[Downgrade Php 7.2] Add opt-out parameter for unsafe types to avoid p…

…iling list of safe types (#1448)
rectorphp · Dec 10, 2021 · b3f13b5 · b3f13b5
1 parent dcabd2d
commit b3f13b5
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 42 deletions.
diff --git a/build/config/config-downgrade.php b/build/config/config-downgrade.php
@@ -14,6 +14,7 @@
 use Rector\DowngradePhp72\Rector\ClassMethod\DowngradeParameterTypeWideningRector;
 use Rector\NodeNameResolver\Contract\NodeNameResolverInterface;
 use Rector\Set\ValueObject\DowngradeLevelSetList;
+use Symfony\Component\Config\Loader\Loader;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\StyleInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -37,50 +38,12 @@
     $containerConfigurator->import(DowngradeLevelSetList::DOWN_TO_PHP_71);
 
     $services = $containerConfigurator->services();
+
     $services->set(DowngradeParameterTypeWideningRector::class)
         ->configure([
-            DowngradeParameterTypeWideningRector::SAFE_TYPES => [
-                // phsptan
-                Type::class,
-                RectorInterface::class,
-                // php-parser
-                NodeVisitorAbstract::class,
-                NodeVisitor::class,
-                ConfigurableRectorInterface::class,
-                OutputInterface::class,
-                StyleInterface::class,
-                PhpDocNodeVisitorInterface::class,
-                Node::class,
-                NodeNameResolverInterface::class,
-                // phpstan
-                SourceLocator::class,
-                \PHPStan\PhpDocParser\Ast\Node::class,
-                \PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode::class,
-                \PHPStan\PhpDocParser\Ast\NodeAttributes::class,
-                \PhpParser\Parser::class,
-                \Rector\Naming\Contract\RenameParamValueObjectInterface::class,
-                \Symplify\RuleDocGenerator\Contract\RuleCodeSamplePrinterInterface::class,
-                \Symplify\RuleDocGenerator\Contract\Category\CategoryInfererInterface::class,
-                \PhpParser\PrettyPrinterAbstract::class,
-                \Helmich\TypoScriptParser\Parser\Traverser\Visitor::class,
-                \Symplify\SymplifyKernel\Contract\LightKernelInterface::class,
-                \Symfony\Component\String\Slugger\SluggerInterface::class,
-                \Psr\Log\LoggerInterface::class,
-                // phsptan
-                \PHPStan\Type\DynamicStaticMethodReturnTypeExtension::class,
-                \PHPStan\Type\DynamicFunctionReturnTypeExtension::class,
-                \PHPStan\Type\DynamicFunctionThrowTypeExtension::class,
-                \PHPStan\Type\DynamicMethodReturnTypeExtension::class,
-                \PHPStan\Type\DynamicMethodThrowTypeExtension::class,
-                \PHPStan\Type\DynamicReturnTypeExtensionRegistry::class,
-                \PHPStan\Type\DynamicStaticMethodReturnTypeExtension::class,
-                \PHPStan\Type\DynamicStaticMethodThrowTypeExtension::class,
-            ],
-            DowngradeParameterTypeWideningRector::SAFE_TYPES_TO_METHODS => [
-                ContainerInterface::class => [
-                    'setParameter',
-                    'getParameter',
-                    'hasParameter',
+            DowngradeParameterTypeWideningRector::UNSAFE_TYPES_TO_METHODS => [
+                Loader::class => [
+                    'load'
                 ],
             ],
         ]);

diff --git a/phpstan.neon b/phpstan.neon
@@ -628,3 +628,12 @@ parameters:
 
         # complex detection
         - '#Cognitive complexity for "Rector\\Core\\DependencyInjection\\Collector\\ConfigureCallValuesCollector\:\:addConfigureCallValues\(\)" is \d+, keep it under 10#'
+
+        # will be removed soon
+        -
+             message: '#Class cognitive complexity is 31, keep it under 30#'
+             path: rules/DowngradePhp72/Rector/ClassMethod/DowngradeParameterTypeWideningRector.php
+
+        -
+             message: '#Cognitive complexity for "Rector\\DowngradePhp72\\Rector\\ClassMethod\\DowngradeParameterTypeWideningRector\:\:isSafeType\(\)" is 14, keep it under 10#'
+             path: rules/DowngradePhp72/Rector/ClassMethod/DowngradeParameterTypeWideningRector.php
diff --git a/rules/DowngradePhp72/Rector/ClassMethod/DowngradeParameterTypeWideningRector.php b/rules/DowngradePhp72/Rector/ClassMethod/DowngradeParameterTypeWideningRector.php
@@ -30,15 +30,22 @@
 final class DowngradeParameterTypeWideningRector extends AbstractRector implements ConfigurableRectorInterface
 {
     /**
+     * @deprecated Use self::UNSAFE_TYPES_TO_METHODS instead
      * @var string
      */
     final public const SAFE_TYPES = 'safe_types';
 
     /**
+     * @deprecated Use self::UNSAFE_TYPES_TO_METHODS instead
      * @var string
      */
     final public const SAFE_TYPES_TO_METHODS = 'safe_types_to_methods';
 
+    /**
+     * @var string
+     */
+    final public const UNSAFE_TYPES_TO_METHODS = 'unsafe_types_to_methods';
+
     /**
      * @var string[]
      */
@@ -49,6 +56,11 @@ final class DowngradeParameterTypeWideningRector extends AbstractRector implemen
      */
     private array $safeTypesToMethods = [];
 
+    /**
+     * @var array<string, string[]>
+     */
+    private array $unsafeTypesToMethods = [];
+
     public function __construct(
         private readonly NativeParamToPhpDocDecorator $nativeParamToPhpDocDecorator,
         private readonly ReflectionResolver $reflectionResolver,
@@ -97,6 +109,7 @@ public function test($input)
                 [
                     self::SAFE_TYPES => [],
                     self::SAFE_TYPES_TO_METHODS => [],
+                    self::UNSAFE_TYPES_TO_METHODS => [],
                 ]
             ),
         ]);
@@ -152,6 +165,15 @@ public function configure(array $configuration): void
         }
 
         $this->safeTypesToMethods = $safeTypesToMethods;
+
+        $unsafeTypesToMethods = $configuration[self::UNSAFE_TYPES_TO_METHODS] ?? [];
+        Assert::isArray($unsafeTypesToMethods);
+        foreach ($unsafeTypesToMethods as $key => $value) {
+            Assert::string($key);
+            Assert::allString($value);
+        }
+
+        $this->unsafeTypesToMethods = $unsafeTypesToMethods;
     }
 
     private function shouldSkip(ClassReflection $classReflection, ClassMethod $classMethod): bool
@@ -255,6 +277,21 @@ private function isSafeType(ClassReflection $classReflection, ClassMethod $class
             }
         }
 
+        foreach ($this->unsafeTypesToMethods as $unsafeType => $unsafeMethods) {
+            if (! $this->isNames($classMethod, $unsafeMethods)) {
+                continue;
+            }
+
+            if ($classReflection->isSubclassOf($unsafeType)) {
+                return false;
+            }
+
+            // skip self too
+            if ($classReflectionName === $unsafeType) {
+                return false;
+            }
+        }
+
         return false;
     }
 }