From 05c35c0e08c0ab80110e051580aac74e6cd4f4c4 Mon Sep 17 00:00:00 2001
From: Tony Messias <tonysm@hey.com>
Date: Tue, 22 Jun 2021 23:46:57 -0300
Subject: [PATCH] Records passed to the RecordIdentifier must only implement
 the getKey method

---
 src/Views/RecordIdentifier.php                | 24 ++++---------------
 src/Views/TurboStreamable.php                 |  8 -------
 src/Views/UnidentifiableRecordException.php   | 15 ++++++++++++
 tests/Stubs/Models/TestTurboStreamable.php    |  6 ++---
 tests/TestTurboStreamable.php                 | 13 ----------
 .../Views/RecordIdentifierStreamableTest.php  |  9 ++++---
 6 files changed, 25 insertions(+), 50 deletions(-)
 delete mode 100644 src/Views/TurboStreamable.php
 create mode 100644 src/Views/UnidentifiableRecordException.php
 delete mode 100644 tests/TestTurboStreamable.php

diff --git a/src/Views/RecordIdentifier.php b/src/Views/RecordIdentifier.php
index 38f1c95..4764933 100644
--- a/src/Views/RecordIdentifier.php
+++ b/src/Views/RecordIdentifier.php
@@ -10,14 +10,14 @@ 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;
@@ -25,7 +25,7 @@ public function __construct(object $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
deleted file mode 100644
index d1cf3b3..0000000
--- a/src/Views/TurboStreamable.php
+++ /dev/null
@@ -1,8 +0,0 @@
-<?php
-
-namespace Tonysm\TurboLaravel\Views;
-
-interface TurboStreamable
-{
-    public function getDomId();
-}
diff --git a/src/Views/UnidentifiableRecordException.php b/src/Views/UnidentifiableRecordException.php
new file mode 100644
index 0000000..deaa334
--- /dev/null
+++ 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
index a40a426..6870757 100644
--- 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
deleted file mode 100644
index 675e213..0000000
--- a/tests/TestTurboStreamable.php
+++ /dev/null
@@ -1,13 +0,0 @@
-<?php
-
-namespace Tonysm\TurboLaravel\Tests;
-
-use Tonysm\TurboLaravel\Views\TurboStreamable;
-
-class TestTurboStreamable implements TurboStreamable
-{
-    public function getDomId()
-    {
-        return 'turbo-dom-id';
-    }
-}
diff --git a/tests/Views/RecordIdentifierStreamableTest.php b/tests/Views/RecordIdentifierStreamableTest.php
index 4295713..6f685dd 100644
--- 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);
     }