render_turbo_stream 1.4.9 → 1.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9b6a483735fb6cb6abf28e28da8a18993727faaa76f22c77a52e99b5df3f738
-  data.tar.gz: 0773d821f8a94b1094cdd99054365ad2792b006be27fc93445e379e8d8bb46a2
+  metadata.gz: 6aaffdee6cb866e03e20f1b6d46e00d187e9f7a63b0d5f26c29b4615fae7b483
+  data.tar.gz: b031dbf2eac68543ddf75de146c58715abaf3e6c6e9852119e3beb4f049832cc
 SHA512:
-  metadata.gz: 96637194a72cfc53cc649056021967e107a150bfb702b7ad951c611c23fab424c72554c9b1aea6d82606546a4342259c797a38c4a08405ceed568869e62acba0
-  data.tar.gz: 4008a55b80afe4b2493d3fa980213554f501c39bdda1aa1cd15a6522876198f987aff0a65e83f1e0ea754f13be31938f17bbcbadc06efe570b7a25f59e0b95c2
+  metadata.gz: cec6a8701b17aabe2d76006771bd0441f28617a80bc16e9987d5334c84742d5df93471a7fb89d474b071fa2bd4f2391c78ea96abc3d8da8bc206198cf0268f64
+  data.tar.gz: 77afb83d8a217eca87b53cfa0aee768cdd8272052540758976c266d72f7d532119e9260473d761743b57de64e252ba41c48ef927685ee90122a0ee0300749a46

data/README.md

@@ -48,7 +48,7 @@ config.x.render_turbo_stream.flash_id = 'flash-box'
 config.x.render_turbo_stream.flash_action = 'prepend'
 ```
 
-The corresponding partials for flashes could look [like this](https://gitlab.com/sedl/renderturbostream/-/wikis/flashes)
+The corresponding partials for flashes could look [like this](https://gitlab.com/sedl/renderturbostream/-/wikis/Flashes-example)
 
 **Translations**
 
@@ -81,6 +81,8 @@ def update
   turbo_stream_save(
     @customer.update(customer_params),
     turbo_redirect_on_success_to: edit_customer_path(@customer),
+    id: 'customer-form',
+    partial: 'form'
   )
 end
 ```
@@ -91,7 +93,7 @@ This will set a status, generate a flash message and perform `render_turbo_strea
 render_turbo_stream(
   [
     {
-      id: 'form',
+      id: 'customer-form',
       partial: 'customers/form'
     },
     {
@@ -103,7 +105,7 @@ render_turbo_stream(
 )
 ```
 
-The `stream_partial` method is just for rendering a partial alone.
+The `stream_partial` method is for rendering a partial alone.
 
 ```ruby
 stream_partial(
@@ -118,7 +120,7 @@ stream_partial(
 
 **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:
+`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:
 
 ```ruby
 render_turbo_stream(
@@ -140,13 +142,12 @@ Under the hood, inside a `*.turbo_stream.erb` template, it does the following: `
 
 **WORKAROUND for redirects inside frame**
 
-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).
+Suppose you have a CRUD controller that should do all its actions inside a turbo frame. Classic redirect_to, together with a turbo_stream action on the same response, 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:
+A workaround is to use the src attribute of the parent frame. `turbo_frame_set_src` comes from turbo_power. The code could look like this:
 
 ```ruby
 def update
-    @car = Car.find(params['id'])
     turbo_stream_save(
       @car.update(car_params),
       streams_on_success: [
@@ -154,6 +155,9 @@ def update
           :turbo_frame_set_src,
           'cars-box',
           cars_path
+        ],
+        [
+          #... more actions possible ...
         ]
       ]
     )

data/app/views/render_turbo_stream.turbo_stream.erb

@@ -7,25 +7,22 @@
   <% if args.is_a?(Array) %>
 
     <% ctl = "turbo_stream.#{args.first}, #{args[1..-1].join(', ')}" %>
-    <% Rails.logger.debug("  RENDER TURBO STREAM => #{ctl}") %>
+    <% Rails.logger.debug("  • render-turbo-stream => #{ctl}") %>
     <%= turbo_stream.send args.first, *(args[1..-1]) %>
 
 
   <% 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? %>
+    <% if 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}") %>
+      <% Rails.logger.error("  ERROR RENDER TURBO STREAM => MISSING ACTION => #{args}") %>
+      <% error = true %>
     <% end %>
   <% end %>
 

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "1.4.9"
+  VERSION = "1.4.11"
 end

data/lib/render_turbo_stream.rb

@@ -159,10 +159,9 @@ module RenderTurboStream
 
     ary = []
     array.each do |pr|
-      if !pr.present?
-        a = 1
-      elsif pr.is_a?(Hash)
+      if pr.is_a?(Hash)
         props = pr.symbolize_keys
+        raise "missing attribute :id in #{props}" if !props[:id].present?
         part = (props[:partial].present? ? props[:partial] : props[:id]).gsub('-', '_')
         partial = (part.to_s.include?('/') ? part : [controller_path, part].join('/'))
         r = props
@@ -170,6 +169,7 @@ module RenderTurboStream
         r[:partial] = partial
         ary.push(r)
       elsif pr.is_a?(Array)
+        raise "array has to contain at least one element: #{pr}" unless pr.first.present?
         ary.push(pr)
       else
         raise "ERROR render_turbo_stream invalid type: Only hash or array allowed"
@@ -289,7 +289,7 @@ module RenderTurboStream
         :append,
         :prepend
       ]
-      (config.present? ? config : default).map{|m|m.to_sym}.include?(method.to_sym)
+      (config.present? ? config : default).map { |m| m.to_sym }.include?(method.to_sym)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 1.4.9
+  version: 1.4.11
 platform: ruby
 authors:
 - christian
@@ -72,6 +72,6 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Render partials and run javascripts directly from the controller. With test
+summary: Run javascripts and render partials directly from the controller. With test
   helpers.
 test_files: []