Skip to content

Commit 5a93f7f

Browse files
committed
add NoGetClassReflectionOnScopeRule, route 8 rules through ReflectionResolver
1 parent 6aff6ac commit 5a93f7f

5 files changed

Lines changed: 153 additions & 0 deletions

File tree

‎phpstan.neon‎

Lines changed: 34 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\NoGetClassReflectionOnScopeRule
89
- Rector\Utils\PHPStan\Rule\RegisterRectorRule
910

1011
parameters:
@@ -77,6 +78,39 @@ parameters:
7778
offloadCollectorData: false
7879

7980
ignoreErrors:
81+
# Scope is the correct source of the enclosing class reflection in the engine resolvers,
82+
# in rules that reuse the same Scope for other calls, and in ObjectTypeSpecifier where the
83+
# scope reflection is refreshed on class change while ReflectionProvider reads the original file
84+
-
85+
identifier: rector.getClassReflectionOnScope
86+
paths:
87+
- rules/CodeQuality/Rector/Class_/ConvertStaticToSelfRector.php
88+
- rules/DeadCode/Rector/ClassMethod/RemoveReturnTagIncompatibleWithNativeTypeRector.php
89+
- rules/DeadCode/Rector/If_/RemoveAlwaysTrueIfConditionRector.php
90+
- rules/Php55/Rector/FuncCall/GetCalledClassToStaticClassRector.php
91+
- rules/Php70/Rector/ClassMethod/Php4ConstructorRector.php
92+
- rules/Php70/Rector/MethodCall/ThisCallOnStaticMethodToStaticCallRector.php
93+
- rules/Php81/Rector/Array_/ArrayToFirstClassCallableRector.php
94+
- rules/Php81/Rector/FuncCall/NullToStrictIntPregSlitFuncCallLimitArgRector.php
95+
- rules/Php81/Rector/FuncCall/NullToStrictStringFuncCallArgRector.php
96+
- rules/Php81/Rector/New_/MyCLabsConstructorCallToEnumFromRector.php
97+
- rules/Php82/NodeManipulator/ReadonlyClassManipulator.php
98+
- rules/Php85/Rector/FuncCall/ArrayKeyExistsNullToEmptyStringRector.php
99+
- rules/Renaming/Rector/MethodCall/RenameMethodRector.php
100+
- rules/TypeDeclaration/PHPStan/ObjectTypeSpecifier.php
101+
- rules/TypeDeclaration/Rector/ClassMethod/AddVoidReturnTypeWhereNoReturnRector.php
102+
- rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromMockObjectRector.php
103+
- rules/TypeDeclaration/Rector/Closure/ClosureReturnTypeFromAssertInstanceOfRector.php
104+
- src/Application/ChangedNodeScopeRefresher.php
105+
- src/NodeCollector/ScopeResolver/ParentClassScopeResolver.php
106+
- src/NodeTypeResolver/NodeTypeResolver.php
107+
- src/NodeTypeResolver/NodeTypeResolver/ClassAndInterfaceTypeResolver.php
108+
- src/NodeTypeResolver/NodeTypeResolver/NameTypeResolver.php
109+
- src/NodeTypeResolver/PHPStan/Scope/PHPStanNodeScopeResolver.php
110+
- src/Reflection/ReflectionResolver.php
111+
- src/StaticTypeMapper/Naming/NameScopeFactory.php
112+
- utils/phpstan/src/Rule/NoResolveClassReflectionInForeachRule.php
113+
80114
# called magically by parent
81115
-
82116
message: '#^Unused Rector\\PhpParser\\Printer\\BetterStandardPrinter\:\:(pInterpolatedStringPart|pStmt_FileNode)$#'
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Rule;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Expr\MethodCall;
9+
use PhpParser\Node\Identifier;
10+
use PHPStan\Analyser\Scope;
11+
use PHPStan\Rules\IdentifierRuleError;
12+
use PHPStan\Rules\Rule;
13+
use PHPStan\Rules\RuleErrorBuilder;
14+
use PHPStan\Type\ObjectType;
15+
16+
/**
17+
* @implements Rule<MethodCall>
18+
* @see \Rector\Utils\PHPStan\Tests\Rule\NoGetClassReflectionOnScopeRule\NoGetClassReflectionOnScopeRuleTest
19+
*/
20+
final class NoGetClassReflectionOnScopeRule implements Rule
21+
{
22+
private const string ERROR_MESSAGE = 'Do not call getClassReflection() on a Scope. Resolve the class name and fetch the reflection via ReflectionProvider->getClass() instead.';
23+
24+
private const string METHOD_NAME = 'getClassReflection';
25+
26+
public function getNodeType(): string
27+
{
28+
return MethodCall::class;
29+
}
30+
31+
/**
32+
* @param MethodCall $node
33+
* @return list<IdentifierRuleError>
34+
*/
35+
public function processNode(Node $node, Scope $scope): array
36+
{
37+
if (! $node->name instanceof Identifier) {
38+
return [];
39+
}
40+
41+
if ($node->name->toString() !== self::METHOD_NAME) {
42+
return [];
43+
}
44+
45+
$callerType = $scope->getType($node->var);
46+
if (! new ObjectType(Scope::class)->isSuperTypeOf($callerType)->yes()) {
47+
return [];
48+
}
49+
50+
return [
51+
RuleErrorBuilder::message(self::ERROR_MESSAGE)
52+
->identifier('rector.getClassReflectionOnScope')
53+
->line($node->getStartLine())
54+
->build(),
55+
];
56+
}
57+
}
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Tests\Rule\NoGetClassReflectionOnScopeRule;
6+
7+
use PHPStan\Rules\Rule;
8+
use PHPStan\Testing\RuleTestCase;
9+
use Rector\Utils\PHPStan\Rule\NoGetClassReflectionOnScopeRule;
10+
11+
/**
12+
* @extends RuleTestCase<NoGetClassReflectionOnScopeRule>
13+
*/
14+
final class NoGetClassReflectionOnScopeRuleTest extends RuleTestCase
15+
{
16+
public function testGetClassReflectionOnScope(): void
17+
{
18+
$expectedErrorMessage = 'Do not call getClassReflection() on a Scope. Resolve the class name and fetch the reflection via ReflectionProvider->getClass() instead.';
19+
20+
$this->analyse([__DIR__ . '/Source/GetClassReflectionOnScope.php'], [[$expectedErrorMessage, 13]]);
21+
}
22+
23+
public function testSkipOtherMethodCall(): void
24+
{
25+
$this->analyse([__DIR__ . '/Source/SkipOtherMethodCall.php'], []);
26+
}
27+
28+
protected function getRule(): Rule
29+
{
30+
return new NoGetClassReflectionOnScopeRule();
31+
}
32+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Tests\Rule\NoGetClassReflectionOnScopeRule\Source;
6+
7+
use PHPStan\Analyser\Scope;
8+
9+
final class GetClassReflectionOnScope
10+
{
11+
public function run(Scope $scope): void
12+
{
13+
$classReflection = $scope->getClassReflection();
14+
}
15+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Utils\PHPStan\Tests\Rule\NoGetClassReflectionOnScopeRule\Source;
6+
7+
use PHPStan\Analyser\Scope;
8+
9+
final class SkipOtherMethodCall
10+
{
11+
public function run(Scope $scope): void
12+
{
13+
$isInClass = $scope->isInClass();
14+
}
15+
}

0 commit comments

Comments
 (0)