[internal] Move RectorNodeTraverser logic up to AbstractImmutableNodeTraverser

phpstan.neon

@@ -5,7 +5,7 @@ includes:
 parameters:
     level: 8
 
-    # reportUnmatchedIgnoredErrors: false
+    reportUnmatchedIgnoredErrors: false
 
     errorFormat: symplify
 
@@ -373,9 +373,6 @@ parameters:
         - '#Method Rector\\Utils\\Rector\\RemoveRefactorDuplicatedNodeInstanceCheckRector\:\:getInstanceofNodeClass\(\) should return class\-string<PhpParser\\Node>\|null but returns class\-string#'
 
         # copied from /vendor, to keep as original as possible
-        -
-            identifier: missingType.iterableValue
-            path: src/PhpParser/NodeTraverser/AbstractImmutableNodeTraverser.php
         -
             identifier: symplify.noDynamicName
             path: src/PhpParser/NodeTraverser/AbstractImmutableNodeTraverser.php

src/PhpParser/NodeTraverser/AbstractImmutableNodeTraverser.php

@@ -10,7 +10,13 @@
 use PhpParser\Node\Stmt;
 use PhpParser\NodeTraverserInterface;
 use PhpParser\NodeVisitor;
+use Rector\Configuration\ConfigurationRuleFilter;
+use Rector\Contract\Rector\RectorInterface;
 use Rector\Exception\ShouldNotHappenException;
+use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
+use Rector\PhpParser\Node\FileNode;
+use Rector\VersionBonding\PhpVersionedFilter;
+use Webmozart\Assert\Assert;
 
 abstract class AbstractImmutableNodeTraverser implements NodeTraverserInterface
 {
@@ -24,14 +30,21 @@ abstract class AbstractImmutableNodeTraverser implements NodeTraverserInterface
      */
     protected bool $stopTraversal;
 
+    private bool $areNodeVisitorsPrepared = false;
+
     /**
-     * Create a traverser with the given visitors.
-     *
-     * @param NodeVisitor ...$visitors Node visitors
+     * @var array<class-string<Node>, NodeVisitor[]>
      */
-    public function __construct(NodeVisitor ...$visitors)
-    {
-        $this->visitors = $visitors;
+    private array $visitorsPerNodeClass = [];
+
+    /**
+     * @param RectorInterface[] $rectors
+     */
+    public function __construct(
+        private readonly PhpVersionedFilter $phpVersionedFilter,
+        private readonly ConfigurationRuleFilter $configurationRuleFilter,
+        private array $rectors
+    ) {
     }
 
     public function addVisitor(NodeVisitor $visitor): void
@@ -45,14 +58,13 @@ public function removeVisitor(NodeVisitor $visitor): void
     }
 
     /**
-     * Traverses an array of nodes using the registered visitors.
-     *
-     * @param Node[] $nodes Array of nodes
-     *
-     * @return Node[] Traversed array of nodes
+     * @param Node[] $nodes
+     * @return Node[]
      */
     public function traverse(array $nodes): array
     {
+        $this->prepareNodeVisitors();
+
         $this->stopTraversal = false;
         foreach ($this->visitors as $visitor) {
             if (null !== $return = $visitor->beforeTraverse($nodes)) {
@@ -71,10 +83,54 @@ public function traverse(array $nodes): array
         return $nodes;
     }
 
+    /**
+     * @param RectorInterface[] $rectors
+     * @api used in tests to update the active rules
+     *
+     * @internal Used only in Rector core, not supported outside. Might change any time.
+     */
+    public function refreshPhpRectors(array $rectors): void
+    {
+        Assert::allIsInstanceOf($rectors, RectorInterface::class);
+
+        $this->rectors = $rectors;
+        $this->visitors = [];
+        $this->visitorsPerNodeClass = [];
+
+        $this->areNodeVisitorsPrepared = false;
+
+        $this->prepareNodeVisitors();
+    }
+
     /**
      * @return NodeVisitor[]
      */
-    abstract public function getVisitorsForNode(Node $node): array;
+    public function getVisitorsForNode(Node $node): array
+    {
+        $nodeClass = $node::class;
+
+        if (! isset($this->visitorsPerNodeClass[$nodeClass])) {
+            $this->visitorsPerNodeClass[$nodeClass] = [];
+
+            /** @var RectorInterface $visitor */
+            foreach ($this->visitors as $visitor) {
+                foreach ($visitor->getNodeTypes() as $nodeType) {
+                    // BC layer matching
+                    if ($nodeType === FileWithoutNamespace::class && $nodeClass === FileNode::class) {
+                        $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
+                        continue;
+                    }
+
+                    if (is_a($nodeClass, $nodeType, true)) {
+                        $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
+                        continue 2;
+                    }
+                }
+            }
+        }
+
+        return $this->visitorsPerNodeClass[$nodeClass];
+    }
 
     protected function traverseNode(Node $node): void
     {
@@ -139,7 +195,7 @@ protected function traverseNode(Node $node): void
 
     /**
      * @param Node[] $nodes
-     * @return array Result of traversal (may be original array or changed one)
+     * @return Node[]
      */
     protected function traverseArray(array $nodes): array
     {
@@ -233,4 +289,24 @@ private function ensureReplacementReasonable(Node $old, Node $new): void
             );
         }
     }
+
+    /**
+     * This must happen after $this->configuration is set after ProcessCommand::execute() is run, otherwise we get default false positives.
+     *
+     * This should be removed after https://github.com/rectorphp/rector/issues/5584 is resolved
+     */
+    private function prepareNodeVisitors(): void
+    {
+        if ($this->areNodeVisitorsPrepared) {
+            return;
+        }
+
+        // filer out by version
+        $this->visitors = $this->phpVersionedFilter->filter($this->rectors);
+
+        // filter by configuration
+        $this->visitors = $this->configurationRuleFilter->filter($this->visitors);
+
+        $this->areNodeVisitorsPrepared = true;
+    }
 }

src/PhpParser/NodeTraverser/RectorNodeTraverser.php

@@ -4,116 +4,9 @@
 
 namespace Rector\PhpParser\NodeTraverser;
 
-use PhpParser\Node;
-use PhpParser\Node\Stmt;
-use PhpParser\NodeVisitor;
-use Rector\Configuration\ConfigurationRuleFilter;
-use Rector\Contract\Rector\RectorInterface;
-use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
-use Rector\PhpParser\Node\FileNode;
-use Rector\VersionBonding\PhpVersionedFilter;
-use Webmozart\Assert\Assert;
-
 /**
  * @see \Rector\Tests\PhpParser\NodeTraverser\RectorNodeTraverserTest
  */
 final class RectorNodeTraverser extends AbstractImmutableNodeTraverser
 {
-    private bool $areNodeVisitorsPrepared = false;
-
-    /**
-     * @var array<class-string<Node>, NodeVisitor[]>
-     */
-    private array $visitorsPerNodeClass = [];
-
-    /**
-     * @param RectorInterface[] $rectors
-     */
-    public function __construct(
-        private array $rectors,
-        private readonly PhpVersionedFilter $phpVersionedFilter,
-        private readonly ConfigurationRuleFilter $configurationRuleFilter,
-    ) {
-        parent::__construct();
-    }
-
-    /**
-     * @param Stmt[] $nodes
-     * @return Stmt[]
-     */
-    public function traverse(array $nodes): array
-    {
-        $this->prepareNodeVisitors();
-
-        return parent::traverse($nodes);
-    }
-
-    /**
-     * @param RectorInterface[] $rectors
-     * @api used in tests to update the active rules
-     *
-     * @internal Used only in Rector core, not supported outside. Might change any time.
-     */
-    public function refreshPhpRectors(array $rectors): void
-    {
-        Assert::allIsInstanceOf($rectors, RectorInterface::class);
-
-        $this->rectors = $rectors;
-        $this->visitors = [];
-        $this->visitorsPerNodeClass = [];
-
-        $this->areNodeVisitorsPrepared = false;
-
-        $this->prepareNodeVisitors();
-    }
-
-    /**
-     * @return NodeVisitor[]
-     */
-    public function getVisitorsForNode(Node $node): array
-    {
-        $nodeClass = $node::class;
-
-        if (! isset($this->visitorsPerNodeClass[$nodeClass])) {
-            $this->visitorsPerNodeClass[$nodeClass] = [];
-
-            /** @var RectorInterface $visitor */
-            foreach ($this->visitors as $visitor) {
-                foreach ($visitor->getNodeTypes() as $nodeType) {
-                    // BC layer matching
-                    if ($nodeType === FileWithoutNamespace::class && $nodeClass === FileNode::class) {
-                        $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
-                        continue;
-                    }
-
-                    if (is_a($nodeClass, $nodeType, true)) {
-                        $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
-                        continue 2;
-                    }
-                }
-            }
-        }
-
-        return $this->visitorsPerNodeClass[$nodeClass];
-    }
-
-    /**
-     * This must happen after $this->configuration is set after ProcessCommand::execute() is run, otherwise we get default false positives.
-     *
-     * This should be removed after https://github.com/rectorphp/rector/issues/5584 is resolved
-     */
-    private function prepareNodeVisitors(): void
-    {
-        if ($this->areNodeVisitorsPrepared) {
-            return;
-        }
-
-        // filer out by version
-        $this->visitors = $this->phpVersionedFilter->filter($this->rectors);
-
-        // filter by configuration
-        $this->visitors = $this->configurationRuleFilter->filter($this->visitors);
-
-        $this->areNodeVisitorsPrepared = true;
-    }
 }