turbo-rails 0.5.5 → 0.5.10

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

@@ -13,6 +13,14 @@ module Turbo::Streams::Broadcasts
     broadcast_action_to *streamables, action: :replace, target: target, **rendering
   end
 
+  def broadcast_before_to(*streamables, target:, **rendering)
+    broadcast_action_to *streamables, action: :before, target: target, **rendering
+  end
+
+  def broadcast_after_to(*streamables, target:, **rendering)
+    broadcast_action_to *streamables, action: :after, target: target, **rendering
+  end
+
   def broadcast_append_to(*streamables, target:, **rendering)
     broadcast_action_to *streamables, action: :append, target: target, **rendering
   end
@@ -32,6 +40,14 @@ module Turbo::Streams::Broadcasts
     broadcast_action_later_to *streamables, action: :replace, target: target, **rendering
   end
 
+  def broadcast_before_later_to(*streamables, target:, **rendering)
+    broadcast_action_later_to *streamables, action: :before, target: target, **rendering
+  end
+
+  def broadcast_after_later_to(*streamables, target:, **rendering)
+    broadcast_action_later_to *streamables, action: :after, target: target, **rendering
+  end
+
   def broadcast_append_later_to(*streamables, target:, **rendering)
     broadcast_action_later_to *streamables, action: :append, target: target, **rendering
   end

data/app/helpers/turbo/frames_helper.rb

@@ -16,12 +16,16 @@ module Turbo::FramesHelper
   #   <%= turbo_frame_tag "tray", target: "other_tray" %>
   #   # => <turbo-frame id="tray" target="other_tray"></turbo-frame>
   #
+  #   <%= turbo_frame_tag "tray", src: tray_path(tray), loading: "lazy" %>
+  #   # => <turbo-frame id="tray" src="http://example.com/trays/1" loading="lazy"></turbo-frame>
+  #
   #   <%= turbo_frame_tag "tray" do %>
   #     <div>My tray frame!</div>
   #   <% end %>
   #   # => <turbo-frame id="tray"><div>My tray frame!</div></turbo-frame>
   def turbo_frame_tag(id, src: nil, target: nil, **attributes, &block)
     id = id.respond_to?(:to_key) ? dom_id(id) : id
+    src = url_for(src) if src.present?
 
     tag.turbo_frame(**attributes.merge(id: id, src: src, target: target).compact, &block)
   end

data/app/helpers/turbo/streams/action_helper.rb

@@ -14,12 +14,7 @@ module Turbo::Streams::ActionHelper
   end
 
   private
-    def convert_to_turbo_stream_dom_id(element_or_dom_id)
-      if element_or_dom_id.respond_to?(:to_key)
-        element = element_or_dom_id
-        ActionView::RecordIdentifier.dom_id(element)
-      else
-        dom_id = element_or_dom_id
-      end
+    def convert_to_turbo_stream_dom_id(target)
+      target.respond_to?(:to_key) ? ActionView::RecordIdentifier.dom_id(target) : target
     end
 end

data/app/helpers/turbo/streams_helper.rb

@@ -1,5 +1,5 @@
 module Turbo::StreamsHelper
-  # Returns a new <tt>Turbo::Streams::TagBuilder</tt> object that accepts stream actions and renders them them as
+  # Returns a new <tt>Turbo::Streams::TagBuilder</tt> object that accepts stream actions and renders them as
   # the template tags needed to send across the wire. This object is automatically yielded to turbo_stream.erb templates.
   #
   # When responding to HTTP requests, controllers can declare `turbo_stream` format response templates in that same
@@ -39,7 +39,9 @@ module Turbo::StreamsHelper
   # The example above will process all turbo streams sent to a stream name like <tt>account:5:entries</tt>
   # (when Current.account.id = 5). Updates to this stream can be sent like
   # <tt>entry.broadcast_append_to entry.account, :entries, target: "entries"</tt>.
-  def turbo_stream_from(*streamables)
-    tag.turbo_cable_stream_source channel: "Turbo::StreamsChannel", "signed-stream-name": Turbo::StreamsChannel.signed_stream_name(streamables)
+  def turbo_stream_from(*streamables, **attributes)
+    attributes[:channel] = "Turbo::StreamsChannel"
+    attributes[:"signed-stream-name"] = Turbo::StreamsChannel.signed_stream_name(streamables)
+    tag.turbo_cable_stream_source(**attributes)
   end
 end

data/app/javascript/turbo/cable.js

@@ -1,15 +1,18 @@
 let consumer
 
 export async function getConsumer() {
-  if (consumer) return consumer
-  const { createConsumer } = await import("@rails/actioncable/src")
-  return setConsumer(createConsumer())
+  return consumer || setConsumer(createConsumer().then(setConsumer))
 }
 
 export function setConsumer(newConsumer) {
   return consumer = newConsumer
 }
 
+export async function createConsumer() {
+  const { createConsumer } = await import(/* webpackChunkName: "actioncable" */ "@rails/actioncable/src")
+  return createConsumer()
+}
+
 export async function subscribeTo(channel, mixin) {
   const { subscriptions } = await getConsumer()
   return subscriptions.create(channel, mixin)

data/app/jobs/turbo/streams/action_broadcast_job.rb

@@ -1,5 +1,7 @@
 # The job that powers all the <tt>broadcast_$action_later</tt> broadcasts available in <tt>Turbo::Streams::Broadcasts</tt>.
 class Turbo::Streams::ActionBroadcastJob < ActiveJob::Base
+  discard_on ActiveJob::DeserializationError
+  
   def perform(stream, action:, target:, **rendering)
     Turbo::StreamsChannel.broadcast_action_to stream, action: action, target: target, **rendering
   end

data/app/jobs/turbo/streams/broadcast_job.rb

@@ -1,6 +1,8 @@
 # The job that powers the <tt>broadcast_render_later_to</tt> available in <tt>Turbo::Streams::Broadcasts</tt> for rendering
 # turbo stream templates.
 class Turbo::Streams::BroadcastJob < ActiveJob::Base
+  discard_on ActiveJob::DeserializationError
+  
   def perform(stream, **rendering)
     Turbo::StreamsChannel.broadcast_render_to stream, **rendering
   end

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

@@ -39,7 +39,7 @@ module Turbo::Broadcastable
   module ClassMethods
     # Configures the model to broadcast creates, updates, and destroys to a stream name derived at runtime by the
     # <tt>stream</tt> symbol invocation. By default, the creates are appended to a dom id target name derived from
-    # the model's plural name. The insertion can also be made to be a prepend by overwriting <tt>insertion</tt> and
+    # the model's plural name. The insertion can also be made to be a prepend by overwriting <tt>inserts_by</tt> and
     # the target dom id overwritten by passing <tt>target</tt>. Examples:
     #
     #   class Message < ApplicationRecord
@@ -52,14 +52,14 @@ module Turbo::Broadcastable
     #     broadcasts_to ->(message) { [ message.board, :messages ] }, inserts_by: :prepend, target: "board_messages"
     #   end
     def broadcasts_to(stream, inserts_by: :append, target: broadcast_target_default)
-      after_create_commit  -> { broadcast_action_later_to stream.try(:call, self) || send(stream), action: inserts_by, target: target }
+      after_create_commit  -> { broadcast_action_later_to stream.try(:call, self) || send(stream), action: inserts_by, target: target.try(:call, self) || target }
       after_update_commit  -> { broadcast_replace_later_to stream.try(:call, self) || send(stream) }
       after_destroy_commit -> { broadcast_remove_to stream.try(:call, self) || send(stream) }
     end
 
     # Same as <tt>#broadcasts_to</tt>, but the designated stream is automatically set to the current model.
     def broadcasts(inserts_by: :append, target: broadcast_target_default)
-      after_create_commit  -> { broadcast_action_later action: inserts_by, target: target }
+      after_create_commit  -> { broadcast_action_later action: inserts_by, target: target.try(:call, self) || target }
       after_update_commit  -> { broadcast_replace_later }
       after_destroy_commit -> { broadcast_remove }
     end
@@ -103,6 +103,38 @@ module Turbo::Broadcastable
     broadcast_replace_to self, **rendering
   end
 
+  # Insert a rendering of this broadcastable model before the target identified by it's dom id passed as <tt>target</tt>
+  # for subscribers of the stream name identified by the passed <tt>streamables</tt>. The rendering parameters can be set by
+  # appending named arguments to the call. Examples:
+  #
+  #   # Sends <turbo-stream action="before" target="clearance_5"><template><div id="clearance_4">My Clearance</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.broadcast_before_to examiner.identity, :clearances, target: "clearance_5"
+  #
+  #   # Sends <turbo-stream action="before" target="clearance_5"><template><div id="clearance_4">Other partial</div></template></turbo-stream>
+  #   # 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)
+  end
+
+  # Insert a rendering of this broadcastable model after the target identified by it's dom id passed as <tt>target</tt>
+  # for subscribers of the stream name identified by the passed <tt>streamables</tt>. The rendering parameters can be set by
+  # appending named arguments to the call. Examples:
+  #
+  #   # Sends <turbo-stream action="after" target="clearance_5"><template><div id="clearance_6">My Clearance</div></template></turbo-stream>
+  #   # to the stream named "identity:2:clearances"
+  #   clearance.broadcast_after_to examiner.identity, :clearances, target: "clearance_5"
+  #
+  #   # Sends <turbo-stream action="after" target="clearance_5"><template><div id="clearance_6">Other partial</div></template></turbo-stream>
+  #   # 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)
+  end
+
   # Append a rendering of this broadcastable model to the target identified by it's dom id passed as <tt>target</tt>
   # for subscribers of the stream name identified by the passed <tt>streamables</tt>. The rendering parameters can be set by
   # appending named arguments to the call. Examples:
@@ -140,7 +172,7 @@ module Turbo::Broadcastable
     Turbo::StreamsChannel.broadcast_prepend_to *streamables, target: target, **broadcast_rendering_with_defaults(rendering)
   end
 
-  # Same as <tt>#broadcast_append_to</tt>, but the designated stream is automatically set to the current model.
+  # Same as <tt>#broadcast_prepend_to</tt>, but the designated stream is automatically set to the current model.
   def broadcast_prepend(target: broadcast_target_default, **rendering)
     broadcast_prepend_to self, target: target, **rendering
   end
@@ -190,7 +222,7 @@ module Turbo::Broadcastable
     broadcast_prepend_later_to self, target: target, **rendering
   end
 
-  # Same as <tt>broadcast_action_later_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
+  # 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, **rendering)
     Turbo::StreamsChannel.broadcast_action_later_to(*streamables, action: action, target: target, **broadcast_rendering_with_defaults(rendering))
   end
@@ -219,7 +251,7 @@ module Turbo::Broadcastable
     broadcast_render_later_to self, **rendering
   end
 
-  # Same as <tt>broadcast_prepend_to</tt> but run with the added option of naming the stream using the passed
+  # 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)
@@ -233,7 +265,7 @@ module Turbo::Broadcastable
 
     def broadcast_rendering_with_defaults(options)
       options.tap do |o|
-        o[:locals]    = (o[:locals] || {}).reverse_merge!(model_name.singular.to_sym => self)
+        o[:object] ||= self
         o[:partial] ||= to_partial_path
       end
     end

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

@@ -14,7 +14,7 @@
 #   <%= turbo_stream.append "entries" do %>
 #     <% # format is automatically switched, such that _entry.html.erb partial is rendered, not _entry.turbo_stream.erb %>
 #     <%= render partial: "entries/entry", locals: { entry: entry } %>
-#   <%= end %>
+#   <% end %>
 #
 # Or you can render the HTML that should be part of the update inline:
 #
@@ -27,6 +27,7 @@ class Turbo::Streams::TagBuilder
 
   def initialize(view_context)
     @view_context = view_context
+    @view_context.formats |= [:html]
   end
 
   # Removes the <tt>target</tt> from the dom. The target can either be a dom id string or an object that responds to
@@ -52,6 +53,32 @@ class Turbo::Streams::TagBuilder
     action :replace, target, content, **rendering, &block
   end
 
+  # Insert the <tt>content</tt> passed in, 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 before the <tt>target</tt> in the dom. Examples:
+  #
+  #   <%= turbo_stream.before "clearance_5", "<div id='clearance_4'>Insert before the dom target identified by clearance_5</div>" %>
+  #   <%= turbo_stream.before clearance %>
+  #   <%= turbo_stream.before clearance, partial: "clearances/clearance", locals: { title: "Hello" } %>
+  #   <%= turbo_stream.before "clearance_5" do %>
+  #     <div id='clearance_4'>Insert before the dom target identified by clearance_5</div>
+  #   <% end %>
+  def before(target, content = nil, **rendering, &block)
+    action :before, target, content, **rendering, &block
+  end
+
+  # Insert the <tt>content</tt> passed in, 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 after the <tt>target</tt> in the dom. Examples:
+  #
+  #   <%= turbo_stream.after "clearance_5", "<div id='clearance_6'>Insert after the dom target identified by clearance_5</div>" %>
+  #   <%= turbo_stream.after clearance %>
+  #   <%= turbo_stream.after clearance, partial: "clearances/clearance", locals: { title: "Hello" } %>
+  #   <%= turbo_stream.after "clearance_5" do %>
+  #     <div id='clearance_6'>Insert after the dom target identified by clearance_5</div>
+  #   <% end %>
+  def after(target, content = nil, **rendering, &block)
+    action :after, target, content, **rendering, &block
+  end
+
   # Update the <tt>target</tt> in the dom with the 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:
   #
@@ -121,7 +148,7 @@ class Turbo::Streams::TagBuilder
     def render_record(possible_record)
       if possible_record.respond_to?(:to_partial_path)
         record = possible_record
-        @view_context.render(partial: record.to_partial_path, locals: { record.model_name.singular.to_sym => record }, formats: [ :html ])
+        @view_context.render(partial: record, formats: :html)
       end
     end
 end

data/lib/install/turbo_with_asset_pipeline.rb

@@ -1,4 +1,5 @@
 APPLICATION_LAYOUT_PATH = Rails.root.join("app/views/layouts/application.html.erb")
+IMPORTMAP_PATH = Rails.root.join("app/assets/javascripts/importmap.json.erb")
 
 if APPLICATION_LAYOUT_PATH.exist?
   say "Yield head in application layout for cache helper"
@@ -7,18 +8,18 @@ if APPLICATION_LAYOUT_PATH.exist?
   if APPLICATION_LAYOUT_PATH.read =~ /stimulus/
     say "Add Turbo include tags in application layout"
     insert_into_file APPLICATION_LAYOUT_PATH.to_s, %(\n    <%= javascript_include_tag "turbo", type: "module-shim" %>), after: /<%= stimulus_include_tags %>/
+
+    if IMPORTMAP_PATH.exist?
+      say "Add Turbo to importmap"
+      insert_into_file IMPORTMAP_PATH, %(    "turbo": "<%= asset_path "turbo" %>",\n), after: /  "imports": {\s*\n/
+    end
   else
     say "Add Turbo include tags in application layout"
     insert_into_file APPLICATION_LAYOUT_PATH.to_s, %(\n    <%= javascript_include_tag "turbo", type: "module" %>), before: /\s*<\/head>/
   end
 else
   say "Default application.html.erb is missing!", :red
-
-  if APPLICATION_LAYOUT_PATH.read =~ /stimulus/
-    say %(        Add <%= javascript_include_tag("turbo", type: "module-shim") %> and <%= yield :head %> within the <head> tag after Stimulus includes in your custom layout.)
-  else
-    say %(        Add <%= javascript_include_tag("turbo", type: "module") %> and <%= yield :head %> within the <head> tag in your custom layout.)
-  end
+  say %(        Add <%= javascript_include_tag("turbo", type: "module-shim") %> and <%= yield :head %> within the <head> tag after Stimulus includes in your custom layout.)
 end
 
 say "Enable redis in bundle"

data/lib/install/turbo_with_webpacker.rb

@@ -1,16 +1,17 @@
 # Some Rails versions use commonJS(require) others use ESM(import).
 TURBOLINKS_REGEX = /(import .* from "turbolinks".*\n|require\("turbolinks"\).*\n)/.freeze
+ACTIVE_STORAGE_REGEX = /(import.*ActiveStorage|require.*@rails\/activestorage.*)/.freeze
 
 abort "❌ Webpacker not found. Exiting." unless defined?(Webpacker::Engine)
 
 say "Install Turbo"
 run "yarn add @hotwired/turbo-rails"
-insert_into_file "#{Webpacker.config.source_entry_path}/application.js", "import \"@hotwired/turbo-rails\"\n", before: /import.*ActiveStorage/
+insert_into_file "#{Webpacker.config.source_entry_path}/application.js", "import \"@hotwired/turbo-rails\"\n", before: ACTIVE_STORAGE_REGEX
 
 say "Remove Turbolinks"
-gsub_file 'Gemfile', /gem 'turbolinks'.*/, ''
-run "bin/bundle", capture: true
-run "bin/yarn remove turbolinks"
+run "#{RbConfig.ruby} bin/bundle remove turbolinks"
+run "#{RbConfig.ruby} bin/bundle", capture: true
+run "#{RbConfig.ruby} bin/yarn remove turbolinks"
 gsub_file "#{Webpacker.config.source_entry_path}/application.js", TURBOLINKS_REGEX, ''
 gsub_file "#{Webpacker.config.source_entry_path}/application.js", /Turbolinks.start.*\n/, ''
 

data/lib/tasks/turbo_tasks.rake

@@ -1,4 +1,4 @@
-def run_install_template(path) system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/#{path}.rb",  __dir__)}" end
+def run_turbo_install_template(path) system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/#{path}.rb",  __dir__)}" end
 
 namespace :turbo do
   desc "Install Turbo into the app"
@@ -13,12 +13,12 @@ namespace :turbo do
   namespace :install do
     desc "Install Turbo into the app with asset pipeline"
     task :asset_pipeline do
-      run_install_template "turbo_with_asset_pipeline"
+      run_turbo_install_template "turbo_with_asset_pipeline"
     end
 
     desc "Install Turbo into the app with webpacker"
     task :webpacker do
-      run_install_template "turbo_with_webpacker"
+      run_turbo_install_template "turbo_with_webpacker"
     end
   end
 end

data/lib/turbo/engine.rb

@@ -16,13 +16,17 @@ module Turbo
       #{root}/app/jobs
     )
 
+    initializer "turbo.no_action_cable" do
+      Rails.autoloaders.once.do_not_eager_load(Dir["#{root}/app/channels/turbo/*_channel.rb"]) unless defined?(ActionCable)
+    end
+
     initializer "turbo.assets" do
       if Rails.application.config.respond_to?(:assets)
         Rails.application.config.assets.precompile += %w( turbo )
       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

data/lib/turbo/test_assertions.rb

@@ -7,14 +7,13 @@ module Turbo
       delegate :dom_id, :dom_class, to: ActionView::RecordIdentifier
     end
 
-    def assert_turbo_stream(action:, target: nil, &block)
-      assert_response :ok
+    def assert_turbo_stream(action:, target: nil, status: :ok, &block)
+      assert_response status
       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
     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
     end

data/lib/turbo/version.rb

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "0.5.5"
+  VERSION = "0.5.10"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.10
 platform: ruby
 authors:
 - Sam Stephenson
 - Javan Mahkmali
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -26,7 +26,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-description: 
+description:
 email: david@loudthinking.com
 executables: []
 extensions: []
@@ -67,7 +67,7 @@ homepage: https://github.com/hotwired/turbo-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: The speed of a single-page web application without having to write any JavaScript.
 test_files: []