Deprecate InitializeDefaultEntityCollectionRector, use ExplicitRelati…

…onCollectionRector instead (#304)

* cover many to many as well

* add annotation test

* deprecate InitializeDefaultEntityCollectionRector, use ExplicitRelationCollectionRector instead

config/sets/doctrine-code-quality.php

@@ -4,7 +4,6 @@
 
 use Rector\Config\RectorConfig;
 use Rector\Doctrine\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector;
-use Rector\Doctrine\CodeQuality\Rector\Class_\InitializeDefaultEntityCollectionRector;
 use Rector\Doctrine\CodeQuality\Rector\Class_\MoveCurrentDateTimeDefaultInEntityToConstructorRector;
 use Rector\Doctrine\CodeQuality\Rector\Class_\RemoveEmptyTableAttributeRector;
 use Rector\Doctrine\CodeQuality\Rector\Property\CorrectDefaultTypesOnEntityPropertyRector;
@@ -22,9 +21,10 @@
         MakeEntityDateTimePropertyDateTimeInterfaceRector::class,
         MoveCurrentDateTimeDefaultInEntityToConstructorRector::class,
         CorrectDefaultTypesOnEntityPropertyRector::class,
-        ImproveDoctrineCollectionDocTypeInEntityRector::class,
-        InitializeDefaultEntityCollectionRector::class,
+
         ExplicitRelationCollectionRector::class,
+        ImproveDoctrineCollectionDocTypeInEntityRector::class,
+
         RemoveEmptyTableAttributeRector::class,
 
         // typed properties in entities from annotations/attributes

rules-tests/CodeQuality/Rector/Class_/ExplicitRelationCollectionRector/ExplicitRelationCollectionRectorTest.php

@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector;
 
+use Iterator;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 
@@ -15,7 +16,7 @@ public function test(string $filePath): void
         $this->doTestFile($filePath);
     }
 
-    public static function provideData(): \Iterator
+    public static function provideData(): Iterator
     {
         return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
     }

rules-tests/CodeQuality/Rector/Class_/ExplicitRelationCollectionRector/Fixture/include_annotation.php.inc

@@ -0,0 +1,48 @@
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector\Fixture;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\ManyToMany;
+
+/**
+ * @Entity
+ */
+class IncludeAnnotation
+{
+    /**
+     * @ManyToMany(targetEntity="SomeClass")
+     */
+    private $items = [];
+    public function __construct()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector\Fixture;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\ManyToMany;
+
+/**
+ * @Entity
+ */
+class IncludeAnnotation
+{
+    /**
+     * @ManyToMany(targetEntity="SomeClass")
+     */
+    private \Doctrine\Common\Collections\Collection $items;
+    public function __construct()
+    {
+        $this->items = new \Doctrine\Common\Collections\ArrayCollection();
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/ExplicitRelationCollectionRector/Fixture/some_many_to_many.php.inc

@@ -0,0 +1,40 @@
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector\Fixture;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\ManyToMany;
+
+#[Entity]
+class SomeManyToMany
+{
+    #[ManyToMany(targetEntity: 'SomeClass')]
+    private $items = [];
+    public function __construct()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector\Fixture;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\ManyToMany;
+
+#[Entity]
+class SomeManyToMany
+{
+    #[ManyToMany(targetEntity: 'SomeClass')]
+    private \Doctrine\Common\Collections\Collection $items;
+    public function __construct()
+    {
+        $this->items = new \Doctrine\Common\Collections\ArrayCollection();
+    }
+}
+
+?>

rules/CodeQuality/Rector/Class_/ExplicitRelationCollectionRector.php

@@ -18,6 +18,8 @@
 
 /**
  * @see \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector\ExplicitRelationCollectionRectorTest
+ *
+ * @changelog https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/best-practices.html#initialize-collections-in-the-constructor
  */
 final class ExplicitRelationCollectionRector extends AbstractRector
 {
@@ -88,7 +90,10 @@ public function refactor(Node $node): ?Node
         $arrayCollectionAssigns = [];
 
         foreach ($node->getProperties() as $property) {
-            if (! $this->attrinationFinder->hasByOne($property, 'Doctrine\ORM\Mapping\OneToMany')) {
+            if (! $this->attrinationFinder->hasByMany($property, [
+                'Doctrine\ORM\Mapping\OneToMany',
+                'Doctrine\ORM\Mapping\ManyToMany',
+            ])) {
                 continue;
             }
 

rules/CodeQuality/Rector/Class_/InitializeDefaultEntityCollectionRector.php

@@ -19,6 +19,8 @@
  * @see https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/best-practices.html#initialize-collections-in-the-constructor
  *
  * @see \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\InitializeDefaultEntityCollectionRector\InitializeDefaultEntityCollectionRectorTest
+ *
+ * @deprecated This rule can create incomplete assign of object to an array. Use the @see \Rector\Doctrine\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector instead.
  */
 final class InitializeDefaultEntityCollectionRector extends AbstractRector
 {