CustomRule How to replace one node with multiple statements?

[alexander-schranz]

I'm trying to replace a single methodCall inside a static function with multiple stmts.

I already have all new stmts inside an array. But I'm no sure how I can replace a Node with this new statments.

class PHPArrayConfigToConfigBuilderRule extends AbstractRector
{
    public function getNodeTypes(): array
    {
        return [Closure::class];
    }

    /**
     * @param Closure
     */
    public function refactor(Node $node): ?Node
    {
        $methodNodes = $this->betterNodeFinder->findInstanceOf($node, MethodCall::class);

        // do some checks

        foreach ($methodNodes as $methodNode) {
            // do some checks
            
            $stmts = $this->createNewStmts();
            
            // TODO replace $methodNode with $stmts ???
        }
        
        // change some other things on $node closure
        
        return $node
    }
    
    // ...
}

[TomasVotruba]

Hi, you can replace single stmts with multiple stmts:

public function refactor(Node $node)
{
    $node = ...;

    // ...

    return [$newStmt, $secondNewStmt];
}

[TomasVotruba]

I see. The finder is "find-only" service. To make the changes, use SimpleCallableNodeTraverser

[alexander-schranz]

Thx, I tried to update the code to the SimpleCallableNodeTraverser. It seems that it requires that I return a Node inside the SimpleCallableNodeTraverser. Returning a single stmts works. But returning an array errors in:

"System error: "enterNode() returned invalid value of type array"

Full Code

    /**
     * @param Closure $node - we can add Closure type here, because only this node is in "getNodeTypes()"
     */
    public function refactor(Node $node): ?Node
    {
        $configClasses = [];

        $this->simpleCallableNodeTraverser->traverseNodesWithCallable($node, function(Node $node) use (&$configClasses): ?array {
            if (! $node instanceof MethodCall) {
                return null;
            }

            if (! $this->isObjectType($node->var, new ObjectType(ContainerConfigurator::class))) {
                return null;
            }

            if (! $this->isName($node->name, 'extension')) {
                return null;
            }

            $configName = $node->args[0]->value->value;
            if (!$configName) {
                return null;
            }

            $configVariable = $configName . 'Config';
            $configClassName = 'Symfony\\Config\\' . ucfirst($configName) . 'Config';
            $configClasses[$configClassName] = $configVariable;

            /** @var Node\Expr\Array_ $configArray */
            $configArray = $node->args[1]->value;

            $stmts = $this->transformItems(
                $configVariable,
                $configArray->items
            );

            return $stmts; // FIXME fails here: "System error: "enterNode() returned invalid value of type array"
        });

        $node->params = [];
        foreach ($configClasses as $configClass => $configVariable) {
            $node->params[] = $this->nodeFactory->createParamFromNameAndType($configVariable, new ObjectType($configClass));
        }

        return $node;
    }

Is there any Virtual Node Object I can use to return here multiple statements?

[TomasVotruba]

Try changing return type in CallableNodeVisitor::enterNode() to allow array of stmts.
How does it affect the result?

[alexander-schranz]

That seems not to have any return type defined: https://github.com/rectorphp/rector/blob/main/packages/PhpDocParser/NodeVisitor/CallableNodeVisitor.php#L27

Stack Trace is:

         #0 vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(196):
         PhpParser\NodeTraverser->traverseNode(Object(PhpParser\Node\Stmt\Expression))
         #1 vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(105):
         PhpParser\NodeTraverser->traverseArray(Array)
         #2 vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(196):
         PhpParser\NodeTraverser->traverseNode(Object(PhpParser\Node\Expr\Closure))
         #3 vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(85):
         PhpParser\NodeTraverser->traverseArray(Array)
         #4 vendor/rector/rector/packages/PhpDocParser/NodeTraverser/SimpleCallableNodeTraverser.php(35):
         PhpParser\NodeTraverser->traverse(Array)
         #5 rector/PHPArrayConfigToConfigBuilderRule.php(70):
         Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser->traverseNodesWithCallable(Object(PhpParser\Node\Expr\Clo
         sure), Object(Closure))

So it seems to be in the nikic library?

rector/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php

Line 196 in 067bd12

$node = $this->traverseNode($node);

[alexander-schranz]

I tried to edit the NodeTraverser but without success yet. I did also push the repository here https://github.com/alexander-schranz/prototype-config-builder-refractor if you want to have a deeper look at the stack trace :).

Really thx for your fast help here!