turbo-rails 2.0.19 → 2.0.21

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

@@ -33,8 +33,8 @@ module Turbo::Streams::Broadcasts
     broadcast_action_to(*streamables, action: :prepend, **opts)
   end
 
-  def broadcast_refresh_to(*streamables, **opts)
-    broadcast_stream_to(*streamables, content: turbo_stream_refresh_tag)
+  def broadcast_refresh_to(*streamables, **attributes)
+    broadcast_stream_to(*streamables, content: turbo_stream_refresh_tag(**attributes))
   end
 
   def broadcast_action_to(*streamables, action:, target: nil, targets: nil, attributes: {}, **rendering)

data/app/helpers/turbo/drive_helper.rb

@@ -74,13 +74,13 @@ module Turbo::DriveHelper
 
   # Configure method to perform page refreshes. See +turbo_refreshes_with+.
   def turbo_refresh_method_tag(method = :replace)
-    raise ArgumentError, "Invalid refresh option '#{method}'" unless method.in?(%i[ replace morph ])
+    raise ArgumentError, "Invalid refresh option '#{method}'" unless method.to_sym.in?(%i[ replace morph ])
     tag.meta(name: "turbo-refresh-method", content: method)
   end
 
   # Configure scroll strategy for page refreshes. See +turbo_refreshes_with+.
   def turbo_refresh_scroll_tag(scroll = :reset)
-    raise ArgumentError, "Invalid scroll option '#{scroll}'" unless scroll.in?(%i[ reset preserve ])
+    raise ArgumentError, "Invalid scroll option '#{scroll}'" unless scroll.to_sym.in?(%i[ reset preserve ])
     tag.meta(name: "turbo-refresh-scroll", content: scroll)
   end
 end

data/app/helpers/turbo/frames_helper.rb

@@ -33,10 +33,13 @@ module Turbo::FramesHelper
   #   <%= turbo_frame_tag(Article.find(1)) %>
   #   # => <turbo-frame id="article_1"></turbo-frame>
   #
+  #   <%= turbo_frame_tag(Article) %>
+  #   # => <turbo-frame id="new_article"></turbo-frame>
+  #
   #   <%= turbo_frame_tag(Article.find(1), "comments") %>
   #   # => <turbo-frame id="comments_article_1"></turbo-frame>
   def turbo_frame_tag(*ids, src: nil, target: nil, **attributes, &block)
-    id = ids.first.respond_to?(:to_key) ? ActionView::RecordIdentifier.dom_id(*ids) : ids.join('_')
+    id = ids.first.respond_to?(:to_key) || ids.first.is_a?(Class) ? ActionView::RecordIdentifier.dom_id(*ids) : ids.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

@@ -19,6 +19,9 @@ module Turbo::Streams::ActionHelper
   #   turbo_stream_action_tag "remove", target: message
   #   # => <turbo-stream action="remove" target="message_1"></turbo-stream>
   #
+  #   turbo_stream_action_tag "remove", target: Message
+  #   # => <turbo-stream action="remove" target="new_message"></turbo-stream>
+  #
   #   message = Message.find(1)
   #   turbo_stream_action_tag "remove", target: [message, :special]
   #   # => <turbo-stream action="remove" target="special_message_1"></turbo-stream>
@@ -45,7 +48,7 @@ module Turbo::Streams::ActionHelper
   private
     def convert_to_turbo_stream_dom_id(target, include_selector: false)
       target_array = Array.wrap(target)
-      if target_array.any? { |value| value.respond_to?(:to_key) }
+      if target_array.any? { |value| value.respond_to?(:to_key) || value.is_a?(Class) }
         "#{"#" if include_selector}#{ActionView::RecordIdentifier.dom_id(*target_array)}"
       else
         target

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

@@ -311,7 +311,7 @@ module Turbo::Broadcastable
   def broadcast_before_to(*streamables, target: nil, targets: nil, **rendering)
     raise ArgumentError, "at least one of target or targets is required" unless target || targets
 
-    Turbo::StreamsChannel.broadcast_before_to(*streamables, **extract_options_and_add_target(rendering.merge(target: target, targets: targets)))
+    Turbo::StreamsChannel.broadcast_before_to(*streamables, **extract_options_and_add_target(rendering.merge(target: target, targets: targets))) unless suppressed_turbo_broadcasts?
   end
 
   # Insert a rendering of this broadcastable model after the target identified by it's dom id passed as <tt>target</tt>
@@ -329,7 +329,7 @@ module Turbo::Broadcastable
   def broadcast_after_to(*streamables, target: nil, targets: nil, **rendering)
     raise ArgumentError, "at least one of target or targets is required" unless target || targets
 
-    Turbo::StreamsChannel.broadcast_after_to(*streamables, **extract_options_and_add_target(rendering.merge(target: target, targets: targets)))
+    Turbo::StreamsChannel.broadcast_after_to(*streamables, **extract_options_and_add_target(rendering.merge(target: target, targets: targets))) unless suppressed_turbo_broadcasts?
   end
 
   # Append a rendering of this broadcastable model to the target identified by it's dom id passed as <tt>target</tt>
@@ -378,8 +378,8 @@ module Turbo::Broadcastable
   #
   #   # Sends <turbo-stream action="refresh"></turbo-stream> to the stream named "identity:2:clearances"
   #   clearance.broadcast_refresh_to examiner.identity, :clearances
-  def broadcast_refresh_to(*streamables)
-    Turbo::StreamsChannel.broadcast_refresh_to(*streamables) unless suppressed_turbo_broadcasts?
+  def broadcast_refresh_to(*streamables, **attributes)
+    Turbo::StreamsChannel.broadcast_refresh_to(*streamables, **attributes) unless suppressed_turbo_broadcasts?
   end
 
   #  Same as <tt>#broadcast_refresh_to</tt>, but the designated stream is automatically set to the current model.
@@ -442,8 +442,8 @@ module Turbo::Broadcastable
   end
 
   #  Same as <tt>broadcast_refresh_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
-  def broadcast_refresh_later_to(*streamables)
-    Turbo::StreamsChannel.broadcast_refresh_later_to(*streamables, request_id: Turbo.current_request_id) unless suppressed_turbo_broadcasts?
+  def broadcast_refresh_later_to(*streamables, **attributes)
+    Turbo::StreamsChannel.broadcast_refresh_later_to(*streamables, request_id: Turbo.current_request_id, **attributes) unless suppressed_turbo_broadcasts?
   end
 
   #  Same as <tt>#broadcast_refresh_later_to</tt>, but the designated stream is automatically set to the current model.

data/app/models/turbo/immediate_debouncer.rb

@@ -0,0 +1,17 @@
+# A debouncer that executes immediately without delays or background threads.
+# This doesn't debounce at all, but is safe to use in tests.
+class Turbo::ImmediateDebouncer # :nodoc:
+  def initialize(delay: Turbo::Debouncer::DEFAULT_DELAY)
+  end
+
+  def debounce(&block)
+    block.call
+  end
+
+  def wait
+  end
+
+  def complete?
+    true
+  end
+end

data/app/models/turbo/thread_debouncer.rb

@@ -3,6 +3,8 @@
 class Turbo::ThreadDebouncer
   delegate :wait, to: :debouncer
 
+  class_attribute :debouncer_class, default: Turbo::Debouncer
+
   def self.for(key, delay: Turbo::Debouncer::DEFAULT_DELAY)
     Thread.current[key] ||= new(key, Thread.current, delay: delay)
   end
@@ -11,7 +13,7 @@ class Turbo::ThreadDebouncer
 
   def initialize(key, thread, delay: )
     @key = key
-    @debouncer = Turbo::Debouncer.new(delay: delay)
+    @debouncer = debouncer_class.new(delay: delay)
     @thread = thread
   end
 

data/lib/turbo/broadcastable/test_helper.rb

@@ -155,10 +155,12 @@ module Turbo
       #     assert_equal "replace", remove["action"]
       #
       def capture_turbo_stream_broadcasts(stream_name_or_object, &block)
-        block&.call
-
         stream_name = stream_name_from(stream_name_or_object)
-        payloads = broadcasts(stream_name)
+        payloads = if block_given?
+          new_broadcasts_from(broadcasts(stream_name), stream_name, "capture_turbo_stream_broadcasts", &block)
+        else
+          broadcasts(stream_name)
+        end
 
         payloads.flat_map do |payload|
           html = ActiveSupport::JSON.decode(payload)

data/lib/turbo/engine.rb

@@ -18,43 +18,17 @@ module Turbo
 
     # If the parent application does not use Active Job, app/jobs cannot
     # be eager loaded, because it references the ActiveJob constant.
-    #
-    # When turbo-rails depends on Rails 7 or above, the entire block can be
-    # reduced to
-    #
-    #   unless defined?(ActiveJob)
-    #     Rails.autoloaders.once.do_not_eager_load("#{root}/app/jobs")
-    #   end
-    #
     initializer "turbo.no_active_job", before: :set_eager_load_paths do
       unless defined?(ActiveJob)
-        if Rails.autoloaders.zeitwerk_enabled?
-          Rails.autoloaders.once.do_not_eager_load("#{root}/app/jobs")
-        else
-          # This else branch only runs in Rails 6.x + classic mode.
-          config.eager_load_paths.delete("#{root}/app/jobs")
-        end
+        Rails.autoloaders.once.do_not_eager_load("#{root}/app/jobs")
       end
     end
 
     # 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
       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
+        Rails.autoloaders.once.do_not_eager_load("#{root}/app/channels")
       end
     end
 
@@ -121,6 +95,9 @@ module Turbo
       ActiveSupport.on_load(:active_support_test_case) do
         require "turbo/test_assertions"
         include Turbo::TestAssertions
+
+        # Use ImmediateDebouncer in tests to prevent flaky tests from background threads
+        Turbo::ThreadDebouncer.debouncer_class = Turbo::ImmediateDebouncer
       end
 
       ActiveSupport.on_load(:action_cable) do

data/lib/turbo/system_test_helper.rb

@@ -80,6 +80,8 @@ module Turbo::SystemTestHelper
   end
 
   Capybara.add_selector :turbo_cable_stream_source do
+    visible :all
+
     xpath do |locator|
       xpath = XPath.descendant.where(XPath.local_name == "turbo-cable-stream-source")
       xpath.where(SignedStreamNameConditions.new(locator).reduce(:|))

data/lib/turbo/test_assertions.rb

@@ -79,5 +79,79 @@ module Turbo
       selector << %([targets="#{targets}"]) if targets
       assert_select selector, count: 0
     end
+
+    # Assert that the rendered fragment of HTML contains a `<turbo-frame>`
+    # element.
+    #
+    # ==== Arguments
+    #
+    # * <tt>ids</tt> [String, Array<String, ActiveRecord::Base>] matches the element's <tt>[id]</tt> attribute
+    #
+    # ==== Options
+    #
+    # * <tt>:loading</tt> [String] matches the element's <tt>[loading]</tt>
+    #   attribute
+    # * <tt>:src</tt> [String] matches the element's <tt>[src]</tt> attribute
+    # * <tt>:target</tt> [String] matches the element's <tt>[target]</tt>
+    #   attribute
+    # * <tt>:count</tt> [Integer] indicates how many turbo frames are expected.
+    #   Defaults to <tt>1</tt>.
+    #
+    #   Given the following HTML fragment:
+    #
+    #     <turbo-frame id="example" target="_top"></turbo-frame>
+    #
+    #   The following assertion would pass:
+    #
+    #     assert_turbo_frame id: "example", target: "_top"
+    #
+    # You can also pass a block make assertions about the contents of the
+    # element. Given the following HTML fragment:
+    #
+    #     <turbo-frame id="example">
+    #       <p>Hello!</p>
+    #     </turbo-frame>
+    #
+    #   The following assertion would pass:
+    #
+    #     assert_turbo_frame id: "example" do
+    #       assert_select "p", text: "Hello!"
+    #     end
+    #
+    def assert_turbo_frame(*ids, loading: nil, src: nil, target: nil, count: 1, &block)
+      id = ids.first.respond_to?(:to_key) ? ActionView::RecordIdentifier.dom_id(*ids) : ids.join('_')
+      selector = %(turbo-frame[id="#{id}"])
+      selector << %([loading="#{loading}"]) if loading
+      selector << %([src="#{src}"]) if src
+      selector << %([target="#{target}"]) if target
+      assert_select selector, count: count, &block
+    end
+
+    # Assert that the rendered fragment of HTML does not contain a `<turbo-frame>`
+    # element.
+    #
+    # ==== Arguments
+    #
+    # * <tt>ids</tt> [String, Array<String, ActiveRecord::Base>] matches the <tt>[id]</tt> attribute
+    #
+    # ==== Options
+    #
+    # * <tt>:loading</tt> [String] matches the element's <tt>[loading]</tt>
+    #   attribute
+    # * <tt>:src</tt> [String] matches the element's <tt>[src]</tt> attribute
+    # * <tt>:target</tt> [String] matches the element's <tt>[target]</tt>
+    #   attribute
+    #
+    #   Given the following HTML fragment:
+    #
+    #     <turbo-frame id="example" target="_top"></turbo-frame>
+    #
+    #   The following assertion would fail:
+    #
+    #     assert_no_turbo_frame id: "example", target: "_top"
+    #
+    def assert_no_turbo_frame(*ids, **options, &block)
+      assert_turbo_frame(*ids, **options, count: 0, &block)
+    end
   end
 end

data/lib/turbo/version.rb

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "2.0.19"
+  VERSION = "2.0.21"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.19
+  version: 2.0.21
 platform: ruby
 authors:
 - Sam Stephenson
@@ -73,6 +73,7 @@ files:
 - app/jobs/turbo/streams/broadcast_stream_job.rb
 - app/models/concerns/turbo/broadcastable.rb
 - app/models/turbo/debouncer.rb
+- app/models/turbo/immediate_debouncer.rb
 - app/models/turbo/streams/tag_builder.rb
 - app/models/turbo/thread_debouncer.rb
 - app/views/layouts/turbo_rails/frame.html.erb