add fixture and test

Author: TomasVotruba

config/set/type-declaration-docblocks.php

@@ -6,6 +6,7 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnDocblockForScalarArrayFromAssignsRector;
 use Rector\TypeDeclarationDocblocks\Rector\Class_\DocblockVarFromParamDocblockInConstructorRector;
+use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockGetterReturnArrayFromPropertyDocblockVarRector;
 
 /**
@@ -18,5 +19,6 @@
         DocblockVarFromParamDocblockInConstructorRector::class,
         DocblockVarFromParamDocblockInConstructorRector::class,
         DocblockGetterReturnArrayFromPropertyDocblockVarRector::class,
+        AddReturnDocblockForCommonObjectDenominatorRector::class,
     ]);
 };

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForCommonObjectDenominatorRector/Fixture/return_of_objects.php.inc

@@ -0,0 +1,42 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector\Source\FirstExtension;
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector\Source\SecondExtension;
+
+final class ReturnOfObjects
+{
+    public function getExtensions(): array
+    {
+        return [
+            new FirstExtension(),
+            new SecondExtension()
+        ];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector\Source\FirstExtension;
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector\Source\SecondExtension;
+
+final class ReturnOfObjects
+{
+    /**
+     * @return \Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector\Source\ExtensionInterface[]
+     */
+    public function getExtensions(): array
+    {
+        return [
+            new FirstExtension(),
+            new SecondExtension()
+        ];
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForCommonObjectDenominatorRector/Fixture/some_property_with_array_docblock.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockGetterReturnArrayFromPropertyDocblockVarRector\Fixture;
+
+final class SomePropertyWithArrayDocblock
+{
+    /**
+     * @var string[]
+     */
+    private array $names = [];
+
+    public function getNames(): array
+    {
+        return $this->names;
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForCommonObjectDenominatorRector/Fixture/some_property_with_array_docblock.php.inc

@@ -3,8 +3,7 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector;
 
 return RectorConfig::configure()
-    ->withRules(
-        [\Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector::class]
-    );
+    ->withRules([AddReturnDocblockForCommonObjectDenominatorRector::class]);

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForCommonObjectDenominatorRector/config/configured_rule.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclarationDocblocks\NodeFinder;
+
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Function_;
+use PhpParser\Node\Stmt\Return_;
+use Rector\PhpParser\Node\BetterNodeFinder;
+use Rector\TypeDeclaration\NodeAnalyzer\ReturnAnalyzer;
+
+final readonly class ReturnNodeFinder
+{
+    public function __construct(
+        private BetterNodeFinder $betterNodeFinder,
+        private ReturnAnalyzer $returnAnalyzer,
+    ) {
+    }
+
+    public function findOnlyReturnWithExpr(ClassMethod|Function_ $functionLike): ?Return_
+    {
+        $returnsScoped = $this->betterNodeFinder->findReturnsScoped($functionLike);
+        if (! $this->returnAnalyzer->hasOnlyReturnWithExpr($functionLike, $returnsScoped)) {
+            return null;
+        }
+
+        return $returnsScoped[0];
+    }
+}

rules/TypeDeclarationDocblocks/NodeFinder/ReturnNodeFinder.php

@@ -5,15 +5,19 @@
 namespace Rector\TypeDeclarationDocblocks\Rector\ClassMethod;
 
 use PhpParser\Node;
+use PhpParser\Node\Expr;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Function_;
+use PhpParser\Node\Stmt\Return_;
+use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Type\ArrayType;
+use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\MixedType;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
-use Rector\PhpParser\Node\BetterNodeFinder;
 use Rector\Rector\AbstractRector;
-use Rector\TypeDeclaration\NodeAnalyzer\ReturnAnalyzer;
+use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;
+use Rector\TypeDeclarationDocblocks\NodeFinder\ReturnNodeFinder;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -23,10 +27,10 @@
 final class AddReturnDocblockForCommonObjectDenominatorRector extends AbstractRector
 {
     public function __construct(
-        private readonly BetterNodeFinder $betterNodeFinder,
-        private readonly ReturnAnalyzer $returnAnalyzer,
-        private readonly PhpDocTypeChanger $phpDocTypeChanger,
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
+        private readonly ReturnNodeFinder $returnNodeFinder,
+        private readonly ReflectionProvider $reflectionProvider,
+        private readonly PhpDocTypeChanger $phpDocTypeChanger,
     ) {
     }
 
@@ -35,8 +39,8 @@ public function getRuleDefinition(): RuleDefinition
         return new RuleDefinition(
             'Add @return docblock array of objects, that have common denominator interface/parent class',
             [
-            new CodeSample(
-                <<<'CODE_SAMPLE'
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
 final class ExtensionProvider
 {
     public function getExtensions(): array
@@ -56,8 +60,8 @@ class SecondExtension implements ExtensionInterface
 {
 }
 CODE_SAMPLE
-                ,
-                <<<'CODE_SAMPLE'
+                    ,
+                    <<<'CODE_SAMPLE'
 final class ExtensionProvider
 {
     /**
@@ -80,9 +84,10 @@ class SecondExtension implements ExtensionInterface
 {
 }
 CODE_SAMPLE
-            ),
-        
-        ]);
+                ),
+
+            ]
+        );
     }
 
     /**
@@ -105,26 +110,62 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        dump(123);
-        die;
-
+        // definitely not an array return
         if ($node->returnType instanceof Node && ! $this->isName($node->returnType, 'array')) {
             return null;
         }
 
-        $returnsScoped = $this->betterNodeFinder->findReturnsScoped($node);
+        $onlyReturnWithExpr = $this->returnNodeFinder->findOnlyReturnWithExpr($node);
+        if (! $onlyReturnWithExpr instanceof Return_ || ! $onlyReturnWithExpr->expr instanceof Expr) {
+            return null;
+        }
+
+        $returnedType = $this->getType($onlyReturnWithExpr->expr);
+        if (! $returnedType instanceof ArrayType && ! $returnedType instanceof ConstantArrayType) {
+            return null;
+        }
 
-        if (! $this->returnAnalyzer->hasOnlyReturnWithExpr($node, $returnsScoped)) {
+        $referencedClasses = $returnedType->getReferencedClasses();
+        // nothing to find here
+        if ($referencedClasses === []) {
             return null;
         }
 
-        //        $arrayType = new ArrayType(new MixedType(), $firstScalarType);
-        //
-        //        $hasChanged = $this->phpDocTypeChanger->changeReturnType($node, $phpDocInfo, $arrayType);
-        //        if ($hasChanged) {
-        //            return $node;
-        //        }
+        $parentClassesAndInterfaces = [];
+
+        foreach ($referencedClasses as $referencedClass) {
+            $parentClassesAndInterfaces[] = $this->resolveParentClassesAndInterfaces($referencedClass);
+        }
+
+        $firstSharedTypes = array_intersect(...$parentClassesAndInterfaces);
+        $firstSharedType = $firstSharedTypes[0] ?? null;
+
+        if ($firstSharedType === null) {
+            return null;
+        }
+
+        $objectTypeArrayType = new ArrayType(new MixedType(), new FullyQualifiedObjectType($firstSharedType));
+        $hasChanged = $this->phpDocTypeChanger->changeReturnType($node, $phpDocInfo, $objectTypeArrayType);
+        if (! $hasChanged) {
+            return null;
+        }
+
+        return $node;
+    }
+
+    /**
+     * @return string[]
+     */
+    private function resolveParentClassesAndInterfaces(string $className): array
+    {
+        $referenceClassReflection = $this->reflectionProvider->getClass($className);
+
+        $currentParentClassesAndInterfaces = $referenceClassReflection->getParentClassesNames();
+
+        foreach ($referenceClassReflection->getInterfaces() as $classReflection) {
+            $currentParentClassesAndInterfaces[] = $classReflection->getName();
+        }
 
-        return null;
+        return $currentParentClassesAndInterfaces;
     }
 }