render_turbo_stream 4.3.1 → 4.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 414f885f38878ae67239db4d797a57f1a0826daf8fdea5f94d6ce7a1b2a0a54a
-  data.tar.gz: eb8b5012eec604e899f088337697491c41522337bf4cec7fc66067462089cc2a
+  metadata.gz: d66f0d9cb7dc4822dbcaf38e286b855386e8637b07a922db1714b14ab63d0c6d
+  data.tar.gz: 017a6047f0c07a1f2847f7be92d810483c00690e1c31f0cb31581004d48f8f18
 SHA512:
-  metadata.gz: 454f651f6801fdb48a2bd2a76167a8d8d0fafd2712242aa9ce5db5f4d72d30bc95a7e4406e7d9da0f67b1542262b2d46a0c60b47cf52ce4773544fc94cdb636b
-  data.tar.gz: 386d2f4bf0d2a940969fe14fd280cb9afe9d09fac6568b9fc5ea98ddcd054a48de547d1a677275e6c418389efe309b10f621258e617c515329105db72b5960eb
+  metadata.gz: a3853c69389798f965cb41e629fb208e6926b3a4ce2d5f0f925554cec41d470fa5963ad6d88dd1712e787be3db683f1e61cce7411c78f8dda574069f7d5a9b55
+  data.tar.gz: 78719ff0ab9c7299639161ba2a966786d18dc79b9f401e8112b58656f2270436c51119c3eb6297f73c4df4e40dc7843bebe4496a9a5cbcc6d187b6898fa00245

data/README.md

@@ -31,13 +31,21 @@ gem 'render_turbo_stream'
 bundle install
 ```
 
+**Include the helpers**
+
 ApplicationController
 
 ```ruby
 include RenderTurboStream::ControllerHelpers
 ```
 
-spec/rails_helper.rb
+Create a Initializer
+
+```ruby
+ActionView::Base.send :include, RenderTurboStream::ViewHelpers
+```
+
+spec/rails_helper.rb (We are using rspec instead of minitest)
 
 ```ruby
 RSpec.configure do |config|
@@ -55,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
 ```
 
@@ -102,15 +112,28 @@ The Rails team has integrated `ActionCable` as `Turbo::StreamsChannel` into `Tur
 def update
   turbo_stream_save(
     @article.update(article_params),
-    if_success_turbo_redirect_to: articles_path,
-    target_id: 'customer-form',
+    if_success_redirect_to: articles_path,
     partial: 'form'
   )
 end
 ```
-This will set a status, generate a flash message, and run `render_turbo_stream`. If it fails, it would result in something like this:
 
-If no partial is given, it renders the default template as turbo_stream.
+Assuming we want to build a form that works within a turbo-frame, including flash messages and redirects, we have to build all that inside a `turbo-frame`, and, within that we need a target-id, that must not be a turbo-frame. For that, there is a helper:
+
+```haml
+= turbo_target_tag do
+  = simple_form ... 
+```
+
+This will generate an element like `<turbo-target id="new-article-form">`.
+
+And the form should work!
+
+If the update succeeds, it sends a flash message by channel(!), because stream cannot work alongside redirect, and redirects to articles#index. If it fails, it sends a flash message by stream and replaces the form tag by stream so that the invalid fields are marked red and you can see the errors inside the form.
+
+Technical details? see later in this README.
+
+As mentioned above, the turbo stream actions are handled by the `render_turbo_stream` controller helper:
 
 ```ruby
 render_turbo_stream(
@@ -130,9 +153,6 @@ render_turbo_stream(
 
 If the update succeeds, it will do a `redirect_to` action from turbo_power
 
-
-**locals**: The hash for locals goes through a `symbolize_keys`, so you need to use locals in used partials like this: `locals[:message]`.
-
 **More options**
 
 `render_turbo_stream` interprets a hash as a partial to be sent by `turbo_stream` and an array as a command to be sent. This allows you to perform most actions from, e.g., [turbo_power](https://github.com/marcoroth/turbo_power). An example of adding a css class to an html element and updating the browser history would look like this:
@@ -163,7 +183,30 @@ If this config is set to true, Turbo::StreamsChannel is installed and a current
 
 If an `if_success_redirect_to` argument is provided and the save action was successful, `turbo_stream_save` would send the partials by channel.
 
-**target-ID: Avoid the same definition in multiple places**
+**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'
+target_id('customers/_form', 'hi-joe') #=> 'hi-joe'
+```
+
+View-helper: Assuming we are inside `customers/_my_form`:
+
+```ruby
+#=> Assuming controller-name "customers" and variable @customer is present
+target_id 
+#=> 'customer-1-my-form'
+
+target_id(Customer.new) 
+#=> 'new-customer-my-form'
+```
+
+**Target-ID: Avoid the same definition in multiple places**
 
 Without this gem a turbo action would be wrapped within two frames, for example:
 
@@ -187,7 +230,7 @@ This means that the target id must be defined in several places: inside a partia
 In order to avoid this kind of tedious coding, the gem has a kind of fallback built in: If the argument `partial` is given, but the attribute `target_id` is not, the gem will get the target_id from the partial. The process is:
 
 1. Render the partial with the provided locals
-2. Grabs into the partial by Nokogiri and looks for the first `turbo_frame_tag` **OR** a element with the attribute `data_turbo_target`, get the id and uses this as target_id.
+2. Grabs into the partial by Nokogiri and looks for the first `turbo-frame` or `turbo-target` element, get the id and uses this as target_id.
 3. If all that not is found it raises a exception
 4. wraps the partial within the `turbo_stream.*` and sends this to the front.
 

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

@@ -12,7 +12,7 @@ module RenderTurboStream
       if_success_redirect_to: nil, # does a regular redirect. Works if you are inside a turbo_frame and just want to redirect inside that frame BUT CANNOT STREAM OTHERS ACTIONS ON THE SAME RESPONSE https://github.com/rails/rails/issues/48056
       if_success_turbo_redirect_to: nil, # does a full page redirect (break out of all frames by turbo_power redirect)
 
-      target_id: nil, # IF NIL: the gem grabs inside the rendered content for turbo_frame_tag or element with attribute data_turbo_target and takes the id from there.
+      target_id: nil, # IF NIL: the gem grabs inside the rendered content for turbo-frame tag or turbo-target (element from helper of this gem) tag and takes the id from there.
       partial: nil, # if nil: the gem renders the default template by turbo-stream
       action: 'replace', # options: append, prepend
       locals: {},
@@ -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 to enable defined redirection 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

@@ -36,7 +36,7 @@ module RenderTurboStream
     def self.fetch_arguments_from_rendered_string(rendered_string)
       noko = Nokogiri::HTML(rendered_string)
       frame = noko.at_css('turbo-frame')
-      ele = noko.at_css('[data_turbo_target]')
+      ele = noko.at_css('turbo-target')
       if frame.present?
         {
           target_id: frame[:id],
@@ -52,5 +52,29 @@ module RenderTurboStream
       end
     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
+        (
+          (
+            id.id ?
+              [id.class.to_s.downcase, id.id] :
+              ['new', id.class.to_s.downcase]
+          ) +
+            [
+              virt_view_path.split('/').last.sub(/^_/, '')
+            ]
+        ).join('-')
+      end
+    end
+
   end
 end

data/lib/render_turbo_stream/test/request/helpers.rb

@@ -84,6 +84,11 @@ module RenderTurboStream
           )
         end
 
+        def target_id(relative_view_path, object)
+          libs = RenderTurboStream::Libs
+          libs.target_id(relative_view_path, object)
+        end
+
       end
     end
   end

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "4.3.1"
+  VERSION = "4.3.3"
 end

data/lib/render_turbo_stream/view_helpers.rb

@@ -0,0 +1,20 @@
+module RenderTurboStream
+  module ViewHelpers
+
+    def turbo_target_tag(id = nil, &block)
+      content_tag :'turbo-target', id: target_id(id) do
+        if block_given?
+          capture(&block)
+        end
+      end
+    end
+
+    def target_id(id = nil)
+      libs = RenderTurboStream::Libs
+      virt_path = self.instance_variable_get('@current_template').instance_variable_get('@virtual_path')
+      obj = (id ? id : eval("@#{controller_name.singularize}"))
+      libs.target_id(virt_path, obj)
+    end
+
+  end
+end

data/lib/render_turbo_stream.rb

@@ -10,6 +10,7 @@ require 'render_turbo_stream/controller_helpers'
 require 'render_turbo_stream/controller_channel_helpers'
 
 require 'render_turbo_stream/channel_view_helpers'
+require 'render_turbo_stream/view_helpers'
 
 require 'render_turbo_stream/channel_libs'
 require 'render_turbo_stream/controller_libs'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.3.3
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-16 00:00:00.000000000 Z
+date: 2023-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -62,6 +62,7 @@ files:
 - lib/render_turbo_stream/test/request/helpers.rb
 - lib/render_turbo_stream/test/request/libs.rb
 - lib/render_turbo_stream/version.rb
+- lib/render_turbo_stream/view_helpers.rb
 - lib/tasks/render_turbo_stream_tasks.rake
 homepage: https://gitlab.com/sedl/renderturbostream
 licenses: