render_turbo_stream 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd9433b4adbd71cc1c6200b10b969c3692772f4cc8a4b21e0e02948e58104a3a
-  data.tar.gz: 21f9ba3336cdc8875300738885eee417a971fe4f6364c81ca9e772579ba80f10
+  metadata.gz: 7737e1e5b1a6b397c22634b0a7efe6ee3f5d550a041fc667323c3b91dc5bf31b
+  data.tar.gz: a254e95ff504444aec88dfb25bfeb24c30f10447b2f47bfe7ff40ef57bb3ed0b
 SHA512:
-  metadata.gz: e50b4ec7e474c6f8c4476f49eb97e6d1088308182d1b3d9d7ecb31fcbc491a940b6cf71046c4626cca36f8234e3008fc09b8bf6ae8ac12473ca04c795cf8faea
-  data.tar.gz: a5c91d74dce4bc5031da22fa702a74d3a8e5eff0aa19ed7bdd7296a9dc6e369c0e7a51cdfb964c316a4f3bddc12c3635af557113ae1d96d7f67d4715fb16cced
+  metadata.gz: 5d1c9a165d5471062752980dc3af0c9cd87908d16e37f000953aceb78c23f458ec5bd6585ec571068572479c7b088b9d6a442f5f993f05f03a8f46d6cc4cf518
+  data.tar.gz: 6db4979439d1399e40f1c786f8f4c78de5828aa4c310810bd4950928acb41cf8db6662ba238c7776337161d76d9139b180d8737bd042329854d8e4f3d366c690

data/README.md

@@ -4,6 +4,8 @@ Defining templates like `(create|update).turbo_stream.haml` annoyed me.
 
 Working consistently with turbo_stream means shooting lots of partials from the backend to the frontend. This always requires the same attributes: the path to the partial, the html-id that turbo_stream points to, and maybe some locals. This gem serialises that: Partials can be controlled directly from the controller. It sets the status, generates a flash message, handles redirection, pushes it all to the front and comes with predefined helpers for enabling request-specs.
 
+And build it dynamically: Most [turbo_power](https://github.com/marcoroth/turbo_power) commands, such as adding a css class to an html element or pushing a state to the browser history, work directly from the controller. Since turbo allows it, custom javascript functions are also possible.
+
 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).
 
@@ -62,10 +64,10 @@ def update
 end
 ```
 
-This will set a status, generate a flash message and perform `stream_partials`, which could result in something like this:
+This will set a status, generate a flash message and perform `render_turbo_stream`, which could result in something like this:
 
 ```ruby
-stream_partials(
+render_turbo_stream(
   [
     {
       id: 'form',
@@ -80,7 +82,7 @@ stream_partials(
 )
 ```
 
-The `stream_partial` method is nothing else than a singular of `stream_partials`.
+The `stream_partial` method is nothing else than a singular of `render_turbo_stream`.
 
 **locals**: The hash for locals goes through a `symbolize_keys`, so you need to use locals in used partials like this: `locals[:message]`.
 
@@ -93,13 +95,39 @@ 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 should allow you to perform most actions from, for example, [turbo_power](https://github.com/marcoroth/turbo_power). An example of rendering a partial and adding a css class to an html element would look like this:
+
+```ruby
+render_turbo_stream(
+  [
+    {
+      id: 'form',
+      partial: 'form'
+    },
+    [
+      :add_css_class,
+      '#colored-element',
+      'red'
+    ]
+  ]
+)
+```
+
+which is done under the hood, for the array: `= turbo_stream.send args.first, *(args[1..-1])`
+
+
 ## Testing Scenarios
 
 For system testing there is Capybara. Its the only way to check if frontend and backend work together. But its a good practice to break tests into smaller pieces. The much larger number of tests we will write on the much faster request tests, examples here in rspec.
 
 If the request format is not `turbo_stream`, which is the case on request specs, the method responds in a special html
-that contains the medadata that is interesting for our tests and is parsed by included test helpers. So tests could look
-like this:
+that contains the medadata that is interesting for our tests and is parsed by included test helpers. 
+
+There is a helper for writing the test: In the debugger, within the test, check the output of `partials_log`.
+
+Test scenarios are:
 
 **The fastest**
 
@@ -143,9 +171,7 @@ expect(partial_response('articles/form', id: 'form', css: '.field_with_errors',
 
 **More detailed**
 
-Consider a controller action that should respond in 2 flashes.
-
-Helper for writing the test: On Debugger, inside the test, check the output of `partials_log`.
+Consider a controller action that should respond in 2 flashes:
 
 ```ruby
 expect(partials_count).to eq(1)

data/app/views/render_turbo_stream.html.erb

@@ -0,0 +1,16 @@
+<% 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] }) %>
+  <% else %>
+    <% html = (render s[:partial], locals: s[:locals]&.symbolize_keys, formats: [:html]) %>
+    <% rendered_partials.push({ html_response: html }.merge(s)) %>
+  <% end %>
+
+
+<% end %>
+
+<%= content_tag :div, rendered_partials.to_json, id: 'rendered-partials' %>
+

data/app/views/render_turbo_stream.turbo_stream.erb

@@ -0,0 +1,41 @@
+<% 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(', ')}" %>
+    <% Rails.logger.error("  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? %>
+      <% 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 %>

data/lib/render_turbo_stream/test/request_helpers.rb

@@ -34,9 +34,18 @@ module RenderTurboStream
 
       # Returns the path to which turbo_stream.redirect_to would be applied.
       def turbo_redirect_to
-        expect(response.status).to eq(302)
-        r = JSON.parse(response.body)
-        r['redirected_to']
+        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
+            end
+          end
+        end
+        url
       end
 
       def partial_response_count(partial, id: nil, total: 1, &block)

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/render_turbo_stream.rb

@@ -126,52 +126,42 @@ module RenderTurboStream
       response.status = 302
       flash[:alert] = flash_alerts
       flash[:notice] = flash_notices
-      if request.format.to_sym == :turbo_stream
-        render template: 'render_turbo_stream_redirect', locals: { url: redirect_on_success_to }, layout: false
-      else
-        render json: { redirected_to: redirect_on_success_to }
-      end
+        render_turbo_stream([
+                          [
+                            :redirect_to,
+                            redirect_on_success_to
+                          ]
+                        ])
     else
       flash.now[:alert] = flash_alerts
       flash.now[:notice] = flash_notices
-      stream_partials(streams)
+      render_turbo_stream(streams)
     end
   end
 
-  def stream_partials(array)
+  def render_turbo_stream(array)
 
     ary = []
-    array.dup.each do |pr|
-      props = pr.symbolize_keys
-      part = (props[:partial].present? ? props[:partial] : props[:id]).gsub('-', '_')
-      partial = (part.to_s.include?('/') ? part : [controller_path, part].join('/'))
-      r = props
-      r[:action] = (props[:action].present? ? props[:action] : :replace)
-      r[:partial] = partial
-      ary.push(r)
+    array.each do |pr|
+      if pr.is_a?(Hash)
+        props = pr.symbolize_keys
+        part = (props[:partial].present? ? props[:partial] : props[:id]).gsub('-', '_')
+        partial = (part.to_s.include?('/') ? part : [controller_path, part].join('/'))
+        r = props
+        r[:action] = (props[:action].present? ? props[:action] : :replace)
+        r[:partial] = partial
+        ary.push(r)
+      elsif pr.is_a?(Array)
+        ary.push(pr)
+      else
+        raise "ERROR render_turbo_stream invalid type: Only hash or array allowed"
+      end
     end
 
     if request.format.to_sym == :turbo_stream
-      render template: 'render_turbo_stream_partials', locals: { streams: ary }, layout: false
+      render template: 'render_turbo_stream', locals: { streams: ary }, layout: false, formats: :turbo_stream
     else
-      if Rails.env.test?
-        check_ids = {}
-        ary.each do |a|
-          if a[:action] == 'replace'
-            check_ids[a[:id]] ||= 0
-            check_ids[a[:id]] += 1
-            throw "More than one partial rendered to ID «#{a[:id]}» by replace" if check_ids[a[:id]] >= 2
-          end
-        end
-      end
-      check = {}
-      ary.each do |a|
-        b = a.dup
-        b.delete(:id)
-        check[a[:id]] = b
-      end
-      # render json: check
-      render template: 'render_turbo_stream_partials', locals: { check: check, streams: ary }, layout: false, formats: :html
+      render template: 'render_turbo_stream', locals: { streams: ary }, layout: false, formats: :html
     end
   end
 
@@ -181,7 +171,7 @@ module RenderTurboStream
     action: :replace,
     locals: {}
   )
-    stream_partials(
+    render_turbo_stream(
       [
         {
           id: id,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,10 +24,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.4.3
-description: 'Writing views like (create|update).turbo_stream.haml annoyed me. This
+description: Writing views like (create|update).turbo_stream.haml annoyed me. This
   gem handles translated flash messages, sets status, and renders partials through
-  turbo-stream. You can control them directly from the controller. It also handles
-  redirection: turbo_power is included. Includes helpers for enabling request testing.'
+  turbo-stream. You can control it directly from the controller. With the turbo_power
+  gem you can also handle predefined actions like redirects and much more. Includes
+  helpers for enabling request testing.
 email:
 - christian@sedlmair.ch
 executables: []
@@ -37,9 +38,8 @@ files:
 - README.md
 - Rakefile
 - app/controllers/render_turbo_stream/application_controller.rb
-- app/views/render_turbo_stream_partials.html.erb
-- app/views/render_turbo_stream_partials.turbo_stream.erb
-- app/views/render_turbo_stream_redirect.turbo_stream.erb
+- app/views/render_turbo_stream.html.erb
+- app/views/render_turbo_stream.turbo_stream.erb
 - lib/render_turbo_stream.rb
 - lib/render_turbo_stream/engine.rb
 - lib/render_turbo_stream/railtie.rb
@@ -72,6 +72,6 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Render partials by turbo-stream directly from the controller. Test helpers
-  included.
+summary: Render partials or performing javascript actions by turbo-stream directly
+  from the controller. Test helpers included.
 test_files: []

data/app/views/render_turbo_stream_partials.html.erb

@@ -1,12 +0,0 @@
-<% rendered_partials = [] %>
-
-<% streams.each do |s| %>
-
-  <% html = (render s[:partial], locals: s[:locals]&.symbolize_keys, formats: [:html]) %>
-
-  <% rendered_partials.push({ html_response: html }.merge(s)) %>
-
-<% end %>
-
-<%= content_tag :div, rendered_partials.to_json, id: 'rendered-partials' %>
-

data/app/views/render_turbo_stream_partials.turbo_stream.erb

@@ -1,52 +0,0 @@
-<% error = false %>
-<% control = [] %>
-<% local_assigns[:streams].each do |s| %>
-  <% ctl = { partial: s[:partial], id: s[:id] } %>
-  <% info = { id: s[:id], partial: s[:partial], locals: s[:locals] } %>
-
-  <% if !s[:id] %>
-    <% Rails.logger.error("  ERROR RENDER TURBO STREAM => MISSING ID => #{s}") %>
-    <% error = true %>
-
-  <% elsif !s[:partial].present? %>
-    <% Rails.logger.error("  ERROR RENDER TURBO STREAM => MISSING PARTIAL => #{s}") %>
-    <% error = true %>
-    <% ctl[:partial] = nil %>
-
-  <% elsif s[:action].to_sym == :replace %>
-    <% ctl[:action] = :replace %>
-    <% Rails.logger.debug("  • render-turbo-stream REPLACE => #{info}") %>
-    <%= turbo_stream.replace s[:id] do %>
-      <%= render s[:partial], locals: s[:locals]&.symbolize_keys %>
-    <% end %>
-
-  <% elsif s[:action].to_sym == :prepend %>
-    <% ctl[:action] = :prepend %>
-    <% Rails.logger.debug("  • render-turbo-stream PREPEND => #{info}") %>
-    <%= turbo_stream.prepend s[:id] do %>
-      <%= render s[:partial], locals: s[:locals]&.symbolize_keys %>
-    <% end %>
-
-  <% elsif s[:action].to_sym == :append %>
-    <% ctl[:action] = :append %>
-    <% Rails.logger.debug("  • render-turbo-stream APPEND => #{info}") %>
-    <%= turbo_stream.prepend s[:id] do %>
-      <%= render s[:partial], locals: s[:locals]&.symbolize_keys %>
-    <% end %>
-
-  <% else %>
-    <% ctl[:action] = :UNKNOWN %>
-    <% Rails.logger.fatal("  ERROR render-turbo-stream => UNKNOWN ACTION => #{s}") %>
-    <% error = true %>
-  <% 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 %>

data/app/views/render_turbo_stream_redirect.turbo_stream.erb

@@ -1 +0,0 @@
-<%= turbo_stream.redirect_to local_assigns[:url] %>