[AutoImport] Handle complex usage of multiple @\ combined with other …

…doc (#5273) * [AutoImport] Handle complex usage of multiple @\ combined with other doc * [ci-review] Rector Rectify * fix re-create object * Fix --------- Co-authored-by: GitHub Action <actions@github.com>
rectorphp · Nov 22, 2023 · 284b1b9 · 284b1b9
1 parent fcd1b1a
commit 284b1b9
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 1 deletion.
diff --git a/packages/BetterPhpDocParser/PhpDocParser/DoctrineAnnotationDecorator.php b/packages/BetterPhpDocParser/PhpDocParser/DoctrineAnnotationDecorator.php
@@ -169,6 +169,8 @@ private function transformGenericTagValueNodesToDoctrineAnnotationTagValueNodes(
                 unset($phpDocNode->children[$key]);
                 array_splice($phpDocNode->children, $key, 0, $spacelessPhpDocTagNodes);
 
+                $key += count($spacelessPhpDocTagNodes);
+
                 continue;
             }
 
@@ -177,6 +179,12 @@ private function transformGenericTagValueNodesToDoctrineAnnotationTagValueNodes(
             }
 
             if (! $phpDocChildNode->value instanceof GenericTagValueNode) {
+                $key = $this->processDescriptionAsSpacelessPhpDoctagNode(
+                    $phpDocNode,
+                    $phpDocChildNode,
+                    $currentPhpNode,
+                    $key
+                );
                 continue;
             }
 
@@ -207,6 +215,54 @@ private function transformGenericTagValueNodesToDoctrineAnnotationTagValueNodes(
         }
     }
 
+    private function processDescriptionAsSpacelessPhpDoctagNode(
+        PhpDocNode $phpDocNode,
+        PhpDocTagNode $phpDocTagNode,
+        Node $currentPhpNode,
+        int $key
+    ): int {
+        if (! property_exists($phpDocTagNode->value, 'description')) {
+            return $key;
+        }
+
+        $description = (string) $phpDocTagNode->value->description;
+        if (! str_contains($description, "\n")) {
+            return $key;
+        }
+
+        $phpDocTextNode = new PhpDocTextNode($description);
+        $startAndEnd = $phpDocTagNode->value->getAttribute(PhpDocAttributeKey::START_AND_END);
+        if (! $startAndEnd instanceof StartAndEnd) {
+            return $key;
+        }
+
+        $phpDocTextNode->setAttribute(PhpDocAttributeKey::START_AND_END, $startAndEnd);
+        $spacelessPhpDocTagNodes = $this->resolveFqnAnnotationSpacelessPhpDocTagNode(
+            $phpDocTextNode,
+            $currentPhpNode
+        );
+
+        if ($spacelessPhpDocTagNodes === []) {
+            return $key;
+        }
+
+        $unsetKey = $phpDocNode->children[$key] instanceof SpacelessPhpDocTagNode
+            ? $key + count($spacelessPhpDocTagNodes)
+            : $key;
+
+        unset($phpDocNode->children[$unsetKey]);
+
+        $classNode = new PhpDocTagNode($phpDocTagNode->name, $phpDocTagNode->value);
+        $description = Strings::replace($description, self::LONG_ANNOTATION_REGEX, '');
+        $description = trim(str_replace("\n *", '', $description));
+        $phpDocTagNode->value->description = $description;
+        $phpDocNode->children[$unsetKey] = $classNode;
+
+        array_splice($phpDocNode->children, $unsetKey + 1, 0, $spacelessPhpDocTagNodes);
+
+        return $key + count($spacelessPhpDocTagNodes);
+    }
+
     /**
      * This is closed block, e.g. {( ... )},
      * false on: {( ... )

diff --git a/phpstan.neon b/phpstan.neon
@@ -106,6 +106,7 @@ parameters:
                 - packages/NodeNameResolver/NodeNameResolver.php
                 - utils/ChangelogGenerator/Command/
                 - packages/BetterPhpDocParser/PhpDocParser/BetterPhpDocParser.php
+                - packages/BetterPhpDocParser/PhpDocParser/DoctrineAnnotationDecorator.php
 
         # known types
         - '#Call to an undefined method PHPStan\\Type\\ConstantType\:\:getValue\(\)#'

diff --git a/tests/Issues/AutoImport/Fixture/DocBlock/two_routes_with_next_doc_other_routes.php.inc b/tests/Issues/AutoImport/Fixture/DocBlock/two_routes_with_next_doc_other_routes.php.inc
@@ -29,7 +29,7 @@ class TwoRoutesWithNextDoc2
      * @Route("/first", methods={"GET"})
      * @Route("/second", methods={"GET"})
      * @return Response
-     * @\Symfony\Component\Routing\Annotation\Route("/third", methods={"GET"})
+     * @Route("/third", methods={"GET"})
      */
     public function some(): Response
     {

diff --git a/...ock/skip_two_routes_with_prev_doc.php.inc → ...DocBlock/two_routes_with_prev_doc.php.inc b/...ock/skip_two_routes_with_prev_doc.php.inc → ...DocBlock/two_routes_with_prev_doc.php.inc
@@ -14,3 +14,25 @@ class TwoRoutesWithPrevDoc
         return new Response();
     }
 }
+
+?>
+-----
+<?php
+
+namespace Rector\Core\Tests\Issues\AutoImport\Fixture\DocBlock;
+
+use Symfony\Component\Routing\Annotation\Route;
+class TwoRoutesWithPrevDoc
+{
+    /**
+     * @return Response
+     * @Route("/first", methods={"GET"})
+     * @Route("/second", methods={"GET"})
+     */
+    public function some(): Response
+    {
+        return new Response();
+    }
+}
+
+?>