PHPLIB-1381 PHPLIB-1269 Add enum for Sort and TimeUnit (#63)

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/expression/sortArray.yaml

@@ -20,6 +20,7 @@ arguments:
         type:
             - object # SortSpec
             - int
+            - sortSpec
         description: |
             The document specifies a sort ordering.
 tests:

generator/config/expressions.php

@@ -117,6 +117,14 @@
         'returnType' => Type\SwitchBranchInterface::class,
         'acceptedTypes' => [Type\SwitchBranchInterface::class, ...$bsonTypes['object']],
     ],
+    'timeUnit' => [
+        'returnType' => Type\TimeUnit::class,
+        'acceptedTypes' => [Type\TimeUnit::class, ResolvesToString::class, ...$bsonTypes['string']],
+    ],
+    'sortSpec' => [
+        'returnType' => Type\Sort::class,
+        'acceptedTypes' => [Type\Sort::class],
+    ],
 
     // @todo add enum values
     'Granularity' => [

generator/config/query/text.yaml

@@ -102,6 +102,8 @@ tests:
                     $text:
                         $search: 'CAFÉ'
                         $diacriticSensitive: true
+            -
+                $project:
                     score:
                         $meta: 'textScore'
             -

generator/config/schema.json

@@ -115,6 +115,8 @@
                             "expression",
                             "geometry",
                             "fieldPath",
+                            "timeUnit",
+                            "sortSpec",
                             "any",
                             "resolvesToNumber", "numberFieldPath", "number",
                             "resolvesToDouble", "doubleFieldPath", "double",

generator/config/stage/sort.yaml

@@ -10,7 +10,9 @@ arguments:
     -
         name: sort
         type:
-            - object # SortSpec
+            - expression
+            - sortSpec
+        variadic: object
 tests:
     -
         name: 'Ascending Descending Sort'

psalm-baseline.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.20.0@3f284e96c9d9be6fe6b15c79416e1d1903dcfef4">
+<files psalm-version="5.21.1@8c473e2437be8b6a8fd8f630f0f11a16b114c494">
   <file src="src/Builder/Encoder/AbstractExpressionEncoder.php">
     <MixedAssignment>
       <code>$val</code>
@@ -113,6 +113,14 @@
       <code>stdClass</code>
     </TooManyTemplateParams>
   </file>
+  <file src="src/Builder/Stage/SortStage.php">
+    <PropertyTypeCoercion>
+      <code>$sort</code>
+    </PropertyTypeCoercion>
+    <TooManyTemplateParams>
+      <code>stdClass</code>
+    </TooManyTemplateParams>
+  </file>
   <file src="src/Builder/Type/OutputWindow.php">
     <DocblockTypeContradiction>
       <code><![CDATA[! is_string($documents[1]) && ! is_int($documents[1])]]></code>

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\DictionaryInterface;
 use MongoDB\Builder\Type\ExpressionInterface;
 use MongoDB\Builder\Type\FieldPathInterface;
 use MongoDB\Builder\Type\OperatorInterface;
@@ -29,16 +31,17 @@
 use function array_key_exists;
 use function is_object;
 
-/** @template-implements Encoder<stdClass|array|string, Pipeline|StageInterface|ExpressionInterface|QueryInterface> */
+/** @template-implements Encoder<stdClass|array|string|int, Pipeline|StageInterface|ExpressionInterface|QueryInterface> */
 class BuilderEncoder implements Encoder
 {
-    /** @template-use EncodeIfSupported<stdClass|array|string, Pipeline|StageInterface|ExpressionInterface|QueryInterface> */
+    /** @template-use EncodeIfSupported<stdClass|array|string|int, Pipeline|StageInterface|ExpressionInterface|QueryInterface> */
     use EncodeIfSupported;
 
     /** @var array<class-string, class-string<ExpressionEncoder>> */
     private array $defaultEncoders = [
         Pipeline::class => PipelineEncoder::class,
         Variable::class => VariableEncoder::class,
+        DictionaryInterface::class => DictionaryEncoder::class,
         FieldPathInterface::class => FieldPathEncoder::class,
         CombinedFieldQuery::class => CombinedFieldQueryEncoder::class,
         QueryObject::class => QueryEncoder::class,
@@ -64,7 +67,7 @@ public function canEncode(mixed $value): bool
         return (bool) $this->getEncoderFor($value)?->canEncode($value);
     }
 
-    public function encode(mixed $value): stdClass|array|string
+    public function encode(mixed $value): stdClass|array|string|int
     {
         $encoder = $this->getEncoderFor($value);
 

src/Builder/Accumulator/FactoryTrait.php

@@ -11,7 +11,7 @@
 use function is_array;
 
 /**
- * @template BSONType of stdClass|array|string
+ * @template BSONType of stdClass|array|string|int
  * @template NativeType
  * @template-implements ExpressionEncoder<BSONType, NativeType>
  */

src/Builder/Accumulator/IntegralAccumulator.php

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

src/Builder/BuilderEncoder.php

@@ -9,7 +9,7 @@
 use stdClass;
 
 /**
- * @template BSONType of stdClass|array|string
+ * @template BSONType of stdClass|array|string|int
  * @template NativeType
  * @template-extends Encoder<BSONType, NativeType>
  */