Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions phpstan.neon
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,7 @@ parameters:
-
identifier: symplify.noDynamicName
path: src/PhpParser/NodeTraverser/RectorNodeTraverser.php

-
identifier: offsetAccess.nonArray
path: src/PhpParser/NodeTraverser/RectorNodeTraverser.php
Expand Down
24 changes: 17 additions & 7 deletions src/PhpParser/NodeTraverser/RectorNodeTraverser.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@
use Webmozart\Assert\Assert;

/**
* Based on native NodeTraverser class, but heavily customized for Rector needs.
*
* The main differences are:
* - no leaveNode(), as we do all in enterNode() that calls refactor() method
* - cached visitors per node class for performance, e.g. when we find rules for Class_ node, they're cached for next time
* - immutability features, register Rector rules once, then use; no changes on the fly
* @see \Rector\Tests\PhpParser\NodeTraverser\RectorNodeTraverserTest
*/
final class RectorNodeTraverser implements NodeTraverserInterface
Expand All @@ -33,7 +39,7 @@ final class RectorNodeTraverser implements NodeTraverserInterface
private bool $areNodeVisitorsPrepared = false;

/**
* @var array<class-string<Node>, NodeVisitor[]>
* @var array<class-string<Node>, RectorInterface[]>
*/
private array $visitorsPerNodeClass = [];

Expand Down Expand Up @@ -103,26 +109,30 @@ public function refreshPhpRectors(array $rectors): void
}

/**
* @return NodeVisitor[]
* @api used in tests
* @return RectorInterface[]
*/
public function getVisitorsForNode(Node $node): array
{
$nodeClass = $node::class;

if (! $this->areNodeVisitorsPrepared) {
$this->prepareNodeVisitors();
}

if (! isset($this->visitorsPerNodeClass[$nodeClass])) {
$this->visitorsPerNodeClass[$nodeClass] = [];

/** @var RectorInterface $visitor */
foreach ($this->visitors as $visitor) {
foreach ($visitor->getNodeTypes() as $nodeType) {
foreach ($this->rectors as $rector) {
foreach ($rector->getNodeTypes() as $nodeType) {
// BC layer matching
if ($nodeType === FileWithoutNamespace::class && $nodeClass === FileNode::class) {
$this->visitorsPerNodeClass[$nodeClass][] = $visitor;
$this->visitorsPerNodeClass[$nodeClass][] = $rector;
continue;
}

if (is_a($nodeClass, $nodeType, true)) {
$this->visitorsPerNodeClass[$nodeClass][] = $visitor;
$this->visitorsPerNodeClass[$nodeClass][] = $rector;
continue 2;
}
}
Expand Down
1 change: 1 addition & 0 deletions tests/PhpParser/NodeTraverser/RectorNodeTraverserTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ public function testGetVisitorsForNodeWhenNoVisitorsMatch(): void
public function testGetVisitorsForNodeWhenSomeVisitorsMatch(): void
{
$class = new Class_('test');

$this->rectorNodeTraverser->refreshPhpRectors([
$this->ruleUsingFunctionRector,
$this->ruleUsingClassRector,
Expand Down
Loading