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

Add match filter

Author: zix2

src/Filtering/AllowedFilter.php

@@ -117,6 +117,11 @@ public static function lessOrEqual(string $name, ?string $field = null): self
         return new static($name, new RangeFilterAction('<='), $field);
     }
 
+    public static function match(string $name, ?string $field): self
+    {
+        return new static($name, new MatchFilterAction(), $field);
+    }
+
     private function refineValue(mixed $value): mixed
     {
         if ($value === null) {

src/Filtering/MatchFilterAction.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Ensi\LaravelElasticQuerySpecification\Filtering;
+
+use Ensi\LaravelElasticQuery\Contracts\BoolQuery;
+use Ensi\LaravelElasticQuerySpecification\Contracts\FilterAction;
+use Ensi\LaravelElasticQuerySpecification\Exceptions\InvalidQueryException;
+
+class MatchFilterAction implements FilterAction
+{
+    public function __invoke(BoolQuery $query, mixed $value, string $field): void
+    {
+        FilterValue::make($value)
+            ->whenSingle(fn (mixed $value) => $query->whereMatch($field, (string)$value))
+            ->whenMultiple(fn () => throw InvalidQueryException::notSupportMultipleValues($field));
+    }
+}

tests/Data/ProductIndexSeeder.php

@@ -14,7 +14,7 @@ class ProductIndexSeeder extends IndexSeeder
             'active' => ['type' => 'boolean'],
 
             'name' => ['type' => 'keyword', 'copy_to' => 'search_name'],
-            'search_name' => ['type' => 'text'],
+            'search_name' => ['type' => 'text', 'analyzer' => 'default'],
             'description' => ['type' => 'text'],
 
             'code' => ['type' => 'keyword'],
@@ -40,4 +40,31 @@ class ProductIndexSeeder extends IndexSeeder
             ],
         ],
     ];
+
+    protected array $settings = [
+        'analysis' => [
+            'filter' => [
+                'english_stop' => [
+                    'type' => 'stop',
+                    'stopwords' => '_english_',
+                ],
+                'english_stemmer' => [
+                    'type' => 'stemmer',
+                    'language' => 'english',
+                ],
+            ],
+            'analyzer' => [
+                'default' => [
+                    'type' => 'custom',
+                    'char_filter' => ['html_strip'],
+                    'tokenizer' => 'standard',
+                    'filter' => [
+                        'lowercase',
+                        'english_stop',
+                        'english_stemmer',
+                    ],
+                ],
+            ],
+        ],
+    ];
 }

tests/Integration/FilteringTest.php

@@ -78,3 +78,15 @@
     'less or equal' => [['rating__lte' => 5], [319, 328, 471]],
     'between' => [['rating__lte' => 7, 'rating__gte' => 5], [1, 328]],
 ]);
+
+test('match filter', function (string $query, array $expectedIds) {
+    $spec = CompositeSpecification::new()
+        ->allowedFilters([
+            AllowedFilter::match('name', 'search_name'),
+        ]);
+
+    searchQuery($spec, ['filter' => ['name' => $query]])->assertDocumentIds($expectedIds);
+})->with([
+    'single' => ['water', [150]],
+    'multiple' => ['gloves', [319, 471]],
+]);

tests/TestCase.php

@@ -5,13 +5,16 @@
 use Ensi\LaravelElasticQuery\ElasticQuery;
 use Ensi\LaravelElasticQuery\ElasticQueryServiceProvider;
 use Ensi\LaravelElasticQuerySpecification\ElasticQuerySpecificationServiceProvider;
+use Ensi\LaravelElasticQuerySpecification\Tests\Data\ProductIndexSeeder;
 use Orchestra\Testbench\TestCase as Orchestra;
 
 class TestCase extends Orchestra
 {
     protected function setUp(): void
     {
         parent::setUp();
+
+        ProductIndexSeeder::run();
     }
 
     protected function tearDown(): void