move string downgrade types to object classes (#4801)

* move string downgrade types to object classes * fix nullable type unwrap * remove uneeded open tags from samples * remove uneeded union type check
rectorphp · Dec 6, 2020 · bfd1953 · bfd1953
1 parent 3b22532
commit bfd1953
Show file tree

Hide file tree

Showing 32 changed files with 49 additions and 179 deletions.
diff --git a/packages/phpstan-static-type-mapper/src/Utils/TypeUnwrapper.php b/packages/phpstan-static-type-mapper/src/Utils/TypeUnwrapper.php
@@ -15,25 +15,29 @@ final class TypeUnwrapper
     /**
      * E.g. null|ClassType → ClassType
      */
-    public function unwrapNullableType(UnionType $unionType): ?Type
+    public function unwrapNullableType(Type $type): Type
     {
-        if (count($unionType->getTypes()) !== 2) {
-            return null;
+        if (! $type instanceof UnionType) {
+            return $type;
+        }
+
+        if (count($type->getTypes()) !== 2) {
+            return $type;
         }
 
-        if (! $unionType->isSuperTypeOf(new NullType())->yes()) {
-            return null;
+        if (! $type->isSuperTypeOf(new NullType())->yes()) {
+            return $type;
         }
 
-        foreach ($unionType->getTypes() as $unionedType) {
+        foreach ($type->getTypes() as $unionedType) {
             if ($unionedType instanceof NullType) {
                 continue;
             }
 
             return $unionedType;
         }
 
-        return null;
+        return $type;
     }
 
     public function unwrapFirstObjectTypeFromUnionType(Type $type): Type

diff --git a/...itecture/src/Rector/MethodCall/ReplaceParentRepositoryCallsByRepositoryPropertyRector.php b/...itecture/src/Rector/MethodCall/ReplaceParentRepositoryCallsByRepositoryPropertyRector.php
@@ -40,8 +40,6 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-<?php
-
 use Doctrine\ORM\EntityRepository;
 
 class SomeRepository extends EntityRepository
@@ -54,8 +52,6 @@ public function someMethod()
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-<?php
-
 use Doctrine\ORM\EntityRepository;
 
 class SomeRepository extends EntityRepository

diff --git a/rules/code-quality/src/Rector/BooleanNot/SimplifyDeMorganBinaryRector.php b/rules/code-quality/src/Rector/BooleanNot/SimplifyDeMorganBinaryRector.php
@@ -37,16 +37,12 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-<?php
-
 $a = 5;
 $b = 10;
 $result = !($a > 20 || $b <= 50);
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-<?php
-
 $a = 5;
 $b = 10;
 $result = $a <= 20 && $b > 50;

diff --git a/rules/code-quality/src/Rector/If_/SimplifyIfReturnBoolRector.php b/rules/code-quality/src/Rector/If_/SimplifyIfReturnBoolRector.php
@@ -21,7 +21,6 @@
 use Rector\Core\Rector\AbstractRector;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\NodeTypeResolver\PHPStan\Type\StaticTypeAnalyzer;
-use Rector\PHPStanStaticTypeMapper\Utils\TypeUnwrapper;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -35,22 +34,13 @@ final class SimplifyIfReturnBoolRector extends AbstractRector
      */
     private $staticTypeAnalyzer;
 
-    /**
-     * @var TypeUnwrapper
-     */
-    private $typeUnwrapper;
-
     /**
      * @var CommentsMerger
      */
     private $commentsMerger;
 
-    public function __construct(
-        CommentsMerger $commentsMerger,
-        StaticTypeAnalyzer $staticTypeAnalyzer,
-        TypeUnwrapper $typeUnwrapper
-    ) {
-        $this->typeUnwrapper = $typeUnwrapper;
+    public function __construct(CommentsMerger $commentsMerger, StaticTypeAnalyzer $staticTypeAnalyzer)
+    {
         $this->staticTypeAnalyzer = $staticTypeAnalyzer;
         $this->commentsMerger = $commentsMerger;
     }

diff --git a/rules/defluent/src/NodeAnalyzer/ExprStringTypeResolver.php b/rules/defluent/src/NodeAnalyzer/ExprStringTypeResolver.php
@@ -6,7 +6,6 @@
 
 use PhpParser\Node\Expr;
 use PHPStan\Type\TypeWithClassName;
-use PHPStan\Type\UnionType;
 use Rector\NodeTypeResolver\NodeTypeResolver;
 use Rector\PHPStan\Type\AliasedObjectType;
 use Rector\PHPStanStaticTypeMapper\Utils\TypeUnwrapper;
@@ -32,9 +31,7 @@ public function __construct(NodeTypeResolver $nodeTypeResolver, TypeUnwrapper $t
     public function resolve(Expr $expr): ?string
     {
         $exprStaticType = $this->nodeTypeResolver->getStaticType($expr);
-        if ($exprStaticType instanceof UnionType) {
-            $exprStaticType = $this->typeUnwrapper->unwrapNullableType($exprStaticType);
-        }
+        $exprStaticType = $this->typeUnwrapper->unwrapNullableType($exprStaticType);
 
         if (! $exprStaticType instanceof TypeWithClassName) {
             // nothing we can do, unless

diff --git a/rules/downgrade-php71/src/Rector/ClassConst/DowngradeClassConstantVisibilityRector.php b/rules/downgrade-php71/src/Rector/ClassConst/DowngradeClassConstantVisibilityRector.php
@@ -22,8 +22,6 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
    public const PUBLIC_CONST_B = 2;
@@ -33,8 +31,6 @@ class SomeClass
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
    const PUBLIC_CONST_B = 2;

diff --git a/rules/downgrade-php71/src/Rector/FunctionLike/AbstractDowngradeReturnDeclarationRector.php b/rules/downgrade-php71/src/Rector/FunctionLike/AbstractDowngradeReturnDeclarationRector.php
@@ -38,7 +38,6 @@ public function refactor(Node $node): ?Node
         }
 
         $this->decorateFunctionLikeWithReturnTagValueNode($node);
-
         $node->returnType = null;
 
         return $node;

diff --git a/...grade-php71/src/Rector/FunctionLike/DowngradeIterablePseudoTypeParamDeclarationRector.php b/...grade-php71/src/Rector/FunctionLike/DowngradeIterablePseudoTypeParamDeclarationRector.php
@@ -22,8 +22,6 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     public function run(iterable $iterator)
@@ -34,8 +32,6 @@ public function run(iterable $iterator)
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     /**

diff --git a/...rade-php71/src/Rector/FunctionLike/DowngradeIterablePseudoTypeReturnDeclarationRector.php b/...rade-php71/src/Rector/FunctionLike/DowngradeIterablePseudoTypeReturnDeclarationRector.php
@@ -22,8 +22,6 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     public function run(): iterable
@@ -34,8 +32,6 @@ public function run(): iterable
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     /**

diff --git a/...s/downgrade-php71/src/Rector/FunctionLike/DowngradeNullableTypeParamDeclarationRector.php b/...s/downgrade-php71/src/Rector/FunctionLike/DowngradeNullableTypeParamDeclarationRector.php
@@ -22,8 +22,6 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     public function run(?string $input)
@@ -34,8 +32,6 @@ public function run(?string $input)
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     /**

diff --git a/.../downgrade-php71/src/Rector/FunctionLike/DowngradeNullableTypeReturnDeclarationRector.php b/.../downgrade-php71/src/Rector/FunctionLike/DowngradeNullableTypeReturnDeclarationRector.php
@@ -23,8 +23,6 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     public function getResponseOrNothing(bool $flag): ?string
@@ -38,8 +36,6 @@ public function getResponseOrNothing(bool $flag): ?string
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     /**

diff --git a/rules/downgrade-php71/src/Rector/FunctionLike/DowngradeVoidTypeReturnDeclarationRector.php b/rules/downgrade-php71/src/Rector/FunctionLike/DowngradeVoidTypeReturnDeclarationRector.php
@@ -4,6 +4,7 @@
 
 namespace Rector\DowngradePhp71\Rector\FunctionLike;
 
+use PHPStan\Type\VoidType;
 use Rector\DowngradePhp72\Rector\FunctionLike\AbstractDowngradeReturnTypeDeclarationRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -20,28 +21,22 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     public function run(): void
     {
-        // do something
     }
 }
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     /**
      * @return void
      */
     public function run()
     {
-        // do something
     }
 }
 CODE_SAMPLE
@@ -50,8 +45,8 @@ public function run()
         );
     }
 
-    public function getTypeNameToRemove(): string
+    public function getTypeToRemove(): string
     {
-        return 'void';
+        return VoidType::class;
     }
 }
diff --git a/rules/downgrade-php72/src/Contract/Rector/DowngradeTypeRectorInterface.php b/rules/downgrade-php72/src/Contract/Rector/DowngradeTypeRectorInterface.php
@@ -9,5 +9,5 @@ interface DowngradeTypeRectorInterface
     /**
      * Name of the type to remove
      */
-    public function getTypeNameToRemove(): string;
+    public function getTypeToRemove(): string;
 }
diff --git a/...s/downgrade-php72/src/Rector/FunctionLike/AbstractDowngradeParamTypeDeclarationRector.php b/...s/downgrade-php72/src/Rector/FunctionLike/AbstractDowngradeParamTypeDeclarationRector.php
@@ -5,8 +5,6 @@
 namespace Rector\DowngradePhp72\Rector\FunctionLike;
 
 use PhpParser\Node\FunctionLike;
-use PhpParser\Node\Identifier;
-use PhpParser\Node\NullableType;
 use PhpParser\Node\Param;
 use Rector\DowngradePhp71\Rector\FunctionLike\AbstractDowngradeParamDeclarationRector;
 use Rector\DowngradePhp72\Contract\Rector\DowngradeTypeRectorInterface;
@@ -23,27 +21,14 @@ public function shouldRemoveParamDeclaration(Param $param, FunctionLike $functio
             return false;
         }
 
-        // It can either be the type, or the nullable type (eg: ?object)
-        $isNullableType = $param->type instanceof NullableType;
-        if (! $param->type instanceof Identifier && ! $isNullableType) {
-            return false;
-        }
-
-        // If it is the NullableType, extract the name from its inner type
-        if ($isNullableType) {
-            /** @var NullableType */
-            $nullableType = $param->type;
-            $typeName = $this->getName($nullableType->type);
-        } else {
-            $typeName = $this->getName($param->type);
-        }
+        $type = $this->staticTypeMapper->mapPhpParserNodePHPStanType($param->type);
+        $type = $this->typeUnwrapper->unwrapNullableType($type);
 
-        // Check it is the type to be removed
-        return $typeName === $this->getTypeNameToRemove();
+        return is_a($type, $this->getTypeToRemove(), true);
     }
 
     protected function getRectorDefinitionDescription(): string
     {
-        return sprintf("Remove the '%s' param type, add a @param tag instead", $this->getTypeNameToRemove());
+        return sprintf("Remove the '%s' param type, add a @param tag instead", $this->getTypeToRemove());
     }
 }
diff --git a/.../downgrade-php72/src/Rector/FunctionLike/AbstractDowngradeReturnTypeDeclarationRector.php b/.../downgrade-php72/src/Rector/FunctionLike/AbstractDowngradeReturnTypeDeclarationRector.php
@@ -5,7 +5,6 @@
 namespace Rector\DowngradePhp72\Rector\FunctionLike;
 
 use PhpParser\Node\FunctionLike;
-use PhpParser\Node\NullableType;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Function_;
 use Rector\DowngradePhp71\Rector\FunctionLike\AbstractDowngradeReturnDeclarationRector;
@@ -22,22 +21,14 @@ public function shouldRemoveReturnDeclaration(FunctionLike $functionLike): bool
             return false;
         }
 
-        // It can either be the type, or the nullable type (eg: ?object)
-        $isNullableType = $functionLike->returnType instanceof NullableType;
-        if ($isNullableType) {
-            /** @var NullableType */
-            $nullableType = $functionLike->returnType;
-            $typeName = $this->getName($nullableType->type);
-        } else {
-            $typeName = $this->getName($functionLike->returnType);
-        }
+        $type = $this->staticTypeMapper->mapPhpParserNodePHPStanType($functionLike->returnType);
+        $type = $this->typeUnwrapper->unwrapNullableType($type);
 
-        // Check it is the type to be removed
-        return $typeName === $this->getTypeNameToRemove();
+        return is_a($type, $this->getTypeToRemove(), true);
     }
 
     protected function getRectorDefinitionDescription(): string
     {
-        return sprintf("Remove the '%s' function type, add a @return tag instead", $this->getTypeNameToRemove());
+        return sprintf("Remove the '%s' function type, add a @return tag instead", $this->getTypeToRemove());
     }
 }
diff --git a/rules/downgrade-php72/src/Rector/FunctionLike/DowngradeParamObjectTypeDeclarationRector.php b/rules/downgrade-php72/src/Rector/FunctionLike/DowngradeParamObjectTypeDeclarationRector.php
@@ -4,6 +4,7 @@
 
 namespace Rector\DowngradePhp72\Rector\FunctionLike;
 
+use PHPStan\Type\ObjectWithoutClassType;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -19,8 +20,6 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     public function someFunction(object $someObject)
@@ -30,8 +29,6 @@ public function someFunction(object $someObject)
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-<?php
-
 class SomeClass
 {
     /**
@@ -47,8 +44,8 @@ public function someFunction($someObject)
         );
     }
 
-    public function getTypeNameToRemove(): string
+    public function getTypeToRemove(): string
     {
-        return 'object';
+        return ObjectWithoutClassType::class;
     }
 }