turbo-rails 0.5.4 → 0.5.9

data/app/helpers/turbo/includes_helper.rb

@@ -1,4 +1,6 @@
 module Turbo::IncludesHelper
+  # DEPRECATED: Just use <tt>javascript_include_tag "turbo", type: "module"</tt> directly if using Turbo alone, or
+  # javascript_include_tag "turbo", type: "module-shim" if together with Stimulus and importmaps.
   def turbo_include_tags
     javascript_include_tag("turbo", type: "module")
   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/models/concerns/turbo/broadcastable.rb

@@ -51,18 +51,23 @@ 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: model_name.plural)
+    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_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: model_name.plural)
+    def broadcasts(inserts_by: :append, target: broadcast_target_default)
       after_create_commit  -> { broadcast_action_later action: inserts_by, target: target }
       after_update_commit  -> { broadcast_replace_later }
       after_destroy_commit -> { broadcast_remove }
     end
+
+    # All default targets will use the return of this method. Overwrite if you want something else than <tt>model_name.plural</tt>.
+    def broadcast_target_default
+      model_name.plural
+    end
   end
 
   # Remove this broadcastable model from the dom for subscribers of the stream name identified by the passed streamables.
@@ -223,7 +228,7 @@ module Turbo::Broadcastable
 
   private
     def broadcast_target_default
-      model_name.plural
+      self.class.broadcast_target_default
     end
 
     def broadcast_rendering_with_defaults(options)

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
@@ -121,7 +122,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,14 +1,30 @@
 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"
   insert_into_file APPLICATION_LAYOUT_PATH.to_s, "\n    <%= yield :head %>", before: /\s*<\/head>/
 
-  say "Add Turbo include tags in application layout"
-  insert_into_file APPLICATION_LAYOUT_PATH.to_s, "\n    <%= turbo_include_tags %>", before: /\s*<\/head>/
+  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
-  say "        Add <%= turbo_include_tags %> and <%= yield :head %> within the <head> tag in your custom layout."
+
+  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
 end
 
 say "Enable redis in bundle"

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/version.rb

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "0.5.4"
+  VERSION = "0.5.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.9
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails