add tests for filters

Author: fabio-ivona

tests/DataTableComponentTest.php

@@ -3,7 +3,11 @@
 namespace Rappasoft\LaravelLivewireTables\Tests;
 
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+use Illuminate\Encryption\Encrypter;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\View\View;
+use Livewire\Livewire;
 use Rappasoft\LaravelLivewireTables\DataTableComponent;
 use Rappasoft\LaravelLivewireTables\Tests\Http\Livewire\PetsAltQueryTable;
 use Rappasoft\LaravelLivewireTables\Tests\Http\Livewire\PetsTable;
@@ -115,6 +119,42 @@ public function search_filter_alt_query_relation()
         $this->assertEquals(2, $this->tableAltQuery->rows->total());
     }
 
+    /** @test */
+    public function custom_filter()
+    {
+        $this->table->filters['species.name'] = 1;
+
+        $this->assertTrue($this->table->getRowsProperty()->where('name', 'Cartman')->isNotEmpty());
+        $this->assertTrue($this->table->getRowsProperty()->where('name', 'Tux')->isNotEmpty());
+        $this->assertFalse($this->table->getRowsProperty()->where('May', 'Tux')->isNotEmpty());
+        $this->assertFalse($this->table->getRowsProperty()->where('Ben', 'Tux')->isNotEmpty());
+        $this->assertFalse($this->table->getRowsProperty()->where('Chico', 'Tux')->isNotEmpty());
+    }
+
+    /** @test */
+    public function custom_filters_pills_label_use_column_name_when_possible()
+    {
+        config()->set('app.key', Encrypter::generateKey(config('app.cipher')));
+
+        Livewire::test(PetsTable::class)
+            ->set('filters', [
+                'species.name' => 1,
+            ])
+            ->assertSeeTextInOrder(['Applied Filters:', 'Species:', 'Cat', 'Filters']);
+    }
+
+    /** @test */
+    public function custom_filters_pills_label_use_filter_name_when_is_not_bound_to_a_column()
+    {
+        config()->set('app.key', Encrypter::generateKey(config('app.cipher')));
+
+        Livewire::test(PetsTable::class)
+            ->set('filters', [
+                'breed_id' => 1
+            ])
+            ->assertSeeTextInOrder(['Applied Filters:', 'Filter Breed:', 'American Shorthair', 'Filters']);
+    }
+
     /** @test */
     public function bulk_actions_defined_through_function()
     {

tests/Http/Livewire/PetsTable.php

@@ -6,9 +6,30 @@
 use Rappasoft\LaravelLivewireTables\DataTableComponent;
 use Rappasoft\LaravelLivewireTables\Tests\Models\Pet;
 use Rappasoft\LaravelLivewireTables\Views\Column;
+use Rappasoft\LaravelLivewireTables\Views\Filter;
 
 class PetsTable extends DataTableComponent
 {
+    public function filters(): array
+    {
+        return [
+            'species.name' => Filter::make('Filter Species')->select([
+                '' => 'All',
+                1  => 'Cat',
+                2  => 'Dog',
+                3  => 'Horse',
+                4  => 'Bird',
+            ]),
+            'breed_id'     => Filter::make('Filter Breed')->select([
+                '' => 'All',
+                1  => 'American Shorthair',
+                2  => 'Maine Coon',
+                3  => 'Persian',
+                4  => 'Norwegian Forest',
+            ]),
+        ];
+    }
+
     public function bulkActions(): array
     {
         return ['count' => 'Count selected'];
@@ -17,11 +38,13 @@ public function bulkActions(): array
     /**
      * @return Builder
      */
-    public function query() : Builder
+    public function query(): Builder
     {
         return Pet::query()
             ->with('species')
-            ->with('breed');
+            ->with('breed')
+            ->when($this->getFilter('species.name'), fn (Builder $query, $specimen_id) => $query->where('species_id', $specimen_id))
+            ->when($this->getFilter('breed_id'), fn (Builder $query, $breed_id) => $query->where('breed_id', $breed_id));
     }
 
     public function columns(): array