Remove array shape return in TemplateAnnotationToThisRenderRector as no longer used (#755)

* add fixture

* Remove array shape return in TemplateAnnotationToThisRenderRector as no longer used

Author: TomasVotruba

config/sets/symfony/symfony6/symfony61/symfony61-console.php

@@ -7,8 +7,5 @@
 use Rector\Symfony\Symfony61\Rector\Class_\CommandPropertyToAttributeRector;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->rules([
-        CommandConfigureToAttributeRector::class,
-        CommandPropertyToAttributeRector::class,
-    ]);
+    $rectorConfig->rules([CommandConfigureToAttributeRector::class, CommandPropertyToAttributeRector::class]);
 };

config/sets/symfony/symfony6/symfony62/symfony62-security-http.php

@@ -3,8 +3,8 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-use Rector\Symfony\Symfony62\Rector\Class_\SecurityAttributeToIsGrantedAttributeRector;
 use Rector\Renaming\Rector\Name\RenameClassRector;
+use Rector\Symfony\Symfony62\Rector\Class_\SecurityAttributeToIsGrantedAttributeRector;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rule(SecurityAttributeToIsGrantedAttributeRector::class);

config/sets/symfony/symfony6/symfony63/symfony63-dependency-injection.php

@@ -3,8 +3,8 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-use Rector\Symfony\Symfony63\Rector\Class_\ParamAndEnvAttributeRector;
 use Rector\Renaming\Rector\Name\RenameClassRector;
+use Rector\Symfony\Symfony63\Rector\Class_\ParamAndEnvAttributeRector;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rules([

config/sets/symfony/symfony7/symfony70/symfony70-serializer.php

@@ -6,7 +6,7 @@
 use Rector\Renaming\Rector\Name\RenameClassRector;
 
 return static function (RectorConfig $rectorConfig): void {
-     $rectorConfig->ruleWithConfiguration(RenameClassRector::class, [
+    $rectorConfig->ruleWithConfiguration(RenameClassRector::class, [
         // @see https://github.com/symfony/symfony/blob/7.0/UPGRADE-7.0.md#frameworkbundle
         'Symfony\Component\Serializer\Normalizer\ObjectNormalizer' => 'Symfony\Component\Serializer\Normalizer\NormalizerInterface',
         'Symfony\Component\Serializer\Normalizer\PropertyNormalizer' => 'Symfony\Component\Serializer\Normalizer\NormalizerInterface',

config/sets/symfony/symfony7/symfony71/symfony71-dependency-injection.php

@@ -18,4 +18,4 @@
             'Symfony\Component\DependencyInjection\Attribute\AutowireLocator'
         ),
     ]);
-};
+};

config/sets/symfony/symfony7/symfony73/symfony73-console.php

@@ -7,7 +7,5 @@
 use Rector\Symfony\Symfony73\Rector\Class_\InvokableCommandInputAttributeRector;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->rules([
-        CommandHelpToAttributeRector::class, InvokableCommandInputAttributeRector::class
-    ]);
+    $rectorConfig->rules([CommandHelpToAttributeRector::class, InvokableCommandInputAttributeRector::class]);
 };

rules-tests/CodeQuality/Rector/ClassMethod/TemplateAnnotationToThisRenderRector/Fixture/Attributes/cleanup_return_array_shape.php.inc

@@ -0,0 +1,41 @@
+<?php
+
+namespace AppBundle\Controller\Attributes;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+
+final class CleanupArrayReturnShape extends AbstractController
+{
+    /**
+     * @return array{hello: string}
+     */
+    #[Template("with_some_template.twig")]
+    public function indexAction()
+    {
+        return [
+            'hello' => 'world'
+        ];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace AppBundle\Controller\Attributes;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+
+final class CleanupArrayReturnShape extends AbstractController
+{
+    public function indexAction(): \Symfony\Component\HttpFoundation\Response
+    {
+        return $this->render('with_some_template.twig', [
+            'hello' => 'world'
+        ]);
+    }
+}
+
+?>

rules/CodeQuality/Rector/ClassMethod/TemplateAnnotationToThisRenderRector.php

@@ -16,11 +16,14 @@
 use PhpParser\Node\Stmt\Function_;
 use PhpParser\Node\Stmt\Return_;
 use PhpParser\NodeVisitor;
+use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
+use PHPStan\PhpDocParser\Ast\Type\ArrayShapeNode;
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ObjectType;
 use Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover;
 use Rector\Comments\NodeDocBlock\DocBlockUpdater;
@@ -176,7 +179,7 @@ private function replaceTemplateAnnotation(
             return $this->refactorClassMethod($classMethod, $doctrineAnnotationTagValueNode ?: $templateAttribute);
         }
 
-        // global @Template access
+        // global @Template/#[Template] access
         if ($classTagValueNodeOrAttribute instanceof DoctrineAnnotationTagValueNode || $classTagValueNodeOrAttribute instanceof Attribute) {
             return $this->refactorClassMethod($classMethod, $classTagValueNodeOrAttribute);
         }
@@ -221,6 +224,9 @@ private function refactorClassMethod(
             return null;
         });
 
+        // remove return array shape details
+        $this->removeReturnArrayShapeDocblock($classMethod);
+
         if (! $this->emptyReturnNodeFinder->hasNoOrEmptyReturns($classMethod)) {
             return $hasChanged;
         }
@@ -393,4 +399,25 @@ private function refactorStmtsAwareNode(
         }
         return $hasChanged;
     }
+
+    private function removeReturnArrayShapeDocblock(ClassMethod $classMethod): void
+    {
+        $classMethodPhpDocInfo = $this->phpDocInfoFactory->createFromNode($classMethod);
+        if (! $classMethodPhpDocInfo instanceof PhpDocInfo) {
+            return;
+        }
+
+        $returnTagValueNode = $classMethodPhpDocInfo->getReturnTagValue();
+        if (! $returnTagValueNode instanceof ReturnTagValueNode) {
+            return;
+        }
+
+        if (! $returnTagValueNode->type instanceof ArrayShapeNode) {
+            return;
+        }
+
+        if ($classMethodPhpDocInfo->removeByName('@return')) {
+            $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($classMethod);
+        }
+    }
 }

stubs/Symfony/Bundle/FrameworkExtraBundle/Configuration/Template.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Sensio\Bundle\FrameworkExtraBundle\Configuration;
+
+#[\Attribute]
+class Template
+{
+}