Ends with strict (#885)

* feat: ends with strict

* update: docs

Author: utsavsomaiya

docs/features/filtering.md

@@ -5,7 +5,7 @@ weight: 1
 
 The `filter` query parameters can be used to add `where` clauses to your Eloquent query. Out of the box we support filtering results by partial attribute value, exact attribute value or even if an attribute value exists in a given array of values. For anything more advanced, custom filters can be used.
 
-By default, all filters have to be explicitly allowed using `allowedFilters()`. This method takes an array of strings or `AllowedFilter` instances. An allowed filter can be partial, beginsWithStrict, exact, scope or custom. By default, any string values passed to `allowedFilters()` will automatically be converted to `AllowedFilter::partial()` filters.
+By default, all filters have to be explicitly allowed using `allowedFilters()`. This method takes an array of strings or `AllowedFilter` instances. An allowed filter can be partial, beginsWithStrict, endsWithStrict, exact, scope or custom. By default, any string values passed to `allowedFilters()` will automatically be converted to `AllowedFilter::partial()` filters.
 
 ## Basic usage
 
@@ -48,9 +48,9 @@ You can set in configuration file to not throw an InvalidFilterQuery exception w
 
 By default the option is set false.
 
-## Partial and beginsWithStrict filters
+## Partial, beginsWithStrict and endsWithStrict filters
 
-By default, all values passed to `allowedFilters` are converted to partial filters. The underlying query will be modified to use a `LIKE LOWER(%value%)` statement. Because this can cause missed indexes, it's often worth considering a `beginsWithStrict` filter instead. This filter will use a `LIKE value%` statement instead.
+By default, all values passed to `allowedFilters` are converted to partial filters. The underlying query will be modified to use a `LIKE LOWER(%value%)` statement. Because this can cause missed indexes, it's often worth considering a `beginsWithStrict` filter for the beginning of the value, or an `endsWithStrict` filter for the end of the value. These filters will use a `LIKE value%` statement and a `LIKE %value` statement respectively, instead of the default partial filter. This can help optimize query performance and index utilization.
 
 ## Exact filters
 

src/AllowedFilter.php

@@ -6,6 +6,7 @@
 use Spatie\QueryBuilder\Filters\Filter;
 use Spatie\QueryBuilder\Filters\FiltersBeginsWithStrict;
 use Spatie\QueryBuilder\Filters\FiltersCallback;
+use Spatie\QueryBuilder\Filters\FiltersEndsWithStrict;
 use Spatie\QueryBuilder\Filters\FiltersExact;
 use Spatie\QueryBuilder\Filters\FiltersPartial;
 use Spatie\QueryBuilder\Filters\FiltersScope;
@@ -78,6 +79,13 @@ public static function beginsWithStrict(string $name, $internalName = null, bool
         return new static($name, new FiltersBeginsWithStrict($addRelationConstraint), $internalName);
     }
 
+    public static function endsWithStrict(string $name, $internalName = null, bool $addRelationConstraint = true, string $arrayValueDelimiter = null): self
+    {
+        static::setFilterArrayValueDelimiter($arrayValueDelimiter);
+
+        return new static($name, new FiltersEndsWithStrict($addRelationConstraint), $internalName);
+    }
+
     public static function scope(string $name, $internalName = null, string $arrayValueDelimiter = null): self
     {
         static::setFilterArrayValueDelimiter($arrayValueDelimiter);

src/Filters/FiltersEndsWithStrict.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Spatie\QueryBuilder\Filters;
+
+/**
+ * @template TModelClass of \Illuminate\Database\Eloquent\Model
+ * @template-implements \Spatie\QueryBuilder\Filters\Filter<TModelClass>
+ */
+class FiltersEndsWithStrict extends FiltersPartial implements Filter
+{
+    protected function getWhereRawParameters($value, string $property): array
+    {
+        return [
+            "{$property} LIKE ?",
+            ["%{$value}"],
+        ];
+    }
+}

tests/FilterTest.php

@@ -142,6 +142,18 @@
     $this->assertQueryLogContains("select * from `test_models` where (`test_models`.`id` LIKE ?)");
 });
 
+test('falsy values are not ignored when applying a ends with strict filter', function () {
+    DB::enableQueryLog();
+
+    createQueryFromFilterRequest([
+            'id' => [0],
+        ])
+        ->allowedFilters(AllowedFilter::endsWithStrict('id'))
+        ->get();
+
+    $this->assertQueryLogContains("select * from `test_models` where (`test_models`.`id` LIKE ?)");
+});
+
 it('can filter partial using begins with strict', function () {
     TestModel::create([
         'name' => 'John Doe',
@@ -161,6 +173,25 @@
     expect($models2->count())->toBe(0);
 });
 
+it('can filter partial using ends with strict', function () {
+    TestModel::create([
+        'name' => 'John Doe',
+    ]);
+
+    $models = createQueryFromFilterRequest(['name' => 'doe'])
+        ->allowedFilters([
+            AllowedFilter::endsWithStrict('name'),
+        ]);
+
+    $models2 = createQueryFromFilterRequest(['name' => 'john'])
+        ->allowedFilters([
+            AllowedFilter::endsWithStrict('name'),
+        ]);
+
+    expect($models->count())->toBe(1);
+    expect($models2->count())->toBe(0);
+});
+
 it('can filter and match results by exact property', function () {
     $testModel = TestModel::first();