Add Expression interfaces

generator/composer.json

@@ -15,6 +15,7 @@
     "require": {
         "php": ">=8.2",
         "ext-mongodb": "*",
+        "mongodb/mongodb": "@dev",
         "nette/php-generator": "^4",
         "symfony/console": "^6.3",
         "symfony/yaml": "^6.3"

generator/config/pipeline-operators.yaml

@@ -1,33 +1,39 @@
 - name: and
+  type: resolvesToBoolExpression
   args:
     - name: expressions
       type: resolvesToExpression
       isVariadic: true
 - name: eq
+  type: resolvesToBoolExpression
   args:
     - name: expression1
       type: resolvesToExpression
     - name: expression2
       type: resolvesToExpression
 - name: gt
+  type: resolvesToBoolExpression
   args:
     - name: expression1
       type: resolvesToExpression
     - name: expression2
       type: resolvesToExpression
 - name: lt
+  type: resolvesToBoolExpression
   args:
     - name: expression1
       type: resolvesToExpression
     - name: expression2
       type: resolvesToExpression
 - name: ne
+  type: resolvesToBoolExpression
   args:
     - name: expression1
       type: resolvesToExpression
     - name: expression2
       type: resolvesToExpression
 - name: filter
+  type: resolvesToArrayExpression
   usesNamedArgs: true
   args:
     - name: input

generator/config/query-operators.yaml

@@ -1,9 +1,11 @@
 - name: and
+  type: resolvesToBoolExpression
   args:
     - name: query
       type: resolvesToQueryOperator
       isVariadic: true
 - name: expr
+  type: resolvesToExpression
   args:
     - name: expression
       type: resolvesToExpression

generator/config/stages.yaml

@@ -1,15 +1,12 @@
----
 - name: match
   args:
     - name: matchExpr
       type: resolvesToMatchExpression
       isVariadic: true
-
 - name: sort
   args:
     - name: sortSpecification
       type: resolvesToSortSpecification
-
 - name: limit
   args:
     - name: limit

generator/src/AbstractGenerator.php

@@ -16,10 +16,10 @@
 use function file_put_contents;
 use function implode;
 use function in_array;
+use function interface_exists;
 use function is_dir;
 use function mkdir;
 use function sort;
-use function str_starts_with;
 use function ucfirst;
 
 /** @internal */
@@ -32,7 +32,7 @@ abstract class AbstractGenerator
         'resolvesToBoolExpression' => [Expression\ResolvesToBoolExpression::class, 'array', 'object', 'string', 'bool'],
         'resolvesToMatchExpression' => ['array', 'object', Expression\ResolvesToMatchExpression::class],
         'resolvesToNumberExpression' => [Expression\ResolvesToBoolExpression::class, 'array', 'object', 'string', 'int', 'float'],
-        'resolvesToQueryOperator' => ['array', 'object', Expression\ResolvesToQuery::class],
+        'resolvesToQueryOperator' => ['array', 'object', Expression\ResolvesToQueryOperator::class],
         'resolvesToSortSpecification' => ['array', 'object', Expression\ResolvesToSortSpecification::class],
     ];
 
@@ -72,11 +72,10 @@ final protected function generateTypeString(ArgumentDefinition $arg): array
         $docTypes = $nativeTypes;
 
         foreach ($nativeTypes as $key => $typeName) {
-            // @todo replace with class_exists
-            if (str_starts_with($typeName, 'MongoDB\\')) {
+            if (interface_exists($typeName)) {
                 $nativeTypes[$key] = $docTypes[$key] = '\\' . $typeName;
-
                 // A union cannot contain both object and a class type, which is redundant and causes a PHP error
+                // @todo replace "object" with "stdClass" and force any class object to implement the proper interface
                 if (in_array('object', $nativeTypes, true)) {
                     unset($nativeTypes[$key]);
                 }

generator/src/Definition/OperatorDefinition.php

@@ -12,6 +12,7 @@
 
     public function __construct(
         public string $name,
+        public ?string $type = null,
         public bool $usesNamedArgs = false,
         array $args = [],
     ) {

generator/src/ValueClassGenerator.php

@@ -5,10 +5,11 @@
 
 use MongoDB\CodeGenerator\Definition\OperatorDefinition;
 use Nette\PhpGenerator\ClassType;
+use RuntimeException;
 
 use function assert;
-
-use const PHP_EOL;
+use function interface_exists;
+use function ucfirst;
 
 /**
  * Generates a value object class for stages and operators.
@@ -20,6 +21,7 @@ public function createClassForObject(object $object): ClassType
         assert($object instanceof OperatorDefinition);
 
         $class = new ClassType($this->getClassName($object));
+        $class->setImplements($this->getInterfaces($object));
 
         $constuctor = $class->addMethod('__construct');
 
@@ -51,4 +53,18 @@ public function createClassForObject(object $object): ClassType
 
         return $class;
     }
+
+    private function getInterfaces(OperatorDefinition $definition): array
+    {
+        if ($definition->type === null) {
+            return [];
+        }
+
+        $interface = 'MongoDB\\Builder\\Expression\\' . ucfirst($definition->type);
+        if (! interface_exists($interface)) {
+            throw new RuntimeException('Interface ' . $interface . ' does not exist');
+        }
+
+        return [$interface];
+    }
 }

src/Builder/Expression/ResolvesToArrayExpression.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MongoDB\Builder\Expression;
+
+interface ResolvesToArrayExpression
+{
+    public const ACCEPTED_TYPES = [self::class, 'array', 'object', 'string'];
+}

src/Builder/Expression/ResolvesToBoolExpression.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MongoDB\Builder\Expression;
+
+interface ResolvesToBoolExpression
+{
+    public const ACCEPTED_TYPES = [self::class, 'array', 'object', 'string', 'bool'];
+}

src/Builder/Expression/ResolvesToExpression.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MongoDB\Builder\Expression;
+
+interface ResolvesToExpression
+{
+    public const ACCEPTED_TYPES = [self::class, 'array', 'object', 'string', 'int', 'float', 'bool', 'null'];
+}

src/Builder/Expression/ResolvesToMatchExpression.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MongoDB\Builder\Expression;
+
+interface ResolvesToMatchExpression
+{
+    public const ACCEPTED_TYPES = [self::class, 'array', 'object'];
+}

src/Builder/Expression/ResolvesToNumberExpression.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MongoDB\Builder\Expression;
+
+interface ResolvesToNumberExpression
+{
+    public const ACCEPTED_TYPES = [self::class, 'array', 'object', 'string', 'int', 'float'];
+}

src/Builder/Expression/ResolvesToQueryOperator.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MongoDB\Builder\Expression;
+
+interface ResolvesToQueryOperator
+{
+    public const ACCEPTED_TYPES = [self::class, 'array', 'object'];
+}

src/Builder/Expression/ResolvesToSortSpecification.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MongoDB\Builder\Expression;
+
+interface ResolvesToSortSpecification
+{
+    public const ACCEPTED_TYPES = [self::class, 'array', 'object'];
+}