update DocblockGetterReturnArrayFromPropertyDocblockVarRector too

Author: TomasVotruba

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForJsonArrayRector/Fixture/override_dummy_array.php.inc

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForJsonArrayRector\Fixture;
+
+final class OverrideDummyArray
+{
+    /**
+     * @return array
+     */
+    public function provide(string $contents): array
+    {
+        return json_decode($contents, true);
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForJsonArrayRector\Fixture;
+
+final class OverrideDummyArray
+{
+    /**
+     * @return array<string, mixed>
+     */
+    public function provide(string $contents): array
+    {
+        return json_decode($contents, true);
+    }
+}
+
+?>

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

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

rules/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForJsonArrayRector.php

@@ -12,7 +12,6 @@
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Function_;
 use PhpParser\Node\Stmt\Return_;
-use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\StringType;
@@ -22,6 +21,7 @@
 use Rector\Rector\AbstractRector;
 use Rector\TypeDeclarationDocblocks\Enum\NetteClassName;
 use Rector\TypeDeclarationDocblocks\NodeFinder\ReturnNodeFinder;
+use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -34,7 +34,8 @@ public function __construct(
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
         private readonly ReturnNodeFinder $returnNodeFinder,
         private readonly PhpDocTypeChanger $phpDocTypeChanger,
-        private readonly ValueResolver $valueResolver
+        private readonly ValueResolver $valueResolver,
+        private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer
     ) {
     }
 
@@ -85,11 +86,6 @@ public function getNodeTypes(): array
     public function refactor(Node $node): ?Node
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
-        $returnType = $phpDocInfo->getReturnType();
-
-        if (! $returnType instanceof MixedType || $returnType->isExplicitMixed()) {
-            return null;
-        }
 
         // definitely not an array return
         if ($node->returnType instanceof Node && ! $this->isName($node->returnType, 'array')) {
@@ -111,8 +107,8 @@ public function refactor(Node $node): ?Node
         }
 
         $classMethodDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
-        // already filled
-        if ($classMethodDocInfo->getReturnTagValue() instanceof ReturnTagValueNode) {
+
+        if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($classMethodDocInfo->getReturnTagValue())) {
             return null;
         }
 

rules/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockGetterReturnArrayFromPropertyDocblockVarRector.php

@@ -8,14 +8,14 @@
 use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Return_;
-use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\UnionType;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
-use Rector\Comments\NodeDocBlock\DocBlockUpdater;
+use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
 use Rector\Rector\AbstractRector;
 use Rector\StaticTypeMapper\StaticTypeMapper;
+use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -26,8 +26,9 @@ final class DocblockGetterReturnArrayFromPropertyDocblockVarRector extends Abstr
 {
     public function __construct(
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
-        private readonly DocBlockUpdater $docBlockUpdater,
-        private readonly StaticTypeMapper $staticTypeMapper
+        private readonly StaticTypeMapper $staticTypeMapper,
+        private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer,
+        private readonly PhpDocTypeChanger $phpDocTypeChanger
     ) {
     }
 
@@ -91,11 +92,15 @@ public function refactor(Node $node): ?Node
 
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
 
-        // return tag is already given
-        if ($phpDocInfo->getReturnTagValue() instanceof ReturnTagValueNode) {
+        if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($phpDocInfo->getReturnTagValue())) {
             return null;
         }
 
+        //        // return tag is already given
+        //        if ($phpDocInfo->getReturnTagValue() instanceof ReturnTagValueNode) {
+        //            return null;
+        //        }
+
         $propertyFetch = $this->matchReturnLocalPropertyFetch($node);
         if (! $propertyFetch instanceof PropertyFetch) {
             return null;
@@ -115,10 +120,12 @@ public function refactor(Node $node): ?Node
 
         $propertyFetchDocTypeNode = $this->staticTypeMapper->mapPHPStanTypeToPHPStanPhpDocTypeNode($propertyFetchType);
 
-        $returnTagValueNode = new ReturnTagValueNode($propertyFetchDocTypeNode, '');
-        $phpDocInfo->addTagValueNode($returnTagValueNode);
+        $this->phpDocTypeChanger->changeReturnTypeNode($node, $phpDocInfo, $propertyFetchDocTypeNode);
 
-        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
+        //        $returnTagValueNode = new ReturnTagValueNode($propertyFetchDocTypeNode, '');
+        //        $phpDocInfo->addTagValueNode($returnTagValueNode);
+        //
+        //        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
 
         return $node;
     }