[code-quality] Add RemoveStandaloneCreateMockRector (#648)

* [code-quality] Add RemoveStandaloneCreateMockRector

* enable AddInstanceofAssertForNullableArgumentRector

* covert topmost call

Author: TomasVotruba

config/sets/phpunit-code-quality.php

@@ -15,12 +15,14 @@
 use Rector\PHPUnit\CodeQuality\Rector\Class_\TestWithToDataProviderRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\TypeWillReturnCallableArrowFunctionRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector;
+use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector;
 use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableInstanceRector;
 use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\BareCreateMockAssignToDirectUseRector;
 use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\DataProviderArrayItemsNewLinedRector;
 use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\EntityDocumentCreateMockToDirectNewRector;
 use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\NoSetupWithParentCallOverrideRector;
 use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\RemoveEmptyTestMethodRector;
+use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector;
 use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\ReplaceTestAnnotationWithPrefixedFunctionRector;
 use Rector\PHPUnit\CodeQuality\Rector\Expression\AssertArrayCastedObjectToAssertSameRector;
 use Rector\PHPUnit\CodeQuality\Rector\Foreach_\SimplifyForeachInstanceOfRector;
@@ -111,7 +113,7 @@
         AddInstanceofAssertForNullableInstanceRector::class,
 
         // enable next after testing
-        // \Rector\PHPUnit\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector::class,
+        AddInstanceofAssertForNullableArgumentRector::class,
 
         AssertArrayCastedObjectToAssertSameRector::class,
 
@@ -149,7 +151,10 @@
         EntityDocumentCreateMockToDirectNewRector::class,
         ReplaceAtMethodWithDesiredMatcherRector::class,
         BareCreateMockAssignToDirectUseRector::class,
+
+        // dead code
         RemoveNeverUsedMockPropertyRector::class,
+        RemoveStandaloneCreateMockRector::class,
 
         // readability
         NoSetupWithParentCallOverrideRector::class,

rules-tests/CodeQuality/Rector/ClassMethod/RemoveStandaloneCreateMockRector/Fixture/fixture.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector\Fixture;
+
+final class SomeTest extends \PHPUnit\Framework\TestCase
+{
+    public function testSomething(): void
+    {
+        $this->createMock('someClass');
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector\Fixture;
+
+final class SomeTest extends \PHPUnit\Framework\TestCase
+{
+    public function testSomething(): void
+    {
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/ClassMethod/RemoveStandaloneCreateMockRector/Fixture/handle_multiples.php.inc

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector\Fixture;
+
+final class HandleMultiples extends \PHPUnit\Framework\TestCase
+{
+    public function testSomething(): void
+    {
+        $this->createMock('someClass');
+        $this->createMock('someClass');
+        $this->createMock('someClass');
+        $this->createMock('someClass');
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector\Fixture;
+
+final class HandleMultiples extends \PHPUnit\Framework\TestCase
+{
+    public function testSomething(): void
+    {
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/ClassMethod/RemoveStandaloneCreateMockRector/Fixture/handle_nested_call.php.inc

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector\Fixture;
+
+final class HandleNestedCall extends \PHPUnit\Framework\TestCase
+{
+    public function testSomething(): void
+    {
+        $this->createMock('someClass')
+            ->method('some')
+            ->willReturn(100);
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector\Fixture;
+
+final class HandleNestedCall extends \PHPUnit\Framework\TestCase
+{
+    public function testSomething(): void
+    {
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/ClassMethod/RemoveStandaloneCreateMockRector/Fixture/skip_assigned_call.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector\Fixture;
+
+final class SkipAssignedCall extends \PHPUnit\Framework\TestCase
+{
+    public function testSomething(): void
+    {
+        $value = $this->createMock('someClass');
+    }
+}

rules-tests/CodeQuality/Rector/ClassMethod/RemoveStandaloneCreateMockRector/RemoveStandaloneCreateMockRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class RemoveStandaloneCreateMockRectorTest 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';
+    }
+}

rules-tests/CodeQuality/Rector/ClassMethod/RemoveStandaloneCreateMockRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(RemoveStandaloneCreateMockRector::class);
+};

rules/CodeQuality/Rector/ClassMethod/RemoveStandaloneCreateMockRector.php

@@ -0,0 +1,112 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\CodeQuality\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Expression;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\RemoveStandaloneCreateMockRector\RemoveStandaloneCreateMockRectorTest
+ */
+final class RemoveStandaloneCreateMockRector extends AbstractRector
+{
+    public function __construct(
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Remove standalone method calls with no effect',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    public function test()
+    {
+        $this->createMock('SomeClass');
+    }
+}
+CODE_SAMPLE
+
+                    ,
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    public function test()
+    {
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        $hasChanged = false;
+        foreach ((array) $node->stmts as $key => $stmt) {
+            if (! $stmt instanceof Expression) {
+                continue;
+            }
+
+            if (! $stmt->expr instanceof MethodCall) {
+                continue;
+            }
+
+            $topmostCall = $this->resolveTopmostCall($stmt->expr);
+            if (! $this->isName($topmostCall->name, 'createMock')) {
+                continue;
+            }
+
+            unset($node->stmts[$key]);
+            $hasChanged = true;
+        }
+
+        if ($hasChanged) {
+            return $node;
+        }
+
+        return null;
+    }
+
+    private function resolveTopmostCall(MethodCall $methodCall): MethodCall
+    {
+        $currentMethodCall = $methodCall;
+        while ($currentMethodCall->var instanceof MethodCall) {
+            $currentMethodCall = $currentMethodCall->var;
+        }
+
+        return $currentMethodCall;
+    }
+}

rules/PHPUnit120/Rector/MethodCall/ExplicitMockExpectsCallRector.php

@@ -4,11 +4,11 @@
 
 namespace Rector\PHPUnit\PHPUnit120\Rector\MethodCall;
 
-use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Stmt\ClassMethod;
 use PHPStan\Type\ObjectType;
 use Rector\PHPUnit\Enum\PHPUnitClassName;
 use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;