allow new feature to be configured

Author: inmanturbo

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());
+}
+```

docs/datatable/available-methods.md

@@ -353,6 +353,17 @@ public function configure(): void
 }
 ```
 
+### setQueryStringAlias
+
+Set an alias for the query string.
+
+```php
+public function configure(): void
+{
+  $this->setQueryStringAlias('my-custom-alias');
+}
+```
+
 ## Relationships
 
 **Disabled by default**, enable to eager load relationships for all columns in the component.

src/DataTableComponent.php

@@ -50,7 +50,7 @@ abstract class DataTableComponent extends Component
     /**
      * returns a unique id for the table, used as an alias to identify one table from another session and query string to prevent conflicts
      */
-    public function dataTableFingerprint(): string
+    protected function dataTableFingerprint(): string
     {
         $className = str_split(static::class);
         $crc32 = sprintf('%u', crc32(serialize($className)));

src/Traits/ComponentUtilities.php

@@ -56,7 +56,7 @@ public function queryString(): array
     {
         if ($this->queryStringIsEnabled()) {
             return [
-                $this->getTableName() => ['except' => null, 'as' => $this->dataTableFingerprint()],
+                $this->getTableName() => ['except' => null, 'as' => $this->getQueryStringAlias()],
             ];
         }
 

src/Traits/Helpers/ColumnSelectHelpers.php

@@ -82,6 +82,6 @@ protected function forgetColumnSelectSession()
      */
     protected function getColumnSelectSessionKey()
     {
-        return $this->dataTableFingerprint().'-columnSelectEnabled';
+        return $this->getDataTableFingerprint().'-columnSelectEnabled';
     }
 }

src/Traits/Helpers/ComponentHelpers.php

@@ -8,6 +8,30 @@
 
 trait ComponentHelpers
 {
+    public function getDataTableFingerprint(): string
+    {
+        return $this->dataTableFingerprint ?? $this->dataTableFingerprint();
+    }
+
+    public function setDataTableFingerprint(string $dataTableFingerprint): self
+    {
+        $this->dataTableFingerprint = $dataTableFingerprint;
+
+        return $this;
+    }
+
+    public function getQueryStringAlias(): string
+    {
+        return $this->queryStringAlias ?? $this->getTableName();
+    }
+
+    public function setQueryStringAlias(string $queryStringAlias): self
+    {
+        $this->queryStringAlias = $queryStringAlias;
+
+        return $this;
+    }
+
     /**
      * @param Builder
      */

tests/DataTableComponentTest.php

@@ -42,50 +42,42 @@ public function primary_key_has_to_be_set(): void
     }
 
     /** @test */
-    public function fingerprint_will_always_be_the_same_for_same_datatable(): void
+    public function default_fingerprint_will_always_be_the_same_for_same_datatable(): void
     {
         $this->assertSame(
             [
-                $this->basicTable->dataTableFingerprint(),
-                $this->basicTable->dataTableFingerprint(),
-                $this->basicTable->dataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
             ],
             [
-                $this->basicTable->dataTableFingerprint(),
-                $this->basicTable->dataTableFingerprint(),
-                $this->basicTable->dataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
+                $this->basicTable->getDataTableFingerprint(),
             ]
         );
-        $this->assertSame($this->basicTable->dataTableFingerprint(), $this->fingerprintingAlgo($this->basicTable::class));
+        $this->assertSame($this->basicTable->getDataTableFingerprint(), $this->defaultFingerprintingAlgo($this->basicTable::class));
     }
 
     /** @test */
-    public function datatable_fingerprints_will_be_different_for_each_table(): void
+    public function default_datatable_fingerprints_will_be_different_for_each_table(): void
     {
         $mockTable = new class() extends PetsTable {
         };
 
-        $this->assertNotSame($this->basicTable->dataTableFingerprint(), $mockTable->dataTableFingerprint());
+        $this->assertNotSame($this->basicTable->getDataTableFingerprint(), $mockTable->getDataTableFingerprint());
     }
 
     /** @test */
-    public function fingerprint_will_be_url_friendy(): void
+    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]->dataTableFingerprint().'.dev', FILTER_VALIDATE_URL) === false);
+            $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);
     }
-
-    protected function fingerPrintingAlgo($className)
-    {
-        $className = str_split($className);
-        $crc32 = sprintf('%u', crc32(serialize($className)));
-
-        return base_convert($crc32, 10, 36);
-    }
 }

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);
+    }
 }

tests/Traits/Configuration/FingerprintConfigurationTest.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Traits\Configuration;
+
+use Rappasoft\LaravelLivewireTables\Tests\TestCase;
+
+class FingerprintConfigurationTest extends TestCase
+{
+    /** @test */
+    public function can_set_fingerprint(): void
+    {
+        $this->assertSame('test', $this->basicTable->setDataTableFingerprint('test')->getDataTableFingerprint());
+    }
+}

tests/Traits/Configuration/QueryStringAliasConfigurationTest.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Traits\Configuration;
+
+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());
+    }
+}