[DeadCode] Skip nullable @ template on RemoveUselessReturnTagRector (#…

…6409)
rectorphp · Nov 5, 2024 · afe7c46 · afe7c46
1 parent 1afc647
commit afe7c46
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 8 deletions.
diff --git a/...ector/ClassMethod/RemoveUselessReturnTagRector/Fixture/skip_nullable_template_tag.php.inc b/...ector/ClassMethod/RemoveUselessReturnTagRector/Fixture/skip_nullable_template_tag.php.inc
@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\Fixture;
+
+use Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\Source\Performance;
+
+/**
+ * @template TPerformance of Performance
+ */
+interface SkipNullableTemplateTag {
+    /** @return TPerformance|null */
+    public function performance(): Performance|null;
+}
diff --git a/rules-tests/DeadCode/Rector/ClassMethod/RemoveUselessReturnTagRector/Source/Performance.php b/rules-tests/DeadCode/Rector/ClassMethod/RemoveUselessReturnTagRector/Source/Performance.php
@@ -0,0 +1,5 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\Source;
+
+interface Performance {}
diff --git a/rules/DeadCode/PhpDoc/DeadParamTagValueNodeAnalyzer.php b/rules/DeadCode/PhpDoc/DeadParamTagValueNodeAnalyzer.php
@@ -9,10 +9,10 @@
 use PhpParser\Node\Param;
 use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
-use PHPStan\Type\Generic\TemplateType;
 use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
 use Rector\BetterPhpDocParser\ValueObject\Type\BracketsAwareUnionTypeNode;
 use Rector\DeadCode\PhpDoc\Guard\StandaloneTypeRemovalGuard;
+use Rector\DeadCode\PhpDoc\Guard\TemplateTypeRemovalGuard;
 use Rector\DeadCode\TypeNodeAnalyzer\GenericTypeNodeAnalyzer;
 use Rector\DeadCode\TypeNodeAnalyzer\MixedArrayTypeNodeAnalyzer;
 use Rector\NodeNameResolver\NodeNameResolver;
@@ -30,7 +30,8 @@ public function __construct(
         private ParamAnalyzer $paramAnalyzer,
         private PhpDocTypeChanger $phpDocTypeChanger,
         private StandaloneTypeRemovalGuard $standaloneTypeRemovalGuard,
-        private StaticTypeMapper $staticTypeMapper
+        private StaticTypeMapper $staticTypeMapper,
+        private TemplateTypeRemovalGuard $templateTypeRemovalGuard
     ) {
     }
 
@@ -53,7 +54,7 @@ public function isDead(ParamTagValueNode $paramTagValueNode, FunctionLike $funct
             $paramTagValueNode->type,
             $functionLike
         );
-        if ($docType instanceof TemplateType) {
+        if (! $this->templateTypeRemovalGuard->isLegal($docType)) {
             return false;
         }
 

diff --git a/rules/DeadCode/PhpDoc/DeadReturnTagValueNodeAnalyzer.php b/rules/DeadCode/PhpDoc/DeadReturnTagValueNodeAnalyzer.php
@@ -12,12 +12,12 @@
 use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\ThisTypeNode;
-use PHPStan\Type\Generic\TemplateType;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\UnionType;
 use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
 use Rector\BetterPhpDocParser\ValueObject\Type\BracketsAwareUnionTypeNode;
 use Rector\DeadCode\PhpDoc\Guard\StandaloneTypeRemovalGuard;
+use Rector\DeadCode\PhpDoc\Guard\TemplateTypeRemovalGuard;
 use Rector\DeadCode\TypeNodeAnalyzer\GenericTypeNodeAnalyzer;
 use Rector\DeadCode\TypeNodeAnalyzer\MixedArrayTypeNodeAnalyzer;
 use Rector\NodeTypeResolver\Node\AttributeKey;
@@ -32,7 +32,8 @@ public function __construct(
         private MixedArrayTypeNodeAnalyzer $mixedArrayTypeNodeAnalyzer,
         private StandaloneTypeRemovalGuard $standaloneTypeRemovalGuard,
         private PhpDocTypeChanger $phpDocTypeChanger,
-        private StaticTypeMapper $staticTypeMapper
+        private StaticTypeMapper $staticTypeMapper,
+        private TemplateTypeRemovalGuard $templateTypeRemovalGuard,
     ) {
     }
 
@@ -52,7 +53,7 @@ public function isDead(ReturnTagValueNode $returnTagValueNode, ClassMethod|Funct
             $returnTagValueNode->type,
             $functionLike
         );
-        if ($docType instanceof TemplateType) {
+        if (! $this->templateTypeRemovalGuard->isLegal($docType)) {
             return false;
         }
 

diff --git a/rules/DeadCode/PhpDoc/DeadVarTagValueNodeAnalyzer.php b/rules/DeadCode/PhpDoc/DeadVarTagValueNodeAnalyzer.php
@@ -6,11 +6,11 @@
 
 use PhpParser\Node\Stmt\Property;
 use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode;
-use PHPStan\Type\Generic\TemplateType;
 use PHPStan\Type\IntersectionType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\UnionType;
+use Rector\DeadCode\PhpDoc\Guard\TemplateTypeRemovalGuard;
 use Rector\NodeTypeResolver\TypeComparator\TypeComparator;
 use Rector\StaticTypeMapper\StaticTypeMapper;
 
@@ -19,6 +19,7 @@
     public function __construct(
         private TypeComparator $typeComparator,
         private StaticTypeMapper $staticTypeMapper,
+        private TemplateTypeRemovalGuard $templateTypeRemovalGuard
     ) {
     }
 
@@ -36,7 +37,7 @@ public function isDead(VarTagValueNode $varTagValueNode, Property $property): bo
         $propertyType = $this->staticTypeMapper->mapPhpParserNodePHPStanType($property->type);
         $docType = $this->staticTypeMapper->mapPHPStanPhpDocTypeNodeToPHPStanType($varTagValueNode->type, $property);
 
-        if ($docType instanceof TemplateType) {
+        if (! $this->templateTypeRemovalGuard->isLegal($docType)) {
             return false;
         }
 

diff --git a/rules/DeadCode/PhpDoc/Guard/TemplateTypeRemovalGuard.php b/rules/DeadCode/PhpDoc/Guard/TemplateTypeRemovalGuard.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DeadCode\PhpDoc\Guard;
+
+use PHPStan\Type\Type;
+use PHPStan\Type\UnionType;
+use PHPStan\Type\Generic\TemplateType;
+
+final class TemplateTypeRemovalGuard
+{
+    public function isLegal(Type $docType): bool
+    {
+        // cover direct \PHPStan\Type\Generic\TemplateUnionType
+        if ($docType instanceof TemplateType) {
+            return false;
+        }
+
+        // cover mixed template with mix from @template and non @template
+        $types = $docType instanceof UnionType
+            ? $docType->getTypes()
+            : [$docType];
+
+        foreach ($types as $type) {
+            if ($type instanceof TemplateType) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}