Only works with final classes and private properties

rectorphp · Nov 28, 2023 · a6f3a3d · a6f3a3d
1 parent e4c561d
commit a6f3a3d
Show file tree

Hide file tree

Showing 14 changed files with 82 additions and 31 deletions.
diff --git a/build/target-repository/docs/rector_rules_overview.md b/build/target-repository/docs/rector_rules_overview.md
@@ -5295,7 +5295,7 @@ Add const to type
 - class: [`Rector\Php83\Rector\ClassConst\AddTypeToConstRector`](../rules/Php83/Rector/ClassConst/AddTypeToConstRector.php)
 
 ```diff
- class SomeClass
+ final class SomeClass
  {
 -    public const TYPE = 'some_type';
 +    public const string TYPE = 'some_type';

diff --git a/...Fixture/apply_type_to_class_const.php.inc → ...e_to_class_const_when_class_final.php.inc b/...Fixture/apply_type_to_class_const.php.inc → ...e_to_class_const_when_class_final.php.inc
@@ -2,7 +2,7 @@
 
 namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
-class ApplyTypes
+final class ApplyTypesWhenClassFinal
 {
     public const STRING = 'some_type';
 
@@ -23,7 +23,7 @@ class ApplyTypes
 
 namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
-class ApplyTypes
+final class ApplyTypesWhenClassFinal
 {
     public const string STRING = 'some_type';
 

diff --git a/...Const/AddTypeToConstRector/Fixture/apply_type_to_class_const_when_const_protected.php.inc b/...Const/AddTypeToConstRector/Fixture/apply_type_to_class_const_when_const_protected.php.inc
@@ -0,0 +1,41 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+class ApplyTypesToPrivateConsts
+{
+    private const STRING = 'some_type';
+
+    private const INT = 1;
+
+    private const FLOAT = 1.0;
+
+    private const BOOL = true;
+
+    private const NULL = null;
+
+    private const ARRAY = [];
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+class ApplyTypesToPrivateConsts
+{
+    private const string STRING = 'some_type';
+
+    private const int INT = 1;
+
+    private const float FLOAT = 1.0;
+
+    private const bool BOOL = true;
+
+    private const null NULL = null;
+
+    private const array ARRAY = [];
+}
+
+?>
diff --git a/...sts/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_abstract_class.php.inc b/...sts/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_abstract_class.php.inc
@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+abstract class SkipAbstractClass
+{
+    public const STRING = 'some_type';
+}
+
+?>
+
diff --git a/...or/ClassConst/AddTypeToConstRector/Fixture/skip_when_implementable_not_autoloaded.php.inc b/...or/ClassConst/AddTypeToConstRector/Fixture/skip_when_implementable_not_autoloaded.php.inc
@@ -2,7 +2,7 @@
 
 namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
-class SkipExtendsNotAutoloadedInterfaceClass implements NotAutoloadedInterface
+final class SkipExtendsNotAutoloadedInterfaceClass implements NotAutoloadedInterface
 {
     public const STRING = 'some_type';
 }

diff --git a/.../Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_interface_defines_const.php.inc b/.../Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_interface_defines_const.php.inc
@@ -4,7 +4,7 @@ namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
 use Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source\SomeInterface;
 
-class SkipOnInterfaceImplements implements SomeInterface
+final class SkipOnInterfaceImplements implements SomeInterface
 {
     public const STRING = 'some_type';
 }

diff --git a/...ts/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_operations_used.php.inc b/...ts/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_operations_used.php.inc
@@ -2,7 +2,7 @@
 
 namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
-class SomeClass
+final class SomeClass
 {
     public const string A = 'A';
 

diff --git a/...ClassConst/AddTypeToConstRector/Fixture/skip_when_parent_class_const_defines_type.php.inc b/...ClassConst/AddTypeToConstRector/Fixture/skip_when_parent_class_const_defines_type.php.inc
@@ -4,7 +4,7 @@ namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
 use Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source\ParentClass;
 
-class SomeClass extends ParentClass
+final class SomeClass extends ParentClass
 {
     public const STRING_OR_INT = 'some_type';
 }

diff --git a/...83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_parent_not_autoloaded.php.inc b/...83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_parent_not_autoloaded.php.inc
@@ -2,7 +2,7 @@
 
 namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
-class SkipExtendsNotAutoloadedClass extends NotAutoloadedClass
+final class SkipExtendsNotAutoloadedClass extends NotAutoloadedClass
 {
     public const STRING = 'some_type';
 }

diff --git a/...ector/ClassConst/AddTypeToConstRector/Fixture/skip_when_referencing_another_const.php.inc b/...ector/ClassConst/AddTypeToConstRector/Fixture/skip_when_referencing_another_const.php.inc
@@ -4,7 +4,7 @@ namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
 use Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source\ParentClass;
 
-class SomeClass
+final class SomeClass
 {
     public const STRING = ParentClass::STRING_OR_INT;
 }

diff --git a/...hp83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_trait_defines_const.php.inc b/...hp83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_trait_defines_const.php.inc
@@ -4,7 +4,7 @@ namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
 use Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source\SomeTrait;
 
-class SkipWhenTraitDefinesInterface
+final class SkipWhenTraitDefinesInterface
 {
     use SomeTrait;
 

diff --git a/...p83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_trait_not_autoloaded.php.inc b/...p83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_trait_not_autoloaded.php.inc
@@ -2,7 +2,7 @@
 
 namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
-class SkipExtendsNotAutoloadedClass
+final class SkipExtendsNotAutoloadedClass
 {
     use NotAutoloadedTrait;
 

diff --git a/...s/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_type_already_set.php.inc b/...s/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_type_already_set.php.inc
@@ -2,7 +2,7 @@
 
 namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
 
-class SomeClass
+final class SomeClass
 {
     public const string|int string = 'A';
 }

diff --git a/rules/Php83/Rector/ClassConst/AddTypeToConstRector.php b/rules/Php83/Rector/ClassConst/AddTypeToConstRector.php
@@ -7,8 +7,6 @@
 use PhpParser\Node;
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Stmt\Class_;
-use PhpParser\Node\Stmt\Interface_;
-use PhpParser\Node\Stmt\Trait_;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\MissingConstantFromReflectionException;
 use PHPStan\Reflection\ReflectionProvider;
@@ -34,14 +32,14 @@ public function getRuleDefinition(): RuleDefinition
         return new RuleDefinition('Add const to type', [
             new CodeSample(
                 <<<'CODE_SAMPLE'
-class SomeClass
+final class SomeClass
 {
     public const TYPE = 'some_type';
 }
 CODE_SAMPLE
                 ,
                 <<<'CODE_SAMPLE'
-class SomeClass
+final class SomeClass
 {
     public const string TYPE = 'some_type';
 }
@@ -61,6 +59,10 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): Class_|null
     {
+        if ($node->isAbstract()) {
+            return null;
+        }
+
         $consts = array_filter($node->stmts, function (Node $stmt) {
             return $stmt instanceof Node\Stmt\ClassConst;
         });
@@ -70,20 +72,9 @@ public function refactor(Node $node): Class_|null
         }
 
         try {
-            /** @var ClassReflection[] $parents */
-            $parents = [];
-            if ($node instanceof Class_ || $node instanceof Interface_) {
-                $parents = $this->getParents($node);
-            }
-            /** @var ClassReflection[] $implementations */
-            $implementations = [];
-            if ($node instanceof Class_) {
-                $implementations = $this->getImplementations($node);
-            }
-            $traits = [];
-            if ($node instanceof Class_ || $node instanceof Trait_) {
-                $traits = $this->getTraits($node);
-            }
+            $parents = $this->getParents($node);
+            $implementations = $this->getImplementations($node);
+            $traits = $this->getTraits($node);
         } catch (FullyQualifiedNameNotAutoloadedException) {
             return null;
         }
@@ -100,6 +91,9 @@ public function refactor(Node $node): Class_|null
                 if ($this->shouldSkipDueToInheritance($constNode, $parents, $implementations, $traits)) {
                     continue;
                 }
+                if ($this->canBeInheritied($const, $node)) {
+                    continue;
+                }
                 $valueType = $this->findValueType($constNode->value);
             }
 
@@ -179,7 +173,7 @@ private function findValueType(Node\Expr $value): ?Node\Identifier
      */
     private function getParents(Class_ $class): array
     {
-        $parents = array_filter(is_iterable($class->extends) ? $class->extends : [$class->extends]);
+        $parents = array_filter([$class->extends]);
 
         return array_map(function (Node\Name $name): ClassReflection {
             if (! $name instanceof FullyQualified) {
@@ -234,4 +228,9 @@ private function getTraits(Class_ $node): array
             throw new FullyQualifiedNameNotAutoloadedException($name);
         }, $traits);
     }
+
+    private function canBeInheritied(Node\Stmt\ClassConst $constNode, Class_ $node): bool
+    {
+        return ! $node->isFinal() && ! $constNode->isPrivate();
+    }
 }