Migrate Filter Status into Own Trait (#2147)

* Migrate Filter Status into Own Trait

* Fix styling

* Update setFiltersStatus to protected

* Fix styling

* Restore filters behaviour to public

---------

Co-authored-by: lrljoe <lrljoe@users.noreply.github.com>

src/Traits/Configuration/FilterConfiguration.php

@@ -2,26 +2,4 @@
 
 namespace Rappasoft\LaravelLivewireTables\Traits\Configuration;
 
-trait FilterConfiguration
-{
-    public function setFiltersStatus(bool $status): self
-    {
-        $this->filtersStatus = $status;
-
-        return $this;
-    }
-
-    public function setFiltersEnabled(): self
-    {
-        $this->setFiltersStatus(true);
-
-        return $this;
-    }
-
-    public function setFiltersDisabled(): self
-    {
-        $this->setFiltersStatus(false);
-
-        return $this;
-    }
-}
+trait FilterConfiguration {}

src/Traits/Core/Filters/HandlesFilterTraits.php

@@ -9,5 +9,6 @@ trait HandlesFilterTraits
         HasFilterMenuStyling,
         HasFilterPillsStyling,
         HasFilterQueryString,
+        HasFiltersStatus,
         HasFiltersVisibility;
 }

src/Traits/Core/Filters/HasFiltersStatus.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits\Core\Filters;
+
+use Livewire\Attributes\Locked;
+
+trait HasFiltersStatus
+{
+    #[Locked]
+    public bool $filtersStatus = true;
+
+    public function getFiltersStatus(): bool
+    {
+        return $this->filtersStatus;
+    }
+
+    public function filtersAreEnabled(): bool
+    {
+        return $this->getFiltersStatus() === true;
+    }
+
+    public function filtersAreDisabled(): bool
+    {
+        return $this->getFiltersStatus() === false;
+    }
+
+    public function setFiltersStatus(bool $status): self
+    {
+        $this->filtersStatus = $status;
+
+        return $this;
+    }
+
+    public function setFiltersEnabled(): self
+    {
+        $this->setFiltersStatus(true);
+
+        return $this;
+    }
+
+    public function setFiltersDisabled(): self
+    {
+        $this->setFiltersStatus(false);
+
+        return $this;
+    }
+}

src/Traits/Helpers/FilterHelpers.php

@@ -11,21 +11,6 @@
 
 trait FilterHelpers
 {
-    public function getFiltersStatus(): bool
-    {
-        return $this->filtersStatus;
-    }
-
-    public function filtersAreEnabled(): bool
-    {
-        return $this->getFiltersStatus() === true;
-    }
-
-    public function filtersAreDisabled(): bool
-    {
-        return $this->getFiltersStatus() === false;
-    }
-
     public function hasFilters(): bool
     {
         return $this->getFiltersCount() > 0;

src/Traits/WithFilters.php

@@ -14,9 +14,6 @@ trait WithFilters
         FilterHelpers;
     use HandlesFilterTraits;
 
-    #[Locked]
-    public bool $filtersStatus = true;
-
     #[Locked]
     public int $filterCount;
 

tests/Unit/Traits/Core/Filters/FilterStatusTest.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Unit\Traits\Core\Filters;
+
+use PHPUnit\Framework\Attributes\Group;
+use Rappasoft\LaravelLivewireTables\Tests\Http\Livewire\PetsTable;
+use Rappasoft\LaravelLivewireTables\Tests\TestCase;
+
+#[Group('Filters')]
+final class FilterStatusTest extends TestCase
+{
+    public function test_can_check_if_filters_are_enabled(): void
+    {
+        $this->assertTrue($this->basicTable->filtersAreEnabled());
+    }
+
+    public function test_can_check_if_filters_can_be_disabled_when_enbled(): void
+    {
+
+        $mock = new class extends PetsTable
+        {
+            public function configure(): void
+            {
+                parent::configure();
+                $this->setFiltersEnabled();
+            }
+
+            public function setFiltersToEnabled()
+            {
+                $this->setFiltersEnabled();
+            }
+
+            public function setFiltersToDisabled()
+            {
+                $this->setFiltersDisabled();
+            }
+        };
+
+        $mock->configure();
+        $mock->boot();
+
+        $this->assertTrue($mock->filtersAreEnabled());
+        $this->assertFalse($mock->filtersAreDisabled());
+
+        $mock->setFiltersToDisabled();
+
+        $this->assertFalse($mock->filtersAreEnabled());
+        $this->assertTrue($mock->filtersAreDisabled());
+
+    }
+
+    public function test_can_check_if_filters_can_be_enabled_when_disabled(): void
+    {
+
+        $mock = new class extends PetsTable
+        {
+            public function configure(): void
+            {
+                parent::configure();
+                $this->setFiltersDisabled();
+            }
+
+            public function setFiltersToEnabled()
+            {
+                $this->setFiltersEnabled();
+            }
+
+            public function setFiltersToDisabled()
+            {
+                $this->setFiltersDisabled();
+            }
+        };
+
+        $mock->configure();
+        $mock->boot();
+
+        $this->assertTrue($mock->filtersAreDisabled());
+        $this->assertFalse($mock->filtersAreEnabled());
+
+        $mock->setFiltersToEnabled();
+        $this->assertTrue($mock->filtersAreEnabled());
+        $this->assertFalse($mock->filtersAreDisabled());
+
+    }
+}