[TypeDeclaration] Skip return interface on NarrowObjectReturnTypeRector

Author: samsonasik

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

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\NarrowObjectReturnTypeRector\Fixture;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+
+final class SkipReturnInterface
+{
+    protected function build(): LoggerInterface
+    {
+        return new NullLogger();
+    }
+}

rules/TypeDeclaration/Rector/ClassMethod/NarrowObjectReturnTypeRector.php

@@ -33,6 +33,16 @@
  */
 final class NarrowObjectReturnTypeRector extends AbstractRector
 {
+    /**
+     * List of interfaces that usually use non-mocked on tests
+     *
+     * @var class-string[]
+     */
+    private const ALLOWED_INTERFACES_CHANGE = [
+        'Doctrine\Common\Collections\Collection',
+        'PhpParser\Node',
+    ];
+
     public function __construct(
         private readonly BetterNodeFinder $betterNodeFinder,
         private readonly ReflectionResolver $reflectionResolver,
@@ -151,13 +161,29 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
+        if (! in_array($declaredType, self::ALLOWED_INTERFACES_CHANGE, true) && $this->isInterface($declaredType)) {
+            return null;
+        }
+
         $node->returnType = new FullyQualified($actualReturnClass);
 
         $this->updateDocblock($node, $actualReturnClass);
 
         return $node;
     }
 
+    private function isInterface(string $declaredType): bool
+    {
+        $declaredObjectType = new ObjectType($declaredType);
+        $classReflection = $declaredObjectType->getClassReflection();
+
+        if (! $classReflection instanceof ClassReflection) {
+            return false;
+        }
+
+        return $classReflection->isInterface();
+    }
+
     private function updateDocblock(ClassMethod $classMethod, string $actualReturnClass): void
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNode($classMethod);