Skip to content

Commit cfdf0fa

Browse files
authored
More proper fix for ClassReflection refresh (part 2) (#8729)
* Proper fix for ClassReflection refresh (part 2) * update test * fix * restore test
1 parent 7bc5a18 commit cfdf0fa

9 files changed

Lines changed: 232 additions & 1 deletion

File tree

‎rules/TypeDeclaration/PHPStan/ObjectTypeSpecifier.php‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,13 @@ public function narrowToFullyQualifiedOrAliasedObjectType(
6464
}
6565

6666
if ($this->reflectionProvider->hasClass($className)) {
67+
// keep the scope class reflection of the current class, as it is refreshed on class change,
68+
// while the reflection provider one still reads the original file
69+
$classReflection = $scope?->getClassReflection();
70+
if ($classReflection instanceof ClassReflection && $classReflection->getName() === $className) {
71+
return new FullyQualifiedObjectType($className, null, $classReflection);
72+
}
73+
6774
return new FullyQualifiedObjectType($className);
6875
}
6976

‎tests/Issues/ClassReflectionRefresh/Source/AddTraitByReflectionRector.php‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,16 @@ public function refactor(Node $node): ?Class_
4747
return null;
4848
}
4949

50-
if ($classReflection->hasTraitUse(SomeTrait::class)) {
50+
// both the scope and the resolved type must see the refreshed class reflection
51+
$typeClassReflection = $this->getType($node)
52+
->getObjectClassReflections()[0] ?? null;
53+
54+
$hasTraitInScope = $classReflection->hasTraitUse(SomeTrait::class);
55+
$hasTraitInType = $typeClassReflection instanceof ClassReflection && $typeClassReflection->hasTraitUse(
56+
SomeTrait::class
57+
);
58+
59+
if ($hasTraitInScope && $hasTraitInType) {
5160
return null;
5261
}
5362

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\Tests\Issues\ClassReflectionRefreshOnModifier;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class ClassReflectionRefreshOnModifierTest extends AbstractRectorTestCase
12+
{
13+
#[DataProvider('provideData')]
14+
public function test(string $filePath): void
15+
{
16+
$this->doTestFile($filePath);
17+
}
18+
19+
public static function provideData(): Iterator
20+
{
21+
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
22+
}
23+
24+
public function provideConfigFilePath(): string
25+
{
26+
return __DIR__ . '/config/configured_rule.php';
27+
}
28+
}
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
3+
namespace Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Fixture;
4+
5+
class RefreshOnClassChange
6+
{
7+
public function run()
8+
{
9+
}
10+
}
11+
12+
?>
13+
-----
14+
<?php
15+
16+
namespace Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Fixture;
17+
18+
final readonly class RefreshOnClassChange
19+
{
20+
public function run()
21+
{
22+
}
23+
}
24+
25+
?>
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
namespace Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Fixture;
4+
5+
use Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Source\SomeInterface;
6+
7+
class RefreshOnClassChangeWithImportedInterface implements SomeInterface
8+
{
9+
public function run(): SomeInterface
10+
{
11+
return $this;
12+
}
13+
}
14+
15+
?>
16+
-----
17+
<?php
18+
19+
namespace Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Fixture;
20+
21+
use Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Source\SomeInterface;
22+
23+
final readonly class RefreshOnClassChangeWithImportedInterface implements SomeInterface
24+
{
25+
public function run(): SomeInterface
26+
{
27+
return $this;
28+
}
29+
}
30+
31+
?>
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\Tests\Issues\ClassReflectionRefreshOnModifier\Source;
6+
7+
use PhpParser\Modifiers;
8+
use PhpParser\Node;
9+
use PhpParser\Node\Stmt\Class_;
10+
use PHPStan\Reflection\ClassReflection;
11+
use Rector\Rector\AbstractRector;
12+
use Rector\Reflection\ReflectionResolver;
13+
use Rector\RuleDoc\RuleDefinition;
14+
15+
final class FinalizeByReflectionRector extends AbstractRector
16+
{
17+
public function __construct(
18+
private readonly ReflectionResolver $reflectionResolver
19+
) {
20+
}
21+
22+
public function getRuleDefinition(): RuleDefinition
23+
{
24+
return new RuleDefinition('', []);
25+
}
26+
27+
/**
28+
* @return array<class-string<Node>>
29+
*/
30+
public function getNodeTypes(): array
31+
{
32+
return [Class_::class];
33+
}
34+
35+
/**
36+
* @param Class_ $node
37+
*/
38+
public function refactor(Node $node): ?Class_
39+
{
40+
$classReflection = $this->reflectionResolver->resolveClassReflection($node);
41+
if (! $classReflection instanceof ClassReflection || $classReflection->isFinal()) {
42+
return null;
43+
}
44+
45+
$node->flags |= Modifiers::FINAL;
46+
47+
return $node;
48+
}
49+
}
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Source;
6+
7+
use PhpParser\Modifiers;
8+
use PhpParser\Node;
9+
use PhpParser\Node\Stmt\Class_;
10+
use PHPStan\Reflection\ClassReflection;
11+
use Rector\Rector\AbstractRector;
12+
use Rector\Reflection\ReflectionResolver;
13+
use Rector\RuleDoc\RuleDefinition;
14+
15+
/**
16+
* Sees the final added by FinalizeByReflectionRector only when the class reflection is refreshed
17+
* after the class node changed, both on the scope and on the resolved type
18+
*/
19+
final class ReadonlyOnFinalByReflectionRector extends AbstractRector
20+
{
21+
public function __construct(
22+
private readonly ReflectionResolver $reflectionResolver
23+
) {
24+
}
25+
26+
public function getRuleDefinition(): RuleDefinition
27+
{
28+
return new RuleDefinition('', []);
29+
}
30+
31+
/**
32+
* @return array<class-string<Node>>
33+
*/
34+
public function getNodeTypes(): array
35+
{
36+
return [Class_::class];
37+
}
38+
39+
/**
40+
* @param Class_ $node
41+
*/
42+
public function refactor(Node $node): ?Class_
43+
{
44+
$scopeClassReflection = $this->reflectionResolver->resolveClassReflection($node);
45+
if (! $scopeClassReflection instanceof ClassReflection || ! $scopeClassReflection->isFinal()) {
46+
return null;
47+
}
48+
49+
if ($scopeClassReflection->isReadOnly()) {
50+
return null;
51+
}
52+
53+
$typeClassReflection = $this->getType($node)
54+
->getObjectClassReflections()[0] ?? null;
55+
if (! $typeClassReflection instanceof ClassReflection || ! $typeClassReflection->isFinal()) {
56+
return null;
57+
}
58+
59+
$node->flags |= Modifiers::READONLY;
60+
61+
return $node;
62+
}
63+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Source;
6+
7+
interface SomeInterface
8+
{
9+
}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Config\RectorConfig;
6+
use Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Source\FinalizeByReflectionRector;
7+
use Rector\Tests\Issues\ClassReflectionRefreshOnModifier\Source\ReadonlyOnFinalByReflectionRector;
8+
9+
return RectorConfig::configure()
10+
->withRules([FinalizeByReflectionRector::class, ReadonlyOnFinalByReflectionRector::class]);

0 commit comments

Comments
 (0)