Merge pull request #5 from robertmarney/master

Basic Min Score Threshold

Author: mattkingshott

README.md

@@ -89,6 +89,23 @@ User::whereFuzzy('name', 'jd')
     ->orderBy('relevance_email', 'desc')
     ->first();
 ```
+### Setting Minimum Match Threshold
+
+When using quest an overall score will be assigned to each row `_fuzzy_relevance_` with a range of 0-100.
+
+You can enforce a minimum match standard and limit results returned by using `->atLeastFuzzy()`
+
+```php
+User::whereFuzzy('name', 'jd')
+    ->atLeastFuzzy(70)
+    ->first();
+
+// Equivalent to:
+
+User::whereFuzzy('name', 'jd')
+    ->having('_fuzzy_relevance_', '>',  70)
+    ->first();
+```
 
 ## Limitations
 
@@ -104,4 +121,4 @@ If you'd like to support the development of Quest, then please consider [sponsor
 
 ## License
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

src/Macros/AtLeast.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types = 1);
+
+namespace Quest\Macros;
+
+use Illuminate\Database\Query\Builder;
+
+class AtLeast
+{
+    /**
+     * Construct a fuzzy search expression.
+     *
+     **/
+    public static function make(Builder $builder, int $minScore) : Builder
+    {
+        $builder->having('_fuzzy_relevance_', '>',  $minScore);
+        return $builder;
+    }
+}

src/ServiceProvider.php

@@ -3,6 +3,7 @@
 namespace Quest;
 
 use Closure;
+use Quest\Macros\AtLeast;
 use Quest\Macros\WhereFuzzy;
 use Quest\Macros\OrderByFuzzy;
 use Illuminate\Database\Query\Builder;
@@ -40,5 +41,7 @@ public function boot(): void
 
             return WhereFuzzy::makeOr($this, $field, $value);
         });
+
+        Builder::macro('atLeastFuzzy', fn($minScore) => AtLeast::make($this, $minScore));
     }
 }

tests/PackageTest.php

@@ -174,4 +174,20 @@ public function it_can_perform_an_eloquent_fuzzy_and_search_with_fuzzy_order()
 
         $this->assertEquals('Jane Doe', $results->first()->name);
     }
+
+    /** @test */
+    public function it_can_limit_minimum_score()
+    {
+        $results = User::whereFuzzy('name', 'joh Do')
+            ->atLeastFuzzy(65)
+            ->get();
+
+        $this->assertEquals('John Doe', $results->first()->name);
+
+        $results = User::whereFuzzy('name', 'joh Do')
+            ->atLeastFuzzy(70)
+            ->get();
+
+        $this->assertCount(0, $results);
+    }
 }