[TypeDeclaration] Make configurable on NarrowObjectReturnTypeRector to allow to not make change return on abstract/interface return

Author: samsonasik

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/DisableReturnAbstractOrInterfaceTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class DisableReturnAbstractOrInterfaceTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/FixtureSkipReturnAbstractOrInterface');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/disable_return_abstract_or_interface_configured_rule.php';
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/FixtureSkipReturnAbstractOrInterface/skip_abstract_class.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\FixtureSkipReturnAbstractOrInterface;
+
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Source\AbstractTalk;
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Source\ConcreteConferenceTalk;
+
+final class SkipReturnAbstractClass
+{
+    public function create(): AbstractTalk
+    {
+        return new ConcreteConferenceTalk();
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/FixtureSkipReturnAbstractOrInterface/skip_return_interface.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\FixtureSkipReturnAbstractOrInterface;
+
+use Illuminate\Container\Container;
+use Psr\Container\ContainerInterface;
+
+final class SkipReturnInterface
+{
+    public function create(): ContainerInterface
+    {
+        return new Container();
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector/config/disable_return_abstract_or_interface_configured_rule.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->ruleWithConfiguration(NarrowObjectReturnTypeRector::class, [
+        NarrowObjectReturnTypeRector::IS_ALLOW_ABSTRACT_AND_INTERFACE => false,
+    ]);
+};

rules/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector.php

@@ -18,22 +18,30 @@
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\BetterPhpDocParser\ValueObject\Type\FullyQualifiedIdentifierTypeNode;
 use Rector\Comments\NodeDocBlock\DocBlockUpdater;
+use Rector\Contract\Rector\ConfigurableRectorInterface;
 use Rector\NodeTypeResolver\TypeComparator\TypeComparator;
 use Rector\PhpParser\AstResolver;
 use Rector\PhpParser\Node\BetterNodeFinder;
 use Rector\Rector\AbstractRector;
 use Rector\Reflection\ReflectionResolver;
 use Rector\StaticTypeMapper\StaticTypeMapper;
-use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
  * Narrows return type from generic object or parent class to specific class in final classes/methods.
  *
  * @see \Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\NarrowObjectReturnTypeRectorTest
  */
-final class NarrowObjectReturnTypeRector extends AbstractRector
+final class NarrowObjectReturnTypeRector extends AbstractRector implements ConfigurableRectorInterface
 {
+    /**
+     * @var string
+     */
+    public const IS_ALLOW_ABSTRACT_AND_INTERFACE = 'is_allow_abstract_and_interface';
+
+    private bool $isAllowAbstractAndInterface = true;
+
     public function __construct(
         private readonly BetterNodeFinder $betterNodeFinder,
         private readonly ReflectionResolver $reflectionResolver,
@@ -50,7 +58,7 @@ public function getRuleDefinition(): RuleDefinition
         return new RuleDefinition(
             'Narrows return type from generic object or parent class to specific class in final classes/methods',
             [
-                new CodeSample(
+                new ConfiguredCodeSample(
                     <<<'CODE_SAMPLE'
 final class TalkFactory extends AbstractFactory
 {
@@ -70,8 +78,12 @@ protected function build(): ConferenceTalk
     }
 }
 CODE_SAMPLE
+                    ,
+                    [
+                        self::IS_ALLOW_ABSTRACT_AND_INTERFACE => true,
+                    ]
                 ),
-                new CodeSample(
+                new ConfiguredCodeSample(
                     <<<'CODE_SAMPLE'
 final class TalkFactory
 {
@@ -91,6 +103,10 @@ public function createConferenceTalk(): ConferenceTalk
     }
 }
 CODE_SAMPLE
+                    ,
+                    [
+                        self::IS_ALLOW_ABSTRACT_AND_INTERFACE => true,
+                    ]
                 ),
             ],
         );
@@ -120,6 +136,10 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
+        if (! $this->isAllowedReturnsAbstractOrInterface($returnType->toString())) {
+            return null;
+        }
+
         if (! $classReflection->isFinalByKeyword() && ! $node->isFinal()) {
             return null;
         }
@@ -159,6 +179,34 @@ public function refactor(Node $node): ?Node
         return $node;
     }
 
+    /**
+     * @param array<string, bool> $configuration
+     */
+    public function configure(array $configuration): void
+    {
+        $this->isAllowAbstractAndInterface = $configuration[self::IS_ALLOW_ABSTRACT_AND_INTERFACE] ?? true;
+    }
+
+    private function isAllowedReturnsAbstractOrInterface(string $actualReturnClass): bool
+    {
+        if ($this->isAllowAbstractAndInterface) {
+            return true;
+        }
+
+        $actualObjectType = new ObjectType($actualReturnClass);
+        $classReflection = $actualObjectType->getClassReflection();
+
+        if (! $classReflection instanceof ClassReflection) {
+            return false;
+        }
+
+        if ($classReflection->isInterface()) {
+            return false;
+        }
+
+        return ! $classReflection->isAbstract();
+    }
+
     private function updateDocblock(ClassMethod $classMethod, string $actualReturnClass): void
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNode($classMethod);