turbo-rails 1.5.0 → 2.0.11

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/broadcastable/test_helper.rb

@@ -11,14 +11,14 @@ module Turbo
 
       # Asserts that `<turbo-stream>` elements were broadcast over Action Cable
       #
-      # === Arguments
+      # ==== Arguments
       #
       # * <tt>stream_name_or_object</tt> the objects used to generate the
       #   channel Action Cable name, or the name itself
       # * <tt>&block</tt> optional block executed before the
       #   assertion
       #
-      # === Options
+      # ==== Options
       #
       # * <tt>count:</tt> the number of `<turbo-stream>` elements that are
       # expected to be broadcast
@@ -64,13 +64,13 @@ module Turbo
         else
           broadcasts = "Turbo Stream broadcast".pluralize(count)
 
-          assert count == payloads.count, "Expected #{count} #{broadcasts} on #{stream_name.inspect}, but there were none"
+          assert count == payloads.count, "Expected #{count} #{broadcasts} on #{stream_name.inspect}, but there were #{payloads.count}"
         end
       end
 
       # Asserts that no `<turbo-stream>` elements were broadcast over Action Cable
       #
-      # === Arguments
+      # ==== Arguments
       #
       # * <tt>stream_name_or_object</tt> the objects used to generate the
       #   channel Action Cable name, or the name itself
@@ -113,7 +113,7 @@ module Turbo
 
       # Captures any `<turbo-stream>` elements that were broadcast over Action Cable
       #
-      # === Arguments
+      # ==== Arguments
       #
       # * <tt>stream_name_or_object</tt> the objects used to generate the
       #   channel Action Cable name, or the name itself

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,8 +16,46 @@ 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.
+    #
+    # 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),
@@ -46,9 +85,17 @@ module Turbo
       end
     end
 
+    initializer "turbo.request_id_tracking" do
+      ActiveSupport.on_load(:action_controller) do
+        include Turbo::RequestIdTracking
+      end
+    end
+
     initializer "turbo.broadcastable" do
       ActiveSupport.on_load(:active_record) do
-        include Turbo::Broadcastable
+        if defined?(ActiveJob)
+          include Turbo::Broadcastable
+        end
       end
     end
 
@@ -57,11 +104,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
 
@@ -75,11 +120,18 @@ module Turbo
     initializer "turbo.test_assertions" do
       ActiveSupport.on_load(:active_support_test_case) do
         require "turbo/test_assertions"
-        require "turbo/broadcastable/test_helper"
-
         include Turbo::TestAssertions
       end
 
+      ActiveSupport.on_load(:action_cable) do
+        ActiveSupport.on_load(:active_support_test_case) do
+          if defined?(ActiveJob)
+            require "turbo/broadcastable/test_helper"
+            include Turbo::Broadcastable::TestHelper
+          end
+        end
+      end
+
       ActiveSupport.on_load(:action_dispatch_integration_test) do
         require "turbo/test_assertions/integration_test_assertions"
 
@@ -100,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/test_assertions/integration_test_assertions.rb

@@ -4,7 +4,7 @@ module Turbo
       # Assert that the Turbo Stream request's response body's HTML contains a
       # `<turbo-stream>` element.
       #
-      # === Options
+      # ==== Options
       #
       # * <tt>:status</tt> [Integer, Symbol] the HTTP response status
       # * <tt>:action</tt> [String] matches the element's <tt>[action]</tt>
@@ -47,7 +47,7 @@ module Turbo
       # Assert that the Turbo Stream request's response body's HTML does not
       # contain a `<turbo-stream>` element.
       #
-      # === Options
+      # ==== Options
       #
       # * <tt>:status</tt> [Integer, Symbol] the HTTP response status
       # * <tt>:action</tt> [String] matches the element's <tt>[action]</tt>

data/lib/turbo/test_assertions.rb

@@ -10,7 +10,7 @@ module Turbo
     # Assert that the rendered fragment of HTML contains a `<turbo-stream>`
     # element.
     #
-    # === Options
+    # ==== Options
     #
     # * <tt>:action</tt> [String] matches the element's <tt>[action]</tt>
     #   attribute
@@ -55,7 +55,7 @@ module Turbo
     # Assert that the rendered fragment of HTML does not contain a `<turbo-stream>`
     # element.
     #
-    # === Options
+    # ==== Options
     #
     # * <tt>:action</tt> [String] matches the element's <tt>[action]</tt>
     #   attribute

data/lib/turbo/version.rb

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "1.5.0"
+  VERSION = "2.0.11"
 end

data/lib/turbo-rails.rb

@@ -1,10 +1,13 @@
 require "turbo/engine"
+require "active_support/core_ext/module/attribute_accessors_per_thread"
 
 module Turbo
   extend ActiveSupport::Autoload
 
   mattr_accessor :draw_routes, default: true
 
+  thread_mattr_accessor :current_request_id
+
   class << self
     attr_writer :signed_stream_verifier_key
 
@@ -15,5 +18,12 @@ module Turbo
     def signed_stream_verifier_key
       @signed_stream_verifier_key or raise ArgumentError, "Turbo requires a signed_stream_verifier_key"
     end
+
+    def with_request_id(request_id)
+      old_request_id, self.current_request_id = self.current_request_id, request_id
+      yield
+    ensure
+      self.current_request_id = old_request_id
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.11
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,22 +10,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activejob
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +55,7 @@ files:
 - app/channels/turbo/streams/broadcasts.rb
 - app/channels/turbo/streams/stream_name.rb
 - app/channels/turbo/streams_channel.rb
+- app/controllers/concerns/turbo/request_id_tracking.rb
 - app/controllers/turbo/frames/frame_request.rb
 - app/controllers/turbo/native/navigation.rb
 - app/controllers/turbo/native/navigation_controller.rb
@@ -85,11 +72,13 @@ files:
 - app/javascript/turbo/snakeize.js
 - app/jobs/turbo/streams/action_broadcast_job.rb
 - app/jobs/turbo/streams/broadcast_job.rb
+- app/jobs/turbo/streams/broadcast_stream_job.rb
 - app/models/concerns/turbo/broadcastable.rb
+- app/models/turbo/debouncer.rb
 - app/models/turbo/streams/tag_builder.rb
+- app/models/turbo/thread_debouncer.rb
 - app/views/layouts/turbo_rails/frame.html.erb
 - config/routes.rb
-- lib/install/turbo_needs_redis.rb
 - lib/install/turbo_with_bun.rb
 - lib/install/turbo_with_importmap.rb
 - lib/install/turbo_with_node.rb
@@ -97,13 +86,15 @@ files:
 - lib/turbo-rails.rb
 - lib/turbo/broadcastable/test_helper.rb
 - lib/turbo/engine.rb
+- lib/turbo/system_test_helper.rb
 - lib/turbo/test_assertions.rb
 - lib/turbo/test_assertions/integration_test_assertions.rb
 - lib/turbo/version.rb
 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:
@@ -119,7 +110,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.

data/lib/install/turbo_needs_redis.rb

@@ -1,20 +0,0 @@
-if (cable_config_path = Rails.root.join("config/cable.yml")).exist?
-  say "Enable redis in bundle"
-
-  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"
-else
-  say 'ActionCable config file (config/cable.yml) is missing. Uncomment "gem \'redis\'" in your Gemfile and create config/cable.yml to use the Turbo Streams broadcast feature.'
-end