PHPLIB-1254 Create Yaml for all operators and stages

.gitattributes

@@ -18,12 +18,8 @@ psalm-baseline.xml export-ignore
 
 # Keep generated files from displaying in diffs by default
 # https://docs.github.com/en/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github
-/src/Builder/Aggregation.php linguist-generated=true
-/src/Builder/Aggregation/*.php linguist-generated=true
-/src/Builder/Expression.php linguist-generated=true
+/src/Builder/Accumulator/*.php linguist-generated=true
 /src/Builder/Expression/*.php linguist-generated=true
-/src/Builder/Query.php linguist-generated=true
 /src/Builder/Query/*.php linguist-generated=true
-/src/Builder/Stage.php linguist-generated=true
+/src/Builder/Projection/*.php linguist-generated=true
 /src/Builder/Stage/*.php linguist-generated=true
-/src/Builder/Stage/Stage.php linguist-generated=false

.github/workflows/benchmark.yml

@@ -5,7 +5,6 @@ on:
     branches:
       - "v*.*"
       - "master"
-      - "feature/*"
     paths-ignore:
       - "docs/**"
   push:
@@ -15,6 +14,7 @@ on:
       - "feature/*"
     paths-ignore:
       - "docs/**"
+      - "generator/**"
 
 env:
   PHP_VERSION: "8.2"

.github/workflows/tests.yml

@@ -27,8 +27,8 @@ jobs:
         os:
           - "ubuntu-20.04"
         php-version:
-          - "7.4"
-          - "8.0"
+          #- "7.4"
+          #- "8.0"
           - "8.1"
           - "8.2"
         mongodb-version:
@@ -39,27 +39,27 @@ jobs:
           - "server"
         include:
           - os: "ubuntu-20.04"
-            php-version: "8.0"
+            php-version: "8.1"
             mongodb-version: "6.0"
             driver-version: "mongodb/mongo-php-driver@master"
             topology: "replica_set"
           - os: "ubuntu-20.04"
-            php-version: "8.0"
+            php-version: "8.1"
             mongodb-version: "6.0"
             driver-version: "mongodb/mongo-php-driver@master"
             topology: "sharded_cluster"
           - os: "ubuntu-20.04"
-            php-version: "8.0"
+            php-version: "8.1"
             mongodb-version: "5.0"
             driver-version: "mongodb/mongo-php-driver@master"
             topology: "server"
           - os: "ubuntu-20.04"
-            php-version: "8.0"
+            php-version: "8.1"
             mongodb-version: "4.4"
             driver-version: "mongodb/mongo-php-driver@master"
             topology: "replica_set"
           - os: "ubuntu-20.04"
-            php-version: "8.0"
+            php-version: "8.1"
             mongodb-version: "4.4"
             driver-version: "mongodb/mongo-php-driver@master"
             topology: "sharded_cluster"

examples/aggregation-builder.php

@@ -7,15 +7,17 @@
 
 namespace MongoDB\Examples\AggregationBuilder;
 
-use MongoDB\Builder\Aggregation;
+use MongoDB\Builder\Accumulator;
 use MongoDB\Builder\BuilderEncoder;
 use MongoDB\Builder\Expression;
 use MongoDB\Builder\Pipeline;
 use MongoDB\Builder\Stage;
 use MongoDB\Client;
 
+use function array_is_list;
 use function assert;
 use function getenv;
+use function is_array;
 use function is_object;
 use function MongoDB\BSON\fromPHP;
 use function MongoDB\BSON\toRelaxedExtendedJSON;
@@ -45,35 +47,27 @@ function toJSON(object $document): string
 $pipeline = new Pipeline(
     Stage::group(
         _id: null,
-        totalCount: Aggregation::sum(1),
-        evenCount: Aggregation::sum(
-            Aggregation::mod(
-                Expression::fieldPath('randomValue'),
-                2,
-            ),
+        totalCount: Accumulator::sum(1),
+        evenCount: Accumulator::sum(
+            Expression::mod(Expression::numberFieldPath('randomValue'), 2),
         ),
-        oddCount: Aggregation::sum(
-            Aggregation::subtract(
+        oddCount: Accumulator::sum(
+            Expression::subtract(
                 1,
-                Aggregation::mod(
-                    Expression::fieldPath('randomValue'),
-                    2,
-                ),
+                Expression::mod(Expression::numberFieldPath('randomValue'), 2),
             ),
         ),
-        maxValue: Aggregation::max(
-            Expression::fieldPath('randomValue'),
-        ),
-        minValue: Aggregation::min(
-            Expression::fieldPath('randomValue'),
-        ),
+        maxValue: Accumulator::max(Expression::numberFieldPath('randomValue')),
+        minValue: Accumulator::min(Expression::numberfieldPath('randomValue')),
     ),
 );
 
 // @todo Accept a Pipeline instance in Collection::aggregate() and automatically encode it
 $encoder = new BuilderEncoder();
 $pipeline = $encoder->encode($pipeline);
 
+assert(is_array($pipeline) && array_is_list($pipeline));
+
 $cursor = $collection->aggregate($pipeline);
 
 foreach ($cursor as $document) {

generator/composer.json

@@ -18,6 +18,7 @@
         "mongodb/mongodb": "@dev",
         "nette/php-generator": "^4",
         "symfony/console": "^6.3",
+        "symfony/finder": "^6.3",
         "symfony/yaml": "^6.3"
     },
     "license": "Apache-2.0",

generator/config/accumulator/accumulator.yaml

@@ -0,0 +1,55 @@
+# $schema: ../schema.json
+name: $accumulator
+
+link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/accumulator/'
+type:
+    - accumulator
+encode: object
+description: |
+    Defines a custom accumulator function.
+    New in version 4.4.
+arguments:
+    -
+        name: init
+        type:
+            - string
+        description: |
+            Function used to initialize the state. The init function receives its arguments from the initArgs array expression. You can specify the function definition as either BSON type Code or String.
+    -
+        name: initArgs
+        type:
+            - resolvesToArray
+        optional: true
+        description: |
+            Arguments passed to the init function.
+    -
+        name: accumulate
+        type:
+            - string
+        description: |
+            Function used to accumulate documents. The accumulate function receives its arguments from the current state and accumulateArgs array expression. The result of the accumulate function becomes the new state. You can specify the function definition as either BSON type Code or String.
+    -
+        name: accumulateArgs
+        type:
+            - resolvesToArray
+        description: |
+            Arguments passed to the accumulate function. You can use accumulateArgs to specify what field value(s) to pass to the accumulate function.
+    -
+        name: merge
+        type:
+            - string
+        description: |
+            Function used to merge two internal states. merge must be either a String or Code BSON type. merge returns the combined result of the two merged states. For information on when the merge function is called, see Merge Two States with $merge.
+    -
+        name: finalize
+        type:
+            - string
+        optional: true
+        description: |
+            Function used to update the result of the accumulation.
+    -
+        name: lang
+        type:
+            - string
+        description: |
+            The language used in the $accumulator code.

generator/config/accumulator/addToSet.yaml

@@ -0,0 +1,16 @@
+# $schema: ../schema.json
+name: $addToSet
+
+link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/addToSet/'
+type:
+    - accumulator
+    - window
+encode: single
+description: |
+    Returns an array of unique expression values for each group. Order of the array elements is undefined.
+    Changed in version 5.0: Available in the $setWindowFields stage.
+arguments:
+    -
+        name: expression
+        type:
+            - expression

generator/config/accumulator/avg.yaml

@@ -0,0 +1,16 @@
+# $schema: ../schema.json
+name: $avg
+
+link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/avg/'
+type:
+    - accumulator
+    - window
+encode: single
+description: |
+    Returns an average of numerical values. Ignores non-numeric values.
+    Changed in version 5.0: Available in the $setWindowFields stage.
+arguments:
+    -
+        name: expression
+        type:
+            - resolvesToNumber

generator/config/accumulator/bottom.yaml

@@ -0,0 +1,24 @@
+# $schema: ../schema.json
+name: $bottom
+
+link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/bottom/'
+type:
+    - accumulator
+    - window
+encode: object
+description: |
+    Returns the bottom element within a group according to the specified sort order.
+    New in version 5.2: Available in the $group and $setWindowFields stages.
+arguments:
+    -
+        name: sortBy
+        type:
+            - object # SortSpec
+        description: |
+            Specifies the order of results, with syntax similar to $sort.
+    -
+        name: output
+        type:
+            - expression
+        description: |
+            Represents the output for each element in the group and can be any expression.

generator/config/accumulator/bottomN.yaml

@@ -0,0 +1,31 @@
+# $schema: ../schema.json
+name: $bottomN
+
+link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/bottomN/'
+type:
+    - accumulator
+    - window
+encode: object
+description: |
+    Returns an aggregation of the bottom n elements within a group, according to the specified sort order. If the group contains fewer than n elements, $bottomN returns all elements in the group.
+    New in version 5.2.
+    Available in the $group and $setWindowFields stages.
+arguments:
+    -
+        name: 'n'
+        type:
+            - resolvesToInt
+        description: |
+            Limits the number of results per group and has to be a positive integral expression that is either a constant or depends on the _id value for $group.
+    -
+        name: sortBy
+        type:
+            - object # SortSpec
+        description: |
+            Specifies the order of results, with syntax similar to $sort.
+    -
+        name: output
+        type:
+            - expression
+        description: |
+            Represents the output for each element in the group and can be any expression.

generator/config/accumulator/count.yaml

@@ -0,0 +1,12 @@
+# $schema: ../schema.json
+name: $count
+
+link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/count-accumulator/'
+type:
+    - accumulator
+    - window
+encode: object
+description: |
+    Returns the number of documents in the group or window.
+    Distinct from the $count pipeline stage.
+    New in version 5.0.

generator/config/accumulator/covariancePop.yaml

@@ -0,0 +1,19 @@
+# $schema: ../schema.json
+name: $covariancePop
+
+link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/covariancePop/'
+type:
+    - window
+encode: array
+description: |
+    Returns the population covariance of two numeric expressions.
+    New in version 5.0.
+arguments:
+    -
+        name: expression1
+        type:
+            - resolvesToNumber
+    -
+        name: expression2
+        type:
+            - resolvesToNumber

generator/config/accumulator/covarianceSamp.yaml

@@ -0,0 +1,19 @@
+# $schema: ../schema.json
+name: $covarianceSamp
+
+link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/covarianceSamp/'
+type:
+    - window
+encode: array
+description: |
+    Returns the sample covariance of two numeric expressions.
+    New in version 5.0.
+arguments:
+    -
+        name: expression1
+        type:
+            - resolvesToNumber
+    -
+        name: expression2
+        type:
+            - resolvesToNumber

generator/config/accumulator/denseRank.yaml

@@ -0,0 +1,10 @@
+# $schema: ../schema.json
+name: $denseRank
+
+link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/denseRank/'
+type:
+    - window
+encode: object
+description: |
+    Returns the document position (known as the rank) relative to other documents in the $setWindowFields stage partition. There are no gaps in the ranks. Ties receive the same rank.
+    New in version 5.0.