[TypeDeclaration] Allow __invoke() method for return type changed on …

…ClassMethodReturnTypeOverrideGuard (#4667)

Co-authored-by: GitHub Action <actions@github.com>

packages/VendorLocker/NodeVendorLocker/ClassMethodReturnTypeOverrideGuard.php

@@ -15,6 +15,7 @@
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Type\MixedType;
 use Rector\Core\FileSystem\FilePathHelper;
+use Rector\Core\NodeAnalyzer\MagicClassMethodAnalyzer;
 use Rector\Core\PhpParser\AstResolver;
 use Rector\Core\PhpParser\Node\BetterNodeFinder;
 use Rector\Core\Reflection\ReflectionResolver;
@@ -42,14 +43,15 @@ public function __construct(
         private readonly ReflectionResolver $reflectionResolver,
         private readonly ReturnTypeInferer $returnTypeInferer,
         private readonly ParentClassMethodTypeOverrideGuard $parentClassMethodTypeOverrideGuard,
-        private readonly FilePathHelper $filePathHelper
+        private readonly FilePathHelper $filePathHelper,
+        private readonly MagicClassMethodAnalyzer $magicClassMethodAnalyzer
     ) {
     }
 
     public function shouldSkipClassMethod(ClassMethod $classMethod, Scope $scope): bool
     {
         // 1. skip magic methods
-        if ($classMethod->isMagic()) {
+        if ($this->magicClassMethodAnalyzer->isUnsafeOverridden($classMethod)) {
             return true;
         }
 

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictTypedCallRector/Fixture/invoke_method.php.inc

@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedCallRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedCallRector\Source\SomeExternalCaller;
+
+final class InvokeMethod
+{
+    public function __invoke(SomeExternalCaller $someExternalCaller)
+    {
+        return $someExternalCaller->getName();
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedCallRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedCallRector\Source\SomeExternalCaller;
+
+final class InvokeMethod
+{
+    public function __invoke(SomeExternalCaller $someExternalCaller): string
+    {
+        return $someExternalCaller->getName();
+    }
+}
+
+?>

rules/TypeDeclaration/Rector/ClassMethod/ReturnNeverTypeRector.php

@@ -94,10 +94,6 @@ public function provideMinPhpVersion(): int
     private function shouldSkip(ClassMethod | Function_ | Closure $node, Scope $scope): bool
     {
         $hasReturn = $this->betterNodeFinder->hasInstancesOfInFunctionLikeScoped($node, Return_::class);
-        if ($node instanceof ClassMethod && $node->isMagic()) {
-            return true;
-        }
-
         if ($hasReturn) {
             return true;
         }

rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictTypedCallRector.php

@@ -166,14 +166,8 @@ private function shouldSkip(ClassMethod | Function_ | Closure $node, Scope $scop
             return true;
         }
 
-        if ($node instanceof ClassMethod) {
-            if ($this->classMethodReturnTypeOverrideGuard->shouldSkipClassMethod($node, $scope)) {
-                return true;
-            }
-
-            if ($node->isMagic()) {
-                return true;
-            }
+        if ($node instanceof ClassMethod && $this->classMethodReturnTypeOverrideGuard->shouldSkipClassMethod($node, $scope)) {
+            return true;
         }
 
         return $this->isUnionPossibleReturnsVoid($node);

src/NodeAnalyzer/MagicClassMethodAnalyzer.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Core\NodeAnalyzer;
+
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Core\ValueObject\MethodName;
+use Rector\NodeNameResolver\NodeNameResolver;
+
+final class MagicClassMethodAnalyzer
+{
+    public function __construct(private readonly NodeNameResolver $nodeNameResolver)
+    {
+    }
+
+    public function isUnsafeOverridden(ClassMethod $classMethod): bool
+    {
+        if ($this->nodeNameResolver->isName($classMethod, MethodName::INVOKE)) {
+            return false;
+        }
+
+        return $classMethod->isMagic();
+    }
+}