PHPORM-155 Integrate aggregation builder to the Query builder

Author: GromNaN

composer.json

@@ -14,6 +14,9 @@
         "issues": "https://www.mongodb.com/support",
         "security": "https://www.mongodb.com/security"
     },
+    "repositories": [
+        { "type": "vcs", "url": "https://github.com/GromNaN/mongo-php-builder.git" }
+    ],
     "authors": [
         { "name": "Andreas Braun", "email": "andreas.braun@mongodb.com", "role": "Leader" },
         { "name": "Jérôme Tamarelle", "email": "jerome.tamarelle@mongodb.com", "role": "Maintainer" },
@@ -31,7 +34,7 @@
         "mongodb/mongodb": "^1.15"
     },
     "require-dev": {
-        "mongodb/builder": "^0.1",
+        "mongodb/builder": "dev-laravel-fluent",
         "phpunit/phpunit": "^10.3",
         "orchestra/testbench": "^8.0|^9.0",
         "mockery/mockery": "^1.4.4",

src/Eloquent/Builder.php

@@ -51,6 +51,13 @@ class Builder extends EloquentBuilder
         'tomql',
     ];
 
+    public function aggregate($function = null, $columns = ['*'])
+    {
+        $result = $this->toBase()->aggregate($function, $columns);
+
+        return $result ?? $this;
+    }
+
     /** @inheritdoc */
     public function update(array $values, array $options = [])
     {

src/Query/Builder.php

@@ -32,6 +32,8 @@
 use MongoDB\Builder\Stage\ReplaceRootStage;
 use MongoDB\Builder\Stage\SkipStage;
 use MongoDB\Builder\Stage\SortStage;
+use MongoDB\Builder\Stage\UnwindStage;
+use MongoDB\Builder\Type\StageInterface;
 use MongoDB\Builder\Variable;
 use MongoDB\Driver\Cursor;
 use Override;
@@ -291,14 +293,8 @@ public function dump(mixed ...$args)
         return $this;
     }
 
-    /**
-     * Return the MongoDB query to be run in the form of an element array like ['method' => [arguments]].
-     *
-     * Example: ['find' => [['name' => 'John Doe'], ['projection' => ['birthday' => 1]]]]
-     *
-     * @return array<string, mixed[]>
-     */
-    public function toMql(): array
+    /** @return StageInterface[] */
+    protected function getPipeline(): array
     {
         $columns = $this->columns ?? [];
 
@@ -373,33 +369,33 @@ public function toMql(): array
             // Build the aggregation pipeline.
             $pipeline = [];
             if ($wheres) {
-                $pipeline[] = ['$match' => $wheres];
+                $pipeline[] = new MatchStage(...$wheres);
             }
 
             // apply unwinds for subdocument array aggregation
             foreach ($unwinds as $unwind) {
-                $pipeline[] = ['$unwind' => '$' . $unwind];
+                $pipeline[] = new UnwindStage($unwind);
             }
 
             if ($group) {
-                $pipeline[] = ['$group' => $group];
+                $pipeline[] = new GroupStage(...$group);
             }
 
             // Apply order and limit
             if ($this->orders) {
-                $pipeline[] = ['$sort' => $this->orders];
+                $pipeline[] = new SortStage($this->orders);
             }
 
             if ($this->offset) {
-                $pipeline[] = ['$skip' => $this->offset];
+                $pipeline[] = new SkipStage($this->offset);
             }
 
             if ($this->limit) {
-                $pipeline[] = ['$limit' => $this->limit];
+                $pipeline[] = new LimitStage($this->limit);
             }
 
             if ($this->projections) {
-                $pipeline[] = ['$project' => $this->projections];
+                $pipeline[] = new ProjectStage(...$this->projections);
             }
 
             $options = [
@@ -457,6 +453,22 @@ public function toMql(): array
             $pipeline[] = new ProjectStage(...$projection);
         }
 
+        return $pipeline;
+    }
+
+    /**
+     * Return the MongoDB query to be run in the form of an element array like ['method' => [arguments]].
+     *
+     * Example: ['find' => [['name' => 'John Doe'], ['projection' => ['birthday' => 1]]]]
+     *
+     * @return array<string, mixed[]>
+     */
+    public function toMql(): array
+    {
+        $pipeline = $this->getPipeline();
+        $encoder = new BuilderEncoder();
+        $pipeline = $encoder->encode(new Pipeline(...$pipeline));
+
         $options = ['typeMap' => ['root' => 'array', 'document' => 'array']];
 
         if ($this->timeout) {
@@ -468,12 +480,8 @@ public function toMql(): array
         }
 
         $options = array_merge($options, $this->options);
-
         $options = $this->inheritConnectionOptions($options);
 
-        $encoder = new BuilderEncoder();
-        $pipeline = $encoder->encode(new Pipeline(...$pipeline));
-
         return ['aggregate' => [$pipeline, $options]];
     }
 
@@ -554,9 +562,16 @@ public function generateCacheKey()
         return md5(serialize(array_values($key)));
     }
 
-    /** @inheritdoc */
-    public function aggregate($function, $columns = [])
+    /**
+     * @return self|PipelineBuilder
+     * @psalm-return $function === null ? PipelineBuilder : self
+     */
+    public function aggregate($function = null, $columns = [])
     {
+        if ($function === null) {
+            return new PipelineBuilder($this->getPipeline());
+        }
+
         $this->aggregate = [
             'function' => $function,
             'columns' => $columns,

src/Query/PipelineBuilder.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Laravel\Query;
+
+use MongoDB\Builder\Stage\FluentFactory;
+
+class PipelineBuilder extends FluentFactory
+{
+    public function __construct(array $pipeline = [])
+    {
+        $this->pipeline = $pipeline;
+    }
+}

tests/Query/PipelineBuilderTest.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Laravel\Tests\Query;
+
+use MongoDB\BSON\Document;
+use MongoDB\Builder\BuilderEncoder;
+use MongoDB\Laravel\Query\PipelineBuilder;
+use MongoDB\Laravel\Tests\Models\User;
+use MongoDB\Laravel\Tests\TestCase;
+
+use function assert;
+
+class PipelineBuilderTest extends TestCase
+{
+    public function testCreateFromQueryBuilder(): void
+    {
+        $builder = User::where('foo', 'bar')->aggregate();
+        assert($builder instanceof PipelineBuilder);
+        $builder->addFields(baz: 'qux');
+
+        $codec = new BuilderEncoder();
+        $pipeline = $codec->encode($builder->getPipeline());
+        $json = Document::fromPHP(['pipeline' => $pipeline])->toCanonicalExtendedJSON();
+
+        $expected = Document::fromPHP([
+            'pipeline' => [
+                [
+                    '$match' => ['foo' => 'bar'],
+                ],
+                [
+                    '$addFields' => ['baz' => 'qux'],
+                ],
+            ],
+        ])->toCanonicalExtendedJSON();
+
+        $this->assertJsonStringEqualsJsonString($expected, $json);
+    }
+}