Skip error in mock to avoid false positive in mixed (#1)

* misc

* add test fixture

* rename to ReturnNullOverFalseRule

composer.json

@@ -17,7 +17,8 @@
         "rector/rector": "^1.1",
         "symplify/easy-coding-standard": "^12.1",
         "phpstan/extension-installer": "^1.3",
-        "tomasvotruba/class-leak": "^0.2"
+        "tomasvotruba/class-leak": "^0.2",
+        "tracy/tracy": "^2.10"
     },
     "autoload": {
         "psr-4": {

config/extension.neon

@@ -51,7 +51,7 @@ rules:
     - Rector\TypePerfect\Rules\NarrowPublicClassMethodParamTypeRule
     - Rector\TypePerfect\Rules\NarrowPrivateClassMethodParamTypeRule
     - Rector\TypePerfect\Rules\NarrowReturnObjectTypeRule
-    - Rector\TypePerfect\Rules\NoReturnFalseInNonBoolClassMethodRule
+    - Rector\TypePerfect\Rules\ReturnNullOverFalseRule
 
     # no mixed
     - Rector\TypePerfect\Rules\NoMixedPropertyFetcherRule

phpstan.neon

@@ -18,5 +18,5 @@ parameters:
         - '#Method (.*?)::getCollectors\(\) return type with generic interface PHPStan\\Collectors\\Collector does not specify its types\: TNodeType, TValue#'
 
         # overly detailed generics
-        - '#Class Rector\\TypePerfect\\Tests\\Rules\\(.*?) extends generic class PHPStan\\Testing\\RuleTestCase but does not specify its types\: TRule#'
-        - '#Method Rector\\TypePerfect\\Tests\\Rules\\(.*?)\:\:getRule\(\) return type with generic interface PHPStan\\Rules\\Rule does not specify its types\: TNodeType#'
+        - '#Rector\\TypePerfect\\Tests\\Rules\\(.*?) generic (class|interface)#'
+        - '#Method Rector\\TypePerfect\\Tests\\Rules\\(.*?)testRule\(\) has parameter \$expectedErrorsWithLines with no value type specified in iterable type array#'

src/Rules/NoMixedMethodCallerRule.php

@@ -49,6 +49,7 @@ public function processNode(Node $node, Scope $scope): array
         }
 
         $callerType = $scope->getType($node->var);
+
         if (! $callerType instanceof MixedType) {
             return [];
         }
@@ -57,10 +58,30 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
+        // if error, skip as well for false positive
+        if ($this->isPreviousTypeErrorType($node, $scope)) {
+            return [];
+        }
+
         $printedMethodCall = $this->printerStandard->prettyPrintExpr($node->var);
 
         return [
             sprintf(self::ERROR_MESSAGE, $printedMethodCall),
         ];
     }
+
+    private function isPreviousTypeErrorType(MethodCall $methodCall, Scope $scope): bool
+    {
+        $currentMethodCall = $methodCall;
+        while ($currentMethodCall->var instanceof MethodCall) {
+            $previousType = $scope->getType($currentMethodCall->var);
+            if ($previousType instanceof ErrorType) {
+                return true;
+            }
+
+            $currentMethodCall = $currentMethodCall->var;
+        }
+
+        return false;
+    }
 }

src/Rules/NoReturnFalseInNonBoolClassMethodRule.php → src/Rules/ReturnNullOverFalseRule.php

@@ -17,7 +17,7 @@
 /**
  * @implements Rule<ClassMethod>
  */
-final readonly class NoReturnFalseInNonBoolClassMethodRule implements Rule
+final readonly class ReturnNullOverFalseRule implements Rule
 {
     /**
      * @api

tests/Rules/NoMixedMethodCallerRule/Fixture/SkipPHPUnitMock.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypePerfect\Tests\Rules\NoMixedMethodCallerRule\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\TypePerfect\Tests\Rules\NoMixedMethodCallerRule\Source\SomeFinalClass;
+
+final class SkipPHPUnitMock extends TestCase
+{
+    public function test()
+    {
+        $someClassMock = $this->createMock(SomeFinalClass::class);
+
+        $someClassMock->expects($this->once())
+            ->method('some')
+            ->with($this->any())
+            ->willReturn(1000);
+    }
+}

tests/Rules/NoMixedMethodCallerRule/NoMixedMethodCallerRuleTest.php

@@ -12,9 +12,6 @@
 
 final class NoMixedMethodCallerRuleTest extends RuleTestCase
 {
-    /**
-     * @param mixed[]|array<int, array<int|string>> $expectedErrorsWithLines
-     */
     #[DataProvider('provideData')]
     public function testRule(string $filePath, array $expectedErrorsWithLines): void
     {
@@ -25,6 +22,7 @@ public static function provideData(): Iterator
     {
         yield [__DIR__ . '/Fixture/SkipKnownCallerType.php', []];
         yield [__DIR__ . '/Fixture/SkipMockObject.php', []];
+        yield [__DIR__ . '/Fixture/SkipPHPUnitMock.php', []];
 
         $errorMessage = sprintf(NoMixedMethodCallerRule::ERROR_MESSAGE, '$someType');
         yield [__DIR__ . '/Fixture/MagicMethodName.php', [[$errorMessage, 11]]];

tests/Rules/NoMixedMethodCallerRule/Source/SomeFinalClass.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\TypePerfect\Tests\Rules\NoMixedMethodCallerRule\Source;
+
+final class SomeFinalClass
+{
+    public function some()
+    {
+    }
+}

tests/Rules/NoMixedPropertyFetcherRule/NoMixedPropertyFetcherRuleTest.php

@@ -12,9 +12,6 @@
 
 final class NoMixedPropertyFetcherRuleTest extends RuleTestCase
 {
-    /**
-     * @param mixed[]|array<int, array<int|string>> $expectedErrorsWithLines
-     */
     #[DataProvider('provideData')]
     public function testRule(string $filePath, array $expectedErrorsWithLines): void
     {

tests/Rules/NoReturnFalseInNonBoolClassMethodRule/Fixture/ReturnFalseOnly.php → tests/Rules/ReturnNullOverFalseRule/Fixture/ReturnFalseOnly.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\TypePerfect\Tests\Rules\NoReturnFalseInNonBoolClassMethodRule\Fixture;
+namespace Rector\TypePerfect\Tests\Rules\ReturnNullOverFalseRule\Fixture;
 
 final class ReturnFalseOnly
 {

tests/Rules/NoReturnFalseInNonBoolClassMethodRule/Fixture/SkipReturnBool.php → tests/Rules/ReturnNullOverFalseRule/Fixture/SkipReturnBool.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\TypePerfect\Tests\Rules\NoReturnFalseInNonBoolClassMethodRule\Fixture;
+namespace Rector\TypePerfect\Tests\Rules\ReturnNullOverFalseRule\Fixture;
 
 final class SkipReturnBool
 {

tests/Rules/NoReturnFalseInNonBoolClassMethodRule/NoReturnFalseInNonBoolClassMethodRuleTest.php → tests/Rules/ReturnNullOverFalseRule/ReturnNullOverFalseRuleTest.php

@@ -2,15 +2,15 @@
 
 declare(strict_types=1);
 
-namespace Rector\TypePerfect\Tests\Rules\NoReturnFalseInNonBoolClassMethodRule;
+namespace Rector\TypePerfect\Tests\Rules\ReturnNullOverFalseRule;
 
 use Iterator;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
-use Rector\TypePerfect\Rules\NoReturnFalseInNonBoolClassMethodRule;
+use Rector\TypePerfect\Rules\ReturnNullOverFalseRule;
 
-final class NoReturnFalseInNonBoolClassMethodRuleTest extends RuleTestCase
+final class ReturnNullOverFalseRuleTest extends RuleTestCase
 {
     /**
      * @param mixed[] $expectedErrorMessagesWithLines
@@ -25,7 +25,7 @@ public static function provideData(): Iterator
     {
         yield [
             __DIR__ . '/Fixture/ReturnFalseOnly.php',
-            [[NoReturnFalseInNonBoolClassMethodRule::ERROR_MESSAGE, 9]],
+            [[ReturnNullOverFalseRule::ERROR_MESSAGE, 9]],
         ];
 
         yield [__DIR__ . '/Fixture/SkipReturnBool.php', []];
@@ -41,6 +41,6 @@ public static function getAdditionalConfigFiles(): array
 
     protected function getRule(): Rule
     {
-        return self::getContainer()->getByType(NoReturnFalseInNonBoolClassMethodRule::class);
+        return self::getContainer()->getByType(ReturnNullOverFalseRule::class);
     }
 }