turbo-rails 0.9.1 → 1.1.0

data/app/channels/turbo/streams_channel.rb

@@ -9,7 +9,7 @@
 # helper modules like <tt>Turbo::Streams::StreamName</tt>:
 #
 #   class CustomChannel < ActionCable::Channel::Base
-#      extend Turbo::Stream::Broadcasts, Turbo::Streams::StreamName
+#      extend Turbo::Streams::Broadcasts, Turbo::Streams::StreamName
 #      include Turbo::Streams::StreamName::ClassMethods
 #
 #      def subscribed

data/app/helpers/turbo/frames_helper.rb

@@ -23,8 +23,20 @@ module Turbo::FramesHelper
   #     <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
+  #
+  # The `turbo_frame_tag` helper will convert the arguments it receives to their
+  # `dom_id` if applicable to easily generate unique ids for Turbo Frames:
+  #
+  #   <%= turbo_frame_tag(Article.find(1)) %>
+  #   # => <turbo-frame id="article_1"></turbo-frame>
+  #
+  #   <%= turbo_frame_tag(Article.find(1), "comments") %>
+  #   # => <turbo-frame id="article_1_comments"></turbo-frame>
+  #
+  #   <%= 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("_")
     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_helper.rb

@@ -44,6 +44,11 @@ module Turbo::StreamsHelper
   # or a class name):
   #
   #   <%= turbo_stream_from "room", channel: RoomChannel %>
+  #
+  # 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"} %>
+  #
   def turbo_stream_from(*streamables, **attributes)
     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

@@ -1,5 +1,6 @@
 import { connectStreamSource, disconnectStreamSource } from "@hotwired/turbo"
 import { subscribeTo } from "./cable"
+import snakeize from "./snakeize"
 
 class TurboCableStreamSourceElement extends HTMLElement {
   async connectedCallback() {
@@ -20,7 +21,7 @@ class TurboCableStreamSourceElement extends HTMLElement {
   get channel() {
     const channel = this.getAttribute("channel")
     const signed_stream_name = this.getAttribute("signed-stream-name")
-    return { channel, signed_stream_name }
+    return { channel, signed_stream_name, ...snakeize({ ...this.dataset }) }
   }
 }
 

data/app/javascript/turbo/form_submissions.js

@@ -0,0 +1,7 @@
+export function overrideMethodWithFormmethod({ detail: { formSubmission: { fetchRequest, submitter } } }) {
+  const formMethod = submitter?.formMethod
+
+  if (formMethod && fetchRequest.body.has("_method")) {
+    fetchRequest.body.set("_method", formMethod)
+  }
+}

data/app/javascript/turbo/index.js

@@ -1,7 +1,10 @@
 import "./cable_stream_source_element"
+import { overrideMethodWithFormmethod } from "./form_submissions"
 
 import * as Turbo from "@hotwired/turbo"
 export { Turbo }
 
 import * as cable from "./cable"
 export { cable }
+
+addEventListener("turbo:submit-start", overrideMethodWithFormmethod)

data/app/javascript/turbo/snakeize.js

@@ -0,0 +1,31 @@
+// Based on https://github.com/nathan7/snakeize
+//
+// This software is released under the MIT license:
+// Permission is hereby granted, free of charge, to any person obtaining a copy of
+// this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to
+// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+// the Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+export default function walk (obj) {
+    if (!obj || typeof obj !== 'object') return obj;
+    if (obj instanceof Date || obj instanceof RegExp) return obj;
+    if (Array.isArray(obj)) return obj.map(walk);
+    return Object.keys(obj).reduce(function (acc, key) {
+        var camel = key[0].toLowerCase() + key.slice(1).replace(/([A-Z]+)/g, function (m, x) {
+            return '_' + x.toLowerCase();
+        });
+        acc[camel] = walk(obj[key]);
+        return acc;
+    }, {});
+};

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

@@ -45,8 +45,9 @@
 # within a real-time path, like a controller or model, since all those updates require a rendering step, which can slow down
 # execution. You don't need to do this for remove, since only the dom id for the model is used.
 #
-# In addition to the four basic actions, you can also use <tt>broadcast_render_later</tt> or
-# <tt>broadcast_render_later_to</tt> to render a turbo stream template with multiple actions.
+# In addition to the four basic actions, you can also use <tt>broadcast_render</tt>,
+# <tt>broadcast_render_to</tt> <tt>broadcast_render_later</tt>, and <tt>broadcast_render_later_to</tt>
+# to render a turbo stream template with multiple actions.
 module Turbo::Broadcastable
   extend ActiveSupport::Concern
 
@@ -65,16 +66,22 @@ module Turbo::Broadcastable
     #     belongs_to :board
     #     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.try(:call, self) || target }
-      after_update_commit  -> { broadcast_replace_later_to stream.try(:call, self) || send(stream) }
+    #
+    #   class Message < ApplicationRecord
+    #     belongs_to :board
+    #     broadcasts_to ->(message) { [ message.board, :messages ] }, partial: "messages/custom_message"
+    #   end
+    def broadcasts_to(stream, inserts_by: :append, target: broadcast_target_default, **rendering)
+      after_create_commit  -> { broadcast_action_later_to stream.try(:call, self) || send(stream), action: inserts_by, target: target.try(:call, self) || target, **rendering }
+      after_update_commit  -> { broadcast_replace_later_to stream.try(:call, self) || send(stream), **rendering }
       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.try(:call, self) || target }
-      after_update_commit  -> { broadcast_replace_later }
+    # Same as <tt>#broadcasts_to</tt>, but the designated stream for updates and destroys is automatically set to
+    # the current model, for creates - to the model plural name, which can be overriden by passing <tt>stream</tt>.
+    def broadcasts(stream = model_name.plural, inserts_by: :append, target: broadcast_target_default, **rendering)
+      after_create_commit  -> { broadcast_action_later_to stream, action: inserts_by, target: target.try(:call, self) || target, **rendering }
+      after_update_commit  -> { broadcast_replace_later **rendering }
       after_destroy_commit -> { broadcast_remove }
     end
 
@@ -275,9 +282,7 @@ module Turbo::Broadcastable
     broadcast_action_later_to self, action: action, target: target, **rendering
   end
 
-
-  # Render a turbo stream template asynchronously with this broadcastable model passed as the local variable using a
-  # <tt>Turbo::Streams::BroadcastJob</tt>. Example:
+  # Render a turbo stream template with this broadcastable model passed as the local variable. Example:
   #
   #   # Template: entries/_entry.turbo_stream.erb
   #   <%= turbo_stream.remove entry %>
@@ -289,7 +294,26 @@ module Turbo::Broadcastable
   #   <turbo-stream action="remove" target="entry_5"></turbo-stream>
   #   <turbo-stream action="append" target="entries"><template><div id="entry_5">My Entry</div></template></turbo-stream>
   #
-  # ...to the stream named "entry:5"
+  # ...to the stream named "entry:5".
+  #
+  # Note that rendering inline via this method will cause template rendering to happen synchronously. That is usually not
+  # 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`, unless you specifically know why synchronous rendering is needed.
+  def broadcast_render(**rendering)
+    broadcast_render_to self, **rendering
+  end
+
+  # Same as <tt>broadcast_render</tt> but run with the added option of naming the stream using the passed
+  # <tt>streamables</tt>.
+  #
+  # Note that rendering inline via this method will cause template rendering to happen synchronously. That is usually not
+  # 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))
+  end
+
+  # Same as <tt>broadcast_action_to</tt> but run asynchronously via a <tt>Turbo::Streams::BroadcastJob</tt>.
   def broadcast_render_later(**rendering)
     broadcast_render_later_to self, **rendering
   end

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

@@ -50,7 +50,7 @@ class Turbo::Streams::TagBuilder
     action_all :remove, targets, allow_inferred_rendering: false
   end
 
-  # Replace the <tt>target</tt> in the dom with the either the <tt>content</tt> passed in, a rendering result determined
+  # Replace the <tt>target</tt> in the dom with either 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. Examples:
   #
   #   <%= turbo_stream.replace "clearance_5", "<div id='clearance_5'>Replace the dom target identified by clearance_5</div>" %>
@@ -63,7 +63,7 @@ class Turbo::Streams::TagBuilder
     action :replace, target, content, **rendering, &block
   end
 
-  # Replace the <tt>targets</tt> in the dom with the either the <tt>content</tt> passed in, a rendering result determined
+  # Replace the <tt>targets</tt> in the dom with either 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. Examples:
   #
   #   <%= turbo_stream.replace_all ".clearance_item", "<div class='clearance_item'>Replace the dom target identified by the class clearance_item</div>" %>
@@ -128,7 +128,7 @@ class Turbo::Streams::TagBuilder
     action_all :after, targets, 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
+  # Update 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:
   #
   #   <%= turbo_stream.update "clearance_5", "Update the content of the dom target identified by clearance_5" %>
@@ -141,7 +141,7 @@ class Turbo::Streams::TagBuilder
     action :update, target, content, **rendering, &block
   end
 
-  # Update the <tt>targets</tt> in the dom with the either the <tt>content</tt> passed in or a rendering result determined
+  # Update 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.update_all "clearance_item", "Update the content of the dom target identified by the class clearance_item" %>

data/lib/tasks/turbo_tasks.rake

@@ -3,7 +3,9 @@ def run_turbo_install_template(path)
 end
 
 def redis_installed?
-  system('which redis-server > /dev/null')
+  Gem.win_platform? ?
+    system('where redis-server > NUL 2>&1') : 
+    system('which redis-server > /dev/null')
 end
 
 def switch_on_redis_if_available

data/lib/turbo/engine.rb

@@ -16,8 +16,8 @@ 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)
+    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),

data/lib/turbo/test_assertions.rb

@@ -7,15 +7,21 @@ module Turbo
       delegate :dom_id, :dom_class, to: ActionView::RecordIdentifier
     end
 
-    def assert_turbo_stream(action:, target: nil, status: :ok, &block)
+    def assert_turbo_stream(action:, target: nil, targets: 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
+      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
     end
 
-    def assert_no_turbo_stream(action:, target: nil)
+    def assert_no_turbo_stream(action:, target: nil, targets: nil)
       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
+      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.9.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,8 +10,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-14 00:00:00.000000000 Z
+date: 2022-05-22 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
@@ -66,7 +80,9 @@ files:
 - app/helpers/turbo/streams_helper.rb
 - app/javascript/turbo/cable.js
 - app/javascript/turbo/cable_stream_source_element.js
+- app/javascript/turbo/form_submissions.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/models/concerns/turbo/broadcastable.rb
@@ -99,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: The speed of a single-page web application without having to write any JavaScript.