[CodeQuality] Add AddStubIntersectionVarToStubPropertyRector (#700)

* [CodeQuality] Skip AddIntersectionVarToMockObjectPropertyRector when @var already has intersection type

* [CodeQuality] Add AddStubIntersectionVarToStubPropertyRector

Add @var Stub&MockedClass intersection docblock to a bare native Stub property whose setUp() assigns createStub(). Generalize MockObjectPropertyDetector to be parametric on class name + create method, shared by both mock and stub rules.

* [CodeQuality] Support self::createStub()/createMock() static calls in intersection @var rules

Generalize MockObjectPropertyDetector to collect both $this->create*() (MethodCall) and self::create*() (StaticCall). Widen both rules' class resolvers accordingly. Add static-call fixtures.

* [CodeQuality] Cover overwriting existing single @var to Stub intersection

* [CodeQuality] Fix PHPStan: widen MethodCall|StaticCall param in RemoveNeverUsedMockPropertyRector

* [CodeQuality] Merge BareVarToStubIntersectionRector into AddStubIntersectionVarToStubPropertyRector

Iterate all native-Stub properties: derive the stubbed class from a setUp() createStub() arg when present, else from a bare single-class @var docblock. Absorbs and removes BareVarToStubIntersectionRector. Stub-first intersection ordering.

Author: TomasVotruba

config/sets/phpunit-code-quality.php

@@ -6,6 +6,7 @@
 use Rector\PHPUnit\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\AddReturnTypeToDependedRector;
+use Rector\PHPUnit\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\InlineStubPropertyToCreateStubMethodCallRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\NarrowUnusedSetUpDefinedPropertyRector;
@@ -57,7 +58,6 @@
 use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Class_\PropertyCreateMockToCreateStubRector;
 use Rector\PHPUnit\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector;
-use Rector\PHPUnit\PHPUnit120\Rector\Property\BareVarToStubIntersectionRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Property\MockObjectVarToStubRector;
 use Rector\PHPUnit\PHPUnit60\Rector\MethodCall\GetMockBuilderGetMockToCreateMockRector;
 use Rector\PHPUnit\PHPUnit90\Rector\MethodCall\ReplaceAtMethodWithDesiredMatcherRector;
@@ -139,7 +139,7 @@
         ExpressionCreateMockToCreateStubRector::class,
         PropertyCreateMockToCreateStubRector::class,
         MockObjectVarToStubRector::class,
-        BareVarToStubIntersectionRector::class,
+        AddStubIntersectionVarToStubPropertyRector::class,
         InlineStubPropertyToCreateStubMethodCallRector::class,
 
         // @test first, enable later

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

@@ -4,11 +4,11 @@
 
 use Rector\Config\RectorConfig;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\AddIntersectionVarToMockObjectPropertyRector;
+use Rector\PHPUnit\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector;
 use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubInCoalesceArgRector;
 use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Class_\PropertyCreateMockToCreateStubRector;
 use Rector\PHPUnit\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector;
-use Rector\PHPUnit\PHPUnit120\Rector\Property\BareVarToStubIntersectionRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Property\MockObjectVarToStubRector;
 
 return static function (RectorConfig $rectorConfig): void {
@@ -19,7 +19,7 @@
         ExpressionCreateMockToCreateStubRector::class,
         PropertyCreateMockToCreateStubRector::class,
         MockObjectVarToStubRector::class,
-        BareVarToStubIntersectionRector::class,
         AddIntersectionVarToMockObjectPropertyRector::class,
+        AddStubIntersectionVarToStubPropertyRector::class,
     ]);
 };

rules-tests/CodeQuality/Rector/Class_/AddIntersectionVarToMockObjectPropertyRector/Fixture/static_call.php.inc

@@ -0,0 +1,38 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddIntersectionVarToMockObjectPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class StaticCallTest extends TestCase
+{
+    private \PHPUnit\Framework\MockObject\MockObject $someServiceMock;
+
+    protected function setUp(): void
+    {
+        $this->someServiceMock = self::createMock(\stdClass::class);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddIntersectionVarToMockObjectPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class StaticCallTest extends TestCase
+{
+    /**
+     * @var \PHPUnit\Framework\MockObject\MockObject&\stdClass
+     */
+    private \PHPUnit\Framework\MockObject\MockObject $someServiceMock;
+
+    protected function setUp(): void
+    {
+        $this->someServiceMock = self::createMock(\stdClass::class);
+    }
+}
+
+?>

…/BareVarToStubIntersectionRectorTest.php …ersectionVarToStubPropertyRectorTest.phprules-tests/PHPUnit120/Rector/Property/BareVarToStubIntersectionRector/BareVarToStubIntersectionRectorTest.php renamed to rules-tests/CodeQuality/Rector/Class_/AddStubIntersectionVarToStubPropertyRector/AddStubIntersectionVarToStubPropertyRectorTest.php rules-tests/PHPUnit120/Rector/Property/BareVarToStubIntersectionRector/BareVarToStubIntersectionRectorTest.php renamed to rules-tests/CodeQuality/Rector/Class_/AddStubIntersectionVarToStubPropertyRector/AddStubIntersectionVarToStubPropertyRectorTest.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Property\BareVarToStubIntersectionRector;
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector;
 
 use Iterator;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 
-final class BareVarToStubIntersectionRectorTest extends AbstractRectorTestCase
+final class AddStubIntersectionVarToStubPropertyRectorTest extends AbstractRectorTestCase
 {
     #[DataProvider('provideData')]
     public function test(string $filePath): void

rules-tests/CodeQuality/Rector/Class_/AddStubIntersectionVarToStubPropertyRector/Fixture/bare_var_without_setup.php.inc

@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class BareVarWithoutSetupTest extends TestCase
+{
+    /**
+     * @var FormBuilderInterface
+     */
+    private \PHPUnit\Framework\MockObject\Stub $formBuilder;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class BareVarWithoutSetupTest extends TestCase
+{
+    /**
+     * @var \PHPUnit\Framework\MockObject\Stub&FormBuilderInterface
+     */
+    private \PHPUnit\Framework\MockObject\Stub $formBuilder;
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddStubIntersectionVarToStubPropertyRector/Fixture/fixture.php.inc

@@ -0,0 +1,38 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    private \PHPUnit\Framework\MockObject\Stub $someServiceStub;
+
+    protected function setUp(): void
+    {
+        $this->someServiceStub = $this->createStub(\stdClass::class);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    /**
+     * @var \PHPUnit\Framework\MockObject\Stub&\stdClass
+     */
+    private \PHPUnit\Framework\MockObject\Stub $someServiceStub;
+
+    protected function setUp(): void
+    {
+        $this->someServiceStub = $this->createStub(\stdClass::class);
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddStubIntersectionVarToStubPropertyRector/Fixture/overwrite_existing_var.php.inc

@@ -0,0 +1,41 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class OverwriteExistingVarTest extends TestCase
+{
+    /**
+     * @var \stdClass
+     */
+    private \PHPUnit\Framework\MockObject\Stub $someServiceStub;
+
+    protected function setUp(): void
+    {
+        $this->someServiceStub = $this->createStub(\stdClass::class);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class OverwriteExistingVarTest extends TestCase
+{
+    /**
+     * @var \PHPUnit\Framework\MockObject\Stub&\stdClass
+     */
+    private \PHPUnit\Framework\MockObject\Stub $someServiceStub;
+
+    protected function setUp(): void
+    {
+        $this->someServiceStub = $this->createStub(\stdClass::class);
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddStubIntersectionVarToStubPropertyRector/Fixture/skip_existing_intersection_var.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SkipExistingIntersectionVarTest extends TestCase
+{
+    /**
+     * @var \PHPUnit\Framework\MockObject\Stub&\stdClass
+     */
+    private \PHPUnit\Framework\MockObject\Stub $someServiceStub;
+
+    protected function setUp(): void
+    {
+        $this->someServiceStub = $this->createStub(\stdClass::class);
+    }
+}

rules-tests/CodeQuality/Rector/Class_/AddStubIntersectionVarToStubPropertyRector/Fixture/skip_mock_object_property.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SkipMockObjectPropertyTest extends TestCase
+{
+    private \PHPUnit\Framework\MockObject\MockObject $someServiceMock;
+
+    protected function setUp(): void
+    {
+        $this->someServiceMock = $this->createStub(\stdClass::class);
+    }
+}

rules-tests/CodeQuality/Rector/Class_/AddStubIntersectionVarToStubPropertyRector/Fixture/skip_non_test_class.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddStubIntersectionVarToStubPropertyRector\Fixture;
+
+final class SkipNonTestClass
+{
+    private \PHPUnit\Framework\MockObject\Stub $someServiceStub;
+
+    public function setUp(): void
+    {
+        $this->someServiceStub = $this->createStub(\stdClass::class);
+    }
+}