[utils] Add RemoveRefactorDuplicatedNodeInstanceCheckRector (#7529)

TomasVotruba · web-flow · commit 4fc4e948f8ac · 2025-10-22T09:44:53.000+02:00
* simplify ClassMethodParamVendorLockResolver check

* const

* [utils] Add RemoveRefactorDuplicatedNodeInstanceCheckRector

* add test
diff --git a/composer.json b/composer.json
@@ -81,6 +81,7 @@
                 "rules-tests",
                 "tests"
             ],
+            "Rector\\Utils\\Tests\\": "utils-tests",
             "E2e\\Parallel\\Reflection\\Resolver\\": [
                 "e2e/parallel-reflection-resolver/src/",
                 "e2e/no-parallel-reflection-resolver/src"
diff --git a/phpstan.neon b/phpstan.neon
@@ -352,3 +352,5 @@ parameters:
         -
             identifier: offsetAccess.invalidOffset
             path: src/CustomRules/SimpleNodeDumper.php
+
+        - '#Method Rector\\Utils\\Rector\\RemoveRefactorDuplicatedNodeInstanceCheckRector\:\:getInstanceofNodeClass\(\) should return class\-string<PhpParser\\Node>\|null but returns class\-string#'
diff --git a/phpunit.xml b/phpunit.xml
@@ -13,6 +13,7 @@
         <testsuite name="main">
             <directory>tests</directory>
             <directory>rules-tests</directory>
+            <directory>utils-tests</directory>
         </testsuite>
     </testsuites>
 
diff --git a/rector.php b/rector.php
@@ -6,6 +6,7 @@
 use Rector\Config\RectorConfig;
 use Rector\DeadCode\Rector\ConstFetch\RemovePhpVersionIdCheckRector;
 use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
+use Rector\Utils\Rector\RemoveRefactorDuplicatedNodeInstanceCheckRector;
 
 return RectorConfig::configure()
     ->withPreparedSets(
@@ -18,7 +19,6 @@
         naming: true,
         instanceOf: true,
         earlyReturn: true,
-        strictBooleans: true,
         rectorPreset: true,
         phpunitCodeQuality: true
     )
@@ -37,6 +37,7 @@
     ])
     ->withRootFiles()
     ->withImportNames(removeUnusedImports: true)
+    ->withRules([RemoveRefactorDuplicatedNodeInstanceCheckRector::class])
     ->withSkip([
         StringClassNameToClassConstantRector::class,
         // tests
diff --git a/rules/CodeQuality/Rector/BooleanNot/ReplaceConstantBooleanNotRector.php b/rules/CodeQuality/Rector/BooleanNot/ReplaceConstantBooleanNotRector.php
@@ -69,10 +69,6 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): ?Node
     {
-        if (! $node instanceof BooleanNot) {
-            return null;
-        }
-
         if ($this->valueResolver->isFalse($node->expr)) {
             return new ConstFetch(new Name('true'));
         }
diff --git a/rules/CodingStyle/Rector/FuncCall/FunctionFirstClassCallableRector.php b/rules/CodingStyle/Rector/FuncCall/FunctionFirstClassCallableRector.php
@@ -61,12 +61,11 @@ public function getNodeTypes(): array
         return [FuncCall::class];
     }
 
+    /**
+     * @param FuncCall $node
+     */
     public function refactor(Node $node): ?FuncCall
     {
-        if (! $node instanceof FuncCall) {
-            return null;
-        }
-
         if (! $node->name instanceof Name) {
             return null;
         }
diff --git a/rules/DeadCode/Rector/ClassMethod/RemoveUnusedPublicMethodParameterRector.php b/rules/DeadCode/Rector/ClassMethod/RemoveUnusedPublicMethodParameterRector.php
@@ -13,6 +13,7 @@
 use Rector\NodeAnalyzer\MagicClassMethodAnalyzer;
 use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
 use Rector\Rector\AbstractRector;
+use Rector\ValueObject\MethodName;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -115,7 +116,7 @@ private function shouldSkipClassMethod(ClassMethod $classMethod, Class_ $class):
         }
 
         // parameter is required for contract coupling
-        if ($this->isName($classMethod->name, '__invoke') && $this->phpAttributeAnalyzer->hasPhpAttribute(
+        if ($this->isName($classMethod->name, MethodName::INVOKE) && $this->phpAttributeAnalyzer->hasPhpAttribute(
             $class,
             'Symfony\Component\Messenger\Attribute\AsMessageHandler'
         )) {
diff --git a/src/VendorLocker/NodeVendorLocker/ClassMethodParamVendorLockResolver.php b/src/VendorLocker/NodeVendorLocker/ClassMethodParamVendorLockResolver.php
@@ -6,7 +6,6 @@
 
 use PhpParser\Node\Stmt\ClassMethod;
 use PHPStan\Reflection\ClassReflection;
-use Rector\FileSystem\FilePathHelper;
 use Rector\NodeNameResolver\NodeNameResolver;
 use Rector\Reflection\ReflectionResolver;
 
@@ -15,7 +14,6 @@
     public function __construct(
         private NodeNameResolver $nodeNameResolver,
         private ReflectionResolver $reflectionResolver,
-        private FilePathHelper $filePathHelper
     ) {
     }
 
@@ -38,11 +36,7 @@ public function isVendorLocked(ClassMethod $classMethod): bool
         $methodName = $this->nodeNameResolver->getName($classMethod);
 
         // has interface vendor lock? → better skip it, as PHPStan has access only to just analyzed classes
-        if ($this->hasParentInterfaceMethod($classReflection, $methodName)) {
-            return true;
-        }
-
-        return $this->hasClassMethodLockMatchingFileName($classReflection, $methodName, '/vendor/');
+        return $this->hasParentInterfaceMethod($classReflection, $methodName);
     }
 
     /**
@@ -60,37 +54,4 @@ private function hasParentInterfaceMethod(ClassReflection $classReflection, stri
 
         return false;
     }
-
-    private function hasClassMethodLockMatchingFileName(
-        ClassReflection $classReflection,
-        string $methodName,
-        string $filePathPartName
-    ): bool {
-        $ancestorClassReflections = [...$classReflection->getParents(), ...$classReflection->getInterfaces()];
-        foreach ($ancestorClassReflections as $ancestorClassReflection) {
-            // parent type
-            if (! $ancestorClassReflection->hasNativeMethod($methodName)) {
-                continue;
-            }
-
-            // is file in vendor?
-            $fileName = $ancestorClassReflection->getFileName();
-            // probably internal class
-            if ($fileName === null) {
-                continue;
-            }
-
-            // not conditions? its a match
-            if ($filePathPartName === '') {
-                return true;
-            }
-
-            $normalizedFileName = $this->filePathHelper->normalizePathAndSchema($fileName);
-            if (str_contains($normalizedFileName, $filePathPartName)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
 }
diff --git a/utils-tests/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector/Fixture/cover_bare_get_node_types.php.inc b/utils-tests/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector/Fixture/cover_bare_get_node_types.php.inc
@@ -0,0 +1,54 @@
+<?php
+
+namespace Rector\Utils\Tests\Rector\RemoveRefactorDuplicatedNodeInstanceCheckRector\Fixture;
+
+use PhpParser\Node;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class CoverBareGetNodeTypes extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Node\Stmt\ClassMethod::class];
+    }
+
+    public function refactor(Node $node)
+    {
+        if (! $node instanceof Node\Stmt\ClassMethod) {
+            return null;
+        }
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Utils\Tests\Rector\RemoveRefactorDuplicatedNodeInstanceCheckRector\Fixture;
+
+use PhpParser\Node;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class CoverBareGetNodeTypes extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Node\Stmt\ClassMethod::class];
+    }
+
+    public function refactor(Node $node)
+    {
+    }
+}
+
+?>
diff --git a/utils-tests/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector/Fixture/some_class.php.inc b/utils-tests/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector/Fixture/some_class.php.inc
@@ -0,0 +1,60 @@
+<?php
+
+namespace Rector\Utils\Tests\Rector\RemoveRefactorDuplicatedNodeInstanceCheckRector\Fixture;
+
+use PhpParser\Node;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class SomeClass extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Node\Stmt\ClassMethod::class];
+    }
+
+    /**
+     * @param Node\Stmt\ClassMethod $node
+     */
+    public function refactor(Node $node)
+    {
+        if (! $node instanceof Node\Stmt\ClassMethod) {
+            return null;
+        }
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Utils\Tests\Rector\RemoveRefactorDuplicatedNodeInstanceCheckRector\Fixture;
+
+use PhpParser\Node;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class SomeClass extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Node\Stmt\ClassMethod::class];
+    }
+
+    /**
+     * @param Node\Stmt\ClassMethod $node
+     */
+    public function refactor(Node $node)
+    {
+    }
+}
+
+?>
diff --git a/utils-tests/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector/RemoveRefactorDuplicatedNodeInstanceCheckRectorTest.php b/utils-tests/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector/RemoveRefactorDuplicatedNodeInstanceCheckRectorTest.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Utils\Tests\Rector\RemoveRefactorDuplicatedNodeInstanceCheckRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class RemoveRefactorDuplicatedNodeInstanceCheckRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/utils-tests/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector/config/configured_rule.php b/utils-tests/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector/config/configured_rule.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Utils\Rector\RemoveRefactorDuplicatedNodeInstanceCheckRector;
+
+return RectorConfig::configure()
+    ->withRules([
+        RemoveRefactorDuplicatedNodeInstanceCheckRector::class,
+    ]);
diff --git a/utils/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector.php b/utils/Rector/RemoveRefactorDuplicatedNodeInstanceCheckRector.php

Original file line number	Diff line number	Diff line change
`@@ -352,3 +352,5 @@ parameters:`
`352`	`352`	`-`
`353`	`353`	`identifier: offsetAccess.invalidOffset`
`354`	`354`	`path: src/CustomRules/SimpleNodeDumper.php`
	`355`	`+`
	`356`	`+ - '#Method Rector\\Utils\\Rector\\RemoveRefactorDuplicatedNodeInstanceCheckRector\:\:getInstanceofNodeClass\(\) should return class\-string<PhpParser\\Node>\\|null but returns class\-string#'`
Original file line number	Diff line number	Diff line change
`@@ -69,10 +69,6 @@ public function getNodeTypes(): array`
`69`	`69`	`*/`
`70`	`70`	`public function refactor(Node $node): ?Node`
`71`	`71`	`{`
`72`		`- if (! $node instanceof BooleanNot) {`
`73`		`- return null;`
`74`		`- }`
`75`		`-`
`76`	`72`	`if ($this->valueResolver->isFalse($node->expr)) {`
`77`	`73`	`return new ConstFetch(new Name('true'));`
`78`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,12 +61,11 @@ public function getNodeTypes(): array`
`61`	`61`	`return [FuncCall::class];`
`62`	`62`	`}`
`63`	`63`
	`64`	`+ /**`
	`65`	`+ * @param FuncCall $node`
	`66`	`+ */`
`64`	`67`	`public function refactor(Node $node): ?FuncCall`
`65`	`68`	`{`
`66`		`- if (! $node instanceof FuncCall) {`
`67`		`- return null;`
`68`		`- }`
`69`		`-`
`70`	`69`	`if (! $node->name instanceof Name) {`
`71`	`70`	`return null;`
`72`	`71`	`}`