[PHP 8.0] Add NestedAnnotationToAttributeRector (#2781)

* [PHP 8.0] Add NestedAnnotationToAttributeRector * remove unused class-string * [PHP 8.0] Add NestedAnnotationToAttribute * move JoinColumns to NestedAnnotationToAttributeRector * [ci-review] Rector Rectify Co-authored-by: GitHub Action <action@github.com>
rectorphp · Aug 18, 2022 · b8549f5 · b8549f5
1 parent f41acb3
commit b8549f5
Show file tree

Hide file tree

Showing 23 changed files with 620 additions and 109 deletions.
diff --git a/packages-tests/PhpAttribute/UseAliasNameMatcherTest.php b/packages-tests/PhpAttribute/UseAliasNameMatcherTest.php
@@ -47,7 +47,6 @@ public function test(
 
         // uses
         $useAliasMetadata = $this->useAliasNameMatcher->match($uses, $shortAnnotationName, $annotationToAttribute);
-
         $this->assertInstanceOf(UseAliasMetadata::class, $useAliasMetadata);
 
         // test new use import

diff --git a/packages/PhpAttribute/NodeFactory/AttributeNameFactory.php b/packages/PhpAttribute/NodeFactory/AttributeNameFactory.php
@@ -8,7 +8,7 @@
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Stmt\Use_;
 use Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode;
-use Rector\Php80\ValueObject\AnnotationToAttribute;
+use Rector\Php80\Contract\ValueObject\AnnotationToAttributeInterface;
 use Rector\PhpAttribute\UseAliasNameMatcher;
 use Rector\PhpAttribute\ValueObject\UseAliasMetadata;
 
@@ -23,7 +23,7 @@ public function __construct(
      * @param Use_[] $uses
      */
     public function create(
-        AnnotationToAttribute $annotationToAttribute,
+        AnnotationToAttributeInterface $annotationToAttribute,
         DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode,
         array $uses
     ): FullyQualified|Name {

diff --git a/packages/PhpAttribute/NodeFactory/PhpAttributeGroupFactory.php b/packages/PhpAttribute/NodeFactory/PhpAttributeGroupFactory.php
@@ -104,6 +104,8 @@ public function createArgsFromItems(array $items, string $attributeClass): array
     }
 
     /**
+     * @todo deprecated
+     *
      * @param mixed[] $items
      * @return mixed[]
      */

diff --git a/packages/PhpAttribute/NodeFactory/PhpNestedAttributeGroupFactory.php b/packages/PhpAttribute/NodeFactory/PhpNestedAttributeGroupFactory.php
@@ -0,0 +1,141 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PhpAttribute\NodeFactory;
+
+use Nette\Utils\Strings;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Attribute;
+use PhpParser\Node\AttributeGroup;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Name;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Use_;
+use Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode;
+use Rector\BetterPhpDocParser\ValueObject\PhpDoc\DoctrineAnnotation\CurlyListNode;
+use Rector\Php80\ValueObject\NestedAnnotationToAttribute;
+use Rector\PhpAttribute\AnnotationToAttributeMapper;
+use Rector\PhpAttribute\AttributeArrayNameInliner;
+use Rector\PhpAttribute\NodeAnalyzer\ExprParameterReflectionTypeCorrector;
+
+final class PhpNestedAttributeGroupFactory
+{
+    /**
+     * @var string
+     * @see https://regex101.com/r/g3d9jy/1
+     */
+    private const SHORT_ORM_ALIAS_REGEX = '#^@ORM#';
+
+    public function __construct(
+        private readonly AnnotationToAttributeMapper $annotationToAttributeMapper,
+        private readonly AttributeNameFactory $attributeNameFactory,
+        private readonly NamedArgsFactory $namedArgsFactory,
+        private readonly ExprParameterReflectionTypeCorrector $exprParameterReflectionTypeCorrector,
+        private readonly AttributeArrayNameInliner $attributeArrayNameInliner
+    ) {
+    }
+
+    /**
+     * @param Use_[] $uses
+     */
+    public function create(
+        DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode,
+        NestedAnnotationToAttribute $nestedAnnotationToAttribute,
+        array $uses
+    ): AttributeGroup {
+        $values = $doctrineAnnotationTagValueNode->getValuesWithExplicitSilentAndWithoutQuotes();
+
+        $args = $this->createArgsFromItems($values, $nestedAnnotationToAttribute);
+        $args = $this->attributeArrayNameInliner->inlineArrayToArgs($args);
+
+        $attributeName = $this->attributeNameFactory->create(
+            $nestedAnnotationToAttribute,
+            $doctrineAnnotationTagValueNode,
+            $uses
+        );
+
+        $attribute = new Attribute($attributeName, $args);
+        return new AttributeGroup([$attribute]);
+    }
+
+    /**
+     * @return AttributeGroup[]
+     */
+    public function createNested(
+        DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode,
+        NestedAnnotationToAttribute $nestedAnnotationToAttribute,
+    ): array {
+        $attributeGroups = [];
+
+        $values = $doctrineAnnotationTagValueNode->getValuesWithExplicitSilentAndWithoutQuotes();
+
+        foreach ($nestedAnnotationToAttribute->getAnnotationPropertiesToAttributeClasses() as $itemName => $nestedAttributeClass) {
+            $nestedValues = $values[$itemName] ?? null;
+            if ($nestedValues === null) {
+                continue;
+            }
+
+            if ($nestedValues instanceof CurlyListNode) {
+                foreach ($nestedValues->getValues() as $nestedDoctrineAnnotationTagValueNode) {
+                    /** @var DoctrineAnnotationTagValueNode $nestedDoctrineAnnotationTagValueNode */
+                    $args = $this->createArgsFromItems(
+                        $nestedDoctrineAnnotationTagValueNode->getValuesWithExplicitSilentAndWithoutQuotes(),
+                        $nestedAnnotationToAttribute
+                    );
+
+                    $args = $this->attributeArrayNameInliner->inlineArrayToArgs($args);
+
+                    $originalIdentifier = $nestedDoctrineAnnotationTagValueNode->identifierTypeNode->name;
+
+                    $attributeName = $this->resolveAliasedAttributeName($originalIdentifier, $nestedAttributeClass);
+
+                    $attribute = new Attribute($attributeName, $args);
+                    $attributeGroups[] = new AttributeGroup([$attribute]);
+                }
+            }
+        }
+
+        return $attributeGroups;
+    }
+
+    /**
+     * @param mixed[] $items
+     * @return Arg[]
+     */
+    private function createArgsFromItems(array $items, NestedAnnotationToAttribute $nestedAnnotationToAttribute): array
+    {
+        // remove nested items
+        foreach (array_keys($nestedAnnotationToAttribute->getAnnotationPropertiesToAttributeClasses()) as $itemName) {
+            unset($items[$itemName]);
+        }
+
+        /** @var Expr[]|Expr\Array_ $items */
+        $items = $this->annotationToAttributeMapper->map($items);
+
+        $items = $this->exprParameterReflectionTypeCorrector->correctItemsByAttributeClass(
+            $items,
+            $nestedAnnotationToAttribute->getTag()
+        );
+
+        return $this->namedArgsFactory->createFromValues($items);
+    }
+
+    /**
+     * @todo improve this hardcoded approach later
+     */
+    private function resolveAliasedAttributeName(
+        string $originalIdentifier,
+        string $nestedAttributeClass
+    ): FullyQualified|Name {
+        $matches = Strings::match($originalIdentifier, self::SHORT_ORM_ALIAS_REGEX);
+
+        if ($matches !== null) {
+            // or alias
+            $shortDoctrineAttributeName = Strings::after($nestedAttributeClass, '\\', -1);
+            return new Name('ORM\\' . $shortDoctrineAttributeName);
+        }
+
+        return new FullyQualified($nestedAttributeClass);
+    }
+}
diff --git a/packages/PhpAttribute/RemovableAnnotationAnalyzer.php b/packages/PhpAttribute/RemovableAnnotationAnalyzer.php
diff --git a/packages/PhpAttribute/UseAliasNameMatcher.php b/packages/PhpAttribute/UseAliasNameMatcher.php
@@ -7,7 +7,7 @@
 use PhpParser\Node\Stmt\Use_;
 use PhpParser\Node\Stmt\UseUse;
 use Rector\NodeTypeResolver\Node\AttributeKey;
-use Rector\Php80\ValueObject\AnnotationToAttribute;
+use Rector\Php80\Contract\ValueObject\AnnotationToAttributeInterface;
 use Rector\PhpAttribute\ValueObject\UseAliasMetadata;
 
 /**
@@ -21,7 +21,7 @@ final class UseAliasNameMatcher
     public function match(
         array $uses,
         string $shortAnnotationName,
-        AnnotationToAttribute $annotationToAttribute
+        AnnotationToAttributeInterface $annotationToAttribute
     ): ?UseAliasMetadata {
         $shortAnnotationName = trim($shortAnnotationName, '@');
 

diff --git a/...s/Php80/Rector/Class_/AnnotationToAttributeRector/Fixture/Doctrine/trailing_comma.php.inc b/...s/Php80/Rector/Class_/AnnotationToAttributeRector/Fixture/Doctrine/trailing_comma.php.inc
@@ -2,13 +2,13 @@
 
 namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Doctrine;
 
-use Doctrine\ORM\Mapping as ORM;
+use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\GenericAnnotation;
 
 final class TrailingComma
 {
     /**
-     * @ORM\JoinColumn(name="parent_id", referencedColumnName="id", nullable=true, )
-     **/
+     * @GenericAnnotation(key="value", )
+     */
     protected $someColumn;
 }
 
@@ -18,11 +18,11 @@ final class TrailingComma
 
 namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Doctrine;
 
-use Doctrine\ORM\Mapping as ORM;
+use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\GenericAnnotation;
 
 final class TrailingComma
 {
-    #[ORM\JoinColumn(name: 'parent_id', referencedColumnName: 'id', nullable: true)]
+    #[GenericAnnotation(key: 'value')]
     protected $someColumn;
 }
 

diff --git a/rules-tests/Php80/Rector/Class_/AnnotationToAttributeRector/config/configured_rule.php b/rules-tests/Php80/Rector/Class_/AnnotationToAttributeRector/config/configured_rule.php
@@ -34,8 +34,6 @@
             new AnnotationToAttribute('Doctrine\ORM\Mapping\Table'),
             new AnnotationToAttribute('Doctrine\ORM\Mapping\Index'),
             new AnnotationToAttribute('Doctrine\ORM\Mapping\UniqueConstraint'),
-            new AnnotationToAttribute('Doctrine\ORM\Mapping\JoinColumns'),
-            new AnnotationToAttribute('Doctrine\ORM\Mapping\JoinColumn'),
             new AnnotationToAttribute('Doctrine\ORM\Mapping\DiscriminatorMap'),
 
             // validation

diff --git a/...rine/doctrine_nested_join_columns.php.inc → ...ture/doctrine_nested_join_columns.php.inc b/...rine/doctrine_nested_join_columns.php.inc → ...ture/doctrine_nested_join_columns.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Doctrine;
+namespace Rector\Tests\Php80\Rector\Property\NestedAnnotationToAttributeRector\Fixture;
 
 use Doctrine\ORM\Mapping as ORM;
 
@@ -19,7 +19,7 @@ final class DoctrineNestedJoinColumns
 -----
 <?php
 
-namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Doctrine;
+namespace Rector\Tests\Php80\Rector\Property\NestedAnnotationToAttributeRector\Fixture;
 
 use Doctrine\ORM\Mapping as ORM;
 

diff --git a/...Property/NestedAnnotationToAttributeRector/Fixture/multiple_inversed_join_columns.php.inc b/...Property/NestedAnnotationToAttributeRector/Fixture/multiple_inversed_join_columns.php.inc
@@ -0,0 +1,36 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\Property\NestedAnnotationToAttributeRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+final class MultipleInversedJoinColumns
+{
+    /**
+     * @ORM\JoinTable(name="join_table_name",
+     *     inverseJoinColumns={
+     *          @ORM\JoinColumn(name="target_id"),
+     *          @ORM\JoinColumn(name="another_id")
+     *     }
+     * )
+     */
+    private $collection;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php80\Rector\Property\NestedAnnotationToAttributeRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+final class MultipleInversedJoinColumns
+{
+    #[ORM\JoinTable(name: 'join_table_name')]
+    #[ORM\InverseJoinColumn(name: 'target_id')]
+    #[ORM\InverseJoinColumn(name: 'another_id')]
+    private $collection;
+}
+
+?>
diff --git a/...-tests/Php80/Rector/Property/NestedAnnotationToAttributeRector/Fixture/some_class.php.inc b/...-tests/Php80/Rector/Property/NestedAnnotationToAttributeRector/Fixture/some_class.php.inc
@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\Property\NestedAnnotationToAttributeRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+final class SomeEntity
+{
+    /**
+     * @ORM\JoinTable(name="join_table_name",
+     *     joinColumns={@ORM\JoinColumn(name="origin_id")},
+     *     inverseJoinColumns={@ORM\JoinColumn(name="target_id")}
+     * )
+     */
+    private $collection;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php80\Rector\Property\NestedAnnotationToAttributeRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+final class SomeEntity
+{
+    #[ORM\JoinTable(name: 'join_table_name')]
+    #[ORM\JoinColumn(name: 'origin_id')]
+    #[ORM\InverseJoinColumn(name: 'target_id')]
+    private $collection;
+}
+
+?>