Skip to content
Open
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
30 changes: 3 additions & 27 deletions src/PhpDocParser/NodeVisitor/CallableNodeVisitor.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,15 @@
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Expression;
use PhpParser\NodeVisitor;
use PhpParser\NodeVisitorAbstract;
use Rector\PhpParser\NodeVisitor\AbstractLeaveNode;

final class CallableNodeVisitor extends NodeVisitorAbstract
final class CallableNodeVisitor extends AbstractLeaveNode
{
/**
* @var callable(Node): (int|Node|null|Node[])
*/
private $callable;

private ?int $nodeIdToRemove = null;

/**
* @var array<int, Node[]>
*/
private array $nodesToReturn = [];

/**
* @param callable(Node $node): (int|Node|null|Node[]) $callable
*/
Expand All @@ -43,7 +36,7 @@ public function enterNode(Node $node): int|Node|null
$newNode = $callable($node);

if ($newNode === NodeVisitor::REMOVE_NODE) {
$this->nodeIdToRemove = spl_object_id($originalNode);
$this->toBeRemovedNodeId = spl_object_id($originalNode);
return $originalNode;
}

Expand All @@ -60,21 +53,4 @@ public function enterNode(Node $node): int|Node|null

return $newNode;
}

/**
* @return int|Node|Node[]
*/
public function leaveNode(Node $node): int|Node|array
{
if ($this->nodeIdToRemove !== null && $this->nodeIdToRemove === spl_object_id($node)) {
$this->nodeIdToRemove = null;
return NodeVisitor::REMOVE_NODE;
}

if ($this->nodesToReturn === []) {
return $node;
}

return $this->nodesToReturn[spl_object_id($node)] ?? $node;
}
}
45 changes: 45 additions & 0 deletions src/PhpParser/NodeVisitor/AbstractLeaveNode.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php

declare(strict_types=1);

namespace Rector\PhpParser\NodeVisitor;

use PhpParser\Node;
use PhpParser\NodeVisitor;
use PhpParser\NodeVisitorAbstract;

/**
* @internal
*/
abstract class AbstractLeaveNode extends NodeVisitorAbstract
{
protected ?int $toBeRemovedNodeId = null;

/**
* @var array<int, Node[]>
*/
protected array $nodesToReturn = [];

/**
* 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 NodeVisitor::REMOVE_NODE|Node|null|Node[]
*/
final public function leaveNode(Node $node): int|Node|null|array
{
// nothing to change here
if ($this->toBeRemovedNodeId === null && $this->nodesToReturn === []) {
return null;
}

$objectId = spl_object_id($node);
if ($this->toBeRemovedNodeId === $objectId) {
$this->toBeRemovedNodeId = null;

return NodeVisitor::REMOVE_NODE;
}

return $this->nodesToReturn[$objectId] ?? $node;
}
}
36 changes: 2 additions & 34 deletions src/Rector/AbstractRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
use PhpParser\Node\Stmt\Property;
use PhpParser\Node\Stmt\Trait_;
use PhpParser\NodeVisitor;
use PhpParser\NodeVisitorAbstract;
use PHPStan\Analyser\MutatingScope;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
Expand All @@ -33,10 +32,11 @@
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpParser\Comparing\NodeComparator;
use Rector\PhpParser\Node\NodeFactory;
use Rector\PhpParser\NodeVisitor\AbstractLeaveNode;
use Rector\Skipper\Skipper\Skipper;
use Rector\ValueObject\Application\File;

abstract class AbstractRector extends NodeVisitorAbstract implements RectorInterface
abstract class AbstractRector extends AbstractLeaveNode implements RectorInterface
{
/**
* @var string
Expand Down Expand Up @@ -71,15 +71,8 @@ abstract class AbstractRector extends NodeVisitorAbstract implements RectorInter

private CurrentFileProvider $currentFileProvider;

/**
* @var array<int, Node[]>
*/
private array $nodesToReturn = [];

private CreatedByRuleDecorator $createdByRuleDecorator;

private ?int $toBeRemovedNodeId = null;

public function autowire(
NodeNameResolver $nodeNameResolver,
NodeTypeResolver $nodeTypeResolver,
Expand Down Expand Up @@ -186,31 +179,6 @@ final public function enterNode(Node $node): int|Node|null
return $this->postRefactorProcess($originalNode, $node, $refactoredNode, $filePath);
}

/**
* 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
*/
final public function leaveNode(Node $node): array|int|Node|null
{
if ($node->hasAttribute(AttributeKey::ORIGINAL_NODE)) {
return null;
}

// nothing to change here
if ($this->toBeRemovedNodeId === null && $this->nodesToReturn === []) {
return null;
}

$objectId = spl_object_id($node);
if ($this->toBeRemovedNodeId === $objectId) {
$this->toBeRemovedNodeId = null;

return NodeVisitor::REMOVE_NODE;
}

return $this->nodesToReturn[$objectId] ?? $node;
}

protected function isName(Node $node, string $name): bool
{
return $this->nodeNameResolver->isName($node, $name);
Expand Down