Merge AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRec…

…tor to single rule (#331)
rectorphp · Jul 25, 2024 · d609a83 · d609a83
1 parent 8bcc255
commit d609a83
Show file tree

Hide file tree

Showing 21 changed files with 167 additions and 605 deletions.
diff --git a/docs/rector_rules_overview.md b/docs/rector_rules_overview.md
@@ -1,49 +1,26 @@
-# 19 Rules Overview
+# 18 Rules Overview
 
 ## AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector
 
-Adds `@return` PHPDoc type to Collection property getter by *ToMany annotation
+Adds `@return` PHPDoc type to Collection property getter by *ToMany annotation/attribute
 
 - class: [`Rector\Doctrine\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector`](../rules/CodeQuality/Rector/Class_/AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector.php)
 
 ```diff
+-use App\Entity\Training;
+-
  /**
   * @ORM\Entity
   */
  final class Trainer
  {
      /**
-      * @ORM\OneToMany(targetEntity=Training::class, mappedBy="trainer")
+      * @ORM\OneToMany(targetEntity=Training::class)
       */
      private $trainings;
 
 +    /**
-+     * @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source>
-+     */
-     public function getTrainings()
-     {
-         return $this->trainings;
-     }
- }
-```
-
-<br>
-
-## AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector
-
-Adds `@return` PHPDoc type to Collection property getter by *ToMany attribute
-
-- class: [`Rector\Doctrine\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector`](../rules/CodeQuality/Rector/Class_/AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector.php)
-
-```diff
- #[ORM\Entity]
- final class Trainer
- {
-     #[ORM\OneToMany(targetEntity:Training::class, mappedBy:"trainer")]
-     private $trainings;
-
-+    /**
-+     * @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Property\ImproveDoctrineCollectionDocTypeInEntityRector\Source\Training>
++     * @return \Doctrine\Common\Collections\Collection<int, \App\Entity\Training>
 +     */
      public function getTrainings()
      {

diff --git a/...tyGetterByToManyAnnotationRector/Fixture/ManyToMany/attribute_getter_with_return_type.php b/...tyGetterByToManyAnnotationRector/Fixture/ManyToMany/attribute_getter_with_return_type.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\ManyToMany;
+
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\Mapping as ORM;
+use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;
+
+#[ORM\Entity]
+final class Trainer
+{
+    #[ORM\ManyToMany(targetEntity:Training::class, mappedBy:"trainer")]
+    private $trainings;
+
+    public function getTrainings(): Collection
+    {
+        return $this->trainings;
+    }
+}
+
+?>
diff --git a/...anyToMany/getter_with_return_type.php.inc → ...attribute_getter_with_return_type.php.inc b/...anyToMany/getter_with_return_type.php.inc → ...attribute_getter_with_return_type.php.inc
@@ -1,10 +1,10 @@
 <?php
 
-namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Fixture\ManyToMany;
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\ManyToMany;
 
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
-use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training;
+use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;
 
 #[ORM\Entity]
 final class Trainer
@@ -22,11 +22,11 @@ final class Trainer
 -----
 <?php
 
-namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Fixture\ManyToMany;
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\ManyToMany;
 
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
-use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training;
+use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;
 
 #[ORM\Entity]
 final class Trainer
@@ -35,7 +35,7 @@ final class Trainer
     private $trainings;
 
     /**
-     * @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training>
+     * @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training>
      */
     public function getTrainings(): Collection
     {

diff --git a/...OneToMany/getter_with_return_type.php.inc → ...attribute_getter_with_return_type.php.inc b/...OneToMany/getter_with_return_type.php.inc → ...attribute_getter_with_return_type.php.inc
@@ -1,13 +1,13 @@
 <?php
 
-namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Fixture\OneToMany;
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\OneToMany;
 
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
-use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training;
+use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;
 
 #[ORM\Entity]
-final class Trainer
+final class AttributeGetterWithReturnType
 {
     #[ORM\OneToMany(targetEntity:Training::class, mappedBy:"trainer")]
     private $trainings;
@@ -22,20 +22,20 @@ final class Trainer
 -----
 <?php
 
-namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Fixture\OneToMany;
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\OneToMany;
 
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
-use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training;
+use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;
 
 #[ORM\Entity]
-final class Trainer
+final class AttributeGetterWithReturnType
 {
     #[ORM\OneToMany(targetEntity:Training::class, mappedBy:"trainer")]
     private $trainings;
 
     /**
-     * @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training>
+     * @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training>
      */
     public function getTrainings(): Collection
     {

diff --git a/...ttributeRector/AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRectorTest.php b/...ttributeRector/AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRectorTest.php
diff --git a/...GetterByToManyAttributeRector/Fixture/OneToMany/association_with_no_target_entity.php.inc b/...GetterByToManyAttributeRector/Fixture/OneToMany/association_with_no_target_entity.php.inc
diff --git a/...ropertyGetterByToManyAttributeRector/Fixture/OneToMany/getter_without_return_type.php.inc b/...ropertyGetterByToManyAttributeRector/Fixture/OneToMany/getter_without_return_type.php.inc
diff --git a/...ByToManyAttributeRector/Fixture/OneToMany/multiple_returned_collection_properties.php.inc b/...ByToManyAttributeRector/Fixture/OneToMany/multiple_returned_collection_properties.php.inc
diff --git a/...tionPropertyGetterByToManyAttributeRector/Fixture/OneToMany/no_collection_methods.php.inc b/...tionPropertyGetterByToManyAttributeRector/Fixture/OneToMany/no_collection_methods.php.inc