Doc Type Fixes (#1891)

* Update NumberFilter and TypeHints * Update DateFilter/DateTimeFilter and ConfigurableAreasHelpers for typehints and array key exists * Add Float Test for NumberFilter * Add ColorColumn View Test * Adjust ColumnSelectConfigurationTest --------- Co-authored-by: lrljoe <[email protected]>
rappasoft · Aug 25, 2024 · d0da3b1 · d0da3b1
1 parent b927a98
commit d0da3b1
Show file tree

Hide file tree

Showing 19 changed files with 77 additions and 47 deletions.
diff --git a/src/Traits/Configuration/FooterConfiguration.php b/src/Traits/Configuration/FooterConfiguration.php
@@ -46,14 +46,14 @@ public function setUseHeaderAsFooterDisabled(): self
         return $this;
     }
 
-    public function setFooterTrAttributes(callable $callback): self
+    public function setFooterTrAttributes(\Closure $callback): self
     {
         $this->footerTrAttributesCallback = $callback;
 
         return $this;
     }
 
-    public function setFooterTdAttributes(callable $callback): self
+    public function setFooterTdAttributes(\Closure $callback): self
     {
         $this->footerTdAttributesCallback = $callback;
 

diff --git a/src/Traits/Configuration/SecondaryHeaderConfiguration.php b/src/Traits/Configuration/SecondaryHeaderConfiguration.php
@@ -25,14 +25,14 @@ public function setSecondaryHeaderDisabled(): self
         return $this;
     }
 
-    public function setSecondaryHeaderTrAttributes(callable $callback): self
+    public function setSecondaryHeaderTrAttributes(\Closure $callback): self
     {
         $this->secondaryHeaderTrAttributesCallback = $callback;
 
         return $this;
     }
 
-    public function setSecondaryHeaderTdAttributes(callable $callback): self
+    public function setSecondaryHeaderTdAttributes(\Closure $callback): self
     {
         $this->secondaryHeaderTdAttributesCallback = $callback;
 

diff --git a/src/Traits/Configuration/TableAttributeConfiguration.php b/src/Traits/Configuration/TableAttributeConfiguration.php
@@ -68,7 +68,7 @@ public function setTbodyAttributes(array $attributes = []): self
     /**
      * Set a list of attributes to override on the th elements
      */
-    public function setThAttributes(callable $callback): self
+    public function setThAttributes(\Closure $callback): self
     {
         $this->thAttributesCallback = $callback;
 
@@ -78,7 +78,7 @@ public function setThAttributes(callable $callback): self
     /**
      * Set a list of attributes to override on the th sort button elements
      */
-    public function setThSortButtonAttributes(callable $callback): self
+    public function setThSortButtonAttributes(\Closure $callback): self
     {
         $this->thSortButtonAttributesCallback = $callback;
 
@@ -88,7 +88,7 @@ public function setThSortButtonAttributes(callable $callback): self
     /**
      * Set a list of attributes to override on the td elements
      */
-    public function setTrAttributes(callable $callback): self
+    public function setTrAttributes(\Closure $callback): self
     {
         $this->trAttributesCallback = $callback;
 
@@ -98,21 +98,21 @@ public function setTrAttributes(callable $callback): self
     /**
      * Set a list of attributes to override on the td elements
      */
-    public function setTdAttributes(callable $callback): self
+    public function setTdAttributes(\Closure $callback): self
     {
         $this->tdAttributesCallback = $callback;
 
         return $this;
     }
 
-    public function setTableRowUrl(callable $callback): self
+    public function setTableRowUrl(\Closure $callback): self
     {
         $this->trUrlCallback = $callback;
 
         return $this;
     }
 
-    public function setTableRowUrlTarget(callable $callback): self
+    public function setTableRowUrlTarget(\Closure $callback): self
     {
         $this->trUrlTargetCallback = $callback;
 

diff --git a/src/Traits/Helpers/ConfigurableAreasHelpers.php b/src/Traits/Helpers/ConfigurableAreasHelpers.php
@@ -21,12 +21,9 @@ public function hasConfigurableAreaFor(string $area): bool
         return isset($this->configurableAreas[$area]) && $this->getConfigurableAreaFor($area) !== null;
     }
 
-    /**
-     * @param  string|array<mixed>  $area
-     */
-    public function getConfigurableAreaFor($area): ?string
+    public function getConfigurableAreaFor(string $area): ?string
     {
-        $area = $this->configurableAreas[$area] ?? null;
+        $area = array_key_exists($area, $this->configurableAreas) ? $this->configurableAreas[$area] : null;
 
         if (is_array($area)) {
             return $area[0];
@@ -35,13 +32,9 @@ public function getConfigurableAreaFor($area): ?string
         return $area;
     }
 
-    /**
-     * @param  string|array<mixed>  $area
-     * @return array<mixed>
-     */
-    public function getParametersForConfigurableArea($area): array
+    public function getParametersForConfigurableArea(string $area): array
     {
-        $area = $this->configurableAreas[$area] ?? null;
+        $area = array_key_exists($area, $this->configurableAreas) ? $this->configurableAreas[$area] : null;
 
         if (is_array($area) && isset($area[1]) && is_array($area[1])) {
             return $area[1];

diff --git a/src/Traits/Helpers/SearchHelpers.php b/src/Traits/Helpers/SearchHelpers.php
@@ -123,7 +123,11 @@ public function getSearchOptions(): string
 
     public function getSearchPlaceholder(): string
     {
-        return $this->hasSearchPlaceholder() ? $this->searchPlaceholder : __('Search');
+        if ($this->hasSearchPlaceholder()) {
+            return $this->searchPlaceholder;
+        }
+
+        return __('Search');
     }
 
     public function hasSearchPlaceholder(): bool

diff --git a/src/Traits/WithFooter.php b/src/Traits/WithFooter.php
@@ -16,9 +16,9 @@ trait WithFooter
 
     protected bool $columnsWithFooter = false;
 
-    protected ?object $footerTrAttributesCallback;
+    protected ?\Closure $footerTrAttributesCallback;
 
-    protected ?object $footerTdAttributesCallback;
+    protected ?\Closure $footerTdAttributesCallback;
 
     public function setupFooter(): void
     {

diff --git a/src/Traits/WithSecondaryHeader.php b/src/Traits/WithSecondaryHeader.php
@@ -14,9 +14,9 @@ trait WithSecondaryHeader
 
     protected bool $columnsWithSecondaryHeader = false;
 
-    protected ?object $secondaryHeaderTrAttributesCallback;
+    protected ?\Closure $secondaryHeaderTrAttributesCallback;
 
-    protected ?object $secondaryHeaderTdAttributesCallback;
+    protected ?\Closure $secondaryHeaderTdAttributesCallback;
 
     public function bootedWithSecondaryHeader(): void
     {

diff --git a/src/Traits/WithTableAttributes.php b/src/Traits/WithTableAttributes.php
@@ -21,15 +21,15 @@ trait WithTableAttributes
 
     protected array $tbodyAttributes = [];
 
-    protected ?object $thAttributesCallback;
+    protected ?\Closure $thAttributesCallback;
 
-    protected ?object $thSortButtonAttributesCallback;
+    protected ?\Closure $thSortButtonAttributesCallback;
 
-    protected ?object $trAttributesCallback;
+    protected ?\Closure $trAttributesCallback;
 
-    protected ?object $tdAttributesCallback;
+    protected ?\Closure $tdAttributesCallback;
 
-    protected ?object $trUrlCallback;
+    protected ?\Closure $trUrlCallback;
 
-    protected ?object $trUrlTargetCallback;
+    protected ?\Closure $trUrlTargetCallback;
 }
diff --git a/src/Views/Columns/ColorColumn.php b/src/Views/Columns/ColorColumn.php
@@ -17,7 +17,7 @@ class ColorColumn extends Column
         ColorColumnHelpers;
     use HasDefaultStringValue;
 
-    public ?object $colorCallback = null;
+    public ?\Closure $colorCallback;
 
     protected string $view = 'livewire-tables::includes.columns.color';
 

diff --git a/src/Views/Filters/DateFilter.php b/src/Views/Filters/DateFilter.php
@@ -23,14 +23,20 @@ public function validate(string $value): string|bool
     {
         $this->setInputDateFormat('Y-m-d')->setOutputDateFormat($this->getConfig('pillFormat') ?? 'Y-m-d');
         $carbonDate = $this->createCarbonDate($value);
+        if ($carbonDate instanceof \Carbon\Carbon) {
+            return $carbonDate->format('Y-m-d');
+        }
 
-        return ($carbonDate === false) ? false : $carbonDate->format('Y-m-d');
+        return false;
     }
 
-    public function getFilterPillValue($value): array|string|bool|null
+    public function getFilterPillValue($value): ?string
     {
         if ($this->validate($value)) {
-            return $this->outputTranslatedDate($this->createCarbonDate($value));
+            $carbonDate = $this->createCarbonDate($value);
+            if ($carbonDate instanceof \Carbon\Carbon) {
+                return $this->outputTranslatedDate($carbonDate);
+            }
         }
 
         return null;

diff --git a/src/Views/Filters/DateTimeFilter.php b/src/Views/Filters/DateTimeFilter.php
@@ -24,14 +24,20 @@ public function validate(string $value): string|bool
         $this->setInputDateFormat('Y-m-d\TH:i')->setOutputDateFormat($this->getConfig('pillFormat'));
 
         $carbonDate = $this->createCarbonDate($value);
+        if ($carbonDate instanceof \Carbon\Carbon) {
+            return $carbonDate->format('Y-m-d\TH:i');
+        }
 
-        return ($carbonDate === false) ? false : $carbonDate->format('Y-m-d\TH:i');
+        return false;
     }
 
-    public function getFilterPillValue($value): array|string|bool|null
+    public function getFilterPillValue($value): ?string
     {
         if ($this->validate($value)) {
-            return $this->outputTranslatedDate($this->createCarbonDate($value));
+            $carbonDate = $this->createCarbonDate($value);
+            if ($carbonDate && $carbonDate instanceof \Carbon\Carbon) {
+                return $this->outputTranslatedDate($carbonDate);
+            }
         }
 
         return null;

diff --git a/src/Views/Filters/NumberFilter.php b/src/Views/Filters/NumberFilter.php
@@ -15,8 +15,16 @@ class NumberFilter extends Filter
 
     protected string $view = 'livewire-tables::components.tools.filters.number';
 
-    public function validate(mixed $value): float|int|bool
+    public function validate(float|int|string|array $value): float|int|string|false
     {
-        return is_numeric($value) ? $value : false;
+        if (is_array($value)) {
+            return false;
+        } elseif (is_float($value)) {
+            return (float) $value;
+        } elseif (is_int($value)) {
+            return (int) $value;
+        }
+
+        return false;
     }
 }
diff --git a/src/Views/Traits/Configuration/ColorColumnConfiguration.php b/src/Views/Traits/Configuration/ColorColumnConfiguration.php
@@ -6,7 +6,7 @@
 
 trait ColorColumnConfiguration
 {
-    public function color(callable $callback): self
+    public function color(\Closure $callback): self
     {
         $this->colorCallback = $callback;
 

diff --git a/src/Views/Traits/Core/HasFooter.php b/src/Views/Traits/Core/HasFooter.php
@@ -63,7 +63,7 @@ public function footerCallbackIsFilter(): bool
         return $callback instanceof Filter;
     }
 
-    public function getFooterContents(mixed $rows, array $filterGenericData): string|HtmlString
+    public function getFooterContents(mixed $rows, array $filterGenericData): \Illuminate\Contracts\Foundation\Application|\Illuminate\View\Factory|\Illuminate\View\View|string|HtmlString
     {
         $value = null;
         $callback = $this->getFooterCallback();

diff --git a/src/Views/Traits/Core/HasSecondaryHeader.php b/src/Views/Traits/Core/HasSecondaryHeader.php
@@ -63,7 +63,7 @@ public function secondaryHeaderCallbackIsFilter(): bool
         return $callback instanceof Filter;
     }
 
-    public function getSecondaryHeaderContents(mixed $rows, array $filterGenericData): string|HtmlString
+    public function getSecondaryHeaderContents(mixed $rows, array $filterGenericData): \Illuminate\Contracts\Foundation\Application|\Illuminate\View\Factory|\Illuminate\View\View|string|HtmlString
     {
         $value = null;
         $callback = $this->getSecondaryHeaderCallback();

diff --git a/src/Views/Traits/Helpers/ColorColumnHelpers.php b/src/Views/Traits/Helpers/ColorColumnHelpers.php
@@ -10,7 +10,7 @@ trait ColorColumnHelpers
     // TODO: Test
     public function getColor(Model|int $row): string
     {
-        return $this->hasColorCallback() ? app()->call($this->getColorCallback(), ['row' => $row]) : ($this->getValue($row));
+        return $this->hasColorCallback() ? app()->call($this->getColorCallback(), ['row' => $row, 'value' => $row->{$this->getFrom()} ?? '']) : ($this->getValue($row));
     }
 
     public function getColorCallback(): ?callable

diff --git a/tests/Traits/Configuration/ColumnSelectConfigurationTest.php b/tests/Traits/Configuration/ColumnSelectConfigurationTest.php
@@ -99,7 +99,7 @@ public function test_can_check_all_columns_get_selected(): void
 
     }
 
-    public function test_check_get_selected_columns()
+    public function test_check_get_selected_columns(): void
     {
 
         $this->basicTable->deselectAllColumns();
@@ -116,6 +116,8 @@ public function test_can_check_all_columns_get_selected_and_extra_methods_work()
     {
         $this->assertTrue($this->basicTable->allSelectedColumnsAreVisibleByDefault());
 
+        $this->assertSame(8, count($this->basicTable->getDefaultVisibleColumns()));
+
         $this->assertTrue($this->basicTable->allVisibleColumnsAreSelected());
 
         $this->basicTable->deselectAllColumns();

diff --git a/tests/Views/Columns/ColorColumnTest.php b/tests/Views/Columns/ColorColumnTest.php
@@ -19,6 +19,9 @@ public function test_can_get_the_column_view(): void
         $column = ColorColumn::make('Favorite Color', 'favorite_color');
 
         $this->assertSame('livewire-tables::includes.columns.color', $column->getView());
+        $column->setView('test-color-column');
+        $this->assertSame('test-color-column', $column->getView());
+
     }
 
     public function test_can_infer_field_name_from_title_if_no_from(): void
@@ -35,6 +38,13 @@ public function test_can_set_base_field_from_from(): void
         $this->assertSame('favorite_color', $column->getField());
     }
 
+    public function test_can_set_view(): void
+    {
+        $column = ColorColumn::make('Favorite Color', 'favorite_color');
+
+        $this->assertSame('livewire-tables::includes.columns.color', $column->getView());
+    }
+
     public function test_can_set_default_value(): void
     {
         $column = ColorColumn::make('Favorite Color', 'favorite_color')->defaultValue('#FEFEFE');

diff --git a/tests/Views/Filters/NumberFilterTest.php b/tests/Views/Filters/NumberFilterTest.php
@@ -157,7 +157,8 @@ public function test_can_set_number_filter_to_number(): void
     {
         $filter = NumberFilter::make('BreedID');
         $this->assertSame(123, $filter->validate(123));
-        $this->assertSame(123, $filter->validate('123'));
+        $this->assertSame(123.51, $filter->validate(123.51));
+        $this->assertFalse($filter->validate('123'));
     }
 
     public function test_can_get_if_number_filter_empty(): void