Merge pull request #2 from greensight/dev-1

New filters, sort order and mode enums.

Author: arrilot

README.md

@@ -49,6 +49,16 @@ $searchQuery->whereNot('field', 'value'); // equals `where('field', '!=', 'value
 
 List of supported operators: `=, !=, >, <, >=, <=`.
 
+```php
+$searchQuery->whereIn('field', ['value1', 'value2']);
+$searchQuery->whereNotIn('field', ['value1', 'value2']);
+```
+
+```php
+$searchQuery->whereNull('field');
+$searchQuery->whereNotNull('field');
+```
+
 ```php
 $searchQuery->whereHas('nested_field', fn(BoolQuery $subQuery) => $subQuery->where('field_in_nested', 'value'));
 $searchQuery->whereDoesntHave(

src/Raw/Aggregating/Bucket/TermsAggregation.php

@@ -2,8 +2,8 @@
 
 namespace Greensight\LaravelElasticQuery\Raw\Aggregating\Bucket;
 
-use Greensight\LaravelElasticQuery\Raw\Aggregating\Bucket;
 use Greensight\LaravelElasticQuery\Raw\Aggregating\BucketCollection;
+use Greensight\LaravelElasticQuery\Raw\Aggregating\Result;
 use Greensight\LaravelElasticQuery\Raw\Contracts\Aggregation;
 use Webmozart\Assert\Assert;
 
@@ -34,7 +34,7 @@ public function toDSL(): array
     public function parseResults(array $response): array
     {
         $buckets = array_map(
-            fn (array $bucket) => new Bucket($bucket['key'], (int)$bucket['doc_count']),
+            fn (array $bucket) => Result::parseBucket($bucket),
             $response[$this->name]['buckets'] ?? []
         );
 

src/Raw/Aggregating/Metrics/MinMaxAggregation.php

@@ -3,6 +3,7 @@
 namespace Greensight\LaravelElasticQuery\Raw\Aggregating\Metrics;
 
 use Greensight\LaravelElasticQuery\Raw\Aggregating\MinMax;
+use Greensight\LaravelElasticQuery\Raw\Aggregating\Result;
 use Greensight\LaravelElasticQuery\Raw\Contracts\Aggregation;
 use Webmozart\Assert\Assert;
 
@@ -30,8 +31,8 @@ public function toDSL(): array
     public function parseResults(array $response): array
     {
         return [$this->name => new MinMax(
-            $response["{$this->name}_min"]['value'] ?? 0,
-            $response["{$this->name}_max"]['value'] ?? 0,
+            Result::parseValue($response["{$this->name}_min"]) ?? 0,
+            Result::parseValue($response["{$this->name}_max"]) ?? 0,
         )];
     }
 }

src/Raw/Aggregating/Result.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Greensight\LaravelElasticQuery\Raw\Aggregating;
+
+class Result
+{
+    public static function parseValue(array $source): mixed
+    {
+        return self::parse($source, 'value');
+    }
+
+    public static function parseBucket(array $source): Bucket
+    {
+        return new Bucket(self::parse($source, 'key'), (int)($source['doc_count'] ?? 0));
+    }
+
+    public static function parse(array $source, string $key): mixed
+    {
+        $stringValue = $source["{$key}_as_string"] ?? null;
+
+        if ($stringValue === null) {
+            return $source[$key] ?? null;
+        }
+
+        if ($stringValue === 'true') {
+            return true;
+        }
+
+        if ($stringValue === 'false') {
+            return false;
+        }
+
+        return $stringValue;
+    }
+}

src/Raw/Concerns/DecoratesBoolQuery.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use Greensight\LaravelElasticQuery\Raw\Filtering\BoolQueryBuilder;
+use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Traits\ForwardsCalls;
 
 trait DecoratesBoolQuery
@@ -39,4 +40,32 @@ public function whereDoesntHave(string $nested, Closure $filter): static
 
         return $this;
     }
+
+    public function whereIn(string $field, array|Arrayable $values): static
+    {
+        $this->forwardCallTo($this->boolQuery(), __FUNCTION__, func_get_args());
+
+        return $this;
+    }
+
+    public function whereNotIn(string $field, array|Arrayable $values): static
+    {
+        $this->forwardCallTo($this->boolQuery(), __FUNCTION__, func_get_args());
+
+        return $this;
+    }
+
+    public function whereNull(string $field): static
+    {
+        $this->forwardCallTo($this->boolQuery(), __FUNCTION__, func_get_args());
+
+        return $this;
+    }
+
+    public function whereNotNull(string $field): static
+    {
+        $this->forwardCallTo($this->boolQuery(), __FUNCTION__, func_get_args());
+
+        return $this;
+    }
 }

src/Raw/Concerns/ExtendsSort.php

@@ -2,35 +2,38 @@
 
 namespace Greensight\LaravelElasticQuery\Raw\Concerns;
 
+use Greensight\LaravelElasticQuery\Raw\Contracts\SortMode;
+use Greensight\LaravelElasticQuery\Raw\Contracts\SortOrder;
+
 /**
  * @psalm-require-implements \Greensight\LaravelElasticQuery\Raw\Contracts\SortableQuery
  *
- * @method static sortBy(string $field, string $order = 'asc', ?string $mode = null)
+ * @method static sortBy(string $field, string $order = SortOrder::ASC, ?string $mode = null)
  */
 trait ExtendsSort
 {
-    public function minSortBy(string $field, string $order = 'asc'): static
+    public function minSortBy(string $field, string $order = SortOrder::ASC): static
     {
-        return $this->sortBy($field, $order, 'min');
+        return $this->sortBy($field, $order, SortMode::MIN);
     }
 
-    public function maxSortBy(string $field, string $order = 'asc'): static
+    public function maxSortBy(string $field, string $order = SortOrder::ASC): static
     {
-        return $this->sortBy($field, $order, 'max');
+        return $this->sortBy($field, $order, SortMode::MAX);
     }
 
-    public function avgSortBy(string $field, string $order = 'asc'): static
+    public function avgSortBy(string $field, string $order = SortOrder::ASC): static
     {
-        return $this->sortBy($field, $order, 'avg');
+        return $this->sortBy($field, $order, SortMode::AVG);
     }
 
-    public function sumSortBy(string $field, string $order = 'asc'): static
+    public function sumSortBy(string $field, string $order = SortOrder::ASC): static
     {
-        return $this->sortBy($field, $order, 'sum');
+        return $this->sortBy($field, $order, SortMode::SUM);
     }
 
-    public function medianSortBy(string $field, string $order = 'asc'): static
+    public function medianSortBy(string $field, string $order = SortOrder::ASC): static
     {
-        return $this->sortBy($field, $order, 'median');
+        return $this->sortBy($field, $order, SortMode::MEDIAN);
     }
 }

src/Raw/Contracts/BoolQuery.php

@@ -3,14 +3,23 @@
 namespace Greensight\LaravelElasticQuery\Raw\Contracts;
 
 use Closure;
+use Illuminate\Contracts\Support\Arrayable;
 
 interface BoolQuery
 {
     public function where(string $field, mixed $operator, mixed $value = null): static;
 
     public function whereNot(string $field, mixed $value): static;
 
+    public function whereIn(string $field, array|Arrayable $values): static;
+
+    public function whereNotIn(string $field, array|Arrayable $values): static;
+
     public function whereHas(string $nested, Closure $filter): static;
 
     public function whereDoesntHave(string $nested, Closure $filter): static;
+
+    public function whereNull(string $field): static;
+
+    public function whereNotNull(string $field): static;
 }

src/Raw/Contracts/SortMode.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Greensight\LaravelElasticQuery\Raw\Contracts;
+
+final class SortMode
+{
+    public const MIN = 'min';
+    public const MAX = 'max';
+    public const AVG = 'avg';
+    public const SUM = 'sum';
+    public const MEDIAN = 'median';
+
+    public static function cases(): array
+    {
+        return [
+            self::MAX,
+            self::MIN,
+            self::AVG,
+            self::SUM,
+            self::MEDIAN,
+        ];
+    }
+}

src/Raw/Contracts/SortOrder.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Greensight\LaravelElasticQuery\Raw\Contracts;
+
+final class SortOrder
+{
+    public const ASC = 'asc';
+    public const DESC = 'desc';
+
+    public static function cases(): array
+    {
+        return [
+            self::ASC,
+            self::DESC,
+        ];
+    }
+}

src/Raw/Contracts/SortableQuery.php

@@ -6,17 +6,17 @@
 
 interface SortableQuery extends BoolQuery
 {
-    public function sortBy(string $field, string $order = 'asc', ?string $mode = null): static;
+    public function sortBy(string $field, string $order = SortOrder::ASC, ?string $mode = null): static;
 
-    public function minSortBy(string $field, string $order = 'asc'): static;
+    public function minSortBy(string $field, string $order = SortOrder::ASC): static;
 
-    public function maxSortBy(string $field, string $order = 'asc'): static;
+    public function maxSortBy(string $field, string $order = SortOrder::ASC): static;
 
-    public function avgSortBy(string $field, string $order = 'asc'): static;
+    public function avgSortBy(string $field, string $order = SortOrder::ASC): static;
 
-    public function sumSortBy(string $field, string $order = 'asc'): static;
+    public function sumSortBy(string $field, string $order = SortOrder::ASC): static;
 
-    public function medianSortBy(string $field, string $order = 'asc'): static;
+    public function medianSortBy(string $field, string $order = SortOrder::ASC): static;
 
     public function sortByNested(string $field, Closure $callback): static;
 }