[DX] make all configure() methods accept direct value object configur…

…ation (#1322)
rectorphp · Nov 27, 2021 · 3844627 · 3844627
1 parent 373ac30
commit 3844627
Show file tree

Hide file tree

Showing 79 changed files with 214 additions and 113 deletions.
diff --git a/rules-tests/Transform/Rector/Class_/AddInterfaceByParentRector/config/configured_rule.php b/rules-tests/Transform/Rector/Class_/AddInterfaceByParentRector/config/configured_rule.php
@@ -10,9 +10,7 @@
 return static function (ContainerConfigurator $containerConfigurator): void {
     $services = $containerConfigurator->services();
     $services->set(AddInterfaceByParentRector::class)
-        ->call('configure', [[
-            AddInterfaceByParentRector::INTERFACE_BY_PARENT => [
-                SomeParent::class => SomeInterface::class,
-            ],
-        ]]);
+        ->configure([
+            SomeParent::class => SomeInterface::class,
+        ]);
 };
diff --git a/...eDeclaration/Rector/ClassMethod/AddReturnTypeDeclarationRector/config/configured_rule.php b/...eDeclaration/Rector/ClassMethod/AddReturnTypeDeclarationRector/config/configured_rule.php
@@ -7,14 +7,9 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnTypeDeclarationRector;
 use Rector\TypeDeclaration\ValueObject\AddReturnTypeDeclaration;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
-use Symplify\SymfonyPhpConfig\ValueObjectInliner;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
     $services = $containerConfigurator->services();
     $services->set(AddReturnTypeDeclarationRector::class)
-        ->call('configure', [[
-            AddReturnTypeDeclarationRector::METHOD_RETURN_TYPES => ValueObjectInliner::inline([
-                new AddReturnTypeDeclaration(PHPUnitTestCase::class, 'tearDown', new VoidType()),
-            ]),
-        ]]);
+        ->configure([new AddReturnTypeDeclaration(PHPUnitTestCase::class, 'tearDown', new VoidType())]);
 };
diff --git a/rules/Arguments/Rector/ClassMethod/ArgumentAdderRector.php b/rules/Arguments/Rector/ClassMethod/ArgumentAdderRector.php
@@ -134,7 +134,7 @@ public function refactor(Node $node): MethodCall | StaticCall | ClassMethod | nu
      */
     public function configure(array $configuration): void
     {
-        $addedArguments = $configuration[self::ADDED_ARGUMENTS] ?? [];
+        $addedArguments = $configuration[self::ADDED_ARGUMENTS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($addedArguments, ArgumentAdder::class);
         $this->addedArguments = $addedArguments;
     }

diff --git a/rules/Arguments/Rector/ClassMethod/ReplaceArgumentDefaultValueRector.php b/rules/Arguments/Rector/ClassMethod/ReplaceArgumentDefaultValueRector.php
@@ -104,7 +104,7 @@ public function refactor(Node $node): MethodCall | StaticCall | ClassMethod
      */
     public function configure(array $configuration): void
     {
-        $replacedArguments = $configuration[self::REPLACED_ARGUMENTS] ?? [];
+        $replacedArguments = $configuration[self::REPLACED_ARGUMENTS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($replacedArguments, ReplaceArgumentDefaultValue::class);
         $this->replacedArguments = $replacedArguments;
     }

diff --git a/rules/Arguments/Rector/FuncCall/FunctionArgumentDefaultValueReplacerRector.php b/rules/Arguments/Rector/FuncCall/FunctionArgumentDefaultValueReplacerRector.php
@@ -88,7 +88,7 @@ public function refactor(Node $node): FuncCall
      */
     public function configure(array $configuration): void
     {
-        $replacedArguments = $configuration[self::REPLACED_ARGUMENTS] ?? [];
+        $replacedArguments = $configuration[self::REPLACED_ARGUMENTS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($replacedArguments, ReplaceFuncCallArgumentDefaultValue::class);
         $this->replacedArguments = $replacedArguments;
     }

diff --git a/rules/Arguments/Rector/FuncCall/SwapFuncCallArgumentsRector.php b/rules/Arguments/Rector/FuncCall/SwapFuncCallArgumentsRector.php
@@ -110,7 +110,7 @@ public function refactor(Node $node): ?FuncCall
      */
     public function configure(array $configuration): void
     {
-        $functionArgumentSwaps = $configuration[self::FUNCTION_ARGUMENT_SWAPS] ?? [];
+        $functionArgumentSwaps = $configuration[self::FUNCTION_ARGUMENT_SWAPS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($functionArgumentSwaps, SwapFuncCallArguments::class);
         $this->functionArgumentSwaps = $functionArgumentSwaps;
     }

diff --git a/rules/Autodiscovery/Rector/Class_/MoveServicesBySuffixToDirectoryRector.php b/rules/Autodiscovery/Rector/Class_/MoveServicesBySuffixToDirectoryRector.php
@@ -95,7 +95,7 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $groupNamesBySuffix = $configuration[self::GROUP_NAMES_BY_SUFFIX] ?? [];
+        $groupNamesBySuffix = $configuration[self::GROUP_NAMES_BY_SUFFIX] ?? ($configuration ?: []);
         Assert::allString($groupNamesBySuffix);
 
         $this->groupNamesBySuffix = $groupNamesBySuffix;

diff --git a/rules/Autodiscovery/Rector/Class_/MoveValueObjectsToValueObjectDirectoryRector.php b/rules/Autodiscovery/Rector/Class_/MoveValueObjectsToValueObjectDirectoryRector.php
@@ -15,6 +15,7 @@
 use Rector\FileSystemRector\ValueObjectFactory\AddedFileWithNodesFactory;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
 
 /**
  * Inspiration @see https://github.com/rectorphp/rector/pull/1865/files#diff-0d18e660cdb626958662641b491623f8
@@ -50,7 +51,7 @@ final class MoveValueObjectsToValueObjectDirectoryRector extends AbstractRector
     private bool $enableValueObjectGuessing = true;
 
     /**
-     * @var class-string[]
+     * @var string[]
      */
     private array $types = [];
 
@@ -154,9 +155,19 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $this->types = $configuration[self::TYPES] ?? [];
-        $this->suffixes = $configuration[self::SUFFIXES] ?? [];
-        $this->enableValueObjectGuessing = $configuration[self::ENABLE_VALUE_OBJECT_GUESSING] ?? false;
+        $types = $configuration[self::TYPES] ?? [];
+        Assert::isArray($types);
+        Assert::allString($types);
+        $this->types = $types;
+
+        $suffixes = $configuration[self::SUFFIXES] ?? [];
+        Assert::isArray($suffixes);
+        Assert::allString($suffixes);
+        $this->suffixes = $suffixes;
+
+        $enableValueObjectGuessing = $configuration[self::ENABLE_VALUE_OBJECT_GUESSING] ?? false;
+        Assert::boolean($enableValueObjectGuessing);
+        $this->enableValueObjectGuessing = $enableValueObjectGuessing;
     }
 
     private function isValueObjectMatch(Class_ $class): bool

diff --git a/rules/CodingStyle/Rector/ClassMethod/OrderAttributesRector.php b/rules/CodingStyle/Rector/ClassMethod/OrderAttributesRector.php
@@ -112,7 +112,7 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $attributesOrder = $configuration[self::ATTRIBUTES_ORDER] ?? [];
+        $attributesOrder = $configuration[self::ATTRIBUTES_ORDER] ?? ($configuration ?: []);
         Assert::isArray($attributesOrder);
         Assert::allString($attributesOrder);
 

diff --git a/rules/CodingStyle/Rector/ClassMethod/ReturnArrayClassMethodToYieldRector.php b/rules/CodingStyle/Rector/ClassMethod/ReturnArrayClassMethodToYieldRector.php
@@ -128,7 +128,7 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $methodsToYields = $configuration[self::METHODS_TO_YIELDS] ?? [];
+        $methodsToYields = $configuration[self::METHODS_TO_YIELDS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($methodsToYields, ReturnArrayClassMethodToYield::class);
         $this->methodsToYields = $methodsToYields;
     }

diff --git a/rules/CodingStyle/Rector/MethodCall/PreferThisOrSelfMethodCallRector.php b/rules/CodingStyle/Rector/MethodCall/PreferThisOrSelfMethodCallRector.php
@@ -102,11 +102,11 @@ public function refactor(Node $node): ?Node
     }
 
     /**
-     * @param array<string, PreferenceSelfThis[]> $configuration
+     * @param mixed[] $configuration
      */
     public function configure(array $configuration): void
     {
-        $typeToPreference = $configuration[self::TYPE_TO_PREFERENCE] ?? [];
+        $typeToPreference = $configuration[self::TYPE_TO_PREFERENCE] ?? ($configuration ?: []);
         Assert::allIsAOf($typeToPreference, PreferenceSelfThis::class);
 
         $this->typeToPreference = $typeToPreference;

diff --git a/rules/Composer/Rector/AddPackageToRequireComposerRector.php b/rules/Composer/Rector/AddPackageToRequireComposerRector.php
@@ -67,7 +67,7 @@ public function getRuleDefinition(): RuleDefinition
      */
     public function configure(array $configuration): void
     {
-        $packagesAndVersions = $configuration[self::PACKAGES_AND_VERSIONS] ?? [];
+        $packagesAndVersions = $configuration[self::PACKAGES_AND_VERSIONS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($packagesAndVersions, PackageAndVersion::class);
 
         $this->versionGuard->validate($packagesAndVersions);

diff --git a/rules/Composer/Rector/AddPackageToRequireDevComposerRector.php b/rules/Composer/Rector/AddPackageToRequireDevComposerRector.php
@@ -70,7 +70,7 @@ public function getRuleDefinition(): RuleDefinition
      */
     public function configure(array $configuration): void
     {
-        $packagesAndVersions = $configuration[self::PACKAGES_AND_VERSIONS] ?? [];
+        $packagesAndVersions = $configuration[self::PACKAGES_AND_VERSIONS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($packagesAndVersions, PackageAndVersion::class);
 
         $this->versionGuard->validate($packagesAndVersions);

diff --git a/rules/Composer/Rector/ChangePackageVersionComposerRector.php b/rules/Composer/Rector/ChangePackageVersionComposerRector.php
@@ -73,7 +73,7 @@ public function getRuleDefinition(): RuleDefinition
      */
     public function configure(array $configuration): void
     {
-        $packagesAndVersions = $configuration[self::PACKAGES_AND_VERSIONS] ?? [];
+        $packagesAndVersions = $configuration[self::PACKAGES_AND_VERSIONS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($packagesAndVersions, PackageAndVersion::class);
 
         $this->versionGuard->validate($packagesAndVersions);

diff --git a/rules/Composer/Rector/RemovePackageComposerRector.php b/rules/Composer/Rector/RemovePackageComposerRector.php
@@ -8,6 +8,7 @@
 use Symplify\ComposerJsonManipulator\ValueObject\ComposerJson;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
 
 /**
  * @see \Rector\Tests\Composer\Rector\RemovePackageComposerRector\RemovePackageComposerRectorTest
@@ -55,10 +56,15 @@ public function getRuleDefinition(): RuleDefinition
     }
 
     /**
-     * @param array<string, string[]> $configuration
+     * @param mixed[] $configuration
      */
     public function configure(array $configuration): void
     {
-        $this->packageNames = $configuration[self::PACKAGE_NAMES] ?? [];
+        $packagesNames = $configuration[self::PACKAGE_NAMES] ?? ($configuration ?: []);
+
+        Assert::isArray($packagesNames);
+        Assert::allString($packagesNames);
+
+        $this->packageNames = $packagesNames;
     }
 }
diff --git a/rules/Composer/Rector/RenamePackageComposerRector.php b/rules/Composer/Rector/RenamePackageComposerRector.php
@@ -80,7 +80,7 @@ public function getRuleDefinition(): RuleDefinition
      */
     public function configure(array $configuration): void
     {
-        $renamePackages = $configuration[self::RENAME_PACKAGES] ?? [];
+        $renamePackages = $configuration[self::RENAME_PACKAGES] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($renamePackages, RenamePackage::class);
         $this->renamePackages = $renamePackages;
     }

diff --git a/rules/Composer/Rector/ReplacePackageAndVersionComposerRector.php b/rules/Composer/Rector/ReplacePackageAndVersionComposerRector.php
@@ -78,7 +78,7 @@ public function getRuleDefinition(): RuleDefinition
      */
     public function configure(array $configuration): void
     {
-        $replacePackagesAndVersions = $configuration[self::REPLACE_PACKAGES_AND_VERSIONS] ?? [];
+        $replacePackagesAndVersions = $configuration[self::REPLACE_PACKAGES_AND_VERSIONS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($replacePackagesAndVersions, ReplacePackageAndVersion::class);
 
         $this->versionGuard->validate($replacePackagesAndVersions);

diff --git a/rules/DeadCode/Rector/ClassLike/RemoveAnnotationRector.php b/rules/DeadCode/Rector/ClassLike/RemoveAnnotationRector.php
@@ -105,7 +105,7 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $annotationsToRemove = $configuration[self::ANNOTATIONS_TO_REMOVE] ?? [];
+        $annotationsToRemove = $configuration[self::ANNOTATIONS_TO_REMOVE] ?? ($configuration ?: []);
         Assert::allString($annotationsToRemove);
 
         $this->annotationsToRemove = $annotationsToRemove;

diff --git a/rules/DependencyInjection/Rector/ClassMethod/AddMethodParentCallRector.php b/rules/DependencyInjection/Rector/ClassMethod/AddMethodParentCallRector.php
@@ -16,6 +16,7 @@
 use Rector\Core\ValueObject\MethodName;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
 
 /**
  * @see \Rector\Tests\DependencyInjection\Rector\ClassMethod\AddMethodParentCallRector\AddMethodParentCallRectorTest
@@ -113,11 +114,16 @@ public function refactor(Node $node): ?Node
     }
 
     /**
-     * @param array<string, array<string, string>> $configuration
+     * @param mixed[] $configuration
      */
     public function configure(array $configuration): void
     {
-        $this->methodByParentTypes = $configuration[self::METHODS_BY_PARENT_TYPES] ?? [];
+        $methodsByParentTypes = $configuration[self::METHODS_BY_PARENT_TYPES] ?? ($configuration ?: []);
+        Assert::allString(array_keys($methodsByParentTypes));
+        Assert::allString($methodsByParentTypes);
+
+        /** @var array<string, string> $methodsByParentTypes */
+        $this->methodByParentTypes = $methodsByParentTypes;
     }
 
     private function shouldSkipMethod(ClassMethod $classMethod, string $method): bool

diff --git a/rules/DowngradePhp72/Rector/ClassMethod/DowngradeParameterTypeWideningRector.php b/rules/DowngradePhp72/Rector/ClassMethod/DowngradeParameterTypeWideningRector.php
@@ -143,12 +143,12 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $safeTypes = $configuration[self::SAFE_TYPES] ?? [];
+        $safeTypes = $configuration[self::SAFE_TYPES] ?? ($configuration ?: []);
         Assert::isArray($safeTypes);
         Assert::allString($safeTypes);
         $this->safeTypes = $safeTypes;
 
-        $safeTypesToMethods = $configuration[self::SAFE_TYPES_TO_METHODS] ?? [];
+        $safeTypesToMethods = $configuration[self::SAFE_TYPES_TO_METHODS] ?? ($configuration ?: []);
         Assert::isArray($safeTypesToMethods);
         foreach ($safeTypesToMethods as $key => $value) {
             Assert::string($key);

diff --git a/rules/DowngradePhp80/Rector/Class_/DowngradeAttributeToAnnotationRector.php b/rules/DowngradePhp80/Rector/Class_/DowngradeAttributeToAnnotationRector.php
@@ -132,7 +132,7 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $attributesToAnnotations = $configuration[self::ATTRIBUTE_TO_ANNOTATION] ?? [];
+        $attributesToAnnotations = $configuration[self::ATTRIBUTE_TO_ANNOTATION] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($attributesToAnnotations, DowngradeAttributeToAnnotation::class);
 
         $this->attributesToAnnotations = $attributesToAnnotations;

diff --git a/rules/Generics/Rector/ClassMethod/GenericClassMethodParamRector.php b/rules/Generics/Rector/ClassMethod/GenericClassMethodParamRector.php
@@ -123,11 +123,11 @@ final class SomeClass implements SomeInterface
     }
 
     /**
-     * @param array<string, GenericClassMethodParam[]> $configuration
+     * @param mixed[] $configuration
      */
     public function configure(array $configuration): void
     {
-        $makeClassMethodGenerics = $configuration[self::GENERIC_CLASS_METHOD_PARAMS] ?? [];
+        $makeClassMethodGenerics = $configuration[self::GENERIC_CLASS_METHOD_PARAMS] ?? ($configuration ?: []);
         Assert::allIsAOf($makeClassMethodGenerics, GenericClassMethodParam::class);
 
         $this->genericClassMethodParams = $makeClassMethodGenerics;

diff --git a/rules/Php55/Rector/String_/StringClassNameToClassConstantRector.php b/rules/Php55/Rector/String_/StringClassNameToClassConstantRector.php
@@ -121,7 +121,7 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $classesToSkip = $configuration[self::CLASSES_TO_SKIP] ?? [];
+        $classesToSkip = $configuration[self::CLASSES_TO_SKIP] ?? ($configuration ?: []);
         Assert::allString($classesToSkip);
 
         $this->classesToSkip = $classesToSkip;

diff --git a/rules/Php71/Rector/Name/ReservedObjectRector.php b/rules/Php71/Rector/Name/ReservedObjectRector.php
@@ -15,6 +15,7 @@
 use Rector\VersionBonding\Contract\MinPhpVersionInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
 
 /**
  * @changelog https://wiki.php.net/rfc/object-typehint https://github.com/cebe/yii2/commit/9548a212ecf6e50fcdb0e5ba6daad88019cfc544
@@ -88,11 +89,17 @@ public function refactor(Node $node): ?Node
     }
 
     /**
-     * @param array<string, array<string, string>> $configuration
+     * @param mixed[] $configuration
      */
     public function configure(array $configuration): void
     {
-        $this->reservedKeywordsToReplacements = $configuration[self::RESERVED_KEYWORDS_TO_REPLACEMENTS] ?? [];
+        $reservedKeywordsToReplacements = $configuration[self::RESERVED_KEYWORDS_TO_REPLACEMENTS] ?? ($configuration ?: []);
+
+        Assert::isArray($reservedKeywordsToReplacements);
+        Assert::allString(array_keys($reservedKeywordsToReplacements));
+        Assert::allString($reservedKeywordsToReplacements);
+
+        $this->reservedKeywordsToReplacements = $reservedKeywordsToReplacements;
     }
 
     private function processIdentifier(Identifier $identifier): Identifier

diff --git a/rules/Php74/Rector/Function_/ReservedFnFunctionRector.php b/rules/Php74/Rector/Function_/ReservedFnFunctionRector.php
@@ -15,6 +15,7 @@
 use Rector\VersionBonding\Contract\MinPhpVersionInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
 
 /**
  * @changelog https://github.com/php/php-src/pull/3941/files#diff-7e3a1a5df28a1cbd8c0fb6db68f243da
@@ -112,10 +113,16 @@ public function refactor(Node $node): ?Node
     }
 
     /**
-     * @param array<string, array<string, string>> $configuration
+     * @param mixed[] $configuration
      */
     public function configure(array $configuration): void
     {
-        $this->reservedNamesToNewOnes = $configuration[self::RESERVED_NAMES_TO_NEW_ONES] ?? [];
+        $reservedNamesToNewOnes = $configuration[self::RESERVED_NAMES_TO_NEW_ONES] ?? ($configuration ?: []);
+
+        Assert::allString(array_keys($reservedNamesToNewOnes));
+        Assert::allString($reservedNamesToNewOnes);
+
+        /** @var array<string, string> $reservedNamesToNewOnes */
+        $this->reservedNamesToNewOnes = $reservedNamesToNewOnes;
     }
 }
diff --git a/rules/Php80/Rector/Class_/AnnotationToAttributeRector.php b/rules/Php80/Rector/Class_/AnnotationToAttributeRector.php
@@ -144,7 +144,7 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $annotationsToAttributes = $configuration[self::ANNOTATION_TO_ATTRIBUTE] ?? [];
+        $annotationsToAttributes = $configuration[self::ANNOTATION_TO_ATTRIBUTE] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($annotationsToAttributes, AnnotationToAttribute::class);
         $this->annotationsToAttributes = $annotationsToAttributes;
     }

diff --git a/rules/Privatization/Rector/MethodCall/ReplaceStringWithClassConstantRector.php b/rules/Privatization/Rector/MethodCall/ReplaceStringWithClassConstantRector.php
@@ -119,7 +119,7 @@ public function refactor(Node $node): ?Node
      */
     public function configure(array $configuration): void
     {
-        $this->replaceStringWithClassConstants = $configuration[self::REPLACE_STRING_WITH_CLASS_CONSTANT] ?? [];
+        $this->replaceStringWithClassConstants = $configuration[self::REPLACE_STRING_WITH_CLASS_CONSTANT] ?? ($configuration ?: []);
     }
 
     private function matchArg(

diff --git a/rules/Removing/Rector/ClassMethod/ArgumentRemoverRector.php b/rules/Removing/Rector/ClassMethod/ArgumentRemoverRector.php
@@ -92,7 +92,7 @@ public function refactor(Node $node): MethodCall | StaticCall | ClassMethod
      */
     public function configure(array $configuration): void
     {
-        $removedArguments = $configuration[self::REMOVED_ARGUMENTS] ?? [];
+        $removedArguments = $configuration[self::REMOVED_ARGUMENTS] ?? ($configuration ?: []);
         Assert::allIsInstanceOf($removedArguments, ArgumentRemover::class);
         $this->removedArguments = $removedArguments;
     }