Skip to content

Commit 411cdf4

Browse files
authored
[Utils] Add PHPStan rule to spot Rector rules not registered in any set (#8760)
Flags any Rector rule whose ::class is in no set/level config - it can never run otherwise. Scans rector-src config + src/Config and sibling rector-* configs. Deprecated rules and Rector\Tests\ doubles are skipped. A short handful of rules registered only in third-party sets (rector-laravel, drupal-rector, which cannot be installed here due to the rector/rector replace) or shipped opt-in only are listed as rector.registerRector ignores.
1 parent 961feaf commit 411cdf4

10 files changed

Lines changed: 377 additions & 0 deletions

File tree

‎phpstan.neon‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ includes:
55
rules:
66
- Rector\Utils\PHPStan\Rule\RegisterRelatedPolyfillRectorRule
77
- Rector\Utils\PHPStan\Rule\NoResolveClassReflectionInForeachRule
8+
- Rector\Utils\PHPStan\Rule\RegisterRectorRule
89

910
parameters:
1011
level: 8
@@ -228,6 +229,19 @@ parameters:
228229
- rules/Php81/Rector/FuncCall/NullToStrictStringFuncCallArgRector.php
229230
- rules/Php80/Rector/NotIdentical/MbStrContainsRector.php
230231

232+
# not registered in a rector-src set on purpose: NullToStrictString is opt-in only (risky),
233+
# the rest are registered in third-party sets (rector-laravel, drupal-rector) that cannot be
234+
# installed here due to the rector/rector replace
235+
-
236+
identifier: rector.registerRector
237+
paths:
238+
- rules/Php81/Rector/FuncCall/NullToStrictStringFuncCallArgRector.php
239+
- rules/Removing/Rector/Class_/RemoveTraitUseRector.php
240+
- rules/Renaming/Rector/StaticCall/RenameStaticMethodRector.php
241+
- rules/Transform/Rector/FuncCall/FuncCallToNewRector.php
242+
- rules/Transform/Rector/FuncCall/FuncCallToStaticCallRector.php
243+
- rules/Transform/Rector/String_/StringToClassConstantRector.php
244+
231245
# lack of generic array in nikic/php-parser
232246
-
233247
identifier: return.type
Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Rule;
6+
7+
use PhpParser\Node;
8+
use PHPStan\Analyser\Scope;
9+
use PHPStan\Node\InClassNode;
10+
use PHPStan\Rules\IdentifierRuleError;
11+
use PHPStan\Rules\Rule;
12+
use PHPStan\Rules\RuleErrorBuilder;
13+
use Rector\Configuration\Deprecation\Contract\DeprecatedInterface;
14+
use Rector\Contract\Rector\RectorInterface;
15+
use RecursiveDirectoryIterator;
16+
use RecursiveIteratorIterator;
17+
use SplFileInfo;
18+
19+
/**
20+
* Every Rector rule must be registered in a set or level config, otherwise it can
21+
* never run and becomes dead code. Registrations in sibling extension packages
22+
* (rector-doctrine, rector-symfony, ...) count too. Deprecated rules are skipped,
23+
* as they are intentionally unregistered.
24+
*
25+
* @implements Rule<InClassNode>
26+
* @see \Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\RegisterRectorRuleTest
27+
*/
28+
final class RegisterRectorRule implements Rule
29+
{
30+
private const string ERROR_MESSAGE = 'Rector rule "%s" is not registered in any set or level config, so it can never run. Register it in a set/level, or deprecate it if it is no longer wanted.';
31+
32+
/**
33+
* @var string[]
34+
*/
35+
private readonly array $registrationDirectories;
36+
37+
/**
38+
* @var array<string, true>|null
39+
*/
40+
private ?array $registeredShortClassNames = null;
41+
42+
/**
43+
* @param string[]|null $registrationDirectories
44+
*/
45+
public function __construct(?array $registrationDirectories = null)
46+
{
47+
$root = __DIR__ . '/../../../../';
48+
49+
$this->registrationDirectories = $registrationDirectories ?? array_merge(
50+
[$root . 'config', $root . 'src/Config'],
51+
// sibling extension packages register rules in their own config sets
52+
glob($root . 'vendor/rector/*/config') ?: []
53+
);
54+
}
55+
56+
public function getNodeType(): string
57+
{
58+
return InClassNode::class;
59+
}
60+
61+
/**
62+
* @param InClassNode $node
63+
* @return list<IdentifierRuleError>
64+
*/
65+
public function processNode(Node $node, Scope $scope): array
66+
{
67+
$classReflection = $node->getClassReflection();
68+
69+
if ($classReflection->isAbstract()) {
70+
return [];
71+
}
72+
73+
if (! $classReflection->implementsInterface(RectorInterface::class)) {
74+
return [];
75+
}
76+
77+
// test doubles are wired directly in their test, not through a set
78+
if (str_starts_with($classReflection->getName(), 'Rector\\Tests\\')) {
79+
return [];
80+
}
81+
82+
// intentionally unregistered
83+
if ($classReflection->implementsInterface(DeprecatedInterface::class)) {
84+
return [];
85+
}
86+
87+
$className = $classReflection->getName();
88+
if ($this->isRegistered($className)) {
89+
return [];
90+
}
91+
92+
return [
93+
RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $className))
94+
->identifier('rector.registerRector')
95+
->build(),
96+
];
97+
}
98+
99+
private function isRegistered(string $className): bool
100+
{
101+
$shortClassName = substr((string) strrchr($className, '\\'), 1);
102+
103+
// short class names are unique repo-wide (enforced by the "no duplicate short class names" check)
104+
return isset($this->getRegisteredShortClassNames()[$shortClassName]);
105+
}
106+
107+
/**
108+
* Collect every "SomeRector::class" short name referenced in the scanned config directories once.
109+
* The capture group stops at the preceding "\", so both "SomeRector::class" and a fully qualified
110+
* "\Some\Ns\SomeRector::class" yield the same short name.
111+
*
112+
* @return array<string, true>
113+
*/
114+
private function getRegisteredShortClassNames(): array
115+
{
116+
if ($this->registeredShortClassNames !== null) {
117+
return $this->registeredShortClassNames;
118+
}
119+
120+
$registeredShortClassNames = [];
121+
foreach ($this->registrationDirectories as $registrationDirectory) {
122+
if (! is_dir($registrationDirectory)) {
123+
continue;
124+
}
125+
126+
$recursiveIterator = new RecursiveIteratorIterator(
127+
new RecursiveDirectoryIterator($registrationDirectory, RecursiveDirectoryIterator::SKIP_DOTS)
128+
);
129+
130+
/** @var SplFileInfo $fileInfo */
131+
foreach ($recursiveIterator as $fileInfo) {
132+
if ($fileInfo->getExtension() !== 'php') {
133+
continue;
134+
}
135+
136+
$fileContents = file_get_contents($fileInfo->getRealPath());
137+
if ($fileContents === false) {
138+
continue;
139+
}
140+
141+
preg_match_all('#([A-Za-z_][A-Za-z0-9_]*)::class#', $fileContents, $matches);
142+
foreach ($matches[1] as $shortClassName) {
143+
$registeredShortClassNames[$shortClassName] = true;
144+
}
145+
}
146+
}
147+
148+
$this->registeredShortClassNames = $registeredShortClassNames;
149+
150+
return $registeredShortClassNames;
151+
}
152+
}
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule;
6+
7+
use PHPStan\Rules\Rule;
8+
use PHPStan\Testing\RuleTestCase;
9+
use Rector\Utils\PHPStan\Rule\RegisterRectorRule;
10+
11+
/**
12+
* @extends RuleTestCase<RegisterRectorRule>
13+
*/
14+
final class RegisterRectorRuleTest extends RuleTestCase
15+
{
16+
public function testUnregistered(): void
17+
{
18+
$expectedErrorMessage = 'Rector rule "Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\Source\UnregisteredRector" is not registered in any set or level config, so it can never run. Register it in a set/level, or deprecate it if it is no longer wanted.';
19+
20+
$this->analyse([__DIR__ . '/Source/UnregisteredRector.php'], [[$expectedErrorMessage, 12]]);
21+
}
22+
23+
public function testUnregisteredConfigurable(): void
24+
{
25+
$expectedErrorMessage = 'Rector rule "Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\Source\UnregisteredConfigurableRector" is not registered in any set or level config, so it can never run. Register it in a set/level, or deprecate it if it is no longer wanted.';
26+
27+
$this->analyse([__DIR__ . '/Source/UnregisteredConfigurableRector.php'], [[$expectedErrorMessage, 13]]);
28+
}
29+
30+
public function testRegistered(): void
31+
{
32+
$this->analyse([__DIR__ . '/Source/RegisteredRector.php'], []);
33+
}
34+
35+
public function testRegisteredInSiblingConfig(): void
36+
{
37+
$this->analyse([__DIR__ . '/Source/SiblingRegisteredRector.php'], []);
38+
}
39+
40+
public function testSkipDeprecated(): void
41+
{
42+
$this->analyse([__DIR__ . '/Source/SkipDeprecatedRector.php'], []);
43+
}
44+
45+
protected function getRule(): Rule
46+
{
47+
return new RegisterRectorRule([__DIR__ . '/config', __DIR__ . '/config-sibling']);
48+
}
49+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\Source;
6+
7+
use PhpParser\Node;
8+
use Rector\Rector\AbstractRector;
9+
use Rector\RuleDoc\CodeSample\CodeSample;
10+
use Rector\RuleDoc\RuleDefinition;
11+
12+
final class RegisteredRector extends AbstractRector
13+
{
14+
public function getRuleDefinition(): RuleDefinition
15+
{
16+
return new RuleDefinition('Registered rule', [new CodeSample('before', 'after')]);
17+
}
18+
19+
public function getNodeTypes(): array
20+
{
21+
return [Node::class];
22+
}
23+
24+
public function refactor(Node $node): ?Node
25+
{
26+
return null;
27+
}
28+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\Source;
6+
7+
use PhpParser\Node;
8+
use Rector\Rector\AbstractRector;
9+
use Rector\RuleDoc\CodeSample\CodeSample;
10+
use Rector\RuleDoc\RuleDefinition;
11+
12+
final class SiblingRegisteredRector extends AbstractRector
13+
{
14+
public function getRuleDefinition(): RuleDefinition
15+
{
16+
return new RuleDefinition('Rule registered in a sibling package config', [new CodeSample('before', 'after')]);
17+
}
18+
19+
public function getNodeTypes(): array
20+
{
21+
return [Node::class];
22+
}
23+
24+
public function refactor(Node $node): ?Node
25+
{
26+
return null;
27+
}
28+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\Source;
6+
7+
use PhpParser\Node;
8+
use Rector\Configuration\Deprecation\Contract\DeprecatedInterface;
9+
use Rector\Rector\AbstractRector;
10+
use Rector\RuleDoc\CodeSample\CodeSample;
11+
use Rector\RuleDoc\RuleDefinition;
12+
13+
final class SkipDeprecatedRector extends AbstractRector implements DeprecatedInterface
14+
{
15+
public function getRuleDefinition(): RuleDefinition
16+
{
17+
return new RuleDefinition('Deprecated rule', [new CodeSample('before', 'after')]);
18+
}
19+
20+
public function getNodeTypes(): array
21+
{
22+
return [Node::class];
23+
}
24+
25+
public function refactor(Node $node): ?Node
26+
{
27+
return null;
28+
}
29+
}
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\Source;
6+
7+
use PhpParser\Node;
8+
use Rector\Contract\Rector\ConfigurableRectorInterface;
9+
use Rector\Rector\AbstractRector;
10+
use Rector\RuleDoc\CodeSample\CodeSample;
11+
use Rector\RuleDoc\RuleDefinition;
12+
13+
final class UnregisteredConfigurableRector extends AbstractRector implements ConfigurableRectorInterface
14+
{
15+
public function getRuleDefinition(): RuleDefinition
16+
{
17+
return new RuleDefinition('Configurable rule', [new CodeSample('before', 'after')]);
18+
}
19+
20+
public function getNodeTypes(): array
21+
{
22+
return [Node::class];
23+
}
24+
25+
public function refactor(Node $node): ?Node
26+
{
27+
return null;
28+
}
29+
30+
public function configure(array $configuration): void
31+
{
32+
}
33+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\Source;
6+
7+
use PhpParser\Node;
8+
use Rector\Rector\AbstractRector;
9+
use Rector\RuleDoc\CodeSample\CodeSample;
10+
use Rector\RuleDoc\RuleDefinition;
11+
12+
final class UnregisteredRector extends AbstractRector
13+
{
14+
public function getRuleDefinition(): RuleDefinition
15+
{
16+
return new RuleDefinition('Unregistered rule', [new CodeSample('before', 'after')]);
17+
}
18+
19+
public function getNodeTypes(): array
20+
{
21+
return [Node::class];
22+
}
23+
24+
public function refactor(Node $node): ?Node
25+
{
26+
return null;
27+
}
28+
}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\Source\SiblingRegisteredRector;
6+
7+
// mimics a sibling extension package config set
8+
return [SiblingRegisteredRector::class];
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Utils\PHPStan\Tests\Rule\RegisterRectorRule\Source\RegisteredRector;
6+
7+
// mimics a set/level config; the rule only checks the "::class" reference is present
8+
return [RegisteredRector::class];

0 commit comments

Comments
 (0)