[CodeQuality] Fix AddInstanceofAssertForNullableArgumentRector duplicate assertInstanceOf inside traits (#773)

Author: TomasVotruba

rules-tests/CodeQuality/Rector/ClassMethod/AddInstanceofAssertForNullableArgumentRector/Fixture/nullable_arg_in_trait.php.inc

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Fixture;
+
+use Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source\SomeFactory;
+
+trait NullableArgInTrait
+{
+    public function assertSomething(SomeFactory $someFactory): void
+    {
+        $someObject = $someFactory->create();
+
+        $someFactory->process($someObject);
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Fixture;
+
+use Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source\SomeFactory;
+
+trait NullableArgInTrait
+{
+    public function assertSomething(SomeFactory $someFactory): void
+    {
+        $someObject = $someFactory->create();
+        $this->assertInstanceOf(\Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source\SomeClassUsedInTests::class, $someObject);
+
+        $someFactory->process($someObject);
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/ClassMethod/AddInstanceofAssertForNullableArgumentRector/Fixture/skip_already_asserted_in_trait.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Fixture;
+
+use Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source\SomeFactory;
+
+trait SkipAlreadyAssertedInTrait
+{
+    public function assertSomething(SomeFactory $someFactory): void
+    {
+        $someObject = $someFactory->create();
+        $this->assertInstanceOf(\Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source\SomeClassUsedInTests::class, $someObject);
+
+        $someFactory->process($someObject);
+    }
+}

rules-tests/CodeQuality/Rector/ClassMethod/AddInstanceofAssertForNullableArgumentRector/Source/SomeFactory.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source;
+
+final class SomeFactory
+{
+    public function create(): ?SomeClassUsedInTests
+    {
+        return null;
+    }
+
+    public function process(SomeClassUsedInTests $someClass): void
+    {
+    }
+}

rules/CodeQuality/Rector/ClassMethod/AddInstanceofAssertForNullableArgumentRector.php

@@ -9,6 +9,7 @@
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Expression;
 use PhpParser\Node\Stmt\Foreach_;
 use PhpParser\NodeVisitor;
 use PHPStan\Type\ObjectType;
@@ -132,6 +133,20 @@ public function refactor(Node $node): ?Node
 
         $next = 0;
         foreach ($node->stmts as $key => $stmt) {
+            // already asserted in a previous run? drop the variable to keep the rule idempotent
+            $assertedVariableName = $this->matchAssertInstanceOfVariableName($stmt);
+            if (is_string($assertedVariableName)) {
+                $alreadyAssertedVariableNameToType = $variableNameToTypeCollection->matchByVariableName(
+                    $assertedVariableName
+                );
+
+                if ($alreadyAssertedVariableNameToType instanceof VariableNameToType) {
+                    $variableNameToTypeCollection->remove($alreadyAssertedVariableNameToType);
+                }
+
+                continue;
+            }
+
             // has callable on nullable variable of already collected name?
             $matchedNullableVariableNameToType = $this->matchedNullableArgumentNameToType(
                 $stmt,
@@ -224,4 +239,36 @@ private function matchedNullableArgumentNameToType(
 
         return $matchedNullableVariableNameToType;
     }
+
+    private function matchAssertInstanceOfVariableName(Stmt $stmt): ?string
+    {
+        if (! $stmt instanceof Expression) {
+            return null;
+        }
+
+        if (! $stmt->expr instanceof MethodCall) {
+            return null;
+        }
+
+        $methodCall = $stmt->expr;
+        if (! $this->isName($methodCall->name, 'assertInstanceOf')) {
+            return null;
+        }
+
+        $args = $methodCall->getArgs();
+        if (! isset($args[1])) {
+            return null;
+        }
+
+        if (! $args[1]->value instanceof Variable) {
+            return null;
+        }
+
+        $variableName = $this->getName($args[1]->value);
+        if (! is_string($variableName)) {
+            return null;
+        }
+
+        return $variableName;
+    }
 }