[8.2] make AddAllowDynamicPropertiesAttributeRector configurable (#1391)

rectorphp · Dec 10, 2021 · 6012e41 · 6012e41
1 parent fa31841
commit 6012e41
Show file tree

Hide file tree

Showing 15 changed files with 225 additions and 15 deletions.
diff --git a/...ture/add_allow_dynamic_properties.php.inc → ...cess/add_allow_dynamic_properties.php.inc b/...ture/add_allow_dynamic_properties.php.inc → ...cess/add_allow_dynamic_properties.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture;
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture\Process;
 
 class WantsAttribute
 {
@@ -11,7 +11,7 @@ class WantsAttribute
 -----
 <?php
 
-namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture;
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture\Process;
 
 #[\AllowDynamicProperties]
 class WantsAttribute

diff --git a/...pend_add_allow_dynamic_properties.php.inc → ...pend_add_allow_dynamic_properties.php.inc b/...pend_add_allow_dynamic_properties.php.inc → ...pend_add_allow_dynamic_properties.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture;
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture\Process;
 
 #[\Immutable]
 class AppendAttribute
@@ -12,7 +12,7 @@ class AppendAttribute
 -----
 <?php
 
-namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture;
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture\Process;
 
 #[\Immutable]
 #[\AllowDynamicProperties]

diff --git a/...adding_to_descendants_of_stdclass.php.inc → ...adding_to_descendants_of_stdclass.php.inc b/...adding_to_descendants_of_stdclass.php.inc → ...adding_to_descendants_of_stdclass.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture;
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture\Process;
 
 use stdClass;
 

diff --git a/...ing_to_descendants_with_magic_set.php.inc → ...ing_to_descendants_with_magic_set.php.inc b/...ing_to_descendants_with_magic_set.php.inc → ...ing_to_descendants_with_magic_set.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture;
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture\Process;
 
 class MagicSetObjects
 {

diff --git a/...llow_dynamic_properties_attribute.php.inc → ...llow_dynamic_properties_attribute.php.inc b/...llow_dynamic_properties_attribute.php.inc → ...llow_dynamic_properties_attribute.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture;
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture\Process;
 
 #[\AllowDynamicProperties]
 class AlreadyHasAttribute

diff --git a/...opertiesAttributeRector/Fixture/Skip/skips_adjusting_class_outside_transform_list.php.inc b/...opertiesAttributeRector/Fixture/Skip/skips_adjusting_class_outside_transform_list.php.inc
@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\Fixture\Skip;
+
+class DoesNothingOnExcludedClass
+{
+    public string $someProperty = 'hello world';
+}
+
+?>
diff --git a/...owDynamicPropertiesAttributeRector/FixtureAllClasses/add_allow_dynamic_properties.php.inc b/...owDynamicPropertiesAttributeRector/FixtureAllClasses/add_allow_dynamic_properties.php.inc
@@ -0,0 +1,22 @@
+<?php
+
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\FixtureAllClasses;
+
+class WantsAttribute
+{
+    public string $someProperty = 'hello world';
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\FixtureAllClasses;
+
+#[\AllowDynamicProperties]
+class WantsAttribute
+{
+    public string $someProperty = 'hello world';
+}
+
+?>
diff --git a/...icPropertiesAttributeRector/FixtureAllClasses/append_add_allow_dynamic_properties.php.inc b/...icPropertiesAttributeRector/FixtureAllClasses/append_add_allow_dynamic_properties.php.inc
@@ -0,0 +1,24 @@
+<?php
+
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\FixtureAllClasses;
+
+#[\Immutable]
+class AppendAttribute
+{
+    public string $someProperty = 'hello world';
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\FixtureAllClasses;
+
+#[\Immutable]
+#[\AllowDynamicProperties]
+class AppendAttribute
+{
+    public string $someProperty = 'hello world';
+}
+
+?>
diff --git a/...ropertiesAttributeRector/FixtureAllClasses/skip_adding_to_descendants_of_stdclass.php.inc b/...ropertiesAttributeRector/FixtureAllClasses/skip_adding_to_descendants_of_stdclass.php.inc
@@ -0,0 +1,22 @@
+<?php
+
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\FixtureAllClasses;
+
+use stdClass;
+
+class ChildOfStdClass extends stdClass
+{
+    public string $someProperty = 'hello world';
+}
+
+class DescendantOfStdClass extends ChildOfStdClass
+{
+    public string $someProperty = 'hello space';
+}
+
+class GrandChildOfStdClass extends ChildOfStdClass
+{
+    public string $someProperty = 'hello universe';
+}
+
+?>
diff --git a/...ertiesAttributeRector/FixtureAllClasses/skip_adding_to_descendants_with_magic_set.php.inc b/...ertiesAttributeRector/FixtureAllClasses/skip_adding_to_descendants_with_magic_set.php.inc
@@ -0,0 +1,28 @@
+<?php
+
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\FixtureAllClasses;
+
+class MagicSetObjects
+{
+    private array $props = [];
+
+    public function __set(string $name, $value) {
+        $this->props[$name] = $value;
+    }
+
+    public function __get(string $name) {
+        return $this->props[$name];
+    }
+}
+
+class AnotherMagicObject extends MagicSetObjects
+{
+    public string $data = 'hello world';
+}
+
+class YetAnotherMagic extends AnotherMagicObject
+{
+    public string $data = 'hello space';
+}
+
+?>
diff --git a/...ibuteRector/FixtureAllClasses/skip_already_has_allow_dynamic_properties_attribute.php.inc b/...ibuteRector/FixtureAllClasses/skip_already_has_allow_dynamic_properties_attribute.php.inc
@@ -0,0 +1,19 @@
+<?php
+
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\FixtureAllClasses;
+
+#[\AllowDynamicProperties]
+class AlreadyHasAttribute
+{
+    public string $someProperty = 'hello world';
+}
+
+class ChildOfAlreadyHasAttribute extends AlreadyHasAttribute {
+    public string $someProperty = 'hello space';
+}
+
+class GrandkidOfAlreadyHasAttribute extends ChildOfAlreadyHasAttribute {
+    public string $someProperty = 'hello universe';
+}
+
+?>
diff --git a/...micPropertiesAttributeRector/UnconfiguredAddAllowDynamicPropertiesAttributeRectorTest.php b/...micPropertiesAttributeRector/UnconfiguredAddAllowDynamicPropertiesAttributeRectorTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class UnconfiguredAddAllowDynamicPropertiesAttributeRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<SmartFileInfo>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/FixtureAllClasses');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/unconfigured_rule.php';
+    }
+}
diff --git a/...ansform/Rector/Class_/AddAllowDynamicPropertiesAttributeRector/config/configured_rule.php b/...ansform/Rector/Class_/AddAllowDynamicPropertiesAttributeRector/config/configured_rule.php
@@ -7,5 +7,10 @@
 
 return static function (ContainerConfigurator $containerConfigurator): void {
     $services = $containerConfigurator->services();
-    $services->set(AddAllowDynamicPropertiesAttributeRector::class);
+    $services->set(AddAllowDynamicPropertiesAttributeRector::class)
+        ->configure(
+            [
+                '*\Fixture\Process\*'
+            ]
+        );
 };
diff --git a/...sform/Rector/Class_/AddAllowDynamicPropertiesAttributeRector/config/unconfigured_rule.php b/...sform/Rector/Class_/AddAllowDynamicPropertiesAttributeRector/config/unconfigured_rule.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $services = $containerConfigurator->services();
+    $services->set(AddAllowDynamicPropertiesAttributeRector::class);
+};
diff --git a/rules/Transform/Rector/Class_/AddAllowDynamicPropertiesAttributeRector.php b/rules/Transform/Rector/Class_/AddAllowDynamicPropertiesAttributeRector.php
@@ -8,28 +8,37 @@
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Stmt\Class_;
 use PHPStan\Reflection\ReflectionProvider;
+use Rector\Core\Contract\Rector\AllowEmptyConfigurableRectorInterface;
 use Rector\Core\Rector\AbstractRector;
 use Rector\Core\ValueObject\MethodName;
 use Rector\Core\ValueObject\PhpVersionFeature;
 use Rector\FamilyTree\Reflection\FamilyRelationsAnalyzer;
 use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
 use Rector\PhpAttribute\Printer\PhpAttributeGroupFactory;
 use Rector\VersionBonding\Contract\MinPhpVersionInterface;
-use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
 
 /**
  * @changelog https://wiki.php.net/rfc/deprecate_dynamic_properties
  *
  * @see \Rector\Tests\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector\AddAllowDynamicPropertiesAttributeRectorTest
  */
-final class AddAllowDynamicPropertiesAttributeRector extends AbstractRector implements MinPhpVersionInterface
+final class AddAllowDynamicPropertiesAttributeRector extends AbstractRector implements AllowEmptyConfigurableRectorInterface, MinPhpVersionInterface
 {
     /**
      * @var string
      */
     private const ATTRIBUTE = 'AllowDynamicProperties';
 
+    public const TRANSFORM_ON_NAMESPACES = 'transform_on_namespaces';
+
+    /**
+     * @var array<array-key, string>
+     */
+    private array $transformOnNamespaces = [];
+
     public function __construct(
         private readonly FamilyRelationsAnalyzer $familyRelationsAnalyzer,
         private readonly PhpAttributeAnalyzer $phpAttributeAnalyzer,
@@ -41,20 +50,27 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition('Add the `AllowDynamicProperties` attribute to all classes', [
-            new CodeSample(
+            new ConfiguredCodeSample(
                 <<<'CODE_SAMPLE'
+namespace Example\Domain;
+
 class SomeObject {
     public string $someProperty = 'hello world';
 }
-CODE_SAMPLE
-
-                ,
+CODE_SAMPLE,
                 <<<'CODE_SAMPLE'
+namespace Example\Domain;
+
 #[AllowDynamicProperties]
 class SomeObject {
     public string $someProperty = 'hello world';
 }
-CODE_SAMPLE
+CODE_SAMPLE,
+                [
+                    AddAllowDynamicPropertiesAttributeRector::TRANSFORM_ON_NAMESPACES => [
+                        'Example\*',
+                    ]
+                ],
             ),
         ]);
     }
@@ -67,6 +83,17 @@ public function getNodeTypes(): array
         return [Class_::class];
     }
 
+
+    public function configure(array $configuration): void
+    {
+        $transformOnNamespaces = $configuration[self::TRANSFORM_ON_NAMESPACES] ?? $configuration;
+
+        Assert::isArray($transformOnNamespaces);
+        Assert::allString($transformOnNamespaces);
+
+        $this->transformOnNamespaces = $transformOnNamespaces;
+    }
+
     /**
      * @param Class_ $node
      */
@@ -118,6 +145,15 @@ private function addAllowDynamicPropertiesAttribute(Class_ $class): Class_
 
     private function shouldSkip(Class_ $class): bool
     {
+        if (count($this->transformOnNamespaces) !== 0) {
+            $className = (string) $this->nodeNameResolver->getName($class);
+            foreach ($this->transformOnNamespaces as $transformOnNamespace) {
+                if (! $this->nodeNameResolver->isStringName($className, $transformOnNamespace)) {
+                    return true;
+                }
+            }
+        }
+
         if ($this->isDescendantOfStdclass($class)) {
             return true;
         }