Skip to content

Commit 8ead5a5

Browse files
authored
[Config] Add ruleWithConfigurationComposerVersionBound() (#8244)
1 parent b64e880 commit 8ead5a5

2 files changed

Lines changed: 89 additions & 0 deletions

File tree

‎src/Config/RectorConfig.php‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44

55
namespace Rector\Config;
66

7+
use Composer\Semver\Semver;
78
use Illuminate\Container\Container;
89
use Override;
910
use Rector\Caching\Contract\CacheMetaExtensionInterface;
1011
use Rector\Caching\Contract\ValueObject\Storage\CacheStorageInterface;
12+
use Rector\Composer\InstalledPackageResolver;
1113
use Rector\Configuration\Option;
1214
use Rector\Configuration\Parameter\SimpleParameterProvider;
1315
use Rector\Configuration\RectorConfigBuilder;
@@ -42,6 +44,8 @@ final class RectorConfig extends Container
4244
*/
4345
private array $autotagInterfaces = [Command::class, ResettableInterface::class];
4446

47+
private ?InstalledPackageResolver $installedPackageResolver = null;
48+
4549
private static ?bool $recreated = null;
4650

4751
public static function configure(): RectorConfigBuilder
@@ -195,6 +199,32 @@ public function ruleWithConfiguration(string $rectorClass, array $configuration)
195199
SimpleParameterProvider::addParameter(Option::REGISTERED_RECTOR_RULES, $rectorClass);
196200
}
197201

202+
/**
203+
* Register the rule configuration only if the package version installed in the analysed project satisfies
204+
* the version constraint. Useful for configuration valid since a specific package version,
205+
* e.g. an attribute added in PHPUnit 11.
206+
*
207+
* @param class-string<ConfigurableRectorInterface> $rectorClass
208+
* @param mixed[] $configuration
209+
*/
210+
public function ruleWithConfigurationComposerVersionBound(
211+
string $rectorClass,
212+
array $configuration,
213+
string $packageName,
214+
string $versionConstraint
215+
): void {
216+
$packageVersion = $this->resolveInstalledPackageVersion($packageName);
217+
if ($packageVersion === null) {
218+
return;
219+
}
220+
221+
if (! Semver::satisfies($packageVersion, $versionConstraint)) {
222+
return;
223+
}
224+
225+
$this->ruleWithConfiguration($rectorClass, $configuration);
226+
}
227+
198228
/**
199229
* @param class-string<RectorInterface> $rectorClass
200230
*/
@@ -488,4 +518,11 @@ public function setOverflowLevels(array $levelOverflows): void
488518
{
489519
SimpleParameterProvider::addParameter(Option::LEVEL_OVERFLOWS, $levelOverflows);
490520
}
521+
522+
private function resolveInstalledPackageVersion(string $packageName): ?string
523+
{
524+
$this->installedPackageResolver ??= new InstalledPackageResolver();
525+
526+
return $this->installedPackageResolver->resolvePackageVersion($packageName);
527+
}
491528
}

‎tests/Config/RectorConfigTest.php‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
88
use Rector\Configuration\Option;
99
use Rector\Configuration\Parameter\SimpleParameterProvider;
10+
use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
11+
use Rector\Renaming\Rector\Name\RenameClassRector;
12+
use Rector\Renaming\Rector\PropertyFetch\RenamePropertyRector;
13+
use Rector\Renaming\ValueObject\MethodCallRename;
14+
use Rector\Renaming\ValueObject\RenameProperty;
1015
use Rector\Symfony\Set\TwigSetList;
1116
use Rector\Testing\PHPUnit\AbstractLazyTestCase;
1217
use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromReturnNewRector;
@@ -29,4 +34,51 @@ public function test(): void
2934
// only collect root withRules()
3035
$this->assertCount(1, SimpleParameterProvider::provideArrayParameter(Option::ROOT_STANDALONE_REGISTERED_RULES));
3136
}
37+
38+
public function testRuleWithConfigurationComposerVersionBoundOnSatisfiedConstraint(): void
39+
{
40+
$rectorConfig = $this->getContainer();
41+
42+
$rectorConfig->ruleWithConfigurationComposerVersionBound(
43+
RenameClassRector::class,
44+
[
45+
'SomeOldClass' => 'SomeNewClass',
46+
],
47+
'phpunit/phpunit',
48+
'>=9.0'
49+
);
50+
51+
$registeredRectorRules = SimpleParameterProvider::provideArrayParameter(Option::REGISTERED_RECTOR_RULES);
52+
$this->assertContains(RenameClassRector::class, $registeredRectorRules);
53+
}
54+
55+
public function testRuleWithConfigurationComposerVersionBoundOnUnsatisfiedConstraint(): void
56+
{
57+
$rectorConfig = $this->getContainer();
58+
59+
$rectorConfig->ruleWithConfigurationComposerVersionBound(
60+
RenameMethodRector::class,
61+
[new MethodCallRename('SomeClass', 'oldMethod', 'newMethod')],
62+
'phpunit/phpunit',
63+
'<9.0'
64+
);
65+
66+
$registeredRectorRules = SimpleParameterProvider::provideArrayParameter(Option::REGISTERED_RECTOR_RULES);
67+
$this->assertNotContains(RenameMethodRector::class, $registeredRectorRules);
68+
}
69+
70+
public function testRuleWithConfigurationComposerVersionBoundOnMissingPackage(): void
71+
{
72+
$rectorConfig = $this->getContainer();
73+
74+
$rectorConfig->ruleWithConfigurationComposerVersionBound(
75+
RenamePropertyRector::class,
76+
[new RenameProperty('SomeClass', 'oldProperty', 'newProperty')],
77+
'not-installed/package',
78+
'>=1.0'
79+
);
80+
81+
$registeredRectorRules = SimpleParameterProvider::provideArrayParameter(Option::REGISTERED_RECTOR_RULES);
82+
$this->assertNotContains(RenamePropertyRector::class, $registeredRectorRules);
83+
}
3284
}

0 commit comments

Comments
 (0)