feat: add StaticToSelfStaticPropertyFetchOnFinalClassRector

calebdw · calebdw · commit 98d0a5be151f · 2025-08-20T23:32:43.000-05:00
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/fixture.php.inc b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/fixture.php.inc
@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+final class BasicPropertyFetch
+{
+    private static $someProperty = 'value';
+
+    public function test()
+    {
+        return static::$someProperty;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+final class BasicPropertyFetch
+{
+    private static $someProperty = 'value';
+
+    public function test()
+    {
+        return self::$someProperty;
+    }
+}
+
+?>
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/multiple_properties.php.inc b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/multiple_properties.php.inc
@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+final class MultipleProperties
+{
+    private static $property1 = 'value1';
+    protected static $property2 = 'value2';
+    public static $property3 = 'value3';
+
+    public function getValues()
+    {
+        return [
+            static::$property1,
+            static::$property2,
+            static::$property3,
+        ];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+final class MultipleProperties
+{
+    private static $property1 = 'value1';
+    protected static $property2 = 'value2';
+    public static $property3 = 'value3';
+
+    public function getValues()
+    {
+        return [
+            self::$property1,
+            self::$property2,
+            self::$property3,
+        ];
+    }
+}
+
+?>
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/parent_static_property.php.inc b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/parent_static_property.php.inc
@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Source\BaseClass;
+
+final class ParentStaticProperty extends BaseClass
+{
+    public function test(): string
+    {
+        return static::$parentProperty;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Source\BaseClass;
+
+final class ParentStaticProperty extends BaseClass
+{
+    public function test(): string
+    {
+        return self::$parentProperty;
+    }
+}
+
+?>
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_already_self.php.inc b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_already_self.php.inc
@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+final class SkipAlreadySelf
+{
+    private static $someProperty = 'value';
+
+    public function getValue()
+    {
+        return self::$someProperty;
+    }
+}
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_dynamic_property.php.inc b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_dynamic_property.php.inc
@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+final class SkipDynamicProperty
+{
+    public function getValue($propertyName)
+    {
+        return static::$$propertyName;
+    }
+}
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_non_existing_property.php.inc b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_non_existing_property.php.inc
@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+final class SkipNonExistingProperty
+{
+    public function getValue()
+    {
+        return static::$nonExistingProperty;
+    }
+}
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_non_final.php.inc b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_non_final.php.inc
@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+class SkipNonFinal
+{
+    private static $someProperty = 'value';
+
+    public function getValue()
+    {
+        return static::$someProperty;
+    }
+}
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_non_static_property.php.inc b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Fixture/skip_non_static_property.php.inc
@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Fixture;
+
+final class SkipNonStaticProperty
+{
+    private $someProperty = 'value';
+
+    public function getValue()
+    {
+        return static::$someProperty;
+    }
+}
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Source/BaseClass.php b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/Source/BaseClass.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\Source;
+
+class BaseClass
+{
+    protected static $parentProperty = 'parent value';
+}
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/StaticToSelfStaticPropertyFetchOnFinalClassRectorTest.php b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/StaticToSelfStaticPropertyFetchOnFinalClassRectorTest.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class StaticToSelfStaticPropertyFetchOnFinalClassRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/config/configured_rule.php b/rules-tests/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector/config/configured_rule.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector;
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withRules([StaticToSelfStaticPropertyFetchOnFinalClassRector::class]);
diff --git a/rules/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector.php b/rules/CodeQuality/Rector/Class_/StaticToSelfStaticPropertyFetchOnFinalClassRector.php
@@ -0,0 +1,120 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CodeQuality\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\StaticPropertyFetch;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Reflection\ClassReflection;
+use Rector\Configuration\Parameter\FeatureFlags;
+use Rector\Enum\ObjectReference;
+use Rector\PHPStan\ScopeFetcher;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see https://3v4l.org/TQIcH
+ * @see \Rector\Tests\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector\StaticToSelfStaticPropertyFetchOnFinalClassRectorTest
+ */
+final class StaticToSelfStaticPropertyFetchOnFinalClassRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Change `static::$property` to `self::$property` on final class', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    private static $property = 'test';
+
+    public function run()
+    {
+        return static::$property;
+    }
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    private static $property = 'test';
+
+    public function run()
+    {
+        return self::$property;
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Class_
+    {
+        if (! $node->isFinal() && FeatureFlags::treatClassesAsFinal($node) === false) {
+            return null;
+        }
+
+        $hasChanged = false;
+        $scope = ScopeFetcher::fetch($node);
+        $classReflection = $scope->getClassReflection();
+
+        if (! $classReflection instanceof ClassReflection) {
+            return null;
+        }
+
+        $this->traverseNodesWithCallable($node->stmts, function (Node $subNode) use (&$hasChanged, $classReflection, $scope): ?StaticPropertyFetch {
+            if (! $subNode instanceof StaticPropertyFetch) {
+                return null;
+            }
+
+            if (! $this->isName($subNode->class, ObjectReference::STATIC)) {
+                return null;
+            }
+
+            // skip dynamic property
+            if (! $subNode->name instanceof Identifier) {
+                return null;
+            }
+
+            $propertyName = (string) $this->getName($subNode->name);
+
+            if (! $classReflection->hasProperty($propertyName)) {
+                return null;
+            }
+
+            $propertyReflection = $classReflection->getProperty($propertyName, $scope);
+
+            // avoid overlapped change
+            if (! $propertyReflection->isStatic()) {
+                return null;
+            }
+
+            $hasChanged = true;
+            $subNode->class = new Name('self');
+            return $subNode;
+        });
+
+        if ($hasChanged) {
+            return $node;
+        }
+
+        return null;
+    }
+}
diff --git a/src/Config/Level/CodeQualityLevel.php b/src/Config/Level/CodeQualityLevel.php
@@ -14,6 +14,7 @@
 use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
 use Rector\CodeQuality\Rector\Class_\RemoveReadonlyPropertyVisibilityOnReadonlyClassRector;
 use Rector\CodeQuality\Rector\Class_\StaticToSelfStaticMethodCallOnFinalClassRector;
+use Rector\CodeQuality\Rector\Class_\StaticToSelfStaticPropertyFetchOnFinalClassRector;
 use Rector\CodeQuality\Rector\ClassConstFetch\ConvertStaticPrivateConstantToSelfRector;
 use Rector\CodeQuality\Rector\ClassMethod\ExplicitReturnNullRector;
 use Rector\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector;
@@ -173,6 +174,7 @@ final class CodeQualityLevel
         CompleteMissingIfElseBracketRector::class,
         RemoveUselessIsObjectCheckRector::class,
         StaticToSelfStaticMethodCallOnFinalClassRector::class,
+        StaticToSelfStaticPropertyFetchOnFinalClassRector::class,
         SortNamedParamRector::class,
         RemoveReadonlyPropertyVisibilityOnReadonlyClassRector::class,
     ];
