Merge pull request #2790 from rectorphp/cakephp-routes-to-explicit

config/set/cakephp-to-symfony/cakephp-24-to-symfony-51.yaml

@@ -16,3 +16,4 @@ services:
     # Model to Doctrine
     Rector\CakePHPToSymfony\Rector\Class_\CakePHPModelToDoctrineEntityRector: null
     Rector\CakePHPToSymfony\Rector\Class_\CakePHPModelToDoctrineRepositoryRector: null
+    Rector\CakePHPToSymfony\Rector\Class_\CakePHPImplicitRouteToExplicitRouteAnnotationRector: null

docs/AllRectorsOverview.md

@@ -1,4 +1,4 @@
-# All 444 Rectors Overview
+# All 445 Rectors Overview
 
 - [Projects](#projects)
 - [General](#general)
@@ -422,6 +422,29 @@ Migrate CakePHP 2.4 Controller to Symfony 5
 
 <br>
 
+### `CakePHPImplicitRouteToExplicitRouteAnnotationRector`
+
+- class: `Rector\CakePHPToSymfony\Rector\Class_\CakePHPImplicitRouteToExplicitRouteAnnotationRector`
+
+Migrate CakePHP implicit routes to Symfony @route annotations
+
+```diff
+-class PaymentsController extends AppController
++use Symfony\Component\Routing\Annotation\Route;
++
++class AdminPaymentsController extends AppController
+ {
++    /**
++     * @Route(path="/payments/index", name="payments_index")
++     */
+     public function index()
+     {
+     }
+ }
+```
+
+<br>
+
 ### `CakePHPModelToDoctrineEntityRector`
 
 - class: `Rector\CakePHPToSymfony\Rector\Class_\CakePHPModelToDoctrineEntityRector`

ecs.yaml

@@ -49,7 +49,7 @@ parameters:
         PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\MethodDeclarationSniff.Underscore: null
         Symplify\CodingStandard\Sniffs\Architecture\DuplicatedClassShortNameSniff: null
         # skip temporary due to missing "import" feature in PhpStorm
-        SlevomatCodingStandard\Sniffs\Namespaces\ReferenceUsedNamesOnlySniff.PartialUse: null
+#        SlevomatCodingStandard\Sniffs\Namespaces\ReferenceUsedNamesOnlySniff.PartialUse: null
 
         # run manually from time to time - performance demanding + not to bother user with it
         Symplify\CodingStandard\Fixer\Order\PropertyOrderByComplexityFixer: null
@@ -173,4 +173,8 @@ parameters:
             # part of the comparison logic
             - 'packages/Polyfill/src/ConditionEvaluator.php'
 
+        SlevomatCodingStandard\Sniffs\Namespaces\ReferenceUsedNamesOnlySniff.PartialUse:
+            - "packages/DeadCode/src/Rector/Plus/RemoveDeadZeroAndOneOperationRector.php"
+            - "packages/Php56/src/Rector/FunctionLike/AddDefaultValueForUndefinedVariableRector.php"
+
     line_ending: "\n"

packages/BetterPhpDocParser/src/Printer/PhpDocInfoPrinter.php

@@ -102,7 +102,7 @@ public function printFormatPreserving(PhpDocInfo $phpDocInfo, bool $shouldSkipEm
         return $this->printPhpDocNode($this->attributeAwarePhpDocNode, $shouldSkipEmptyLinesAbove);
     }
 
-    public function printPhpDocNode(
+    private function printPhpDocNode(
         AttributeAwarePhpDocNode $attributeAwarePhpDocNode,
         bool $shouldSkipEmptyLinesAbove = false
     ): string {

packages/CakePHPToSymfony/src/Rector/Class_/CakePHPImplicitRouteToExplicitRouteAnnotationRector.php

@@ -0,0 +1,121 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CakePHPToSymfony\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\BetterPhpDocParser\PhpDocNode\Symfony\SymfonyRouteTagValueNode;
+use Rector\CakePHPToSymfony\Rector\AbstractCakePHPRector;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\PHPStan\Type\FullyQualifiedObjectType;
+use Rector\RectorDefinition\CodeSample;
+use Rector\RectorDefinition\RectorDefinition;
+use Rector\Util\RectorStrings;
+
+/**
+ * @inspiration
+ * @see \Rector\NetteToSymfony\Rector\ClassMethod\RouterListToControllerAnnotationsRector
+ *
+ * @see \Rector\CakePHPToSymfony\Tests\Rector\Class_\CakePHPImplicitRouteToExplicitRouteAnnotationRector\CakePHPImplicitRouteToExplicitRouteAnnotationRectorTest
+ */
+final class CakePHPImplicitRouteToExplicitRouteAnnotationRector extends AbstractCakePHPRector
+{
+    /**
+     * @var string
+     */
+    private const HAS_FRESH_ROUTE_ANNOTATION_ATTRIBUTE = 'has_fresh_route_annotation';
+
+    public function getDefinition(): RectorDefinition
+    {
+        return new RectorDefinition('Migrate CakePHP implicit routes to Symfony @route annotations', [
+            new CodeSample(
+                <<<'PHP'
+class PaymentsController extends AppController
+{
+    public function index()
+    {
+    }
+}
+PHP
+,
+                <<<'PHP'
+use Symfony\Component\Routing\Annotation\Route;
+
+class AdminPaymentsController extends AppController
+{
+    /**
+     * @Route(path="/payments/index", name="payments_index")
+     */
+    public function index()
+    {
+    }
+}
+PHP
+
+            ),
+        ]);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isInCakePHPController($node)) {
+            return null;
+        }
+
+        foreach ($node->getMethods() as $classMethod) {
+            if (! $classMethod->isPublic()) {
+                continue;
+            }
+
+            /** @var string $className */
+            $className = $node->getAttribute(AttributeKey::CLASS_NAME);
+            $shortClassName = $this->getShortName($className);
+
+            $methodName = $this->getName($classMethod);
+
+            $combined = RectorStrings::removeSuffixes($shortClassName, ['Controller']) . '/' . $methodName;
+            $path = '/' . RectorStrings::camelCaseToSlashes($combined);
+            $name = RectorStrings::camelCaseToUnderscore($combined);
+
+            $symfonyRoutePhpDocTagValueNode = $this->createSymfonyRoutePhpDocTagValueNode($path, $name);
+            $this->addSymfonyRouteShortTagNodeWithUse($symfonyRoutePhpDocTagValueNode, $classMethod);
+        }
+
+        return $node;
+    }
+
+    private function createSymfonyRoutePhpDocTagValueNode(string $path, string $name): SymfonyRouteTagValueNode
+    {
+        return new SymfonyRouteTagValueNode($path, $name);
+    }
+
+    /**
+     * @todo reuse from RouterListToControllerAnnotationsRector
+     */
+    private function addSymfonyRouteShortTagNodeWithUse(
+        SymfonyRouteTagValueNode $symfonyRouteTagValueNode,
+        ClassMethod $classMethod
+    ): void {
+        // @todo use empty phpdoc info
+        $this->docBlockManipulator->addTagValueNodeWithShortName($classMethod, $symfonyRouteTagValueNode);
+
+        $symfonyRouteUseObjectType = new FullyQualifiedObjectType(SymfonyRouteTagValueNode::CLASS_NAME);
+        $this->addUseType($symfonyRouteUseObjectType, $classMethod);
+
+        $classMethod->setAttribute(self::HAS_FRESH_ROUTE_ANNOTATION_ATTRIBUTE, true);
+    }
+}

packages/CakePHPToSymfony/tests/Rector/Class_/CakePHPImplicitRouteToExplicitRouteAnnotationRector/CakePHPImplicitRouteToExplicitRouteAnnotationRectorTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CakePHPToSymfony\Tests\Rector\Class_\CakePHPImplicitRouteToExplicitRouteAnnotationRector;
+
+use Iterator;
+use Rector\CakePHPToSymfony\Rector\Class_\CakePHPImplicitRouteToExplicitRouteAnnotationRector;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class CakePHPImplicitRouteToExplicitRouteAnnotationRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideDataForTest()
+     */
+    public function test(string $file): void
+    {
+        $this->doTestFile($file);
+    }
+
+    public function provideDataForTest(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    protected function getRectorClass(): string
+    {
+        return CakePHPImplicitRouteToExplicitRouteAnnotationRector::class;
+    }
+}

packages/CakePHPToSymfony/tests/Rector/Class_/CakePHPImplicitRouteToExplicitRouteAnnotationRector/Fixture/fixture.php.inc

@@ -0,0 +1,29 @@
+<?php
+
+namespace Rector\CakePHPToSymfony\Tests\Rector\Class_\CakePHPImplicitRouteToExplicitRouteAnnotationRector\Fixture;
+
+class PaymentsController extends \AppController
+{
+    public function index()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\CakePHPToSymfony\Tests\Rector\Class_\CakePHPImplicitRouteToExplicitRouteAnnotationRector\Fixture;
+
+use Symfony\Component\Routing\Annotation\Route;
+class PaymentsController extends \AppController
+{
+    /**
+     * @Route(path="/payments/index", name="payments_index")
+     */
+    public function index()
+    {
+    }
+}
+
+?>

packages/CodeQuality/src/Rector/If_/CombineIfRector.php

@@ -76,7 +76,7 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        /** @var Node\Stmt\If_ $subIf */
+        /** @var If_ $subIf */
         $subIf = $node->stmts[0];
         $node->cond = new BooleanAnd($node->cond, $subIf->cond);
         $node->stmts = $subIf->stmts;

packages/CodeQuality/src/Rector/If_/RemoveAlwaysTrueConditionSetInConstructorRector.php

@@ -8,6 +8,7 @@
 use PhpParser\Node\Expr\Assign;
 use PhpParser\Node\Expr\Closure;
 use PhpParser\Node\Expr\PropertyFetch;
+use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassLike;
 use PhpParser\Node\Stmt\ClassMethod;
@@ -205,7 +206,7 @@ private function resolvePropertyFetchType(PropertyFetch $propertyFetch): Type
     }
 
     /**
-     * @param Node\Stmt[] $stmts
+     * @param Stmt[] $stmts
      */
     private function resolveAssignedTypeInStmtsByPropertyName(array $stmts, string $propertyName): ?Type
     {

packages/CodingStyle/src/Rector/ClassMethod/MakeInheritedMethodVisibilitySameAsParentRector.php

@@ -6,6 +6,7 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Return_;
 use PHPStan\Analyser\Scope;
@@ -139,7 +140,7 @@ private function isConstructorWithStaticFactory(ClassMethod $classMethod, string
             return false;
         }
 
-        /** @var Node\Stmt\Class_|null $class */
+        /** @var Class_|null $class */
         $class = $classMethod->getAttribute(AttributeKey::CLASS_NODE);
         if ($class === null) {
             return false;

packages/DeadCode/src/Rector/Plus/RemoveDeadZeroAndOneOperationRector.php

@@ -62,10 +62,10 @@ public function getNodeTypes(): array
             Minus::class,
             Mul::class,
             Div::class,
-            Node\Expr\AssignOp\Plus::class,
-            Node\Expr\AssignOp\Minus::class,
-            Node\Expr\AssignOp\Mul::class,
-            Node\Expr\AssignOp\Div::class,
+            AssignOp\Plus::class,
+            AssignOp\Minus::class,
+            AssignOp\Mul::class,
+            AssignOp\Div::class,
         ];
     }
 
@@ -106,7 +106,7 @@ public function refactor(Node $node): ?Node
     private function processAssignOp(Node $node): ?Expr
     {
         // +=, -=
-        if ($node instanceof Node\Expr\AssignOp\Plus || $node instanceof Node\Expr\AssignOp\Minus) {
+        if ($node instanceof AssignOp\Plus || $node instanceof AssignOp\Minus) {
             if (! $this->isValue($node->expr, 0)) {
                 return null;
             }
@@ -117,7 +117,7 @@ private function processAssignOp(Node $node): ?Expr
         }
 
         // *, /
-        if ($node instanceof Node\Expr\AssignOp\Mul || $node instanceof Node\Expr\AssignOp\Div) {
+        if ($node instanceof AssignOp\Mul || $node instanceof AssignOp\Div) {
             if (! $this->isValue($node->expr, 1)) {
                 return null;
             }

packages/Laravel/src/Rector/Class_/InlineValidationRulesToArrayDefinitionRector.php

@@ -179,7 +179,7 @@ private function transformConcatExpressionToSingleString(Concat $concat): ?strin
             } elseif ($expressionPart instanceof Concat) {
                 $output .= $this->transformConcatExpressionToSingleString($expressionPart);
             } elseif ($expressionPart instanceof ClassConstFetch) {
-                /** @var Node\Name $name */
+                /** @var Name $name */
                 $name = $expressionPart->class->getAttribute('originalName');
 
                 $output .= implode('\\', $name->parts);

packages/Laravel/src/Rector/FuncCall/HelperFunctionToConstructorInjectionRector.php

@@ -8,6 +8,7 @@
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
 use Rector\Exception\ShouldNotHappenException;
 use Rector\Laravel\FunctionToServiceMap;
 use Rector\Laravel\ValueObject\ArrayFunctionToMethodCall;
@@ -144,7 +145,7 @@ private function shouldSkipFuncCall(FuncCall $funcCall): bool
             return true;
         }
 
-        /** @var Node\Stmt\ClassMethod|null $classMethod */
+        /** @var ClassMethod|null $classMethod */
         $classMethod = $funcCall->getAttribute(AttributeKey::METHOD_NODE);
         if ($classMethod === null) {
             return true;

packages/NodeTypeResolver/src/NodeVisitor/FunctionMethodAndClassNodeVisitor.php

@@ -36,7 +36,7 @@ final class FunctionMethodAndClassNodeVisitor extends NodeVisitorAbstract
     private $methodNode;
 
     /**
-     * @var Node\Stmt\Function_|null
+     * @var Function_|null
      */
     private $functionNode;
 

packages/NodeTypeResolver/src/PerNodeTypeResolver/CastTypeResolver.php

@@ -34,7 +34,7 @@ public function getNodeClasses(): array
     }
 
     /**
-     * @param Node\Expr\Cast $node
+     * @param Cast $node
      */
     public function resolve(Node $node): Type
     {