re-use CommentsMerger service to decouple logic from abstract rector

Author: TomasVotruba

src/BetterPhpDocParser/Comment/CommentsMerger.php

@@ -5,10 +5,48 @@
 namespace Rector\BetterPhpDocParser\Comment;
 
 use PhpParser\Node;
+use PhpParser\Node\Stmt\InlineHTML;
+use PhpParser\Node\Stmt\Nop;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
 use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\PhpParser\Comparing\NodeComparator;
 
 final class CommentsMerger
 {
+    public function __construct(
+        private readonly NodeComparator $nodeComparator,
+    ) {
+    }
+
+    public function mirrorComments(Node $newNode, Node $oldNode): void
+    {
+        if ($oldNode instanceof InlineHTML) {
+            return;
+        }
+
+        if ($this->nodeComparator->areSameNode($newNode, $oldNode)) {
+            return;
+        }
+
+        $oldPhpDocInfo = $oldNode->getAttribute(AttributeKey::PHP_DOC_INFO);
+        $newPhpDocInfo = $newNode->getAttribute(AttributeKey::PHP_DOC_INFO);
+
+        if ($newPhpDocInfo instanceof PhpDocInfo) {
+            if (! $oldPhpDocInfo instanceof PhpDocInfo) {
+                return;
+            }
+
+            if ((string) $oldPhpDocInfo->getPhpDocNode() !== (string) $newPhpDocInfo->getPhpDocNode()) {
+                return;
+            }
+        }
+
+        $newNode->setAttribute(AttributeKey::PHP_DOC_INFO, $oldPhpDocInfo);
+        if (! $newNode instanceof Nop) {
+            $newNode->setAttribute(AttributeKey::COMMENTS, $oldNode->getAttribute(AttributeKey::COMMENTS));
+        }
+    }
+
     /**
      * @param Node[] $mergedNodes
      */

src/DependencyInjection/LazyContainerFactory.php

@@ -17,6 +17,7 @@
 use Rector\Application\ChangedNodeScopeRefresher;
 use Rector\Application\FileProcessor;
 use Rector\Application\Provider\CurrentFileProvider;
+use Rector\BetterPhpDocParser\Comment\CommentsMerger;
 use Rector\BetterPhpDocParser\Contract\BasePhpDocNodeVisitorInterface;
 use Rector\BetterPhpDocParser\Contract\PhpDocParser\PhpDocNodeDecoratorInterface;
 use Rector\BetterPhpDocParser\PhpDocNodeMapper;
@@ -558,6 +559,7 @@ static function (AbstractRector $rector, Container $container): void {
                     $container->get(CurrentFileProvider::class),
                     $container->get(CreatedByRuleDecorator::class),
                     $container->get(ChangedNodeScopeRefresher::class),
+                    $container->get(CommentsMerger::class),
                 );
             }
         );

src/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ContextNodeVisitor.php

@@ -11,6 +11,7 @@
 use PhpParser\Node\Expr\ArrayDimFetch;
 use PhpParser\Node\Expr\BinaryOp\BooleanAnd;
 use PhpParser\Node\Expr\Closure;
+use PhpParser\Node\Expr\Isset_;
 use PhpParser\Node\Expr\PostDec;
 use PhpParser\Node\Expr\PostInc;
 use PhpParser\Node\Expr\PreDec;
@@ -61,13 +62,15 @@ public function enterNode(Node $node): ?Node
             foreach ($node->vars as $var) {
                 $var->setAttribute(AttributeKey::IS_UNSET_VAR, true);
             }
+
             return null;
         }
 
-        if ($node instanceof Node\Expr\Isset_) {
+        if ($node instanceof Isset_) {
             foreach ($node->vars as $var) {
                 $var->setAttribute(AttributeKey::IS_ISSET_VAR, true);
             }
+
             return null;
         }
 

src/Rector/AbstractRector.php

@@ -9,9 +9,7 @@
 use PhpParser\Node\PropertyItem;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Const_;
-use PhpParser\Node\Stmt\InlineHTML;
 use PhpParser\Node\Stmt\Interface_;
-use PhpParser\Node\Stmt\Nop;
 use PhpParser\Node\Stmt\Property;
 use PhpParser\Node\Stmt\Trait_;
 use PhpParser\NodeTraverser;
@@ -22,7 +20,7 @@
 use PHPStan\Type\Type;
 use Rector\Application\ChangedNodeScopeRefresher;
 use Rector\Application\Provider\CurrentFileProvider;
-use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
+use Rector\BetterPhpDocParser\Comment\CommentsMerger;
 use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
 use Rector\Contract\Rector\HTMLAverseRectorInterface;
 use Rector\Contract\Rector\RectorInterface;
@@ -72,6 +70,8 @@ abstract class AbstractRector extends NodeVisitorAbstract implements RectorInter
 
     private CurrentFileProvider $currentFileProvider;
 
+    private CommentsMerger $commentsMerger;
+
     /**
      * @var array<int, Node[]>
      */
@@ -90,7 +90,8 @@ public function autowire(
         NodeComparator $nodeComparator,
         CurrentFileProvider $currentFileProvider,
         CreatedByRuleDecorator $createdByRuleDecorator,
-        ChangedNodeScopeRefresher $changedNodeScopeRefresher
+        ChangedNodeScopeRefresher $changedNodeScopeRefresher,
+        CommentsMerger $commentsMerger
     ): void {
         $this->nodeNameResolver = $nodeNameResolver;
         $this->nodeTypeResolver = $nodeTypeResolver;
@@ -101,6 +102,7 @@ public function autowire(
         $this->currentFileProvider = $currentFileProvider;
         $this->createdByRuleDecorator = $createdByRuleDecorator;
         $this->changedNodeScopeRefresher = $changedNodeScopeRefresher;
+        $this->commentsMerger = $commentsMerger;
     }
 
     /**
@@ -183,7 +185,7 @@ final public function enterNode(Node $node): int|Node|null
      * Replacing nodes in leaveNode() method avoids infinite recursion
      * see"infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
      *
-     * @return \PhpParser\Node|\PhpParser\Node[]|NodeVisitor::REMOVE_NODE|null
+     * @return Node|Node[]|NodeVisitor::REMOVE_NODE|null
      */
     final public function leaveNode(Node $node): array|int|Node|null
     {
@@ -263,31 +265,7 @@ protected function traverseNodesWithCallable(Node | array $nodes, callable $call
 
     protected function mirrorComments(Node $newNode, Node $oldNode): void
     {
-        if ($this->nodeComparator->areSameNode($newNode, $oldNode)) {
-            return;
-        }
-
-        if ($oldNode instanceof InlineHTML) {
-            return;
-        }
-
-        $oldPhpDocInfo = $oldNode->getAttribute(AttributeKey::PHP_DOC_INFO);
-        $newPhpDocInfo = $newNode->getAttribute(AttributeKey::PHP_DOC_INFO);
-
-        if ($newPhpDocInfo instanceof PhpDocInfo) {
-            if (! $oldPhpDocInfo instanceof PhpDocInfo) {
-                return;
-            }
-
-            if ((string) $oldPhpDocInfo->getPhpDocNode() !== (string) $newPhpDocInfo->getPhpDocNode()) {
-                return;
-            }
-        }
-
-        $newNode->setAttribute(AttributeKey::PHP_DOC_INFO, $oldPhpDocInfo);
-        if (! $newNode instanceof Nop) {
-            $newNode->setAttribute(AttributeKey::COMMENTS, $oldNode->getAttribute(AttributeKey::COMMENTS));
-        }
+        $this->commentsMerger->mirrorComments($newNode, $oldNode);
     }
 
     /**