[phpunit 12] Add /ExpressionCreateMockToCreateStubRector

Author: TomasVotruba

config/sets/phpunit120.php

@@ -6,6 +6,7 @@
 use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Class_\RemoveOverrideFinalConstructTestCaseRector;
+use Rector\PHPUnit\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rules([
@@ -14,6 +15,7 @@
 
         // stubs over mocks
         CreateStubOverCreateMockArgRector::class,
+        ExpressionCreateMockToCreateStubRector::class,
 
         // experimental, from PHPUnit 12.5.2
         // @see https://github.com/sebastianbergmann/phpunit/commit/24c208d6a340c3071f28a9b5cce02b9377adfd43

rules-tests/PHPUnit120/Rector/CallLike/CreateStubOverCreateMockArgRector/Source/InstanceWithMock.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Source;
+
+final class InstanceWithMock
+{
+    public function __construct(private $object)
+    {
+    }
+
+    public function getInner(): object
+    {
+        return $this->object;
+    }
+}

rules-tests/PHPUnit120/Rector/ClassMethod/ExpressionCreateMockToCreateStubRector/ExpressionCreateMockToCreateStubRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ExpressionCreateMockToCreateStubRectorTest 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/PHPUnit120/Rector/ClassMethod/ExpressionCreateMockToCreateStubRector/Fixture/fixture.php.inc

@@ -0,0 +1,39 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector\Source\ClassWithDependency;
+
+final class SomeTest extends TestCase
+{
+    public function test()
+    {
+        $mock = $this->createMock(\stdClass::class);
+
+        $someObject = new ClassWithDependency($mock);
+        $this->assertSame($mock, $someObject->getDependency());
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector\Source\ClassWithDependency;
+
+final class SomeTest extends TestCase
+{
+    public function test()
+    {
+        $mock = $this->createStub(\stdClass::class);
+
+        $someObject = new ClassWithDependency($mock);
+        $this->assertSame($mock, $someObject->getDependency());
+    }
+}
+
+?>

rules-tests/PHPUnit120/Rector/ClassMethod/ExpressionCreateMockToCreateStubRector/Source/ClassWithDependency.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector\Source;
+
+final class ClassWithDependency
+{
+    public function __construct(
+        private $dependency,
+    ) {
+    }
+
+    public function getDependency()
+    {
+        return $this->dependency;
+    }
+}

rules-tests/PHPUnit120/Rector/ClassMethod/ExpressionCreateMockToCreateStubRector/config/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector;
+
+return RectorConfig::configure()
+    ->withRules(rules: [ExpressionCreateMockToCreateStubRector::class]);

rules/PHPUnit120/Rector/ClassMethod/ExpressionCreateMockToCreateStubRector.php

@@ -0,0 +1,169 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\PHPUnit120\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\Assign;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Expression;
+use Rector\PhpParser\Node\BetterNodeFinder;
+use Rector\PHPUnit\CodeQuality\NodeAnalyser\AssignedMocksCollector;
+use Rector\PHPUnit\CodeQuality\NodeFinder\VariableFinder;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class ExpressionCreateMockToCreateStubRector extends AbstractRector
+{
+    public function __construct(
+        private readonly AssignedMocksCollector $assignedMocksCollector,
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+        private readonly VariableFinder $variableFinder,
+        private readonly BetterNodeFinder $betterNodeFinder,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Replace createMock() assigned to variable that is only used as arg with no expectations, to createStub()',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    public function test(): void
+    {
+        $mock = $this->createMock(SomeClass::class);
+
+        $someObject = new SomeClass($mock);
+        $this->assertSame($mock, $someObject->getDependency());
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    public function test(): void
+    {
+        $mock = $this->createStub(SomeClass::class);
+
+        $someObject = new SomeClass($mock);
+        $this->assertSame($mock, $someObject->getDependency());
+    }
+}
+CODE_SAMPLE
+                ),
+
+            ]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node)
+    {
+        if (! $this->testsNodeAnalyzer->isTestClassMethod($node)) {
+            return null;
+        }
+
+        if ($node->stmts === null || count($node->stmts) < 2) {
+            return null;
+        }
+
+        $hasChanged = false;
+
+        foreach ($node->stmts as $stmt) {
+            if (! $stmt instanceof Expression) {
+                continue;
+            }
+
+            if (! $stmt->expr instanceof Assign) {
+                continue;
+            }
+
+            $typeArg = $this->assignedMocksCollector->matchCreateMockArgAssignedToVariable($stmt->expr);
+            if (! $typeArg instanceof Arg) {
+                continue;
+            }
+
+            /** @var Assign $assign */
+            $assign = $stmt->expr;
+
+            if (! $assign->var instanceof Variable) {
+                continue;
+            }
+
+            $assignedVariable = $assign->var;
+            $variableName = $this->getName($assignedVariable);
+
+            // find variable usages outside call like and inside it
+            $usedVariables = $this->variableFinder->find($node, $variableName);
+
+            // used variable in calls
+            /** @var array<StaticCall|MethodCall|New_> $callLikes */
+            $callLikes = $this->betterNodeFinder->findInstancesOfScoped(
+                $node->stmts,
+                [MethodCall::class, StaticCall::class, New_::class]
+            );
+
+            $callLikeUsedVariables = [];
+
+            foreach ($callLikes as $callLike) {
+                foreach ($callLike->getArgs() as $arg) {
+                    if (! $arg->value instanceof Variable) {
+                        continue;
+                    }
+
+                    if (! $this->isName($arg->value, $variableName)) {
+                        continue;
+                    }
+
+                    $callLikeUsedVariables[] = $arg->value;
+                }
+            }
+
+            dump(count($callLikeUsedVariables));
+            if (count($usedVariables) - 1 !== count($callLikeUsedVariables)) {
+                continue;
+            }
+
+            // here we can flip the createMock() to createStub()
+
+            if (! $assign->expr instanceof MethodCall) {
+                continue;
+            }
+
+            $methodCall = $assign->expr;
+            $methodCall->name = new Identifier('createStub');
+
+            $hasChanged = true;
+        }
+
+        if ($hasChanged) {
+            return $node;
+        }
+
+        return null;
+    }
+}