turbo-rails 1.4.0 → 1.5.0

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

@@ -23,6 +23,8 @@ module Turbo::Frames::FrameRequest
   included do
     layout -> { "turbo_rails/frame" if turbo_frame_request? }
     etag { :frame if turbo_frame_request? }
+
+    helper_method :turbo_frame_request_id
   end
 
   private

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

@@ -2,23 +2,34 @@
 # have Turbo Native clients running (see the Turbo iOS and Turbo Android projects for details), you can respond to native
 # requests with three dedicated responses: <tt>recede</tt>, <tt>resume</tt>, <tt>refresh</tt>.
 #
-# FIXME: Supply full description of when we use either.
+# turbo-android handles these actions automatically. You are required to implement the handling on your own for turbo-ios.
 module Turbo::Native::Navigation
-  private
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :turbo_native_app?
+  end
 
+  # Turbo Native applications are identified by having the string "Turbo Native" as part of their user agent.
+  def turbo_native_app?
+    request.user_agent.to_s.match?(/Turbo Native/)
+  end
+  
+  # Tell the Turbo Native app to dismiss a modal (if presented) or pop a screen off of the navigation stack.
   def recede_or_redirect_to(url, **options)
     turbo_native_action_or_redirect url, :recede, :to, options
   end
 
+  # Tell the Turbo Native app to ignore this navigation.
   def resume_or_redirect_to(url, **options)
     turbo_native_action_or_redirect url, :resume, :to, options
   end
 
+  # Tell the Turbo Native app to refresh the current screen.
   def refresh_or_redirect_to(url, **options)
     turbo_native_action_or_redirect url, :refresh, :to, options
   end
 
-
   def recede_or_redirect_back_or_to(url, **options)
     turbo_native_action_or_redirect url, :recede, :back, options
   end
@@ -30,6 +41,8 @@ module Turbo::Native::Navigation
   def refresh_or_redirect_back_or_to(url, **options)
     turbo_native_action_or_redirect url, :refresh, :back, options
   end
+  
+  private
 
   # :nodoc:
   def turbo_native_action_or_redirect(url, action, redirect_type, options = {})
@@ -43,9 +56,4 @@ module Turbo::Native::Navigation
       redirect_to url, options
     end
   end
-
-  # Turbo Native applications are identified by having the string "Turbo Native" as part of their user agent.
-  def turbo_native_app?
-    request.user_agent.to_s.match?(/Turbo Native/)
-  end
 end

data/app/helpers/turbo/frames_helper.rb

@@ -36,7 +36,7 @@ module Turbo::FramesHelper
   #   <%= turbo_frame_tag(Article.find(1), Comment.new) %>
   #   # => <turbo-frame id="article_1_new_comment"></turbo-frame>
   def turbo_frame_tag(*ids, src: nil, target: nil, **attributes, &block)
-    id = ids.map { |id| id.respond_to?(:to_key) ? ActionView::RecordIdentifier.dom_id(id) : id }.join("_")
+    id = ids.first.respond_to?(:to_key) ? ActionView::RecordIdentifier.dom_id(*ids) : ids.first
     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

@@ -11,6 +11,18 @@ 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>
+  #
+  # The `target:` keyword option will forward `ActionView::RecordIdentifier#dom_id`-compatible arguments to
+  # `ActionView::RecordIdentifier#dom_id`
+  #
+  #   message = Message.find(1)
+  #   turbo_stream_action_tag "remove", target: message
+  #   # => <turbo-stream action="remove" target="message_1"></turbo-stream>
+  #
+  #   message = Message.find(1)
+  #   turbo_stream_action_tag "remove", target: [message, :special]
+  #   # => <turbo-stream action="remove" target="special_message_1"></turbo-stream>
+  #
   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)
 
@@ -25,8 +37,8 @@ module Turbo::Streams::ActionHelper
 
   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)}"
+      if Array(target).any? { |value| value.respond_to?(:to_key) }
+        "#{"#" if include_selector}#{ActionView::RecordIdentifier.dom_id(*target)}"
       else
         target
       end

data/app/javascript/turbo/fetch_requests.js

@@ -35,7 +35,16 @@ function determineFetchMethod(submitter, body, form) {
 
 function determineFormMethod(submitter) {
   if (submitter instanceof HTMLButtonElement || submitter instanceof HTMLInputElement) {
-    if (submitter.hasAttribute("formmethod")) {
+    // Rails 7 ActionView::Helpers::FormBuilder#button method has an override
+    // for formmethod if the button does not have name or value attributes
+    // set, which is the default. This means that if you use <%= f.button
+    // formmethod: :delete %>, it will generate a <button name="_method"
+    // value="delete" formmethod="post">. Therefore, if the submitter's name
+    // is already _method, it's value attribute already contains the desired
+    // method.
+    if (submitter.name === '_method') {
+      return submitter.value
+    } else if (submitter.hasAttribute("formmethod")) {
       return submitter.formMethod
     } else {
       return null

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

@@ -54,6 +54,19 @@
 #       end
 #   end
 #
+# If you want to render a renderable object you can use the `renderable:` option.
+#
+#   class Message < ApplicationRecord
+#     belongs_to :user
+#
+#     after_create_commit :update_message
+#
+#     private
+#       def update_message
+#         broadcast_replace_to(user, :message, target: "message", renderable: MessageComponent.new)
+#       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
@@ -352,7 +365,7 @@ module Turbo::Broadcastable
 
         if o[:html] || o[:partial]
           return o
-        elsif o[:template]
+        elsif o[:template] || o[:renderable]
           o[:layout] = false
         else
           # if none of these options are passed in, it will set a partial from #to_partial_path

data/config/routes.rb

@@ -3,4 +3,4 @@ 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
-end
+end if Turbo.draw_routes

data/lib/install/turbo_with_bun.rb

@@ -0,0 +1,9 @@
+if (js_entrypoint_path = Rails.root.join("app/javascript/application.js")).exist?
+  say "Import Turbo"
+  append_to_file "app/javascript/application.js", %(import "@hotwired/turbo-rails"\n)
+else
+  say "You must import @hotwired/turbo-rails in your JavaScript entrypoint file", :red
+end
+
+say "Install Turbo"
+run "bun add @hotwired/turbo-rails"

data/lib/tasks/turbo_tasks.rake

@@ -1,18 +1,27 @@
-def run_turbo_install_template(path)
-  system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/#{path}.rb", __dir__)}"
-end
+module Turbo
+  module Tasks
+    extend self
+    def run_turbo_install_template(path)
+      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 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"
+    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
   end
 end
 
@@ -21,6 +30,8 @@ namespace :turbo do
   task :install do
     if Rails.root.join("config/importmap.rb").exist?
       Rake::Task["turbo:install:importmap"].invoke
+    elsif Rails.root.join("package.json").exist? && Turbo::Tasks.using_bun?
+      Rake::Task["turbo:install:bun"].invoke
     elsif Rails.root.join("package.json").exist?
       Rake::Task["turbo:install:node"].invoke
     else
@@ -31,19 +42,25 @@ namespace :turbo do
   namespace :install do
     desc "Install Turbo into the app with asset pipeline"
     task :importmap do
-      run_turbo_install_template "turbo_with_importmap"
-      switch_on_redis_if_available
+      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
-      run_turbo_install_template "turbo_with_node"
-      switch_on_redis_if_available
+      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
-      run_turbo_install_template "turbo_needs_redis"
+      Turbo::Tasks.run_turbo_install_template "turbo_needs_redis"
     end
   end
 end

data/lib/turbo/broadcastable/test_helper.rb

@@ -0,0 +1,172 @@
+module Turbo
+  module Broadcastable
+    module TestHelper
+      extend ActiveSupport::Concern
+
+      included do
+        include ActionCable::TestHelper
+
+        include Turbo::Streams::StreamName
+      end
+
+      # Asserts that `<turbo-stream>` elements were broadcast over Action Cable
+      #
+      # === 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
+      #
+      # * <tt>count:</tt> the number of `<turbo-stream>` elements that are
+      # expected to be broadcast
+      #
+      # Asserts `<turbo-stream>` elements were broadcast:
+      #
+      #     message = Message.find(1)
+      #     message.broadcast_replace_to "messages"
+      #
+      #     assert_turbo_stream_broadcasts "messages"
+      #
+      # Asserts that two `<turbo-stream>` elements were broadcast:
+      #
+      #     message = Message.find(1)
+      #     message.broadcast_replace_to "messages"
+      #     message.broadcast_remove_to "messages"
+      #
+      #     assert_turbo_stream_broadcasts "messages", count: 2
+      #
+      # You can pass a block to run before the assertion:
+      #
+      #     message = Message.find(1)
+      #
+      #     assert_turbo_stream_broadcasts "messages" do
+      #       message.broadcast_append_to "messages"
+      #     end
+      #
+      # In addition to a String, the helper also accepts an Object or Array to
+      # determine the name of the channel the elements are broadcast to:
+      #
+      #     message = Message.find(1)
+      #
+      #     assert_turbo_stream_broadcasts message do
+      #       message.broadcast_replace
+      #     end
+      #
+      def assert_turbo_stream_broadcasts(stream_name_or_object, count: nil, &block)
+        payloads = capture_turbo_stream_broadcasts(stream_name_or_object, &block)
+        stream_name = stream_name_from(stream_name_or_object)
+
+        if count.nil?
+          assert_not_empty payloads, "Expected at least one broadcast on #{stream_name.inspect}, but there were none"
+        else
+          broadcasts = "Turbo Stream broadcast".pluralize(count)
+
+          assert count == payloads.count, "Expected #{count} #{broadcasts} on #{stream_name.inspect}, but there were none"
+        end
+      end
+
+      # Asserts that no `<turbo-stream>` elements were broadcast over Action Cable
+      #
+      # === 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
+      #
+      # Asserts that no `<turbo-stream>` elements were broadcast:
+      #
+      #     message = Message.find(1)
+      #     message.broadcast_replace_to "messages"
+      #
+      #     assert_no_turbo_stream_broadcasts "messages" # fails with MiniTest::Assertion error
+      #
+      # You can pass a block to run before the assertion:
+      #
+      #     message = Message.find(1)
+      #
+      #     assert_no_turbo_stream_broadcasts "messages" do
+      #       # do something other than broadcast to "messages"
+      #     end
+      #
+      # In addition to a String, the helper also accepts an Object or Array to
+      # determine the name of the channel the elements are broadcast to:
+      #
+      #     message = Message.find(1)
+      #
+      #     assert_no_turbo_stream_broadcasts message do
+      #       # do something other than broadcast to "message_1"
+      #     end
+      #
+      def assert_no_turbo_stream_broadcasts(stream_name_or_object, &block)
+        block&.call
+
+        stream_name = stream_name_from(stream_name_or_object)
+
+        payloads = broadcasts(stream_name)
+
+        assert payloads.empty?, "Expected no broadcasts on #{stream_name.inspect}, but there were #{payloads.count}"
+      end
+
+      # Captures any `<turbo-stream>` elements that were broadcast over Action Cable
+      #
+      # === 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 to capture broadcasts during execution
+      #
+      # Returns any `<turbo-stream>` elements that have been broadcast as an
+      # Array of <tt>Nokogiri::XML::Element</tt> instances
+      #
+      #     message = Message.find(1)
+      #     message.broadcast_append_to "messages"
+      #     message.broadcast_prepend_to "messages"
+      #
+      #     turbo_streams = capture_turbo_stream_broadcasts "messages"
+      #
+      #     assert_equal "append", turbo_streams.first["action"]
+      #     assert_equal "prepend", turbo_streams.second["action"]
+      #
+      # You can pass a block to limit the scope of the broadcasts being captured:
+      #
+      #     message = Message.find(1)
+      #
+      #     turbo_streams = capture_turbo_stream_broadcasts "messages" do
+      #       message.broadcast_append_to "messages"
+      #     end
+      #
+      #     assert_equal "append", turbo_streams.first["action"]
+      #
+      # In addition to a String, the helper also accepts an Object or Array to
+      # determine the name of the channel the elements are broadcast to:
+      #
+      #     message = Message.find(1)
+      #
+      #     replace, remove = capture_turbo_stream_broadcasts message do
+      #       message.broadcast_replace
+      #       message.broadcast_remove
+      #     end
+      #
+      #     assert_equal "replace", replace["action"]
+      #     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.flat_map do |payload|
+          html = ActiveSupport::JSON.decode(payload)
+          document = Nokogiri::HTML5.parse(html)
+
+          document.at("body").element_children
+        end
+      end
+    end
+  end
+end

data/lib/turbo/engine.rb

@@ -1,5 +1,4 @@
 require "rails/engine"
-require "turbo/test_assertions"
 
 module Turbo
   class Engine < Rails::Engine
@@ -34,6 +33,12 @@ module Turbo
       end
     end
 
+    initializer "turbo.configs" do
+      config.after_initialize do |app|
+        Turbo.draw_routes = app.config.turbo.draw_routes != false
+      end
+    end
+
     initializer "turbo.helpers", before: :load_config_initializers do
       ActiveSupport.on_load(:action_controller_base) do
         include Turbo::Streams::TurboStreamsTagBuilder, Turbo::Frames::FrameRequest, Turbo::Native::Navigation
@@ -69,8 +74,17 @@ 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_dispatch_integration_test) do
+        require "turbo/test_assertions/integration_test_assertions"
+
+        include Turbo::TestAssertions::IntegrationTestAssertions
+      end
     end
 
     initializer "turbo.integration_test_request_encoding" do

data/lib/turbo/test_assertions/integration_test_assertions.rb

@@ -0,0 +1,76 @@
+module Turbo
+  module TestAssertions
+    module IntegrationTestAssertions
+      # Assert that the Turbo Stream request's response body's HTML contains a
+      # `<turbo-stream>` element.
+      #
+      # === Options
+      #
+      # * <tt>:status</tt> [Integer, Symbol] the HTTP response status
+      # * <tt>:action</tt> [String] matches the element's <tt>[action]</tt>
+      #   attribute
+      # * <tt>:target</tt> [String, #to_key] matches the element's
+      #   <tt>[target]</tt> attribute. If the value responds to <tt>#to_key</tt>,
+      #   the value will be transformed by calling <tt>dom_id</tt>
+      # * <tt>:targets</tt> [String] matches the element's <tt>[targets]</tt>
+      #   attribute
+      #
+      #   Given the following HTML response body:
+      #
+      #     <turbo-stream action="remove" target="message_1"></turbo-stream>
+      #
+      #   The following assertion would pass:
+      #
+      #     assert_turbo_stream action: "remove", target: "message_1"
+      #
+      # You can also pass a block make assertions about the contents of the
+      # element. Given the following HTML response body:
+      #
+      #     <turbo-stream action="replace" target="message_1">
+      #       <template>
+      #         <p>Hello!</p>
+      #       <template>
+      #     </turbo-stream>
+      #
+      #   The following assertion would pass:
+      #
+      #     assert_turbo_stream action: "replace", target: "message_1" do
+      #       assert_select "template p", text: "Hello!"
+      #     end
+      #
+      def assert_turbo_stream(status: :ok, **attributes, &block)
+        assert_response status
+        assert_equal Mime[:turbo_stream], response.media_type
+        super(**attributes, &block)
+      end
+
+      # Assert that the Turbo Stream request's response body's HTML does not
+      # contain a `<turbo-stream>` element.
+      #
+      # === Options
+      #
+      # * <tt>:status</tt> [Integer, Symbol] the HTTP response status
+      # * <tt>:action</tt> [String] matches the element's <tt>[action]</tt>
+      #   attribute
+      # * <tt>:target</tt> [String, #to_key] matches the element's
+      #   <tt>[target]</tt> attribute. If the value responds to <tt>#to_key</tt>,
+      #   the value will be transformed by calling <tt>dom_id</tt>
+      # * <tt>:targets</tt> [String] matches the element's <tt>[targets]</tt>
+      #   attribute
+      #
+      #   Given the following HTML response body:
+      #
+      #     <turbo-stream action="remove" target="message_1"></turbo-stream>
+      #
+      #   The following assertion would fail:
+      #
+      #     assert_no_turbo_stream action: "remove", target: "message_1"
+      #
+      def assert_no_turbo_stream(status: :ok, **attributes)
+        assert_response status
+        assert_equal Mime[:turbo_stream], response.media_type
+        super(**attributes)
+      end
+    end
+  end
+end

data/lib/turbo/test_assertions.rb

@@ -7,17 +7,73 @@ module Turbo
       delegate :dom_id, :dom_class, to: ActionView::RecordIdentifier
     end
 
-    def assert_turbo_stream(action:, target: nil, targets: nil, status: :ok, &block)
-      assert_response status
-      assert_equal Mime[:turbo_stream], response.media_type
+    # Assert that the rendered fragment of HTML contains a `<turbo-stream>`
+    # element.
+    #
+    # === Options
+    #
+    # * <tt>:action</tt> [String] matches the element's <tt>[action]</tt>
+    #   attribute
+    # * <tt>:target</tt> [String, #to_key] matches the element's
+    #   <tt>[target]</tt> attribute. If the value responds to <tt>#to_key</tt>,
+    #   the value will be transformed by calling <tt>dom_id</tt>
+    # * <tt>:targets</tt> [String] matches the element's <tt>[targets]</tt>
+    #   attribute
+    # * <tt>:count</tt> [Integer] indicates how many turbo streams are expected.
+    #   Defaults to <tt>1</tt>.
+    #
+    #   Given the following HTML fragment:
+    #
+    #     <turbo-stream action="remove" target="message_1"></turbo-stream>
+    #
+    #   The following assertion would pass:
+    #
+    #     assert_turbo_stream action: "remove", target: "message_1"
+    #
+    # You can also pass a block make assertions about the contents of the
+    # element. Given the following HTML fragment:
+    #
+    #     <turbo-stream action="replace" target="message_1">
+    #       <template>
+    #         <p>Hello!</p>
+    #       <template>
+    #     </turbo-stream>
+    #
+    #   The following assertion would pass:
+    #
+    #     assert_turbo_stream action: "replace", target: "message_1" do
+    #       assert_select "template p", text: "Hello!"
+    #     end
+    #
+    def assert_turbo_stream(action:, target: nil, targets: nil, count: 1, &block)
       selector =  %(turbo-stream[action="#{action}"])
       selector << %([target="#{target.respond_to?(:to_key) ? dom_id(target) : target}"]) if target
       selector << %([targets="#{targets}"]) if targets
-      assert_select selector, count: 1, &block
+      assert_select selector, count: count, &block
     end
 
+    # Assert that the rendered fragment of HTML does not contain a `<turbo-stream>`
+    # element.
+    #
+    # === Options
+    #
+    # * <tt>:action</tt> [String] matches the element's <tt>[action]</tt>
+    #   attribute
+    # * <tt>:target</tt> [String, #to_key] matches the element's
+    #   <tt>[target]</tt> attribute. If the value responds to <tt>#to_key</tt>,
+    #   the value will be transformed by calling <tt>dom_id</tt>
+    # * <tt>:targets</tt> [String] matches the element's <tt>[targets]</tt>
+    #   attribute
+    #
+    #   Given the following HTML fragment:
+    #
+    #     <turbo-stream action="remove" target="message_1"></turbo-stream>
+    #
+    #   The following assertion would fail:
+    #
+    #     assert_no_turbo_stream action: "remove", target: "message_1"
+    #
     def assert_no_turbo_stream(action:, target: nil, targets: nil)
-      assert_equal Mime[:turbo_stream], response.media_type
       selector =  %(turbo-stream[action="#{action}"])
       selector << %([target="#{target.respond_to?(:to_key) ? dom_id(target) : target}"]) if target
       selector << %([targets="#{targets}"]) if targets

data/lib/turbo/version.rb

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

data/lib/turbo-rails.rb

@@ -3,6 +3,8 @@ require "turbo/engine"
 module Turbo
   extend ActiveSupport::Autoload
 
+  mattr_accessor :draw_routes, default: true
+
   class << self
     attr_writer :signed_stream_verifier_key