PHPLIB-1342 Add tests on Arithmetic Expression Operators (mongodb#52)

Author: GromNaN

generator/config/expression/abs.yaml

@@ -11,3 +11,15 @@ arguments:
         name: value
         type:
             - resolvesToNumber
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/abs/#example'
+        pipeline:
+            -
+                $project:
+                    delta:
+                        $abs:
+                            $subtract:
+                                - '$startTemp'
+                                - '$endTemp'

generator/config/expression/ceil.yaml

@@ -13,3 +13,13 @@ arguments:
             - resolvesToNumber
         description: |
             If the argument resolves to a value of null or refers to a field that is missing, $ceil returns null. If the argument resolves to NaN, $ceil returns NaN.
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/ceil/#example'
+        pipeline:
+            -
+                $project:
+                    value: 1
+                    ceilingValue:
+                        $ceil: '$value'

generator/config/expression/divide.yaml

@@ -17,3 +17,15 @@ arguments:
         name: divisor
         type:
             - resolvesToNumber
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/divide/#example'
+        pipeline:
+            -
+                $project:
+                    city: 1
+                    workdays:
+                        $divide:
+                            - '$hours'
+                            - 8

generator/config/expression/exp.yaml

@@ -11,3 +11,15 @@ arguments:
         name: exponent
         type:
             - resolvesToNumber
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/exp/#example'
+        pipeline:
+            -
+                $project:
+                    effectiveRate:
+                        $subtract:
+                            -
+                                $exp: '$interestRate'
+                            - 1

generator/config/expression/floor.yaml

@@ -11,3 +11,13 @@ arguments:
         name: expression
         type:
             - resolvesToNumber
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/floor/#example'
+        pipeline:
+            -
+                $project:
+                    value: 1
+                    floorValue:
+                        $floor: '$value'

generator/config/expression/ln.yaml

@@ -14,3 +14,13 @@ arguments:
             - resolvesToNumber
         description: |
             Any valid expression as long as it resolves to a non-negative number. For more information on expressions, see Expressions.
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/ln/#example'
+        pipeline:
+            -
+                $project:
+                    x: '$year'
+                    y:
+                        $ln: '$sales'

generator/config/expression/log.yaml

@@ -19,3 +19,18 @@ arguments:
             - resolvesToNumber
         description: |
             Any valid expression as long as it resolves to a positive number greater than 1.
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/log/#example'
+        pipeline:
+            -
+                $project:
+                    bitsNeeded:
+                        $floor:
+                            $add:
+                                - 1
+                                -
+                                    $log:
+                                        - '$int'
+                                        - 2

generator/config/expression/log10.yaml

@@ -13,3 +13,15 @@ arguments:
             - resolvesToNumber
         description: |
             Any valid expression as long as it resolves to a non-negative number.
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/log10/#example'
+        pipeline:
+            -
+                $project:
+                    pH:
+                        $multiply:
+                            - -1
+                            -
+                                $log10: '$H3O'

generator/config/expression/mod.yaml

@@ -17,3 +17,14 @@ arguments:
         name: divisor
         type:
             - resolvesToNumber
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/mod/#example'
+        pipeline:
+            -
+                $project:
+                    remainder:
+                        $mod:
+                            - '$hours'
+                            - '$tasks'

generator/config/expression/multiply.yaml

@@ -15,3 +15,16 @@ arguments:
         description: |
             The arguments can be any valid expression as long as they resolve to numbers.
             Starting in MongoDB 6.1 you can optimize the $multiply operation. To improve performance, group references at the end of the argument list.
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/multiply/#example'
+        pipeline:
+            -
+                $project:
+                    date: 1
+                    item: 1
+                    total:
+                        $multiply:
+                            - '$price'
+                            - '$quantity'

generator/config/expression/pow.yaml

@@ -15,3 +15,17 @@ arguments:
         name: exponent
         type:
             - resolvesToNumber
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/pow/#example'
+        pipeline:
+            -
+                $project:
+                    variance:
+                        $pow:
+                            -
+                                # The builder renders $stdDevPop with the array form, even with a single value
+                                # $stdDevPop: '$scores.score'
+                                $stdDevPop: ['$scores.score']
+                            - 2

generator/config/expression/round.yaml

@@ -27,3 +27,14 @@ arguments:
         optional: true
         description: |
             Can be any valid expression that resolves to an integer between -20 and 100, exclusive.
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/round/#example'
+        pipeline:
+            -
+                $project:
+                    roundedValue:
+                        $round:
+                            - '$value'
+                            - 1

generator/config/expression/sqrt.yaml

@@ -13,3 +13,27 @@ arguments:
             - resolvesToNumber
         description: |
             The argument can be any valid expression as long as it resolves to a non-negative number.
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/sqrt/#example'
+        pipeline:
+            -
+                $project:
+                    distance:
+                        $sqrt:
+                            $add:
+                                -
+                                    $pow:
+                                        -
+                                            $subtract:
+                                                - '$p2.y'
+                                                - '$p1.y'
+                                        - 2
+                                -
+                                    $pow:
+                                        -
+                                            $subtract:
+                                                - '$p2.x'
+                                                - '$p1.x'
+                                        - 2

generator/config/expression/trunc.yaml

@@ -21,3 +21,14 @@ arguments:
         optional: true
         description: |
             Can be any valid expression that resolves to an integer between -20 and 100, exclusive. e.g. -20 < place < 100. Defaults to 0.
+tests:
+    -
+        name: 'Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/trunc/#example'
+        pipeline:
+            -
+                $project:
+                    truncatedValue:
+                        $trunc:
+                            - '$value'
+                            - 1

tests/Builder/Expression/AbsOperatorTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Tests\Builder\Expression;
+
+use MongoDB\Builder\Expression;
+use MongoDB\Builder\Pipeline;
+use MongoDB\Builder\Stage;
+use MongoDB\Tests\Builder\PipelineTestCase;
+
+/**
+ * Test $abs expression
+ */
+class AbsOperatorTest extends PipelineTestCase
+{
+    public function testExample(): void
+    {
+        $pipeline = new Pipeline(
+            Stage::project(
+                delta: Expression::abs(
+                    Expression::subtract(
+                        Expression::numberFieldPath('startTemp'),
+                        Expression::numberFieldPath('endTemp'),
+                    ),
+                ),
+            ),
+        );
+
+        $this->assertSamePipeline(Pipelines::AbsExample, $pipeline);
+    }
+}

tests/Builder/Expression/CeilOperatorTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Tests\Builder\Expression;
+
+use MongoDB\Builder\Expression;
+use MongoDB\Builder\Pipeline;
+use MongoDB\Builder\Stage;
+use MongoDB\Tests\Builder\PipelineTestCase;
+
+/**
+ * Test $ceil expression
+ */
+class CeilOperatorTest extends PipelineTestCase
+{
+    public function testExample(): void
+    {
+        $pipeline = new Pipeline(
+            Stage::project(
+                value: 1,
+                ceilingValue: Expression::ceil(
+                    Expression::numberFieldPath('value'),
+                ),
+            ),
+        );
+
+        $this->assertSamePipeline(Pipelines::CeilExample, $pipeline);
+    }
+}

tests/Builder/Expression/DivideOperatorTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Tests\Builder\Expression;
+
+use MongoDB\Builder\Expression;
+use MongoDB\Builder\Pipeline;
+use MongoDB\Builder\Stage;
+use MongoDB\Tests\Builder\PipelineTestCase;
+
+/**
+ * Test $divide expression
+ */
+class DivideOperatorTest extends PipelineTestCase
+{
+    public function testExample(): void
+    {
+        $pipeline = new Pipeline(
+            Stage::project(
+                city: 1,
+                workdays: Expression::divide(
+                    Expression::numberFieldPath('hours'),
+                    8,
+                ),
+            ),
+        );
+
+        $this->assertSamePipeline(Pipelines::DivideExample, $pipeline);
+    }
+}

tests/Builder/Expression/ExpOperatorTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Tests\Builder\Expression;
+
+use MongoDB\Builder\Expression;
+use MongoDB\Builder\Pipeline;
+use MongoDB\Builder\Stage;
+use MongoDB\Tests\Builder\PipelineTestCase;
+
+/**
+ * Test $exp expression
+ */
+class ExpOperatorTest extends PipelineTestCase
+{
+    public function testExample(): void
+    {
+        $pipeline = new Pipeline(
+            Stage::project(
+                effectiveRate: Expression::subtract(
+                    Expression::exp(
+                        Expression::numberFieldPath('interestRate'),
+                    ),
+                    1,
+                ),
+            ),
+        );
+
+        $this->assertSamePipeline(Pipelines::ExpExample, $pipeline);
+    }
+}

tests/Builder/Expression/FloorOperatorTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Tests\Builder\Expression;
+
+use MongoDB\Builder\Expression;
+use MongoDB\Builder\Pipeline;
+use MongoDB\Builder\Stage;
+use MongoDB\Tests\Builder\PipelineTestCase;
+
+/**
+ * Test $floor expression
+ */
+class FloorOperatorTest extends PipelineTestCase
+{
+    public function testExample(): void
+    {
+        $pipeline = new Pipeline(
+            Stage::project(
+                value: 1,
+                floorValue: Expression::floor(
+                    Expression::numberFieldPath('value'),
+                ),
+            ),
+        );
+
+        $this->assertSamePipeline(Pipelines::FloorExample, $pipeline);
+    }
+}