RubyGems - turbo-rails - Versions diffs - 2.0.4 → 2.0.6 - Mend

turbo-rails 2.0.4 → 2.0.6

Files changed (15) hide show

checksums.yaml +4 -4
data/README.md +43 -5
data/app/assets/javascripts/turbo.js +158 -139
data/app/assets/javascripts/turbo.min.js +6 -6
data/app/assets/javascripts/turbo.min.js.map +1 -1
data/app/channels/turbo/streams/broadcasts.rb +15 -3
data/app/channels/turbo/streams_channel.rb +15 -15
data/app/controllers/turbo/frames/frame_request.rb +2 -2
data/app/helpers/turbo/drive_helper.rb +2 -2
data/app/helpers/turbo/streams/action_helper.rb +3 -2
data/app/models/concerns/turbo/broadcastable.rb +19 -11
data/app/models/turbo/streams/tag_builder.rb +26 -0
data/lib/turbo/engine.rb +21 -6
data/lib/turbo/version.rb +1 -1
metadata +5 -4

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

@@ -75,8 +75,15 @@ module Turbo::Streams::Broadcasts
   end
   def broadcast_action_later_to(*streamables, action:, target: nil, targets: nil, attributes: {}, **rendering)
-    Turbo::Streams::ActionBroadcastJob.perform_later \
-      stream_name_from(streamables), action: action, target: target, targets: targets, attributes: attributes, **rendering
+    streamables.flatten!
+    streamables.compact_blank!
+    if streamables.present?
+      target = convert_to_turbo_stream_dom_id(target)
+      targets = convert_to_turbo_stream_dom_id(targets, include_selector: true)
+      Turbo::Streams::ActionBroadcastJob.perform_later \
+        stream_name_from(streamables), action: action, target: target, targets: targets, attributes: attributes, **rendering
+    end
   end
   def broadcast_render_to(*streamables, **rendering)
@@ -88,7 +95,12 @@ module Turbo::Streams::Broadcasts
   end
   def broadcast_stream_to(*streamables, content:)
-    ActionCable.server.broadcast stream_name_from(streamables), content
+    streamables.flatten!
+    streamables.compact_blank!
+    if streamables.present?
+      ActionCable.server.broadcast stream_name_from(streamables), content
+    end
   end
   def refresh_debouncer_for(*streamables, request_id: nil) # :nodoc:

data/app/channels/turbo/streams_channel.rb CHANGED Viewed

@@ -9,27 +9,27 @@
 # 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
+#     extend Turbo::Streams::Broadcasts, Turbo::Streams::StreamName
+#     include Turbo::Streams::StreamName::ClassMethods
 #
-#      def subscribed
-#        if (stream_name = verified_stream_name_from_params).present? &&
+#     def subscribed
+#       if (stream_name = verified_stream_name_from_params).present? &&
 #           subscription_allowed?
-#          stream_from stream_name
-#        else
-#          reject
-#        end
-#      end
+#         stream_from stream_name
+#       else
+#         reject
+#       end
+#     end
 #
-#      def subscription_allowed?
-#         # ...
-#      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:
+# 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 %>
+#   <%= turbo_stream_from 'room', channel: CustomChannel %>
 #
 class Turbo::StreamsChannel < ActionCable::Channel::Base
   extend Turbo::Streams::Broadcasts, Turbo::Streams::StreamName

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

@@ -24,7 +24,7 @@ module Turbo::Frames::FrameRequest
     layout -> { "turbo_rails/frame" if turbo_frame_request? }
     etag { :frame if turbo_frame_request? }
-    helper_method :turbo_frame_request_id
+    helper_method :turbo_frame_request?, :turbo_frame_request_id
   end
   private
@@ -33,6 +33,6 @@ module Turbo::Frames::FrameRequest
     end
     def turbo_frame_request_id
-      request&.headers["Turbo-Frame"]
+      request.headers["Turbo-Frame"]
     end
 end

data/app/helpers/turbo/drive_helper.rb CHANGED Viewed

@@ -51,7 +51,7 @@ module Turbo::DriveHelper
   # Configure how to handle page refreshes. A page refresh happens when
   # Turbo loads the current page again with a *replace* visit:
   #
-  # === Parameters:
+  # ==== Parameters:
   #
   # * <tt>method</tt> - Method to update the +<body>+ of the page
   #   during a page refresh. It can be one of:
@@ -64,7 +64,7 @@ module Turbo::DriveHelper
   #   * +reset:+: Resets scroll to the top, left corner. This is the default.
   #   * +preserve:+: Keeps the scroll.
   #
-  # === Example Usage:
+  # ==== Example Usage:
   #
   #   turbo_refreshes_with(method: :morph, scroll: :preserve)
   def turbo_refreshes_with(method: :replace, scroll: :reset)

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

@@ -44,8 +44,9 @@ module Turbo::Streams::ActionHelper
   private
     def convert_to_turbo_stream_dom_id(target, include_selector: false)
-      if Array(target).any? { |value| value.respond_to?(:to_key) }
-        "#{"#" if include_selector}#{ActionView::RecordIdentifier.dom_id(*target)}"
+      target_array = Array.wrap(target)
+      if target_array.any? { |value| value.respond_to?(:to_key) }
+        "#{"#" if include_selector}#{ActionView::RecordIdentifier.dom_id(*target_array)}"
       else
         target
       end

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

@@ -1,4 +1,4 @@
-# Turbo streams can be broadcast directly from models that include this module (this is automatically done for Active Records).
+# Turbo streams can be broadcasted directly from models that include this module (this is automatically done for Active Records).
 # This makes it convenient to execute both synchronous and asynchronous updates, and render directly from callbacks in models
 # or from controllers or jobs that act on those models. Here's an example:
 #
@@ -79,19 +79,19 @@
 #
 # == Page refreshes
 #
-# You can broadcast "page refresh" stream actions. This will make subscribed clients reload the
+# You can broadcast "page refresh" stream actions. This will make subscribed clients reload the
 # page. For pages that configure morphing and scroll preservation, this will translate into smooth
 # updates when it only updates the content that changed.
+#
 # This approach is an alternative to fine-grained stream actions targeting specific DOM elements. It
 # offers good fidelity with a much simpler programming model. As a tradeoff, the fidelity you can reach
 # is often not as high as with targeted stream actions since it renders the entire page again.
 #
-# The +broadcast_refreshes+ class method configures the model to broadcast a "page refresh" on creates,
+# The +broadcasts_refreshes+ class method configures the model to broadcast a "page refresh" on creates,
 # updates, and destroys to a stream name derived at runtime by the <tt>stream</tt> symbol invocation. Examples
 #
 #   class Board < ApplicationRecord
-#     broadcast_refreshes
+#     broadcasts_refreshes
 #   end
 #
 # In this example, when a board is created, updated, or destroyed, a Turbo Stream for a
@@ -104,16 +104,16 @@
 #     belongs_to :board, touch: true # +Board+ will trigger a page refresh on column changes
 #   end
 #
-# You can also specify the streamable declaratively by passing a symbol to the +broadcast_refreshes_to+ method:
+# You can also specify the streamable declaratively by passing a symbol to the +broadcasts_refreshes_to+ method:
 #
 #   class Column < ApplicationRecord
 #     belongs_to :board
-#     broadcast_refreshes_to :board
+#     broadcasts_refreshes_to :board
 #   end
 #
-# For more granular control, you can also broadcast a "page refresh" to a stream name derived
+# For more granular control, you can also broadcast a "page refresh" to a stream name derived
 # from the passed <tt>streamables</tt> by using the instance-level methods <tt>broadcast_refresh_to</tt> or
-# <tt>broadcast_refresh_later_to</tt>. These methods are particularly useful when you want to trigger
+# <tt>broadcast_refresh_later_to</tt>. These methods are particularly useful when you want to trigger
 # a page refresh for more specific scenarios. Example:
 #
 #   class Clearance < ApplicationRecord
@@ -128,11 +128,11 @@
 #       end
 #   end
 #
-# In this example, a "page refresh" is broadcast to the stream named "identity:<identity-id>:clearances"
+# In this example, a "page refresh" is broadcast to the stream named "identity:<identity-id>:clearances"
 # after a new clearance is created. All clients subscribed to this stream will refresh the page to reflect
 # the changes.
 #
-# When broadcasting page refreshes, Turbo will automatically debounce multiple calls in a row to only broadcast the last one.
+# When broadcasting page refreshes, Turbo will automatically debounce multiple calls in a row to only broadcast the last one.
 # This is meant for scenarios where you process records in mass. Because of the nature of such signals, it makes no sense to
 # broadcast them repeatedly and individually.
 # == Suppressing broadcasts
@@ -260,6 +260,10 @@ module Turbo::Broadcastable
   #   # 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.broadcast_replace_to examiner.identity, :clearances, partial: "clearances/other_partial", locals: { a: 1 }
+  #
+  #   # Sends <turbo-stream action="replace" method="morph" target="clearance_5"><template><div id="clearance_5">Other partial</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.broadcast_replace_to examiner.identity, :clearance, attributes: { method: :morph }, 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)) unless suppressed_turbo_broadcasts?
   end
@@ -279,6 +283,10 @@ module Turbo::Broadcastable
   #   # 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.broadcast_update_to examiner.identity, :clearances, partial: "clearances/other_partial", locals: { a: 1 }
+  #
+  #   # sends <turbo-stream action="update" method="morph" target="clearance_5"><template><div id="clearance_5">Other partial</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   # clearance.broadcast_update_to examiner.identity, :clearances, attributes: { method: :morph }, 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)) unless suppressed_turbo_broadcasts?
   end

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

@@ -228,6 +228,32 @@ class Turbo::Streams::TagBuilder
     action_all :prepend, targets, content, **rendering, &block
   end
+  # Morph 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.morph "clearance_5", "<div id='clearance_5'>Morph the dom target identified by clearance_5</div>" %>
+  #   <%= turbo_stream.morph clearance %>
+  #   <%= turbo_stream.morph clearance, partial: "clearances/clearance", locals: { title: "Hello" } %>
+  #   <%= turbo_stream.morph "clearance_5" do %>
+  #     <div id='clearance_5'>Morph the dom target identified by clearance_5</div>
+  #   <% end %>
+  def morph(target, content = nil, **rendering, &block)
+    action :morph, target, content, **rendering, &block
+  end
+  # Morph 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.morph_all ".clearance_item", "<div class='clearance_item'>Morph the dom target identified by the class clearance_item</div>" %>
+  #   <%= turbo_stream.morph_all clearance %>
+  #   <%= turbo_stream.morph_all clearance, partial: "clearances/clearance", locals: { title: "Hello" } %>
+  #   <%= turbo_stream.morph_all ".clearance_item" do %>
+  #     <div class='clearance_item'>Morph the dom target identified by the class clearance_item</div>
+  #   <% end %>
+  def morph_all(targets, content = nil, **rendering, &block)
+    action_all :morph, targets, content, **rendering, &block
+  end
   # Send an action of the type <tt>name</tt> to <tt>target</tt>. Options described in the concrete methods.
   def action(name, target, content = nil, allow_inferred_rendering: true, **rendering, &block)
     template = render_template(target, content, allow_inferred_rendering: allow_inferred_rendering, **rendering, &block)

data/lib/turbo/engine.rb CHANGED Viewed

@@ -15,8 +15,25 @@ module Turbo
       #{root}/app/jobs
     )
+    # If the parent application does not use Action Cable, app/channels cannot
+    # be eager loaded, because it references the ActionCable constant.
+    #
+    # When turbo-rails depends on Rails 7 or above, the entire block can be
+    # reduced to
+    #
+    #   unless defined?(ActionCable)
+    #     Rails.autoloaders.once.do_not_eager_load("#{root}/app/channels")
+    #   end
+    #
     initializer "turbo.no_action_cable", before: :set_eager_load_paths do
-      config.eager_load_paths.delete("#{root}/app/channels") unless defined?(ActionCable)
+      unless defined?(ActionCable)
+        if Rails.autoloaders.zeitwerk_enabled?
+          Rails.autoloaders.once.do_not_eager_load("#{root}/app/channels")
+        else
+          # This else branch only runs in Rails 6.x + classic mode.
+          config.eager_load_paths.delete("#{root}/app/channels")
+        end
+      end
     end
     # If you don't want to precompile Turbo's assets (eg. because you're using webpack),
@@ -63,11 +80,9 @@ module Turbo
     end
     initializer "turbo.renderer" do
-      ActiveSupport.on_load(:action_controller) do
-        ActionController::Renderers.add :turbo_stream do |turbo_streams_html, options|
-          self.content_type = Mime[:turbo_stream] if media_type.nil?
-          turbo_streams_html
-        end
+      ActionController::Renderers.add :turbo_stream do |turbo_streams_html, options|
+        self.content_type = Mime[:turbo_stream] if media_type.nil?
+        turbo_streams_html
       end
     end

data/lib/turbo/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "2.0.4"
+  VERSION = "2.0.6"
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.6
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -107,7 +107,8 @@ files:
 homepage: https://github.com/hotwired/turbo-rails
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/hotwired/turbo-rails/releases
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: The speed of a single-page web application without having to write any JavaScript.