Improve ClassPropertyAssignToConstructorPromotionRector not to use STMT_KEY attribute value (#7645)

* improve ClassPropertyAssignToConstructorPromotionRector not to use stmts key

* move stmt key to property candidate value object

Author: TomasVotruba

rules/Php80/NodeAnalyzer/PromotedPropertyCandidateResolver.php

@@ -47,18 +47,25 @@ public function resolveFromClass(
         }
 
         $propertyPromotionCandidates = [];
-        foreach ($class->getProperties() as $property) {
-            $propertyCount = count($property->props);
-            if ($propertyCount !== 1) {
+        foreach ($class->stmts as $classStmtPosition => $classStmt) {
+            if (! $classStmt instanceof Property) {
                 continue;
             }
 
-            $propertyPromotionCandidate = $this->matchPropertyPromotionCandidate($property, $constructClassMethod);
+            if (count($classStmt->props) !== 1) {
+                continue;
+            }
+
+            $propertyPromotionCandidate = $this->matchPropertyPromotionCandidate(
+                $classStmt,
+                $constructClassMethod,
+                $classStmtPosition
+            );
             if (! $propertyPromotionCandidate instanceof PropertyPromotionCandidate) {
                 continue;
             }
 
-            if (! $allowModelBasedClasses && $this->hasModelTypeCheck($property, ClassName::JMS_TYPE)) {
+            if (! $allowModelBasedClasses && $this->hasModelTypeCheck($classStmt, ClassName::JMS_TYPE)) {
                 continue;
             }
 
@@ -80,7 +87,8 @@ private function hasModelTypeCheck(Class_|Property $node, string $modelType): bo
 
     private function matchPropertyPromotionCandidate(
         Property $property,
-        ClassMethod $constructClassMethod
+        ClassMethod $constructClassMethod,
+        int $propertyStmtPosition
     ): ?PropertyPromotionCandidate {
         if ($property->flags === 0) {
             return null;
@@ -92,7 +100,7 @@ private function matchPropertyPromotionCandidate(
         $firstParamAsVariable = $this->resolveFirstParamUses($constructClassMethod);
 
         // match property name to assign in constructor
-        foreach ((array) $constructClassMethod->stmts as $stmt) {
+        foreach ((array) $constructClassMethod->stmts as $assignStmtPosition => $stmt) {
             if (! $stmt instanceof Expression) {
                 continue;
             }
@@ -127,7 +135,12 @@ private function matchPropertyPromotionCandidate(
                 continue;
             }
 
-            return new PropertyPromotionCandidate($property, $matchedParam, $stmt);
+            return new PropertyPromotionCandidate(
+                $property,
+                $matchedParam,
+                $propertyStmtPosition,
+                $assignStmtPosition
+            );
         }
 
         return null;

rules/Php80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector.php

@@ -26,7 +26,6 @@
 use Rector\Naming\PropertyRenamer\PropertyPromotionRenamer;
 use Rector\Naming\VariableRenamer;
 use Rector\NodeAnalyzer\ParamAnalyzer;
-use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\NodeTypeResolver\TypeComparator\TypeComparator;
 use Rector\Php80\DocBlock\PropertyPromotionDocBlockMerger;
 use Rector\Php80\Guard\MakePropertyPromotionGuard;
@@ -209,22 +208,17 @@ public function refactor(Node $node): ?Node
                 continue;
             }
 
-            if ($property->type instanceof Node
-                && $param->type instanceof Node
-                && $property->hooks !== []
-                && ! $this->nodeComparator->areNodesEqual($property->type, $param->type)) {
+            if ($this->shouldSkipPropertyOrParam($property, $param)) {
                 continue;
             }
 
             $hasChanged = true;
 
             // remove property from class
-            $propertyStmtKey = $property->getAttribute(AttributeKey::STMT_KEY);
-            unset($node->stmts[$propertyStmtKey]);
+            unset($node->stmts[$promotionCandidate->getPropertyStmtPosition()]);
 
             // remove assign in constructor
-            $assignStmtPosition = $promotionCandidate->getStmtPosition();
-            unset($constructClassMethod->stmts[$assignStmtPosition]);
+            unset($constructClassMethod->stmts[$promotionCandidate->getConstructorAssignStmtPosition()]);
 
             $oldParamName = $this->getName($param);
             $this->variableRenamer->renameVariableInFunctionLike($constructClassMethod, $oldParamName, $propertyName);
@@ -367,4 +361,12 @@ private function isCallableTypeIdentifier(?Node $node): bool
     {
         return $node instanceof Identifier && $this->isName($node, 'callable');
     }
+
+    private function shouldSkipPropertyOrParam(Property $property, Param $param): bool
+    {
+        return $property->type instanceof Node
+            && $param->type instanceof Node
+            && $property->hooks !== []
+            && ! $this->nodeComparator->areNodesEqual($property->type, $param->type);
+    }
 }

rules/Php80/ValueObject/PropertyPromotionCandidate.php

@@ -6,17 +6,16 @@
 
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Param;
-use PhpParser\Node\Stmt\Expression;
 use PhpParser\Node\Stmt\Property;
 use Rector\Exception\ShouldNotHappenException;
-use Rector\NodeTypeResolver\Node\AttributeKey;
 
 final readonly class PropertyPromotionCandidate
 {
     public function __construct(
         private Property $property,
         private Param $param,
-        private Expression $expression,
+        private int $propertyStmtPosition,
+        private int $constructorAssignStmtPosition,
     ) {
     }
 
@@ -45,8 +44,13 @@ public function getParamName(): string
         return $paramVar->name;
     }
 
-    public function getStmtPosition(): int
+    public function getPropertyStmtPosition(): int
     {
-        return $this->expression->getAttribute(AttributeKey::STMT_KEY);
+        return $this->propertyStmtPosition;
+    }
+
+    public function getConstructorAssignStmtPosition(): int
+    {
+        return $this->constructorAssignStmtPosition;
     }
 }