[Docblock] Move DocBlockUpdater service usage from AbstractRector to …

…PhpDocTypeChanger (#4215) * [Docblock] Move DocBlockUpdater service usage on PhpDocTypeChanger * [ci-review] Rector Rectify * Fix test * fix phpstan * update changeVarTypeNode as well * Fix phpstan * fix --------- Co-authored-by: GitHub Action <actions@github.com>
rectorphp · Jun 14, 2023 · 20ec11e · 20ec11e
1 parent 2551618
commit 20ec11e
Show file tree

Hide file tree

Showing 15 changed files with 38 additions and 33 deletions.
diff --git a/packages/BetterPhpDocParser/PhpDocManipulator/PhpDocTypeChanger.php b/packages/BetterPhpDocParser/PhpDocManipulator/PhpDocTypeChanger.php
@@ -4,7 +4,9 @@
 
 namespace Rector\BetterPhpDocParser\PhpDocManipulator;
 
+use PhpParser\Node\FunctionLike;
 use PhpParser\Node\Param;
+use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Property;
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstFetchNode;
@@ -29,6 +31,7 @@
 use Rector\BetterPhpDocParser\ValueObject\Type\BracketsAwareUnionTypeNode;
 use Rector\BetterPhpDocParser\ValueObject\Type\SpacingAwareArrayTypeNode;
 use Rector\BetterPhpDocParser\ValueObject\Type\SpacingAwareCallableTypeNode;
+use Rector\Comments\NodeDocBlock\DocBlockUpdater;
 use Rector\NodeNameResolver\NodeNameResolver;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\NodeTypeResolver\TypeComparator\TypeComparator;
@@ -60,11 +63,12 @@ public function __construct(
         private readonly NodeNameResolver $nodeNameResolver,
         private readonly CommentsMerger $commentsMerger,
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
-        private readonly NewPhpDocFromPHPStanTypeGuard $newPhpDocFromPHPStanTypeGuard
+        private readonly NewPhpDocFromPHPStanTypeGuard $newPhpDocFromPHPStanTypeGuard,
+        private readonly DocBlockUpdater $docBlockUpdater
     ) {
     }
 
-    public function changeVarType(PhpDocInfo $phpDocInfo, Type $newType): void
+    public function changeVarType(Stmt $stmt, PhpDocInfo $phpDocInfo, Type $newType): void
     {
         // better skip, could crash hard
         if ($phpDocInfo->hasInvalidTag('@var')) {
@@ -102,9 +106,11 @@ public function changeVarType(PhpDocInfo $phpDocInfo, Type $newType): void
 
             $phpDocInfo->addTagValueNode($varTagValueNode);
         }
+
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($stmt);
     }
 
-    public function changeReturnType(PhpDocInfo $phpDocInfo, Type $newType): bool
+    public function changeReturnType(FunctionLike $functionLike, PhpDocInfo $phpDocInfo, Type $newType): bool
     {
         // better not touch this, can crash
         if ($phpDocInfo->hasInvalidTag('@return')) {
@@ -138,10 +144,12 @@ public function changeReturnType(PhpDocInfo $phpDocInfo, Type $newType): bool
             $phpDocInfo->addTagValueNode($returnTagValueNode);
         }
 
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($functionLike);
+
         return true;
     }
 
-    public function changeParamType(PhpDocInfo $phpDocInfo, Type $newType, Param $param, string $paramName): void
+    public function changeParamType(FunctionLike $functionLike, PhpDocInfo $phpDocInfo, Type $newType, Param $param, string $paramName): void
     {
         // better skip, could crash hard
         if ($phpDocInfo->hasInvalidTag('@param')) {
@@ -178,6 +186,8 @@ public function changeParamType(PhpDocInfo $phpDocInfo, Type $newType, Param $pa
             $paramTagValueNode = $this->paramPhpDocNodeFactory->create($phpDocTypeNode, $param);
             $phpDocInfo->addTagValueNode($paramTagValueNode);
         }
+
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($functionLike);
     }
 
     public function isAllowed(TypeNode $typeNode): bool
@@ -237,18 +247,20 @@ public function copyPropertyDocToParam(ClassMethod $classMethod, Property $prope
         $phpDocInfo = $classMethod->getAttribute(AttributeKey::PHP_DOC_INFO);
         $paramType = $this->staticTypeMapper->mapPHPStanPhpDocTypeToPHPStanType($varTagValueNode, $property);
 
-        $this->changeParamType($phpDocInfo, $paramType, $param, $paramVarName);
+        $this->changeParamType($classMethod, $phpDocInfo, $paramType, $param, $paramVarName);
         $this->processKeepComments($property, $param);
     }
 
     /**
      * @api doctrine
      */
-    public function changeVarTypeNode(PhpDocInfo $phpDocInfo, TypeNode $typeNode): void
+    public function changeVarTypeNode(Stmt $stmt, PhpDocInfo $phpDocInfo, TypeNode $typeNode): void
     {
         // add completely new one
         $varTagValueNode = new VarTagValueNode($typeNode, '', '');
         $phpDocInfo->addTagValueNode($varTagValueNode);
+
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($stmt);
     }
 
     private function processKeepComments(Property $property, Param $param): void
@@ -259,6 +271,8 @@ private function processKeepComments(Property $property, Param $param): void
         $toBeRemoved = ! $varTagValueNode instanceof VarTagValueNode;
         $this->commentsMerger->keepComments($param, [$property]);
 
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($property);
+
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($param);
         $varTagValueNode = $phpDocInfo->getVarTagValueNode();
         if (! $toBeRemoved) {
@@ -274,5 +288,7 @@ private function processKeepComments(Property $property, Param $param): void
         }
 
         $phpDocInfo->removeByType(VarTagValueNode::class);
+
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($property);
     }
 }
diff --git a/...e/rename_class_without_namespace2.php.inc → ...er_rename_class_without_namespace.php.inc b/...e/rename_class_without_namespace2.php.inc → ...er_rename_class_without_namespace.php.inc
diff --git a/rules/CodeQuality/NodeFactory/PropertyTypeDecorator.php b/rules/CodeQuality/NodeFactory/PropertyTypeDecorator.php
@@ -27,6 +27,6 @@ public function decorateProperty(Property $property, Type $propertyType): void
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($property);
         $phpDocInfo->makeMultiLined();
 
-        $this->phpDocTypeChanger->changeVarType($phpDocInfo, $propertyType);
+        $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $propertyType);
     }
 }
diff --git a/rules/CodingStyle/Rector/ClassConst/VarConstantCommentRector.php b/rules/CodingStyle/Rector/ClassConst/VarConstantCommentRector.php
@@ -96,7 +96,7 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        $this->phpDocTypeChanger->changeVarType($phpDocInfo, $constType);
+        $this->phpDocTypeChanger->changeVarType($node, $phpDocInfo, $constType);
         if (! $phpDocInfo->hasChanged()) {
             return null;
         }

diff --git a/rules/Php80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector.php b/rules/Php80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector.php
@@ -251,7 +251,7 @@ private function decorateParamWithPropertyPhpDocInfo(
 
             $paramType = $this->staticTypeMapper->mapPHPStanPhpDocTypeToPHPStanType($varTagValueNode, $property);
             $classMethodPhpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($classMethod);
-            $this->phpDocTypeChanger->changeParamType($classMethodPhpDocInfo, $paramType, $param, $paramName);
+            $this->phpDocTypeChanger->changeParamType($classMethod, $classMethodPhpDocInfo, $paramType, $param, $paramName);
         } else {
             $paramType = $this->staticTypeMapper->mapPhpParserNodePHPStanType($param->type);
         }

diff --git a/rules/TypeDeclaration/NodeTypeAnalyzer/PropertyTypeDecorator.php b/rules/TypeDeclaration/NodeTypeAnalyzer/PropertyTypeDecorator.php
@@ -42,7 +42,7 @@ public function decoratePropertyUnionType(
             }
 
             if ($changeVarTypeFallback) {
-                $this->phpDocTypeChanger->changeVarType($phpDocInfo, $unionType);
+                $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $unionType);
             }
 
             return;
@@ -66,7 +66,7 @@ public function decoratePropertyUnionType(
             return;
         }
 
-        $this->phpDocTypeChanger->changeVarType($phpDocInfo, $unionType);
+        $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $unionType);
     }
 
     private function isDocBlockRequired(UnionType $unionType): bool

diff --git a/rules/TypeDeclaration/Rector/ClassMethod/AddVoidReturnTypeWhereNoReturnRector.php b/rules/TypeDeclaration/Rector/ClassMethod/AddVoidReturnTypeWhereNoReturnRector.php
@@ -137,15 +137,15 @@ public function configure(array $configuration): void
         $this->usePhpdoc = $usePhpdoc;
     }
 
-    private function changePhpDocToVoidIfNotNever(ClassMethod|Function_|Closure|Node $node): bool
+    private function changePhpDocToVoidIfNotNever(ClassMethod|Function_|Closure $node): bool
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
 
         if ($phpDocInfo->getReturnType() instanceof NeverType) {
             return false;
         }
 
-        return $this->phpDocTypeChanger->changeReturnType($phpDocInfo, new VoidType());
+        return $this->phpDocTypeChanger->changeReturnType($node, $phpDocInfo, new VoidType());
     }
 
     private function shouldSkipClassMethod(ClassMethod|Function_|Closure $functionLike): bool

diff --git a/rules/TypeDeclaration/Rector/ClassMethod/ArrayShapeFromConstantArrayReturnRector.php b/rules/TypeDeclaration/Rector/ClassMethod/ArrayShapeFromConstantArrayReturnRector.php
@@ -129,7 +129,7 @@ public function refactorWithScope(Node $node, Scope $scope): ?Node
             return null;
         }
 
-        $hasChanged = $this->phpDocTypeChanger->changeReturnType($phpDocInfo, $returnExprType);
+        $hasChanged = $this->phpDocTypeChanger->changeReturnType($node, $phpDocInfo, $returnExprType);
         if (! $hasChanged) {
             return null;
         }

diff --git a/rules/TypeDeclaration/Rector/ClassMethod/ReturnAnnotationIncorrectNullableRector.php b/rules/TypeDeclaration/Rector/ClassMethod/ReturnAnnotationIncorrectNullableRector.php
@@ -117,7 +117,7 @@ public function refactorWithScope(Node $node, Scope $scope): ?Node
             return null;
         }
 
-        $hasReturnTypeChanged = $this->phpDocTypeChanger->changeReturnType($phpDocInfo, $updatedPhpDocType);
+        $hasReturnTypeChanged = $this->phpDocTypeChanger->changeReturnType($node, $phpDocInfo, $updatedPhpDocType);
 
         if ($hasReturnTypeChanged) {
             return $node;

diff --git a/rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictNewArrayRector.php b/rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictNewArrayRector.php
@@ -165,14 +165,14 @@ private function shouldSkip(ClassMethod|Function_|Closure $node, Scope $scope):
         );
     }
 
-    private function changeReturnType(Node $node, Type $exprType): void
+    private function changeReturnType(ClassMethod|Function_|Closure $node, Type $exprType): void
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
 
         $exprType = $this->narrowConstantArrayType($exprType);
 
         if (! $this->typeComparator->isSubtype($phpDocInfo->getReturnType(), $exprType)) {
-            $this->phpDocTypeChanger->changeReturnType($phpDocInfo, $exprType);
+            $this->phpDocTypeChanger->changeReturnType($node, $phpDocInfo, $exprType);
         }
     }
 

diff --git a/rules/TypeDeclaration/Rector/FunctionLike/AddParamTypeSplFixedArrayRector.php b/rules/TypeDeclaration/Rector/FunctionLike/AddParamTypeSplFixedArrayRector.php
@@ -114,7 +114,7 @@ public function refactor(Node $node): ?Node
             }
 
             $paramName = $this->getName($param);
-            $this->phpDocTypeChanger->changeParamType($functionLikePhpDocInfo, $genericParamType, $param, $paramName);
+            $this->phpDocTypeChanger->changeParamType($node, $functionLikePhpDocInfo, $genericParamType, $param, $paramName);
         }
 
         if ($functionLikePhpDocInfo->hasChanged()) {

diff --git a/rules/TypeDeclaration/Rector/Property/TypedPropertyFromStrictConstructorRector.php b/rules/TypeDeclaration/Rector/Property/TypedPropertyFromStrictConstructorRector.php
@@ -110,7 +110,7 @@ public function refactor(Node $node): ?Node
 
             // public property can be anything
             if ($property->isPublic()) {
-                $this->phpDocTypeChanger->changeVarType($phpDocInfo, $propertyType);
+                $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $propertyType);
                 $hasChanged = true;
                 continue;
             }

diff --git a/rules/TypeDeclaration/Rector/Property/VarAnnotationIncorrectNullableRector.php b/rules/TypeDeclaration/Rector/Property/VarAnnotationIncorrectNullableRector.php
@@ -115,7 +115,7 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        $this->phpDocTypeChanger->changeVarType($phpDocInfo, $updatedPhpDocType);
+        $this->phpDocTypeChanger->changeVarType($node, $phpDocInfo, $updatedPhpDocType);
 
         if (! $phpDocInfo->hasChanged()) {
             return null;

diff --git a/src/NodeDecorator/PropertyTypeDecorator.php b/src/NodeDecorator/PropertyTypeDecorator.php
@@ -39,13 +39,13 @@ public function decorate(Property $property, ?Type $type): void
                 $property->type = $phpParserType;
 
                 if ($type instanceof GenericObjectType) {
-                    $this->phpDocTypeChanger->changeVarType($phpDocInfo, $type);
+                    $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $type);
                 }
 
                 return;
             }
         }
 
-        $this->phpDocTypeChanger->changeVarType($phpDocInfo, $type);
+        $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $type);
     }
 }
diff --git a/src/Rector/AbstractRector.php b/src/Rector/AbstractRector.php
@@ -19,7 +19,6 @@
 use PHPStan\Type\Type;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
-use Rector\Comments\NodeDocBlock\DocBlockUpdater;
 use Rector\Core\Application\ChangedNodeScopeRefresher;
 use Rector\Core\Configuration\CurrentNodeProvider;
 use Rector\Core\Console\Output\RectorOutputStyle;
@@ -104,8 +103,6 @@ abstract class AbstractRector extends NodeVisitorAbstract implements PhpRectorIn
 
     private FilePathHelper $filePathHelper;
 
-    private DocBlockUpdater $docBlockUpdater;
-
     private NodeConnectingTraverser $nodeConnectingTraverser;
 
     private ?string $toBeRemovedNodeHash = null;
@@ -130,7 +127,6 @@ public function autowire(
         ChangedNodeScopeRefresher $changedNodeScopeRefresher,
         RectorOutputStyle $rectorOutputStyle,
         FilePathHelper $filePathHelper,
-        DocBlockUpdater $docBlockUpdater,
         NodeConnectingTraverser $nodeConnectingTraverser
     ): void {
         $this->nodeNameResolver = $nodeNameResolver;
@@ -151,7 +147,6 @@ public function autowire(
         $this->changedNodeScopeRefresher = $changedNodeScopeRefresher;
         $this->rectorOutputStyle = $rectorOutputStyle;
         $this->filePathHelper = $filePathHelper;
-        $this->docBlockUpdater = $docBlockUpdater;
         $this->nodeConnectingTraverser = $nodeConnectingTraverser;
     }
 
@@ -392,12 +387,6 @@ private function refreshScopeNodes(array | Node $node, string $filePath, ?Mutati
         $nodes = $node instanceof Node ? [$node] : $node;
 
         foreach ($nodes as $node) {
-            /**
-             * Early refresh Doc Comment of Node before refresh Scope to ensure doc node is latest update
-             * to make PHPStan type can be correctly detected
-             */
-            $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
-
             $this->changedNodeScopeRefresher->refresh($node, $mutatingScope, $filePath);
         }
     }