turbo-rails 0.7.11 → 1.3.0

data/app/channels/turbo/streams/broadcasts.rb

@@ -6,61 +6,61 @@ module Turbo::Streams::Broadcasts
   include Turbo::Streams::ActionHelper
 
   def broadcast_remove_to(*streamables, **opts)
-    broadcast_action_to *streamables, action: :remove, **opts
+    broadcast_action_to(*streamables, action: :remove, **opts)
   end
 
   def broadcast_replace_to(*streamables, **opts)
-    broadcast_action_to *streamables, action: :replace, **opts
+    broadcast_action_to(*streamables, action: :replace, **opts)
   end
 
   def broadcast_update_to(*streamables, **opts)
-    broadcast_action_to *streamables, action: :update, **opts
+    broadcast_action_to(*streamables, action: :update, **opts)
   end
 
   def broadcast_before_to(*streamables, **opts)
-    broadcast_action_to *streamables, action: :before, **opts
+    broadcast_action_to(*streamables, action: :before, **opts)
   end
 
   def broadcast_after_to(*streamables, **opts)
-    broadcast_action_to *streamables, action: :after, **opts
+    broadcast_action_to(*streamables, action: :after, **opts)
   end
 
   def broadcast_append_to(*streamables, **opts)
-    broadcast_action_to *streamables, action: :append, **opts
+    broadcast_action_to(*streamables, action: :append, **opts)
   end
 
   def broadcast_prepend_to(*streamables, **opts)
-    broadcast_action_to *streamables, action: :prepend, **opts
+    broadcast_action_to(*streamables, action: :prepend, **opts)
   end
 
   def broadcast_action_to(*streamables, action:, target: nil, targets: nil, **rendering)
-    broadcast_stream_to *streamables, content: turbo_stream_action_tag(action, target: target, targets: targets, template:
-      rendering.delete(:content) || (rendering.any? ? render_format(:html, **rendering) : nil)
-    )
+    broadcast_stream_to(*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_replace_later_to(*streamables, **opts)
-    broadcast_action_later_to *streamables, action: :replace, **opts
+    broadcast_action_later_to(*streamables, action: :replace, **opts)
   end
 
   def broadcast_update_later_to(*streamables, **opts)
-    broadcast_action_later_to *streamables, action: :update, **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
+    broadcast_action_later_to(*streamables, action: :before, **opts)
   end
 
   def broadcast_after_later_to(*streamables, **opts)
-    broadcast_action_later_to *streamables, action: :after, **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
+    broadcast_action_later_to(*streamables, action: :append, **opts)
   end
 
   def broadcast_prepend_later_to(*streamables, **opts)
-    broadcast_action_later_to *streamables, action: :prepend, **opts
+    broadcast_action_later_to(*streamables, action: :prepend, **opts)
   end
 
   def broadcast_action_later_to(*streamables, action:, target: nil, targets: nil, **rendering)
@@ -69,7 +69,7 @@ module Turbo::Streams::Broadcasts
   end
 
   def broadcast_render_to(*streamables, **rendering)
-    broadcast_stream_to *streamables, content: render_format(:turbo_stream, **rendering)
+    broadcast_stream_to(*streamables, content: render_format(:turbo_stream, **rendering))
   end
 
   def broadcast_render_later_to(*streamables, **rendering)

data/app/channels/turbo/streams/stream_name.rb

@@ -13,6 +13,13 @@ module Turbo::Streams::StreamName
     Turbo.signed_stream_verifier.generate stream_name_from(streamables)
   end
 
+  module ClassMethods
+    # Can be used by custom turbo stream channels to obtain signed stream name from <tt>params</tt>
+    def verified_stream_name_from_params
+      self.class.verified_stream_name(params[:signed_stream_name])
+    end
+  end
+
   private
     def stream_name_from(streamables)
       if streamables.is_a?(Array)

data/app/channels/turbo/streams_channel.rb

@@ -4,12 +4,40 @@
 # into signed stream name using <tt>Turbo::Streams::StreamName#signed_stream_name</tt>. This is automatically done
 # using the view helper <tt>Turbo::StreamsHelper#turbo_stream_from(*streamables)</tt>.
 # If the signed stream name cannot be verified, the subscription is rejected.
+#
+# In case if custom behavior is desired, one can create their own channel and re-use some of the primitives from
+# helper modules like <tt>Turbo::Streams::StreamName</tt>:
+#
+#   class CustomChannel < ActionCable::Channel::Base
+#      extend Turbo::Streams::Broadcasts, Turbo::Streams::StreamName
+#      include Turbo::Streams::StreamName::ClassMethods
+#
+#      def subscribed
+#        if (stream_name = verified_stream_name_from_params).present? &&
+#           subscription_allowed?
+#          stream_from stream_name
+#        else
+#          reject
+#        end
+#      end
+#
+#      def subscription_allowed?
+#         # ...
+#      end
+#   end
+#
+#  This channel can be connected to a web page using <tt>:channel</tt> option in
+#  <tt>turbo_stream_from</tt> helper:
+#
+#    <%= turbo_stream_from 'room', channel: CustomChannel %>
+#
 class Turbo::StreamsChannel < ActionCable::Channel::Base
   extend Turbo::Streams::Broadcasts, Turbo::Streams::StreamName
+  include Turbo::Streams::StreamName::ClassMethods
 
   def subscribed
-    if verified_stream_name = self.class.verified_stream_name(params[:signed_stream_name])
-      stream_from verified_stream_name
+    if stream_name = verified_stream_name_from_params
+      stream_from stream_name
     else
       reject
     end

data/app/controllers/turbo/frames/frame_request.rb

@@ -19,6 +19,10 @@ module Turbo::Frames::FrameRequest
 
   private
     def turbo_frame_request?
-      request.headers["Turbo-Frame"].present?
+      turbo_frame_request_id.present?
+    end
+
+    def turbo_frame_request_id
+      request.headers["Turbo-Frame"]
     end
 end

data/app/helpers/turbo/drive_helper.rb

@@ -1,6 +1,5 @@
 module Turbo::DriveHelper
-  # Pages that are more likely than not to be a cache miss can skip turbo cache to avoid visual jitter.
-  # Note: This requires a +yield :head+ provision in the application layout.
+  # Note: These helpers require a +yield :head+ provision in the layout.
   #
   # ==== Example
   #
@@ -10,7 +9,21 @@ module Turbo::DriveHelper
   #   # app/views/trays/index.html.erb
   #   <% turbo_exempts_page_from_cache %>
   #   <p>Page that shouldn't be cached by Turbo</p>
+
+  # Pages that are more likely than not to be a cache miss can skip turbo cache to avoid visual jitter.
+  # Cannot be used along with +turbo_exempts_page_from_preview+.
   def turbo_exempts_page_from_cache
-    provide :head, %(<meta name="turbo-cache-control" content="no-cache">).html_safe
+    provide :head, tag.meta(name: "turbo-cache-control", content: "no-cache")
+  end
+
+  # Specify that a cached version of the page should not be shown as a preview during an application visit.
+  # Cannot be used along with +turbo_exempts_page_from_cache+.
+  def turbo_exempts_page_from_preview
+    provide :head, tag.meta(name: "turbo-cache-control", content: "no-preview")
+  end
+
+  # Force the page, when loaded by Turbo, to be cause a full page reload.
+  def turbo_page_requires_reload
+    provide :head, tag.meta(name: "turbo-visit-control", content: "reload")
   end
 end

data/app/helpers/turbo/frames_helper.rb

@@ -23,8 +23,20 @@ module Turbo::FramesHelper
   #     <div>My tray frame!</div>
   #   <% end %>
   #   # => <turbo-frame id="tray"><div>My tray frame!</div></turbo-frame>
-  def turbo_frame_tag(id, src: nil, target: nil, **attributes, &block)
-    id = id.respond_to?(:to_key) ? dom_id(id) : id
+  #
+  # The `turbo_frame_tag` helper will convert the arguments it receives to their
+  # `dom_id` if applicable to easily generate unique ids for Turbo Frames:
+  #
+  #   <%= turbo_frame_tag(Article.find(1)) %>
+  #   # => <turbo-frame id="article_1"></turbo-frame>
+  #
+  #   <%= turbo_frame_tag(Article.find(1), "comments") %>
+  #   # => <turbo-frame id="article_1_comments"></turbo-frame>
+  #
+  #   <%= turbo_frame_tag(Article.find(1), Comment.new) %>
+  #   # => <turbo-frame id="article_1_new_comment"></turbo-frame>
+  def turbo_frame_tag(*ids, src: nil, target: nil, **attributes, &block)
+    id = ids.map { |id| id.respond_to?(:to_key) ? ActionView::RecordIdentifier.dom_id(id) : id }.join("_")
     src = url_for(src) if src.present?
 
     tag.turbo_frame(**attributes.merge(id: id, src: src, target: target).compact, &block)

data/app/helpers/turbo/streams/action_helper.rb

@@ -1,4 +1,6 @@
 module Turbo::Streams::ActionHelper
+  include ActionView::Helpers::TagHelper
+
   # Creates a `turbo-stream` tag according to the passed parameters. Examples:
   #
   #   turbo_stream_action_tag "remove", target: "message_1"
@@ -9,20 +11,24 @@ module Turbo::Streams::ActionHelper
   #
   #   turbo_stream_action_tag "replace", targets: "message_1", template: %(<div id="message_1">Hello!</div>)
   #   # => <turbo-stream action="replace" targets="message_1"><template><div id="message_1">Hello!</div></template></turbo-stream>
-  def turbo_stream_action_tag(action, target: nil, targets: nil, template: nil)
-    template = action.to_sym == :remove ? "" : "<template>#{template}</template>"
+  def turbo_stream_action_tag(action, target: nil, targets: nil, template: nil, **attributes)
+    template = action.to_sym == :remove ? "" : tag.template(template.to_s.html_safe)
 
     if target = convert_to_turbo_stream_dom_id(target)
-      %(<turbo-stream action="#{action}" target="#{target}">#{template}</turbo-stream>).html_safe
-    elsif targets = convert_to_turbo_stream_dom_id(targets)
-      %(<turbo-stream action="#{action}" targets="#{targets}">#{template}</turbo-stream>).html_safe
+      tag.turbo_stream(template, **attributes.merge(action: action, target: target))
+    elsif targets = convert_to_turbo_stream_dom_id(targets, include_selector: true)
+      tag.turbo_stream(template, **attributes.merge(action: action, targets: targets))
     else
-      raise ArgumentError, "target or targets must be supplied"
+      tag.turbo_stream(template, **attributes.merge(action: action))
     end
   end
 
   private
-    def convert_to_turbo_stream_dom_id(target)
-      target.respond_to?(:to_key) ? ActionView::RecordIdentifier.dom_id(target) : target
+    def convert_to_turbo_stream_dom_id(target, include_selector: false)
+      if target.respond_to?(:to_key)
+        [ ("#" if include_selector), ActionView::RecordIdentifier.dom_id(target) ].compact.join
+      else
+        target
+      end
     end
 end

data/app/helpers/turbo/streams_helper.rb

@@ -39,9 +39,20 @@ module Turbo::StreamsHelper
   # The example above will process all turbo streams sent to a stream name like <tt>account:5:entries</tt>
   # (when Current.account.id = 5). Updates to this stream can be sent like
   # <tt>entry.broadcast_append_to entry.account, :entries, target: "entries"</tt>.
+  #
+  # Custom channel class name can be passed using <tt>:channel</tt> option (either as a String
+  # or a class name):
+  #
+  #   <%= turbo_stream_from "room", channel: RoomChannel %>
+  #
+  # It is also possible to pass additional parameters to the channel by passing them through `data` attributes:
+  #
+  #   <%= turbo_stream_from "room", channel: RoomChannel, data: {room_name: "room #1"} %>
+  #
   def turbo_stream_from(*streamables, **attributes)
-    attributes[:channel] = "Turbo::StreamsChannel"
+    attributes[:channel] = attributes[:channel]&.to_s || "Turbo::StreamsChannel"
     attributes[:"signed-stream-name"] = Turbo::StreamsChannel.signed_stream_name(streamables)
+
     tag.turbo_cable_stream_source(**attributes)
   end
 end

data/app/javascript/turbo/cable_stream_source_element.js

@@ -1,5 +1,6 @@
 import { connectStreamSource, disconnectStreamSource } from "@hotwired/turbo"
 import { subscribeTo } from "./cable"
+import snakeize from "./snakeize"
 
 class TurboCableStreamSourceElement extends HTMLElement {
   async connectedCallback() {
@@ -20,7 +21,7 @@ class TurboCableStreamSourceElement extends HTMLElement {
   get channel() {
     const channel = this.getAttribute("channel")
     const signed_stream_name = this.getAttribute("signed-stream-name")
-    return { channel, signed_stream_name }
+    return { channel, signed_stream_name, ...snakeize({ ...this.dataset }) }
   }
 }
 

data/app/javascript/turbo/fetch_requests.js

@@ -0,0 +1,19 @@
+export function encodeMethodIntoRequestBody(event) {
+  if (event.target instanceof HTMLFormElement) {
+    const { target: form, detail: { fetchOptions } } = event
+
+    form.addEventListener("turbo:submit-start", ({ detail: { formSubmission: { submitter } } }) => {
+      const method = (submitter && submitter.formMethod) || (fetchOptions.body && fetchOptions.body.get("_method")) || form.getAttribute("method")
+
+      if (!/get/i.test(method)) {
+        if (/post/i.test(method)) {
+          fetchOptions.body.delete("_method")
+        } else {
+          fetchOptions.body.set("_method", method)
+        }
+
+        fetchOptions.method = "post"
+      }
+    }, { once: true })
+  }
+}

data/app/javascript/turbo/index.js

@@ -5,3 +5,7 @@ export { Turbo }
 
 import * as cable from "./cable"
 export { cable }
+
+import { encodeMethodIntoRequestBody } from "./fetch_requests"
+
+addEventListener("turbo:before-fetch-request", encodeMethodIntoRequestBody)

data/app/javascript/turbo/snakeize.js

@@ -0,0 +1,31 @@
+// Based on https://github.com/nathan7/snakeize
+//
+// This software is released under the MIT license:
+// Permission is hereby granted, free of charge, to any person obtaining a copy of
+// this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to
+// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+// the Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+export default function walk (obj) {
+    if (!obj || typeof obj !== 'object') return obj;
+    if (obj instanceof Date || obj instanceof RegExp) return obj;
+    if (Array.isArray(obj)) return obj.map(walk);
+    return Object.keys(obj).reduce(function (acc, key) {
+        var camel = key[0].toLowerCase() + key.slice(1).replace(/([A-Z]+)/g, function (m, x) {
+            return '_' + x.toLowerCase();
+        });
+        acc[camel] = walk(obj[key]);
+        return acc;
+    }, {});
+};

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

@@ -26,13 +26,28 @@
 # and finally prepend the result of that partial rendering to the target identified with the dom id "clearances"
 # (which is derived by default from the plural model name of the model, but can be overwritten).
 #
+# You can also choose to render html instead of a partial inside of a broadcast
+# you do this by passing the html: option to any broadcast method that accepts the **rendering argument
+# 
+#   class Message < ApplicationRecord
+#     belongs_to :user
+#
+#     after_create_commit :update_message_count
+#
+#     private
+#       def update_message_count
+#         broadcast_update_to(user, :messages, target: "message-count", html: "<p> #{user.messages.count} </p>")
+#       end
+#   end
+# 
 # There are four basic actions you can broadcast: <tt>remove</tt>, <tt>replace</tt>, <tt>append</tt>, and
 # <tt>prepend</tt>. As a rule, you should use the <tt>_later</tt> versions of everything except for remove when broadcasting
 # within a real-time path, like a controller or model, since all those updates require a rendering step, which can slow down
 # execution. You don't need to do this for remove, since only the dom id for the model is used.
 #
-# In addition to the four basic actions, you can also use <tt>broadcast_render_later</tt> or
-# <tt>broadcast_render_later_to</tt> to render a turbo stream template with multiple actions.
+# In addition to the four basic actions, you can also use <tt>broadcast_render</tt>,
+# <tt>broadcast_render_to</tt> <tt>broadcast_render_later</tt>, and <tt>broadcast_render_later_to</tt>
+# to render a turbo stream template with multiple actions.
 module Turbo::Broadcastable
   extend ActiveSupport::Concern
 
@@ -51,16 +66,22 @@ module Turbo::Broadcastable
     #     belongs_to :board
     #     broadcasts_to ->(message) { [ message.board, :messages ] }, inserts_by: :prepend, target: "board_messages"
     #   end
-    def broadcasts_to(stream, inserts_by: :append, target: broadcast_target_default)
-      after_create_commit  -> { broadcast_action_later_to stream.try(:call, self) || send(stream), action: inserts_by, target: target.try(:call, self) || target }
-      after_update_commit  -> { broadcast_replace_later_to stream.try(:call, self) || send(stream) }
+    #
+    #   class Message < ApplicationRecord
+    #     belongs_to :board
+    #     broadcasts_to ->(message) { [ message.board, :messages ] }, partial: "messages/custom_message"
+    #   end
+    def broadcasts_to(stream, inserts_by: :append, target: broadcast_target_default, **rendering)
+      after_create_commit  -> { broadcast_action_later_to stream.try(:call, self) || send(stream), action: inserts_by, target: target.try(:call, self) || target, **rendering }
+      after_update_commit  -> { broadcast_replace_later_to stream.try(:call, self) || send(stream), **rendering }
       after_destroy_commit -> { broadcast_remove_to stream.try(:call, self) || send(stream) }
     end
 
-    # Same as <tt>#broadcasts_to</tt>, but the designated stream is automatically set to the current model.
-    def broadcasts(inserts_by: :append, target: broadcast_target_default)
-      after_create_commit  -> { broadcast_action_later action: inserts_by, target: target.try(:call, self) || target }
-      after_update_commit  -> { broadcast_replace_later }
+    # Same as <tt>#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 broadcasts(stream = model_name.plural, inserts_by: :append, target: broadcast_target_default, **rendering)
+      after_create_commit  -> { broadcast_action_later_to stream, action: inserts_by, target: target.try(:call, self) || target, **rendering }
+      after_update_commit  -> { broadcast_replace_later **rendering }
       after_destroy_commit -> { broadcast_remove }
     end
 
@@ -76,7 +97,7 @@ module Turbo::Broadcastable
   #   # Sends <turbo-stream action="remove" target="clearance_5"></turbo-stream> to the stream named "identity:2:clearances"
   #   clearance.broadcast_remove_to examiner.identity, :clearances
   def broadcast_remove_to(*streamables, target: self)
-    Turbo::StreamsChannel.broadcast_remove_to *streamables, target: target
+    Turbo::StreamsChannel.broadcast_remove_to(*streamables, target: target)
   end
 
   # Same as <tt>#broadcast_remove_to</tt>, but the designated stream is automatically set to the current model.
@@ -95,7 +116,7 @@ module Turbo::Broadcastable
   #   # to the stream named "identity:2:clearances"
   #   clearance.broadcast_replace_to examiner.identity, :clearances, partial: "clearances/other_partial", locals: { a: 1 }
   def broadcast_replace_to(*streamables, **rendering)
-    Turbo::StreamsChannel.broadcast_replace_to *streamables, target: self, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_replace_to(*streamables, target: self, **broadcast_rendering_with_defaults(rendering))
   end
 
   # Same as <tt>#broadcast_replace_to</tt>, but the designated stream is automatically set to the current model.
@@ -114,7 +135,7 @@ module Turbo::Broadcastable
   #   # to the stream named "identity:2:clearances"
   #   clearance.broadcast_update_to examiner.identity, :clearances, partial: "clearances/other_partial", locals: { a: 1 }
   def broadcast_update_to(*streamables, **rendering)
-    Turbo::StreamsChannel.broadcast_update_to *streamables, target: self, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_update_to(*streamables, target: self, **broadcast_rendering_with_defaults(rendering))
   end
 
   # Same as <tt>#broadcast_update_to</tt>, but the designated stream is automatically set to the current model.
@@ -135,7 +156,7 @@ module Turbo::Broadcastable
   #   clearance.broadcast_before_to examiner.identity, :clearances, target: "clearance_5",
   #     partial: "clearances/other_partial", locals: { a: 1 }
   def broadcast_before_to(*streamables, target:, **rendering)
-    Turbo::StreamsChannel.broadcast_before_to *streamables, target: target, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_before_to(*streamables, target: target, **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>
@@ -151,7 +172,7 @@ module Turbo::Broadcastable
   #   clearance.broadcast_after_to examiner.identity, :clearances, target: "clearance_5",
   #     partial: "clearances/other_partial", locals: { a: 1 }
   def broadcast_after_to(*streamables, target:, **rendering)
-    Turbo::StreamsChannel.broadcast_after_to *streamables, target: target, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_after_to(*streamables, target: target, **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>
@@ -167,7 +188,7 @@ module Turbo::Broadcastable
   #   clearance.broadcast_append_to examiner.identity, :clearances, target: "clearances",
   #     partial: "clearances/other_partial", locals: { a: 1 }
   def broadcast_append_to(*streamables, target: broadcast_target_default, **rendering)
-    Turbo::StreamsChannel.broadcast_append_to *streamables, target: target, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_append_to(*streamables, target: target, **broadcast_rendering_with_defaults(rendering))
   end
 
   # Same as <tt>#broadcast_append_to</tt>, but the designated stream is automatically set to the current model.
@@ -188,7 +209,7 @@ module Turbo::Broadcastable
   #   clearance.broadcast_prepend_to examiner.identity, :clearances, target: "clearances",
   #     partial: "clearances/other_partial", locals: { a: 1 }
   def broadcast_prepend_to(*streamables, target: broadcast_target_default, **rendering)
-    Turbo::StreamsChannel.broadcast_prepend_to *streamables, target: target, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_prepend_to(*streamables, target: target, **broadcast_rendering_with_defaults(rendering))
   end
 
   # Same as <tt>#broadcast_prepend_to</tt>, but the designated stream is automatically set to the current model.
@@ -213,7 +234,7 @@ module Turbo::Broadcastable
 
   # Same as <tt>broadcast_replace_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
   def broadcast_replace_later_to(*streamables, **rendering)
-    Turbo::StreamsChannel.broadcast_replace_later_to *streamables, target: self, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_replace_later_to(*streamables, target: self, **broadcast_rendering_with_defaults(rendering))
   end
 
   # Same as <tt>#broadcast_replace_later_to</tt>, but the designated stream is automatically set to the current model.
@@ -223,7 +244,7 @@ module Turbo::Broadcastable
 
   # Same as <tt>broadcast_update_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
   def broadcast_update_later_to(*streamables, **rendering)
-    Turbo::StreamsChannel.broadcast_update_later_to *streamables, target: self, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_update_later_to(*streamables, target: self, **broadcast_rendering_with_defaults(rendering))
   end
 
   # Same as <tt>#broadcast_update_later_to</tt>, but the designated stream is automatically set to the current model.
@@ -233,7 +254,7 @@ module Turbo::Broadcastable
 
   # Same as <tt>broadcast_append_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
   def broadcast_append_later_to(*streamables, target: broadcast_target_default, **rendering)
-    Turbo::StreamsChannel.broadcast_append_later_to *streamables, target: target, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_append_later_to(*streamables, target: target, **broadcast_rendering_with_defaults(rendering))
   end
 
   # Same as <tt>#broadcast_append_later_to</tt>, but the designated stream is automatically set to the current model.
@@ -243,7 +264,7 @@ module Turbo::Broadcastable
 
   # Same as <tt>broadcast_prepend_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
   def broadcast_prepend_later_to(*streamables, target: broadcast_target_default, **rendering)
-    Turbo::StreamsChannel.broadcast_prepend_later_to *streamables, target: target, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_prepend_later_to(*streamables, target: target, **broadcast_rendering_with_defaults(rendering))
   end
 
   # Same as <tt>#broadcast_prepend_later_to</tt>, but the designated stream is automatically set to the current model.
@@ -261,9 +282,7 @@ module Turbo::Broadcastable
     broadcast_action_later_to self, action: action, target: target, **rendering
   end
 
-
-  # Render a turbo stream template asynchronously with this broadcastable model passed as the local variable using a
-  # <tt>Turbo::Streams::BroadcastJob</tt>. Example:
+  # 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 %>
@@ -275,7 +294,26 @@ module Turbo::Broadcastable
   #   <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"
+  # ...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 `broadcast_render_later`, unless you specifically know why synchronous rendering is needed.
+  def broadcast_render(**rendering)
+    broadcast_render_to self, **rendering
+  end
+
+  # Same as <tt>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 `broadcast_render_later_to`, unless you specifically know why synchronous rendering is needed.
+  def broadcast_render_to(*streamables, **rendering)
+    Turbo::StreamsChannel.broadcast_render_to(*streamables, **broadcast_rendering_with_defaults(rendering))
+  end
+
+  # Same as <tt>broadcast_action_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
   def broadcast_render_later(**rendering)
     broadcast_render_later_to self, **rendering
   end
@@ -283,7 +321,7 @@ module Turbo::Broadcastable
   # Same as <tt>broadcast_render_later</tt> but run with the added option of naming the stream using the passed
   # <tt>streamables</tt>.
   def broadcast_render_later_to(*streamables, **rendering)
-    Turbo::StreamsChannel.broadcast_render_later_to *streamables, **broadcast_rendering_with_defaults(rendering)
+    Turbo::StreamsChannel.broadcast_render_later_to(*streamables, **broadcast_rendering_with_defaults(rendering))
   end
 
 
@@ -297,7 +335,10 @@ module Turbo::Broadcastable
         # 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)
-        o[:partial] ||= to_partial_path
+        # if the html option is passed in it will skip setting a partial from #to_partial_path
+        unless o.include?(:html)
+          o[:partial] ||= to_partial_path
+        end
       end
     end
 end

data/app/models/turbo/streams/tag_builder.rb

@@ -50,7 +50,7 @@ class Turbo::Streams::TagBuilder
     action_all :remove, targets, allow_inferred_rendering: false
   end
 
-  # Replace the <tt>target</tt> in the dom with the either the <tt>content</tt> passed in, a rendering result determined
+  # Replace the <tt>target</tt> in the dom with either the <tt>content</tt> passed in, a rendering result determined
   # by the <tt>rendering</tt> keyword arguments, the content in the block, or the rendering of the target as a record. Examples:
   #
   #   <%= turbo_stream.replace "clearance_5", "<div id='clearance_5'>Replace the dom target identified by clearance_5</div>" %>
@@ -63,7 +63,7 @@ class Turbo::Streams::TagBuilder
     action :replace, target, content, **rendering, &block
   end
 
-  # Replace the <tt>targets</tt> in the dom with the either the <tt>content</tt> passed in, a rendering result determined
+  # Replace the <tt>targets</tt> in the dom with either the <tt>content</tt> passed in, a rendering result determined
   # by the <tt>rendering</tt> keyword arguments, the content in the block, or the rendering of the target as a record. Examples:
   #
   #   <%= turbo_stream.replace_all ".clearance_item", "<div class='clearance_item'>Replace the dom target identified by the class clearance_item</div>" %>
@@ -128,7 +128,7 @@ class Turbo::Streams::TagBuilder
     action_all :after, targets, content, **rendering, &block
   end
 
-  # Update the <tt>target</tt> in the dom with the either the <tt>content</tt> passed in or a rendering result determined
+  # Update the <tt>target</tt> in the dom with either the <tt>content</tt> passed in or a rendering result determined
   # by the <tt>rendering</tt> keyword arguments, the content in the block, or the rendering of the target as a record. Examples:
   #
   #   <%= turbo_stream.update "clearance_5", "Update the content of the dom target identified by clearance_5" %>
@@ -141,7 +141,7 @@ class Turbo::Streams::TagBuilder
     action :update, target, content, **rendering, &block
   end
 
-  # Update the <tt>targets</tt> in the dom with the either the <tt>content</tt> passed in or a rendering result determined
+  # Update the <tt>targets</tt> in the dom with either the <tt>content</tt> passed in or a rendering result determined
   # by the <tt>rendering</tt> keyword arguments, the content in the block, or the rendering of the targets as a record. Examples:
   #
   #   <%= turbo_stream.update_all "clearance_item", "Update the content of the dom target identified by the class clearance_item" %>

data/lib/install/turbo_needs_redis.rb

@@ -1,6 +1,17 @@
 if (cable_config_path = Rails.root.join("config/cable.yml")).exist?
   say "Enable redis in bundle"
-  uncomment_lines "Gemfile", %(gem 'redis')
+
+  gemfile_content = File.read(Rails.root.join("Gemfile"))
+  pattern = /gem ['"]redis['"]/
+
+  if gemfile_content.match?(pattern)
+    uncomment_lines "Gemfile", pattern
+  else
+    append_file "Gemfile", "\n# Use Redis for Action Cable"
+    gem 'redis', '~> 4.0'
+  end
+
+  run_bundle
 
   say "Switch development cable to use redis"
   gsub_file cable_config_path.to_s, /development:\n\s+adapter: async/, "development:\n  adapter: redis\n  url: redis://localhost:6379/1"

data/lib/install/turbo_with_importmap.rb

@@ -2,4 +2,4 @@ say "Import Turbo"
 append_to_file "app/javascript/application.js", %(import "@hotwired/turbo-rails"\n)
 
 say "Pin Turbo"
-append_to_file "config/importmap.rb", %(pin "@hotwired/turbo-rails", to: "turbo.js"\n)
+append_to_file "config/importmap.rb", %(pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true\n)