[FEAT] refacto OrderAttributesRector (#2243)

* [FEAT] refacto OrderAttributesRector to allow strategy instead of specific array * [DOC] update doc OrderAttributesRector * [FIX] add option default value * [REFACTO] create SpecificOrder folder * [TU] add tu AlphabeticallOrder * [FIX] use isAlphabetically instead of duplicate function logic * [FIX] fix phpstan errors * [FIX] fix NoNestedFuncCallRule ignore rule for OrderAttributesRector
rectorphp · May 9, 2022 · 4468743 · 4468743
1 parent 97a33aa
commit 4468743
Show file tree

Hide file tree

Showing 25 changed files with 366 additions and 63 deletions.
diff --git a/build/target-repository/docs/rector_rules_overview.md b/build/target-repository/docs/rector_rules_overview.md
@@ -2068,21 +2068,45 @@ Order attributes by desired names
 
 - class: [`Rector\CodingStyle\Rector\ClassMethod\OrderAttributesRector`](../rules/CodingStyle/Rector/ClassMethod/OrderAttributesRector.php)
 
+#### 1) Order by specific namespace
+
+```php
+use Rector\CodingStyle\Rector\ClassMethod\OrderAttributesRector;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->ruleWithConfiguration(OrderAttributesRector::class, [Annotation\First::class, Annotation\Second::class]);
+};
+```
+
+↓
+
+```diff
++#[Annotation\First]
+ #[Annotation\Second]
+-#[Annotation\First]
+ class Someclass
+ {
+ }
+```
+
+#### 2) Order alphabetically
+
 ```php
 use Rector\CodingStyle\Rector\ClassMethod\OrderAttributesRector;
 use Rector\Config\RectorConfig;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->ruleWithConfiguration(OrderAttributesRector::class, ['First', 'Second']);
+    $rectorConfig->ruleWithConfiguration(OrderAttributesRector::class, [Rector\CodingStyle\Rector\ClassMethod::ALPHABETICALLY]);
 };
 ```
 
 ↓
 
 ```diff
-+#[First]
- #[Second]
--#[First]
++#[Annotation\AAttribute]
+ #[Annotation\BAttribute]
+-#[Annotation\AAttribute]
  class Someclass
  {
  }

diff --git a/phpstan.neon b/phpstan.neon
@@ -385,6 +385,10 @@ parameters:
             message: '#Use separate function calls with readable variable names#'
             path: src/DependencyInjection/Loader/Configurator/RectorServiceConfigurator.php
 
+        -
+            message: '#Use separate function calls with readable variable names#'
+            path: rules/CodingStyle/Rector/ClassMethod/OrderAttributesRector.php
+
         # on purpose to make use of worker paralle pattern
         -
             message: '#Instead of abstract class, use specific service with composition#'

diff --git a/...tributesRector/AlphabeticallOrder/Fixture/first_from_multiple_attr_in_attr_groups.php.inc b/...tributesRector/AlphabeticallOrder/Fixture/first_from_multiple_attr_in_attr_groups.php.inc
@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Fixture;
+
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\AAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\BAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\CAttribute;
+
+#[CAttribute]
+#[AAttribute, BAttribute]
+final class FirstFromMultipleAttrInAttrGroups
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Fixture;
+
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\AAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\BAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\CAttribute;
+
+#[AAttribute, BAttribute]
+#[CAttribute]
+final class FirstFromMultipleAttrInAttrGroups
+{
+}
+
+?>
diff --git a/...le/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Fixture/one_around.php.inc b/...le/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Fixture/one_around.php.inc
@@ -0,0 +1,33 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Fixture;
+
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\AAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\BAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\CAttribute;
+
+#[CAttribute]
+#[AAttribute]
+#[BAttribute]
+class OneAround
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Fixture;
+
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\AAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\BAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\CAttribute;
+
+#[AAttribute]
+#[BAttribute]
+#[CAttribute]
+class OneAround
+{
+}
+
+?>
diff --git a/.../ClassMethod/OrderAttributesRector/AlphabeticallOrder/Fixture/skip_expected_order.php.inc b/.../ClassMethod/OrderAttributesRector/AlphabeticallOrder/Fixture/skip_expected_order.php.inc
@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Fixture;
+
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\AAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\BAttribute;
+
+#[AAttribute]
+#[BAttribute]
+class SkipExpectedOrder
+{
+}
diff --git a/...butesRector/AlphabeticallOrder/Fixture/skip_expected_order_with_annotation_around.php.inc b/...butesRector/AlphabeticallOrder/Fixture/skip_expected_order_with_annotation_around.php.inc
@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Fixture;
+
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\AAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\BAttribute;
+
+/**
+ * @some
+ */
+#[AAttribute]
+#[BAttribute]
+class SkipExpectedOrderWithAround
+{
+}
diff --git a/.../OrderAttributesRector/AlphabeticallOrder/Fixture/skip_expected_order_with_around.php.inc b/.../OrderAttributesRector/AlphabeticallOrder/Fixture/skip_expected_order_with_around.php.inc
@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Fixture;
+
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\AAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\BAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\CAttribute;
+
+#[AAttribute]
+#[BAttribute]
+#[CAttribute]
+class SkipExpectedOrderWithAround
+{
+}
diff --git a/...le/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Fixture/some_class.php.inc b/...le/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Fixture/some_class.php.inc
@@ -0,0 +1,29 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Fixture;
+
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\AAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\BAttribute;
+
+#[BAttribute]
+#[AAttribute]
+class Someclass
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Fixture;
+
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\AAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source\BAttribute;
+
+#[AAttribute]
+#[BAttribute]
+class Someclass
+{
+}
+
+?>
diff --git a/...Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/OrderAttributesRectorTest.php b/...Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/OrderAttributesRectorTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class OrderAttributesRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<SmartFileInfo>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/...ngStyle/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Source/AAttribute.php b/...ngStyle/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Source/AAttribute.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source;
+
+use Attribute;
+
+#[Attribute]
+final class AAttribute
+{
+}
diff --git a/...ngStyle/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Source/BAttribute.php b/...ngStyle/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Source/BAttribute.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source;
+
+use Attribute;
+
+#[Attribute]
+final class BAttribute
+{
+}
diff --git a/...ngStyle/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Source/CAttribute.php b/...ngStyle/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/Source/CAttribute.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\AlphabeticallOrder\Source;
+
+use Attribute;
+
+#[Attribute]
+final class CAttribute
+{
+}
diff --git a/...le/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/config/configured_rule.php b/...le/Rector/ClassMethod/OrderAttributesRector/AlphabeticallOrder/config/configured_rule.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodingStyle\Rector\ClassMethod\OrderAttributesRector;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig
+        ->ruleWithConfiguration(OrderAttributesRector::class, [OrderAttributesRector::ALPHABETICALLY]);
+};
diff --git a/...from_multiple_attr_in_attr_groups.php.inc → ...from_multiple_attr_in_attr_groups.php.inc b/...from_multiple_attr_in_attr_groups.php.inc → ...from_multiple_attr_in_attr_groups.php.inc
@@ -1,10 +1,10 @@
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Fixture;
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Fixture;
 
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\FirstAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\SecondAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\ThirdAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\FirstAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\SecondAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\ThirdAttribute;
 
 #[ThirdAttribute]
 #[FirstAttribute, SecondAttribute]
@@ -16,11 +16,11 @@ final class FirstFromMultipleAttrInAttrGroups
 -----
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Fixture;
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Fixture;
 
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\FirstAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\SecondAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\ThirdAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\FirstAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\SecondAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\ThirdAttribute;
 
 #[FirstAttribute, SecondAttribute]
 #[ThirdAttribute]

diff --git a/...tributesRector/Fixture/one_around.php.inc → .../SpecificOrder/Fixture/one_around.php.inc b/...tributesRector/Fixture/one_around.php.inc → .../SpecificOrder/Fixture/one_around.php.inc
@@ -1,10 +1,10 @@
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Fixture;
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Fixture;
 
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\FirstAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\SecondAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\ThirdAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\FirstAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\SecondAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\ThirdAttribute;
 
 #[ThirdAttribute]
 #[FirstAttribute]
@@ -17,11 +17,11 @@ class OneAround
 -----
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Fixture;
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Fixture;
 
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\FirstAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\SecondAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\ThirdAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\FirstAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\SecondAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\ThirdAttribute;
 
 #[FirstAttribute]
 #[SecondAttribute]

diff --git a/...ector/Fixture/skip_expected_order.php.inc → ...Order/Fixture/skip_expected_order.php.inc b/...ector/Fixture/skip_expected_order.php.inc → ...Order/Fixture/skip_expected_order.php.inc
@@ -1,9 +1,9 @@
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Fixture;
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Fixture;
 
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\FirstAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\SecondAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\FirstAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\SecondAttribute;
 
 #[FirstAttribute]
 #[SecondAttribute]

diff --git a/...cted_order_with_annotation_around.php.inc → ...cted_order_with_annotation_around.php.inc b/...cted_order_with_annotation_around.php.inc → ...cted_order_with_annotation_around.php.inc
@@ -1,10 +1,9 @@
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Fixture;
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Fixture;
 
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\FirstAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\SecondAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\ThirdAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\FirstAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\SecondAttribute;
 
 /**
  * @some

diff --git a/...e/skip_expected_order_with_around.php.inc → ...e/skip_expected_order_with_around.php.inc b/...e/skip_expected_order_with_around.php.inc → ...e/skip_expected_order_with_around.php.inc
@@ -1,10 +1,10 @@
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Fixture;
+namespace Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Fixture;
 
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\FirstAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\SecondAttribute;
-use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\Source\ThirdAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\FirstAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\SecondAttribute;
+use Rector\Tests\CodingStyle\Rector\ClassMethod\OrderAttributesRector\SpecificOrder\Source\ThirdAttribute;
 
 #[FirstAttribute]
 #[SecondAttribute]