[DeadCode] Allow remove @var on expression assign on RemoveUselessVarTagRector (#7871)

* [DeadCode] Allow remove @var on expression assign on RemoveUselessVarTagRector

* skip non-equal type with var type

* only get type check on Expr

* allow with description

* setup Expr

* get scope from Expression

* clean up

* use doc type

* cleanup

* [ci-review] Rector Rectify

---------

Co-authored-by: GitHub Action <actions@github.com>

Author: samsonasik

rules-tests/DeadCode/Rector/Property/RemoveUselessVarTagRector/Fixture/on_expression.php.inc

@@ -0,0 +1,20 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Property\RemoveUselessVarTagRector\Fixture;
+
+use DateTime;
+
+/** @var DateTime */
+$a = new DateTime('now');
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Property\RemoveUselessVarTagRector\Fixture;
+
+use DateTime;
+
+$a = new DateTime('now');
+
+?>

rules-tests/DeadCode/Rector/Property/RemoveUselessVarTagRector/Fixture/skip_on_expression_from_docblock.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Property\RemoveUselessVarTagRector\Fixture;
+
+use DateTime;
+use Rector\Tests\DeadCode\Rector\Property\RemoveUselessVarTagRector\Source\SomeReturnDocblock;
+
+$obj = new SomeReturnDocblock();
+/** @var DateTime $return */
+$return = $obj->get();

rules-tests/DeadCode/Rector/Property/RemoveUselessVarTagRector/Source/SomeReturnDocblock.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Property\RemoveUselessVarTagRector\Source;
+
+use DateTime;
+
+class SomeReturnDocblock
+{
+    /**
+     * @return DateTime
+     */
+    public function get()
+    {
+    }
+}

rules/CodingStyle/Rector/Catch_/CatchExceptionNameMatchingTypeRector.php

@@ -108,7 +108,6 @@ public function refactor(Node $node): ?Node
             /** @var Variable $catchVar */
             $catchVar = $catch->var;
 
-            /** @var string $oldVariableName */
             $oldVariableName = (string) $this->getName($catchVar);
 
             $typeShortName = $this->resolveVariableName($catch->types[0]);

rules/DeadCode/PhpDoc/DeadVarTagValueNodeAnalyzer.php

@@ -5,7 +5,10 @@
 namespace Rector\DeadCode\PhpDoc;
 
 use PhpParser\Node;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\Assign;
 use PhpParser\Node\Stmt\ClassConst;
+use PhpParser\Node\Stmt\Expression;
 use PhpParser\Node\Stmt\Property;
 use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
@@ -15,34 +18,62 @@
 use PHPStan\Type\UnionType;
 use Rector\DeadCode\PhpDoc\Guard\TemplateTypeRemovalGuard;
 use Rector\NodeTypeResolver\TypeComparator\TypeComparator;
+use Rector\PHPStan\ScopeFetcher;
 use Rector\StaticTypeMapper\StaticTypeMapper;
 
 final readonly class DeadVarTagValueNodeAnalyzer
 {
     public function __construct(
         private TypeComparator $typeComparator,
         private StaticTypeMapper $staticTypeMapper,
-        private TemplateTypeRemovalGuard $templateTypeRemovalGuard
+        private TemplateTypeRemovalGuard $templateTypeRemovalGuard,
     ) {
     }
 
-    public function isDead(VarTagValueNode $varTagValueNode, Property|ClassConst $property): bool
+    public function isDead(VarTagValueNode $varTagValueNode, Property|ClassConst|Expression $node): bool
     {
-        if (! $property->type instanceof Node) {
+        if (! $node instanceof Expression && ! $node->type instanceof Node) {
             return false;
         }
 
         if ($varTagValueNode->description !== '') {
             return false;
         }
 
+        $targetNode = null;
+
+        if ($node instanceof Expression && $node->expr instanceof Assign) {
+            $targetNode = $node->expr->expr;
+        } elseif ($node instanceof Property || $node instanceof ClassConst) {
+            $targetNode = $node->type;
+        }
+
+        // allow Identifier, ComplexType, and Name on Property and ClassConst
+        if (! $targetNode instanceof Node) {
+            return false;
+        }
+
         if ($varTagValueNode->type instanceof GenericTypeNode) {
             return false;
         }
 
         // is strict type superior to doc type? keep strict type only
-        $propertyType = $this->staticTypeMapper->mapPhpParserNodePHPStanType($property->type);
-        $docType = $this->staticTypeMapper->mapPHPStanPhpDocTypeNodeToPHPStanType($varTagValueNode->type, $property);
+        $propertyType = $this->staticTypeMapper->mapPhpParserNodePHPStanType($targetNode);
+        $docType = $this->staticTypeMapper->mapPHPStanPhpDocTypeNodeToPHPStanType($varTagValueNode->type, $node);
+
+        if ($node instanceof Expression) {
+            $scope = ScopeFetcher::fetch($node);
+
+            // only allow Expr on assign expr
+            if (! $targetNode instanceof Expr) {
+                return false;
+            }
+
+            $nativeType = $scope->getNativeType($targetNode);
+            if (! $docType->equals($nativeType)) {
+                return false;
+            }
+        }
 
         if (! $this->templateTypeRemovalGuard->isLegal($docType)) {
             return false;
@@ -59,9 +90,9 @@ public function isDead(VarTagValueNode $varTagValueNode, Property|ClassConst $pr
         }
 
         if ($this->typeComparator->arePhpParserAndPhpStanPhpDocTypesEqual(
-            $property->type,
+            $targetNode,
             $varTagValueNode->type,
-            $property
+            $node
         )) {
             return true;
         }

rules/DeadCode/PhpDoc/TagRemover/VarTagRemover.php

@@ -32,7 +32,7 @@ public function __construct(
     ) {
     }
 
-    public function removeVarTagIfUseless(PhpDocInfo $phpDocInfo, Property|ClassConst $property): bool
+    public function removeVarTagIfUseless(PhpDocInfo $phpDocInfo, Property|ClassConst|Expression $property): bool
     {
         $varTagValueNode = $phpDocInfo->getVarTagValueNode();
         if (! $varTagValueNode instanceof VarTagValueNode) {

rules/DeadCode/Rector/Property/RemoveUselessVarTagRector.php

@@ -6,6 +6,7 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Stmt\ClassConst;
+use PhpParser\Node\Stmt\Expression;
 use PhpParser\Node\Stmt\Property;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\DeadCode\PhpDoc\TagRemover\VarTagRemover;
@@ -54,11 +55,11 @@ final class SomeClass
      */
     public function getNodeTypes(): array
     {
-        return [Property::class, ClassConst::class];
+        return [Property::class, ClassConst::class, Expression::class];
     }
 
     /**
-     * @param Property|ClassConst $node
+     * @param Property|ClassConst|Expression $node
      */
     public function refactor(Node $node): ?Node
     {

rules/Php55/RegexMatcher.php

@@ -41,7 +41,6 @@ public function resolvePatternExpressionWithoutEIfFound(Expr $expr): Concat|Stri
                 default => $delimiter
             };
 
-            /** @var string $modifiers */
             $modifiers = $this->resolveModifiers((string) Strings::after($pattern, $delimiter, -1));
             if (! \str_contains($modifiers, 'e')) {
                 return null;