rector/vendor/rector/rector-symfony/src/Rector/ClassMethod/RouteCollectionBuilderToRoutingConfiguratorRector.php
Tomas Votruba 8afa5f961e Updated Rector to commit 074b1781b3fa7c7e23470c57ab85c0bd5fe0bfd2
074b1781b3 Remove RemoveUnusedVariableAssignRector, as could be breaking code in order of excution and hard to do reliable (#3793)
2023-05-11 07:56:32 +00:00

109 lines
3.8 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\Symfony\Rector\ClassMethod;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\ClassMethod;
use Rector\Core\Exception\NotImplementedYetException;
use Rector\Core\Rector\AbstractRector;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://github.com/symfony/symfony/pull/32937/files
*
* @see \Rector\Symfony\Tests\Rector\ClassMethod\RouteCollectionBuilderToRoutingConfiguratorRector\RouteCollectionBuilderToRoutingConfiguratorRectorTest
*/
final class RouteCollectionBuilderToRoutingConfiguratorRector extends AbstractRector
{
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Change RouteCollectionBuilder to RoutingConfiguratorRector', [new CodeSample(<<<'CODE_SAMPLE'
use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\Routing\RouteCollectionBuilder;
final class ConcreteMicroKernel extends Kernel
{
use MicroKernelTrait;
protected function configureRoutes(RouteCollectionBuilder $routes)
{
$routes->add('/admin', 'App\Controller\AdminController::dashboard', 'admin_dashboard');
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
final class ConcreteMicroKernel extends Kernel
{
use MicroKernelTrait;
protected function configureRouting(RoutingConfigurator $routes): void
{
$routes->add('admin_dashboard', '/admin')
->controller('App\Controller\AdminController::dashboard')
}}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [ClassMethod::class];
}
/**
* @param ClassMethod $node
*/
public function refactor(Node $node) : ?Node
{
if (!$this->isName($node, 'configureRoutes')) {
return null;
}
$firstParam = $node->params[0];
if ($firstParam->type === null) {
return null;
}
if (!$this->isName($firstParam->type, 'Symfony\\Component\\Routing\\RouteCollectionBuilder')) {
return null;
}
$firstParam->type = new FullyQualified('Symfony\\Component\\Routing\\Loader\\Configurator\\RoutingConfigurator');
$node->name = new Identifier('configureRouting');
$node->returnType = new Identifier('void');
$this->traverseNodesWithCallable((array) $node->stmts, function (Node $node) : ?MethodCall {
if (!$node instanceof MethodCall) {
return null;
}
if (!$this->isName($node->name, 'add')) {
return null;
}
// avoid nesting chain iteration infinity loop
$shouldSkip = (bool) $node->getAttribute(AttributeKey::DO_NOT_CHANGE);
if ($shouldSkip) {
return null;
}
$node->setAttribute(AttributeKey::DO_NOT_CHANGE, \true);
$pathValue = $node->getArgs()[0]->value;
$controllerValue = $node->getArgs()[1]->value;
$nameValue = $node->getArgs()[2]->value ?? null;
if (!$nameValue instanceof Expr) {
throw new NotImplementedYetException();
}
$node->args = [new Arg($nameValue), new Arg($pathValue)];
return new MethodCall($node, 'controller', [new Arg($controllerValue)]);
});
return $node;
}
}