fix promoted property

Author: TomasVotruba

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockGetterReturnArrayFromPropertyDocblockVarRector/Fixture/add_prefix_backslash.php.inc

@@ -43,7 +43,7 @@ class AddPrefixBackslash extends LogicException
     }
 
     /**
-     * @return array<string, array<int, class-string<\App\Support\Benchmarking\Contracts\Metric>>>
+     * @return array<string, array<int, class-string<Metric>>>
      */
     public function getDuplicateNames(): array
     {

rules/TypeDeclarationDocblocks/NodeDocblockTypeDecorator.php

@@ -55,8 +55,8 @@ public function decorateGenericIterableParamType(
 
     public function decorateGenericIterableReturnType(
         Type|TypeNode $typeOrTypeNode,
-        PhpDocInfo    $classMethodPhpDocInfo,
-        FunctionLike  $functionLike
+        PhpDocInfo $classMethodPhpDocInfo,
+        FunctionLike $functionLike
     ): bool {
         if ($typeOrTypeNode instanceof TypeNode) {
             $type = $this->staticTypeMapper->mapPHPStanPhpDocTypeNodeToPHPStanType($typeOrTypeNode, $functionLike);

rules/TypeDeclarationDocblocks/NodeFinder/GetterClassMethodPropertyFinder.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclarationDocblocks\NodeFinder;
+
+use PhpParser\Node\Expr\PropertyFetch;
+use PhpParser\Node\Param;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Property;
+use PhpParser\Node\Stmt\Return_;
+use Rector\NodeNameResolver\NodeNameResolver;
+use Rector\ValueObject\MethodName;
+
+final readonly class GetterClassMethodPropertyFinder
+{
+    public function __construct(
+        private NodeNameResolver $nodeNameResolver,
+    ) {
+    }
+
+    public function find(ClassMethod $classMethod, Class_ $class): Property|Param|null
+    {
+        // we need exactly one statement of return
+        if ($classMethod->stmts === null || count($classMethod->stmts) !== 1) {
+            return null;
+        }
+
+        $onlyStmt = $classMethod->stmts[0];
+        if (! $onlyStmt instanceof Return_) {
+            return null;
+        }
+
+        if (! $onlyStmt->expr instanceof PropertyFetch) {
+            return null;
+        }
+
+        $propertyFetch = $onlyStmt->expr;
+        if (! $this->nodeNameResolver->isName($propertyFetch->var, 'this')) {
+            return null;
+        }
+
+        $propertyName = $this->nodeNameResolver->getName($propertyFetch->name);
+        if (! is_string($propertyName)) {
+            return null;
+        }
+
+        $property = $class->getProperty($propertyName);
+        if ($property instanceof Property) {
+            return $property;
+        }
+
+        // try also promoted property in constructor
+        $constructClassMethod = $class->getMethod(MethodName::CONSTRUCT);
+        if (! $constructClassMethod instanceof ClassMethod) {
+            return null;
+        }
+
+        foreach ($constructClassMethod->getParams() as $param) {
+            if (! $param->isPromoted()) {
+                continue;
+            }
+
+            if (! $this->nodeNameResolver->isName($param, $propertyName)) {
+                continue;
+            }
+
+            return $param;
+        }
+
+        return null;
+    }
+}

rules/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockGetterReturnArrayFromPropertyDocblockVarRector.php

@@ -4,22 +4,15 @@
 
 namespace Rector\TypeDeclarationDocblocks\Rector\ClassMethod;
 
+use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
-use PhpParser\Node\Stmt\Property;
 use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode;
 use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
-use PHPStan\Type\Type;
-use PhpParser\Node;
-use PhpParser\Node\Expr\PropertyFetch;
-use PhpParser\Node\Stmt\ClassMethod;
-use PhpParser\Node\Stmt\Return_;
-use PHPStan\Type\ArrayType;
-use PHPStan\Type\MixedType;
-use PHPStan\Type\UnionType;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\Rector\AbstractRector;
 use Rector\TypeDeclarationDocblocks\NodeDocblockTypeDecorator;
+use Rector\TypeDeclarationDocblocks\NodeFinder\GetterClassMethodPropertyFinder;
 use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -32,7 +25,8 @@ final class DocblockGetterReturnArrayFromPropertyDocblockVarRector extends Abstr
     public function __construct(
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
         private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer,
-        private readonly NodeDocblockTypeDecorator $nodeDocblockTypeDecorator
+        private readonly NodeDocblockTypeDecorator $nodeDocblockTypeDecorator,
+        private readonly GetterClassMethodPropertyFinder $getterClassMethodPropertyFinder,
     ) {
     }
 
@@ -108,13 +102,12 @@ public function refactor(Node $node): ?Node
                 continue;
             }
 
-            // @todo add promoted proeprty
-            $property = $this->matchReturnLocalPropertyFetch($classMethod, $node);
-            if (! $property instanceof Property) {
+            $propertyOrParam = $this->getterClassMethodPropertyFinder->find($classMethod, $node);
+            if (! $propertyOrParam instanceof Node) {
                 continue;
             }
 
-            $propertyDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($property);
+            $propertyDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($propertyOrParam);
 
             $varTagValueNode = $propertyDocInfo->getVarTagValueNode();
 
@@ -144,50 +137,4 @@ public function refactor(Node $node): ?Node
 
         return $node;
     }
-
-    private function matchReturnLocalPropertyFetch(ClassMethod $classMethod, Class_ $class): ?Property
-    {
-        // we need exactly one statement of return
-        if ($classMethod->stmts === null || count($classMethod->stmts) !== 1) {
-            return null;
-        }
-
-        $onlyStmt = $classMethod->stmts[0];
-        if (! $onlyStmt instanceof Return_) {
-            return null;
-        }
-
-        if (! $onlyStmt->expr instanceof PropertyFetch) {
-            return null;
-        }
-
-        $propertyFetch = $onlyStmt->expr;
-        if (! $this->isName($propertyFetch->var, 'this')) {
-            return null;
-        }
-
-        $propertyName = $this->getName($propertyFetch->name);
-        if (! is_string($propertyName)) {
-            return null;
-        }
-
-        return $class->getProperty($propertyName);
-    }
-
-    private function isUsefulType(Type $type): bool
-    {
-        if ($type instanceof UnionType) {
-            return false;
-        }
-
-        if (! $type instanceof ArrayType) {
-            return true;
-        }
-
-        if (! $type->getKeyType() instanceof MixedType) {
-            return true;
-        }
-
-        return ! $type->getItemType() instanceof MixedType;
-    }
 }

src/BetterPhpDocParser/PhpDocManipulator/PhpDocTypeChanger.php

@@ -28,7 +28,6 @@
 use Rector\BetterPhpDocParser\ValueObject\Type\SpacingAwareArrayTypeNode;
 use Rector\BetterPhpDocParser\ValueObject\Type\SpacingAwareCallableTypeNode;
 use Rector\Comments\NodeDocBlock\DocBlockUpdater;
-use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\NodeTypeResolver\TypeComparator\TypeComparator;
 use Rector\StaticTypeMapper\StaticTypeMapper;
 use Rector\TypeDeclaration\PhpDocParser\ParamPhpDocNodeFactory;