Records passed to the RecordIdentifier must only implement the getKey…

… method
hotwired-laravel · Jun 23, 2021 · 05c35c0 · 05c35c0
1 parent 03032b2
commit 05c35c0
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 50 deletions.
diff --git a/src/Views/RecordIdentifier.php b/src/Views/RecordIdentifier.php
@@ -10,22 +10,22 @@ class RecordIdentifier
     const NEW_PREFIX = "create";
     const DELIMITER = "_";
 
-    /** @var Model|TurboStreamable */
+    /** @var Model */
     private $record;
 
     public function __construct(object $record)
     {
         throw_if(
-            ! $this->isStreamable($record),
-            sprintf('[%s] must be an instance of Eloquent or TurboStreamable.', get_class($record))
+            ! method_exists($record, 'getKey'),
+            UnidentifiableRecordException::missingGetKeyMethod($record),
         );
 
         $this->record = $record;
     }
 
     public function domId(?string $prefix = null): string
     {
-        if ($recordId = $this->streamableKey()) {
+        if ($recordId = $this->record->getKey()) {
             return sprintf('%s%s%s', $this->domClass($prefix), self::DELIMITER, $recordId);
         }
 
@@ -39,20 +39,4 @@ public function domClass(?string $prefix = null): string
 
         return trim("{$prefix}{$delimiter}{$singular}", $delimiter);
     }
-
-    protected function streamableKey(): ?string
-    {
-        if ($this->record instanceof Model) {
-            return $this->record->getKey();
-        }
-
-        if ($this->record instanceof TurboStreamable) {
-            return $this->record->getDomId();
-        }
-    }
-
-    protected function isStreamable($record): bool
-    {
-        return $record instanceof Model || $record instanceof TurboStreamable;
-    }
 }
diff --git a/src/Views/TurboStreamable.php b/src/Views/TurboStreamable.php
diff --git a/src/Views/UnidentifiableRecordException.php b/src/Views/UnidentifiableRecordException.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Tonysm\TurboLaravel\Views;
+
+use RuntimeException;
+
+class UnidentifiableRecordException extends RuntimeException
+{
+    public static function missingGetKeyMethod(object $model): self
+    {
+        return new self(
+            sprintf('[%s] must implement a getKey() method.', get_class($model))
+        );
+    }
+}
diff --git a/tests/Stubs/Models/TestTurboStreamable.php b/tests/Stubs/Models/TestTurboStreamable.php
@@ -2,11 +2,9 @@
 
 namespace Tonysm\TurboLaravel\Tests\Stubs\Models;
 
-use Tonysm\TurboLaravel\Views\TurboStreamable;
-
-class TestTurboStreamable implements TurboStreamable
+class TestTurboStreamable
 {
-    public function getDomId()
+    public function getKey()
     {
         return 'turbo-dom-id';
     }

diff --git a/tests/TestTurboStreamable.php b/tests/TestTurboStreamable.php
diff --git a/tests/Views/RecordIdentifierStreamableTest.php b/tests/Views/RecordIdentifierStreamableTest.php
@@ -2,11 +2,11 @@
 
 namespace Tonysm\TurboLaravel\Tests\Views;
 
-use RuntimeException;
 use stdClass;
+use Tonysm\TurboLaravel\Tests\Stubs\Models\TestTurboStreamable;
 use Tonysm\TurboLaravel\Tests\TestCase;
-use Tonysm\TurboLaravel\Tests\TestTurboStreamable;
 use Tonysm\TurboLaravel\Views\RecordIdentifier;
+use Tonysm\TurboLaravel\Views\UnidentifiableRecordException;
 
 class RecordIdentifierStreamableTest extends TestCase
 {
@@ -32,12 +32,11 @@ public function dom_id_of_streamable_with_custom_prefix()
     {
         $this->assertEquals("custom_prefix_{$this->singular}_turbo-dom-id", (new RecordIdentifier($this->streamable))->domId("custom_prefix"));
     }
-    
+
     /** @test */
     public function exception_is_thrown_when_given_non_streamable_instance()
     {
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('[stdClass] must be an instance of Eloquent or TurboStreamable.');
+        $this->expectException(UnidentifiableRecordException::class);
 
         new RecordIdentifier(new stdClass);
     }