render_turbo_stream 4.1.5 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a667bdf8e453b073d1a728867311b094c6cd4e2b0130e0bf315111b06cd1fd7
-  data.tar.gz: c38fc937c8accd644b2990806e16b6065641544954cf9685831e7da418a80eba
+  metadata.gz: e0baf30f6152a1308687add8e14fda8ae815bfa43e54f9b4ffc6d859accc5e5b
+  data.tar.gz: a61f84ab272df1447b3a4cd38ef5dcbf3702390e360cbb03d5f172f0056aa760
 SHA512:
-  metadata.gz: 79220607a4ae09be4cab396d6ca86a97f2ed1177bbf3abeca162ecbfa770b4628691e18b00f26f7db160d5a0cc8f60615231c1f109aad5945e83511f8d11273e
-  data.tar.gz: a3d4c30bb7f1f3fb30fe527bc20da9703207c893db2378ca8aca452d037eb9f5a2f284c233c8ebb0698660bff0eb72abd8954e6440e8ec293574c87fef2da5cc
+  metadata.gz: 5f6b26a244628091a4385883b04d588d682f1da0144dd56a827e74cceb5d61df5bdeeb8eb72e041c9203995b25f1b62605fde0d5d4eadc611b3ef7a02dd8df54
+  data.tar.gz: bf8a7eaae4377b4a52f4200057f9dd4e8e8273fdee243f258cf1e65a63f935873d11a9686e73e1e353b54c5a05458781a6811c991f76650d1810da6dfa2b5e0a

data/README.md

@@ -170,6 +170,34 @@ 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**
+
+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:
+
+```haml
+= turbo_frame_tag 'target-id' do
+   ... content
+```
+
+The `turbo_frame_tag` would stay inside a partial in most cases. The reason is: On the first load, the target-id must be delivered up front, so that if the tag needs to be replaced later, turbo knows which part to replace.
+
+This means that the target id must be defined in several places: inside a partial and at the place where the turbo action is defined.
+
+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 a turbo_frame_tag and fetches the 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.
+
 # Request Testing
 
 To test if the whole system works together, including javascript actions, so that finally a part reaches the surface, there is **Capybara** system testing. But it is a good practice to **break tests into smaller pieces**. So, there are helpers for **enabling the much faster request tests that are much easier to maintain**.

data/app/controllers/render_turbo_stream/render_controller.rb

@@ -0,0 +1,4 @@
+module RenderTurboStream
+  class RenderController < ActionController::Base
+  end
+end

data/app/views/render_turbo_stream.turbo_stream.erb

@@ -14,22 +14,28 @@
   <% else %>
     <% ctl = { partial: args[:partial], target_id: args[:target_id], action: args[:action] } %>
 
+
+
+    <% rendered_html = render(partial: args[:partial], locals: args[:locals]&.symbolize_keys, formats: [:html]) %>
+    <% unless args[:target].present? %>
+      <% args[:target] = RenderTurboStream::Libs.fetch_arguments_from_rendered_string(rendered_html)[:target] %>
+      <% unless args[:target].present? %>
+        <% raise 'No target specified by arguments and no target found inside the rendered partial' %>
+      <% end %>
+    <% end %>
+
+
     <% target_id = RenderTurboStream::Libs.target_to_target_id(args[:target]) %>
 
     <% info = { target_id: args[:target_id], partial: args[:partial], locals: args[:locals] } %>
 
 
-
     <% if args[:action].present? %>
       <% Rails.logger.debug("  • render-turbo-stream #{args[:action].upcase} => #{info}") %>
       <%= turbo_stream.send args[:action].to_sym, target_id do %>
-        <% if RenderTurboStream::CheckTemplate.new(partial: args[:partial], action: args[:action]).add_turbo_frame_tag? %>
-          <%= turbo_frame_tag RenderTurboStream::Libs.target_to_target_id(args[:target]) do %>
-            <%= render args[:partial], locals: args[:locals]&.symbolize_keys %>
-          <% end %>
-        <% else %>
-          <%= render args[:partial], locals: args[:locals]&.symbolize_keys %>
-        <% end %>
+
+        <%= rendered_html %>
+
       <% end %>
 
     <% else %>

data/app/views/render_turbo_stream_request_test.html.erb

@@ -10,15 +10,20 @@
     <% rendered_partials.push(h) %>
   <% else %>
 
-    <% wrap = RenderTurboStream::CheckTemplate.new(partial: s[:partial], action: s[:action]).add_turbo_frame_tag? %>
 
-    <% if wrap %>
-      <% html = turbo_frame_tag RenderTurboStream::Libs.target_to_target_id(s[:target]) do %>
-        <%= (render s[:partial], locals: s[:locals]&.symbolize_keys, formats: [:html]) %>
-      <% end %>
-    <% else %>
       <% html = (render s[:partial], locals: s[:locals]&.symbolize_keys, formats: [:html]) %>
+
+
+
+    <% unless s[:target].present? %>
+      <% s[:target] = RenderTurboStream::Libs.fetch_arguments_from_rendered_string(html)[:target] %>
+      <% unless s[:target].present? %>
+        <% raise 'No target specified by arguments and no target found inside the rendered partial' %>
+      <% end %>
     <% end %>
+
+
+
     <% s[:target] = s[:target] %>
     <% s.delete(:id) %>
     <% rendered_partials.push({ html_response: html, type: 'stream-partial' }.merge(s)) %>

data/lib/render_turbo_stream/channel_libs.rb

@@ -7,9 +7,10 @@ module RenderTurboStream
 
     def render_to_channel(channel, target, action, controller_self, partial: nil, template: nil, locals: nil)
 
+      _locals = (locals ? locals : {})
+
       # instance variables
 
-      target_id = RenderTurboStream::Libs.target_to_target_id(target)
       check_template = RenderTurboStream::CheckTemplate.new(
         partial: partial,
         template: template,
@@ -19,35 +20,40 @@ module RenderTurboStream
 
       # add instance_variables to locals
 
-      locals = {} unless locals # prevent error missing keys for nil
-      if check_template.add_turbo_frame_tag?
-        _layout = 'layouts/add_turbo_frame_tag'
-        _locals = locals.merge(
-          {
-            render_turbo_stream_partial: partial,
-            render_turbo_stream_target_id: target_id
-          }
-        )
-      else
-        _locals = locals
-        _layout = false
-      end
       check_template.templates_instance_variables.each do |v|
         _locals[:"render_turbo_stream_instance_variable_#{v}"] = controller_self.instance_variable_get(v.to_s)
       end
 
+      # fetch target-id
+
+      target_id = RenderTurboStream::Libs.target_to_target_id(target)
+      if !target.present? || Rails.env.test?
+        if partial.present?
+          rendered_html = RenderController.render(partial: partial, locals: _locals, layout: false)
+        elsif template.present?
+          rendered_html = RenderController.render(template: template, locals: _locals, layout: false)
+        end
+        if !target.present?
+          r = RenderTurboStream::Libs.fetch_arguments_from_rendered_string(rendered_html)
+          target_id = r[:target_id]
+          target = r[:target]
+        end
+      end
+
+      unless target.present? && target_id.present?
+        raise 'No target specified by arguments and no target found inside the rendered partial'
+      end
+
       # add headers for test
 
       if Rails.env.test?
-        html = RenderTurboStreamRenderController.render(partial: partial, locals: _locals, layout: _layout) if partial
-        html = RenderTurboStreamRenderController.render(template: template, locals: _locals, layout: _layout) if template
         props = {
           target: target,
           action: action,
           type: 'channel-partial',
           locals: locals,
           channel: channel,
-          html_response: html.to_s
+          html_response: rendered_html.to_s
         }
 
         props[:partial] = partial if partial
@@ -66,23 +72,23 @@ module RenderTurboStream
 
       # send
 
-      if partial
+      if partial.present?
         Turbo::StreamsChannel.send(
           "broadcast_#{action}_to",
           channel.to_s,
           target: target_id,
           partial: partial,
           locals: _locals&.symbolize_keys,
-          layout: _layout
+          layout: false
         )
-      elsif template
+      elsif template.present?
         Turbo::StreamsChannel.send(
           "broadcast_#{action}_to",
           channel.to_s,
           target: target_id,
           template: template,
-          locals: locals&.symbolize_keys,
-          layout: _layout
+          locals: _locals&.symbolize_keys,
+          layout: false
         )
       end
     end
@@ -114,7 +120,7 @@ module RenderTurboStream
         end
       end
 
-      content = RenderTurboStreamRenderController.render(template: 'render_turbo_stream_command', layout: false, locals: { command: command, arguments: arguments })
+      content = RenderController.render(template: 'render_turbo_stream_command', layout: false, locals: { command: command, arguments: arguments })
 
       Turbo::StreamsChannel.broadcast_stream_to(
         channel,

data/lib/render_turbo_stream/check_template.rb

@@ -23,12 +23,12 @@ module RenderTurboStream
         if $render_turbo_stream_check_templates[@key]
           @result = $render_turbo_stream_check_templates[@key]
         else
-          @result = { instance_variables: [], add_turbo_frame_tag: false }
+          @result = { instance_variables: [] }
           fetch_nested_partials(1, partial: @partial_path, template: @template_path)
           $render_turbo_stream_check_templates[@key] ||= @result
         end
       else
-        @result = { instance_variables: [], add_turbo_frame_tag: false }
+        @result = { instance_variables: [] }
         fetch_nested_partials(1, partial: @partial_path, template: @template_path)
       end
     end
@@ -37,10 +37,6 @@ module RenderTurboStream
       @result[:instance_variables]
     end
 
-    def add_turbo_frame_tag?
-      @result[:add_turbo_frame_tag]
-    end
-
     private
 
     def production?
@@ -67,13 +63,6 @@ module RenderTurboStream
         end
       end
 
-      conf = Rails.configuration.x.render_turbo_stream.auto_wrap_for_actions
-      if stack_level == 1 && conf.present? && conf.include?(@action.to_sym)
-        unless _code.match(/(turbo_frame_tag|turbo-frame)/)
-          @result[:add_turbo_frame_tag] = true
-        end
-      end
-
       loop do
         _matched_partial = _code.match((/\brender[ ](partial:|())(|[ ])("|')[a-z_\/]+("|')/))
         _code = _code[(_code.index(_matched_partial.to_s) + 5)..-1]

data/lib/render_turbo_stream/controller_channel_helpers.rb

@@ -1,7 +1,7 @@
 module RenderTurboStream
   module ControllerChannelHelpers
 
-    def render_to_all(target_id, action = :replace, partial: nil, template: nil, locals: nil)
+    def render_to_all(target_id = nil, action = :replace, partial: nil, template: nil, locals: nil)
       evaluate_instance_variables
       render_to_channel(
         'all',
@@ -13,7 +13,7 @@ module RenderTurboStream
       )
     end
 
-    def render_to_me(target_id, action = :replace, partial: nil, locals: nil)
+    def render_to_me(target_id = nil, action = :replace, partial: nil, locals: nil)
       begin
         u_id = helpers.current_user&.id
         unless u_id.present?
@@ -34,7 +34,7 @@ module RenderTurboStream
       )
     end
 
-    def render_to_authenticated_group(group, target_id, action = :replace, partial: nil, locals: nil)
+    def render_to_authenticated_group(group, target_id = nil, action = :replace, partial: nil, locals: nil)
       begin
         u_id = helpers.current_user&.id
         unless u_id.present?
@@ -55,7 +55,7 @@ module RenderTurboStream
       )
     end
 
-    def render_to_channel(channel, target_id, action, partial: nil, template: nil, locals: nil, instance_variables: true)
+    def render_to_channel(channel, target_id = nil, action = :replace, partial: nil, template: nil, locals: nil, instance_variables: true)
 
       raise 'Arguments partial and template cannot both be specified' if partial && template
 
@@ -157,11 +157,11 @@ module RenderTurboStream
       unless object
         object = eval("@#{controller_name.classify.underscore}")
       end
-
-      libs = RenderTurboStream::ControllerLibs.new(save_action)
-      if !object
+      unless object
         raise "Could not fetch a model name by «eval(\"\@\#{controller_name.classify.underscore}\")». You must provide the argument :object."
       end
+
+      libs = RenderTurboStream::ControllerLibs.new(save_action)
       model_name = object.model_name.human
 
       turbo_actions = libs.generate_flash(

data/lib/render_turbo_stream/controller_helpers.rb

@@ -21,7 +21,7 @@ module RenderTurboStream
       if_error_add: nil, # additional partials that should be rendered if save_action failed
       add: [], # additional streams
 
-      if_success_notices: nil, # array of strings, override default generated flash generation in the case of success
+      if_success_notices: nil, # array of strings, or string, override default generated flash generation in the case of success
       if_error_alerts: nil,
       add_notices: nil, # array of strings
       add_alerts: nil,
@@ -42,6 +42,9 @@ module RenderTurboStream
       unless object
         object = eval("@#{controller_name.classify.underscore}")
       end
+      unless object
+        raise "Could not fetch a model name by «eval(\"\@\#{controller_name.classify.underscore}\")». You must provide the argument :object."
+      end
 
       libs = RenderTurboStream::ControllerLibs.new(save_action)
       model_name = object.model_name.human
@@ -129,11 +132,11 @@ module RenderTurboStream
           else
             r[:target] = props[:target]
           end
-          raise "Missing attribute :target in #{props}" if !props[:target].present?
           r.delete(:target_id)
           r[:action] = (props[:action].present? ? props[:action] : :replace)
           r[:partial] = RenderTurboStream::Libs.partial_path(props[:target], props[:target_id], controller_path, props[:partial])
           r[:type] = 'stream-partial'
+
           ary.push(r)
         elsif pr.is_a?(Array)
           raise "array has to contain at least one element: #{pr}" unless pr.first.present?
@@ -154,7 +157,7 @@ module RenderTurboStream
 
     # renders a partial to turbo_stream
 
-    def stream_partial(target_id, partial: nil, action: :replace, locals: {})
+    def stream_partial(target_id = nil, partial: nil, action: :replace, locals: {})
       render_turbo_stream(
         [
           {

data/lib/render_turbo_stream/controller_libs.rb

@@ -5,7 +5,7 @@ module RenderTurboStream
       @save_action = save_action
     end
 
-    def generate_flash( model_name, controller_action, if_success_notices, if_error_alerts, add_notices, add_alerts )
+    def generate_flash(model_name, controller_action, if_success_notices, if_error_alerts, add_notices, add_alerts)
 
       target_id = (Rails.configuration.x.render_turbo_stream.flash_target_id rescue nil)
       raise "Missing configuration: config.x.render_turbo_stream.flash_target_id" unless target_id
@@ -14,26 +14,33 @@ module RenderTurboStream
       turbo_action = Rails.configuration.x.render_turbo_stream.flash_turbo_action
       raise "Missing configuration: configuration.x.render_turbo_stream.flash_turbo_action" unless turbo_action
 
-
       if @save_action
         notices = if if_success_notices
-                          if_success_notices
-                        else
-                          str = I18n.t(
-                            "activerecord.render_turbo_stream_success.#{controller_action}"
-                          )
-                          [format(str, model_name: model_name)]
-                        end
+                    if if_success_notices.is_a?(String)
+                      [if_success_notices]
+                    else
+                      if_success_notices
+                    end
+                  else
+                    str = I18n.t(
+                      "activerecord.render_turbo_stream_success.#{controller_action}"
+                    )
+                    [format(str, model_name: model_name)]
+                  end
         alerts = []
       else
         alerts = if if_error_alerts
-                         if_error_alerts
-                       else
-                         str = I18n.t(
-                           "activerecord.render_turbo_stream_errors.#{controller_action}"
-                         )
-                         [format(str, model_name: model_name)]
-                       end
+                   if if_error_alerts.is_a?(String)
+                     [if_error_alerts]
+                   else
+                     if_error_alerts
+                   end
+                 else
+                   str = I18n.t(
+                     "activerecord.render_turbo_stream_errors.#{controller_action}"
+                   )
+                   [format(str, model_name: model_name)]
+                 end
         notices = []
       end
 
@@ -63,13 +70,13 @@ module RenderTurboStream
       { turbo_actions: turbo_actions, alerts: alerts, notices: notices }
     end
 
-    def additional_actions( if_success_add, if_error_add, add )
+    def additional_actions(if_success_add, if_error_add, add)
 
       (@save_action ? make_actions(if_success_add) : make_actions(if_error_add)) + make_actions(add)
 
     end
 
-    def generate_action( controller_path, target_id, action, partial, locals )
+    def generate_action(controller_path, target_id, action, partial, locals)
       libs = RenderTurboStream::Libs
       target = libs.target_id_to_target(target_id)
       _partial = libs.partial_path(nil, target_id, controller_path, partial)

data/lib/render_turbo_stream/libs.rb

@@ -29,7 +29,18 @@ module RenderTurboStream
       end
     end
 
-
+    def self.fetch_arguments_from_rendered_string(rendered_string)
+      noko = Nokogiri::HTML(rendered_string)
+      frame = noko.at_css('turbo-frame')
+      if frame.present?
+        {
+          target_id: frame[:id],
+          target: target_id_to_target(frame[:id])
+        }
+      else
+        {}
+      end
+    end
 
   end
 end

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "4.1.5"
+  VERSION = "4.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.2.0
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,10 +27,10 @@ dependencies:
 description: 'A set of helpers that allow a UNIFIED WORKFLOW for TurboStream and TurboStreams::Channel.
   To avoid a heavy mix of view and logic, partials and templates can be rendered directly
   from the controller. There is no need to write *.turbo_stream.* templates anymore.
-  Logic can stay on the Ruby side, in the controller. Javascript actions can also
-  be executed directly from the controller. TESTING: To reduce the amount of hard-to-maintain
-  system tests, this gem allows detailed request tests. A DEMO PROJECT with all this
-  built in, along with system and request tests, is linked in the README.'
+  Logic can stay on in the controller. Javascript actions can also be executed directly
+  from the controller. TESTING: To reduce the amount of hard-to-maintain system tests,
+  this gem allows detailed request tests. A DEMO PROJECT with all this built in, along
+  with system and request tests, is linked in the README.'
 email:
 - christian@sedlmair.ch
 executables: []
@@ -40,7 +40,7 @@ files:
 - README.md
 - Rakefile
 - app/controllers/render_turbo_stream/application_controller.rb
-- app/controllers/render_turbo_stream/render_turbo_stream_render_controller.rb
+- app/controllers/render_turbo_stream/render_controller.rb
 - app/views/layouts/_add_turbo_frame_tag.html.erb
 - app/views/render_turbo_stream.turbo_stream.erb
 - app/views/render_turbo_stream_command.html.erb
@@ -86,5 +86,5 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Complete workflow for turbo-rails with a testing strategy.
+summary: Makes working with Turbo fun and ensures quality.
 test_files: []

data/app/controllers/render_turbo_stream/render_turbo_stream_render_controller.rb

@@ -1,4 +0,0 @@
-module RenderTurboStream
-  class RenderTurboStreamRenderController < ActionController::Base
-  end
-end