render_turbo_stream 4.3.2 → 4.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f3b950cec2aadef6d1acea45b6d15e0bb10a2b6c47adaf49bad4e4ed909ffba
-  data.tar.gz: a1ec0bf02392b4cebf5416aed80723f9a2d2c34f2996262bc451733dc56c9442
+  metadata.gz: de051d73d56102cedd1c2a29e0794041dbe3cd18577300002005ac050eb085e4
+  data.tar.gz: 0224b8f893ecb5408f917b4fe201650b54a815bab020fc3a549cc869da9615a6
 SHA512:
-  metadata.gz: f9ca2767f8ac34efd99bdb31f3abb5bc5654c0d130482d3a999f815b435a08cb3eecce4eec88272919feefc0e4e5584fa7a61970b3e9535ba2550945c10bac9a
-  data.tar.gz: 97b79f7d79095632faa08dc7838e959188e3342ce9eb62168e0a2e2cacac1de67eb6279dd2fecb31b289aa4d6a84799f3a129c3ee6a7692db4c6a16f4e8ee9c5
+  metadata.gz: f756884588c93fcf1052cfcb358fb69e7d996b746aa79d8cf3b134a91037e6acc3ea34253184491b3383a79bf87c2e8b046a4b67b70db950bb1182e41f8c49ca
+  data.tar.gz: 23bcf3db97515ace21d9f84fde860941326db0001c9388e44cb152a08f6288c64e72e949d884fd9be9f06ba3fc8cfe4a2ce9231f877ecc0c8536642e228c65b5

data/README.md

@@ -31,6 +31,8 @@ gem 'render_turbo_stream'
 bundle install
 ```
 
+**Include the helpers**
+
 ApplicationController
 
 ```ruby
@@ -40,10 +42,10 @@ include RenderTurboStream::ControllerHelpers
 Create a Initializer
 
 ```ruby
-ActionView::Base.send :include, RenderTurboStream::ChannelViewHelpers
+ActionView::Base.send :include, RenderTurboStream::ViewHelpers
 ```
 
-spec/rails_helper.rb
+spec/rails_helper.rb (We are using rspec instead of minitest)
 
 ```ruby
 RSpec.configure do |config|
@@ -61,6 +63,8 @@ Required Configurations for Flash Partial
     config.x.render_turbo_stream.flash_partial = 'layouts/flash'
     config.x.render_turbo_stream.flash_target_id = 'flash-box'
     config.x.render_turbo_stream.flash_turbo_action = 'prepend'
+
+    # In case of redirection a flash cannot be sent by TurboStream
     config.x.render_turbo_stream.allow_channel_to_me_for_turbo_stream_save = true
 ```
 
@@ -181,21 +185,27 @@ If an `if_success_redirect_to` argument is provided and the save action was succ
 
 **Target-ID**
 
-The target ID for turbo has to be safely unique, and it has to be nice, because at least during testing the developer has to deal with it. Since the default ID builder `dom_id` is too simple for this, there are some helpers. How it works is best shown by the `request-test helper target_id`:
+The target ID for turbo has to be unique for sure, and it has to be nice, because, at least during testing the developer has to deal with it. Since the default ID builder dom_id is too simple for this, there are some helpers. How it works is best shown by the `request-test helper target_id`:
 
 ```ruby
 # target_id(virtual_view_path, object)
 target_id('customers/_form', Customer.new) #=> 'new-customer-form'
-target_id('customers/_form', Customer.first) #=> 'customer-1-form'
-target_id('customers/_form', nil) #=> 'customers-form'
 ```
-View-helpers, assuming we are inside `customers/_form`:
+
+View-helper: Assuming we are inside `customers/_my_form`:
 
 ```ruby
-target_id #=> this checks automatically for @customer => if present => 'customer-1-form'
-target_id(Customer.new) #=> 'new-customer-form'
+#=> Assuming controller-name "customers" and variable @customer is present
+target_id 
+#=> 'customer-1-my-form'
+
+target_id(Customer.first) #=> 'customer-1-my-form'
+target_id( [Customer.first, Article.last, 'hello'] ) #=> 'customer-1-article-7-hello-my-form'
+target_id('hi-joe') #=> 'hi-joe'
 ```
 
+Why include the filename in a html-id? Because for turbo its likely to have multiple cases for the same object on the same page, for example: _form, _show, _password. These can all be the same customer.
+
 **Target-ID: Avoid the same definition in multiple places**
 
 Without this gem a turbo action would be wrapped within two frames, for example:
@@ -203,7 +213,6 @@ Without this gem a turbo action would be wrapped within two frames, for example:
 ```haml
 = turbo_stream.replace 'target-id' do 
   = render 'a partial'
- 
 ```
 
 and within a partial:

data/app/views/render_turbo_stream.turbo_stream.erb

@@ -7,7 +7,6 @@
   <% if args.is_a?(Array) %>
 
     <% ctl = "turbo_stream.#{args.first}, #{args[1..-1].join(', ')}" %>
-    <% Rails.logger.debug("  • render-turbo-stream => #{ctl}") %>
     <%= turbo_stream.send args.first, *(args[1..-1]) %>
 
 
@@ -26,7 +25,9 @@
 
     <% unless args[:target].present? %>
       <% args[:target] = RenderTurboStream::Libs.fetch_arguments_from_rendered_string(rendered_html)[:target] %>
-      <% unless args[:target].present? %>
+      <% if args[:target].present? %>
+        <% Rails.logger.debug("  • Target #{args[:target]} found in #{args[:partial]}") %>
+      <% else %>
         <% raise 'No target specified by arguments and no target found inside the rendered partial' %>
       <% end %>
     <% end %>
@@ -38,7 +39,6 @@
 
 
     <% if args[:action].present? %>
-      <% Rails.logger.debug("  • render-turbo-stream #{args[:action].upcase} => #{info}") %>
       <%= turbo_stream.send args[:action].to_sym, target_id do %>
 
         <%= rendered_html %>

data/lib/render_turbo_stream/channel_libs.rb

@@ -37,6 +37,7 @@ module RenderTurboStream
           r = RenderTurboStream::Libs.fetch_arguments_from_rendered_string(rendered_html)
           target_id = r[:target_id]
           target = r[:target]
+          Rails.logger.debug("  • Target #{r[:target]} found in #{partial.to_s + template.to_s}")
         end
       end
 

data/lib/render_turbo_stream/controller_helpers.rb

@@ -79,6 +79,7 @@ module RenderTurboStream
         response.status = 302
         flash[:alert] = flashes[:alerts]
         flash[:notice] = flashes[:notices]
+        Rails.logger.debug("  • Successful saved && Redirect by «turbo_redirect_to»")
         Rails.logger.debug("  • Set flash[:alert] => #{flashes[:alerts]}") if flashes[:alerts].present?
         Rails.logger.debug("  • Set flash[:notice] => #{flashes[:notices]}") if flashes[:notices].present?
         render_turbo_stream([
@@ -91,18 +92,21 @@ module RenderTurboStream
       elsif save_action && if_success_redirect_to.present?
         response.status = 303
         if allow_channel
-          Rails.logger.debug("  • Sent #{streams.length} actions through Turbo::StreamsChannel because allowed in configs.")
+          Rails.logger.debug("  • Send actions through Turbo::StreamsChannel")
           c_libs = RenderTurboStream::ChannelLibs.new(response)
           c_libs.send_actions_to_channel("authenticated-user-#{helpers.current_user.id}", streams, @render_turbo_stream_evaluate_instance_variables)
         else
           flash[:alert] = flashes[:alerts]
           flash[:notice] = flashes[:notices]
+          Rails.logger.debug("  • Turbo::StreamsChannel NOT ALLOWED BY CONFIGS!")
           Rails.logger.debug("  • Set flash[:alert] => #{flashes[:alerts]}") if flashes[:alerts].present?
           Rails.logger.debug("  • Set flash[:notice] => #{flashes[:notices]}") if flashes[:notices].present?
+          Rails.logger.debug("  • Could not send #{streams.length} actions => #{streams}")
         end
         redirect_to if_success_redirect_to
 
       else
+        Rails.logger.debug("  • Respond by TurboStream in #{streams.length} #{'action'.pluralize(streams.length)}")
         streams += libs.generate_action(controller_path, target_id, action, partial, (partial ? nil : action_name), locals)
         render_turbo_stream(streams)
 
@@ -114,6 +118,7 @@ module RenderTurboStream
 
       ary = []
       array.each do |pr|
+        cmd = nil
         if !pr.present?
           Rails.logger.warn "  WARNING render_turbo_stream: Empty element inside attributes: «#{array}»"
         elsif pr.is_a?(Hash)
@@ -133,13 +138,15 @@ module RenderTurboStream
           end
           r[:type] = 'stream-partial'
 
-          ary.push(r)
+          cmd = r
         elsif pr.is_a?(Array)
           raise "array has to contain at least one element: #{pr}" unless pr.first.present?
-          ary.push(pr)
+          cmd = pr
         else
           raise "ERROR render_turbo_stream invalid type: Only hash or array allowed"
         end
+        ary.push(cmd) if cmd
+        Rails.logger.debug("  • Stream => #{cmd}")
       end
 
       if request.format.to_sym == :turbo_stream

data/lib/render_turbo_stream/libs.rb

@@ -53,26 +53,34 @@ module RenderTurboStream
     end
 
     def self.target_id(virt_view_path, id)
+
       if id.is_a?(String)
         id
-      elsif !id
-        [
-          virt_view_path.gsub('/', '-').gsub('-_', '-')
-        ].join('-')
-      else
-        unless id.methods.include?(:id)
-          raise("target_id / argument ID: Only String or object with method :id accepted")
-        end
+      elsif id
         (
-          (
-            id.id ?
-              [id.class.to_s.downcase, id.id] :
-              ['new', id.class.to_s.downcase]
-          ) +
+          (id.is_a?(Array) ? id : [id]).map do |_id|
+
+            if _id.is_a?(String)
+              _id
+            elsif _id.methods.include?(:id)
+              (
+                _id.id ?
+                  [_id.class.to_s.downcase, _id.id] :
+                  ['new', _id.class.to_s.downcase]
+              ).join('-')
+            else
+              raise("target_id / argument ID: Only String or object with method :id accepted")
+            end
+          end +
             [
               virt_view_path.split('/').last.sub(/^_/, '')
             ]
         ).join('-')
+
+      else
+        [
+          virt_view_path.gsub('/', '-').gsub('-_', '-')
+        ].join('-')
       end
     end
 

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "4.3.2"
+  VERSION = "4.3.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 4.3.2
+  version: 4.3.4
 platform: ruby
 authors:
 - christian