add target document support to CompletePropertyDocblockFromToManyRector (#465)

* add target document support to CompletePropertyDocblockFromToManyRector

* move safer rules to collections docblocks

Author: TomasVotruba

config/sets/typed-collections-docblocks.php

@@ -3,11 +3,15 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\Doctrine\TypedCollections\Rector\Class_\CompletePropertyDocblockFromToManyRector;
 use Rector\Doctrine\TypedCollections\Rector\ClassMethod\CollectionDocblockGenericTypeRector;
+use Rector\Doctrine\TypedCollections\Rector\ClassMethod\DefaultCollectionKeyRector;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rules([
         // safe rules that handle only docblocks
         CollectionDocblockGenericTypeRector::class,
+        DefaultCollectionKeyRector::class,
+        CompletePropertyDocblockFromToManyRector::class,
     ]);
 };

config/sets/typed-collections.php

@@ -6,14 +6,12 @@
 use Rector\Doctrine\TypedCollections\Rector\Assign\ArrayDimFetchAssignToAddCollectionCallRector;
 use Rector\Doctrine\TypedCollections\Rector\Assign\ArrayOffsetSetToSetCollectionCallRector;
 use Rector\Doctrine\TypedCollections\Rector\Class_\CompleteParamDocblockFromSetterToCollectionRector;
-use Rector\Doctrine\TypedCollections\Rector\Class_\CompletePropertyDocblockFromToManyRector;
 use Rector\Doctrine\TypedCollections\Rector\Class_\CompleteReturnDocblockFromToManyRector;
 use Rector\Doctrine\TypedCollections\Rector\Class_\InitializeCollectionInConstructorRector;
 use Rector\Doctrine\TypedCollections\Rector\Class_\RemoveNullFromInstantiatedArrayCollectionPropertyRector;
 use Rector\Doctrine\TypedCollections\Rector\ClassMethod\CollectionGetterNativeTypeRector;
 use Rector\Doctrine\TypedCollections\Rector\ClassMethod\CollectionParamTypeSetterToCollectionPropertyRector;
 use Rector\Doctrine\TypedCollections\Rector\ClassMethod\CollectionSetterParamNativeTypeRector;
-use Rector\Doctrine\TypedCollections\Rector\ClassMethod\DefaultCollectionKeyRector;
 use Rector\Doctrine\TypedCollections\Rector\ClassMethod\NarrowArrayCollectionToCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\ClassMethod\NarrowParamUnionToCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\ClassMethod\NarrowReturnUnionToCollectionRector;
@@ -73,15 +71,13 @@
         RemoveNullFromNullableCollectionTypeRector::class,
 
         // docblocks
-        DefaultCollectionKeyRector::class,
         NarrowArrayCollectionToCollectionRector::class,
 
         // @param docblock
         CompleteParamDocblockFromSetterToCollectionRector::class,
         NarrowParamUnionToCollectionRector::class,
 
         // @var docblock
-        CompletePropertyDocblockFromToManyRector::class,
         NarrowPropertyUnionToCollectionRector::class,
 
         // @return docblock

rules-tests/TypedCollections/Rector/Class_/CompletePropertyDocblockFromToManyRector/Fixture/Odm/odm_many_attribute.php.inc

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

rules/CodeQuality/Enum/OdmMappingKey.php …/CodeQuality/Enum/DocumentMappingKey.phprules/CodeQuality/Enum/OdmMappingKey.php renamed to rules/CodeQuality/Enum/DocumentMappingKey.php rules/CodeQuality/Enum/OdmMappingKey.php renamed to rules/CodeQuality/Enum/DocumentMappingKey.php

@@ -7,7 +7,7 @@
 /**
  * @api
  */
-final class OdmMappingKey
+final class DocumentMappingKey
 {
     /**
      * @var string

src/NodeAnalyzer/TargetEntityResolver.php

@@ -10,6 +10,7 @@
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Scalar\String_;
 use PHPStan\Reflection\ReflectionProvider;
+use Rector\Doctrine\CodeQuality\Enum\DocumentMappingKey;
 use Rector\Doctrine\CodeQuality\Enum\EntityMappingKey;
 use Rector\Exception\NotImplementedYetException;
 use Rector\NodeNameResolver\NodeNameResolver;
@@ -29,7 +30,11 @@ public function resolveFromAttribute(Attribute $attribute): ?string
                 continue;
             }
 
-            if ($arg->name->toString() !== EntityMappingKey::TARGET_ENTITY) {
+            if (! in_array(
+                $arg->name->toString(),
+                [EntityMappingKey::TARGET_ENTITY, DocumentMappingKey::TARGET_DOCUMENT],
+                true
+            )) {
                 continue;
             }
 

src/NodeManipulator/ToManyRelationPropertyTypeResolver.php

@@ -14,8 +14,8 @@
 use Rector\BetterPhpDocParser\PhpDoc\StringNode;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\Doctrine\CodeQuality\Enum\CollectionMapping;
+use Rector\Doctrine\CodeQuality\Enum\DocumentMappingKey;
 use Rector\Doctrine\CodeQuality\Enum\EntityMappingKey;
-use Rector\Doctrine\CodeQuality\Enum\OdmMappingKey;
 use Rector\Doctrine\Enum\DoctrineClass;
 use Rector\Doctrine\NodeAnalyzer\AttributeFinder;
 use Rector\Doctrine\PhpDoc\ShortClassExpander;
@@ -48,7 +48,7 @@ public function resolve(Property $property): ?Type
         $expr = $this->attributeFinder->findAttributeByClassesArgByNames(
             $property,
             CollectionMapping::TO_MANY_CLASSES,
-            [EntityMappingKey::TARGET_ENTITY, OdmMappingKey::TARGET_DOCUMENT]
+            [EntityMappingKey::TARGET_ENTITY, DocumentMappingKey::TARGET_DOCUMENT]
         );
 
         if (! $expr instanceof Expr) {
@@ -64,7 +64,7 @@ private function processToManyRelation(
     ): Type|null {
         $targetEntityArrayItemNode = $doctrineAnnotationTagValueNode->getValue(
             EntityMappingKey::TARGET_ENTITY
-        ) ?: $doctrineAnnotationTagValueNode->getValue(OdmMappingKey::TARGET_DOCUMENT);
+        ) ?: $doctrineAnnotationTagValueNode->getValue(DocumentMappingKey::TARGET_DOCUMENT);
         if (! $targetEntityArrayItemNode instanceof ArrayItemNode) {
             // most likely mapped superclass
             return new ObjectType(DoctrineClass::COLLECTION);

src/TypeAnalyzer/CollectionTypeResolver.php

@@ -23,8 +23,8 @@
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\Doctrine\CodeQuality\Enum\CollectionMapping;
+use Rector\Doctrine\CodeQuality\Enum\DocumentMappingKey;
 use Rector\Doctrine\CodeQuality\Enum\EntityMappingKey;
-use Rector\Doctrine\CodeQuality\Enum\OdmMappingKey;
 use Rector\Doctrine\NodeAnalyzer\AttrinationFinder;
 use Rector\Doctrine\NodeAnalyzer\TargetEntityResolver;
 use Rector\Doctrine\PhpDoc\ShortClassExpander;
@@ -111,7 +111,7 @@ public function resolveFromToManyProperty(Property $property): ?FullyQualifiedOb
         if ($doctrineAnnotationTagValueNodeOrAttribute instanceof Attribute) {
             $targetEntityExpr = $this->findExprByArgNames(
                 $doctrineAnnotationTagValueNodeOrAttribute->args,
-                [EntityMappingKey::TARGET_ENTITY, OdmMappingKey::TARGET_DOCUMENT]
+                [EntityMappingKey::TARGET_ENTITY, DocumentMappingKey::TARGET_DOCUMENT]
             );
 
             if (! $targetEntityExpr instanceof ClassConstFetch) {