[CodeQuality] Resolve type on Collection<> docblock to correct target…

… type when has indexBy
rectorphp · Dec 22, 2024 · 1b6a19d · 1b6a19d
1 parent 1523ce5
commit 1b6a19d
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 12 deletions.
diff --git a/...oCollectionPropertyGetterByToManyAnnotationRector/Fixture/OneToMany/with_index_by.php.inc b/...oCollectionPropertyGetterByToManyAnnotationRector/Fixture/OneToMany/with_index_by.php.inc
@@ -46,7 +46,7 @@ class Trainer
     private $trainings = [];
 
     /**
-     * @return \Doctrine\Common\Collections\Collection<\Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training>
+     * @return \Doctrine\Common\Collections\Collection<string, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training>
      */
     public function getTrainings()
     {

diff --git a/...ty/ImproveDoctrineCollectionDocTypeInEntityRector/Fixture/OneToMany/with_index_by.php.inc b/...ty/ImproveDoctrineCollectionDocTypeInEntityRector/Fixture/OneToMany/with_index_by.php.inc
@@ -35,7 +35,7 @@ class WithIndexBy
 {
     /**
      * @ORM\OneToMany(targetEntity=Training::class, mappedBy="trainer", "indexBy"="id")
-     * @var \Doctrine\Common\Collections\Collection<\Rector\Doctrine\Tests\CodeQuality\Rector\Property\ImproveDoctrineCollectionDocTypeInEntityRector\Source\Training>
+     * @var \Doctrine\Common\Collections\Collection<string, \Rector\Doctrine\Tests\CodeQuality\Rector\Property\ImproveDoctrineCollectionDocTypeInEntityRector\Source\Training>
      */
     private $trainings = [];
 }

diff --git a/...uality/Rector/Property/ImproveDoctrineCollectionDocTypeInEntityRector/Source/Training.php b/...uality/Rector/Property/ImproveDoctrineCollectionDocTypeInEntityRector/Source/Training.php
@@ -4,7 +4,13 @@
 
 namespace Rector\Doctrine\Tests\CodeQuality\Rector\Property\ImproveDoctrineCollectionDocTypeInEntityRector\Source;
 
+use Doctrine\ORM\Mapping as ORM;
+
 final class Training
 {
-
+    /**
+     * @ORM\Column(name: 'id', type: 'string')
+     * @ORM\Id
+     */
+    private string $id;
 }
diff --git a/...ity/Rector/Class_/AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector.php b/...ity/Rector/Class_/AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector.php
@@ -128,7 +128,8 @@ public function refactor(Node $node): ?Node
             $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($classMethod);
             $newVarType = $this->collectionTypeFactory->createType(
                 $collectionObjectType,
-                $this->collectionTypeResolver->hasIndexBy($property)
+                $this->collectionTypeResolver->hasIndexBy($property),
+                $property
             );
             $this->phpDocTypeChanger->changeReturnType($classMethod, $phpDocInfo, $newVarType);
             $hasChanged = true;

diff --git a/rules/CodeQuality/Rector/Property/ImproveDoctrineCollectionDocTypeInEntityRector.php b/rules/CodeQuality/Rector/Property/ImproveDoctrineCollectionDocTypeInEntityRector.php
@@ -210,7 +210,8 @@ private function refactorPropertyPhpDocInfo(Property $property, PhpDocInfo $phpD
 
             $newVarType = $this->collectionTypeFactory->createType(
                 $collectionObjectType,
-                $this->collectionTypeResolver->hasIndexBy($property)
+                $this->collectionTypeResolver->hasIndexBy($property),
+                $property
             );
             $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $newVarType);
         } else {
@@ -221,7 +222,8 @@ private function refactorPropertyPhpDocInfo(Property $property, PhpDocInfo $phpD
 
             $newVarType = $this->collectionTypeFactory->createType(
                 $collectionObjectType,
-                $this->collectionTypeResolver->hasIndexBy($property)
+                $this->collectionTypeResolver->hasIndexBy($property),
+                $property
             );
             $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $newVarType);
         }
@@ -257,7 +259,8 @@ private function refactorAttribute(Expr $expr, PhpDocInfo $phpDocInfo, Property
 
         $genericObjectType = $this->collectionTypeFactory->createType(
             $fullyQualifiedObjectType,
-            $this->collectionTypeResolver->hasIndexBy($property)
+            $this->collectionTypeResolver->hasIndexBy($property),
+            $property
         );
         $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $genericObjectType);
 

diff --git a/rules/CodeQuality/SetterCollectionResolver.php b/rules/CodeQuality/SetterCollectionResolver.php
@@ -84,7 +84,8 @@ public function resolveAssignedGenericCollectionType(Class_ $class, ClassMethod
                 if ($soleType instanceof ArrayType && $soleType->getItemType() instanceof ObjectType) {
                     return $this->collectionTypeFactory->createType(
                         $soleType->getItemType(),
-                        $this->collectionTypeResolver->hasIndexBy($property)
+                        $this->collectionTypeResolver->hasIndexBy($property),
+                        $property
                     );
                 }
             }

diff --git a/src/NodeManipulator/ToManyRelationPropertyTypeResolver.php b/src/NodeManipulator/ToManyRelationPropertyTypeResolver.php
@@ -96,7 +96,8 @@ private function resolveTypeFromTargetEntity(Expr|string $targetEntity, Property
 
         return $this->collectionTypeFactory->createType(
             $fullyQualifiedObjectType,
-            $this->collectionTypeResolver->hasIndexBy($property)
+            $this->collectionTypeResolver->hasIndexBy($property),
+            $property
         );
     }
 }
diff --git a/src/TypeAnalyzer/CollectionTypeFactory.php b/src/TypeAnalyzer/CollectionTypeFactory.php
@@ -4,16 +4,41 @@
 
 namespace Rector\Doctrine\TypeAnalyzer;
 
+use PhpParser\Node\Param;
+use PhpParser\Node\Stmt\Property;
 use PHPStan\Type\Generic\GenericObjectType;
 use PHPStan\Type\IntegerType;
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\StringType;
+use Rector\PhpParser\AstResolver;
 
-final class CollectionTypeFactory
+final readonly class CollectionTypeFactory
 {
-    public function createType(ObjectType $objectType, bool $withIndexBy): GenericObjectType
+    public function __construct(
+        private AstResolver $astResolver
+    ) {
+    }
+
+    public function createType(ObjectType $objectType, bool $withIndexBy, Property|Param $property): GenericObjectType
     {
-        $genericTypes = $withIndexBy ? [$objectType] : [new IntegerType(), $objectType];
+        $keyType = new IntegerType();
+
+        if ($withIndexBy) {
+            $keyType = $this->resolveKeyType($property, $objectType->getClassName());
+        }
+
+        $genericTypes = [$keyType, $objectType];
 
         return new GenericObjectType('Doctrine\Common\Collections\Collection', $genericTypes);
     }
+
+    private function resolveKeyType(Property|Param $property, string $className): IntegerType|StringType
+    {
+        // todo, resolve type from annotation/attribute
+        //    -> use AstResolver to get target Class
+        //         -> get property type from it
+        //             -> resolve from its annotation/attribute
+        // fallback to IntegerType
+        return new IntegerType();
+    }
 }