Merge pull request #2 from ensi-platform/dev-match

Full text search

Author: arrilot

README.md

@@ -70,6 +70,16 @@ $searchQuery->whereDoesntHave(
 `nested_field` must have `nested` type.
 Subqueries cannot use fields of main document only subdocument.
 
+### Full text search
+
+```php
+$searchQuery->whereMatch('field_one', 'query string');
+$searchQuery->whereMultiMatch(['field_one^3', 'field_two'], 'query string', MatchType::MOST_FIELDS);
+$searchQuery->whereMultiMatch([], 'query string');  // search by all text fields
+```
+
+`field_one` and `field_two` must be of text type. If no type is given, the `MatchType::BEST_FIELDS` is used.
+
 ### Sorting
 
 ```php

src/Concerns/DecoratesBoolQuery.php

@@ -68,4 +68,18 @@ public function whereNotNull(string $field): static
 
         return $this;
     }
+
+    public function whereMatch(string $field, string $query, string $operator = 'or'): static
+    {
+        $this->forwardCallTo($this->boolQuery(), __FUNCTION__, func_get_args());
+
+        return $this;
+    }
+
+    public function whereMultiMatch(array $fields, string $query, ?string $type = null): static
+    {
+        $this->forwardCallTo($this->boolQuery(), __FUNCTION__, func_get_args());
+
+        return $this;
+    }
 }

src/Contracts/BoolQuery.php

@@ -22,4 +22,8 @@ public function whereDoesntHave(string $nested, Closure $filter): static;
     public function whereNull(string $field): static;
 
     public function whereNotNull(string $field): static;
+
+    public function whereMatch(string $field, string $query, string $operator = 'or'): static;
+
+    public function whereMultiMatch(array $fields, string $query, ?string $type = null): static;
 }

src/Contracts/MatchType.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Contracts;
+
+final class MatchType
+{
+    public const BEST_FIELDS = 'best_fields';
+    public const MOST_FIELDS = 'most_fields';
+    public const CROSS_FIELDS = 'cross_fields';
+    public const PHRASE = 'phrase';
+    public const PHRASE_PREFIX = 'phrase_prefix';
+    public const BOOL_PREFIX = 'bool_prefix';
+
+    public static function cases(): array
+    {
+        return [
+            self::BEST_FIELDS,
+            self::MOST_FIELDS,
+            self::CROSS_FIELDS,
+            self::PHRASE,
+            self::PHRASE_PREFIX,
+            self::BOOL_PREFIX,
+        ];
+    }
+}

src/Filtering/BoolQueryBuilder.php

@@ -7,7 +7,9 @@
 use Ensi\LaravelElasticQuery\Contracts\BoolQuery;
 use Ensi\LaravelElasticQuery\Contracts\Criteria;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\Exists;
+use Ensi\LaravelElasticQuery\Filtering\Criterias\MultiMatch;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\Nested;
+use Ensi\LaravelElasticQuery\Filtering\Criterias\OneMatch;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\RangeBound;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\Term;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\Terms;
@@ -139,6 +141,25 @@ public function whereNotNull(string $field): static
         return $this;
     }
 
+    public function whereMatch(string $field, string $query, string $operator = 'or'): static
+    {
+        $this->must->add(new OneMatch($this->absolutePath($field), $query, $operator));
+
+        return $this;
+    }
+
+    public function whereMultiMatch(array $fields, string $query, ?string $type = null): static
+    {
+        $fields = array_map(
+            fn (string $field) => $this->absolutePath($field),
+            $fields
+        );
+
+        $this->must->add(new MultiMatch($fields, $query, $type));
+
+        return $this;
+    }
+
     protected function addNestedCriteria(string $nested, Closure $filter, CriteriaCollection $target): static
     {
         $path = $this->absolutePath($nested);

src/Filtering/Criterias/MultiMatch.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Filtering\Criterias;
+
+use Ensi\LaravelElasticQuery\Contracts\Criteria;
+use Ensi\LaravelElasticQuery\Contracts\MatchType;
+use Webmozart\Assert\Assert;
+
+class MultiMatch implements Criteria
+{
+    public function __construct(private array $fields, private string $query, private ?string $type = null)
+    {
+        Assert::nullOrOneOf($this->type, MatchType::cases());
+    }
+
+    public function toDSL(): array
+    {
+        $dsl = ['query' => $this->query];
+
+        if ($this->fields) {
+            $dsl['fields'] = $this->fields;
+        }
+
+        if ($this->type !== null) {
+            $dsl['type'] = $this->type;
+        }
+
+        return ['multi_match' => $dsl];
+    }
+}

src/Filtering/Criterias/OneMatch.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Filtering\Criterias;
+
+use Ensi\LaravelElasticQuery\Contracts\Criteria;
+use Webmozart\Assert\Assert;
+
+class OneMatch implements Criteria
+{
+    public function __construct(private string $field, private string $query, private string $operator)
+    {
+        Assert::stringNotEmpty(trim($field));
+        Assert::oneOf($operator, ['and', 'or']);
+    }
+
+    public function toDSL(): array
+    {
+        $body = [
+            'query' => $this->query,
+            'operator' => $this->operator,
+        ];
+
+        return [
+            'match' => [
+                $this->field => $body,
+            ],
+        ];
+    }
+}

tests/Functional/Search/FilteringTest.php

@@ -39,4 +39,53 @@ public function testWhereDoesntHave(): void
 
         $this->assertDocumentIds([1, 328, 471]);
     }
+
+    public function testWhereNull(): void
+    {
+        $this->testing->whereNull('package');
+
+        $this->assertDocumentIds([1, 319, 328, 471]);
+    }
+
+    public function testWhereNotNull(): void
+    {
+        $this->testing->whereNotNull('package');
+
+        $this->assertDocumentIds([150, 405]);
+    }
+
+    public function testWhereMatch(): void
+    {
+        $this->testing->whereMatch('search_name', 'black leather gloves');
+
+        $this->assertDocumentIds([319, 471]);
+    }
+
+    public function whereMatchOperatorAnd(): void
+    {
+        $this->testing->whereMatch('search_name', 'leather gloves', 'and');
+
+        $this->assertDocumentIds([319]);
+    }
+
+    public function testWhereMultiMatch(): void
+    {
+        $this->testing->whereMultiMatch(['search_name', 'description'], 'nice gloves');
+
+        $this->assertDocumentIds([471, 328, 319]);
+    }
+
+    public function testWhereMultiMatchDefault(): void
+    {
+        $this->testing->whereMultiMatch([], 'nice gloves');
+
+        $this->assertDocumentIds([471, 328, 319]);
+    }
+
+    public function testWhereMultiMatchPrioritized(): void
+    {
+        $this->testing->whereMultiMatch(['search_name^2', 'description'], 'water');
+
+        $this->assertDocumentOrder([150, 405]);
+    }
 }

tests/Functional/Search/SearchQueryTest.php

@@ -68,13 +68,4 @@ public function testSortByNested(): void
     }
 
     //endregion
-
-    protected function assertDocumentOrder(array $ids): void
-    {
-        $actual = $this->testing->get()
-            ->pluck('_id')
-            ->all();
-
-        $this->assertEquals($ids, $actual);
-    }
 }

tests/Functional/Search/SearchTestCase.php

@@ -29,4 +29,13 @@ protected function assertDocumentIds(array $expected): void
 
         $this->assertEqualsCanonicalizing($expected, $actual);
     }
+
+    protected function assertDocumentOrder(array $ids): void
+    {
+        $actual = $this->testing->get()
+            ->pluck('_id')
+            ->all();
+
+        $this->assertEquals($ids, $actual);
+    }
 }