Skip to content

Commit

Permalink
Fix code example prefixed on CriteriaOrderingConstantsDeprecationRect…
Browse files Browse the repository at this point in the history 
…or (#341)
  • Loading branch information
@samsonasik
samsonasik authored Aug 26, 2024
1 parent a302734 commit ef84d74
Showing 1 changed file with 31 additions and 41 deletions.
72 changes: 31 additions & 41 deletions rules/Collection22/Rector/CriteriaOrderingConstantsDeprecationRector.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,14 @@
namespace Rector\Doctrine\Collection22\Rector;

use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Array_;
use PhpParser\Node\Expr\ArrayItem;
use PhpParser\Node\Expr\ClassConstFetch;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name;
use PhpParser\Node\Scalar\String_;
use PHPStan\Type\ObjectType;
use Rector\Rector\AbstractRector;
Expand All @@ -18,7 +24,7 @@
*/
final class CriteriaOrderingConstantsDeprecationRector extends AbstractRector
{
private ObjectType $criteriaObjectType;
private readonly ObjectType $criteriaObjectType;

public function __construct()
{
Expand All @@ -32,47 +38,31 @@ public function getRuleDefinition(): RuleDefinition
[
new CodeSample(
<<<'CODE_SAMPLE'
<?php
use Doctrine\Common\Collections\Criteria;
$criteria = new Criteria();
$criteria->orderBy(['someProperty' => 'ASC', 'anotherProperty' => 'DESC']);
?>
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
<?php
use Doctrine\Common\Collections\Criteria;
$criteria = new Criteria();
$criteria->orderBy(['someProperty' => \Doctrine\Common\Collections\Order::Ascending, 'anotherProperty' => \Doctrine\Common\Collections\Order::Descending]);
?>
CODE_SAMPLE
),
new CodeSample(
<<<'PHP'
<?php
<<<'CODE_SAMPLE'
use Doctrine\Common\Collections\Criteria;
$query->addOrderBy('something', Criteria::ASC);
?>
PHP
CODE_SAMPLE
,
<<<'PHP'
<?php
<<<'CODE_SAMPLE'
use Doctrine\Common\Collections\Criteria;
$query->addOrderBy('something', 'ASC');
?>
PHP
CODE_SAMPLE
,
),
]
Expand All @@ -84,32 +74,33 @@ public function getRuleDefinition(): RuleDefinition
*/
public function getNodeTypes(): array
{
return [Node\Expr\MethodCall::class, Node\Expr\ClassConstFetch::class];
return [MethodCall::class, ClassConstFetch::class];
}

/**
* @param Node\Expr\MethodCall|Node\Expr\ClassConstFetch $node
* @param MethodCall|ClassConstFetch $node
*/
public function refactor(Node $node): ?Node
{
if ($node instanceof Node\Expr\ClassConstFetch) {
if ($node instanceof ClassConstFetch) {
return $this->refactorClassConstFetch($node);
}

return $this->refactorMethodCall($node);

}

private function refactorClassConstFetch(Node\Expr\ClassConstFetch $classConstFetch): ?Node
private function refactorClassConstFetch(ClassConstFetch $classConstFetch): ?Node
{
if (! $classConstFetch->name instanceof Node\Identifier) {
if (! $classConstFetch->name instanceof Identifier) {
return null;
}

if (! in_array($classConstFetch->name->name, ['ASC', 'DESC'])) {
return null;
}

if (! $classConstFetch->class instanceof Node\Name) {
if (! $classConstFetch->class instanceof Name) {
return null;
}

Expand All @@ -125,28 +116,28 @@ private function refactorClassConstFetch(Node\Expr\ClassConstFetch $classConstFe
};
}

private function refactorMethodCall(Node\Expr\MethodCall $node): ?Node
private function refactorMethodCall(MethodCall $methodCall): ?Node
{
if (! $this->isName($node->name, 'orderBy')) {
if (! $this->isName($methodCall->name, 'orderBy')) {
return null;
}

if ($node->isFirstClassCallable()) {
if ($methodCall->isFirstClassCallable()) {
return null;
}

if (! $this->criteriaObjectType->isSuperTypeOf($this->nodeTypeResolver->getType($node->var))->yes()) {
if (! $this->criteriaObjectType->isSuperTypeOf($this->nodeTypeResolver->getType($methodCall->var))->yes()) {
return null;
}

$args = $node->getArgs();
$args = $methodCall->getArgs();

if (count($args) < 1) {
return null;
}

$arg = $args[0];
if (! $arg instanceof Node\Arg) {
if (! $arg instanceof Arg) {
return null;
}

Expand All @@ -173,11 +164,11 @@ private function refactorMethodCall(Node\Expr\MethodCall $node): ?Node
$newItems[] = $this->buildArrayItem($v, $item->key);
$nodeHasChange = true;
} elseif (
$item->value instanceof Node\Expr\ClassConstFetch
&& $item->value->class instanceof Node\Name
$item->value instanceof ClassConstFetch
&& $item->value->class instanceof Name
/* @phpstan-ignore-next-line */
&& $this->criteriaObjectType->isSuperTypeOf(new ObjectType($item->value->class->toString()))
&& $item->value->name instanceof Node\Identifier
&& $item->value->name instanceof Identifier
&& in_array($v = strtoupper((string) $item->value->name), ['ASC', 'DESC'], true)
) {
$newItems[] = $this->buildArrayItem($v, $item->key);
Expand All @@ -189,7 +180,7 @@ private function refactorMethodCall(Node\Expr\MethodCall $node): ?Node

if ($nodeHasChange) {
return $this->nodeFactory->createMethodCall(
$node->var,
$methodCall->var,
'orderBy',
$this->nodeFactory->createArgs([$this->nodeFactory->createArg(new Array_($newItems))])
);
Expand All @@ -200,18 +191,17 @@ private function refactorMethodCall(Node\Expr\MethodCall $node): ?Node

/**
* @param 'ASC'|'DESC' $direction
* @return ArrayItem
*/
private function buildArrayItem(string $direction, Node\Expr|null $key): Node\Expr\ArrayItem
private function buildArrayItem(string $direction, Expr|null $key): ArrayItem
{
$value = $this->nodeFactory->createClassConstFetch(
$classConstFetch = $this->nodeFactory->createClassConstFetch(
'Doctrine\Common\Collections\Order',
match ($direction) {
'ASC' => 'Ascending',
'DESC' => 'Descending',
}
);

return new Node\Expr\ArrayItem($value, $key);
return new ArrayItem($classConstFetch, $key);
}
}

0 comments on commit ef84d74

Please sign in to comment.