turbo-rails 2.0.6 → 2.0.10

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

@@ -6,7 +6,7 @@ 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, render: false, **opts)
   end
 
   def broadcast_replace_to(*streamables, **opts)
@@ -38,10 +38,9 @@ module Turbo::Streams::Broadcasts
   end
 
   def broadcast_action_to(*streamables, action:, target: nil, targets: nil, attributes: {}, **rendering)
-    broadcast_stream_to(*streamables, content: turbo_stream_action_tag(action, target: target, targets: targets, template:
-      rendering.delete(:content) || rendering.delete(:html) || (rendering[:render] != false && rendering.any? ? render_format(:html, **rendering) : nil),
-      **attributes
-    ))
+    broadcast_stream_to *streamables, content: turbo_stream_action_tag(
+      action, target: target, targets: targets, template: render_broadcast_action(rendering), **attributes
+    )
   end
 
   def broadcast_replace_later_to(*streamables, **opts)
@@ -70,7 +69,7 @@ module Turbo::Streams::Broadcasts
 
   def broadcast_refresh_later_to(*streamables, request_id: Turbo.current_request_id, **opts)
     refresh_debouncer_for(*streamables, request_id: request_id).debounce do
-      Turbo::Streams::BroadcastStreamJob.perform_later stream_name_from(streamables), content: turbo_stream_refresh_tag(request_id: request_id, **opts)
+      Turbo::Streams::BroadcastStreamJob.perform_later stream_name_from(streamables), content: turbo_stream_refresh_tag(request_id: request_id, **opts).to_str # Sidekiq requires job arguments to be valid JSON types, such as String
     end
   end
 
@@ -111,4 +110,16 @@ module Turbo::Streams::Broadcasts
     def render_format(format, **rendering)
       ApplicationController.render(formats: [ format ], **rendering)
     end
+
+    def render_broadcast_action(rendering)
+      content = rendering.delete(:content)
+      html    = rendering.delete(:html)
+      render  = rendering.delete(:render)
+
+      if render == false
+        nil
+      else
+        content || html || (render_format(:html, **rendering) if rendering.present?)
+      end
+    end
 end

data/app/helpers/turbo/streams_helper.rb

@@ -48,7 +48,13 @@ module Turbo::StreamsHelper
   # 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"} %>
+  #
+  # Raises an +ArgumentError+ if all streamables are blank
+  #
+  #   <%= turbo_stream_from("") %> # => ArgumentError: streamables can't be blank
+  #   <%= turbo_stream_from("", nil) %> # => ArgumentError: streamables can't be blank
   def turbo_stream_from(*streamables, **attributes)
+    raise ArgumentError, "streamables can't be blank" unless streamables.any?(&:present?)
     attributes[:channel] = attributes[:channel]&.to_s || "Turbo::StreamsChannel"
     attributes[:"signed-stream-name"] = Turbo::StreamsChannel.signed_stream_name(streamables)
 

data/app/javascript/turbo/cable_stream_source_element.js

@@ -3,6 +3,8 @@ import { subscribeTo } from "./cable"
 import snakeize from "./snakeize"
 
 class TurboCableStreamSourceElement extends HTMLElement {
+  static observedAttributes = ["channel", "signed-stream-name"]
+
   async connectedCallback() {
     connectStreamSource(this)
     this.subscription = await subscribeTo(this.channel, {
@@ -15,6 +17,14 @@ class TurboCableStreamSourceElement extends HTMLElement {
   disconnectedCallback() {
     disconnectStreamSource(this)
     if (this.subscription) this.subscription.unsubscribe()
+    this.subscriptionDisconnected()
+  }
+
+  attributeChangedCallback() {
+    if (this.subscription) {
+      this.disconnectedCallback()
+      this.connectedCallback()
+    }
   }
 
   dispatchMessageEvent(data) {

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

@@ -1,4 +1,4 @@
-# Turbo streams can be broadcasted 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 if ActiveJob is loaded).
 # 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:
 #
@@ -241,13 +241,13 @@ 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) unless suppressed_turbo_broadcasts?
+  def broadcast_remove_to(*streamables, target: self, **rendering)
+    Turbo::StreamsChannel.broadcast_remove_to(*streamables, **extract_options_and_add_target(rendering, target: target)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_remove_to</tt>, but the designated stream is automatically set to the current model.
-  def broadcast_remove
-    broadcast_remove_to self
+  def broadcast_remove(**rendering)
+    broadcast_remove_to self, **rendering
   end
 
   # Replace this broadcastable model in the dom for subscribers of the stream name identified by the passed
@@ -265,7 +265,7 @@ module Turbo::Broadcastable
   #   # 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?
+    Turbo::StreamsChannel.broadcast_replace_to(*streamables, **extract_options_and_add_target(rendering, target: self)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_replace_to</tt>, but the designated stream is automatically set to the current model.
@@ -288,7 +288,7 @@ module Turbo::Broadcastable
   #   # 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?
+    Turbo::StreamsChannel.broadcast_update_to(*streamables, **extract_options_and_add_target(rendering, target: self)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_update_to</tt>, but the designated stream is automatically set to the current model.
@@ -308,8 +308,10 @@ module Turbo::Broadcastable
   #   # to the stream named "identity:2:clearances"
   #   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))
+  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)))
   end
 
   # Insert a rendering of this broadcastable model after the target identified by it's dom id passed as <tt>target</tt>
@@ -324,8 +326,10 @@ module Turbo::Broadcastable
   #   # to the stream named "identity:2:clearances"
   #   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))
+  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)))
   end
 
   # Append a rendering of this broadcastable model to the target identified by it's dom id passed as <tt>target</tt>
@@ -341,7 +345,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)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_append_to(*streamables, **extract_options_and_add_target(rendering, target: target)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_append_to</tt>, but the designated stream is automatically set to the current model.
@@ -362,7 +366,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)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_prepend_to(*streamables, **extract_options_and_add_target(rendering, target: target)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_prepend_to</tt>, but the designated stream is automatically set to the current model.
@@ -389,7 +393,7 @@ module Turbo::Broadcastable
   #   # to the stream named "identity:2:clearances"
   #   clearance.broadcast_action_to examiner.identity, :clearances, action: :prepend, target: "clearances"
   def broadcast_action_to(*streamables, action:, target: broadcast_target_default, attributes: {}, **rendering)
-    Turbo::StreamsChannel.broadcast_action_to(*streamables, action: action, target: target, attributes: attributes, **broadcast_rendering_with_defaults(rendering)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_action_to(*streamables, action: action, attributes: attributes, **extract_options_and_add_target(rendering, target: target)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_action_to</tt>, but the designated stream is automatically set to the current model.
@@ -399,7 +403,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)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_replace_later_to(*streamables, **extract_options_and_add_target(rendering, target: self)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_replace_later_to</tt>, but the designated stream is automatically set to the current model.
@@ -409,7 +413,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)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_update_later_to(*streamables, **extract_options_and_add_target(rendering, target: self)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_update_later_to</tt>, but the designated stream is automatically set to the current model.
@@ -419,7 +423,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)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_append_later_to(*streamables, **extract_options_and_add_target(rendering, target: target)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_append_later_to</tt>, but the designated stream is automatically set to the current model.
@@ -429,7 +433,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)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_prepend_later_to(*streamables, **extract_options_and_add_target(rendering, target: target)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_prepend_later_to</tt>, but the designated stream is automatically set to the current model.
@@ -449,7 +453,7 @@ module Turbo::Broadcastable
 
   # Same as <tt>broadcast_action_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
   def broadcast_action_later_to(*streamables, action:, target: broadcast_target_default, attributes: {}, **rendering)
-    Turbo::StreamsChannel.broadcast_action_later_to(*streamables, action: action, target: target, attributes: attributes, **broadcast_rendering_with_defaults(rendering)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_action_later_to(*streamables, action: action, attributes: attributes, **extract_options_and_add_target(rendering, target: target)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>#broadcast_action_later_to</tt>, but the designated stream is automatically set to the current model.
@@ -485,7 +489,7 @@ module Turbo::Broadcastable
   # 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)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_render_to(*streamables, **extract_options_and_add_target(rendering, target: self)) unless suppressed_turbo_broadcasts?
   end
 
   # Same as <tt>broadcast_render_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
@@ -496,7 +500,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)) unless suppressed_turbo_broadcasts?
+    Turbo::StreamsChannel.broadcast_render_later_to(*streamables, **extract_options_and_add_target(rendering)) unless suppressed_turbo_broadcasts?
   end
 
   private
@@ -504,11 +508,17 @@ module Turbo::Broadcastable
       self.class.broadcast_target_default
     end
 
+    def extract_options_and_add_target(rendering = {}, target: broadcast_target_default)
+      broadcast_rendering_with_defaults(rendering).tap do |options|
+        options[:target] = target if !options.key?(:target) && !options.key?(:targets)
+      end
+    end
+
     def 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, request_id: Turbo.current_request_id).compact
+        o[:locals] = (o[:locals] || {}).reverse_merge!(model_name.element.to_sym => self).compact
 
         if o[:html] || o[:partial]
           return o

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

@@ -77,8 +77,9 @@ class Turbo::Streams::TagBuilder
   #   <%= turbo_stream.replace "clearance_5" do %>
   #     <div id='clearance_5'>Replace the dom target identified by clearance_5</div>
   #   <% end %>
-  def replace(target, content = nil, **rendering, &block)
-    action :replace, target, content, **rendering, &block
+  #   <%= turbo_stream.replace clearance, "<div>Morph the dom target</div>", method: :morph %>
+  def replace(target, content = nil, method: nil, **rendering, &block)
+    action :replace, target, content, method: method, **rendering, &block
   end
 
   # Replace the <tt>targets</tt> in the dom with either the <tt>content</tt> passed in, a rendering result determined
@@ -90,8 +91,9 @@ class Turbo::Streams::TagBuilder
   #   <%= turbo_stream.replace_all ".clearance_item" do %>
   #     <div class='.clearance_item'>Replace the dom target identified by the class clearance_item</div>
   #   <% end %>
-  def replace_all(targets, content = nil, **rendering, &block)
-    action_all :replace, targets, content, **rendering, &block
+  #   <%= turbo_stream.replace_all clearance, "<div>Morph the dom target</div>", method: :morph %>
+  def replace_all(targets, content = nil, method: nil, **rendering, &block)
+    action_all :replace, targets, content, method: method, **rendering, &block
   end
 
   # Insert the <tt>content</tt> passed in, a rendering result determined by the <tt>rendering</tt> keyword arguments,
@@ -155,8 +157,9 @@ class Turbo::Streams::TagBuilder
   #   <%= turbo_stream.update "clearance_5" do %>
   #     Update the content of the dom target identified by clearance_5
   #   <% end %>
-  def update(target, content = nil, **rendering, &block)
-    action :update, target, content, **rendering, &block
+  #   <%= turbo_stream.update clearance, "<div>Morph the dom target</div>", method: :morph %>
+  def update(target, content = nil, method: nil, **rendering, &block)
+    action :update, target, content, method: method, **rendering, &block
   end
 
   # Update the <tt>targets</tt> in the dom with either the <tt>content</tt> passed in or a rendering result determined
@@ -168,8 +171,9 @@ class Turbo::Streams::TagBuilder
   #   <%= turbo_stream.update_all "clearance_item" do %>
   #     Update the content of the dom target identified by the class clearance_item
   #   <% end %>
-  def update_all(targets, content = nil, **rendering, &block)
-    action_all :update, targets, content, **rendering, &block
+  #   <%= turbo_stream.update_all clearance, "<div>Morph the dom target</div>", method: :morph %>
+  def update_all(targets, content = nil, method: nil, **rendering, &block)
+    action_all :update, targets, content, method: method, **rendering, &block
   end
 
   # Append to the target in the dom identified with <tt>target</tt> either the <tt>content</tt> passed in or a
@@ -228,49 +232,37 @@ 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:
+  # Creates a `turbo-stream` tag with an `[action="refresh"`] attribute and a
+  # `[request-id]` attribute that defaults to `Turbo.current_request_id`:
   #
-  #   <%= 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.refresh
+  #   # => <turbo-stream action="refresh" request-id="ef083d55-7516-41b1-ad28-16f553399c6a"></turbo-stream>
   #
-  #   <%= 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
+  #   turbo_stream.refresh request_id: "abc123"
+  #   # => <turbo-stream action="refresh" request-id="abc123"></turbo-stream>
+  def refresh(...)
+    turbo_stream_refresh_tag(...)
   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)
+  def action(name, target, content = nil, method: nil, allow_inferred_rendering: true, **rendering, &block)
     template = render_template(target, content, allow_inferred_rendering: allow_inferred_rendering, **rendering, &block)
 
-    turbo_stream_action_tag name, target: target, template: template
+    turbo_stream_action_tag name, target: target, template: template, method: method
   end
 
   # Send an action of the type <tt>name</tt> to <tt>targets</tt>. Options described in the concrete methods.
-  def action_all(name, targets, content = nil, allow_inferred_rendering: true, **rendering, &block)
+  def action_all(name, targets, content = nil, method: nil, allow_inferred_rendering: true, **rendering, &block)
     template = render_template(targets, content, allow_inferred_rendering: allow_inferred_rendering, **rendering, &block)
 
-    turbo_stream_action_tag name, targets: targets, template: template
+    turbo_stream_action_tag name, targets: targets, template: template, method: method
   end
 
   private
     def render_template(target, content = nil, allow_inferred_rendering: true, **rendering, &block)
       case
+      when target.respond_to?(:render_in) && content.nil?
+        target.render_in(@view_context, &block)
       when content.respond_to?(:render_in)
         content.render_in(@view_context, &block)
       when content

data/config/routes.rb

@@ -1,5 +1,5 @@
 Rails.application.routes.draw do
-  get "recede_historical_location"  => "turbo/native/navigation#recede",  as: :turbo_recede_historical_location
-  get "resume_historical_location"  => "turbo/native/navigation#resume",  as: :turbo_resume_historical_location
-  get "refresh_historical_location" => "turbo/native/navigation#refresh", as: :turbo_refresh_historical_location
+  get "recede_historical_location", to: "turbo/native/navigation#recede", as: :turbo_recede_historical_location
+  get "resume_historical_location", to: "turbo/native/navigation#resume", as: :turbo_resume_historical_location
+  get "refresh_historical_location", to: "turbo/native/navigation#refresh", as: :turbo_refresh_historical_location
 end if Turbo.draw_routes

data/lib/tasks/turbo_tasks.rake

@@ -5,20 +5,6 @@ module Turbo
       system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/#{path}.rb", __dir__)}"
     end
 
-    def redis_installed?
-      Gem.win_platform? ?
-        system('where redis-server > NUL 2>&1') :
-        system('which redis-server > /dev/null')
-    end
-
-    def switch_on_redis_if_available
-      if redis_installed?
-        Rake::Task["turbo:install:redis"].invoke
-      else
-        puts "Run turbo:install:redis to switch on Redis and use it in development for turbo streams"
-      end
-    end
-
     def using_bun?
       Rails.root.join("bun.config.js").exist?
     end
@@ -43,24 +29,16 @@ namespace :turbo do
     desc "Install Turbo into the app with asset pipeline"
     task :importmap do
       Turbo::Tasks.run_turbo_install_template "turbo_with_importmap"
-      Turbo::Tasks.switch_on_redis_if_available
     end
 
     desc "Install Turbo into the app with webpacker"
     task :node do
       Turbo::Tasks.run_turbo_install_template "turbo_with_node"
-      Turbo::Tasks.switch_on_redis_if_available
     end
 
     desc "Install Turbo into the app with bun"
     task :bun do
       Turbo::Tasks.run_turbo_install_template "turbo_with_bun"
-      Turbo::Tasks.switch_on_redis_if_available
-    end
-
-    desc "Switch on Redis and use it in development"
-    task :redis do
-      Turbo::Tasks.run_turbo_install_template "turbo_needs_redis"
     end
   end
 end

data/lib/turbo/engine.rb

@@ -5,6 +5,7 @@ module Turbo
     isolate_namespace Turbo
     config.eager_load_namespaces << Turbo
     config.turbo = ActiveSupport::OrderedOptions.new
+    config.turbo.test_connect_after_actions = %i[visit]
     config.autoload_once_paths = %W(
       #{root}/app/channels
       #{root}/app/controllers
@@ -15,6 +16,27 @@ module Turbo
       #{root}/app/jobs
     )
 
+    # 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
+      end
+    end
+
     # If the parent application does not use Action Cable, app/channels cannot
     # be eager loaded, because it references the ActionCable constant.
     #
@@ -71,7 +93,9 @@ module Turbo
 
     initializer "turbo.broadcastable" do
       ActiveSupport.on_load(:active_record) do
-        include Turbo::Broadcastable
+        if defined?(ActiveJob)
+          include Turbo::Broadcastable
+        end
       end
     end
 
@@ -101,8 +125,10 @@ module Turbo
 
       ActiveSupport.on_load(:action_cable) do
         ActiveSupport.on_load(:active_support_test_case) do
-          require "turbo/broadcastable/test_helper"
-          include Turbo::Broadcastable::TestHelper
+          if defined?(ActiveJob)
+            require "turbo/broadcastable/test_helper"
+            include Turbo::Broadcastable::TestHelper
+          end
         end
       end
 
@@ -126,5 +152,24 @@ module Turbo
         end
       end
     end
+
+    initializer "turbo.system_test_helper" do
+      ActiveSupport.on_load(:action_dispatch_system_test_case) do
+        require "turbo/system_test_helper"
+        include Turbo::SystemTestHelper
+      end
+    end
+
+    config.after_initialize do |app|
+      ActiveSupport.on_load(:action_dispatch_system_test_case) do
+        app.config.turbo.test_connect_after_actions.map do |method|
+          class_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def #{method}(...)                                    # def visit(...)
+              super.tap { connect_turbo_cable_stream_sources }    #   super.tap { connect_turbo_cable_stream_sources }
+            end                                                   # end
+          RUBY
+        end
+      end
+    end
   end
 end

data/lib/turbo/system_test_helper.rb

@@ -0,0 +1,128 @@
+module Turbo::SystemTestHelper
+  # Delay until every `<turbo-cable-stream-source>` element present in the page
+  # is ready to receive broadcasts
+  #
+  #   test "renders broadcasted Messages" do
+  #     message = Message.new content: "Hello, from Action Cable"
+  #
+  #     visit "/"
+  #     click_link "All Messages"
+  #     message.save! # execute server-side code to broadcast a Message
+  #
+  #     assert_text message.content
+  #   end
+  #
+  # By default, calls to `#visit` will wait for all `<turbo-cable-stream-source>`
+  # elements to connect. You can control this by modifying the
+  # `config.turbo.test_connect_after_actions`. For example, to wait after calls to
+  # `#click_link`, add the following to `config/environments/test.rb`:
+  #
+  #   # config/environments/test.rb
+  #   config.turbo.test_connect_after_actions << :click_link
+  #
+  # To disable automatic connecting, set the configuration to `[]`:
+  #
+  #   # config/environments/test.rb
+  #   config.turbo.test_connect_after_actions = []
+  #
+  def connect_turbo_cable_stream_sources(**options, &block)
+    all(:turbo_cable_stream_source, **options, connected: false, wait: 0).each do |element|
+      element.assert_matches_selector(:turbo_cable_stream_source, **options, connected: true, &block)
+    end
+  end
+
+  # Asserts that a `<turbo-cable-stream-source>` element is present in the
+  # document
+  #
+  # ==== Arguments
+  #
+  # * <tt>locator</tt> optional locator to determine the element's
+  #   `[signed-stream-name]` attribute. Can be of any type that is a valid
+  #   argument to <tt>Turbo::Streams::StreamName#signed_stream_name</tt>.
+  #
+  # ==== Options
+  #
+  # * <tt>:connected</tt> matches the `[connected]` attribute
+  # * <tt>:channel</tt> matches the `[channel]` attribute. Can be a Class,
+  #   String, Symbol, or Regexp
+  # * <tt>:signed_stream_name</tt> matches the element's `[signed-stream-name]`
+  #   attribute. Can be of any type that is a valid
+  #   argument to <tt>Turbo::Streams::StreamName#signed_stream_name</tt>.
+  #
+  # In addition to the filters listed above, accepts any valid Capybara global
+  # filter option.
+  def assert_turbo_cable_stream_source(...)
+    assert_selector(:turbo_cable_stream_source, ...)
+  end
+
+  # Asserts that a `<turbo-cable-stream-source>` element is absent from the
+  # document
+  #
+  # ==== Arguments
+  #
+  # * <tt>locator</tt> optional locator to determine the element's
+  #   `[signed-stream-name]` attribute. Can be of any type that is a valid
+  #   argument to <tt>Turbo::Streams::StreamName#signed_stream_name</tt>.
+  #
+  # ==== Options
+  #
+  # * <tt>:connected</tt> matches the `[connected]` attribute
+  # * <tt>:channel</tt> matches the `[channel]` attribute. Can be a Class,
+  #   String, Symbol, or Regexp
+  # * <tt>:signed_stream_name</tt> matches the element's `[signed-stream-name]`
+  #   attribute. Can be of any type that is a valid
+  #   argument to <tt>Turbo::Streams::StreamName#signed_stream_name</tt>.
+  #
+  # In addition to the filters listed above, accepts any valid Capybara global
+  # filter option.
+  def assert_no_turbo_cable_stream_source(...)
+    assert_no_selector(:turbo_cable_stream_source, ...)
+  end
+
+  Capybara.add_selector :turbo_cable_stream_source do
+    xpath do |locator|
+      xpath = XPath.descendant.where(XPath.local_name == "turbo-cable-stream-source")
+      xpath.where(SignedStreamNameConditions.new(locator).reduce(:|))
+    end
+
+    expression_filter :connected do |xpath, value|
+      builder(xpath).add_attribute_conditions(connected: value)
+    end
+
+    expression_filter :channel do |xpath, value|
+      builder(xpath).add_attribute_conditions(channel: value.try(:name) || value)
+    end
+
+    expression_filter :signed_stream_name do |xpath, value|
+      case value
+      when TrueClass, FalseClass, NilClass, Regexp
+        builder(xpath).add_attribute_conditions("signed-stream-name": value)
+      else
+        xpath.where(SignedStreamNameConditions.new(value).reduce(:|))
+      end
+    end
+  end
+
+  class SignedStreamNameConditions # :nodoc:
+    include Turbo::Streams::StreamName, Enumerable
+
+    def initialize(value)
+      @value = value
+    end
+
+    def attribute
+      XPath.attr(:"signed-stream-name")
+    end
+
+    def each
+      if @value.is_a?(String)
+        yield attribute == @value
+        yield attribute == signed_stream_name(@value)
+      elsif @value.is_a?(Array) || @value.respond_to?(:to_key)
+        yield attribute == signed_stream_name(@value)
+      elsif @value.present?
+        yield attribute == @value
+      end
+    end
+  end
+end

data/lib/turbo/version.rb

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