[ORM32] add DoctrineQueryBuilderSortDirectionRector

composer.json

@@ -8,7 +8,7 @@
     },
     "require-dev": {
         "doctrine/doctrine-bundle": "^3.0",
-        "doctrine/orm": "^3.0",
+        "doctrine/orm": "^3.2",
         "symplify/easy-coding-standard": "^13.2",
         "phpstan/extension-installer": "^1.4",
         "phpstan/phpstan": "^2.2",

rules-tests/Orm32/Rector/MethodCall/DoctrineQueryBuilderSortDirectionRector/DoctrineQueryBuilderSortDirectionRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\Orm32\Rector\MethodCall\DoctrineQueryBuilderSortDirectionRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class DoctrineQueryBuilderSortDirectionRectorTest 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__ . '/configured_rule.php';
+    }
+}

rules-tests/Orm32/Rector/MethodCall/DoctrineQueryBuilderSortDirectionRector/Fixture/replace_order_by.php.inc

@@ -0,0 +1,47 @@
+<?php
+
+namespace Rector\Doctrine\Tests\Orm32\Rector\MethodCall\DoctrineQueryBuilderSortDirectionRector\Fixture;
+
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\ORM\Query\Expr;
+use Doctrine\ORM\Query\Expr\OrderBy;
+
+function modifyQuery(QueryBuilder $qb, Expr $expr)
+{
+    $qb->add(
+        'orderBy',
+        $expr->orderBy('u.status', 'ASC')
+    );
+
+    $orderBy = new OrderBy('u.createdAt', 'desc');
+    $qb->add('orderBy', $orderBy);
+
+    $ignoreMe = new OrderBy('u.id');
+    $qb->add('orderBy', $expr->orderBy('u.name'));
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\Orm32\Rector\MethodCall\DoctrineQueryBuilderSortDirectionRector\Fixture;
+
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\ORM\Query\Expr;
+use Doctrine\ORM\Query\Expr\OrderBy;
+
+function modifyQuery(QueryBuilder $qb, Expr $expr)
+{
+    $qb->add(
+        'orderBy',
+        $expr->orderBy('u.status', \SortDirection::Ascending)
+    );
+
+    $orderBy = new OrderBy('u.createdAt', \SortDirection::Descending);
+    $qb->add('orderBy', $orderBy);
+
+    $ignoreMe = new OrderBy('u.id');
+    $qb->add('orderBy', $expr->orderBy('u.name'));
+}
+
+?>

rules-tests/Orm32/Rector/MethodCall/DoctrineQueryBuilderSortDirectionRector/Fixture/replace_query_builder.php.inc

@@ -0,0 +1,65 @@
+<?php
+
+namespace Rector\Doctrine\Tests\Orm32\Rector\MethodCall\DoctrineQueryBuilderSortDirectionRector\Fixture;
+
+use Doctrine\ORM\QueryBuilder;
+
+
+function someFunction(QueryBuilder $qb)
+{
+    $qb->orderBy('e.id', 'ASC');
+    $qb->addOrderBy('e.id', \Doctrine\Common\Collections\Criteria\Criteria::ASC);
+    $qb->addOrderBy('e.id', \Doctrine\Common\Collections\Criteria\Criteria::DESC);
+    $qb
+        ->addOrderBy('e.name', \Doctrine\Common\Collections\Order::Ascending)
+        ->addOrderBy('e.name', \Doctrine\Common\Collections\Order::Descending);
+    $qb->addOrderBy('e.name', 'desc');
+    $qb->addOrderBy('e.title', 'DeSc');
+}
+
+class NotAQueryBuilder
+{
+    public function orderBy(string $field, string $dir): void
+    {
+    }
+}
+
+function ignoreNonQueryBuilder(NotAQueryBuilder $notQb)
+{
+    $notQb->orderBy('e.id', 'ASC');
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\Orm32\Rector\MethodCall\DoctrineQueryBuilderSortDirectionRector\Fixture;
+
+use Doctrine\ORM\QueryBuilder;
+
+
+function someFunction(QueryBuilder $qb)
+{
+    $qb->orderBy('e.id', \SortDirection::Ascending);
+    $qb->addOrderBy('e.id', \SortDirection::Ascending);
+    $qb->addOrderBy('e.id', \SortDirection::Descending);
+    $qb
+        ->addOrderBy('e.name', \SortDirection::Ascending)
+        ->addOrderBy('e.name', \SortDirection::Descending);
+    $qb->addOrderBy('e.name', \SortDirection::Descending);
+    $qb->addOrderBy('e.title', \SortDirection::Descending);
+}
+
+class NotAQueryBuilder
+{
+    public function orderBy(string $field, string $dir): void
+    {
+    }
+}
+
+function ignoreNonQueryBuilder(NotAQueryBuilder $notQb)
+{
+    $notQb->orderBy('e.id', 'ASC');
+}
+
+?>

rules-tests/Orm32/Rector/MethodCall/DoctrineQueryBuilderSortDirectionRector/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Doctrine\Orm32\Rector\MethodCall\DoctrineQueryBuilderSortDirectionRector;
+
+return RectorConfig::configure()
+    ->withRules([DoctrineQueryBuilderSortDirectionRector::class]);

rules/Collection22/Rector/CriteriaOrderingConstantsDeprecationRector.php

@@ -4,7 +4,6 @@
 
 namespace Rector\Doctrine\Collection22\Rector;
 
-use PHPStan\Type\IsSuperTypeOfResult;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
 use PhpParser\Node\ArrayItem;
@@ -15,6 +14,7 @@
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Name;
 use PhpParser\Node\Scalar\String_;
+use PHPStan\Type\IsSuperTypeOfResult;
 use PHPStan\Type\ObjectType;
 use Rector\Doctrine\Enum\DoctrineClass;
 use Rector\Rector\AbstractRector;

rules/Orm32/Rector/MethodCall/DoctrineQueryBuilderSortDirectionRector.php

@@ -0,0 +1,160 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Orm32\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\New_;
+use PHPStan\Type\ObjectType;
+use Rector\PhpParser\Node\Value\ValueResolver;
+use Rector\Rector\AbstractRector;
+use Rector\VersionBonding\Contract\ComposerPackageConstraintInterface;
+use Rector\VersionBonding\ValueObject\ComposerPackageConstraint;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see https://github.com/doctrine/orm/issues/11313
+ * @see \Rector\Doctrine\Tests\Orm32\Rector\MethodCall\DoctrineQueryBuilderSortDirectionRector\DoctrineQueryBuilderSortDirectionRectorTest
+ */
+final class DoctrineQueryBuilderSortDirectionRector extends AbstractRector implements ComposerPackageConstraintInterface
+{
+    public function __construct(
+        private readonly ValueResolver $valueResolver,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Replaces string sort directions with \SortDirection enum in Doctrine QueryBuilder',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+$queryBuilder->orderBy('e.id', 'ASC');
+$queryBuilder->addOrderBy('e.name', 'desc');
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+$queryBuilder->orderBy('e.id', \SortDirection::Ascending);
+$queryBuilder->addOrderBy('e.name', \SortDirection::Descending);
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    public function provideComposerPackageConstraint(): ComposerPackageConstraint
+    {
+        return new ComposerPackageConstraint('doctrine/orm', '>=3.2');
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class, New_::class];
+    }
+
+    /**
+     * @param MethodCall|New_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if ($node->isFirstClassCallable()) {
+            return null;
+        }
+
+        if ($node instanceof MethodCall) {
+            $isQueryBuilder = $this->isTargetType($node->var, 'Doctrine\ORM\QueryBuilder')
+                && $this->isNames($node->name, ['orderBy', 'addOrderBy']);
+
+            $isExpr = $this->isObjectType($node->var, new ObjectType('Doctrine\ORM\Query\Expr'))
+                && $this->isName($node->name, 'orderBy');
+
+            if (! $isQueryBuilder && ! $isExpr) {
+                return null;
+            }
+        }
+
+        if ($node instanceof New_ && ! $this->isObjectType($node->class, new ObjectType('Doctrine\ORM\Query\Expr\OrderBy'))) {
+            return null;
+        }
+
+        $args = $node->getArgs();
+
+        if (count($args) < 2) {
+            return null;
+        }
+
+        $orderArg = $args[1];
+        $orderValue = $this->resolveSortDirectionValue($orderArg->value);
+
+        if (! is_string($orderValue)) {
+            return null;
+        }
+
+        $orderValue = strtolower($orderValue);
+
+        if ($orderValue === 'asc') {
+            $orderArg->value = $this->nodeFactory->createClassConstFetch('SortDirection', 'Ascending');
+
+            return $node;
+        }
+
+        if ($orderValue === 'desc') {
+            $orderArg->value = $this->nodeFactory->createClassConstFetch('SortDirection', 'Descending');
+
+            return $node;
+        }
+
+        return null;
+    }
+
+    /**
+     * Safely checks types even when fluent method chains lose their type mid-mutation.
+     */
+    private function isTargetType(Node $node, string $className): bool
+    {
+        if ($this->isObjectType($node, new ObjectType($className))) {
+            return true;
+        }
+
+        if ($node instanceof MethodCall) {
+            return $this->isTargetType($node->var, $className);
+        }
+
+        return false;
+    }
+
+    /**
+     * Extracts a normalized 'asc' or 'desc' string from Strings, Constants
+     */
+    private function resolveSortDirectionValue(Node\Expr $expr): ?string
+    {
+        if ($expr instanceof ClassConstFetch) {
+            $constName = $this->getName($expr->name);
+
+            if (is_string($constName)) {
+                $normalized = strtolower($constName);
+                if (in_array($normalized, ['asc', 'ascending'], true)) {
+                    return 'asc';
+                }
+                if (in_array($normalized, ['desc', 'descending'], true)) {
+                    return 'desc';
+                }
+            }
+        }
+
+        $value = $this->valueResolver->getValue($expr);
+        if (is_string($value)) {
+            $normalized = strtolower($value);
+            if ($normalized === 'asc' || $normalized === 'desc') {
+                return $normalized;
+            }
+        }
+
+        return null;
+    }
+}