[code-quality] Add ConfiguredMockEntityToSetterObjectRector

Author: TomasVotruba

rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/ConfiguredMockEntityToSetterObjectRectorTest.php

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

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Fixture;
+
+use Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source\SomeEntityToBeConfigured;
+
+final class SomeTest extends \PHPUnit\Framework\TestCase
+{
+    public function test()
+    {
+        $mockObject = $this->createConfiguredMock(SomeEntityToBeConfigured::class, [
+            'getName'=> 'John',
+        ]);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Fixture;
+
+use Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source\SomeEntityToBeConfigured;
+
+final class SomeTest extends \PHPUnit\Framework\TestCase
+{
+    public function test()
+    {
+        $mockObject = new \Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source\SomeEntityToBeConfigured();
+        $mockObject->setName('John');
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/SomeEntityToBeConfigured.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source;
+
+final class SomeEntityToBeConfigured
+{
+    private string $name = '';
+
+    public function setName($name)
+    {
+        $this->name = $name;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+}

rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/config/configured_rule.php

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

rules/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector.php

@@ -0,0 +1,153 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\CodeQuality\Rector\Expression;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Expression;
+use PHPStan\Reflection\ReflectionProvider;
+use Rector\PhpParser\Node\Value\ValueResolver;
+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\Expression\ConfiguredMockEntityToSetterObjectRector\ConfiguredMockEntityToSetterObjectRectorTest
+ */
+final class ConfiguredMockEntityToSetterObjectRector extends AbstractRector
+{
+    public function __construct(
+        private readonly ReflectionProvider $reflectionProvider,
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+        private readonly ValueResolver $valueResolver,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Change createConfigureMock() on Entity/Document object to direct new instance with setters',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestClass
+{
+    public function test()
+    {
+        $someObject = $this->createConfiguredMock(SomeObject::class, [
+            'name' => 'John',
+            'surname' => 'Doe',
+        ]);
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestClass
+{
+    public function test()
+    {
+        $someObject = new SomeObject();
+        $someObject->setName('John');
+        $someObject->setSurname('Doe');
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Expression::class];
+    }
+
+    /**
+     * @param Expression $node
+     * @return Expression[]|null
+     */
+    public function refactor(Node $node): ?array
+    {
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        if (! $node->expr instanceof Node\Expr\Assign) {
+            return null;
+        }
+
+        $assign = $node->expr;
+        if (! $assign->expr instanceof MethodCall) {
+            return null;
+        }
+
+        $objectVariable = $assign->var;
+
+        $methodCall = $assign->expr;
+        if (! $this->isName($methodCall->name, 'createConfiguredMock')) {
+            return null;
+        }
+
+        if ($methodCall->isFirstClassCallable()) {
+            return null;
+        }
+
+        $mockedClassArg = $methodCall->getArgs()[0];
+        $mockedClassValue = $this->valueResolver->getValue($mockedClassArg->value);
+
+        if (! is_string($mockedClassValue)) {
+            return null;
+        }
+
+        if (! $this->reflectionProvider->hasClass($mockedClassValue)) {
+            return null;
+        }
+
+        $definedGettersArg = $methodCall->getArgs()[1];
+        if (! $definedGettersArg->value instanceof Node\Expr\Array_) {
+            return null;
+        }
+
+        $definedGettersArray = $definedGettersArg->value;
+
+        $standaloneExpressions = [$node];
+
+        $assign->expr = new New_(new FullyQualified($mockedClassValue));
+
+        foreach ($definedGettersArray->items as $arrayItem) {
+            if (! $arrayItem->key instanceof Node\Expr) {
+                continue;
+            }
+
+            $getterName = $this->valueResolver->getValue($arrayItem->key);
+            if (! is_string($getterName)) {
+                continue;
+            }
+
+            // remove "get" prefix
+            if (! str_starts_with($getterName, 'get')) {
+                continue;
+            }
+
+            $setterName = 'set' . substr($getterName, 3);
+
+            $setterMethodCall = new MethodCall($objectVariable, $setterName, [new Node\Arg($arrayItem->value)]);
+            $standaloneExpressions[] = new Expression($setterMethodCall);
+        }
+
+        return $standaloneExpressions;
+    }
+}