Narrow object return type

Author: Orest-Divintari

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/Fixture/narrow_from_abstract_class.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+abstract class AbstractTalk
+{
+}
+
+final class ConcreteConferenceTalk extends AbstractTalk
+{
+}
+
+final class TalkFactory
+{
+    public function create(): AbstractTalk
+    {
+        return new ConcreteConferenceTalk();
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+abstract class AbstractTalk
+{
+}
+
+final class ConcreteConferenceTalk extends AbstractTalk
+{
+}
+
+final class TalkFactory
+{
+    public function create(): \Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture\ConcreteConferenceTalk
+    {
+        return new ConcreteConferenceTalk();
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/Fixture/narrow_from_interface.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+interface TalkInterface
+{
+}
+
+final class ConferenceTalkImplementation implements TalkInterface
+{
+}
+
+final class TalkFactory
+{
+    public function create(): TalkInterface
+    {
+        return new ConferenceTalkImplementation();
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+interface TalkInterface
+{
+}
+
+final class ConferenceTalkImplementation implements TalkInterface
+{
+}
+
+final class TalkFactory
+{
+    public function create(): \Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture\ConferenceTalkImplementation
+    {
+        return new ConferenceTalkImplementation();
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/Fixture/narrow_interface_inheritance.php.inc

@@ -0,0 +1,63 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+interface ProductInterface
+{
+}
+
+final class ConcreteProduct implements ProductInterface
+{
+}
+
+abstract class AbstractProductFactory
+{
+    abstract public function build(): ProductInterface;
+}
+
+final class ConcreteProductFactory extends AbstractProductFactory
+{
+    public function build(): ProductInterface
+    {
+        return $this->createProduct();
+    }
+
+    private function createProduct(): ConcreteProduct
+    {
+        return new ConcreteProduct();
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+interface ProductInterface
+{
+}
+
+final class ConcreteProduct implements ProductInterface
+{
+}
+
+abstract class AbstractProductFactory
+{
+    abstract public function build(): ProductInterface;
+}
+
+final class ConcreteProductFactory extends AbstractProductFactory
+{
+    public function build(): \Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture\ConcreteProduct
+    {
+        return $this->createProduct();
+    }
+
+    private function createProduct(): ConcreteProduct
+    {
+        return new ConcreteProduct();
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/Fixture/narrow_interface_via_method_call.php.inc

@@ -0,0 +1,53 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+interface PaymentInterface
+{
+}
+
+final class StripePayment implements PaymentInterface
+{
+}
+
+final class PaymentFactory
+{
+    public function create(): PaymentInterface
+    {
+        return $this->createStripePayment();
+    }
+
+    private function createStripePayment(): StripePayment
+    {
+        return new StripePayment();
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+interface PaymentInterface
+{
+}
+
+final class StripePayment implements PaymentInterface
+{
+}
+
+final class PaymentFactory
+{
+    public function create(): \Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture\StripePayment
+    {
+        return $this->createStripePayment();
+    }
+
+    private function createStripePayment(): StripePayment
+    {
+        return new StripePayment();
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/Fixture/narrow_parent_has_specific_return_type.php.inc

@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Source\AbstractTalkFactory;
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Source\Talk;
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Source\ConferenceTalkExtended;
+
+final class ConcreteTalkFactory extends AbstractTalkFactory
+{
+    public function build(): Talk
+    {
+        return new ConferenceTalkExtended();
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Source\AbstractTalkFactory;
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Source\Talk;
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Source\ConferenceTalkExtended;
+
+final class ConcreteTalkFactory extends AbstractTalkFactory
+{
+    public function build(): \Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Source\ConferenceTalkExtended
+    {
+        return new ConferenceTalkExtended();
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/Fixture/skip_parent_has_specific_return_type.php.inc

@@ -10,15 +10,14 @@
 use PhpParser\Node\Stmt\ClassMethod;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Type\ObjectType;
-use Rector\PhpParser\AstResolver;
 use Rector\PhpParser\Node\BetterNodeFinder;
 use Rector\Rector\AbstractRector;
 use Rector\Reflection\ReflectionResolver;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
- * Narrows return type from generic object to specific class in final classes/methods.
+ * Narrows return type from generic object or parent class to specific class in final classes/methods.
  *
  * @see \Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\NarrowObjectReturnTypeRectorTest
  */
@@ -27,14 +26,13 @@ final class NarrowObjectReturnTypeRector extends AbstractRector
     public function __construct(
         private readonly BetterNodeFinder $betterNodeFinder,
         private readonly ReflectionResolver $reflectionResolver,
-        private readonly AstResolver $astResolver,
     ) {
     }
 
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Narrows return type from generic object to specific class in final classes/methods',
+            'Narrows return type from generic object or parent class to specific class in final classes/methods',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
@@ -114,10 +112,6 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        if ($this->hasParentMethodWithNonObjectReturn($node)) {
-            return null;
-        }
-
         $actualReturnClass = $this->getActualReturnClass($node);
 
         if ($actualReturnClass === null) {
@@ -188,52 +182,6 @@ private function isNarrowingValid(string $declaredType, string $actualType): boo
             ->yes();
     }
 
-    private function hasParentMethodWithNonObjectReturn(ClassMethod $classMethod): bool
-    {
-        $classReflection = $this->reflectionResolver->resolveClassReflection($classMethod);
-
-        if (! $classReflection instanceof ClassReflection) {
-            return false;
-        }
-
-        $ancestors = array_filter(
-            $classReflection->getAncestors(),
-            fn (ClassReflection $ancestorClassReflection): bool => $classReflection->getName() !== $ancestorClassReflection->getName()
-        );
-
-        $methodName = $this->getName($classMethod);
-
-        foreach ($ancestors as $ancestor) {
-            if ($ancestor->getFileName() === null) {
-                continue;
-            }
-
-            if (! $ancestor->hasNativeMethod($methodName)) {
-                continue;
-            }
-
-            $parentClassMethod = $this->astResolver->resolveClassMethod($ancestor->getName(), $methodName);
-
-            if ($parentClassMethod === null) {
-                continue;
-            }
-
-            $parentReturnType = $parentClassMethod->returnType;
-
-            if ($parentReturnType === null) {
-                continue;
-            }
-
-            if ($parentReturnType instanceof Identifier && $parentReturnType->name === 'object') {
-                continue;
-            }
-
-            return true;
-        }
-
-        return false;
-    }
-
     private function getActualReturnClass(ClassMethod $node): ?string
     {
         $returnStatements = $this->betterNodeFinder->findReturnsScoped($node);