Add MockObjectArgCreateStubToCreateMockRector (#741)

Author: TomasVotruba

config/sets/phpunit-mock-to-stub.php

@@ -6,6 +6,7 @@
 use Rector\PHPUnit\CodeQuality\Rector\Class_\AddIntersectionVarToMockObjectPropertyRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector;
 use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\BareCreateMockAssignToDirectUseRector;
+use Rector\PHPUnit\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector;
 use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubInCoalesceArgRector;
 use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Class_\PropertyCreateMockToCreateStubRector;
@@ -23,5 +24,8 @@
         AddIntersectionVarToMockObjectPropertyRector::class,
         AddStubIntersectionVarToStubPropertyRector::class,
         BareCreateMockAssignToDirectUseRector::class,
+
+        // mocks back over stubs, where mock object is required
+        MockObjectArgCreateStubToCreateMockRector::class,
     ]);
 };

config/sets/phpunit110.php

@@ -5,11 +5,13 @@
 use Rector\Config\RectorConfig;
 use Rector\PHPUnit\PHPUnit110\Rector\CallLike\AssertContainsOnlyMethodCallRector;
 use Rector\PHPUnit\PHPUnit110\Rector\Class_\NamedArgumentForDataProviderRector;
+use Rector\PHPUnit\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rules([
         NamedArgumentForDataProviderRector::class,
+        MockObjectArgCreateStubToCreateMockRector::class,
         // deprecated in PHPUnit 11.5, guarded by composer package constraint
         AssertContainsOnlyMethodCallRector::class,
         AssertIsTypeMethodCallRector::class,

rules-tests/PHPUnit110/Rector/ClassMethod/MockObjectArgCreateStubToCreateMockRector/Fixture/fixture.php.inc

@@ -0,0 +1,51 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Fixture;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Source\SomeUser;
+
+final class PassedToMockObjectParam extends TestCase
+{
+    public function test()
+    {
+        $user = $this->createStub(SomeUser::class);
+        $this->prepareUserMock($user);
+    }
+
+    private function prepareUserMock(MockObject $user): void
+    {
+        $user->expects($this->once())
+            ->method('getId')
+            ->willReturn(1);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Fixture;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Source\SomeUser;
+
+final class PassedToMockObjectParam extends TestCase
+{
+    public function test()
+    {
+        $user = $this->createMock(SomeUser::class);
+        $this->prepareUserMock($user);
+    }
+
+    private function prepareUserMock(MockObject $user): void
+    {
+        $user->expects($this->once())
+            ->method('getId')
+            ->willReturn(1);
+    }
+}
+
+?>

rules-tests/PHPUnit110/Rector/ClassMethod/MockObjectArgCreateStubToCreateMockRector/Fixture/intersection_docblock_param.php.inc

@@ -0,0 +1,57 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Fixture;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Source\SomeUser;
+
+final class IntersectionDocblockParam extends TestCase
+{
+    public function test()
+    {
+        $user = $this->createStub(SomeUser::class);
+        $this->prepareCommonMocks('some_event', $user);
+    }
+
+    /**
+     * @param MockObject&SomeUser $user
+     */
+    private function prepareCommonMocks(string $event, MockObject $user): void
+    {
+        $user->expects($this->once())
+            ->method('getId')
+            ->willReturn(1);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Fixture;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Source\SomeUser;
+
+final class IntersectionDocblockParam extends TestCase
+{
+    public function test()
+    {
+        $user = $this->createMock(SomeUser::class);
+        $this->prepareCommonMocks('some_event', $user);
+    }
+
+    /**
+     * @param MockObject&SomeUser $user
+     */
+    private function prepareCommonMocks(string $event, MockObject $user): void
+    {
+        $user->expects($this->once())
+            ->method('getId')
+            ->willReturn(1);
+    }
+}
+
+?>

rules-tests/PHPUnit110/Rector/ClassMethod/MockObjectArgCreateStubToCreateMockRector/Fixture/named_arg.php.inc

@@ -0,0 +1,49 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Fixture;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Source\SomeUser;
+
+final class NamedArg extends TestCase
+{
+    public function test()
+    {
+        $user = $this->createStub(SomeUser::class);
+        $this->prepareUserMock(user: $user);
+    }
+
+    private function prepareUserMock(MockObject $user): void
+    {
+        $user->expects($this->once())
+            ->method('getId');
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Fixture;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Source\SomeUser;
+
+final class NamedArg extends TestCase
+{
+    public function test()
+    {
+        $user = $this->createMock(SomeUser::class);
+        $this->prepareUserMock(user: $user);
+    }
+
+    private function prepareUserMock(MockObject $user): void
+    {
+        $user->expects($this->once())
+            ->method('getId');
+    }
+}
+
+?>

rules-tests/PHPUnit110/Rector/ClassMethod/MockObjectArgCreateStubToCreateMockRector/Fixture/skip_plain_param_type.php.inc

@@ -0,0 +1,20 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Source\SomeUser;
+
+final class SkipPlainParamType extends TestCase
+{
+    public function test()
+    {
+        $user = $this->createStub(SomeUser::class);
+        $this->useUser($user);
+    }
+
+    private function useUser(SomeUser $user): void
+    {
+        $user->getId();
+    }
+}

rules-tests/PHPUnit110/Rector/ClassMethod/MockObjectArgCreateStubToCreateMockRector/Fixture/skip_stub_only_usage.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Source\SomeUser;
+
+final class SkipStubOnlyUsage extends TestCase
+{
+    public function test()
+    {
+        $user = $this->createStub(SomeUser::class);
+        $user->method('getId')->willReturn(1);
+
+        $this->assertSame(1, $user->getId());
+    }
+}

rules-tests/PHPUnit110/Rector/ClassMethod/MockObjectArgCreateStubToCreateMockRector/MockObjectArgCreateStubToCreateMockRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class MockObjectArgCreateStubToCreateMockRectorTest 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/PHPUnit110/Rector/ClassMethod/MockObjectArgCreateStubToCreateMockRector/Source/SomeUser.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\PHPUnit110\Rector\ClassMethod\MockObjectArgCreateStubToCreateMockRector\Source;
+
+final class SomeUser
+{
+    public function getId(): int
+    {
+        return 1;
+    }
+}

rules-tests/PHPUnit110/Rector/ClassMethod/MockObjectArgCreateStubToCreateMockRector/config/configured_rule.php

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