Skip to content

Commit 55416f5

Browse files
simonschaufisimonschaufi
committed
[dbal 3.8] Add MigrateQueryBuilderResetQueryPartRector
Resolves: #453
1 parent 0231850 commit 55416f5

File tree

7 files changed

+232
-0
lines changed

7 files changed

+232
-0
lines changed

‎config/sets/doctrine-dbal-38.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Config\RectorConfig;
6+
use Rector\Doctrine\Dbal36\Rector\MethodCall\MigrateQueryBuilderResetQueryPartRector;
7+
8+
# https://github.com/doctrine/dbal/blob/master/UPGRADE.md#bc-break-changes-in-handling-string-and-binary-columns
9+
return static function (RectorConfig $rectorConfig): void {
10+
# https://github.com/doctrine/dbal/blob/4.2.x/UPGRADE.md#deprecated-getting-query-parts-from-querybuilder
11+
$rectorConfig->rule(MigrateQueryBuilderResetQueryPartRector::class);
12+
};

‎rules-tests/Dbal36/Rector/MethodCall/MigrateQueryBuilderResetQueryPartRector/Fixture/fixture.php.inc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<?php
2+
3+
namespace Rector\Doctrine\Tests\Dbal36\Rector\MethodCall\MigrateQueryBuilderResetQueryPartRector\Fixture;
4+
5+
use Doctrine\DBAL\Connection;
6+
use Doctrine\DBAL\Driver\SQLite3\Driver;
7+
use Doctrine\DBAL\Query\QueryBuilder;
8+
9+
final class SomeRepository
10+
{
11+
public function getQueryPart()
12+
{
13+
$connection = new Connection([], new Driver());
14+
$queryBuilder = new QueryBuilder($connection);
15+
$queryBuilder->resetQueryPart('distinct');
16+
$queryBuilder->resetQueryPart('where');
17+
$queryBuilder->resetQueryPart('groupBy');
18+
$queryBuilder->resetQueryPart('having');
19+
$queryBuilder->resetQueryPart('orderBy');
20+
21+
$queryBuilder->resetQueryPart('select');
22+
$queryBuilder->resetQueryPart('values');
23+
}
24+
}
25+
26+
?>
27+
-----
28+
<?php
29+
30+
namespace Rector\Doctrine\Tests\Dbal36\Rector\MethodCall\MigrateQueryBuilderResetQueryPartRector\Fixture;
31+
32+
use Doctrine\DBAL\Connection;
33+
use Doctrine\DBAL\Driver\SQLite3\Driver;
34+
use Doctrine\DBAL\Query\QueryBuilder;
35+
36+
final class SomeRepository
37+
{
38+
public function getQueryPart()
39+
{
40+
$connection = new Connection([], new Driver());
41+
$queryBuilder = new QueryBuilder($connection);
42+
$queryBuilder->distinct(false);
43+
$queryBuilder->resetWhere();
44+
$queryBuilder->resetGroupBy();
45+
$queryBuilder->resetHaving();
46+
$queryBuilder->resetOrderBy();
47+
48+
$queryBuilder->resetQueryPart('select');
49+
$queryBuilder->resetQueryPart('values');
50+
}
51+
}
52+
53+
?>

‎rules-tests/Dbal36/Rector/MethodCall/MigrateQueryBuilderResetQueryPartRector/MigrateQueryBuilderResetQueryPartRectorTest.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\Doctrine\Tests\Dbal36\Rector\MethodCall\MigrateQueryBuilderResetQueryPartRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class MigrateQueryBuilderResetQueryPartRectorTest 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/Dbal36/Rector/MethodCall/MigrateQueryBuilderResetQueryPartRector/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\Doctrine\Dbal36\Rector\MethodCall\MigrateQueryBuilderResetQueryPartRector;
7+
8+
return static function (RectorConfig $rectorConfig): void {
9+
$rectorConfig->rule(MigrateQueryBuilderResetQueryPartRector::class);
10+
};

‎rules/Dbal36/Rector/MethodCall/MigrateQueryBuilderResetQueryPartRector.php

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Doctrine\Dbal36\Rector\MethodCall;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Expr\MethodCall;
9+
use PhpParser\Node\Identifier;
10+
use PhpParser\Node\Scalar\String_;
11+
use PHPStan\Type\ObjectType;
12+
use Rector\Rector\AbstractRector;
13+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
14+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
15+
16+
/**
17+
* @see https://github.com/doctrine/dbal/blob/4.2.x/UPGRADE.md#deprecated-getting-query-parts-from-querybuilder
18+
* @see \Rector\Doctrine\Tests\Dbal36\Rector\MethodCall\MigrateQueryBuilderResetQueryPartRector\MigrateQueryBuilderResetQueryPartRectorTest
19+
*/
20+
final class MigrateQueryBuilderResetQueryPartRector extends AbstractRector
21+
{
22+
/**
23+
* @var array<string, string>
24+
*/
25+
private const PART_TO_METHOD_MAP = [
26+
'where' => 'resetWhere',
27+
'groupBy' => 'resetGroupBy',
28+
'having' => 'resetHaving',
29+
'orderBy' => 'resetOrderBy',
30+
];
31+
32+
/**
33+
* @return array<class-string<Node>>
34+
*/
35+
public function getNodeTypes(): array
36+
{
37+
return [MethodCall::class];
38+
}
39+
40+
public function getRuleDefinition(): RuleDefinition
41+
{
42+
return new RuleDefinition(
43+
'Change QueryBuilder::resetQueryPart() to $queryBuilder->reset*()',
44+
[
45+
new CodeSample(
46+
<<<'CODE_SAMPLE'
47+
class SomeRepository
48+
{
49+
public function resetQueryPart(\Doctrine\DBAL\Query\QueryBuilder $queryBuilder)
50+
{
51+
$queryBuilder->resetQueryPart('distinct');
52+
$queryBuilder->resetQueryPart('where');
53+
$queryBuilder->resetQueryPart('groupBy');
54+
$queryBuilder->resetQueryPart('having');
55+
$queryBuilder->resetQueryPart('orderBy');
56+
}
57+
}
58+
CODE_SAMPLE
59+
,
60+
<<<'CODE_SAMPLE'
61+
class SomeRepository
62+
{
63+
public function resetQueryPart(\Doctrine\DBAL\Query\QueryBuilder $queryBuilder)
64+
{
65+
$queryBuilder->distinct(false);
66+
$queryBuilder->resetWhere();
67+
$queryBuilder->resetGroupBy();
68+
$queryBuilder->resetHaving();
69+
$queryBuilder->resetOrderBy();
70+
}
71+
}
72+
CODE_SAMPLE
73+
),
74+
]
75+
);
76+
}
77+
78+
/**
79+
* @param MethodCall $node
80+
*/
81+
public function refactor(Node $node): ?Node
82+
{
83+
if (! $this->isObjectType($node->var, new ObjectType('Doctrine\DBAL\Query\QueryBuilder'))) {
84+
return null;
85+
}
86+
87+
if (! $this->isName($node->name, 'resetQueryPart')) {
88+
return null;
89+
}
90+
91+
$args = $node->args;
92+
if (! isset($args[0])) {
93+
return null;
94+
}
95+
96+
$argValue = $args[0]->value;
97+
if (! $argValue instanceof String_) {
98+
return null;
99+
}
100+
101+
$queryPartName = $argValue->value;
102+
if ($queryPartName === 'distinct') {
103+
$node->name = new Identifier('distinct');
104+
$node->args = [$this->nodeFactory->createArg($this->nodeFactory->createFalse())];
105+
return $node;
106+
}
107+
108+
if (isset(self::PART_TO_METHOD_MAP[$queryPartName])) {
109+
$newMethodName = self::PART_TO_METHOD_MAP[$queryPartName];
110+
$node->name = new Identifier($newMethodName);
111+
$node->args = [];
112+
return $node;
113+
}
114+
115+
return null;
116+
}
117+
}

‎src/Set/DoctrineSetList.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ final class DoctrineSetList
4848
*/
4949
public const DOCTRINE_DBAL_30 = __DIR__ . '/../../config/sets/doctrine-dbal-30.php';
5050

51+
/**
52+
* @deprecated Use withComposerBased() instead, see https://getrector.com/blog/introducing-composer-version-based-sets
53+
* @var string
54+
*/
55+
public const DOCTRINE_DBAL_38 = __DIR__ . '/../../config/sets/doctrine-dbal-38.php';
56+
5157
/**
5258
* @deprecated Use withComposerBased() instead, see https://getrector.com/blog/introducing-composer-version-based-sets
5359
* @var string

‎src/Set/SetProvider/DoctrineSetProvider.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,12 @@ public function provide(): array
5757
'3.0',
5858
__DIR__ . '/../../../config/sets/doctrine-dbal-30.php',
5959
),
60+
new ComposerTriggeredSet(
61+
SetGroup::DOCTRINE,
62+
'doctrine/dbal',
63+
'3.8',
64+
__DIR__ . '/../../../config/sets/doctrine-dbal-38.php',
65+
),
6066
new ComposerTriggeredSet(
6167
SetGroup::DOCTRINE,
6268
'doctrine/dbal',

0 commit comments

Comments
 (0)