render_turbo_stream 1.4.14 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2c84aacdaefecd60e436ebd13e68801e87d02d3318ded429a643605b2ec94a3
-  data.tar.gz: 1b6089600ec4abe349d2cae88a1802f258a535e2303f9289cc29ec0e7c09bf66
+  metadata.gz: f1923db5dbed0c8a3f0cc583ba8de9469b16f0d09fdf3d46b48002ee1099537a
+  data.tar.gz: 7c2bdf446e15de06c2704311fc2725b84613592ac91827eaa4df69a51d383d1a
 SHA512:
-  metadata.gz: 83b71f6a084d9da96a09d710bc64c46506a424a8d704838ed0b91b54853cf799d3c1c336c2059bfd23f8ec70581f850c87341bbc03419efe2627c762fee94ff3
-  data.tar.gz: a623f4b6acf363a224adfbf4e4e246bec3fcd3f3cc267452ee66bb8bdd6067d0c50a94de45611edbd1640ab25c567d05a9a4853d24d2fbe885a8e2427c336454
+  metadata.gz: f2258c4ae8b77734f82837a883011591a5d6798d1110f3b63cf7ea557a3a3c60e8f5a358dd9a3dc963c02e0215979d91842d25dd94dfaf6c79e8cc3cc4483e59
+  data.tar.gz: 1495b280772066632effbc8bf484c9d5aa867e3c8fe86d745b6264fb1e0b029420be850bfe432765ade82bc0d5617fcb1dcce2ca2a5611e4c8e01b150483f5bb

data/README.md

@@ -2,17 +2,21 @@
 
 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.
+The biggest advantage of this gem is the testing strategy.
+
+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. Includes helpers for enabling request tests.
 
 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.
 
 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).
 
+A quick and dirty application with all the features, including tests, built in is [here](https://gitlab.com/sedl/renderturbostream_railsapp).
+
+Hope it can help you.
+
 ## Installation
 
 ```ruby
@@ -71,6 +75,9 @@ To get redirection and many other options working, you need to follow the instal
 
 A comprehensive tutorial on turbo and how to check that it is working properly can be found at [hotrails.dev](https://www.hotrails.dev/turbo-rails).
 
+**Turbo::StreamsChannel**
+
+The Rails team has seamlessly integrated `ActionCable` as `Turbo::StreamsChannel` into `Turbo Rails`. For installation along with this gem, see the [README](https://gitlab.com/sedl/renderturbostream/-/blob/main/README-cable.md).
 ## Usage
 
 `turbo_stream_save` is a special method for streamlining `update` or `create` functions with `turbo_stream`. A controller action for update might look like this:
@@ -140,11 +147,19 @@ render_turbo_stream(
 
 Under the hood, inside a `*.turbo_stream.erb` template, it does the following: `= turbo_stream.send args.first, *(args[1..-1])`
 
-**WORKAROUND for redirects inside frame**
+**WORKAROUNDS for redirects inside frame**
 
 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).
 
-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:
+There are two workarounds:
+
+```ruby
+config.x.render_turbo_stream.use_cable_for_turbo_stream_save = true
+```
+
+With this config, the `turbo_stream_save` method will send flash messages through `Turbo::StreamsChannel` (if installed as described above) to a channel to the currently logged in user in parallel with the redirect.
+
+Another workaround is to use the src attribute of the parent frame. `turbo_frame_set_src` comes from turbo_power. The code might look like this:
 
 ```ruby
 def update
@@ -155,9 +170,6 @@ def update
           :turbo_frame_set_src,
           'cars-box',
           cars_path
-        ],
-        [
-          #... more actions possible ...
         ]
       ]
     )

data/lib/render_turbo_stream/turbo_cable_helpers.rb

@@ -1,22 +1,62 @@
 module RenderTurboStream
-    module TurboCableHelpers
+  module TurboCableHelpers
 
+    def cable_to_all_authenticated_users
+      if user_signed_in?
 
-        def turbo_cable_to_authenticated
+      end
+    end
 
+    def cable_to_me(id, action, *args, partial: nil, locals: nil)
+      begin
+        u_id = helpers.current_user&.id
+        a=1
+        unless u_id.present?
+          Rails.logger.debug('  • SKIP RenderTurboStream.cable_to_me because current_user is nil')
+          return
         end
-
-        def turbo_cable_to_current_user(target, action, *args, partial: nil, locals: nil)
-            if [:append, :prepend, :replace].include?(action.to_sym)
-                Turbo::StreamsChannel.send("broadcast_#{action}_to", "current_user_#{helpers.current_user.id}", *args, target: target, partial: partial, locals: locals)
-            else
-                # Turbo::StreamsChannel.broadcast_action_to(
-                #   "current_user_#{helpers.current_user.id}",
-                #   action:'toggle_css_class',
-                #   'colored-element'
-                # )
+      rescue
+        Rails.logger.debug('  • ERROR RenderTurboStream.cable_to_me because current_user is not available')
+        return
+      end
+      if Rails.env.test?
+        args = {
+          target: "##{id}",
+          action: action,
+          type: 'cable-partial',
+          args: args,
+          partial: partial,
+          locals: locals
+        }
+        h = response.headers.to_h
+        i = 1
+        loop do
+            k = "test-turbo-cable-#{i}"
+            unless h.keys.include?(k)
+                response.headers[k] = args.to_json
+                break
             end
+          i += 1
         end
-
+      end
+      if [:append, :prepend, :replace].include?(action.to_sym)
+        Turbo::StreamsChannel.send(
+          "broadcast_#{action}_to",
+          "current_user_#{helpers.current_user.id}",
+          *args,
+          target: id,
+          partial: partial,
+          locals: locals&.symbolize_keys,
+          layout: false
+        )
+      else
+        # Turbo::StreamsChannel.broadcast_action_to(
+        #   "current_user_#{helpers.current_user.id}",
+        #   action:'toggle_css_class',
+        #   'colored-element'
+        # )
+      end
     end
+
+  end
 end

data/lib/render_turbo_stream/turbo_cable_view_helpers.rb

@@ -1,15 +1,27 @@
 module RenderTurboStream
   module TurboCableViewHelpers
 
-    def turbo_cable_from_current_user
+    def cable_from_me
       if current_user
         turbo_stream_from "current_user_#{current_user.id}"
+      else
+        Rails.logger.debug("  • SKIP CABLE_FROM_ME because not authenticated")
       end
     end
 
-    def turbo_cable_from_authenticated_users
+    def cable_from_all_authenticated_users
       if user_signed_in?
-        turbo_stream_from "authenticated_users"
+        turbo_stream_from "all_authenticated_users"
+      else
+        Rails.logger.debug("  • SKIP CABLE_FROM_ALL_AUTHENTICATED_USERS because not authenticated")
+      end
+    end
+
+    def local_model(object)
+      if (object.is_a?(String) && object[0..5] == 'gid://') || object.is_a?(GlobalID)
+        GlobalID::Locator.locate(object)
+      else
+        object
       end
     end
 

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "1.4.14"
+  VERSION = "2.0.0"
 end

data/lib/render_turbo_stream.rb

@@ -16,6 +16,7 @@ module RenderTurboStream
     id: nil, # if nil: no partial is rendered
     partial: nil, # example: 'customers/form' default: "#{controller_path}/#{id}"
     action: 'replace', # options: append, prepend
+    flash_action: action_name, # options: 'update', 'create', otherwise you have to declare a translation in config/locales like "activerecord.success.#{flash_action}" and "activerecord.errors.#{flash_action}"
     locals: {}, # locals used by the partial
     streams_on_success: [
       {
@@ -67,35 +68,47 @@ module RenderTurboStream
     if save_action
       flash_notices = if flashes_on_success.present?
                         flashes_on_success
-                      elsif action_name == 'create'
+                      elsif flash_action.to_s == 'create'
                         str = I18n.t(
                           'activerecord.success.successfully_created',
                           default: '%<model_name>s successfully created'
                         )
                         [format(str, model_name: model_name)]
-                      elsif action_name == 'update'
+                      elsif flash_action.to_s == 'update'
                         str = I18n.t(
                           'activerecord.success.successfully_updated',
                           default: '%<model_name>s successfully updated'
                         )
                         [format(str, model_name: model_name)]
+                      else
+                        str = I18n.t(
+                          "activerecord.success.#{flash_action}",
+                          default: '%<model_name>s successfully updated'
+                        )
+                        [format(str, model_name: model_name)]
                       end
       flash_alerts = []
     else
       flash_alerts = if flashes_on_error.present?
                        flashes_on_error
-                     elsif action_name == 'create'
+                     elsif flash_action.to_s == 'create'
                        str = I18n.t(
                          'activerecord.errors.messages.could_not_create',
                          default: '%<model_name>s could not be created'
                        )
                        [format(str, model_name: model_name)]
-                     elsif action_name == 'update'
+                     elsif flash_action.to_s == 'update'
                        str = I18n.t(
                          'activerecord.errors.messages.could_not_update',
                          default: '%<model_name>s could not be updated'
                        )
                        [format(str, model_name: model_name)]
+                     else
+                       str = I18n.t(
+                         "activerecord.errors.messages.#{flash_action}",
+                         default: '%<model_name>s could not be updated'
+                       )
+                       [format(str, model_name: model_name)]
                      end
       flash_notices = []
     end
@@ -145,10 +158,24 @@ module RenderTurboStream
                           ])
     elsif save_action && redirect_on_success_to.present?
       response.status = 302
-      flash[:alert] = flash_alerts
-      flash[:notice] = flash_notices
-      Rails.logger.debug("  • Set flash[:alert] => #{flash_alerts}") if flash_alerts.present?
-      Rails.logger.debug("  • Set flash[:notice] => #{flash_notices}") if flash_notices.present?
+      if Rails.configuration.x.render_turbo_stream.use_cable_for_turbo_stream_save && helpers.user_signed_in?
+        streams.each do |s|
+          next unless s.is_a?(Hash)
+          Rails.logger.debug("  • Send by Cable => «#{s}»")
+          cable_to_me(
+            s[:id],
+            :prepend,
+            partial: s[:partial],
+            locals: s[:locals]
+          )
+        end
+
+      else
+        flash[:alert] = flash_alerts
+        flash[:notice] = flash_notices
+        Rails.logger.debug("  • Set flash[:alert] => #{flash_alerts}") if flash_alerts.present?
+        Rails.logger.debug("  • Set flash[:notice] => #{flash_notices}") if flash_notices.present?
+      end
       redirect_to redirect_on_success_to
 
     else
@@ -184,6 +211,7 @@ module RenderTurboStream
     if request.format.to_sym == :turbo_stream
       render template: 'render_turbo_stream', locals: { streams: ary }, layout: false, formats: :turbo_stream
     else
+      Rails.logger.debug("  • Render Turbo Stream RENDERING AS HTML because request.format => #{request.format}")
       render template: 'render_turbo_stream', locals: { streams: ary }, layout: false, formats: :html
     end
   end
@@ -209,7 +237,24 @@ module RenderTurboStream
   class Libs
     def self.all_responses(response)
       e = Nokogiri::HTML(response.body).search('#rendered-partials').first
-      JSON.parse(e.inner_html)
+      if e.present?
+        res = JSON.parse(e.inner_html)
+      else
+        res = []
+      end
+      cables = response.headers.to_h.select { |k| k.match(/^test-turbo-cable-[\d]+$/) }
+      cables.each do |k, v|
+        args = JSON.parse(v)
+        html = ApplicationController.render(partial: args['partial'], locals: args['locals'].symbolize_keys)
+        res.push(
+          args.merge(
+            {
+              'html_response' => html,
+            }
+          )
+        )
+      end
+      res
     end
 
     # if partial is one word, its checked against the last behind the slash, example: 'articles/form' matches 'form'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 1.4.14
+  version: 2.0.0
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-29 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails