turbo-rails 1.1.1 → 1.4.0

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

@@ -35,7 +35,7 @@ module Turbo::Streams::Broadcasts
 
   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)
+      rendering.delete(:content) || rendering.delete(:html) || (rendering.any? ? render_format(:html, **rendering) : nil)
     ))
   end
 

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

@@ -1,19 +1,27 @@
 # Turbo frame requests are requests made from within a turbo frame with the intention of replacing the content of just
 # that frame, not the whole page. They are automatically tagged as such by the Turbo Frame JavaScript, which adds a
-# <tt>Turbo-Frame</tt> header to the request. When that header is detected by the controller, we ensure that any
-# template layout is skipped (since we're only working on an in-page frame, thus can skip the weight of the layout), and
-# that the etag for the page is changed (such that a cache for a layout-less request isn't served on a normal request
-# and vice versa).
+# <tt>Turbo-Frame</tt> header to the request.
 #
-# This is merely a rendering optimization. Everything would still work just fine if we rendered everything including the layout.
-# Turbo Frames knows how to fish out the relevant frame regardless.
+# When that header is detected by the controller, we substitute our own minimal layout in place of the
+# application-supplied layout (since we're only working on an in-page frame, thus can skip the weight of the layout). We
+# use a minimal layout, rather than avoid the layout entirely, so that it's still possible to render content into the
+# <tt>head<tt>.
+#
+# Accordingly, we ensure that the etag for the page is changed, such that a cache for a minimal-layout request isn't
+# served on a normal request and vice versa.
+#
+# This is merely a rendering optimization. Everything would still work just fine if we rendered everything including the
+# full layout. Turbo Frames knows how to fish out the relevant frame regardless.
+#
+# The layout used is <tt>turbo_rails/frame.html.erb</tt>. If there's a need to customize this layout, an application can
+# supply its own (such as <tt>app/views/layouts/turbo_rails/frame.html.erb</tt>) which will be used instead.
 #
 # This module is automatically included in <tt>ActionController::Base</tt>.
 module Turbo::Frames::FrameRequest
   extend ActiveSupport::Concern
 
   included do
-    layout -> { false if turbo_frame_request? }
+    layout -> { "turbo_rails/frame" if turbo_frame_request? }
     etag { :frame if turbo_frame_request? }
   end
 

data/app/controllers/turbo/native/navigation.rb

@@ -33,8 +33,10 @@ module Turbo::Native::Navigation
 
   # :nodoc:
   def turbo_native_action_or_redirect(url, action, redirect_type, options = {})
+    native_params = options.delete(:native_params) || {}
+
     if turbo_native_app?
-      redirect_to send("turbo_#{action}_historical_location_url", notice: options[:notice] || options.delete(:native_notice))
+      redirect_to send("turbo_#{action}_historical_location_url", notice: options[:notice], **native_params)
     elsif redirect_type == :back
       redirect_back fallback_location: url, **options
     else

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/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,22 +11,22 @@ 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
+      tag.turbo_stream(template, **attributes, action: action, target: target)
     elsif targets = convert_to_turbo_stream_dom_id(targets, include_selector: true)
-      %(<turbo-stream action="#{action}" targets="#{targets}">#{template}</turbo-stream>).html_safe
+      tag.turbo_stream(template, **attributes, action: action, targets: targets)
     else
-      raise ArgumentError, "target or targets must be supplied"
+      tag.turbo_stream(template, **attributes, action: action)
     end
   end
 
   private
     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
+        "#{"#" if include_selector}#{ActionView::RecordIdentifier.dom_id(target)}"
       else
         target
       end

data/app/javascript/turbo/cable_stream_source_element.js

@@ -5,7 +5,11 @@ import snakeize from "./snakeize"
 class TurboCableStreamSourceElement extends HTMLElement {
   async connectedCallback() {
     connectStreamSource(this)
-    this.subscription = await subscribeTo(this.channel, { received: this.dispatchMessageEvent.bind(this) })
+    this.subscription = await subscribeTo(this.channel, {
+      received: this.dispatchMessageEvent.bind(this),
+      connected: this.subscriptionConnected.bind(this),
+      disconnected: this.subscriptionDisconnected.bind(this)
+    })
   }
 
   disconnectedCallback() {
@@ -18,6 +22,14 @@ class TurboCableStreamSourceElement extends HTMLElement {
     return this.dispatchEvent(event)
   }
 
+  subscriptionConnected() {
+    this.setAttribute("connected", "")
+  }
+
+  subscriptionDisconnected() {
+    this.removeAttribute("connected")
+  }
+
   get channel() {
     const channel = this.getAttribute("channel")
     const signed_stream_name = this.getAttribute("signed-stream-name")
@@ -25,4 +37,7 @@ class TurboCableStreamSourceElement extends HTMLElement {
   }
 }
 
-customElements.define("turbo-cable-stream-source", TurboCableStreamSourceElement)
+
+if (customElements.get("turbo-cable-stream-source") === undefined) {
+  customElements.define("turbo-cable-stream-source", TurboCableStreamSourceElement)
+}

data/app/javascript/turbo/fetch_requests.js

@@ -0,0 +1,50 @@
+export function encodeMethodIntoRequestBody(event) {
+  if (event.target instanceof HTMLFormElement) {
+    const { target: form, detail: { fetchOptions } } = event
+
+    form.addEventListener("turbo:submit-start", ({ detail: { formSubmission: { submitter } } }) => {
+      const body = isBodyInit(fetchOptions.body) ? fetchOptions.body : new URLSearchParams()
+      const method = determineFetchMethod(submitter, body, form)
+
+      if (!/get/i.test(method)) {
+        if (/post/i.test(method)) {
+          body.delete("_method")
+        } else {
+          body.set("_method", method)
+        }
+
+        fetchOptions.method = "post"
+      }
+    }, { once: true })
+  }
+}
+
+function determineFetchMethod(submitter, body, form) {
+  const formMethod = determineFormMethod(submitter)
+  const overrideMethod = body.get("_method")
+  const method = form.getAttribute("method") || "get"
+
+  if (typeof formMethod == "string") {
+    return formMethod
+  } else if (typeof overrideMethod == "string") {
+    return overrideMethod
+  } else {
+    return method
+  }
+}
+
+function determineFormMethod(submitter) {
+  if (submitter instanceof HTMLButtonElement || submitter instanceof HTMLInputElement) {
+    if (submitter.hasAttribute("formmethod")) {
+      return submitter.formMethod
+    } else {
+      return null
+    }
+  } else {
+    return null
+  }
+}
+
+function isBodyInit(body) {
+  return body instanceof FormData || body instanceof URLSearchParams
+}

data/app/javascript/turbo/index.js

@@ -1,5 +1,4 @@
 import "./cable_stream_source_element"
-import { overrideMethodWithFormmethod } from "./form_submissions"
 
 import * as Turbo from "@hotwired/turbo"
 export { Turbo }
@@ -7,4 +6,6 @@ export { Turbo }
 import * as cable from "./cable"
 export { cable }
 
-addEventListener("turbo:submit-start", overrideMethodWithFormmethod)
+import { encodeMethodIntoRequestBody } from "./fetch_requests"
+
+addEventListener("turbo:before-fetch-request", encodeMethodIntoRequestBody)

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

@@ -27,8 +27,8 @@
 # (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
-# 
+# you do this by passing the `html:` option to any broadcast method that accepts the **rendering argument. Example:
+#
 #   class Message < ApplicationRecord
 #     belongs_to :user
 #
@@ -39,7 +39,21 @@
 #         broadcast_update_to(user, :messages, target: "message-count", html: "<p> #{user.messages.count} </p>")
 #       end
 #   end
-# 
+#
+# If you want to render a template instead of a partial, e.g. ('messages/index' or 'messages/show'), you can use the `template:` option.
+# Again, only to any broadcast method that accepts the `**rendering` argument. Example:
+#
+#   class Message < ApplicationRecord
+#     belongs_to :user
+#
+#     after_create_commit :update_message
+#
+#     private
+#       def update_message
+#         broadcast_replace_to(user, :message, target: "message", template: "messages/show", locals: { message: self })
+#       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
@@ -72,16 +86,16 @@ module Turbo::Broadcastable
     #     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) }
+      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 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_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
 
@@ -335,8 +349,13 @@ 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)
-        # if the html option is passed in it will skip setting a partial from #to_partial_path
-        unless o.include?(:html)
+
+        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

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

@@ -227,6 +227,8 @@ class Turbo::Streams::TagBuilder
   private
     def render_template(target, content = nil, allow_inferred_rendering: true, **rendering, &block)
       case
+      when content.respond_to?(:render_in)
+        content.render_in(@view_context, &block)
       when content
         allow_inferred_rendering ? (render_record(content) || content) : content
       when block_given?

data/app/views/layouts/turbo_rails/frame.html.erb

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <%= yield :head %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/turbo/version.rb

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "1.1.1"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-23 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -80,13 +80,14 @@ files:
 - app/helpers/turbo/streams_helper.rb
 - app/javascript/turbo/cable.js
 - app/javascript/turbo/cable_stream_source_element.js
-- app/javascript/turbo/form_submissions.js
+- app/javascript/turbo/fetch_requests.js
 - app/javascript/turbo/index.js
 - app/javascript/turbo/snakeize.js
 - app/jobs/turbo/streams/action_broadcast_job.rb
 - app/jobs/turbo/streams/broadcast_job.rb
 - app/models/concerns/turbo/broadcastable.rb
 - app/models/turbo/streams/tag_builder.rb
+- app/views/layouts/turbo_rails/frame.html.erb
 - config/routes.rb
 - lib/install/turbo_needs_redis.rb
 - lib/install/turbo_with_importmap.rb
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: The speed of a single-page web application without having to write any JavaScript.

data/app/javascript/turbo/form_submissions.js

@@ -1,7 +0,0 @@
-export function overrideMethodWithFormmethod({ detail: { formSubmission: { fetchRequest, submitter } } }) {
-  const formMethod = submitter?.formMethod
-
-  if (formMethod && fetchRequest.body.has("_method")) {
-    fetchRequest.body.set("_method", formMethod)
-  }
-}