[PHP 7.4] Add @var removal to TypedPropertyRector

packages/NodeTypeResolver/src/StaticTypeMapper.php

@@ -31,6 +31,7 @@
 use PHPStan\Type\ClosureType;
 use PHPStan\Type\ConstantType;
 use PHPStan\Type\FloatType;
+use PHPStan\Type\Generic\GenericObjectType;
 use PHPStan\Type\IntegerType;
 use PHPStan\Type\IntersectionType;
 use PHPStan\Type\IterableType;
@@ -554,6 +555,13 @@ public function mapStringToPhpParserNode(string $type): ?Node
         throw new NotImplementedException(sprintf('%s for "%s"', __METHOD__, $type));
     }
 
+    public function mapPHPStanPhpDocTypeNodeToPhpDocString(TypeNode $typeNode, Node $node): string
+    {
+        $phpStanType = $this->mapPHPStanPhpDocTypeNodeToPHPStanType($typeNode, $node);
+
+        return $this->mapPHPStanTypeToDocString($phpStanType);
+    }
+
     public function mapPHPStanPhpDocTypeNodeToPHPStanType(TypeNode $typeNode, Node $node): Type
     {
         if ($typeNode instanceof IdentifierTypeNode) {
@@ -638,7 +646,11 @@ public function mapPHPStanPhpDocTypeNodeToPHPStanType(TypeNode $typeNode, Node $
         if ($typeNode instanceof GenericTypeNode) {
             if ($typeNode->type instanceof IdentifierTypeNode) {
                 $typeName = $typeNode->type->name;
-                if (in_array($typeName, ['array', 'iterable'], true)) {
+
+                // remove extra prefix
+                $typeName = ltrim($typeName, '\\');
+
+                if (in_array($typeName, ['array', 'iterable', 'Traversable'], true)) {
                     $genericTypes = [];
                     foreach ($typeNode->genericTypes as $genericTypeNode) {
                         $genericTypes[] = $this->mapPHPStanPhpDocTypeNodeToPHPStanType($genericTypeNode, $node);
@@ -650,9 +662,27 @@ public function mapPHPStanPhpDocTypeNodeToPHPStanType(TypeNode $typeNode, Node $
                         return new ArrayType(new MixedType(), $genericType);
                     }
 
+                    if ($typeName === 'Traversable') {
+                        return new ObjectType('Traversable');
+                    }
+
                     return new IterableType(new MixedType(), $genericType);
                 }
             }
+
+            $mainType = $this->mapPHPStanPhpDocTypeNodeToPHPStanType($typeNode->type, $node);
+            if ($mainType instanceof TypeWithClassName) {
+                $className = $mainType->getClassName();
+            } else {
+                throw new NotImplementedException();
+            }
+
+            $genericTypes = [];
+            foreach ($typeNode->genericTypes as $genericType) {
+                $genericTypes[] = $this->mapPHPStanPhpDocTypeNodeToPHPStanType($genericType, $node);
+            }
+
+            return new GenericObjectType($className, $genericTypes);
         }
 
         throw new NotImplementedException(__METHOD__ . ' for ' . get_class($typeNode));

packages/Php74/src/Rector/Property/TypedPropertyRector.php

@@ -6,6 +6,9 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Property;
+use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode;
+use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 use PHPStan\Type\MixedType;
 use Rector\Rector\AbstractRector;
 use Rector\RectorDefinition\CodeSample;
@@ -56,9 +59,6 @@ final class SomeClass
                     <<<'PHP'
 final class SomeClass
 {
-    /**
-     * @var int
-     */
     private int count;
 }
 PHP
@@ -103,8 +103,61 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
+        $this->removeVarPhpTagValueNodeIfNotComment($node);
+
         $node->type = $propertyTypeNode;
 
         return $node;
     }
+
+    private function removeVarPhpTagValueNodeIfNotComment(Property $property): void
+    {
+        $propertyPhpDocInfo = $this->getPhpDocInfo($property);
+        // nothing to remove
+        if ($propertyPhpDocInfo === null) {
+            return;
+        }
+
+        $varTagValueNode = $propertyPhpDocInfo->getByType(VarTagValueNode::class);
+        if ($varTagValueNode === null) {
+            return;
+        }
+
+        // has description? keep it
+        if ($varTagValueNode->description !== '') {
+            return;
+        }
+
+        // keep generic types
+        if ($varTagValueNode->type instanceof GenericTypeNode) {
+            return;
+        }
+
+        // keep string[] etc.
+        if ($this->isNonBasicArrayType($property, $varTagValueNode)) {
+            return;
+        }
+
+        $propertyPhpDocInfo->removeByType(VarTagValueNode::class);
+        $this->docBlockManipulator->updateNodeWithPhpDocInfo($property, $propertyPhpDocInfo);
+    }
+
+    private function isNonBasicArrayType(Property $property, VarTagValueNode $varTagValueNode): bool
+    {
+        if (! $this->isArrayTypeNode($varTagValueNode)) {
+            return false;
+        }
+
+        $varTypeDocString = $this->staticTypeMapper->mapPHPStanPhpDocTypeNodeToPhpDocString(
+            $varTagValueNode->type,
+            $property
+        );
+
+        return $varTypeDocString !== 'array';
+    }
+
+    private function isArrayTypeNode(VarTagValueNode $varTagValueNode): bool
+    {
+        return $varTagValueNode->type instanceof ArrayTypeNode;
+    }
 }

packages/Php74/tests/Rector/Property/TypedPropertyRector/Fixture/bool_property.php.inc

@@ -20,7 +20,6 @@ namespace Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Fixture;
 final class BoolProperty
 {
     /**
-     * @var bool
      * another comment
      */
     private bool $isTrue = false;

packages/Php74/tests/Rector/Property/TypedPropertyRector/Fixture/class_property.php.inc

@@ -22,9 +22,6 @@ use Rector\TypeDeclaration\Tests\Rector\Property\TypedPropertyRector\Source\Anot
 
 final class ClassWithClassProperty
 {
-    /**
-     * @var AnotherClass
-     */
     private \Rector\TypeDeclaration\Tests\Rector\Property\TypedPropertyRector\Source\AnotherClass $anotherClass;
 }
 

packages/Php74/tests/Rector/Property/TypedPropertyRector/Fixture/complex_array.php.inc

@@ -0,0 +1,41 @@
+<?php
+
+namespace Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Fixture;
+
+use Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Source\SomeParent;
+
+final class ComplexArray
+{
+    /**
+     * @var array<int, string>
+     */
+    private $foo;
+
+    /**
+     * @var int[]
+     */
+    private $foos;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Fixture;
+
+use Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Source\SomeParent;
+
+final class ComplexArray
+{
+    /**
+     * @var array<int, string>
+     */
+    private array $foo;
+
+    /**
+     * @var int[]
+     */
+    private array $foos;
+}
+
+?>

packages/Php74/tests/Rector/Property/TypedPropertyRector/Fixture/default_values.php.inc

@@ -68,59 +68,26 @@ namespace Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Fixture;
 
 final class DefaultValues
 {
-    /**
-     * @var bool
-     */
     private string $name = 'not_a_bool';
 
-    /**
-     * @var bool
-     */
     private bool $isItRealName = false;
 
-    /**
-     * @var bool
-     */
     private ?bool $isItRealNameNull = null;
 
-    /**
-     * @var string
-     */
     private bool $size = false;
 
-    /**
-     * @var float
-     */
     private float $a = 42.42;
 
-    /**
-     * @var float
-     */
     private int $b = 42;
 
-    /**
-     * @var float
-     */
     private string $c = 'hey';
 
-    /**
-     * @var int
-     */
     private float $e = 42.42;
 
-    /**
-     * @var int
-     */
     private int $f = 42;
 
-    /**
-     * @var array
-     */
     private array $g = [1, 2, 3];
 
-    /**
-     * @var iterable
-     */
     private array $h = [1, 2, 3];
 }
 

packages/Php74/tests/Rector/Property/TypedPropertyRector/Fixture/default_values_for_nullable_iterables.php.inc

@@ -28,19 +28,10 @@ namespace Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Fixture;
 
 final class DefaultValuesForNullableIterables
 {
-    /**
-     * @var array
-     */
     private ?array $items = null;
 
-    /**
-     * @var iterable
-     */
     private ?iterable $itemsB = null;
 
-    /**
-     * @var array|null
-     */
     private ?array $nullableItems = null;
 }
 

packages/Php74/tests/Rector/Property/TypedPropertyRector/Fixture/match_types.php.inc

@@ -58,49 +58,22 @@ namespace Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Fixture;
 
 final class MatchTypes
 {
-    /**
-     * @var bool
-     */
     private bool $a;
 
-    /**
-     * @var boolean
-     */
     private bool $b;
 
-    /**
-     * @var int
-     */
     private int $c;
 
-    /**
-     * @var integer
-     */
     private int $d;
 
-    /**
-     * @var float
-     */
     private float $e;
 
-    /**
-     * @var string
-     */
     private string $f;
 
-    /**
-     * @var object
-     */
     private object $g;
 
-    /**
-     * @var iterable
-     */
     private iterable $h;
 
-    /**
-     * @var self
-     */
     private self $i;
 }
 

packages/Php74/tests/Rector/Property/TypedPropertyRector/Fixture/match_types_parent.php.inc

@@ -28,9 +28,6 @@ class PropperParent
 
 final class MatchTypesParent extends PropperParent
 {
-    /**
-     * @var parent
-     */
     private parent $j;
 }
 

packages/Php74/tests/Rector/Property/TypedPropertyRector/Fixture/non_array_generic_types.php.inc

@@ -0,0 +1,53 @@
+<?php
+
+namespace Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Fixture;
+
+class Promise
+{
+}
+
+class Foo
+{
+}
+
+final class NonArrayGenericTypes
+{
+    /**
+     * @var \Traversable<int, string>
+     */
+    private $foo;
+
+    /**
+     * @var Promise<Foo>
+     */
+    private $bar;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Fixture;
+
+class Promise
+{
+}
+
+class Foo
+{
+}
+
+final class NonArrayGenericTypes
+{
+    /**
+     * @var \Traversable<int, string>
+     */
+    private \Traversable $foo;
+
+    /**
+     * @var Promise<Foo>
+     */
+    private \Rector\Php74\Tests\Rector\Property\TypedPropertyRector\Fixture\Promise $bar;
+}
+
+?>