Add config for values validation

reachweb · Jan 25, 2024 · fa19ed0 · fa19ed0
1 parent 365ecdd
commit fa19ed0
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 4 deletions.
diff --git a/config/config.php b/config/config.php
@@ -7,4 +7,7 @@
     // Only allow filters for fields and conditions already loaded in the page to be applied
     'only_allow_active_filters' => true,
 
+    // Validate that the values of radio and checkbox filters are in the available options array
+    'validate_filter_values' => true,
+
 ];
diff --git a/src/Http/Livewire/LfCheckboxFilter.php b/src/Http/Livewire/LfCheckboxFilter.php
@@ -31,7 +31,9 @@ public function filterOptions()
 
     public function updatedSelected()
     {
-        $this->validate();
+        if (config('statamic-livewire-filters.validate_filter_values')) {
+            $this->validate();
+        }
 
         $optionsToAdd = array_diff($this->selected, $this->previousSelected);
         $optionsToRemove = array_diff($this->previousSelected, $this->selected);

diff --git a/src/Http/Livewire/LfRadioFilter.php b/src/Http/Livewire/LfRadioFilter.php
@@ -29,7 +29,9 @@ public function filterOptions()
 
     public function updatedSelected()
     {
-        $this->validate();
+        if (config('statamic-livewire-filters.validate_filter_values')) {
+            $this->validate();
+        }
 
         $this->dispatch('filter-updated',
             field: $this->field,

diff --git a/tests/Feature/LfCheckboxFilterTest.php b/tests/Feature/LfCheckboxFilterTest.php
@@ -3,6 +3,7 @@
 namespace Tests\Feature;
 
 use Facades\Reach\StatamicLivewireFilters\Tests\Factories\EntryFactory;
+use Illuminate\Support\Facades\Config;
 use Livewire\Livewire;
 use Reach\StatamicLivewireFilters\Http\Livewire\LfCheckboxFilter;
 use Reach\StatamicLivewireFilters\Tests\PreventSavingStacheItemsToDisk;
@@ -146,7 +147,25 @@ public function it_does_not_accept_a_value_not_in_the_options_array()
         Livewire::test(LfCheckboxFilter::class, ['field' => 'item_options', 'collection' => 'pages', 'blueprint' => 'pages.pages', 'condition' => 'is'])
             ->assertSet('selected', [])
             ->set('selected', ['not-an-option'])
-            ->assertHasErrors('selected');
+            ->assertHasErrors('selected')
+            ->assertNotDispatched('filter-updated');
+    }
+
+    /** @test */
+    public function it_can_turn_off_validation_of_values_in_the_config()
+    {
+        Config::set('statamic-livewire-filters.validate_filter_values', false);
+
+        Livewire::test(LfCheckboxFilter::class, ['field' => 'item_options', 'collection' => 'pages', 'blueprint' => 'pages.pages', 'condition' => 'is'])
+            ->assertSet('selected', [])
+            ->set('selected', ['not-an-option'])
+            ->assertSet('selected', ['not-an-option'])
+            ->assertDispatched('filter-updated',
+                field: 'item_options',
+                condition: 'is',
+                payload: 'not-an-option',
+                command: 'add',
+            );
     }
 
     /** @test */

diff --git a/tests/Feature/LfRadioFilterTest.php b/tests/Feature/LfRadioFilterTest.php
@@ -3,6 +3,7 @@
 namespace Tests\Feature;
 
 use Facades\Reach\StatamicLivewireFilters\Tests\Factories\EntryFactory;
+use Illuminate\Support\Facades\Config;
 use Livewire\Livewire;
 use Reach\StatamicLivewireFilters\Http\Livewire\LfRadioFilter;
 use Reach\StatamicLivewireFilters\Tests\PreventSavingStacheItemsToDisk;
@@ -112,7 +113,25 @@ public function it_does_not_accept_a_value_not_in_the_options_array()
         Livewire::test(LfRadioFilter::class, ['field' => 'item_options', 'collection' => 'pages', 'blueprint' => 'pages.pages', 'condition' => 'is'])
             ->assertSet('selected', '')
             ->set('selected', 'not-an-option')
-            ->assertHasErrors('selected');
+            ->assertHasErrors('selected')
+            ->assertNotDispatched('filter-updated');
+    }
+
+    /** @test */
+    public function it_can_turn_off_validation_in_the_config()
+    {
+        Config::set('statamic-livewire-filters.validate_filter_values', false);
+
+        Livewire::test(LfRadioFilter::class, ['field' => 'item_options', 'collection' => 'pages', 'blueprint' => 'pages.pages', 'condition' => 'is'])
+            ->assertSet('selected', '')
+            ->set('selected', 'not-an-option')
+            ->assertSet('selected', 'not-an-option')
+            ->assertDispatched('filter-updated',
+                field: 'item_options',
+                condition: 'is',
+                payload: 'not-an-option',
+                command: 'replace',
+            );
     }
 
     /** @test */