From adc2404f7cf36b6b457032ca3e0aacc9153e9707 Mon Sep 17 00:00:00 2001
From: Marvin Ahlgrimm <marv.ahlgrimm@gmail.com>
Date: Wed, 17 Jul 2024 15:43:34 +0200
Subject: [PATCH] Allow turbo stream instances to be created from
 `Marten::Model`

---
 spec/marten-turbo/turbo_stream_spec.cr        | 19 ++++++++++++
 src/marten_turbo/app.cr                       |  1 +
 src/marten_turbo/concerncs/dom_identifier.cr  | 31 +++++++++++++++++++
 .../template/tag/concerncs/dom_identifier.cr  | 31 -------------------
 src/marten_turbo/template/tag/dom_id.cr       |  2 --
 src/marten_turbo/template/tag/turbo_stream.cr |  2 --
 src/marten_turbo/turbo_stream.cr              | 25 +++++++++++++--
 7 files changed, 73 insertions(+), 38 deletions(-)
 create mode 100644 src/marten_turbo/concerncs/dom_identifier.cr
 delete mode 100644 src/marten_turbo/template/tag/concerncs/dom_identifier.cr

diff --git a/spec/marten-turbo/turbo_stream_spec.cr b/spec/marten-turbo/turbo_stream_spec.cr
index a359e3a..ee83e8b 100644
--- a/spec/marten-turbo/turbo_stream_spec.cr
+++ b/spec/marten-turbo/turbo_stream_spec.cr
@@ -49,6 +49,16 @@ describe MartenTurbo::TurboStream do
       stream.to_s.should_not contain "<template>"
       stream.to_s.should contain "</turbo-stream>"
     end
+
+    it "adds a remove action to the streams using a record" do
+      tag = Tag.create!(name: "Tag 1")
+      stream = MartenTurbo::TurboStream.new
+      stream.remove(tag)
+
+      stream.to_s.should contain "<turbo-stream action=\"remove\" target=\"tag_#{tag.pk!}\">"
+      stream.to_s.should_not contain "<template>"
+      stream.to_s.should contain "</turbo-stream>"
+    end
   end
 
   describe "Class methods" do
@@ -67,5 +77,14 @@ describe MartenTurbo::TurboStream do
       stream.to_s.should_not contain "<template>"
       stream.to_s.should contain "</turbo-stream>"
     end
+
+    it "::remove accepts a model returns a new TurboStream with the remove action" do
+      tag = Tag.create!(name: "Tag 1")
+      stream = MartenTurbo::TurboStream.remove(tag)
+
+      stream.to_s.should contain "<turbo-stream action=\"remove\" target=\"tag_#{tag.pk!}\">"
+      stream.to_s.should_not contain "<template>"
+      stream.to_s.should contain "</turbo-stream>"
+    end
   end
 end
diff --git a/src/marten_turbo/app.cr b/src/marten_turbo/app.cr
index a4b2077..dae4971 100644
--- a/src/marten_turbo/app.cr
+++ b/src/marten_turbo/app.cr
@@ -1,3 +1,4 @@
+require "./concerncs/**"
 require "./turbo_stream"
 require "./ext/**"
 require "./handlers/**"
diff --git a/src/marten_turbo/concerncs/dom_identifier.cr b/src/marten_turbo/concerncs/dom_identifier.cr
new file mode 100644
index 0000000..e9d9809
--- /dev/null
+++ b/src/marten_turbo/concerncs/dom_identifier.cr
@@ -0,0 +1,31 @@
+module MartenTurbo
+  module Identifiable
+    def create_dom_id(value : Marten::Template::Value, prefix : Marten::Template::Value? = nil)
+      if value.raw.is_a? Marten::Model
+        create_dom_id(value.raw.as(Marten::Model), prefix)
+      else
+        dom_id = value.to_s
+        prefix ? "#{prefix}_#{dom_id}" : dom_id
+      end
+    end
+
+    def create_dom_id(model : Marten::Model, prefix : Marten::Template::Value? = nil)
+      generate_id_for_model(model, prefix)
+    end
+
+    private def formatted_prefix(prefix)
+      prefix ? "#{prefix}_" : ""
+    end
+
+    private def generate_id_for_model(model, prefix)
+      identifier = model.class.name.downcase.gsub(RE_NAMESPACE_IDENTIFIER, '_')
+      if model.new_record?
+        "#{formatted_prefix(prefix)}new_#{identifier}"
+      else
+        "#{formatted_prefix(prefix)}#{identifier}_#{model.pk}"
+      end
+    end
+
+    RE_NAMESPACE_IDENTIFIER = /(?:\:\:|\.)/
+  end
+end
diff --git a/src/marten_turbo/template/tag/concerncs/dom_identifier.cr b/src/marten_turbo/template/tag/concerncs/dom_identifier.cr
deleted file mode 100644
index 1024901..0000000
--- a/src/marten_turbo/template/tag/concerncs/dom_identifier.cr
+++ /dev/null
@@ -1,31 +0,0 @@
-module MartenTurbo
-  module Template
-    module Tag
-      module Identifiable
-        def create_dom_id(value : Marten::Template::Value, prefix : Marten::Template::Value? = nil)
-          if value.raw.is_a? Marten::Model
-            generate_id_for_model(value.raw.as(Marten::Model), prefix)
-          else
-            dom_id = value.to_s
-            prefix ? "#{prefix}_#{dom_id}" : dom_id
-          end
-        end
-
-        private def formatted_prefix(prefix)
-          prefix ? "#{prefix}_" : ""
-        end
-
-        private def generate_id_for_model(model, prefix)
-          identifier = model.class.name.downcase.gsub(RE_NAMESPACE_IDENTIFIER, '_')
-          if model.new_record?
-            "#{formatted_prefix(prefix)}new_#{identifier}"
-          else
-            "#{formatted_prefix(prefix)}#{identifier}_#{model.pk}"
-          end
-        end
-
-        RE_NAMESPACE_IDENTIFIER = /(?:\:\:|\.)/
-      end
-    end
-  end
-end
diff --git a/src/marten_turbo/template/tag/dom_id.cr b/src/marten_turbo/template/tag/dom_id.cr
index 79292a5..a98d627 100644
--- a/src/marten_turbo/template/tag/dom_id.cr
+++ b/src/marten_turbo/template/tag/dom_id.cr
@@ -1,5 +1,3 @@
-require "./concerncs/dom_identifier"
-
 module MartenTurbo
   module Template
     module Tag
diff --git a/src/marten_turbo/template/tag/turbo_stream.cr b/src/marten_turbo/template/tag/turbo_stream.cr
index 9edb3db..f7883a3 100644
--- a/src/marten_turbo/template/tag/turbo_stream.cr
+++ b/src/marten_turbo/template/tag/turbo_stream.cr
@@ -1,5 +1,3 @@
-require "./concerncs/dom_identifier"
-
 module MartenTurbo
   module Template
     module Tag
diff --git a/src/marten_turbo/turbo_stream.cr b/src/marten_turbo/turbo_stream.cr
index 1a7f434..98338b9 100644
--- a/src/marten_turbo/turbo_stream.cr
+++ b/src/marten_turbo/turbo_stream.cr
@@ -1,5 +1,7 @@
 module MartenTurbo
   class TurboStream
+    include Identifiable
+
     ACTIONS = %w[append prepend replace update remove before after]
 
     def initialize
@@ -21,7 +23,24 @@ module MartenTurbo
     # stream = MartenTurbo::TurboStream.new
     # stream.action("append", "messages", "<div>New Message</div>")
     # ```
-    def action(action, target_id, content)
+    def action(action, target_id : String, content)
+      @streams << <<-TURBO_STREAM_TAG
+        <turbo-stream action="#{action}" target="#{target_id}">
+          #{render_template_tag(content)}
+        </turbo-stream>
+      TURBO_STREAM_TAG
+
+      self
+    end
+
+    # Creates a new TurboStream instance and adds a single action.
+    #
+    # ```
+    # stream = MartenTurbo::TurboStream.new
+    # stream.replace("append", Message.get(pk: 1), "<div>Updated Message</div>")
+    # ```
+    def action(action, target : Marten::Model, content)
+      target_id = create_dom_id(target)
       @streams << <<-TURBO_STREAM_TAG
         <turbo-stream action="#{action}" target="#{target_id}">
           #{render_template_tag(content)}
@@ -33,7 +52,7 @@ module MartenTurbo
 
     {% for action in ACTIONS %}
       # Adds a turbo stream {{ action.id }} action to the streams array.
-      def {{ action.id }}(target : String, content : String? = nil)
+      def {{ action.id }}(target, content : String? = nil)
         action("{{ action.id }}", target, content)
 
         self
@@ -41,7 +60,7 @@ module MartenTurbo
 
       # Creates a a turbo stream instance with a {{ action.id }} action
       # already in its array.
-      def self.{{ action.id }}(target : String, content : String? = nil)
+      def self.{{ action.id }}(target, content : String? = nil)
         self.new.action("{{ action.id }}", target, content)
       end
     {% end %}