PHPLIB-1269 Update $sort stage to accept variadic object

GromNaN · GromNaN · commit a4eff1dda83a · 2024-02-02T15:03:30.000+01:00
diff --git a/generator/config/query/text.yaml b/generator/config/query/text.yaml
@@ -102,6 +102,8 @@ tests:
                     $text:
                         $search: 'CAFÉ'
                         $diacriticSensitive: true
+            -
+                $project:
                     score:
                         $meta: 'textScore'
             -
diff --git a/generator/config/stage/sort.yaml b/generator/config/stage/sort.yaml
@@ -10,7 +10,8 @@ arguments:
     -
         name: sort
         type:
-            - object # SortSpec
+            - expression
+        variadic: object
 tests:
     -
         name: 'Ascending Descending Sort'
diff --git a/src/Builder/Stage/FactoryTrait.php b/src/Builder/Stage/FactoryTrait.php
diff --git a/src/Builder/Stage/SortStage.php b/src/Builder/Stage/SortStage.php
diff --git a/tests/Builder/Accumulator/FirstAccumulatorTest.php b/tests/Builder/Accumulator/FirstAccumulatorTest.php
@@ -20,10 +20,10 @@ class FirstAccumulatorTest extends PipelineTestCase
     public function testUseInGroupStage(): void
     {
         $pipeline = new Pipeline(
-            Stage::sort(object(
+            Stage::sort(
                 item: 1,
                 date: 1,
-            )),
+            ),
             Stage::group(
                 _id: Expression::fieldPath('item'),
                 firstSale: Accumulator::first(Expression::dateFieldPath('date')),
diff --git a/tests/Builder/Accumulator/FirstNAccumulatorTest.php b/tests/Builder/Accumulator/FirstNAccumulatorTest.php
@@ -106,9 +106,7 @@ public function testUsingSortWithFirstN(): void
     {
         $pipeline = new Pipeline(
             Stage::sort(
-                object(
-                    score: -1,
-                ),
+                score: -1,
             ),
             Stage::group(
                 _id: Expression::fieldPath('gameId'),
diff --git a/tests/Builder/Accumulator/LastAccumulatorTest.php b/tests/Builder/Accumulator/LastAccumulatorTest.php
@@ -20,10 +20,10 @@ class LastAccumulatorTest extends PipelineTestCase
     public function testUseInGroupStage(): void
     {
         $pipeline = new Pipeline(
-            Stage::sort(object(
+            Stage::sort(
                 item: 1,
                 date: 1,
-            )),
+            ),
             Stage::group(
                 _id: '$item',
                 lastSalesDate: Accumulator::last(Expression::dateFieldPath('date')),
diff --git a/tests/Builder/Accumulator/LastNAccumulatorTest.php b/tests/Builder/Accumulator/LastNAccumulatorTest.php
@@ -10,8 +10,6 @@
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
-use function MongoDB\object;
-
 /**
  * Test $lastN accumulator
  */
@@ -81,9 +79,9 @@ public function testFindingTheLastThreePlayerScoresAcrossMultipleGames(): void
     public function testUsingSortWithLastN(): void
     {
         $pipeline = new Pipeline(
-            Stage::sort(object(
+            Stage::sort(
                 score: -1,
-            )),
+            ),
             Stage::group(
                 _id: Expression::fieldPath('gameId'),
                 playerId: Accumulator::lastN(
diff --git a/tests/Builder/Accumulator/PushAccumulatorTest.php b/tests/Builder/Accumulator/PushAccumulatorTest.php
@@ -21,10 +21,8 @@ public function testUseInGroupStage(): void
     {
         $pipeline = new Pipeline(
             Stage::sort(
-                object(
-                    date: 1,
-                    item: 1,
-                ),
+                date: 1,
+                item: 1,
             ),
             Stage::group(
                 _id: object(
diff --git a/tests/Builder/BuilderEncoderTest.php b/tests/Builder/BuilderEncoderTest.php
@@ -98,7 +98,7 @@ public function testMatchNumericFieldName(): void
     public function testSort(): void
     {
         $pipeline = new Pipeline(
-            Stage::sort(object(age: -1, posts: 1)),
+            Stage::sort(age: -1, posts: 1),
         );
 
         $expected = [
diff --git a/tests/Builder/Expression/BsonSizeOperatorTest.php b/tests/Builder/Expression/BsonSizeOperatorTest.php
@@ -10,8 +10,6 @@
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
-use function MongoDB\object;
-
 /**
  * Test $bsonSize expression
  */
@@ -43,7 +41,7 @@ public function testReturnDocumentWithLargestSpecifiedField(): void
                 ),
             ),
             Stage::sort(
-                object(task_object_size: -1),
+                task_object_size: -1,
             ),
             Stage::limit(1),
         );
diff --git a/tests/Builder/Expression/SplitOperatorTest.php b/tests/Builder/Expression/SplitOperatorTest.php
@@ -43,9 +43,7 @@ public function testExample(): void
                 ),
             ),
             Stage::sort(
-                object(
-                    total_qty: -1,
-                ),
+                total_qty: -1,
             ),
         );
 
diff --git a/tests/Builder/Expression/ToDateOperatorTest.php b/tests/Builder/Expression/ToDateOperatorTest.php
@@ -9,8 +9,6 @@
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
-use function MongoDB\object;
-
 /**
  * Test $toDate expression
  */
@@ -25,9 +23,7 @@ public function testExample(): void
                 ),
             ),
             Stage::sort(
-                object(
-                    convertedDate: 1,
-                ),
+                convertedDate: 1,
             ),
         );
 
diff --git a/tests/Builder/Expression/ToLongOperatorTest.php b/tests/Builder/Expression/ToLongOperatorTest.php
@@ -9,8 +9,6 @@
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
-use function MongoDB\object;
-
 /**
  * Test $toLong expression
  */
@@ -25,9 +23,7 @@ public function testExample(): void
                 ),
             ),
             Stage::sort(
-                object(
-                    convertedQty: -1,
-                ),
+                convertedQty: -1,
             ),
         );
 
diff --git a/tests/Builder/Expression/ToObjectIdOperatorTest.php b/tests/Builder/Expression/ToObjectIdOperatorTest.php
@@ -9,8 +9,6 @@
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
-use function MongoDB\object;
-
 /**
  * Test $toObjectId expression
  */
@@ -25,9 +23,7 @@ public function testExample(): void
                 ),
             ),
             Stage::sort(
-                object(
-                    convertedId: -1,
-                ),
+                convertedId: -1,
             ),
         );
 
diff --git a/tests/Builder/Expression/ToStringOperatorTest.php b/tests/Builder/Expression/ToStringOperatorTest.php
@@ -9,8 +9,6 @@
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
-use function MongoDB\object;
-
 /**
  * Test $toString expression
  */
@@ -25,9 +23,7 @@ public function testExample(): void
                 ),
             ),
             Stage::sort(
-                object(
-                    convertedZipCode: 1,
-                ),
+                convertedZipCode: 1,
             ),
         );
 
diff --git a/tests/Builder/Query/Pipelines.php b/tests/Builder/Query/Pipelines.php
diff --git a/tests/Builder/Query/TextOperatorTest.php b/tests/Builder/Query/TextOperatorTest.php
@@ -4,6 +4,7 @@
 
 namespace MongoDB\Tests\Builder\Query;
 
+use MongoDB\Builder\Expression;
 use MongoDB\Builder\Pipeline;
 use MongoDB\Builder\Query;
 use MongoDB\Builder\Stage;
@@ -97,20 +98,18 @@ public function testSearchForASingleWord(): void
 
     public function testTextSearchScoreExamples(): void
     {
-        /**
-         * @todo: add support for $meta: "textScore"
-         * @todo: add support for $sort spec with object
-         */
         $pipeline = new Pipeline(
             Stage::match(
                 Query::text(
                     search: 'CAFÉ',
                     diacriticSensitive: true,
                 ),
-                score: ['$meta' => 'textScore'],
+            ),
+            Stage::project(
+                score: Expression::meta('textScore'),
             ),
             Stage::sort(
-                ['score' => ['$meta' => 'textScore']],
+                score: Expression::meta('textScore'),
             ),
             Stage::limit(5),
         );
diff --git a/tests/Builder/Stage/GroupStageTest.php b/tests/Builder/Stage/GroupStageTest.php
@@ -13,8 +13,6 @@
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
-use function MongoDB\object;
-
 /**
  * Test $group stage
  */
@@ -43,9 +41,7 @@ public function testCalculateCountSumAndAverage(): void
                 count: Accumulator::sum(1),
             ),
             Stage::sort(
-                object(
-                    totalSaleAmount: -1,
-                ),
+                totalSaleAmount: -1,
             ),
         );
 
diff --git a/tests/Builder/Stage/SortStageTest.php b/tests/Builder/Stage/SortStageTest.php
@@ -4,13 +4,12 @@
 
 namespace MongoDB\Tests\Builder\Stage;
 
+use MongoDB\Builder\Expression;
 use MongoDB\Builder\Pipeline;
 use MongoDB\Builder\Query;
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
-use function MongoDB\object;
-
 /**
  * Test $sort stage
  */
@@ -20,10 +19,8 @@ public function testAscendingDescendingSort(): void
     {
         $pipeline = new Pipeline(
             Stage::sort(
-                object(
-                    age: -1,
-                    posts: 1,
-                ),
+                age: -1,
+                posts: 1,
             ),
         );
 
@@ -37,10 +34,8 @@ public function testTextScoreMetadataSort(): void
                 Query::text('operating'),
             ),
             Stage::sort(
-                object(
-                    score: ['$meta' => 'textScore'],
-                    posts: -1,
-                ),
+                score: Expression::meta('textScore'),
+                posts: -1,
             ),
         );
 
diff --git a/tests/Builder/Stage/UnionWithStageTest.php b/tests/Builder/Stage/UnionWithStageTest.php
diff --git a/tests/Builder/Stage/UnwindStageTest.php b/tests/Builder/Stage/UnwindStageTest.php

Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,8 @@ tests:`
`102`	`102`	`$text:`
`103`	`103`	`$search: 'CAFÉ'`
`104`	`104`	`$diacriticSensitive: true`
	`105`	`+ -`
	`106`	`+ $project:`
`105`	`107`	`score:`
`106`	`108`	`$meta: 'textScore'`
`107`	`109`	`-`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,8 @@ arguments:`
`10`	`10`	`-`
`11`	`11`	`name: sort`
`12`	`12`	`type:`
`13`		`- - object # SortSpec`
	`13`	`+ - expression`
	`14`	`+ variadic: object`
`14`	`15`	`tests:`
`15`	`16`	`-`
`16`	`17`	`name: 'Ascending Descending Sort'`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ public function testMatchNumericFieldName(): void`
`98`	`98`	`public function testSort(): void`
`99`	`99`	`{`
`100`	`100`	`$pipeline = new Pipeline(`
`101`		`- Stage::sort(object(age: -1, posts: 1)),`
	`101`	`+ Stage::sort(age: -1, posts: 1),`
`102`	`102`	`);`
`103`	`103`
`104`	`104`	`$expected = [`