[CodeQuality] Concat name annotation/attribute on InlineClassRoutePrefixRector (#704)

Author: samsonasik

config/sets/symfony/symfony60.php

@@ -5,7 +5,6 @@
 use PhpParser\Node\Scalar\String_;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ObjectType;
-use PHPStan\Type\StringType;
 use Rector\Config\RectorConfig;
 use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
 use Rector\Renaming\Rector\Name\RenameClassRector;

rules-tests/CodeQuality/Rector/Class_/InlineClassRoutePrefixRector/Fixture/with_existing_name.php.inc

@@ -0,0 +1,40 @@
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\Class_\InlineClassRoutePrefixRector\Fixture;
+
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\Routing\Annotation\Route;
+
+/**
+ * @Route(path="/city", name="some_org.")
+ */
+final class WithExistingName extends Controller
+{
+    /**
+     * @Route("/street", name="some")
+     */
+    public function some()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\Class_\InlineClassRoutePrefixRector\Fixture;
+
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\Routing\Annotation\Route;
+
+final class WithExistingName extends Controller
+{
+    /**
+     * @Route("/city/street", name="some_org.some")
+     */
+    public function some()
+    {
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/InlineClassRoutePrefixRector/Fixture/with_existing_name2.php.inc

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\Class_\InlineClassRoutePrefixRector\Fixture;
+
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\Routing\Annotation\Route;
+
+#[\Symfony\Component\Routing\Attribute\Route("/city", name: "some_org.")]
+final class WithExistingName2 extends Controller
+{
+    #[\Symfony\Component\Routing\Attribute\Route("/street", name: "some")]
+    public function some()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\Class_\InlineClassRoutePrefixRector\Fixture;
+
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\Routing\Annotation\Route;
+
+final class WithExistingName2 extends Controller
+{
+    #[\Symfony\Component\Routing\Attribute\Route('/city/street', name: 'some_org.some')]
+    public function some()
+    {
+    }
+}
+
+?>

rules/CodeQuality/Rector/Class_/InlineClassRoutePrefixRector.php

@@ -107,6 +107,7 @@ public function refactor(Node $node): ?Class_
         }
 
         $classRoutePath = null;
+        $classRouteName = null;
 
         // 1. detect attribute
         $routeAttributeOrAnnotation = $this->attrinationFinder->getByMany(
@@ -116,8 +117,10 @@ public function refactor(Node $node): ?Class_
 
         if ($routeAttributeOrAnnotation instanceof DoctrineAnnotationTagValueNode) {
             $classRoutePath = $this->resolveRoutePath($routeAttributeOrAnnotation);
+            $classRouteName = $this->resolveRouteName($routeAttributeOrAnnotation);
         } elseif ($routeAttributeOrAnnotation instanceof Attribute) {
             $classRoutePath = $this->resolveRoutePathFromAttribute($routeAttributeOrAnnotation);
+            $classRouteName = $this->resolveRouteNameFromAttribute($routeAttributeOrAnnotation);
         }
 
         if ($classRoutePath === null) {
@@ -155,6 +158,15 @@ public function refactor(Node $node): ?Class_
                     $newMethodPath = $classRoutePath . $methodPrefix->value;
 
                     $routePathArrayItemNode->value = new StringNode($newMethodPath);
+
+                    foreach ($methodRouteAnnotationOrAttribute->values as $value) {
+                        if ($value->key === 'name' && $value->value instanceof StringNode && is_string(
+                            $classRouteName
+                        )) {
+                            $value->value->value = $classRouteName . $value->value->value;
+                        }
+                    }
+
                     $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($classMethod);
 
                     $hasChanged = true;
@@ -173,6 +185,23 @@ public function refactor(Node $node): ?Class_
                             ));
 
                             $hasChanged = true;
+
+                            continue;
+                        }
+
+                        if ($methodRouteArg->name->toString() === 'name') {
+                            if (! $methodRouteArg->value instanceof String_) {
+                                continue;
+                            }
+
+                            $methodRouteString = $methodRouteArg->value;
+                            $methodRouteArg->value = new String_(sprintf(
+                                '%s%s',
+                                $classRouteName,
+                                $methodRouteString->value
+                            ));
+
+                            $hasChanged = true;
                         }
                     }
                 }
@@ -238,6 +267,21 @@ private function resolveRoutePath(DoctrineAnnotationTagValueNode $doctrineAnnota
         return $classRoutePathNode->value->value;
     }
 
+    private function resolveRouteName(DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode): ?string
+    {
+        $classRouteNameNode = $doctrineAnnotationTagValueNode->getValue('name');
+
+        if (! $classRouteNameNode instanceof ArrayItemNode) {
+            return null;
+        }
+
+        if (! $classRouteNameNode->value instanceof StringNode) {
+            return null;
+        }
+
+        return $classRouteNameNode->value->value;
+    }
+
     private function resolveRoutePathFromAttribute(Attribute $attribute): ?string
     {
         foreach ($attribute->args as $arg) {
@@ -252,4 +296,22 @@ private function resolveRoutePathFromAttribute(Attribute $attribute): ?string
 
         return null;
     }
+
+    private function resolveRouteNameFromAttribute(Attribute $attribute): ?string
+    {
+        foreach ($attribute->args as $arg) {
+            if ($arg->name === null) {
+                continue;
+            }
+
+            if ($arg->name->toString() === 'name') {
+                $routeExpr = $arg->value;
+                if ($routeExpr instanceof String_) {
+                    return $routeExpr->value;
+                }
+            }
+        }
+
+        return null;
+    }
 }