Skip to content

Commit 0360089

Browse files
TomasVotrubaTomasVotruba
committed
[code-quality] Add ConfiguredMockEntityToSetterObjectRector
1 parent 887abad commit 0360089

File tree

9 files changed

+324
-0
lines changed

9 files changed

+324
-0
lines changed

‎config/sets/phpunit-code-quality.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,9 @@
125125
SimplerWithIsInstanceOfRector::class,
126126
DirectInstanceOverMockArgRector::class,
127127

128+
// @test first, enable later
129+
// \Rector\PHPUnit\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector::class,
130+
128131
FinalizeTestCaseClassRector::class,
129132
DeclareStrictTypesTestsRector::class,
130133
WithCallbackIdenticalToStandaloneAssertsRector::class,

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class ConfiguredMockEntityToSetterObjectRectorTest extends AbstractRectorTestCase
12+
{
13+
#[DataProvider('provideData')]
14+
public function test(string $filePath): void
15+
{
16+
$this->doTestFile($filePath);
17+
}
18+
19+
public static function provideData(): Iterator
20+
{
21+
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
22+
}
23+
24+
public function provideConfigFilePath(): string
25+
{
26+
return __DIR__ . '/config/configured_rule.php';
27+
}
28+
}

‎rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/fixture.php.inc‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Fixture;
4+
5+
use Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source\SomeEntityToBeConfigured;
6+
7+
final class SomeTest extends \PHPUnit\Framework\TestCase
8+
{
9+
public function test()
10+
{
11+
$mockObject = $this->createConfiguredMock(SomeEntityToBeConfigured::class, [
12+
'getName'=> 'John',
13+
]);
14+
}
15+
}
16+
17+
?>
18+
-----
19+
<?php
20+
21+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Fixture;
22+
23+
use Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source\SomeEntityToBeConfigured;
24+
25+
final class SomeTest extends \PHPUnit\Framework\TestCase
26+
{
27+
public function test()
28+
{
29+
$mockObject = new \Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source\SomeEntityToBeConfigured();
30+
$mockObject->setName('John');
31+
}
32+
}
33+
34+
?>

‎rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/skip_non_entity.php.inc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Fixture;
4+
5+
use Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source\SomeObjectToBeConfigured;
6+
7+
final class SkipNonEntity extends \PHPUnit\Framework\TestCase
8+
{
9+
public function test()
10+
{
11+
$mockObject = $this->createConfiguredMock(SomeObjectToBeConfigured::class, [
12+
'getName'=> 'John',
13+
]);
14+
}
15+
}

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source;
4+
5+
use Doctrine\ORM\Mapping as ORM;
6+
7+
#[ORM\Entity()]
8+
class SomeEntityToBeConfigured
9+
{
10+
private string $name = '';
11+
12+
public function setName($name)
13+
{
14+
$this->name = $name;
15+
}
16+
17+
public function getName(): string
18+
{
19+
return $this->name;
20+
}
21+
}

‎rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/SomeObjectToBeConfigured.php‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\Source;
4+
5+
final class SomeObjectToBeConfigured
6+
{
7+
private string $name = '';
8+
9+
public function setName($name)
10+
{
11+
$this->name = $name;
12+
}
13+
14+
public function getName(): string
15+
{
16+
return $this->name;
17+
}
18+
}

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Config\RectorConfig;
6+
use Rector\PHPUnit\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector;
7+
8+
return static function (RectorConfig $rectorConfig): void {
9+
$rectorConfig->rule(ConfiguredMockEntityToSetterObjectRector::class);
10+
};

‎rules/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector.php‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\CodeQuality\Rector\Expression;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Arg;
9+
use PhpParser\Node\Expr;
10+
use PhpParser\Node\Expr\Array_;
11+
use PhpParser\Node\Expr\Assign;
12+
use PhpParser\Node\Expr\MethodCall;
13+
use PhpParser\Node\Expr\New_;
14+
use PhpParser\Node\Name\FullyQualified;
15+
use PhpParser\Node\Stmt\Expression;
16+
use PHPStan\Reflection\ReflectionProvider;
17+
use Rector\Doctrine\NodeAnalyzer\DoctrineEntityDetector;
18+
use Rector\PhpParser\AstResolver;
19+
use Rector\PhpParser\Node\Value\ValueResolver;
20+
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
21+
use Rector\Rector\AbstractRector;
22+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
23+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
24+
25+
/**
26+
* @see \Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\ConfiguredMockEntityToSetterObjectRectorTest
27+
*/
28+
final class ConfiguredMockEntityToSetterObjectRector extends AbstractRector
29+
{
30+
public function __construct(
31+
private readonly ReflectionProvider $reflectionProvider,
32+
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
33+
private readonly ValueResolver $valueResolver,
34+
private readonly AstResolver $astResolver,
35+
private readonly DoctrineEntityDetector $doctrineEntityDetector,
36+
) {
37+
}
38+
39+
public function getRuleDefinition(): RuleDefinition
40+
{
41+
return new RuleDefinition(
42+
'Change createConfigureMock() on Entity/Document object to direct new instance with setters',
43+
[
44+
new CodeSample(
45+
<<<'CODE_SAMPLE'
46+
use PHPUnit\Framework\TestCase;
47+
48+
final class SomeTest extends TestClass
49+
{
50+
public function test()
51+
{
52+
$someObject = $this->createConfiguredMock(SomeObject::class, [
53+
'name' => 'John',
54+
'surname' => 'Doe',
55+
]);
56+
}
57+
}
58+
CODE_SAMPLE
59+
,
60+
<<<'CODE_SAMPLE'
61+
use PHPUnit\Framework\TestCase;
62+
63+
final class SomeTest extends TestClass
64+
{
65+
public function test()
66+
{
67+
$someObject = new SomeObject();
68+
$someObject->setName('John');
69+
$someObject->setSurname('Doe');
70+
}
71+
}
72+
CODE_SAMPLE
73+
),
74+
]
75+
);
76+
}
77+
78+
/**
79+
* @return array<class-string<Node>>
80+
*/
81+
public function getNodeTypes(): array
82+
{
83+
return [Expression::class];
84+
}
85+
86+
/**
87+
* @param Expression $node
88+
* @return Expression[]|null
89+
*/
90+
public function refactor(Node $node): ?array
91+
{
92+
if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
93+
return null;
94+
}
95+
96+
if (! $node->expr instanceof Assign) {
97+
return null;
98+
}
99+
100+
$assign = $node->expr;
101+
if (! $assign->expr instanceof MethodCall) {
102+
return null;
103+
}
104+
105+
$objectVariable = $assign->var;
106+
107+
$methodCall = $assign->expr;
108+
if (! $this->isName($methodCall->name, 'createConfiguredMock')) {
109+
return null;
110+
}
111+
112+
if ($methodCall->isFirstClassCallable()) {
113+
return null;
114+
}
115+
116+
$mockedClassArg = $methodCall->getArgs()[0];
117+
118+
$doctrineClass = $this->matchDoctrineClassName($mockedClassArg->value);
119+
if (! is_string($doctrineClass)) {
120+
return null;
121+
}
122+
123+
$definedGettersArg = $methodCall->getArgs()[1];
124+
if (! $definedGettersArg->value instanceof Array_) {
125+
return null;
126+
}
127+
128+
$assign->expr = new New_(new FullyQualified($doctrineClass));
129+
130+
$setterExpressions = $this->createEntitySetterExpressions($definedGettersArg->value, $objectVariable);
131+
132+
return array_merge([$node], $setterExpressions);
133+
}
134+
135+
/**
136+
* @return Expression[]
137+
*/
138+
private function createEntitySetterExpressions(Array_ $definedGettersArray, Expr $objectVariable): array
139+
{
140+
$setterExpressions = [];
141+
142+
foreach ($definedGettersArray->items as $arrayItem) {
143+
if (! $arrayItem->key instanceof Expr) {
144+
continue;
145+
}
146+
147+
$getterName = $this->valueResolver->getValue($arrayItem->key);
148+
if (! is_string($getterName)) {
149+
continue;
150+
}
151+
152+
// remove "get" prefix
153+
if (! str_starts_with($getterName, 'get')) {
154+
continue;
155+
}
156+
157+
$setterName = 'set' . substr($getterName, 3);
158+
159+
$setterMethodCall = new MethodCall($objectVariable, $setterName, [new Arg($arrayItem->value)]);
160+
$setterExpressions[] = new Expression($setterMethodCall);
161+
}
162+
return $setterExpressions;
163+
}
164+
165+
private function matchDoctrineClassName(Expr $expr): string|null
166+
{
167+
$mockedClassValue = $this->valueResolver->getValue($expr);
168+
if (! is_string($mockedClassValue)) {
169+
return null;
170+
}
171+
172+
if (! $this->reflectionProvider->hasClass($mockedClassValue)) {
173+
return null;
174+
}
175+
176+
$mockedClass = $this->astResolver->resolveClassFromName($mockedClassValue);
177+
if (! $this->doctrineEntityDetector->detect($mockedClass)) {
178+
return null;
179+
}
180+
181+
return $mockedClassValue;
182+
}
183+
}

‎stubs/Doctrine/ORM/Mapping/Entity.php‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?php
2+
3+
namespace Doctrine\ORM\Mapping;
4+
5+
/**
6+
* @Annotation
7+
*/
8+
#[\Attribute]
9+
class Entity
10+
{
11+
12+
}

0 commit comments

Comments
 (0)