render_turbo_stream 1.4.4 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab99348bf3118d88b5b5d1ae6bb12eca5c3b2a433c53ce8d7777a7519130f69c
-  data.tar.gz: 57958c45f249bab4fb1c1d4c118a5a30db4956f2991c04bca9ac36b50739e78f
+  metadata.gz: 187ae01e898e93a7b6a09936abc83f15e96172f4a76759844ff54c585d0a58bb
+  data.tar.gz: 8b361d4745339fb6bd83dd05ad784be75e82bf47f596e635e8bf8c567afeeff7
 SHA512:
-  metadata.gz: 725ca7fb7f726dbb70c796ed8438ebf74ea63310055188c635bd94d59f5297f99c974d44677fc8b7bf2d033c07960fcc5ccb7c68cf1a0ebbbe5d868b0c9f2af4
-  data.tar.gz: 7d2639a7744be4b9f9e28a620a7d2c55adedc7a2948b197ef4ced797d2ff585041cb9ffba61b72a55c87766fc803581098b7ad65595708dd76378d80e39b69e5
+  metadata.gz: 7d2fab8e12360c1756d53fc5dcd82479fd34a0fed8a6398f745449460325a28b173b22bdb805e0319815b2fa3745f52c15a7e0a09e9faeebedbcf5cdbaaa2bf7
+  data.tar.gz: 2f767606657e5f98281834676fb1a159aa8f799907dd43ec7dce770c6d2a2f7cdbc08f4e0d983964c231b5fbb466efee0659875a25cb25e8fc3c37fd75cb10d0

data/README.md

@@ -8,6 +8,8 @@ And build it dynamically: Most [turbo_power](https://github.com/marcoroth/turbo_
 
 ATTENTION: This plugin is in a early state.
 
+Hope this gem can help you.
+
 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).
 
@@ -101,7 +103,7 @@ render_turbo_stream(
 )
 ```
 
-The `stream_partial` method is nothing else than a singular of `render_turbo_stream`.
+The `stream_partial` method is just for rendering a partial alone.
 
 ```ruby
 stream_partial(
@@ -129,9 +131,6 @@ render_turbo_stream(
       :add_css_class,
       '#colored-element',
       'red'
-    ],
-    [
-      
     ]
   ]
 )
@@ -141,14 +140,34 @@ Under the hood, inside a `*.turbo_stream.erb` template, it does the following: `
 
 **WORKAROUND for redirects inside frame**
 
-How to handle a classical redirect_to, together with a flash message, within a frame for a CRUD controller? see [workaround](https://gitlab.com/sedl/renderturbostream/-/issues/3)
+Suppose you have a CRUD controller that should do all its actions inside a turbo frame. Classic redirect_to, along with a Flash message, would raise "Render and/or redirect were called multiple times in this action". See [issue] (https://gitlab.com/sedl/renderturbostream/-/issues/3).
+
+You can handle this by reloading the parent frame's src attribute. The code might look like this:
+
+```ruby
+def update
+    @car = Car.find(params['id'])
+    turbo_stream_save(
+      @car.update(car_params),
+      streams_on_success: [
+        [
+          :turbo_frame_set_src,
+          'cars-box',
+          cars_path
+        ]
+      ]
+    )
+  end
+
+```
 
 **Parameters for turbo_stream_save**
 
     save_action,
-    redirect_on_success_to: nil,
+    redirect_on_success_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
+    turbo_redirect_on_success_to: nil, # does a full page redirect (break out of all frames by turbo_power redirect)
     object: nil, # object used in save_action, example: @customer
-    id: 'form', # if nil: no partial is rendered
+    id: nil, # if nil: no partial is rendered
     partial: nil, # example: 'customers/form' default: "#{controller_path}/#{id}"
     action: 'replace', # options: append, prepend
     locals: {}, # locals used by the partial
@@ -255,6 +274,17 @@ For more detailed testing of partials, there are view tests.
 Testing the plugin itself: There is a [quick-and-dirty app](https://gitlab.com/sedl/renderturbostream_railsapp) which
 includes the plugin and has tests done by rspec/request and capybara.
 
+## More Configs
+
+On test helpers, the marker for a turbo-stream target is in most cases the id of the target element. This is true for the standard turbo-stream functions. On `turbo_power` it is the same in most cases. `RenderTurboStream::Libs.first_attr_is_html_id()` checks for which methods this is true. You can override this:
+
+```ruby
+config.x.render_turbo_stream.first_attribute_is_html_id = %[replace append prepend turbo_frame_set_src]
+```
+
+This setting is relevant for testing helpers.
+
+
 ## Contributing
 
 Contribution welcome.
@@ -262,3 +292,7 @@ Contribution welcome.
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Thanks
+
+Thanks to Marco Roth for turbo_power and thanks to DHH and the rails team for taking a bold new step by creating turbo.

data/app/views/render_turbo_stream.html.erb

@@ -1,13 +1,19 @@
 <% rendered_partials = [] %>
 
+
 <% streams.each do |s| %>
 
   <% if s.is_a?(Array) %>
-    <% rendered_partials.push({ command: "turbo_stream.#{s.first}, #{s[1..-1].join(', ')}", method: s.first, attributes: s[1..-1] }) %>
+    <% attr_id = RenderTurboStream::Libs.first_attr_is_html_id(s.first) %>
+    <% h = { attributes: s, type: 'command' } %>
+    <% h[:target] = "##{s.second}" if attr_id %>
+    <% rendered_partials.push(h) %>
   <% else %>
     <% html = (render s[:partial], locals: s[:locals]&.symbolize_keys, formats: [:html]) %>
     <% s.delete(:partial) %>
-    <% rendered_partials.push({ html_response: html }.merge(s)) %>
+    <% s[:target] = "##{s[:id]}" %>
+    <% s.delete(:id) %>
+    <% rendered_partials.push({ html_response: html, type: 'partial' }.merge(s)) %>
   <% end %>
 
 

data/lib/render_turbo_stream/test/request_helpers.rb

@@ -4,24 +4,7 @@ module RenderTurboStream
 
       # log as helper for the developer to see which flash is set and which partials are rendered to wich ids
       def streams_log
-        all_responses = RenderTurboStream::Libs.all_responses(response)
-        r = []
-        if response.status == 302
-          r.push("redirect to #{turbo_redirect_to}")
-        else
-          all_responses.map do |a|
-            str = [
-              a['action'],
-              'id',
-              "«#{a['id']}»",
-              'by partial',
-              "«#{a['partial']}»",
-              (a['locals'].present? ? "locals: «#{a['locals']}»" : nil)
-            ].compact.join(' ')
-            r.push(str)
-          end
-        end
-        r
+        RenderTurboStream::Libs.all_responses(response)
       end
 
       # Returns the path to which turbo_stream.redirect_to would be applied.
@@ -29,11 +12,13 @@ module RenderTurboStream
         resps = RenderTurboStream::Libs.all_responses(response)
         url = nil
         resps.each do |r|
-          if r['method'] == 'redirect_to'
-            if url
-              url = 'ERROR: REDIRECT CALLED MORE THAN ONCE'
-            else
-              url = r['attributes'].first
+          if r['type'] == 'command'
+            if r['attributes'].first == 'redirect_to'
+              if url
+                url = 'ERROR: REDIRECT CALLED MORE THAN ONCE'
+              else
+                url = r['attributes'].second
+              end
             end
           end
         end
@@ -66,6 +51,50 @@ module RenderTurboStream
       def stream_targets_count
         stream_targets.length
       end
+
+      # Returns false if a given action such as "replace" (for: turbo_stream.replace) is not performed exactly once on a given target id. Otherwise, it returns an array of attributes that were used to call the function.
+      # For stream actions, this only works if the given action has the HTML-ID as its first element.
+      def stream_action_once(action, id)
+        all_responses = RenderTurboStream::Libs.all_responses(response)
+        counts = {}
+        res = nil
+        all_responses.each do |r|
+
+          if r['type'] == 'command'
+            act = r['attributes'].first
+            is_id = RenderTurboStream::Libs.first_attr_is_html_id(act)
+            if action.to_s == act && is_id && r['attributes'].second == id.to_s
+              k = [act, r['attributes'].second].join('-')
+              counts[k] ||= 0
+              counts[k] += 1
+              if counts[k] == 1
+                res = r['attributes']
+              else
+                res = false
+              end
+            end
+
+          elsif r['type'] == 'partial'
+
+            act = r['action']
+            is_id = r['target'][0] == '#'
+            _id = r['target'][1..-1]
+            if action.to_s == act && is_id && _id == id.to_s
+              k = [act, _id].join('-')
+              counts[k] ||= 0
+              counts[k] += 1
+              if counts[k] == 1
+                res = [act, id, { locals: r['locals'] }]
+              else
+                res = false
+              end
+            end
+
+          end
+        end
+        res
+      end
+
     end
   end
 end

data/lib/render_turbo_stream/test/rspec_request_helpers.rb

@@ -2,22 +2,30 @@ module RenderTurboStream
   module Test
     module RspecRequestHelpers
 
-
       # expect status 200 and a each one time response to given ids
 
       def expect_successful_saved(*ids)
         responses = RenderTurboStream::Libs.all_responses(response)
-        counts = {}
+        id_counts = {}
         responses.each do |r|
-          counts[r['id']] ||= 0
-          counts[r['id']] +=1
+          if r['target'].is_a?(Array)
+            r['target'].each do |t|
+              id = (t[0] == '#' ? t[1..-1] : t)
+              id_counts[t.to_s] ||= 0
+              id_counts[t.to_s] += 1
+            end
+          else
+            id = (r['target'][0] == '#' ? r['target'][1..-1] : r['target'])
+            id_counts[id] ||= 0
+            id_counts[id] += 1
+          end
         end
 
         expect(response.status).to eq(200)
-        expect(counts.keys.length).to eq(ids.length)
+        expect(id_counts.keys.length).to eq(ids.length)
         ids.each do |id|
-          expect(counts.key?(id)).to be_truthy
-          expect(counts[id]).to eq(1)
+          expect(id_counts.key?(id)).to be_truthy
+          expect(id_counts[id]).to eq(1)
         end
       end
 

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "1.4.4"
+  VERSION = "1.4.6"
 end

data/lib/render_turbo_stream.rb

@@ -8,7 +8,7 @@ module RenderTurboStream
 
   def turbo_stream_save(
     save_action,
-    redirect_on_success_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 AT SAME TIME https://github.com/rails/rails/issues/48056
+    redirect_on_success_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
     turbo_redirect_on_success_to: nil, # does a full page redirect (break out of all frames by turbo_power redirect)
     object: nil, # object used in save_action, example: @customer
     id: nil, # if nil: no partial is rendered
@@ -43,7 +43,7 @@ module RenderTurboStream
 
     #== Streams / Partials
 
-    streams = [(id ? { id: id, partial: partial, locals: locals, action: action } : nil)]
+    streams = (id ? [id: id, partial: partial, locals: locals, action: action] : [])
 
     if save_action
       response.status = 200
@@ -160,7 +160,7 @@ module RenderTurboStream
     ary = []
     array.each do |pr|
       if !pr.present?
-        a=1
+        a = 1
       elsif pr.is_a?(Hash)
         props = pr.symbolize_keys
         part = (props[:partial].present? ? props[:partial] : props[:id]).gsub('-', '_')
@@ -214,7 +214,7 @@ module RenderTurboStream
 
       all.select do |a|
         if id.present?
-          a['id'] == id
+          a['target'] == "##{id}"
         else
           false
         end
@@ -223,15 +223,19 @@ module RenderTurboStream
     end
 
     def self.stream_targets(response)
-      all = all_responses(response)
-      ids = []
-      all.each do |p|
-        _p = p['id']
-        unless ids.include?(_p)
-          ids.push(_p)
+      responses = all_responses(response)
+      targets = []
+      responses.each do |r|
+        if r['target'].is_a?(Array)
+          r['target'].each do |t|
+            targets.push(t) unless targets.include?(t)
+          end
+        else
+          targets.push(r['target']) unless targets.include?(r['target'])
         end
       end
-      ids
+
+      targets
     end
 
     def self.stream_target_response_count(response, id, total, &block)
@@ -252,5 +256,41 @@ module RenderTurboStream
 
     end
 
+    # on most methods the first attribute is the target.
+    # This method checks for that
+    # it includes the methods from turbo-power
+    # used for test helpers
+    def self.first_attr_is_html_id(method)
+      config = Rails.configuration.x.render_turbo_stream.first_attribute_is_html_id
+      default = [
+        :graft,
+        :morph,
+        :inner_html,
+        :insert_adjacent_text,
+        :outer_html,
+        :text_content,
+        :add_css_class,
+        :remove_attribute,
+        :remove_css_class,
+        :set_attribute,
+        :set_dataset_attribute,
+        :set_property,
+        :set_style,
+        :set_styles,
+        :set_value,
+        :dispatch_event,
+        :reset_form,
+        :clear_storage,
+        :scroll_into_view,
+        :set_focus,
+        :turbo_frame_reload,
+        :turbo_frame_set_src,
+        :replace,
+        :append,
+        :prepend
+      ]
+      (config.present? ? config : default).map{|m|m.to_sym}.include?(method.to_sym)
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.6
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,7 +38,6 @@ files:
 - README.md
 - Rakefile
 - app/controllers/render_turbo_stream/application_controller.rb
-- app/views/_render_turbo_stream.turbo_stream.erb
 - app/views/render_turbo_stream.html.erb
 - app/views/render_turbo_stream.turbo_stream.erb
 - lib/render_turbo_stream.rb
@@ -73,5 +72,6 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Render partials, run javascript like redirect by controller. With test helpers.
+summary: Render partials and run javascripts directly from the controller. With test
+  helpers.
 test_files: []

data/app/views/_render_turbo_stream.turbo_stream.erb

@@ -1,49 +0,0 @@
-<% error = false %>
-<% control = [] %>
-<% streams = local_assigns[:streams] %>
-<% streams.each do |args| %>
-
-
-  <% if args.is_a?(Array) %>
-
-    <% ctl = "turbo_stream.#{args.first}, #{args[1..-1].join(', ')}" %>
-
-    <% if args.last.is_a?(Proc) %>
-      <% Rails.logger.error("  RENDER TURBO STREAM BLOCK => #{ctl}") %>
-      <%#= turbo_stream.replace 'form' do %>
-        <%#= render partial: 'articles/form' %>
-      <%# end %>
-      <%= turbo_stream.send args.first, *(args[1..-2]) { args.last.call } %>
-    <% else %>
-      <% Rails.logger.error("  RENDER TURBO POWER => #{ctl}") %>
-      <%= turbo_stream.send args.first, *(args[1..-1]) %>
-    <% end %>
-
-  <% else %>
-    <% ctl = { partial: args[:partial], id: args[:id], action: args[:action] } %>
-    <% info = { id: args[:id], partial: args[:partial], locals: args[:locals] } %>
-    <% if !args[:action].present? %>
-      <% Rails.logger.error("  ERROR RENDER TURBO STREAM => MISSING ACTION => #{args}") %>
-      <% error = true %>
-
-    <% elsif args[:action].present? %>
-      <% Rails.logger.debug("  • render-turbo-stream #{args[:action].upcase} => #{info}") %>
-      <%= turbo_stream.send args[:action].to_sym, args[:id] do %>
-        <%= render args[:partial], locals: args[:locals]&.symbolize_keys %>
-      <% end %>
-
-    <% else %>
-      <% Rails.logger.error("  ERROR RENDER TURBO STREAM => NOTHING DONE! => #{args}") %>
-    <% end %>
-  <% end %>
-
-  <% control.push(ctl) %>
-
-<% end %>
-
-<% if error %>
-  <% Rails.logger.error("  RENDER TURBO STREAM HAD ERRORS, REPEATING WHOLE ARRAY: ") %>
-  <% control.each do |c| %>
-    <% Rails.logger.error("    #{c}") %>
-  <% end %>
-<% end %>