Add Immutable attribute and the possibility to exclude some annotations

php-static-analysis · Feb 28, 2024 · 19cdb95 · 19cdb95
1 parent c35515d
commit 19cdb95
Show file tree

Hide file tree

Showing 8 changed files with 188 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -108,11 +108,29 @@ return RectorConfig::configure()
     );
 ```
 
+If you want to replace most annotations but exclude a few, you can use the `excludeAnnotations` config parameter like this:
+
+```php
+use Rector\Config\RectorConfig;
+use PhpStaticAnalysis\RectorRule\AnnotationsToAttributesRector;
+
+return RectorConfig::configure()
+    ->withConfiguredRule(
+        AnnotationsToAttributesRector::class,
+        [
+            'excludeAnnotations' => ['throws', 'deprecated'],
+        ]
+    );
+```
+
+That would convert all annotations except `@throws` and `@deprecated`
+
 These are the available attributes and their corresponding PHPDoc annotations:
 
 | Attribute                                                                                                         | PHPDoc Annotations |
 |-------------------------------------------------------------------------------------------------------------------|--------------------|
 | [Deprecated](https://github.com/php-static-analysis/attributes/blob/main/doc/Deprecated.md)                       | `@deprecated`                        |
+| [Immmutable](https://github.com/php-static-analysis/attributes/blob/main/doc/Immmutable.md)                       | `@immmutable`                        |
 | [Impure](https://github.com/php-static-analysis/attributes/blob/main/doc/Impure.md)                               | `@impure`                            |
 | [Internal](https://github.com/php-static-analysis/attributes/blob/main/doc/Internal.md)                           | `@internal`                          |
 | [IsReadOnly](https://github.com/php-static-analysis/attributes/blob/main/doc/IsReadOnly.md)                       | `@readonly`                          |

diff --git a/composer.json b/composer.json
@@ -28,7 +28,7 @@
     "require": {
         "php": ">=8.0",
         "cweagans/composer-patches": "^1.7",
-        "php-static-analysis/attributes": "^0.1.16 || dev-main",
+        "php-static-analysis/attributes": "^0.1.17 || dev-main",
         "rector/rector": "^0.19 || ^1.0"
     },
     "require-dev": {

diff --git a/config/sets/php-static-analysis-annotations-to-attributes.php b/config/sets/php-static-analysis-annotations-to-attributes.php
@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use PhpStaticAnalysis\Attributes\Deprecated;
+use PhpStaticAnalysis\Attributes\Immutable;
 use PhpStaticAnalysis\Attributes\Impure;
 use PhpStaticAnalysis\Attributes\Internal;
 use PhpStaticAnalysis\Attributes\Method;
@@ -36,6 +37,7 @@
         [
             new AnnotationToAttribute('deprecated', Deprecated::class),
             new AnnotationToAttribute('extends', TemplateExtends::class),
+            new AnnotationToAttribute('immutable', Immutable::class),
             new AnnotationToAttribute('impure', Impure::class),
             new AnnotationToAttribute('implements', TemplateImplements::class),
             new AnnotationToAttribute('internal', Internal::class),
@@ -65,6 +67,7 @@
             'addParamAttributeOnParameters' => false,
             'useTypeAttributeForReturnAnnotation' => false,
             'usePropertyAttributeForVarAnnotation' => false,
+            'excludeAnnotations' => [],
         ]
     );
 };
diff --git a/src/AnnotationsToAttributesRector.php b/src/AnnotationsToAttributesRector.php
@@ -124,19 +124,22 @@ public function addArrays(array $array1, array $array2): array
     /**
      * @psalm-suppress MoreSpecificImplementedParamType
      */
-    #[Param(configuration: '(AnnotationToAttribute|bool)[]')]
+    #[Param(configuration: '(AnnotationToAttribute|bool|string[])[]')]
     public function configure(array $configuration): void
     {
+        $excludedAnnotations = [];
         foreach ($configuration as $key => $value) {
             if ($value instanceof AnnotationToAttribute) {
                 $tag = str_replace('_', '-', $value->getTag());
                 $this->annotationsToAttributes[$tag] = $value;
-            } elseif ($key == 'addParamAttributeOnParameters') {
+            } elseif (is_bool($value) && $key == 'addParamAttributeOnParameters') {
                 $this->addParamAttributeOnParameters = $value;
-            } elseif ($key == 'useTypeAttributeForReturnAnnotation') {
+            } elseif (is_bool($value) && $key == 'useTypeAttributeForReturnAnnotation') {
                 $this->useTypeAttributeForReturnAnnotation = $value;
-            } elseif ($key == 'usePropertyAttributeForVarAnnotation') {
+            } elseif (is_bool($value) && $key == 'usePropertyAttributeForVarAnnotation') {
                 $this->usePropertyAttributeForVarAnnotation = $value;
+            } elseif (is_array($value) && $key == 'excludeAnnotations') {
+                $excludedAnnotations = $value;
             }
         }
         if ($this->useTypeAttributeForReturnAnnotation) {
@@ -151,6 +154,11 @@ public function configure(array $configuration): void
                     new AnnotationToAttribute('var', Property::class);
             }
         }
+        foreach ($excludedAnnotations as $excludedAnnotation) {
+            if (isset($this->annotationsToAttributes[$excludedAnnotation])) {
+                unset($this->annotationsToAttributes[$excludedAnnotation]);
+            }
+        }
     }
 
     #[Returns('array<class-string<Node>>')]

diff --git a/tests/ExcludeAnnotationsTest.php b/tests/ExcludeAnnotationsTest.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace test\PhpStaticAnalysis\RectorRule;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ExcludeAnnotationsTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        yield [__DIR__ . '/SpecialFixture/ExcludeAnnotationsTest.php.inc'];
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured-rule-with-exclude-annotations.php';
+    }
+}
diff --git a/tests/Fixture/ImmutableAttributeTest.php.inc b/tests/Fixture/ImmutableAttributeTest.php.inc
@@ -0,0 +1,55 @@
+<?php
+
+namespace test\PhpStaticAnalysis\RectorRule\Fixture;
+
+use PhpStaticAnalysis\Attributes\Param;
+
+/**
+ * @codeCoverageIgnore
+ * @immutable all properties are read only
+ */
+class ImmutableAttributeTest
+{
+}
+
+/**
+ * @psalm-immutable
+ */
+class ImmutableAttributePsalmTest
+{
+}
+
+/**
+ * @phpstan-immutable
+ */
+class ImmutableAttributePHPStanTest
+{
+}
+
+?>
+-----
+<?php
+
+namespace test\PhpStaticAnalysis\RectorRule\Fixture;
+
+use PhpStaticAnalysis\Attributes\Param;
+
+/**
+ * @codeCoverageIgnore
+ */
+#[\PhpStaticAnalysis\Attributes\Immutable] // all properties are read only
+class ImmutableAttributeTest
+{
+}
+
+#[\PhpStaticAnalysis\Attributes\Immutable]
+class ImmutableAttributePsalmTest
+{
+}
+
+#[\PhpStaticAnalysis\Attributes\Immutable]
+class ImmutableAttributePHPStanTest
+{
+}
+
+?>
diff --git a/tests/SpecialFixture/ExcludeAnnotationsTest.php.inc b/tests/SpecialFixture/ExcludeAnnotationsTest.php.inc
@@ -0,0 +1,51 @@
+<?php
+
+namespace test\PhpStaticAnalysis\RectorRule\Fixture;
+
+use Exception;
+
+/**
+ * @deprecated
+ * @template T
+ */
+class ExcludeAnnotationsTest
+{
+    /**
+     * @var string
+     */
+    public $name;
+
+    /**
+     * @throws Exception
+     */
+    public function throwsException()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace test\PhpStaticAnalysis\RectorRule\Fixture;
+
+use Exception;
+
+/**
+ * @deprecated
+ */
+#[\PhpStaticAnalysis\Attributes\Template('T')]
+class ExcludeAnnotationsTest
+{
+    #[\PhpStaticAnalysis\Attributes\Type('string')]
+    public $name;
+
+    /**
+     * @throws Exception
+     */
+    public function throwsException()
+    {
+    }
+}
+
+?>
diff --git a/tests/config/configured-rule-with-exclude-annotations.php b/tests/config/configured-rule-with-exclude-annotations.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpStaticAnalysis\RectorRule\AnnotationsToAttributesRector;
+use PhpStaticAnalysis\RectorRule\Set\PhpStaticAnalysisSetList;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->sets([
+        PhpStaticAnalysisSetList::ANNOTATIONS_TO_ATTRIBUTES
+    ]);
+    $rectorConfig->ruleWithConfiguration(
+        AnnotationsToAttributesRector::class,
+        [
+            'excludeAnnotations' => ['throws', 'deprecated'],
+        ]
+    );
+};