Add odm support to AddReturnDocBlockToCollectionPropertyGetterByToMan…

…yAnnotationRector (#330)

* add failing fixture

* add odm support to AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector

rules-tests/CodeQuality/Rector/Class_/AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector/Fixture/Odm/orm_many.php.inc

@@ -0,0 +1,54 @@
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\Odm;
+
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\Mapping as ORM;
+use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;
+
+/**
+ * @\Doctrine\ODM\MongoDB\Mapping\Annotations\Document
+ */
+final class OdmMany
+{
+    /**
+     * @\Doctrine\ODM\MongoDB\Mapping\Annotations\ReferenceMany(targetDocument="\Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training")
+     */
+    private $items = [];
+
+    public function getItems()
+    {
+        return $this->items;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\Odm;
+
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\Mapping as ORM;
+use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;
+
+/**
+ * @\Doctrine\ODM\MongoDB\Mapping\Annotations\Document
+ */
+final class OdmMany
+{
+    /**
+     * @\Doctrine\ODM\MongoDB\Mapping\Annotations\ReferenceMany(targetDocument="\Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training")
+     */
+    private $items = [];
+
+    /**
+     * @return \Doctrine\Common\Collections\Collection<int, \\Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training>
+     */
+    public function getItems()
+    {
+        return $this->items;
+    }
+}
+
+?>

rules/CodeQuality/Enum/ToManyMappings.php

@@ -4,10 +4,17 @@
 
 namespace Rector\Doctrine\CodeQuality\Enum;
 
+use Rector\Doctrine\Enum\MappingClass;
+use Rector\Doctrine\Enum\OdmMappingClass;
+
 class ToManyMappings
 {
     /**
-     * @var class-string[]
+     * @var string[]
      */
-    final public const TO_MANY_CLASSES = ['Doctrine\\ORM\\Mapping\\OneToMany', 'Doctrine\\ORM\\Mapping\\ManyToMany'];
+    final public const TO_MANY_CLASSES = [
+        MappingClass::ONE_TO_MANY,
+        MappingClass::MANY_TO_MANY,
+        OdmMappingClass::REFERENCE_MANY,
+    ];
 }

rules/CodeQuality/Rector/Class_/AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector.php

@@ -107,13 +107,11 @@ public function refactorWithScope(Node $node, Scope $scope): ?Node
             }
 
             $property = $this->methodUniqueReturnedPropertyResolver->resolve($node, $classMethod);
-
             if (! $property instanceof Property) {
                 continue;
             }
 
             $collectionObjectType = $this->collectionTypeResolver->resolveFromToManyProperties($property);
-
             if (! $collectionObjectType instanceof FullyQualifiedObjectType) {
                 continue;
             }

src/PhpDocParser/DoctrineDocBlockResolver.php

@@ -6,6 +6,8 @@
 
 use PhpParser\Node\Stmt\Class_;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\Doctrine\Enum\MappingClass;
+use Rector\Doctrine\Enum\OdmMappingClass;
 
 final readonly class DoctrineDocBlockResolver
 {
@@ -17,6 +19,9 @@ public function __construct(
     public function isDoctrineEntityClass(Class_ $class): bool
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($class);
-        return $phpDocInfo->hasByAnnotationClasses(['Doctrine\ORM\Mapping\Entity', 'Doctrine\ORM\Mapping\Embeddable']);
+
+        return $phpDocInfo->hasByAnnotationClasses(
+            [MappingClass::ENTITY, MappingClass::EMBEDDABLE, OdmMappingClass::DOCUMENT]
+        );
     }
 }

src/TypeAnalyzer/CollectionTypeResolver.php

@@ -58,11 +58,15 @@ public function resolveFromToManyProperties(Property $property): ?FullyQualified
         }
 
         $targetEntityArrayItemNode = $doctrineAnnotationTagValueNode->getValue('targetEntity');
-        if (! $targetEntityArrayItemNode instanceof ArrayItemNode) {
+        // in case of odm
+        $targetDocumentArrayItemNode = $doctrineAnnotationTagValueNode->getValue('targetDocument');
+
+        $targetArrayItemNode = $targetEntityArrayItemNode ?: $targetDocumentArrayItemNode;
+        if (! $targetArrayItemNode instanceof ArrayItemNode) {
             return null;
         }
 
-        $targetEntityClass = $targetEntityArrayItemNode->value;
+        $targetEntityClass = $targetArrayItemNode->value;
 
         if ($targetEntityClass instanceof StringNode) {
             $targetEntityClass = $targetEntityClass->value;