Merge pull request #776 from rappasoft/column-select

rappasoft · web-flow · commit 7d2a8c8804b8 · 2022-06-07T20:37:26.000-04:00
Column select
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,15 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 ## [Unreleased]
 
+## [column-select-dev] - 2022-05-16
+
+### Added
+
+- Added functionality to bookmark or deep link column selection
+- Added functionality to identify different datatable components as unique in column selection
+- Added Funcitonality to configure query string alias
+- Added Funcitonality to configure session key for column selection (dataTableFingerprint)
+
 ## [2.7.0] - 2022-05-07
 
 ### Added
diff --git a/docs/columns/column-selection.md b/docs/columns/column-selection.md
@@ -95,4 +95,19 @@ public function configure(): void
     // Shorthand for $this->setRememberColumnSelectionStatus(false)
     $this->setRememberColumnSelectionDisabled();
 }
-```
+```
+
+### setDataTableFingerprint
+
+In order to idenfify each table and prevent conflicts on column selection, each table is given a unique fingerprint.
+This fingerprint is generated using the static::class name of the component. If you are reusing
+the same component in different parts of your application, you may need to set your own custom fingerprint.
+
+```php
+public function configure(): void
+{
+    // Default fingerprint is output of protected method dataTableFingerprint()
+    // Below will prepend the current route name
+    $this->setDataTableFingerprint(route()->getName() . '-' . $this->dataTableFingerprint());
+}
+```
diff --git a/docs/misc/multiple-tables.md b/docs/misc/multiple-tables.md
@@ -92,3 +92,14 @@ public function configure(): void
     $this->setQueryStringDisabled();
 }
 ```
+
+## Disabling column selection for multiple of the same component
+
+You should also disable the columns selection for those components so the column selection state does not get replaced by one or the other:
+
+```php
+public function configure(): void
+{
+    $this->setColumnSelectStatus(false);
+}
+```
diff --git a/resources/views/components/tools/toolbar.blade.php b/resources/views/components/tools/toolbar.blade.php
@@ -260,7 +260,7 @@ class="text-indigo-600 rounded border-gray-300 shadow-sm transition duration-150
                                                         wire:target="selectedColumns"
                                                         wire:loading.attr="disabled"
                                                         type="checkbox"
-                                                        value="{{ $column->getHash() }}"
+                                                        value="{{ $column->getSlug() }}"
                                                     />
                                                     <span class="ml-2">{{ $column->getTitle() }}</span>
                                                 </label>
@@ -511,7 +511,7 @@ class="px-2 {{ $loop->last ? 'mb-0' : 'mb-1' }}"
                                                 wire:target="selectedColumns"
                                                 wire:loading.attr="disabled"
                                                 type="checkbox"
-                                                value="{{ $column->getHash() }}"
+                                                value="{{ $column->getSlug() }}"
                                             />
                                             <span class="ml-2">{{ $column->getTitle() }}</span>
                                         </label>
@@ -754,7 +754,7 @@ class="px-2 {{ $loop->last ? 'mb-0' : 'mb-1' }}"
                                                 wire:target="selectedColumns"
                                                 wire:loading.attr="disabled"
                                                 type="checkbox"
-                                                value="{{ $column->getHash() }}"
+                                                value="{{ $column->getSlug() }}"
                                             />
                                             <span class="ml-2">{{ $column->getTitle() }}</span>
                                         </label>
@@ -813,4 +813,4 @@ class="d-block">
 
 @if ($component->hasConfigurableAreaFor('after-toolbar'))
     @include($component->getConfigurableAreaFor('after-toolbar'), $component->getParametersForConfigurableArea('after-toolbar'))
-@endif
+@endif
diff --git a/src/DataTableComponent.php b/src/DataTableComponent.php
@@ -47,6 +47,17 @@ abstract class DataTableComponent extends Component
         'clearFilters' => 'clearFilterEvent',
     ];
 
+    /**
+     * returns a unique id for the table, used as an alias to identify one table from another session and query string to prevent conflicts
+     */
+    protected function dataTableFingerprint(): string
+    {
+        $className = str_split(static::class);
+        $crc32 = sprintf('%u', crc32(serialize($className)));
+
+        return base_convert($crc32, 10, 36);
+    }
+
     /**
      * Runs on every request, immediately after the component is instantiated, but before any other lifecycle methods are called
      */
@@ -55,8 +66,9 @@ public function boot(): void
         $this->{$this->tableName} = [
             'sorts' => $this->{$this->tableName}['sorts'] ?? [],
             'filters' => $this->{$this->tableName}['filters'] ?? [],
+            'columns' => $this->{$this->tableName}['columns'] ?? [],
         ];
-
+        
         // Set the filter defaults based on the filter type
         $this->setFilterDefaults();
     }
diff --git a/src/Traits/ComponentUtilities.php b/src/Traits/ComponentUtilities.php
@@ -56,7 +56,7 @@ public function queryString(): array
     {
         if ($this->queryStringIsEnabled()) {
             return [
-                $this->getTableName() => ['except' => null],
+                $this->getTableName() => ['except' => null, 'as' => $this->getQueryStringAlias()],
             ];
         }
 
diff --git a/src/Traits/Configuration/ComponentConfiguration.php b/src/Traits/Configuration/ComponentConfiguration.php
@@ -355,4 +355,18 @@ public function setHideConfigurableAreasWhenReorderingDisabled(): self
 
         return $this;
     }
+
+    public function setDataTableFingerprint(string $dataTableFingerprint): self
+    {
+        $this->dataTableFingerprint = $dataTableFingerprint;
+
+        return $this;
+    }
+
+    public function setQueryStringAlias(string $queryStringAlias): self
+    {
+        $this->queryStringAlias = $queryStringAlias;
+
+        return $this;
+    }
 }
diff --git a/src/Traits/Helpers/ColumnSelectHelpers.php b/src/Traits/Helpers/ColumnSelectHelpers.php
@@ -65,7 +65,7 @@ public function rememberColumnSelectionIsDisabled(): bool
      */
     public function columnSelectIsEnabledForColumn($column): bool
     {
-        return in_array($column instanceof Column ? $column->getHash() : $column, $this->selectedColumns, true);
+        return in_array($column instanceof Column ? $column->getSlug() : $column, $this->selectedColumns, true);
     }
 
     /**
@@ -82,6 +82,6 @@ protected function forgetColumnSelectSession()
      */
     protected function getColumnSelectSessionKey()
     {
-        return $this->getTableName().'-columnSelectEnabled';
+        return $this->getDataTableFingerprint().'-columnSelectEnabled';
     }
 }
diff --git a/src/Traits/Helpers/ComponentHelpers.php b/src/Traits/Helpers/ComponentHelpers.php
@@ -8,6 +8,16 @@
 
 trait ComponentHelpers
 {
+    public function getDataTableFingerprint(): string
+    {
+        return $this->dataTableFingerprint ?? $this->dataTableFingerprint();
+    }
+
+    public function getQueryStringAlias(): string
+    {
+        return $this->queryStringAlias ?? $this->getTableName();
+    }
+
     /**
      * @param Builder
      */
diff --git a/src/Traits/WithColumnSelect.php b/src/Traits/WithColumnSelect.php
@@ -31,24 +31,27 @@ public function setupColumnSelect(): void
             ->filter(function ($column) {
                 return $column->isVisible() && $column->isSelectable() && $column->isSelected();
             })
-            ->map(fn ($column) => $column->getHash())
+            ->map(fn ($column) => $column->getSlug())
             ->values()
             ->toArray();
 
         // Set to either the default set or what is stored in the session
-        $this->selectedColumns = session()->get($this->getColumnSelectSessionKey(), $columns);
+        $this->selectedColumns = (isset($this->{$this->tableName}['columns']) && count($this->{$this->tableName}['columns']) > 0) ?
+            $this->{$this->tableName}['columns'] :
+            session()->get($this->getColumnSelectSessionKey(), $columns);
 
         // Check to see if there are any excluded that are already stored in the enabled and remove them
         foreach ($this->getColumns() as $column) {
-            if (! $column->isSelectable() && ! in_array($column->getHash(), $this->selectedColumns, true)) {
-                $this->selectedColumns[] = $column->getHash();
+            if (! $column->isSelectable() && ! in_array($column->getSlug(), $this->selectedColumns, true)) {
+                $this->selectedColumns[] = $column->getSlug();
                 session([$this->getColumnSelectSessionKey() => $this->selectedColumns]);
             }
         }
     }
 
     public function updatedSelectedColumns(): void
     {
-        session([$this->getColumnSelectSessionKey() => $this->selectedColumns]);
+        $this->{$this->tableName}['columns'] = $this->selectedColumns;
+        session([$this->getColumnSelectSessionKey() => $this->{$this->tableName}['columns']]);
     }
 }
diff --git a/src/Views/Traits/Helpers/ColumnHelpers.php b/src/Views/Traits/Helpers/ColumnHelpers.php
@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\HtmlString;
+use Illuminate\Support\Str;
 use Rappasoft\LaravelLivewireTables\DataTableComponent;
 use Rappasoft\LaravelLivewireTables\Exceptions\DataTableConfigurationException;
 use Rappasoft\LaravelLivewireTables\Views\Column;
@@ -20,16 +21,6 @@ public function getComponent(): ?DataTableComponent
         return $this->component;
     }
 
-    /**
-     * @param  DataTableComponent  $component
-     *
-     * @return $this
-     */
-    public function getHash(): string
-    {
-        return $this->hash;
-    }
-
     /**
      * @return bool
      */
@@ -54,6 +45,14 @@ public function getTitle(): string
         return $this->title;
     }
 
+    /**
+     * @return string
+     */
+    public function getSlug(): string
+    {
+        return Str::slug($this->title);
+    }
+
     /**
      * @return string|null
      */
diff --git a/tests/DataTableComponentTest.php b/tests/DataTableComponentTest.php
@@ -40,4 +40,44 @@ public function primary_key_has_to_be_set(): void
 //            ->call('setPrimaryKey', null)
 //            ->call('setSearch', 'abcd');
     }
+
+    /** @test */
+    public function default_fingerprint_will_always_be_the_same_for_same_datatable(): void
+    {
+        $this->assertSame(
+            [
+                $this->basicTable->getDataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
+            ],
+            [
+                $this->basicTable->getDataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
+            ]
+        );
+        $this->assertSame($this->basicTable->getDataTableFingerprint(), $this->defaultFingerprintingAlgo($this->basicTable::class));
+    }
+
+    /** @test */
+    public function default_datatable_fingerprints_will_be_different_for_each_table(): void
+    {
+        $mockTable = new class() extends PetsTable {
+        };
+
+        $this->assertNotSame($this->basicTable->getDataTableFingerprint(), $mockTable->getDataTableFingerprint());
+    }
+
+    /** @test */
+    public function default_fingerprint_will_be_url_friendy(): void
+    {
+        $mocks = [];
+        for ($i = 0; $i < 9; $i++) {
+            $mocks[$i] = new class() extends PetsTable {
+            };
+            $this->assertFalse(filter_var('http://'.$mocks[$i]->getDataTableFingerprint().'.dev', FILTER_VALIDATE_URL) === false);
+        }
+        // control
+        $this->assertTrue(filter_var('http://[9/$].dev', FILTER_VALIDATE_URL) === false);
+    }
 }
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -93,4 +93,12 @@ public function getEnvironmentSetUp($app): void
 
         config()->set('app.key', Encrypter::generateKey(config('app.cipher')));
     }
+
+    protected function defaultFingerPrintingAlgo($className)
+    {
+        $className = str_split($className);
+        $crc32 = sprintf('%u', crc32(serialize($className)));
+
+        return base_convert($crc32, 10, 36);
+    }
 }
diff --git a/tests/Traits/Configuration/FingerprintConfigurationTest.php b/tests/Traits/Configuration/FingerprintConfigurationTest.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Traits\Configuration;
+
+use Rappasoft\LaravelLivewireTables\Tests\Http\Livewire\PetsTable;
+use Rappasoft\LaravelLivewireTables\Tests\TestCase;
+
+class FingerprintConfigurationTest extends TestCase
+{
+    /** @test */
+    public function can_set_fingerprint(): void
+    {
+        $this->assertSame('test', $this->basicTable->setDataTableFingerprint('test')->getDataTableFingerprint());
+    }
+
+    /** @test */
+    public function can_set_fingerprint_in_configure_method(): void
+    {
+        $mock = new class extends PetsTable {
+            public function configure(): void
+            {
+                $this->setDataTableFingerprint('test');
+            }
+        };
+
+        $mock->configure();
+        $mock->boot();
+
+        $this->assertSame('test', $mock->getDataTableFingerprint());
+    }
+}
diff --git a/tests/Traits/Configuration/QueryStringAliasConfigurationTest.php b/tests/Traits/Configuration/QueryStringAliasConfigurationTest.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Traits\Configuration;
+
+use Rappasoft\LaravelLivewireTables\Tests\Http\Livewire\PetsTable;
+use Rappasoft\LaravelLivewireTables\Tests\TestCase;
+
+class QueryStringAliasConfigurationTest extends TestCase
+{
+    /** @test */
+    public function can_set_query_string_alias(): void
+    {
+        $this->assertSame('test', $this->basicTable->setQueryStringAlias('test')->getQueryStringAlias());
+    }
+
+    /** @test */
+    public function can_set_query_string_in_configure_method(): void
+    {
+        $mock = new class extends PetsTable {
+            public function configure(): void
+            {
+                $this->setQueryStringAlias('test');
+            }
+        };
+    
+        $mock->configure();
+        $mock->boot();
+    
+        $this->assertSame('test', $mock->getQueryStringAlias());
+    }
+}
diff --git a/tests/Traits/Helpers/ComponentHelpersTest.php b/tests/Traits/Helpers/ComponentHelpersTest.php
@@ -225,4 +225,16 @@ public function can_get_hide_configurable_areas_when_reordering_status(): void
 
         $this->assertFalse($this->basicTable->hideConfigurableAreasWhenReorderingIsDisabled());
     }
+
+    /** @test */
+    public function can_get_dataTable_fingerprint(): void
+    {
+        $this->assertSame($this->defaultFingerPrintingAlgo($this->basicTable::class), $this->basicTable->getDataTableFingerprint());
+    }
+
+    /** @test */
+    public function can_get_query_string_alias_and_it_will_be_the_same_as_table_name_by_default(): void
+    {
+        $this->assertSame($this->basicTable->getTableName(), $this->basicTable->getQueryStringAlias());
+    }
 }
diff --git a/tests/Traits/Visuals/ReorderingVisualsTest.php b/tests/Traits/Visuals/ReorderingVisualsTest.php
diff --git a/tests/Views/Traits/Helpers/ColumnHelpersTest.php b/tests/Views/Traits/Helpers/ColumnHelpersTest.php

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public function queryString(): array`
`56`	`56`	`{`
`57`	`57`	`if ($this->queryStringIsEnabled()) {`
`58`	`58`	`return [`
`59`		`- $this->getTableName() => ['except' => null],`
	`59`	`+ $this->getTableName() => ['except' => null, 'as' => $this->getQueryStringAlias()],`
`60`	`60`	`];`
`61`	`61`	`}`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function rememberColumnSelectionIsDisabled(): bool`
`65`	`65`	`*/`
`66`	`66`	`public function columnSelectIsEnabledForColumn($column): bool`
`67`	`67`	`{`
`68`		`- return in_array($column instanceof Column ? $column->getHash() : $column, $this->selectedColumns, true);`
	`68`	`+ return in_array($column instanceof Column ? $column->getSlug() : $column, $this->selectedColumns, true);`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`
`@@ -82,6 +82,6 @@ protected function forgetColumnSelectSession()`
`82`	`82`	`*/`
`83`	`83`	`protected function getColumnSelectSessionKey()`
`84`	`84`	`{`
`85`		`- return $this->getTableName().'-columnSelectEnabled';`
	`85`	`+ return $this->getDataTableFingerprint().'-columnSelectEnabled';`
`86`	`86`	`}`
`87`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,24 +31,27 @@ public function setupColumnSelect(): void`
`31`	`31`	`->filter(function ($column) {`
`32`	`32`	`return $column->isVisible() && $column->isSelectable() && $column->isSelected();`
`33`	`33`	`})`
`34`		`- ->map(fn ($column) => $column->getHash())`
	`34`	`+ ->map(fn ($column) => $column->getSlug())`
`35`	`35`	`->values()`
`36`	`36`	`->toArray();`
`37`	`37`
`38`	`38`	`// Set to either the default set or what is stored in the session`
`39`		`- $this->selectedColumns = session()->get($this->getColumnSelectSessionKey(), $columns);`
	`39`	`+ $this->selectedColumns = (isset($this->{$this->tableName}['columns']) && count($this->{$this->tableName}['columns']) > 0) ?`
	`40`	`+ $this->{$this->tableName}['columns'] :`
	`41`	`+ session()->get($this->getColumnSelectSessionKey(), $columns);`
`40`	`42`
`41`	`43`	`// Check to see if there are any excluded that are already stored in the enabled and remove them`
`42`	`44`	`foreach ($this->getColumns() as $column) {`
`43`		`- if (! $column->isSelectable() && ! in_array($column->getHash(), $this->selectedColumns, true)) {`
`44`		`- $this->selectedColumns[] = $column->getHash();`
	`45`	`+ if (! $column->isSelectable() && ! in_array($column->getSlug(), $this->selectedColumns, true)) {`
	`46`	`+ $this->selectedColumns[] = $column->getSlug();`
`45`	`47`	`session([$this->getColumnSelectSessionKey() => $this->selectedColumns]);`
`46`	`48`	`}`
`47`	`49`	`}`
`48`	`50`	`}`
`49`	`51`
`50`	`52`	`public function updatedSelectedColumns(): void`
`51`	`53`	`{`
`52`		`- session([$this->getColumnSelectSessionKey() => $this->selectedColumns]);`
	`54`	`+ $this->{$this->tableName}['columns'] = $this->selectedColumns;`
	`55`	`+ session([$this->getColumnSelectSessionKey() => $this->{$this->tableName}['columns']]);`
`53`	`56`	`}`
`54`	`57`	`}`