New feature: Range aggregation via groupByRanges()

Author: pdphilip

src/Eloquent/Docs/ModelDocs.php

@@ -168,6 +168,7 @@
  * @method static $this orderByDesc($column,$options = [])
  *-----------------------------------
  * @method static $this groupBy($groups)
+ * @method static $this groupByRanges($column, array $ranges)
  *-----------------------------------
  * @method static $this orderByGeo($column, $pin, $direction = 'asc', $options = [])
  * @method static $this orderByGeoDesc($column, $pin, $options = [])

src/Query/Builder.php

@@ -1917,6 +1917,17 @@ public function bucket($key, $type = null, $args = null, $aggregations = null):
         return $this->bucketAggregation($key, $type, $args, $aggregations);
     }
 
+    public function groupByRanges($column, $ranges = [])
+    {
+        $args = [
+            'field' => $column,
+            'ranges' => $ranges,
+        ];
+        $key = $column.'_ranges';
+
+        return $this->bucketAggregation($key, 'range', $args);
+    }
+
     /**
      * Get the aggregations returned from query
      */

src/Query/Concerns/ProcessesBucketAggregations.php

@@ -17,14 +17,18 @@ public function processBucketAggregations($bucketAggregations, $rawAggs): array
     protected function parseBucket($bucketAggregation, $rawAggs)
     {
         $key = $bucketAggregation['key'];
+        $type = $bucketAggregation['type'] ?? null;
 
         if (! isset($rawAggs[$key]['buckets'])) {
             return $rawAggs[$key];
         }
-
-        $result = collect($rawAggs[$key]['buckets'])->map(function ($bucket) use ($key) {
+        $result = collect($rawAggs[$key]['buckets'])->map(function ($bucket) use ($key, $type) {
             $metricAggs = $this->appendMetricsToBucket($bucket);
-            // ES is super annoying with how it does keys. For composite, it returns keys as an array but in other cases it does not.
+
+            if ($type === 'range') {
+                return $this->makeRangeBucket($bucket, $metricAggs);
+            }
+
             if (! is_array($bucket['key'])) {
                 $bucket['key'] = [$key => $bucket['key']];
             }
@@ -40,6 +44,24 @@ protected function parseBucket($bucketAggregation, $rawAggs)
         return $result->toArray();
     }
 
+    protected function makeRangeBucket($bucket, $metricAggs)
+    {
+        $cleanBucket = [
+            'key' => $bucket['key'],
+            'from' => $bucket['from'] ?? null,
+            'to' => $bucket['to'] ?? null,
+        ];
+        $docCount = $bucket['doc_count'] ?? 0;
+        unset($bucket['doc_count']);
+        $cleanBucket['count'] = $docCount;
+
+        return [
+            ...$cleanBucket,
+            ...$metricAggs,
+            '_meta' => $this->metaFromResult(['doc_count' => $docCount]),
+        ];
+    }
+
     protected function appendMetricsToBucket($bucket)
     {
         if (! $this->query->metricsAggregations) {

src/Query/DSL/DslFactory.php

@@ -2,6 +2,8 @@
 
 namespace PDPhilip\Elasticsearch\Query\DSL;
 
+use PDPhilip\Elasticsearch\Utils\Helpers;
+
 class DslFactory
 {
     // ----------------------------------------------------------------------
@@ -493,6 +495,18 @@ public static function termsAggregation(string $field, int $size, array $options
         ];
     }
 
+    public static function rangeAggregation(string $field, array $ranges)
+    {
+        $ranges = Helpers::sanitizeRanges($ranges);
+
+        return [
+            'range' => [
+                'field' => $field,
+                'ranges' => $ranges,
+            ],
+        ];
+    }
+
     public static function filterTermsAggregationOptions(array $options): array
     {
         $allowedArgs = [

src/Query/Grammar.php

@@ -1362,6 +1362,14 @@ protected function compileTermsAggregation(Builder $builder, array $aggregation)
         return DslFactory::termsAggregation($indexableField, $builder->getLimit(), $options);
     }
 
+    protected function compileRangeAggregation(Builder $builder, array $aggregation): array
+    {
+        $field = $aggregation['args']['field'];
+        $ranges = $aggregation['args']['ranges'];
+
+        return DslFactory::rangeAggregation($field, $ranges);
+    }
+
     /**
      * Apply inner hits options to the clause
      */

src/Utils/Helpers.php

@@ -56,4 +56,38 @@ public static function getLaravelCompatabilityVersion(): int
 
         return $majorVersion;
     }
+
+    public static function sanitizeRanges($input)
+    {
+        $ranges = [];
+        foreach ($input as $value) {
+            $range = [];
+            if (isset($value['from']) || isset($value['to'])) {
+                if (! empty($value['from'])) {
+                    $range['from'] = $value['from'];
+                }
+                if (! empty($value['to'])) {
+                    $range['to'] = $value['to'];
+                }
+
+                if (! empty($value['key'])) {
+                    $range['key'] = $value['key'];
+                }
+                $ranges[] = $range;
+
+                continue;
+            }
+            // assume its an array with values of from and to
+            if ($value[0] !== null) {
+                $range['from'] = $value[0];
+            }
+            if ($value[1] !== null) {
+                $range['to'] = $value[1];
+            }
+            $ranges[] = $range;
+
+        }
+
+        return $ranges;
+    }
 }