PHPLIB-1381 Add dictionnary for time units

Author: GromNaN

generator/config/accumulator/derivative.yaml

@@ -16,7 +16,7 @@ arguments:
     -
         name: unit
         type:
-            - string
+            - timeUnit
         optional: true
         description: |
             A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond".

generator/config/accumulator/integral.yaml

@@ -16,7 +16,7 @@ arguments:
     -
         name: unit
         type:
-            - resolvesToString
+            - timeUnit
         optional: true
         description: |
             A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond".

generator/config/expression/dateAdd.yaml

@@ -18,7 +18,7 @@ arguments:
     -
         name: unit
         type:
-            - resolvesToString
+            - timeUnit
         description: |
             The unit used to measure the amount of time added to the startDate.
     -

generator/config/expression/dateDiff.yaml

@@ -26,7 +26,7 @@ arguments:
     -
         name: unit
         type:
-            - resolvesToString
+            - timeUnit
         description: |
             The time measurement unit between the startDate and endDate
     -

generator/config/expression/dateSubtract.yaml

@@ -18,7 +18,7 @@ arguments:
     -
         name: unit
         type:
-            - resolvesToString
+            - timeUnit
         description: |
             The unit used to measure the amount of time added to the startDate.
     -

generator/config/expression/dateTrunc.yaml

@@ -18,7 +18,7 @@ arguments:
     -
         name: unit
         type:
-            - resolvesToString
+            - timeUnit
         description: |
             The unit of time, specified as an expression that must resolve to one of these strings: year, quarter, week, month, day, hour, minute, second.
             Together, binSize and unit specify the time period used in the $dateTrunc calculation.

generator/config/expressions.php

@@ -113,6 +113,10 @@
         'returnType' => Type\GeometryInterface::class,
         'acceptedTypes' => [Type\GeometryInterface::class, ...$bsonTypes['object']],
     ],
+    'timeUnit' => [
+        'returnType' => Type\TimeUnit::class,
+        'acceptedTypes' => [Type\TimeUnit::class, ResolvesToString::class, ...$bsonTypes['string']],
+    ],
 
     // @todo add enum values
     'Granularity' => [

generator/config/schema.json

@@ -113,6 +113,7 @@
                             "expression",
                             "geometry",
                             "fieldPath",
+                            "timeUnit",
                             "any",
                             "resolvesToNumber", "numberFieldPath", "number",
                             "resolvesToDouble", "doubleFieldPath", "double",

src/Builder/Accumulator.php

@@ -8,6 +8,7 @@
 use MongoDB\BSON\Serializable;
 use MongoDB\Builder\Type\Optional;
 use MongoDB\Builder\Type\OutputWindow;
+use MongoDB\Builder\Type\TimeUnit;
 use MongoDB\Builder\Type\WindowInterface;
 use stdClass;
 
@@ -31,7 +32,7 @@ public static function outputWindow(
         Document|Serializable|WindowInterface|stdClass|array $operator,
         Optional|array $documents = Optional::Undefined,
         Optional|array $range = Optional::Undefined,
-        Optional|string $unit = Optional::Undefined,
+        Optional|TimeUnit|string $unit = Optional::Undefined,
     ): OutputWindow {
         return new OutputWindow($operator, $documents, $range, $unit);
     }

src/Builder/Accumulator/DerivativeAccumulator.php

@@ -5,6 +5,7 @@
 namespace MongoDB\Builder;
 
 use MongoDB\Builder\Encoder\CombinedFieldQueryEncoder;
+use MongoDB\Builder\Encoder\DictionaryEncoder;
 use MongoDB\Builder\Encoder\ExpressionEncoder;
 use MongoDB\Builder\Encoder\FieldPathEncoder;
 use MongoDB\Builder\Encoder\OperatorEncoder;
@@ -14,6 +15,7 @@
 use MongoDB\Builder\Encoder\VariableEncoder;
 use MongoDB\Builder\Expression\Variable;
 use MongoDB\Builder\Type\CombinedFieldQuery;
+use MongoDB\Builder\Type\Dictionnary;
 use MongoDB\Builder\Type\ExpressionInterface;
 use MongoDB\Builder\Type\FieldPathInterface;
 use MongoDB\Builder\Type\OperatorInterface;
@@ -39,6 +41,7 @@ class BuilderEncoder implements Encoder
     private array $defaultEncoders = [
         Pipeline::class => PipelineEncoder::class,
         Variable::class => VariableEncoder::class,
+        Dictionnary::class => DictionaryEncoder::class,
         FieldPathInterface::class => FieldPathEncoder::class,
         CombinedFieldQuery::class => CombinedFieldQueryEncoder::class,
         QueryObject::class => QueryEncoder::class,

src/Builder/Accumulator/FactoryTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Builder\Encoder;
+
+use MongoDB\Builder\Type\Dictionnary;
+use MongoDB\Codec\EncodeIfSupported;
+use MongoDB\Exception\UnsupportedValueException;
+use stdClass;
+
+/** @template-extends AbstractExpressionEncoder<string, Dictionnary> */
+class DictionaryEncoder extends AbstractExpressionEncoder
+{
+    /** @template-use EncodeIfSupported<string, Dictionnary> */
+    use EncodeIfSupported;
+
+    public function canEncode(mixed $value): bool
+    {
+        return $value instanceof Dictionnary;
+    }
+
+    public function encode(mixed $value): string|int|array|stdClass
+    {
+        if (! $this->canEncode($value)) {
+            throw UnsupportedValueException::invalidEncodableValue($value);
+        }
+
+        return $value->getValue();
+    }
+}