From 27885425c27d1e3aea1a8f9b84182b3ee763468d Mon Sep 17 00:00:00 2001
From: Tomas Votruba <tomas.vot@gmail.com>
Date: Sun, 23 Jun 2024 02:08:53 +0900
Subject: [PATCH] [Renaming] Add RenameAttributeRector

---
 .../Fixture/fixture.php.inc                   |  31 ++++++
 .../Fixture/multiple-places.php.inc           |  33 ++++++
 .../RenameAttributeRectorTest.php             |  28 +++++
 .../Source/NextRoute.php                      |   8 ++
 .../Source/SimpleRoute.php                    |   8 ++
 .../config/configured_rule.php                |  16 +++
 .../Rector/Class_/RenameAttributeRector.php   | 105 ++++++++++++++++++
 .../Renaming/ValueObject/RenameAttribute.php  |  27 +++++
 8 files changed, 256 insertions(+)
 create mode 100644 rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/fixture.php.inc
 create mode 100644 rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/multiple-places.php.inc
 create mode 100644 rules-tests/Renaming/Rector/Class_/RenameAttributeRector/RenameAttributeRectorTest.php
 create mode 100644 rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/NextRoute.php
 create mode 100644 rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/SimpleRoute.php
 create mode 100644 rules-tests/Renaming/Rector/Class_/RenameAttributeRector/config/configured_rule.php
 create mode 100644 rules/Renaming/Rector/Class_/RenameAttributeRector.php
 create mode 100644 rules/Renaming/ValueObject/RenameAttribute.php

diff --git a/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/fixture.php.inc b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/fixture.php.inc
new file mode 100644
index 00000000000..84eaeebce43
--- /dev/null
+++ b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/fixture.php.inc
@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Fixture;
+
+use Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute;
+
+final class SomeClass
+{
+    #[SimpleRoute()]
+    public function subscribe()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Fixture;
+
+use Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute;
+
+final class SomeClass
+{
+    #[\Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\NextRoute()]
+    public function subscribe()
+    {
+    }
+}
+
+?>
diff --git a/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/multiple-places.php.inc b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/multiple-places.php.inc
new file mode 100644
index 00000000000..d829c458e74
--- /dev/null
+++ b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/multiple-places.php.inc
@@ -0,0 +1,33 @@
+<?php
+
+namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Fixture;
+
+use Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute;
+
+final class MultiplePlaces
+{
+    #[SimpleRoute()]
+    #[SimpleRoute('another')]
+    public function subscribe()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Fixture;
+
+use Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute;
+
+final class MultiplePlaces
+{
+    #[\Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\NextRoute()]
+    #[\Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\NextRoute('another')]
+    public function subscribe()
+    {
+    }
+}
+
+?>
diff --git a/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/RenameAttributeRectorTest.php b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/RenameAttributeRectorTest.php
new file mode 100644
index 00000000000..7ff30edac8a
--- /dev/null
+++ b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/RenameAttributeRectorTest.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class RenameAttributeRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/NextRoute.php b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/NextRoute.php
new file mode 100644
index 00000000000..c8840b57fe5
--- /dev/null
+++ b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/NextRoute.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source;
+
+#[\Attribute]
+class NextRoute
+{
+}
diff --git a/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/SimpleRoute.php b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/SimpleRoute.php
new file mode 100644
index 00000000000..ba0f7b863bf
--- /dev/null
+++ b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/SimpleRoute.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source;
+
+#[\Attribute]
+class SimpleRoute
+{
+}
diff --git a/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/config/configured_rule.php b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/config/configured_rule.php
new file mode 100644
index 00000000000..3d5865a5319
--- /dev/null
+++ b/rules-tests/Renaming/Rector/Class_/RenameAttributeRector/config/configured_rule.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Renaming\Rector\Class_\RenameAttributeRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig
+        ->ruleWithConfiguration(RenameAttributeRector::class, [
+            new \Rector\Renaming\ValueObject\RenameAttribute(
+                'Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute',
+                'Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\NextRoute'
+            ),
+        ]);
+};
diff --git a/rules/Renaming/Rector/Class_/RenameAttributeRector.php b/rules/Renaming/Rector/Class_/RenameAttributeRector.php
new file mode 100644
index 00000000000..6f4dc328b6e
--- /dev/null
+++ b/rules/Renaming/Rector/Class_/RenameAttributeRector.php
@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Renaming\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Property;
+use Rector\Contract\Rector\ConfigurableRectorInterface;
+use Rector\Rector\AbstractRector;
+use Rector\Renaming\ValueObject\RenameAttribute;
+use Rector\ValueObject\PhpVersionFeature;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
+
+/**
+ * @see \Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\RenameAttributeRectorTest
+ */
+final class RenameAttributeRector extends AbstractRector implements ConfigurableRectorInterface, MinPhpVersionInterface
+{
+    /**
+     * @var RenameAttribute[]
+     */
+    private array $renameAttributes = [];
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Rename attribute class names',
+            [
+                new ConfiguredCodeSample(
+                    <<<'CODE_SAMPLE'
+#[SimpleRoute()]
+class SomeClass
+{
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+#[BasicRoute()]
+class SomeClass
+{
+}
+CODE_SAMPLE
+                    ,
+                    []
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class, ClassMethod::class, Property::class];
+    }
+
+    /**
+     * @param Class_|ClassMethod|Property $node
+     */
+    public function refactor(Node $node): ?\PhpParser\Node
+    {
+        $hasChanged = false;
+
+        foreach ($node->attrGroups as $attrGroup) {
+            foreach ($attrGroup->attrs as $attr) {
+                foreach ($this->renameAttributes as $renameAttribute) {
+                    if ($this->isName($attr->name, $renameAttribute->getOldAttribute())) {
+                        $attr->name = new FullyQualified($renameAttribute->getNewAttribute());
+
+                        $hasChanged = true;
+                    }
+                }
+            }
+        }
+
+        if ($hasChanged) {
+            return $node;
+        }
+
+        return null;
+    }
+
+    /**
+     * @param mixed[] $configuration
+     */
+    public function configure(array $configuration): void
+    {
+        Assert::allIsAOf($configuration, RenameAttribute::class);
+
+        $this->renameAttributes = $configuration;
+    }
+
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersionFeature::ATTRIBUTES;
+    }
+}
diff --git a/rules/Renaming/ValueObject/RenameAttribute.php b/rules/Renaming/ValueObject/RenameAttribute.php
new file mode 100644
index 00000000000..285a84bc712
--- /dev/null
+++ b/rules/Renaming/ValueObject/RenameAttribute.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Renaming\ValueObject;
+
+/**
+ * @api
+ */
+final readonly class RenameAttribute
+{
+    public function __construct(
+        private string $oldAttribute,
+        private string $newAttribute
+    ) {
+    }
+
+    public function getOldAttribute(): string
+    {
+        return $this->oldAttribute;
+    }
+
+    public function getNewAttribute(): string
+    {
+        return $this->newAttribute;
+    }
+}