Add annotation to attribute core rename in AnnotationToAttributeRector (

#2384) * fix fixture name * [PHP 8.0] Add test case for partial import annotation to attribute rename
rectorphp · May 28, 2022 · 012e9ad · 012e9ad
1 parent 31e60de
commit 012e9ad
Show file tree

Hide file tree

Showing 19 changed files with 226 additions and 65 deletions.
diff --git a/packages-tests/PhpAttribute/Printer/PhpAttributeGroupFactoryTest.php b/packages-tests/PhpAttribute/Printer/PhpAttributeGroupFactoryTest.php
@@ -6,7 +6,7 @@
 
 use PhpParser\Node\Arg;
 use PhpParser\Node\AttributeGroup;
-use Rector\PhpAttribute\Printer\PhpAttributeGroupFactory;
+use Rector\PhpAttribute\NodeFactory\PhpAttributeGroupFactory;
 use Rector\Testing\PHPUnit\AbstractTestCase;
 use Rector\Tests\Transform\Rector\FuncCall\ArgumentFuncCallToMethodCallRector\Fixture\Route;
 

diff --git a/packages/BetterPhpDocParser/PhpDocParser/PhpDocFromTypeDeclarationDecorator.php b/packages/BetterPhpDocParser/PhpDocParser/PhpDocFromTypeDeclarationDecorator.php
@@ -23,7 +23,7 @@
 use Rector\Core\PhpParser\Node\BetterNodeFinder;
 use Rector\NodeNameResolver\NodeNameResolver;
 use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
-use Rector\PhpAttribute\Printer\PhpAttributeGroupFactory;
+use Rector\PhpAttribute\NodeFactory\PhpAttributeGroupFactory;
 use Rector\PHPStanStaticTypeMapper\Utils\TypeUnwrapper;
 use Rector\StaticTypeMapper\StaticTypeMapper;
 use ReturnTypeWillChange;

diff --git a/packages/PhpAttribute/NodeFactory/AttributeNameFactory.php b/packages/PhpAttribute/NodeFactory/AttributeNameFactory.php
@@ -4,24 +4,96 @@
 
 namespace Rector\PhpAttribute\NodeFactory;
 
+use Nette\Utils\Strings;
 use PhpParser\Node\Name;
 use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Use_;
 use Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode;
 use Rector\Php80\ValueObject\AnnotationToAttribute;
+use Rector\PhpAttribute\ValueObject\UseAliasMetadata;
 
 final class AttributeNameFactory
 {
+    /**
+     * @param Use_[] $uses
+     */
     public function create(
         AnnotationToAttribute $annotationToAttribute,
-        DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode
+        DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode,
+        array $uses
     ): FullyQualified|Name {
-        // attribute and class name are the same, so we re-use the short form to keep code compatible with previous one
+        // A. attribute and class name are the same, so we re-use the short form to keep code compatible with previous one
         if ($annotationToAttribute->getAttributeClass() === $annotationToAttribute->getTag()) {
             $attributeName = $doctrineAnnotationTagValueNode->identifierTypeNode->name;
             $attributeName = ltrim($attributeName, '@');
+
             return new Name($attributeName);
         }
 
+        // B. different name
+        $useAliasMetadata = $this->matchUseAliasMetadata(
+            $uses,
+            $doctrineAnnotationTagValueNode,
+            $annotationToAttribute
+        );
+        if ($useAliasMetadata instanceof UseAliasMetadata) {
+            $useUse = $useAliasMetadata->getUseUse();
+
+            // is same as name?
+            $useImportName = $useAliasMetadata->getUseImportName();
+            if ($useUse->name->toString() !== $useImportName) {
+                // no? rename
+                $useUse->name = new Name($useImportName);
+            }
+
+            return new Name($useAliasMetadata->getShortAttributeName());
+        }
+
+        // 3. the class is not aliased and is compeltelly new... return the FQN version
         return new FullyQualified($annotationToAttribute->getAttributeClass());
     }
+
+    /**
+     * @param Use_[] $uses
+     */
+    private function matchUseAliasMetadata(
+        array $uses,
+        DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode,
+        AnnotationToAttribute $annotationToAttribute
+    ): ?UseAliasMetadata {
+        $shortAnnotationName = trim($doctrineAnnotationTagValueNode->identifierTypeNode->name, '@');
+
+        foreach ($uses as $use) {
+            foreach ($use->uses as $useUse) {
+                if ($useUse->alias === null) {
+                    continue;
+                }
+
+                $alias = $useUse->alias->toString();
+                if (! str_starts_with($shortAnnotationName, $alias)) {
+                    continue;
+                }
+
+                $importName = $useUse->name->toString();
+
+                // previous keyword
+                $lastImportKeyword = Strings::after($importName, '\\', -1);
+                if ($lastImportKeyword === null) {
+                    continue;
+                }
+
+                // resolve new short name
+                $newShortname = Strings::after($annotationToAttribute->getAttributeClass(), $lastImportKeyword);
+
+                $beforeImportName = Strings::before(
+                    $annotationToAttribute->getAttributeClass(),
+                    $lastImportKeyword
+                ) . $lastImportKeyword;
+
+                return new UseAliasMetadata($alias . $newShortname, $beforeImportName, $useUse);
+            }
+        }
+
+        return null;
+    }
 }
diff --git a/...ute/Printer/DoctrineAnnotationFactory.php → ...NodeFactory/DoctrineAnnotationFactory.php b/...ute/Printer/DoctrineAnnotationFactory.php → ...NodeFactory/DoctrineAnnotationFactory.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\PhpAttribute\Printer;
+namespace Rector\PhpAttribute\NodeFactory;
 
 use PhpParser\Node\Arg;
 use PhpParser\Node\Attribute;

diff --git a/...bute/Printer/PhpAttributeGroupFactory.php → .../NodeFactory/PhpAttributeGroupFactory.php b/...bute/Printer/PhpAttributeGroupFactory.php → .../NodeFactory/PhpAttributeGroupFactory.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\PhpAttribute\Printer;
+namespace Rector\PhpAttribute\NodeFactory;
 
 use PhpParser\Node\Arg;
 use PhpParser\Node\Attribute;
@@ -11,15 +11,14 @@
 use PhpParser\Node\Expr\ArrayItem;
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Scalar\String_;
+use PhpParser\Node\Stmt\Use_;
 use Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode;
 use Rector\Core\Php\PhpVersionProvider;
 use Rector\Core\ValueObject\PhpVersionFeature;
 use Rector\Php80\ValueObject\AnnotationToAttribute;
 use Rector\PhpAttribute\AnnotationToAttributeMapper;
 use Rector\PhpAttribute\AttributeArrayNameInliner;
 use Rector\PhpAttribute\NodeAnalyzer\ExprParameterReflectionTypeCorrector;
-use Rector\PhpAttribute\NodeFactory\AttributeNameFactory;
-use Rector\PhpAttribute\NodeFactory\NamedArgsFactory;
 
 /**
  * @see \Rector\Tests\PhpAttribute\Printer\PhpAttributeGroupFactoryTest
@@ -70,20 +69,24 @@ public function createFromClassWithItems(string $attributeClass, array $items):
         return new AttributeGroup([$attribute]);
     }
 
+    /**
+     * @param Use_[] $uses
+     */
     public function create(
         DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode,
         AnnotationToAttribute $annotationToAttribute,
+        array $uses
     ): AttributeGroup {
         $values = $doctrineAnnotationTagValueNode->getValuesWithExplicitSilentAndWithoutQuotes();
 
         $args = $this->createArgsFromItems($values, $annotationToAttribute->getAttributeClass());
-
-        // @todo this can be a different class then the unwrapped crated one
-        //$argumentNames = $this->namedArgumentsResolver->resolveFromClass($annotationToAttribute->getAttributeClass());
-
         $args = $this->attributeArrayNameInliner->inlineArrayToArgs($args);
 
-        $attributeName = $this->attributeNameFactory->create($annotationToAttribute, $doctrineAnnotationTagValueNode);
+        $attributeName = $this->attributeNameFactory->create(
+            $annotationToAttribute,
+            $doctrineAnnotationTagValueNode,
+            $uses
+        );
 
         $attribute = new Attribute($attributeName, $args);
         return new AttributeGroup([$attribute]);

diff --git a/packages/PhpAttribute/ValueObject/UseAliasMetadata.php b/packages/PhpAttribute/ValueObject/UseAliasMetadata.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PhpAttribute\ValueObject;
+
+use PhpParser\Node\Stmt\UseUse;
+
+final class UseAliasMetadata
+{
+    public function __construct(
+        private readonly string $shortAttributeName,
+        private readonly string $useImportName,
+        private readonly UseUse $useUse
+    ) {
+    }
+
+    public function getShortAttributeName(): string
+    {
+        return $this->shortAttributeName;
+    }
+
+    public function getUseImportName(): string
+    {
+        return $this->useImportName;
+    }
+
+    public function getUseUse(): UseUse
+    {
+        return $this->useUse;
+    }
+}
diff --git a/.../Rector/Class_/AnnotationToAttributeRector/Fixture/alias_used_with_partial_rename.php.inc b/.../Rector/Class_/AnnotationToAttributeRector/Fixture/alias_used_with_partial_rename.php.inc
@@ -0,0 +1,29 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture;
+
+use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Annotation\OpenApi as OA;
+
+final class AliasUsedWithUsePartialRename
+{
+    /**
+     * @OA\PastAnnotation
+     */
+    public $value;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture;
+
+use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Attribute\OpenApi as OA;
+
+final class AliasUsedWithUsePartialRename
+{
+    #[OA\FutureAttribute]
+    public $value;
+}
+
+?>
diff --git a/...80/Rector/Class_/AnnotationToAttributeRector/Source/Annotation/OpenApi/PastAnnotation.php b/...80/Rector/Class_/AnnotationToAttributeRector/Source/Annotation/OpenApi/PastAnnotation.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Annotation\OpenApi;
+
+final class PastAnnotation
+{
+}
diff --git a/...80/Rector/Class_/AnnotationToAttributeRector/Source/Attribute/OpenApi/FutureAttribute.php b/...80/Rector/Class_/AnnotationToAttributeRector/Source/Attribute/OpenApi/FutureAttribute.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Attribute\OpenApi;
+
+final class FutureAttribute
+{
+}
diff --git a/rules-tests/Php80/Rector/Class_/AnnotationToAttributeRector/config/configured_rule.php b/rules-tests/Php80/Rector/Class_/AnnotationToAttributeRector/config/configured_rule.php
@@ -6,6 +6,8 @@
 use Rector\Core\ValueObject\PhpVersionFeature;
 use Rector\Php80\Rector\Class_\AnnotationToAttributeRector;
 use Rector\Php80\ValueObject\AnnotationToAttribute;
+use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Annotation\OpenApi\PastAnnotation;
+use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Attribute\OpenApi\FutureAttribute;
 use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\GenericAnnotation;
 use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\GenericSingleImplicitAnnotation;
 
@@ -14,6 +16,8 @@
 
     $rectorConfig
         ->ruleWithConfiguration(AnnotationToAttributeRector::class, [
+            new AnnotationToAttribute(PastAnnotation::class, FutureAttribute::class),
+
             // use always this annotation to test inner part of annotation - arguments, arrays, calls...
             new AnnotationToAttribute(GenericAnnotation::class),
             new AnnotationToAttribute(GenericSingleImplicitAnnotation::class),

diff --git a/rules-tests/Renaming/Rector/Name/RenameClassRector/Fixture/class_to_new.php.inc b/rules-tests/Renaming/Rector/Name/RenameClassRector/Fixture/class_to_new.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\Renaming\Rector\Name\RenameClassRector;
+namespace Rector\Tests\Renaming\Rector\Name\RenameClassRector\Fixture;
 
 class MyCustomValidatorTest extends \Rector\Tests\Renaming\Rector\Name\RenameClassRector\Source\OldClass
 {
@@ -11,7 +11,7 @@ class MyCustomValidatorTest extends \Rector\Tests\Renaming\Rector\Name\RenameCla
 -----
 <?php
 
-namespace Rector\Tests\Renaming\Rector\Name\RenameClassRector;
+namespace Rector\Tests\Renaming\Rector\Name\RenameClassRector\Fixture;
 
 class MyCustomValidatorTest extends \Rector\Tests\Renaming\Rector\Name\RenameClassRector\Source\NewClass
 {

diff --git a/rules/DowngradePhp80/Rector/Class_/DowngradeAttributeToAnnotationRector.php b/rules/DowngradePhp80/Rector/Class_/DowngradeAttributeToAnnotationRector.php
@@ -17,7 +17,7 @@
 use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
 use Rector\Core\Rector\AbstractRector;
 use Rector\DowngradePhp80\ValueObject\DowngradeAttributeToAnnotation;
-use Rector\PhpAttribute\Printer\DoctrineAnnotationFactory;
+use Rector\PhpAttribute\NodeFactory\DoctrineAnnotationFactory;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 use Webmozart\Assert\Assert;

diff --git a/rules/Naming/Naming/UseImportsResolver.php b/rules/Naming/Naming/UseImportsResolver.php
@@ -37,4 +37,20 @@ public function resolveForNode(Node $node): array
             fn (Stmt $stmt): bool => $stmt instanceof Use_ || $stmt instanceof GroupUse
         );
     }
+
+    /**
+     * @return Use_[]
+     */
+    public function resolveBareUsesForNode(Node $node): array
+    {
+        $namespace = $this->betterNodeFinder->findParentByTypes(
+            $node,
+            [Namespace_::class, FileWithoutNamespace::class]
+        );
+        if (! $namespace instanceof Node) {
+            return [];
+        }
+
+        return array_filter($namespace->stmts, fn (Stmt $stmt): bool => $stmt instanceof Use_);
+    }
 }
diff --git a/rules/Php80/NodeFactory/AttrGroupsFactory.php b/rules/Php80/NodeFactory/AttrGroupsFactory.php
@@ -5,8 +5,9 @@
 namespace Rector\Php80\NodeFactory;
 
 use PhpParser\Node\AttributeGroup;
+use PhpParser\Node\Stmt\Use_;
 use Rector\Php80\ValueObject\DoctrineTagAndAnnotationToAttribute;
-use Rector\PhpAttribute\Printer\PhpAttributeGroupFactory;
+use Rector\PhpAttribute\NodeFactory\PhpAttributeGroupFactory;
 
 final class AttrGroupsFactory
 {
@@ -17,9 +18,10 @@ public function __construct(
 
     /**
      * @param DoctrineTagAndAnnotationToAttribute[] $doctrineTagAndAnnotationToAttributes
+     * @param Use_[] $uses
      * @return AttributeGroup[]
      */
-    public function create(array $doctrineTagAndAnnotationToAttributes): array
+    public function create(array $doctrineTagAndAnnotationToAttributes, array $uses): array
     {
         $attributeGroups = [];
 
@@ -30,6 +32,7 @@ public function create(array $doctrineTagAndAnnotationToAttributes): array
             $attributeGroups[] = $this->phpAttributeGroupFactory->create(
                 $doctrineAnnotationTagValueNode,
                 $doctrineTagAndAnnotationToAttribute->getAnnotationToAttribute(),
+                $uses
             );
         }