turbo-train 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 033a0817bbb8ada60d3658f9fbc5edfc34cf96a4da5f4db2d968ca07efa5b3f4
-  data.tar.gz: c232fd0c8f51fe97e473db23ef9180e629f4aca46bdddbb085f33d561701f3cc
+  metadata.gz: 848a9382896a69a3cb1d57a569c0fd2fc3908a3599dc5338cd26acf732ee9992
+  data.tar.gz: 1672959f0bbae5254a6f97904db3322607080ffa7da940f1553732b883d96fcb
 SHA512:
-  metadata.gz: 770537fbb431a7a735cb49a7af09b3cb9d0470e5c48189068650456e13efcbd5dc3b486e68036f30cb5cfcbb1b8ea1d58d84e01be25b8dcb3180e27c89907dba
-  data.tar.gz: c41705c378a6425c581f16d925b3e1ee649d745f64899965c7cbcf0942fc6ba464ed0437ac539b628246f8507844514eb42b054875dbe5dde57489712e4789ae
+  metadata.gz: 245d52890779c61021ac9b5e3877b164e93535dae1211e351dc883c1c024bd429b1ed4f48d09401d204de16cdf971ccaba1b9daea403c43ff38e47dc874039f9
+  data.tar.gz: a66cebab47ba27702446128492dfceac83bc6ae2382bf072547681de7989f9a98c81e2e20482d3d9fa9509c4c5d01a421b443b7349afc734b326bdfe5099327a

data/README.md

@@ -2,8 +2,9 @@
 
 # Turbo::Train
 
-<img align="right" width="160" title="Turbo::Train logo"
-     src="./logo.svg">
+<img align="right" width="220" title="Turbo::Train logo"
+     src="https://user-images.githubusercontent.com/3010927/210603861-4b265489-a4a7-4d2a-bceb-40ceccebcd96.jpg">
+     
 
 Real-time page updates for your Rails app over SSE with [Mercure](https://mercure.rocks) and [Hotwire Turbo](https://turbo.hotwired.dev/handbook/streams#integration-with-server-side-frameworks).
 
@@ -57,12 +58,11 @@ Now you are ready to run 🚀
 caddy run
 ```
 
-
 ## Usage
 
 If you are familiar with broadcasting from ActionCable, usage would be extremely familiar:
 
-```
+```erb
 <%# app/views/chat_messages/index.html.erb %>
 <%= turbo_train_from "chat_messages" %>
 
@@ -71,15 +71,27 @@ If you are familiar with broadcasting from ActionCable, usage would be extremely
 
 And then you can send portions of HTML from your Rails backend to deliver live to all currently open browsers:
 
-```
-Turbo::Train.broadcast_action_to('chat_messages', action: :append, target:'append_new_messages_here', html: '<span>Test!</span>')
+```ruby
+Turbo::Train.broadcast_action_to(
+  'chat_messages',
+  action: :append,
+  target:'append_new_messages_here',
+  html: '<span>Test!</span>'
+)
 ```
 
 or in real world you'd probably have something like
 
-```
+```ruby
 # app/models/chat_message.rb
-after_create_commit { Turbo::Train.broadcast_action_to('chat_messages', action: :append, target:'append_new_messages_here', partial: 'somepath/message') }
+after_create_commit do
+  Turbo::Train.broadcast_action_to(
+    'chat_messages',
+    action: :append,
+    target: 'append_new_messages_here',
+    partial: 'somepath/message'
+  )
+end
 ```
 
 You have the same options as original Rails Turbo helpers: rendering partials, pure html, [same actions](https://turbo.hotwired.dev/reference/streams).
@@ -88,7 +100,7 @@ You have the same options as original Rails Turbo helpers: rendering partials, p
 
 To specify different Mercure server settings, please adjust the generated `config/initializers/turbo_train.rb` file:
 
-```
+```ruby
 Turbo::Train.configure do |config|
   config.mercure_domain = ...
   config.publisher_key = ...
@@ -103,5 +115,8 @@ By default, these are set to `localhost`/`test`/`testing` to match the configura
 
 ***
 
+<img width="80" title="Turbo::Train logo"
+     src="https://user-images.githubusercontent.com/3010927/210604381-4b715322-55f8-4db8-8bb8-660be734704d.jpg">
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/helpers/turbo/train/streams_helper.rb

@@ -2,7 +2,7 @@ module Turbo::Train::StreamsHelper
   def turbo_train_from(*streamables, **attributes)
     attributes[:name] = Turbo::Train.signed_stream_name(streamables)
     attributes[:session] = Turbo::Train.encode({ platform: "web" })
-    attributes[:href] = Turbo::Train.url
+    attributes[:href] = Turbo::Train.configuration.url
     tag.turbo_train_stream_source(**attributes)
   end
 end

data/app/jobs/turbo/train/action_broadcast_job.rb

@@ -0,0 +1,16 @@
+module Turbo
+  module Train
+    class ActionBroadcastJob < ActiveJob::Base
+      discard_on ActiveJob::DeserializationError
+
+      def perform(stream, action:, target:, **rendering)
+        Turbo::Train.broadcast_action_to(
+          stream,
+          action: action,
+          target: target,
+          **rendering
+        )
+      end
+    end
+  end
+end

data/app/jobs/turbo/train/broadcast_job.rb

@@ -0,0 +1,11 @@
+module Turbo
+  module Train
+    class BroadcastJob < ActiveJob::Base
+      discard_on ActiveJob::DeserializationError
+
+      def perform(stream, **rendering)
+        Turbo::Train.broadcast_render_to(stream, **rendering)
+      end
+    end
+  end
+end

data/app/models/concerns/turbo/train/broadcastable.rb

@@ -0,0 +1,300 @@
+# Based on: Turbo::Broadcastable
+module Turbo::Train::Broadcastable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Configures the model to broadcast creates, updates, and destroys to a stream name derived at runtime by the
+    # <tt>stream</tt> symbol invocation. By default, the creates are appended to a dom id target name derived from
+    # the model's plural name. The insertion can also be made to be a prepend by overwriting <tt>inserts_by</tt> and
+    # the target dom id overwritten by passing <tt>target</tt>. Examples:
+    #
+    #   class Message < ApplicationRecord
+    #     belongs_to :board
+    #     broadcasts_to :board
+    #   end
+    #
+    #   class Message < ApplicationRecord
+    #     belongs_to :board
+    #     train_broadcasts_to ->(message) { [ message.board, :messages ] }, inserts_by: :prepend, target: "board_messages"
+    #   end
+    #
+    #   class Message < ApplicationRecord
+    #     belongs_to :board
+    #     train_broadcasts_to ->(message) { [ message.board, :messages ] }, partial: "messages/custom_message"
+    #   end
+    def train_broadcasts_to(stream, inserts_by: :append, target: train_broadcast_target_default, **rendering)
+      after_create_commit  -> { train_broadcast_action_later_to(stream.try(:call, self) || send(stream), action: inserts_by, target: target.try(:call, self) || target, **rendering) }
+      after_update_commit  -> { train_broadcast_replace_later_to(stream.try(:call, self) || send(stream), **rendering) }
+      after_destroy_commit -> { train_broadcast_remove_to(stream.try(:call, self) || send(stream)) }
+    end
+
+    # Same as <tt>#train_broadcasts_to</tt>, but the designated stream for updates and destroys is automatically set to
+    # the current model, for creates - to the model plural name, which can be overriden by passing <tt>stream</tt>.
+    def train_broadcasts(stream = model_name.plural, inserts_by: :append, target: train_broadcast_target_default, **rendering)
+      after_create_commit  -> { train_broadcast_action_later_to(stream, action: inserts_by, target: target.try(:call, self) || target, **rendering) }
+      after_update_commit  -> { train_broadcast_replace_later(**rendering) }
+      after_destroy_commit -> { train_broadcast_remove }
+    end
+
+    # All default targets will use the return of this method. Overwrite if you want something else than <tt>model_name.plural</tt>.
+    def train_broadcast_target_default
+      model_name.plural
+    end
+  end
+
+  # Remove this broadcastable model from the dom for subscribers of the stream name identified by the passed streamables.
+  # Example:
+  #
+  #   # Sends <turbo-stream action="remove" target="clearance_5"></turbo-stream> to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_remove_to examiner.identity, :clearances
+  def train_broadcast_remove_to(*streamables, target: self)
+    Turbo::Train.broadcast_remove_to(*streamables, target: target)
+  end
+
+  # Same as <tt>#train_broadcast_remove_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_remove
+    train_broadcast_remove_to self
+  end
+
+  # Replace this broadcastable model in the dom for subscribers of the stream name identified by the passed
+  # <tt>streamables</tt>. The rendering parameters can be set by appending named arguments to the call. Examples:
+  #
+  #   # Sends <turbo-stream action="replace" target="clearance_5"><template><div id="clearance_5">My Clearance</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_replace_to examiner.identity, :clearances
+  #
+  #   # Sends <turbo-stream action="replace" target="clearance_5"><template><div id="clearance_5">Other partial</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_replace_to examiner.identity, :clearances, partial: "clearances/other_partial", locals: { a: 1 }
+  def train_broadcast_replace_to(*streamables, **rendering)
+    Turbo::Train.broadcast_replace_to(*streamables, target: self, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#train_broadcast_replace_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_replace(**rendering)
+    train_broadcast_replace_to self, **rendering
+  end
+
+  # Update this broadcastable model in the dom for subscribers of the stream name identified by the passed
+  # <tt>streamables</tt>. The rendering parameters can be set by appending named arguments to the call. Examples:
+  #
+  #   # Sends <turbo-stream action="update" target="clearance_5"><template><div id="clearance_5">My Clearance</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_update_to examiner.identity, :clearances
+  #
+  #   # Sends <turbo-stream action="update" target="clearance_5"><template><div id="clearance_5">Other partial</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_update_to examiner.identity, :clearances, partial: "clearances/other_partial", locals: { a: 1 }
+  def train_broadcast_update_to(*streamables, **rendering)
+    Turbo::Train.broadcast_update_to(*streamables, target: self, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#broadcast_update_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_update(**rendering)
+    train_broadcast_update_to self, **rendering
+  end
+
+  # Insert a rendering of this broadcastable model before the target identified by it's dom id passed as <tt>target</tt>
+  # for subscribers of the stream name identified by the passed <tt>streamables</tt>. The rendering parameters can be set by
+  # appending named arguments to the call. Examples:
+  #
+  #   # Sends <turbo-stream action="before" target="clearance_5"><template><div id="clearance_4">My Clearance</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_before_to examiner.identity, :clearances, target: "clearance_5"
+  #
+  #   # Sends <turbo-stream action="before" target="clearance_5"><template><div id="clearance_4">Other partial</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_before_to examiner.identity, :clearances, target: "clearance_5",
+  #     partial: "clearances/other_partial", locals: { a: 1 }
+  def train_broadcast_before_to(*streamables, target:, **rendering)
+    Turbo::Train.broadcast_before_to(*streamables, target: target, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Insert a rendering of this broadcastable model after the target identified by it's dom id passed as <tt>target</tt>
+  # for subscribers of the stream name identified by the passed <tt>streamables</tt>. The rendering parameters can be set by
+  # appending named arguments to the call. Examples:
+  #
+  #   # Sends <turbo-stream action="after" target="clearance_5"><template><div id="clearance_6">My Clearance</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_after_to examiner.identity, :clearances, target: "clearance_5"
+  #
+  #   # Sends <turbo-stream action="after" target="clearance_5"><template><div id="clearance_6">Other partial</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_after_to examiner.identity, :clearances, target: "clearance_5",
+  #     partial: "clearances/other_partial", locals: { a: 1 }
+  def train_broadcast_after_to(*streamables, target:, **rendering)
+    Turbo::Train.broadcast_after_to(*streamables, target: target, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Append a rendering of this broadcastable model to the target identified by it's dom id passed as <tt>target</tt>
+  # for subscribers of the stream name identified by the passed <tt>streamables</tt>. The rendering parameters can be set by
+  # appending named arguments to the call. Examples:
+  #
+  #   # Sends <turbo-stream action="append" target="clearances"><template><div id="clearance_5">My Clearance</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_append_to examiner.identity, :clearances, target: "clearances"
+  #
+  #   # Sends <turbo-stream action="append" target="clearances"><template><div id="clearance_5">Other partial</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_append_to examiner.identity, :clearances, target: "clearances",
+  #     partial: "clearances/other_partial", locals: { a: 1 }
+  def train_broadcast_append_to(*streamables, target: train_broadcast_target_default, **rendering)
+    Turbo::Train.broadcast_append_to(*streamables, target: target, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#train_broadcast_append_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_append(target: train_broadcast_target_default, **rendering)
+    train_broadcast_append_to self, target: target, **rendering
+  end
+
+  # Prepend a rendering of this broadcastable model to the target identified by it's dom id passed as <tt>target</tt>
+  # for subscribers of the stream name identified by the passed <tt>streamables</tt>. The rendering parameters can be set by
+  # appending named arguments to the call. Examples:
+  #
+  #   # Sends <turbo-stream action="prepend" target="clearances"><template><div id="clearance_5">My Clearance</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_prepend_to examiner.identity, :clearances, target: "clearances"
+  #
+  #   # Sends <turbo-stream action="prepend" target="clearances"><template><div id="clearance_5">Other partial</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_prepend_to examiner.identity, :clearances, target: "clearances",
+  #     partial: "clearances/other_partial", locals: { a: 1 }
+  def train_broadcast_prepend_to(*streamables, target: train_broadcast_target_default, **rendering)
+    Turbo::Train.broadcast_prepend_to(*streamables, target: target, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#train_broadcast_prepend_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_prepend(target: train_broadcast_target_default, **rendering)
+    train_broadcast_prepend_to self, target: target, **rendering
+  end
+
+  # Broadcast a named <tt>action</tt>, allowing for dynamic dispatch, instead of using the concrete action methods. Examples:
+  #
+  #   # Sends <turbo-stream action="prepend" target="clearances"><template><div id="clearance_5">My Clearance</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.train_broadcast_action_to examiner.identity, :clearances, action: :prepend, target: "clearances"
+  def train_broadcast_action_to(*streamables, action:, target: train_broadcast_target_default, **rendering)
+    Turbo::Train.broadcast_action_to(*streamables, action: action, target: target, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#train_broadcast_action_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_action(action, target: train_broadcast_target_default, **rendering)
+    train_broadcast_action_to self, action: action, target: target, **rendering
+  end
+
+
+  # Same as <tt>train_broadcast_replace_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
+  def train_broadcast_replace_later_to(*streamables, **rendering)
+    Turbo::Train.broadcast_replace_later_to(*streamables, target: self, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#train_broadcast_replace_later_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_replace_later(**rendering)
+    train_broadcast_replace_later_to self, **rendering
+  end
+
+  # Same as <tt>train_broadcast_update_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
+  def train_broadcast_update_later_to(*streamables, **rendering)
+    Turbo::Train.broadcast_update_later_to(*streamables, target: self, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#train_broadcast_update_later_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_update_later(**rendering)
+    train_broadcast_update_later_to self, **rendering
+  end
+
+  # Same as <tt>train_broadcast_append_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
+  def train_broadcast_append_later_to(*streamables, target: train_broadcast_target_default, **rendering)
+    Turbo::Train.broadcast_append_later_to(*streamables, target: target, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#train_broadcast_append_later_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_append_later(target: train_broadcast_target_default, **rendering)
+    train_broadcast_append_later_to self, target: target, **rendering
+  end
+
+  # Same as <tt>train_broadcast_prepend_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
+  def train_broadcast_prepend_later_to(*streamables, target: train_broadcast_target_default, **rendering)
+    Turbo::Train.broadcast_prepend_later_to(*streamables, target: target, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#train_broadcast_prepend_later_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_prepend_later(target: train_broadcast_target_default, **rendering)
+    train_broadcast_prepend_later_to self, target: target, **rendering
+  end
+
+  # Same as <tt>train_broadcast_action_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
+  def train_broadcast_action_later_to(*streamables, action:, target: train_broadcast_target_default, **rendering)
+    Turbo::Train.broadcast_action_later_to(*streamables, action: action, target: target, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>#train_broadcast_action_later_to</tt>, but the designated stream is automatically set to the current model.
+  def train_broadcast_action_later(action:, target: train_broadcast_target_default, **rendering)
+    train_broadcast_action_later_to self, action: action, target: target, **rendering
+  end
+
+  # Render a turbo stream template with this broadcastable model passed as the local variable. Example:
+  #
+  #   # Template: entries/_entry.turbo_stream.erb
+  #   <%= turbo_stream.remove entry %>
+  #
+  #   <%= turbo_stream.append "entries", entry if entry.active? %>
+  #
+  # Sends:
+  #
+  #   <turbo-stream action="remove" target="entry_5"></turbo-stream>
+  #   <turbo-stream action="append" target="entries"><template><div id="entry_5">My Entry</div></template></turbo-stream>
+  #
+  # ...to the stream named "entry:5".
+  #
+  # Note that rendering inline via this method will cause template rendering to happen synchronously. That is usually not
+  # desireable for model callbacks, certainly not if those callbacks are inside of a transaction. Most of the time you should
+  # be using `train_broadcast_render_later`, unless you specifically know why synchronous rendering is needed.
+  def train_broadcast_render(**rendering)
+    train_broadcast_render_to self, **rendering
+  end
+
+  # Same as <tt>train_broadcast_render</tt> but run with the added option of naming the stream using the passed
+  # <tt>streamables</tt>.
+  #
+  # Note that rendering inline via this method will cause template rendering to happen synchronously. That is usually not
+  # desireable for model callbacks, certainly not if those callbacks are inside of a transaction. Most of the time you should
+  # be using `train_broadcast_render_later_to`, unless you specifically know why synchronous rendering is needed.
+  def train_broadcast_render_to(*streamables, **rendering)
+    Turbo::Train.broadcast_render_to(*streamables, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>train_broadcast_action_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
+  def train_broadcast_render_later(**rendering)
+    train_broadcast_render_later_to self, **rendering
+  end
+
+  # Same as <tt>train_broadcast_render_later</tt> but run with the added option of naming the stream using the passed
+  # <tt>streamables</tt>.
+  def train_broadcast_render_later_to(*streamables, **rendering)
+    Turbo::Train.broadcast_render_later_to(*streamables, **train_broadcast_rendering_with_defaults(rendering))
+  end
+
+
+  private
+  def train_broadcast_target_default
+    self.class.train_broadcast_target_default
+  end
+
+  def train_broadcast_rendering_with_defaults(options)
+    options.tap do |o|
+      # Add the current instance into the locals with the element name (which is the un-namespaced name)
+      # as the key. This parallels how the ActionView::ObjectRenderer would create a local variable.
+      o[:locals] = (o[:locals] || {}).reverse_merge!(model_name.element.to_sym => self)
+
+      if o[:html] || o[:partial]
+        return o
+      elsif o[:template]
+        o[:layout] = false
+      else
+        # if none of these options are passed in, it will set a partial from #to_partial_path
+        o[:partial] ||= to_partial_path
+      end
+    end
+  end
+end

data/lib/turbo/train/broadcasts.rb

@@ -0,0 +1,91 @@
+module Turbo::Train::Broadcasts
+  def broadcast(streamables, content:)
+    topics = if streamables.is_a?(Array)
+               streamables.map { |s| signed_stream_name(s) }
+             else
+               [signed_stream_name(streamables)]
+             end
+
+    data = {
+      topic: topics,
+      data: content
+    }
+
+    Turbo::Train.server.publish(topics: topics, data: data)
+  end
+
+  def broadcast_action_to(*streamables, action:, target: nil, targets: nil, **rendering)
+    broadcast(streamables, content: turbo_stream_action_tag(action, target: target, targets: targets, template:
+      rendering.delete(:content) || rendering.delete(:html) || (rendering.any? ? render_format(:html, **rendering) : nil)
+    ))
+  end
+
+  def broadcast_render_to(*streamables, **rendering)
+    broadcast(*streamables, content: render_format(:turbo_stream, **rendering))
+  end
+
+  def broadcast_remove_to(*streamables, **opts)
+    broadcast_action_to(*streamables, action: :remove, **opts)
+  end
+
+  def broadcast_replace_to(*streamables, **opts)
+    broadcast_action_to(*streamables, action: :replace, **opts)
+  end
+
+  def broadcast_update_to(*streamables, **opts)
+    broadcast_action_to(*streamables, action: :update, **opts)
+  end
+
+  def broadcast_before_to(*streamables, **opts)
+    broadcast_action_to(*streamables, action: :before, **opts)
+  end
+
+  def broadcast_after_to(*streamables, **opts)
+    broadcast_action_to(*streamables, action: :after, **opts)
+  end
+
+  def broadcast_append_to(*streamables, **opts)
+    broadcast_action_to(*streamables, action: :append, **opts)
+  end
+
+  def broadcast_prepend_to(*streamables, **opts)
+    broadcast_action_to(*streamables, action: :prepend, **opts)
+  end
+
+  # later
+  def broadcast_action_later_to(*streamables, action:, target: nil, targets: nil, **rendering)
+    Turbo::Train::ActionBroadcastJob.perform_later streamables, action: action, target: target, targets: targets, **rendering
+  end
+
+  def broadcast_replace_later_to(*streamables, **opts)
+    broadcast_action_later_to(*streamables, action: :replace, **opts)
+  end
+
+  def broadcast_remove_later_to(*streamables, **opts)
+    broadcast_action_later_to(*streamables, action: :remove, **opts)
+  end
+
+  def broadcast_update_later_to(*streamables, **opts)
+    broadcast_action_later_to(*streamables, action: :update, **opts)
+  end
+
+  def broadcast_before_later_to(*streamables, **opts)
+    broadcast_action_later_to(*streamables, action: :before, **opts)
+  end
+
+  def broadcast_after_later_to(*streamables, **opts)
+    broadcast_action_later_to(*streamables, action: :after, **opts)
+  end
+
+  def broadcast_append_later_to(*streamables, **opts)
+    broadcast_action_later_to(*streamables, action: :append, **opts)
+  end
+
+  def broadcast_prepend_later_to(*streamables, **opts)
+    broadcast_action_later_to(*streamables, action: :prepend, **opts)
+  end
+
+  def broadcast_render_later_to(*streamables, **rendering)
+    Turbo::Train::BroadcastJob.perform_later streamables, **rendering
+  end
+end

data/lib/turbo/train/config.rb

@@ -9,6 +9,10 @@ module Turbo
         @subscriber_key = 'testing'
         @skip_ssl_verification = Rails.env.development? || Rails.env.test?
       end
+
+      def url
+        "https://#{mercure_domain}/.well-known"
+      end
     end
 
     class << self

data/lib/turbo/train/server.rb

@@ -0,0 +1,35 @@
+module Turbo
+  module Train
+    class Server
+      attr_reader :configuration
+
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def publish(topics:, data:)
+        payload = { mercure: { publish: topics } }
+        token = JWT.encode payload, configuration.publisher_key, ALGORITHM
+
+        uri = URI("#{configuration.url}/mercure")
+
+        req = Net::HTTP::Post.new(uri)
+        req['Content-Type'] = 'application/x-www-form-urlencoded'
+        req['Authorization'] = "Bearer #{token}"
+
+        req.body = URI.encode_www_form(data)
+        opts = {
+          use_ssl: uri.scheme == 'https'
+        }
+
+        if configuration.skip_ssl_verification
+          opts[:verify_mode] = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        Net::HTTP.start(uri.host, uri.port, opts) do |http|
+          http.request(req)
+        end
+      end
+    end
+  end
+end

data/lib/turbo/train/test_helper.rb

@@ -0,0 +1,41 @@
+# Based on: ActionCable::TestHelper
+module Turbo
+  module Train
+    module TestHelper
+      def before_setup
+        Turbo::Train.instance_variable_set(:@server, Turbo::Train::TestServer.new(Turbo::Train.configuration))
+        super
+      end
+
+      def after_teardown
+        super
+        Turbo::Train.instance_variable_set(:@server, Turbo::Train::Server.new(Turbo::Train.configuration))
+      end
+
+      def assert_broadcast_on(stream, data, &block)
+        signed_stream_name = Turbo::Train.signed_stream_name(stream)
+
+        new_messages = Turbo::Train.server.broadcasts(signed_stream_name)
+        if block_given?
+          old_messages = new_messages
+          Turbo::Train.server.clear_messages(signed_stream_name)
+
+          assert_nothing_raised(&block)
+          new_messages = Turbo::Train.server.broadcasts(signed_stream_name)
+          Turbo::Train.server.clear_messages(signed_stream_name)
+
+          # Restore all sent messages
+          (old_messages + new_messages).each { |m| Turbo::Train.server.broadcasts(signed_stream_name) << m }
+        end
+
+        message = new_messages.find { |msg| msg == data }
+        if message.nil?
+          puts "signed_stream_name => #{signed_stream_name}"
+          puts "channels_data: #{Turbo::Train.server.channels_data.inspect}}"
+        end
+
+        assert message, "No messages sent with #{data} to #{Turbo::Train.stream_name_from(stream)}"
+      end
+    end
+  end
+end

data/lib/turbo/train/test_server.rb

@@ -0,0 +1,33 @@
+module Turbo
+  module Train
+    class TestServer < Server
+      attr_reader :configuration, :channels_data
+
+      def initialize(configuration)
+        @configuration = configuration
+        @channels_data = {}
+      end
+
+      def publish(topics:, data:)
+        Array(topics).each do |topic|
+          @channels_data[topic] ||= []
+          @channels_data[topic] << data[:data]
+        end
+
+        super
+      end
+
+      def broadcasts(channel)
+        channels_data[channel] ||= []
+      end
+
+      def clear_messages(channel)
+        channels_data[channel] = []
+      end
+
+      def clear
+        @channels_data = []
+      end
+    end
+  end
+end

data/lib/turbo/train/train.rb

@@ -4,14 +4,11 @@ require 'net/http'
 module Turbo
   module Train
     extend Turbo::Streams::ActionHelper
+    extend Broadcasts
 
     ALGORITHM = "HS256"
 
     class << self
-      def url
-        "https://#{configuration.mercure_domain}/.well-known"
-      end
-
       def encode(payload)
         structured_payload = { mercure: { payload: payload } }
         JWT.encode structured_payload, configuration.subscriber_key, ALGORITHM
@@ -21,94 +18,27 @@ module Turbo
         Turbo.signed_stream_verifier.generate stream_name_from(streamables)
       end
 
-      def broadcast_action_to(*streamables, action:, target: nil, targets: nil, **rendering)
-        broadcast(streamables, content: turbo_stream_action_tag(action, target: target, targets: targets, template:
-          rendering.delete(:content) || rendering.delete(:html) || (rendering.any? ? render_format(:html, **rendering) : nil)
-        ))
-      end
-
-      def broadcast_render_to(*streamables, **rendering)
-        broadcast(*streamables, content: render_format(:turbo_stream, **rendering))
-      end
-
-      def broadcast_remove_to(*streamables, **opts)
-        broadcast_action_to(*streamables, action: :remove, **opts)
-      end
-
-      def broadcast_replace_to(*streamables, **opts)
-        broadcast_action_to(*streamables, action: :replace, **opts)
-      end
-
-      def broadcast_update_to(*streamables, **opts)
-        broadcast_action_to(*streamables, action: :update, **opts)
+      def server
+        @server ||= Server.new(configuration)
       end
 
-      def broadcast_before_to(*streamables, **opts)
-        broadcast_action_to(*streamables, action: :before, **opts)
-      end
-
-      def broadcast_after_to(*streamables, **opts)
-        broadcast_action_to(*streamables, action: :after, **opts)
-      end
-
-      def broadcast_append_to(*streamables, **opts)
-        broadcast_action_to(*streamables, action: :append, **opts)
+      def stream_name_from(streamables)
+        if streamables.is_a?(Array)
+          streamables.map  { |streamable| stream_name_from(streamable) }.join(":")
+        else
+          streamables.then { |streamable| streamable.try(:to_gid_param) || streamable.to_param }
+        end
       end
 
-      def broadcast_prepend_to(*streamables, **opts)
-        broadcast_action_to(*streamables, action: :prepend, **opts)
+      def url
+        configuration.url
       end
 
       private
 
-      def domain
-        Rails.configuration.turbo_train.mercure_domain
-      end
-
       def render_format(format, **rendering)
         ApplicationController.render(formats: [ format ], **rendering)
       end
-
-      def broadcast(streamables, content:)
-        topics = if streamables.is_a?(Array)
-          streamables.map { |s| signed_stream_name(s) }
-        else
-          [signed_stream_name(streamables)]
-        end
-
-        data = {
-          topic: topics,
-          data: content
-        }
-        payload = { mercure: { publish: topics } }
-        token = JWT.encode payload, configuration.publisher_key, ALGORITHM
-
-        uri = URI("#{url}/mercure")
-
-        req = Net::HTTP::Post.new(uri)
-        req['Content-Type'] = 'application/x-www-form-urlencoded'
-        req['Authorization'] = "Bearer #{token}"
-        req.body = URI.encode_www_form(data)
-        opts = {
-          use_ssl: uri.scheme == 'https'
-        }
-
-        if configuration.skip_ssl_verification
-          opts[:verify_mode] = OpenSSL::SSL::VERIFY_NONE
-        end
-
-        Net::HTTP.start(uri.host, uri.port, opts) do |http|
-          http.request(req)
-        end
-      end
-
-      def stream_name_from(streamables)
-        if streamables.is_a?(Array)
-          streamables.map  { |streamable| stream_name_from(streamable) }.join(":")
-        else
-          streamables.then { |streamable| streamable.try(:to_gid_param) || streamable.to_param }
-        end
-      end
     end
   end
-end
+end

data/lib/turbo/train/version.rb

@@ -1,5 +1,5 @@
 module Turbo
   module Train
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/turbo/train.rb

@@ -1,3 +1,7 @@
 require "turbo/train/version"
 require "turbo/train/config"
+require 'turbo/train/broadcasts'
+require 'turbo/train/server'
+require 'turbo/train/test_server'
+require 'turbo/train/test_helper'
 require "turbo/train/engine"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: turbo-train
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nick Savrov
 - Dima Bondarenko
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-22 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,7 +53,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - nick@uscreen.tv
 - dmitry@uscreen.tv
@@ -70,8 +70,11 @@ files:
 - app/assets/javascripts/turbo-train.min.js
 - app/controllers/turbo/train/test/application_controller.rb
 - app/helpers/turbo/train/streams_helper.rb
+- app/jobs/turbo/train/action_broadcast_job.rb
+- app/jobs/turbo/train/broadcast_job.rb
 - app/jobs/turbo/train/test/application_job.rb
 - app/mailers/turbo/train/test/application_mailer.rb
+- app/models/concerns/turbo/train/broadcastable.rb
 - app/models/turbo/train/test/application_record.rb
 - app/views/layouts/turbo/train/test/application.html.erb
 - config/routes.rb
@@ -81,8 +84,12 @@ files:
 - lib/install/install_node.rb
 - lib/tasks/install_tasks.rake
 - lib/turbo/train.rb
+- lib/turbo/train/broadcasts.rb
 - lib/turbo/train/config.rb
 - lib/turbo/train/engine.rb
+- lib/turbo/train/server.rb
+- lib/turbo/train/test_helper.rb
+- lib/turbo/train/test_server.rb
 - lib/turbo/train/train.rb
 - lib/turbo/train/version.rb
 homepage: https://github.com/Uscreen-video/turbo-train
@@ -91,7 +98,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Uscreen-video/turbo-train
   source_code_uri: https://github.com/goodsign/turbo-train-test
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Rails Turbo Stream broadcasting over SSE instead of WebSockets. Uses Mercure
   server.