turbo-rails 0.5.2 → 2.0.0

data/lib/turbo/engine.rb

@@ -1,5 +1,4 @@
 require "rails/engine"
-require "turbo/test_assertions"
 
 module Turbo
   class Engine < Rails::Engine
@@ -16,19 +15,43 @@ module Turbo
       #{root}/app/jobs
     )
 
+    initializer "turbo.no_action_cable", before: :set_eager_load_paths do
+      config.eager_load_paths.delete("#{root}/app/channels") unless defined?(ActionCable)
+    end
+
+    # If you don't want to precompile Turbo's assets (eg. because you're using webpack),
+    # you can do this in an intiailzer:
+    #
+    # config.after_initialize do
+    #   config.assets.precompile -= Turbo::Engine::PRECOMPILE_ASSETS
+    # end
+    PRECOMPILE_ASSETS = %w( turbo.js turbo.min.js turbo.min.js.map )
+
     initializer "turbo.assets" do
       if Rails.application.config.respond_to?(:assets)
-        Rails.application.config.assets.precompile += %w( turbo )
+        Rails.application.config.assets.precompile += PRECOMPILE_ASSETS
+      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" do
+    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
         helper Turbo::Engine.helpers
       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
@@ -36,7 +59,7 @@ module Turbo
     end
 
     initializer "turbo.mimetype" do
-      Mime::Type.register "text/html; turbo-stream", :turbo_stream
+      Mime::Type.register "text/vnd.turbo-stream.html", :turbo_stream
     end
 
     initializer "turbo.renderer" do
@@ -49,14 +72,25 @@ module Turbo
     end
 
     initializer "turbo.signed_stream_verifier_key" do
-      Turbo.signed_stream_verifier_key = config.turbo.signed_stream_verifier_key ||
-        Rails.application.key_generator.generate_key("turbo/signed_stream_verifier_key")
+      config.after_initialize do
+        Turbo.signed_stream_verifier_key = config.turbo.signed_stream_verifier_key ||
+          Rails.application.key_generator.generate_key("turbo/signed_stream_verifier_key")
+      end
     end
 
     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,16 +7,77 @@ module Turbo
       delegate :dom_id, :dom_class, to: ActionView::RecordIdentifier
     end
 
-    def assert_turbo_stream(action:, target: nil, &block)
-      assert_response :ok
-      assert_equal Mime[:turbo_stream], response.media_type
-      assert_select %(turbo-stream[action="#{action}"][target="#{target.respond_to?(:to_key) ? dom_id(target) : target}"]), count: 1, &block
+    # 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: count, &block
     end
 
-    def assert_no_turbo_stream(action:, target: nil)
-      assert_response :ok
-      assert_equal Mime[:turbo_stream], response.media_type
-      assert_select %(turbo-stream[action="#{action}"][target="#{target.respond_to?(:to_key) ? dom_id(target) : target}"]), count: 0
+    # 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)
+      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: 0
     end
   end
 end

data/lib/turbo/version.rb

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "0.5.2"
+  VERSION = "2.0.0"
 end

data/lib/turbo-rails.rb

@@ -1,8 +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
 
@@ -13,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: 0.5.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,10 +10,38 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  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
+    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: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -32,17 +60,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
 - app/assets/javascripts/turbo.js
+- app/assets/javascripts/turbo.min.js
+- app/assets/javascripts/turbo.min.js.map
 - 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
@@ -54,102 +81,29 @@ files:
 - app/helpers/turbo/streams_helper.rb
 - app/javascript/turbo/cable.js
 - app/javascript/turbo/cable_stream_source_element.js
+- app/javascript/turbo/fetch_requests.js
 - app/javascript/turbo/index.js
+- 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_with_asset_pipeline.rb
-- lib/install/turbo_with_webpacker.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
 - lib/tasks/turbo_tasks.rake
 - lib/turbo-rails.rb
+- lib/turbo/broadcastable/test_helper.rb
 - lib/turbo/engine.rb
 - lib/turbo/test_assertions.rb
+- lib/turbo/test_assertions/integration_test_assertions.rb
 - lib/turbo/version.rb
-- package.json
-- rollup.config.js
-- test/drive/drive_helper_test.rb
-- test/dummy/.babelrc
-- test/dummy/.gitignore
-- test/dummy/.postcssrc.yml
-- test/dummy/Rakefile
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/images/.keep
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/stylesheets/scaffold.css
-- test/dummy/app/channels/application_cable/channel.rb
-- test/dummy/app/channels/application_cable/connection.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/controllers/messages_controller.rb
-- test/dummy/app/controllers/trays_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/javascript/packs/application.js
-- test/dummy/app/jobs/application_job.rb
-- test/dummy/app/mailboxes/application_mailbox.rb
-- test/dummy/app/mailboxes/messages_mailbox.rb
-- test/dummy/app/mailers/application_mailer.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/concerns/.keep
-- test/dummy/app/models/message.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/layouts/mailer.html.erb
-- test/dummy/app/views/layouts/mailer.text.erb
-- test/dummy/app/views/messages/_message.html.erb
-- test/dummy/app/views/messages/_message.turbo_stream.erb
-- test/dummy/app/views/messages/show.turbo_stream.erb
-- test/dummy/app/views/trays/index.html.erb
-- test/dummy/app/views/trays/show.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/bin/update
-- test/dummy/bin/yarn
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/cable.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/content_security_policy.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/puma.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/spring.rb
-- test/dummy/config/webpack/development.js
-- test/dummy/config/webpack/environment.js
-- test/dummy/config/webpack/production.js
-- test/dummy/config/webpack/test.js
-- test/dummy/config/webpacker.yml
-- test/dummy/lib/assets/.keep
-- test/dummy/log/.keep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/apple-touch-icon-precomposed.png
-- test/dummy/public/apple-touch-icon.png
-- test/dummy/public/favicon.ico
-- test/frames/frame_request_controller_test.rb
-- test/frames/frames_helper_test.rb
-- test/native/navigation_controller_test.rb
-- test/streams/broadcastable_test.rb
-- test/streams/streams_channel_test.rb
-- test/streams/streams_controller_test.rb
-- test/turbo_test.rb
-- turbo-rails.gemspec
-- yarn.lock
 homepage: https://github.com/hotwired/turbo-rails
 licenses:
 - MIT
@@ -169,87 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: The speed of a single-page web application without having to write any JavaScript.
-test_files:
-- test/drive/drive_helper_test.rb
-- test/dummy/.babelrc
-- test/dummy/.gitignore
-- test/dummy/.postcssrc.yml
-- test/dummy/Rakefile
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/images/.keep
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/stylesheets/scaffold.css
-- test/dummy/app/channels/application_cable/channel.rb
-- test/dummy/app/channels/application_cable/connection.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/controllers/messages_controller.rb
-- test/dummy/app/controllers/trays_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/javascript/packs/application.js
-- test/dummy/app/jobs/application_job.rb
-- test/dummy/app/mailboxes/application_mailbox.rb
-- test/dummy/app/mailboxes/messages_mailbox.rb
-- test/dummy/app/mailers/application_mailer.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/concerns/.keep
-- test/dummy/app/models/message.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/layouts/mailer.html.erb
-- test/dummy/app/views/layouts/mailer.text.erb
-- test/dummy/app/views/messages/_message.html.erb
-- test/dummy/app/views/messages/_message.turbo_stream.erb
-- test/dummy/app/views/messages/show.turbo_stream.erb
-- test/dummy/app/views/trays/index.html.erb
-- test/dummy/app/views/trays/show.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/bin/update
-- test/dummy/bin/yarn
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/cable.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/content_security_policy.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/puma.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/spring.rb
-- test/dummy/config/webpack/development.js
-- test/dummy/config/webpack/environment.js
-- test/dummy/config/webpack/production.js
-- test/dummy/config/webpack/test.js
-- test/dummy/config/webpacker.yml
-- test/dummy/lib/assets/.keep
-- test/dummy/log/.keep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/apple-touch-icon-precomposed.png
-- test/dummy/public/apple-touch-icon.png
-- test/dummy/public/favicon.ico
-- test/frames/frame_request_controller_test.rb
-- test/frames/frames_helper_test.rb
-- test/native/navigation_controller_test.rb
-- test/streams/broadcastable_test.rb
-- test/streams/streams_channel_test.rb
-- test/streams/streams_controller_test.rb
-- test/turbo_test.rb
+test_files: []

data/.github/workflows/ci.yml

@@ -1,30 +0,0 @@
-name: CI
-on: [push, pull_request]
-jobs:
-  tests:
-    strategy:
-      matrix:
-        ruby-version:
-          - "2.7"
-          - "3.0"
-        continue-on-error: [ false ]
-
-        include:
-          - ruby-version: head
-            continue-on-error: true
-
-    name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
-    runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.continue-on-error }}
-
-    steps:
-      - uses: actions/checkout@v1
-
-      - name: Install Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
-
-      - name: Run tests
-        run: bundle exec rake

data/.gitignore

@@ -1,2 +0,0 @@
-*.gem
-/node_modules

data/Gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'rake'
-gem 'byebug'