Add Optional::Undefined for optional values

mongodb · Oct 2, 2023 · d3e48cc · d3e48cc
1 parent cae32c0
commit d3e48cc
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 20 deletions.
diff --git a/generator/src/OperatorClassGenerator.php b/generator/src/OperatorClassGenerator.php
@@ -6,6 +6,7 @@
 use MongoDB\Builder\Stage\StageInterface;
 use MongoDB\CodeGenerator\Definition\GeneratorDefinition;
 use MongoDB\CodeGenerator\Definition\OperatorDefinition;
+use Nette\PhpGenerator\Literal;
 use Nette\PhpGenerator\PhpNamespace;
 
 use function assert;
@@ -75,7 +76,7 @@ public function createClass(GeneratorDefinition $definition, OperatorDefinition
                     PHP);
                 }
             } elseif ($argument->isOptional) {
-                $constuctorParam->setDefaultValue(null);
+                $constuctorParam->setDefaultValue(new Literal('Optional::Undefined'));
             }
 
             $constuctor->addComment('@param ' . $type->doc . ' $' . $argument->name);

diff --git a/generator/src/OperatorFactoryGenerator.php b/generator/src/OperatorFactoryGenerator.php
@@ -5,6 +5,7 @@
 
 use MongoDB\CodeGenerator\Definition\GeneratorDefinition;
 use MongoDB\CodeGenerator\Definition\OperatorDefinition;
+use Nette\PhpGenerator\Literal;
 use Nette\PhpGenerator\PhpNamespace;
 
 use function implode;
@@ -52,7 +53,7 @@ private function createFactoryClass(GeneratorDefinition $definition): PhpNamespa
                     $args[] = '...$' . $argument->name;
                 } else {
                     if ($argument->isOptional) {
-                        $parameter->setDefaultValue(null);
+                        $parameter->setDefaultValue(new Literal('Optional::Undefined'));
                     }
 
                     $method->addComment('@param ' . $type->doc . ' $' . $argument->name);

diff --git a/generator/src/OperatorGenerator.php b/generator/src/OperatorGenerator.php
@@ -4,6 +4,7 @@
 namespace MongoDB\CodeGenerator;
 
 use MongoDB\Builder\Expression\ExpressionInterface;
+use MongoDB\Builder\Optional;
 use MongoDB\CodeGenerator\Definition\ArgumentDefinition;
 use MongoDB\CodeGenerator\Definition\ExpressionDefinition;
 use MongoDB\CodeGenerator\Definition\GeneratorDefinition;
@@ -112,8 +113,9 @@ final protected function generateExpressionTypes(ArgumentDefinition $arg): objec
         }
 
         if ($arg->isOptional) {
-            $nativeTypes[] = 'null';
-            $docTypes[] = 'null';
+            $use[] = '\\' . Optional::class;
+            $docTypes[] = 'Undefined';
+            $nativeTypes[] = Optional::class;
         }
 
         // mixed can only be used as a standalone type

diff --git a/src/Builder/Aggregation.php b/src/Builder/Aggregation.php
diff --git a/src/Builder/Aggregation/FilterAggregation.php b/src/Builder/Aggregation/FilterAggregation.php
diff --git a/src/Builder/BuilderEncoder.php b/src/Builder/BuilderEncoder.php
@@ -141,8 +141,7 @@ private function encodeAsObject(ExpressionInterface|StageInterface $value): stdC
         foreach (get_object_vars($value) as $key => $val) {
             /** @var mixed $val */
             $val = $this->encodeIfSupported($val);
-            // @todo check for undefined value vs null
-            if ($val !== null) {
+            if ($val !== Optional::Undefined) {
                 $result->{$key} = $val;
             }
         }

diff --git a/src/Builder/Optional.php b/src/Builder/Optional.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace MongoDB\Builder;
+
+/**
+ * Mark an argument as undefined.
+ *
+ * @internal
+ */
+enum Optional
+{
+    case Undefined;
+}
diff --git a/tests/Builder/BuilderCodecTest.php b/tests/Builder/BuilderCodecTest.php
@@ -77,15 +77,15 @@ public function testPerformCount(): void
      * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/filter/#examples
      * @dataProvider provideAggregationFilterLimit
      */
-    public function testAggregationFilter(?int $limit, array $expectedLimit): void
+    public function testAggregationFilter(array $limit, array $expectedLimit): void
     {
         $pipeline = new Pipeline(
             Stage::project(
                 items: Aggregation::filter(
                     Expression::arrayFieldPath('items'),
                     Aggregation::gte(Expression::variable('item.price'), 100),
                     'item',
-                    $limit,
+                    ...$limit,
                 ),
             ),
         );
@@ -110,12 +110,12 @@ public function testAggregationFilter(?int $limit, array $expectedLimit): void
     public static function provideAggregationFilterLimit(): Generator
     {
         yield 'unspecified limit' => [
-            null,
+            [],
             [],
         ];
 
         yield 'int limit' => [
-            1,
+            [1],
             ['limit' => 1],
         ];
     }