render_turbo_stream 4.1.6 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d41d763714ed2d599837c9cd3723d2f618f9ee6df7a095c8a06d0f66291cae7f
-  data.tar.gz: fac83287dbba160bfbe7a18b505810eab430c0fef43b32472494ee3e3291acd2
+  metadata.gz: 28e02fddd9493b46170e9e2767651c82748da1c0a0984940e57044489a24d472
+  data.tar.gz: a75224ab07323e2eef5d8f6905776c849a852068074d5e10a356303178b7d30a
 SHA512:
-  metadata.gz: 4c6943379cb3411f3d2a79b3ab11559876c6ff25db04f41c5f6b6eeb574f6aa8152398584cc9fc00eb00f107a205bb1852e5ae1141ee48707076ad627c963f39
-  data.tar.gz: 6c160c3026eac74b5fa1be6288409554a95cad8548b75e615015d99883774e87c3c61d8087588fb5d4e9840b2acd141b90a03e82cf21440ccaf0b221d8b0238e
+  metadata.gz: 45161e756cf12ebee2a2fd8941e93471ac001153bd39905597777f3fed48f5bb91e26fb254b41f0f30e340b4f47d1f743c2ec744a969e59e6b21baefdde40d5e
+  data.tar.gz: 8e610e79ae595f3af6290b450fb7b61a97c0166e883db6a5cae71bb095dac3481644d2964218478176376c1d0461144235cb6f2526d9af2dba97e21df999e57d

data/README.md

@@ -4,6 +4,8 @@
 
 This gem has a second [README Turbo::StreamsChannel](https://gitlab.com/sedl/renderturbostream/-/blob/main/README-channels.md). Starting point is here. And I recommend that you download my [Quick-and-dirty test project](https://gitlab.com/sedl/renderturbostream_railsapp), set it up, see all the tests succeed, and then read through this README.
 
+As of v4.3, locals inside partials should work as expected. If you are working with turbo but without this gem, please read [readme-locals](https://gitlab.com/sedl/renderturbostream/-/blob/main/readme-locals.md) to avoid tedious details.
+
 Defining templates like `(create|update).turbo_stream.haml` is a heavy mix of logic and view. This gem separates logic and view so that `*.turbo_stream.*` templates are no longer necessary and the logic can stay on the ruby side.
 
 For `:replace` actions, responses must be wrapped inside a `turbo_frame_tag` with a matching `target_id`. The gem will regex the content and wrap it by a `turbo_frame_tag` if necessary but not present. This way the matching `target_id` is only defined in one place. This check only happens on the first call after restarting the application in production and on every call if precompile assets is set to true in configs.
@@ -17,7 +19,7 @@ Has a testing strategy.
 An overview of how we design a rails-7 application with turbo
 is [published on dev.to](https://dev.to/chmich/rails-7-vite-wrapping-up-1pia).
 
-I am happy if it can help.
+Hope it helps :)
 
 **Chris**
 
@@ -170,6 +172,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**.
@@ -222,10 +252,19 @@ config.x.render_turbo_stream.first_argument_is_html_id = %[replace append prepen
 
 This setting is relevant for testing helpers.
 
+# Conclusion
+
+The World Wide Web, founded around 1990 by [Tim Berners-Lee](https://en.wikipedia.org/wiki/Tim_Berners-Lee), was an html response from the server.
+
+Frameworks like Angular, Ember, React, Vue brought a much better user experience, so called "single page applications". But they changed something: Now Javascript was the processor of HTML, which is far from the [Progressive Enhancement] (https://developer.mozilla.org/en-US/docs/Glossary/Progressive_Enhancement)
+
+The Rails core team has now achieved a milestone by turbo, for bringing a user experience like a single page app, but by reducing javascript. Somehow modern, back to the roots. Thank you.
+
+This gem is an attempt to make this approach more convenient for developers. 
 
 # Contributing
 
-Contribution welcome.
+Contributors welcome.
 
 # License
 

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,29 @@
   <% else %>
     <% ctl = { partial: args[:partial], target_id: args[:target_id], action: args[:action] } %>
 
+
+    <% locals = args[:locals]&.symbolize_keys %>
+    <% partial = args[:partial] %>
+    <% rendered_html = render(partial: partial, locals: locals, 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,22 @@
     <% 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]) %>
+    <% locals = s[:locals]&.symbolize_keys %>
+    <% partial = s[:partial] %>
+    <% html = (render partial: partial, locals: locals, 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 %>
-    <% else %>
-      <% html = (render s[:partial], locals: s[:locals]&.symbolize_keys, formats: [:html]) %>
     <% 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
 

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,
@@ -132,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?
@@ -157,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,5 +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.6"
+  VERSION = "4.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 4.1.6
+  version: 4.3.0
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2023-05-25 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: Make working with Turbo fun!
 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