Merge pull request #754 from rectorphp/symfony42-tree

[Symfony] Add RootNodeTreeBuilderRector

config/level/symfony/symfony42.yml

@@ -1,3 +1,4 @@
 services:
     # https://symfony.com/blog/new-in-symfony-4-2-important-deprecations
     Rector\Symfony\Rector\New_\StringToArrayArgumentProcessRector: ~
+    Rector\Symfony\Rector\New_\RootNodeTreeBuilderRector: ~

packages/Symfony/src/Rector/New_/RootNodeTreeBuilderRector.php

@@ -0,0 +1,128 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Symfony\Rector\New_;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Scalar\String_;
+use Rector\NodeTypeResolver\Node\Attribute;
+use Rector\Rector\AbstractRector;
+use Rector\RectorDefinition\CodeSample;
+use Rector\RectorDefinition\RectorDefinition;
+use Rector\Utils\BetterNodeFinder;
+
+/**
+ * @see https://github.com/symfony/symfony/pull/27476
+ */
+final class RootNodeTreeBuilderRector extends AbstractRector
+{
+    /**
+     * @var BetterNodeFinder
+     */
+    private $betterNodeFinder;
+
+    /**
+     * @var string
+     */
+    private $treeBuilderClass;
+
+    public function __construct(
+        BetterNodeFinder $betterNodeFinder,
+        string $treeBuilderClass = 'Symfony\Component\Config\Definition\Builder\TreeBuilder'
+    ) {
+        $this->betterNodeFinder = $betterNodeFinder;
+        $this->treeBuilderClass = $treeBuilderClass;
+    }
+
+    public function getDefinition(): RectorDefinition
+    {
+        return new RectorDefinition('Changes  Process string argument to an array', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+
+$treeBuilder = new TreeBuilder();
+$rootNode = $treeBuilder->root('acme_root');
+$rootNode->someCall();
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+
+$treeBuilder = new TreeBuilder('acme_root');
+$rootNode = $treeBuilder->getRootNode();
+$rootNode->someCall();
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [New_::class];
+    }
+
+    /**
+     * @param New_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isType($node->class, $this->treeBuilderClass)) {
+            return null;
+        }
+
+        if (isset($node->args[1])) {
+            return null;
+        }
+
+        /** @var MethodCall|null $rootMethodCallNode */
+        $rootMethodCallNode = $this->getRootMethodCallNode($node);
+        if ($rootMethodCallNode === null) {
+            return null;
+        }
+
+        $rootNameNode = $rootMethodCallNode->args[0]->value;
+        if (! $rootNameNode instanceof String_) {
+            return null;
+        }
+
+        // switch arguments
+        [$node->args, $rootMethodCallNode->args] = [$rootMethodCallNode->args, $node->args];
+
+        $rootMethodCallNode->name = new Identifier('getRootNode');
+
+        return $node;
+    }
+
+    private function getRootMethodCallNode(Node $node): ?Node
+    {
+        /** @var Node $node */
+        $expression = $node->getAttribute(Attribute::CURRENT_EXPRESSION);
+        $nextExpression = $expression->getAttribute(Attribute::NEXT_NODE);
+
+        return $this->betterNodeFinder->findFirst([$nextExpression], function (Node $node) {
+            if (! $node instanceof MethodCall) {
+                return false;
+            }
+
+            if (! $this->isType($node, $this->treeBuilderClass)) {
+                return false;
+            }
+
+            if (! $this->isName($node, 'root')) {
+                return false;
+            }
+
+            if (! isset($node->args[0])) {
+                return false;
+            }
+
+            return true;
+        });
+    }
+}

packages/Symfony/tests/Rector/New_/RootNodeTreeBuilderRector/Correct/correct.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Wrong;
+
+use Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Source\TreeBuilder;
+
+$treeBuilder = new TreeBuilder('acme_root');
+$rootNode = $treeBuilder->getRootNode();
+$rootNode->someCall();
+
+$treeBuilder = new TreeBuilder('already_root');
+$rootNode = $treeBuilder->root();
+$rootNode->someCall();

packages/Symfony/tests/Rector/New_/RootNodeTreeBuilderRector/Correct/correct2.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Wrong;
+
+use Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Source\TreeBuilder;
+
+$treeBuilder = new TreeBuilder('override', 'array', new \stdClass());
+$treeBuilder->getRootNode();

packages/Symfony/tests/Rector/New_/RootNodeTreeBuilderRector/RootNodeTreeBuilderRectorTest.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+/**
+ * @covers \Rector\Symfony\Rector\New_\RootNodeTreeBuilderRector
+ */
+final class RootNodeTreeBuilderRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideWrongToFixedFiles()
+     */
+    public function test(string $wrong, string $fixed): void
+    {
+        $this->doTestFileMatchesExpectedContent($wrong, $fixed);
+    }
+
+    public function provideWrongToFixedFiles(): Iterator
+    {
+        yield [__DIR__ . '/Wrong/wrong.php.inc', __DIR__ . '/Correct/correct.php.inc'];
+        yield [__DIR__ . '/Wrong/wrong2.php.inc', __DIR__ . '/Correct/correct2.php.inc'];
+    }
+
+    protected function provideConfig(): string
+    {
+        return __DIR__ . '/config.yml';
+    }
+}

packages/Symfony/tests/Rector/New_/RootNodeTreeBuilderRector/Source/TreeBuilder.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Source;
+
+final class TreeBuilder
+{
+
+}

packages/Symfony/tests/Rector/New_/RootNodeTreeBuilderRector/Wrong/wrong.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Wrong;
+
+use Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Source\TreeBuilder;
+
+$treeBuilder = new TreeBuilder();
+$rootNode = $treeBuilder->root('acme_root');
+$rootNode->someCall();
+
+$treeBuilder = new TreeBuilder('already_root');
+$rootNode = $treeBuilder->root();
+$rootNode->someCall();

packages/Symfony/tests/Rector/New_/RootNodeTreeBuilderRector/Wrong/wrong2.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Wrong;
+
+use Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Source\TreeBuilder;
+
+$treeBuilder = new TreeBuilder();
+$treeBuilder->root('override', 'array', new \stdClass());

packages/Symfony/tests/Rector/New_/RootNodeTreeBuilderRector/config.yml

@@ -0,0 +1,3 @@
+services:
+    Rector\Symfony\Rector\New_\RootNodeTreeBuilderRector:
+        $treeBuilderClass: 'Rector\Symfony\Tests\Rector\New_\RootNodeTreeBuilderRector\Source\TreeBuilder'