Updates/tests

Author: rappasoft

CHANGELOG.md

@@ -9,6 +9,10 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 ### Added
 
 - Added functionality to hide individual filters from popover and slide down views
+- Added functionality to hide individual filters from filter pills
+- Added functionality to hide individual filters from the active filter count
+- Added functionality to say which filters get reset by the clear button
+- Added functionality to set filters as secondaryHeader or footer of columns
 
 ## [2.6.0] - 2022-05-05
 

docs/filters/available-methods.md

@@ -206,19 +206,3 @@ If the filter takes any config options, you can set them with the `config` metho
         'max' => '2021-12-31',
     ])
 ```
-
-### Hiding filters
-
-If you don't want the filter to be visible in the `ui`, you can use the `hidden` method:
-
-```php
-
-    // this filter won't  be seen in popover and slide down
-    SelectFilter::make('Active')
-        ->options([
-            '' => 'All',
-            'yes' => 'Yes',
-            'no' => 'No',
-        ])
-        ->hidden() // hide the filter from popover and slidedown
-```

src/Traits/Helpers/FilterHelpers.php

@@ -58,7 +58,6 @@ public function hasFilters(): bool
         return $this->getFilters()->count();
     }
 
-    // TODO: Test
     public function hasVisibleFilters(): bool
     {
         return $this->getFilters()
@@ -124,7 +123,6 @@ public function hasAppliedFiltersWithValues(): bool
         return count($this->getAppliedFiltersWithValues());
     }
 
-    // TODO: Test
     public function hasAppliedVisibleFiltersWithValuesThatCanBeCleared(): bool
     {
         return collect($this->getAppliedFiltersWithValues())

src/Views/Traits/Configuration/FilterConfiguration.php

@@ -43,28 +43,39 @@ public function setFilterPillValues(array $values): self
         return $this;
     }
 
-    // TODO: Test
+    /**
+     * @return $this
+     */
     public function hiddenFromMenus(): self
     {
         $this->hiddenFromMenus = true;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function hiddenFromPills(): self
     {
         $this->hiddenFromPills = true;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function hiddenFromFilterCount(): self
     {
         $this->hiddenFromFilterCount = true;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function hiddenFromAll(): self
     {
         $this->hiddenFromMenus = true;
@@ -74,6 +85,9 @@ public function hiddenFromAll(): self
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function notResetByClearButton(): self
     {
         $this->resetByClearButton = false;

tests/Views/Traits/Configuration/ColumnConfigurationTest.php

@@ -4,6 +4,7 @@
 
 use Rappasoft\LaravelLivewireTables\Tests\TestCase;
 use Rappasoft\LaravelLivewireTables\Views\Column;
+use Rappasoft\LaravelLivewireTables\Views\Filter;
 
 class ColumnConfigurationTest extends TestCase
 {
@@ -108,4 +109,30 @@ public function can_deselect_column(): void
 
         $this->assertFalse($column->isSelected());
     }
+
+    /** @test */
+    public function can_set_secondary_header_as_filter(): void
+    {
+        $column = Column::make('Name');
+
+        $this->assertFalse($column->hasSecondaryHeader());
+
+        $column->secondaryHeader($this->basicTable->getFilterByKey('breed'));
+
+        $this->assertTrue($column->hasSecondaryHeader());
+        $this->assertInstanceOf(Filter::class, $column->getSecondaryHeaderCallback());
+    }
+
+    /** @test */
+    public function can_set_footer_as_filter(): void
+    {
+        $column = Column::make('Name');
+
+        $this->assertFalse($column->hasFooter());
+
+        $column->footer($this->basicTable->getFilterByKey('breed'));
+
+        $this->assertTrue($column->hasFooter());
+        $this->assertInstanceOf(Filter::class, $column->getFooterCallback());
+    }
 }

tests/Views/Traits/Configuration/FilterConfigurationTest.php

@@ -63,4 +63,70 @@ public function filter_pill_values_can_be_set_for_select(): void
         $this->assertEquals('Yes', $filter->getFilterPillValue('1'));
         $this->assertEquals('Inactive', $filter->getFilterPillValue('0'));
     }
+
+    /** @test */
+    public function can_hide_filter_from_menus(): void
+    {
+        $filter = SelectFilter::make('Active');
+
+        $this->assertFalse($filter->isHiddenFromMenus());
+
+        $filter->hiddenFromMenus();
+
+        $this->assertTrue($filter->isHiddenFromMenus());
+    }
+
+    /** @test */
+    public function can_hide_filter_from_pills(): void
+    {
+        $filter = SelectFilter::make('Active');
+
+        $this->assertFalse($filter->isHiddenFromPills());
+
+        $filter->hiddenFromPills();
+
+        $this->assertTrue($filter->isHiddenFromPills());
+    }
+
+    /** @test */
+    public function can_hide_filter_from_filter_count(): void
+    {
+        $filter = SelectFilter::make('Active');
+
+        $this->assertFalse($filter->isHiddenFromFilterCount());
+
+        $filter->hiddenFromFilterCount();
+
+        $this->assertTrue($filter->isHiddenFromFilterCount());
+    }
+
+    /** @test */
+    public function filter_is_not_reset_by_clear_button(): void
+    {
+        $filter = SelectFilter::make('Active');
+
+        $this->assertTrue($filter->isResetByClearButton());
+
+        $filter->notResetByClearButton();
+
+        $this->assertFalse($filter->isResetByClearButton());
+    }
+
+    /** @test */
+    public function can_be_hidden_from_all(): void
+    {
+        $filter = SelectFilter::make('Active');
+
+        $this->assertFalse($filter->isHiddenFromMenus());
+        $this->assertFalse($filter->isHiddenFromPills());
+        $this->assertFalse($filter->isHiddenFromFilterCount());
+        $this->assertTrue($filter->isResetByClearButton());
+
+        $filter->hiddenFromAll();
+
+        $this->assertTrue($filter->isHiddenFromMenus());
+        $this->assertTrue($filter->isHiddenFromPills());
+        $this->assertTrue($filter->isHiddenFromFilterCount());
+        $this->assertTrue($filter->isResetByClearButton());
+    }
 }

tests/Views/Traits/Helpers/FilterHelpersTest.php

@@ -138,7 +138,7 @@ public function can_check_filter_config_by_name(): void
     }
 
     /** @test */
-    public function can_check_if_filter_is_hidden(): void
+    public function can_check_if_filter_is_hidden_from_menus(): void
     {
         $filter = SelectFilter::make('Active');