[TypeDeclaration] Remove existing type override in ReturnTypeDeclarat…

…ionRector (#3119) * remove prioarity aware sorter etc * remove unused ReturnTypeAlreadyAddedChecker * lower complexity, skip already added type * [ci-review] Rector Rectify Co-authored-by: GitHub Action <action@github.com>
rectorphp · Nov 28, 2022 · 696ddd9 · 696ddd9
1 parent 9ffa707
commit 696ddd9
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 497 deletions.
diff --git a/...nTypeDeclarationRector/Fixture/Correction/constructor_property_assign_over_getter.php.inc b/...nTypeDeclarationRector/Fixture/Correction/constructor_property_assign_over_getter.php.inc
diff --git a/...ion/Rector/FunctionLike/ReturnTypeDeclarationRector/Fixture/Correction/prefix_fqn.php.inc b/...ion/Rector/FunctionLike/ReturnTypeDeclarationRector/Fixture/Correction/prefix_fqn.php.inc
diff --git a/...ation/Rector/FunctionLike/ReturnTypeDeclarationRector/Fixture/closure_nested_type.php.inc b/...ation/Rector/FunctionLike/ReturnTypeDeclarationRector/Fixture/closure_nested_type.php.inc
diff --git a/rules/TypeDeclaration/PhpParserTypeAnalyzer.php b/rules/TypeDeclaration/PhpParserTypeAnalyzer.php
diff --git a/rules/TypeDeclaration/Rector/FunctionLike/ReturnTypeDeclarationRector.php b/rules/TypeDeclaration/Rector/FunctionLike/ReturnTypeDeclarationRector.php
@@ -16,16 +16,11 @@
 use PHPStan\Type\MixedType;
 use PHPStan\Type\Type;
 use PHPStan\Type\UnionType;
-use Rector\Core\Php\PhpVersionProvider;
 use Rector\Core\Rector\AbstractRector;
 use Rector\Core\ValueObject\PhpVersionFeature;
-use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\PHPStanStaticTypeMapper\Enum\TypeKind;
 use Rector\StaticTypeMapper\ValueObject\Type\NonExistingObjectType;
 use Rector\TypeDeclaration\PhpDocParser\NonInformativeReturnTagRemover;
-use Rector\TypeDeclaration\PhpParserTypeAnalyzer;
-use Rector\TypeDeclaration\TypeAlreadyAddedChecker\ReturnTypeAlreadyAddedChecker;
-use Rector\TypeDeclaration\TypeAnalyzer\ObjectTypeComparator;
 use Rector\TypeDeclaration\TypeInferer\ReturnTypeInferer;
 use Rector\VendorLocker\NodeVendorLocker\ClassMethodReturnTypeOverrideGuard;
 use Rector\VendorLocker\NodeVendorLocker\ClassMethodReturnVendorLockResolver;
@@ -45,12 +40,8 @@ final class ReturnTypeDeclarationRector extends AbstractRector implements MinPhp
 {
     public function __construct(
         private readonly ReturnTypeInferer $returnTypeInferer,
-        private readonly ReturnTypeAlreadyAddedChecker $returnTypeAlreadyAddedChecker,
         private readonly NonInformativeReturnTagRemover $nonInformativeReturnTagRemover,
         private readonly ClassMethodReturnTypeOverrideGuard $classMethodReturnTypeOverrideGuard,
-        private readonly PhpParserTypeAnalyzer $phpParserTypeAnalyzer,
-        private readonly ObjectTypeComparator $objectTypeComparator,
-        private readonly PhpVersionProvider $phpVersionProvider,
         private readonly ClassMethodReturnVendorLockResolver $classMethodReturnVendorLockResolver,
     ) {
     }
@@ -107,13 +98,14 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        $inferedReturnType = $this->returnTypeInferer->inferFunctionLike($node);
-
-        if ($inferedReturnType instanceof MixedType || $inferedReturnType instanceof NonExistingObjectType) {
+        // skip already added types
+        if ($node->returnType instanceof Node) {
             return null;
         }
 
-        if ($this->returnTypeAlreadyAddedChecker->isSameOrBetterReturnTypeAlreadyAdded($node, $inferedReturnType)) {
+        $inferedReturnType = $this->returnTypeInferer->inferFunctionLike($node);
+
+        if ($inferedReturnType instanceof MixedType || $inferedReturnType instanceof NonExistingObjectType) {
             return null;
         }
 
@@ -148,17 +140,9 @@ private function processType(ClassMethod | Function_ $node, Type $inferedType):
             return null;
         }
 
-        if ($this->shouldSkipInferredReturnNode($node)) {
-            return null;
-        }
-
-        // should be previous overridden?
-        if ($node->returnType !== null && $this->shouldSkipExistingReturnType($node, $inferedType)) {
-            return null;
-        }
-
         /** @var Name|NullableType|PhpParserUnionType|IntersectionType $inferredReturnNode */
-        $this->addReturnType($node, $inferredReturnNode);
+        $node->returnType = $inferredReturnNode;
+
         $this->nonInformativeReturnTagRemover->removeReturnTagIfNotUseful($node);
 
         return $node;
@@ -173,77 +157,6 @@ private function shouldSkipClassMethod(ClassMethod $classMethod): bool
         return $this->classMethodReturnVendorLockResolver->isVendorLocked($classMethod);
     }
 
-    private function shouldSkipInferredReturnNode(ClassMethod | Function_ $functionLike): bool
-    {
-        // already overridden by previous populateChild() method run
-        if ($functionLike->returnType === null) {
-            return false;
-        }
-
-        return (bool) $functionLike->returnType->getAttribute(AttributeKey::DO_NOT_CHANGE);
-    }
-
-    private function shouldSkipExistingReturnType(ClassMethod | Function_ $functionLike, Type $inferedType): bool
-    {
-        if ($functionLike->returnType === null) {
-            return false;
-        }
-
-        if ($functionLike instanceof ClassMethod && $this->classMethodReturnVendorLockResolver->isVendorLocked(
-            $functionLike
-        )) {
-            return true;
-        }
-
-        $currentType = $this->staticTypeMapper->mapPhpParserNodePHPStanType($functionLike->returnType);
-        if ($this->objectTypeComparator->isCurrentObjectTypeSubType($currentType, $inferedType)) {
-            return true;
-        }
-
-        return $this->isNullableTypeSubType($currentType, $inferedType);
-    }
-
-    private function addReturnType(
-        ClassMethod | Function_ $functionLike,
-        Name|NullableType|PhpParserUnionType|IntersectionType $inferredReturnNode
-    ): void {
-        if ($functionLike->returnType === null) {
-            $functionLike->returnType = $inferredReturnNode;
-            return;
-        }
-
-        $isSubtype = $this->phpParserTypeAnalyzer->isCovariantSubtypeOf($inferredReturnNode, $functionLike->returnType);
-        if ($this->phpVersionProvider->isAtLeastPhpVersion(PhpVersionFeature::COVARIANT_RETURN) && $isSubtype) {
-            $functionLike->returnType = $inferredReturnNode;
-            return;
-        }
-
-        if (! $isSubtype) {
-            // type override with correct one
-            $functionLike->returnType = $inferredReturnNode;
-        }
-    }
-
-    private function isNullableTypeSubType(Type $currentType, Type $inferedType): bool
-    {
-        if (! $currentType instanceof UnionType) {
-            return false;
-        }
-
-        if (! $inferedType instanceof UnionType) {
-            return false;
-        }
-
-        // probably more/less strict union type on purpose
-        if ($currentType->isSubTypeOf($inferedType)
-            ->yes()) {
-            return true;
-        }
-
-        return $inferedType->isSubTypeOf($currentType)
-            ->yes();
-    }
-
     private function shouldSkipClassLike(FunctionLike $functionLike): bool
     {
         if (! $functionLike instanceof ClassMethod) {