Skip to content

Commit 30895a0

Browse files
authored
Add withComposerBasedRule() to fluent RectorConfig::configure() builder (#8875)
1 parent 66649dc commit 30895a0

2 files changed

Lines changed: 70 additions & 0 deletions

File tree

‎src/Configuration/RectorConfigBuilder.php‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@ final class RectorConfigBuilder
8888
*/
8989
private array $rulesWithConfigurations = [];
9090

91+
/**
92+
* @var array<array{class-string<ConfigurableRectorInterface>, mixed[], string, string}>
93+
*/
94+
private array $composerBasedRules = [];
95+
9196
/**
9297
* @var string[]
9398
*/
@@ -262,6 +267,15 @@ public function __invoke(RectorConfig $rectorConfig): void
262267
}
263268
}
264269

270+
foreach ($this->composerBasedRules as [$rectorClass, $configuration, $packageName, $versionConstraint]) {
271+
$rectorConfig->ruleWithConfigurationComposerVersionBound(
272+
$rectorClass,
273+
$configuration,
274+
$packageName,
275+
$versionConstraint
276+
);
277+
}
278+
265279
if ($this->fileExtensions !== []) {
266280
$rectorConfig->fileExtensions($this->fileExtensions);
267281
}
@@ -763,6 +777,24 @@ public function withConfiguredRule(string $rectorClass, array $configuration): s
763777
return $this;
764778
}
765779

780+
/**
781+
* Register the rule configuration only if the package version installed in the analysed project
782+
* satisfies the version constraint, e.g. a class renamed in a specific framework version.
783+
*
784+
* @param class-string<ConfigurableRectorInterface> $rectorClass
785+
* @param mixed[] $configuration
786+
*/
787+
public function withComposerBasedRule(
788+
string $rectorClass,
789+
array $configuration,
790+
string $packageName,
791+
string $versionConstraint
792+
): self {
793+
$this->composerBasedRules[] = [$rectorClass, $configuration, $packageName, $versionConstraint];
794+
795+
return $this;
796+
}
797+
766798
public function withParallel(
767799
?int $timeoutSeconds = null,
768800
?int $maxNumberOfProcess = null,

‎tests/Config/RectorConfigTest.php‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,42 @@ public function testRuleWithConfigurationComposerVersionBoundOnMissingPackage():
9494
$registeredRectorRules = SimpleParameterProvider::provideArrayParameter(Option::REGISTERED_RECTOR_RULES);
9595
$this->assertNotContains(RenamePropertyRector::class, $registeredRectorRules);
9696
}
97+
98+
public function testWithComposerBasedRuleOnSatisfiedConstraint(): void
99+
{
100+
$rectorConfig = $this->getContainer();
101+
102+
$rectorConfigBuilder = RectorConfig::configure()
103+
->withComposerBasedRule(
104+
RenameClassRector::class,
105+
[
106+
'SomeOldClass' => 'SomeNewClass',
107+
],
108+
'phpunit/phpunit',
109+
'>=9.0'
110+
);
111+
112+
$rectorConfigBuilder($rectorConfig);
113+
114+
$registeredRectorRules = SimpleParameterProvider::provideArrayParameter(Option::REGISTERED_RECTOR_RULES);
115+
$this->assertContains(RenameClassRector::class, $registeredRectorRules);
116+
}
117+
118+
public function testWithComposerBasedRuleOnUnsatisfiedConstraint(): void
119+
{
120+
$rectorConfig = $this->getContainer();
121+
122+
$rectorConfigBuilder = RectorConfig::configure()
123+
->withComposerBasedRule(
124+
RenameMethodRector::class,
125+
[new MethodCallRename('SomeClass', 'oldMethod', 'newMethod')],
126+
'phpunit/phpunit',
127+
'<9.0'
128+
);
129+
130+
$rectorConfigBuilder($rectorConfig);
131+
132+
$registeredRectorRules = SimpleParameterProvider::provideArrayParameter(Option::REGISTERED_RECTOR_RULES);
133+
$this->assertNotContains(RenameMethodRector::class, $registeredRectorRules);
134+
}
97135
}

0 commit comments

Comments
 (0)