refactoring

Author: mattkingshott

README.md

@@ -89,21 +89,21 @@ User::whereFuzzy('name', 'jd')
     ->orderBy('relevance_email', 'desc')
     ->first();
 ```
-### Setting Minimum Match Threshold
+### Applying a minimum threshold
 
-When using quest an overall score will be assigned to each row `_fuzzy_relevance_` with a range of 0-100.
+When using Quest, an overall score will be assigned to each record within the `_fuzzy_relevance_` column. This score is represented as an `integer` between 0 and 100.
 
-You can enforce a minimum match standard and limit results returned by using `->atLeastFuzzy()`
+You can enforce a minimum score to restrict the results by using the `withMinimumRelevance()` method. Setting a higher score will return fewer, but likely more-relevant results.
 
 ```php
+// Before
 User::whereFuzzy('name', 'jd')
-    ->atLeastFuzzy(70)
+    ->having('_fuzzy_relevance_', '>',  70)
     ->first();
 
-// Equivalent to:
-
+// After
 User::whereFuzzy('name', 'jd')
-    ->having('_fuzzy_relevance_', '>',  70)
+    ->withMinimumRelevance(70)
     ->first();
 ```
 

resources/build.svg

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

resources/coverage.svg

@@ -3,10 +3,10 @@
 namespace Quest;
 
 use Closure;
-use Quest\Macros\AtLeast;
 use Quest\Macros\WhereFuzzy;
 use Quest\Macros\OrderByFuzzy;
 use Illuminate\Database\Query\Builder;
+use Quest\Macros\withMinimumRelevance;
 use Illuminate\Support\ServiceProvider as Provider;
 
 class ServiceProvider extends Provider
@@ -42,6 +42,6 @@ public function boot(): void
             return WhereFuzzy::makeOr($this, $field, $value);
         });
 
-        Builder::macro('atLeastFuzzy', fn($minScore) => AtLeast::make($this, $minScore));
+        Builder::macro('withMinimumRelevance', fn($score) => withMinimumRelevance::make($this, $score));
     }
 }

resources/version.svg

@@ -179,13 +179,13 @@ public function it_can_perform_an_eloquent_fuzzy_and_search_with_fuzzy_order()
     public function it_can_limit_minimum_score()
     {
         $results = User::whereFuzzy('name', 'joh Do')
-            ->atLeastFuzzy(65)
+            ->withMinimumRelevance(65)
             ->get();
 
         $this->assertEquals('John Doe', $results->first()->name);
 
         $results = User::whereFuzzy('name', 'joh Do')
-            ->atLeastFuzzy(70)
+            ->withMinimumRelevance(70)
             ->get();
 
         $this->assertCount(0, $results);