Refactor the OrderByKeyToClassConstRector to use the new enum only in…

… `Criteria::orderBy` method calls (#336)

* Refactor the OrderByKeyToClassConstRector to use the new enum only in Criteria::orderBy method call, and remove usage of Criteria::ASC and Criteria::DESC where not recommended

Relates to:

- doctrine/collections#389;
- doctrine/orm#11313 (comment)

* Add check for first class callable in CriteriaOrderingRector

* Refactor condition check in `CriteriaOrderingConstantsDeprecationRector`

Simplify the type-checking condition by directly verifying if the criteria object type is a super type and ensuring it returns a positive result.

* Replaced `toCodeString` with `toString` to get the class name

config/sets/doctrine-code-quality.php

@@ -9,7 +9,6 @@
 use Rector\Doctrine\CodeQuality\Rector\Property\CorrectDefaultTypesOnEntityPropertyRector;
 use Rector\Doctrine\CodeQuality\Rector\Property\ImproveDoctrineCollectionDocTypeInEntityRector;
 use Rector\Doctrine\CodeQuality\Rector\Property\MakeEntityDateTimePropertyDateTimeInterfaceRector;
-use Rector\Doctrine\CodeQuality\Rector\Property\OrderByKeyToClassConstRector;
 use Rector\Doctrine\CodeQuality\Rector\Property\TypedPropertyFromColumnTypeRector;
 use Rector\Doctrine\CodeQuality\Rector\Property\TypedPropertyFromToManyRelationTypeRector;
 use Rector\Doctrine\CodeQuality\Rector\Property\TypedPropertyFromToOneRelationTypeRector;
@@ -31,8 +30,6 @@
         TypedPropertyFromColumnTypeRector::class,
         TypedPropertyFromToOneRelationTypeRector::class,
         TypedPropertyFromToManyRelationTypeRector::class,
-
-        OrderByKeyToClassConstRector::class,
     ]);
 
     $rectorConfig->ruleWithConfiguration(AttributeKeyToClassConstFetchRector::class, [

config/sets/doctrine-collection-22.php

@@ -3,22 +3,7 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-use Rector\Renaming\Rector\ClassConstFetch\RenameClassConstFetchRector;
-use Rector\Renaming\ValueObject\RenameClassAndConstFetch;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->ruleWithConfiguration(RenameClassConstFetchRector::class, [
-        new RenameClassAndConstFetch(
-            'Doctrine\\Common\\Collections\\Criteria',
-            'ASC',
-            'Doctrine\\Common\\Collections\\Order',
-            'Ascending'
-        ),
-        new RenameClassAndConstFetch(
-            'Doctrine\\Common\\Collections\\Criteria',
-            'DESC',
-            'Doctrine\\Common\\Collections\\Order',
-            'Descending'
-        ),
-    ]);
+    $rectorConfig->rules([\Rector\Doctrine\Collection22\Rector\CriteriaOrderingConstantsDeprecationRector::class]);
 };

rules-tests/CodeQuality/Rector/Property/OrderByKeyToClassConstRector/OrderByKeyToClassConstRectorTest.php → rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/CriteriaOrderingConstantDeprecationTest.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Rector\Doctrine\Tests\CodeQuality\Rector\Property\OrderByKeyToClassConstRector;
+namespace Rector\Doctrine\Tests\Collection22\Rector\CriteriaOrderingConstantsDeprecations;
 
 use Iterator;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 
-final class OrderByKeyToClassConstRectorTest extends AbstractRectorTestCase
+final class CriteriaOrderingConstantDeprecationTest extends AbstractRectorTestCase
 {
     #[DataProvider('provideData')]
     public function test(string $filePath): void

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/criteria_aliased_to_order_mixed_content.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+use Doctrine\Common\Collections\Criteria as SomeAliasedCriteria;
+
+$crit = new SomeAliasedCriteria();
+$crit->orderBy(['param1' => \Doctrine\Common\Collections\Order::Ascending, 'param2' => SomeAliasedCriteria::DESC, 'param3' => 'asc']);
+
+?>
+-----
+<?php
+
+use Doctrine\Common\Collections\Criteria as SomeAliasedCriteria;
+
+$crit = new SomeAliasedCriteria();
+$crit->orderBy(['param1' => \Doctrine\Common\Collections\Order::Ascending, 'param2' => \Doctrine\Common\Collections\Order::Descending, 'param3' => \Doctrine\Common\Collections\Order::Ascending]);
+
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/criteria_to_order_from_constant_criteria.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$criteria = new Criteria();
+$criteria->orderBy(['asc' => Criteria::ASC, 'desc' => Criteria::DESC]);
+
+?>
+-----
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$criteria = new Criteria();
+$criteria->orderBy(['asc' => \Doctrine\Common\Collections\Order::Ascending, 'desc' => \Doctrine\Common\Collections\Order::Descending]);
+
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/criteria_to_order_from_string_lower.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$criteria = new Criteria();
+$criteria->orderBy(['asc' => 'asc', 'desc' => 'desc']);
+
+?>
+-----
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$criteria = new Criteria();
+$criteria->orderBy(['asc' => \Doctrine\Common\Collections\Order::Ascending, 'desc' => \Doctrine\Common\Collections\Order::Descending]);
+
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/criteria_to_order_from_string_upper.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$criteria = new Criteria();
+$criteria->orderBy(['asc' => 'ASC', 'desc' => 'DESC']);
+
+?>
+-----
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$criteria = new Criteria();
+$criteria->orderBy(['asc' => \Doctrine\Common\Collections\Order::Ascending, 'desc' => \Doctrine\Common\Collections\Order::Descending]);
+
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/criteria_to_order_mixed_content.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$criteria = new Criteria();
+$criteria->orderBy(['param1' => \Doctrine\Common\Collections\Order::Ascending, 'param2' => Criteria::DESC, 'param3' => 'asc']);
+
+?>
+-----
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$criteria = new Criteria();
+$criteria->orderBy(['param1' => \Doctrine\Common\Collections\Order::Ascending, 'param2' => \Doctrine\Common\Collections\Order::Descending, 'param3' => \Doctrine\Common\Collections\Order::Ascending]);
+
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/replace_class_constant_by_string_where_not_in_criteria_order_by.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$query->addOrderBy('someParameter', Criteria::ASC);
+
+?>
+-----
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$query->addOrderBy('someParameter', 'ASC');
+
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/replace_order_by_asc_lower_with_class_constant.php.inc

@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Doctrine\Tests\Collection22\Rector\CriteriaOrderingConstantsDeprecations\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+class ReplaceOrderByAscWithClassConstant
+{
+    #[ORM\OrderBy(['createdAt' => 'asc'])]
+    protected \DateTimeInterface $messages;
+}
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/replace_order_by_asc_with_class_constant.php.inc

@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Doctrine\Tests\Collection22\Rector\CriteriaOrderingConstantsDeprecations\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+class ReplaceOrderByAscWithClassConstant
+{
+    #[ORM\OrderBy(['createdAt' => 'ASC'])]
+    protected \DateTimeInterface $messages;
+}
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/replace_order_by_desc_with_class_constant.php.inc

@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Doctrine\Tests\Collection22\Rector\CriteriaOrderingConstantsDeprecations\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+class ReplaceOrderByAscWithClassConstant
+{
+    #[ORM\OrderBy(['createdAt' => 'desc'])]
+    protected \DateTimeInterface $messages;
+}
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/skip_already_using_const.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+use Doctrine\Common\Collections\Criteria;
+
+$criteria = new Criteria();
+$criteria->orderBy(['asc' => \Doctrine\Common\Collections\Order::Ascending, 'desc' => \Doctrine\Common\Collections\Order::Descending]);
+
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/skip_class_constant_ASC_where_not_related_to_criteria.php.inc

@@ -0,0 +1,7 @@
+<?php
+
+use SomeClass;
+
+$query->addOrderBy('someParameter', SomeClass::ASC);
+
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/Fixture/skip_order_by_not_on_criteria.php.inc

@@ -0,0 +1,6 @@
+<?php
+
+$object = new SomeClass();
+$object->orderBy(['someType' => 'ASC']);
+
+?>

rules-tests/Collection22/Rector/CriteriaOrderingConstantsDeprecations/config/configured_set.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Doctrine\Collection22\Rector\CriteriaOrderingConstantsDeprecationRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(CriteriaOrderingConstantsDeprecationRector::class);
+};