render_turbo_stream 1.4.13 → 1.4.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7bcd60dee638218b100db8304ddda17a1d7c87df5c46d721cb541913a424abc
-  data.tar.gz: 6e606363c60175378ac3cf4a652560d44e5d3b49d98a77c6a0557ff679df67fa
+  metadata.gz: ddf2d67786644e4776a58ead9c9bd705d54aa20e6c2a7f2a50383bcc59eacbc4
+  data.tar.gz: e5dce474494ad9076d96390ef06fca96b7303e821d2326e6d7b4a4b737f96670
 SHA512:
-  metadata.gz: e7ca3b5b395709063ebd1c30577280527e064bff16e9dc4bcf114a1a0d1a60bda33bfe105a76f0f497a8fcc39fcf59cc0f877ca05a7688666d228fa577f9d85d
-  data.tar.gz: 0704ce40c37540bd5135f108668348b4b86fc21cef1d8a5e94ee41a7f5e1da593fd2ec82ea9b3f7e9d7a0c47e8432716cd094beb3dcb1de2e133487d146b047c
+  metadata.gz: c86bcd83fb42ebd8286c981e3a1d80d7b37d8ab3ae524f91679a2a3734429692cb3be356199252bbabb9161d056214fd7a63454095259b8cc95ba9bd62eb341e
+  data.tar.gz: 8330c7f4b8d178d68a7be8f8b54d76a6de88676c17178a2e46878934d2c3ecedac4bc968ffa78828e7fa6288324551698f5def18aff073883de0ab3fee42d63a

data/README.md

@@ -155,9 +155,6 @@ def update
           :turbo_frame_set_src,
           'cars-box',
           cars_path
-        ],
-        [
-          #... more actions possible ...
         ]
       ]
     )
@@ -165,6 +162,17 @@ def update
 
 ```
 
+**Turbo::StreamsChannel**
+
+Another workaround as described above, but with more advantages, is to use Turbo Streams, which are seamlessly integrated into `turbo rails`. See the [README](https://gitlab.com/sedl/renderturbostream/-/blob/main/README-cable.md).
+If setup well and configured by
+
+```ruby
+config.x.render_turbo_stream.use_cable = true
+```
+
+The `turbo_stream_save` method, in the case of classical redirects (by redirect_to), would send the flashes plus additional partials, declared on arguments by `Turbo::StreamsChannel` in parallel to the redirect.
+
 **Parameters for turbo_stream_save**
 
     save_action,

data/app/models/render_turbo_stream/cable_stream.rb

@@ -0,0 +1,4 @@
+module RenderTurboStream
+  class CableStream < ApplicationRecord
+  end
+end

data/db/migrate/20230428115511_cable_streams.rb

@@ -0,0 +1,4 @@
+class CableStreams < ActiveRecord::Migration[7.0]
+  def change
+  end
+end

data/db/migrate/20230428115724_create_render_turbo_stream_cable_streams.rb

@@ -0,0 +1,11 @@
+class CreateRenderTurboStreamCableStreams < ActiveRecord::Migration[7.0]
+  def change
+    create_table :render_turbo_stream_cable_streams do |t|
+      t.string :request_id, limit: 80
+      t.text :locals
+      t.string :action, limit: 80
+      t.string :arguments
+      t.timestamps
+    end
+  end
+end

data/lib/render_turbo_stream/turbo_cable_helpers.rb

@@ -0,0 +1,51 @@
+module RenderTurboStream
+  module TurboCableHelpers
+
+    def turbo_cable_to_authenticated
+      if user_signed_in?
+
+      end
+    end
+
+    def turbo_cable_to_current_user(target, action, *args, partial: nil, locals: nil)
+      if Rails.env.test?
+        args = {
+          target: target,
+          action: action,
+          type: 'turbo-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: target,
+          partial: partial,
+          locals: locals,
+          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

@@ -0,0 +1,17 @@
+module RenderTurboStream
+  module TurboCableViewHelpers
+
+    def turbo_cable_from_current_user
+      if current_user
+        turbo_stream_from "current_user_#{current_user.id}"
+      end
+    end
+
+    def turbo_cable_from_authenticated_users
+      if user_signed_in?
+        turbo_stream_from "authenticated_users"
+      end
+    end
+
+  end
+end

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "1.4.13"
+  VERSION = "1.4.15"
 end

data/lib/render_turbo_stream.rb

@@ -3,6 +3,8 @@ require "render_turbo_stream/railtie"
 require 'render_turbo_stream/engine'
 require 'render_turbo_stream/test/request_helpers'
 require 'render_turbo_stream/test/rspec_request_helpers'
+require 'render_turbo_stream/turbo_cable_helpers'
+require 'render_turbo_stream/turbo_cable_view_helpers'
 
 module RenderTurboStream
 
@@ -14,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: [
       {
@@ -65,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
@@ -143,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 && helpers.user_signed_in?
+        streams.each do |s|
+          next unless s.is_a?(Hash)
+          Rails.logger.debug("  • Send by Cable => «#{s}»")
+          turbo_cable_to_current_user(
+            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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 1.4.13
+  version: 1.4.15
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,13 +38,18 @@ files:
 - README.md
 - Rakefile
 - app/controllers/render_turbo_stream/application_controller.rb
+- app/models/render_turbo_stream/cable_stream.rb
 - app/views/render_turbo_stream.html.erb
 - app/views/render_turbo_stream.turbo_stream.erb
+- db/migrate/20230428115511_cable_streams.rb
+- db/migrate/20230428115724_create_render_turbo_stream_cable_streams.rb
 - lib/render_turbo_stream.rb
 - lib/render_turbo_stream/engine.rb
 - lib/render_turbo_stream/railtie.rb
 - lib/render_turbo_stream/test/request_helpers.rb
 - lib/render_turbo_stream/test/rspec_request_helpers.rb
+- lib/render_turbo_stream/turbo_cable_helpers.rb
+- lib/render_turbo_stream/turbo_cable_view_helpers.rb
 - lib/render_turbo_stream/version.rb
 - lib/tasks/render_turbo_stream_tasks.rake
 homepage: https://gitlab.com/sedl/renderturbostream