render_turbo_stream 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1923db5dbed0c8a3f0cc583ba8de9469b16f0d09fdf3d46b48002ee1099537a
-  data.tar.gz: 7c2bdf446e15de06c2704311fc2725b84613592ac91827eaa4df69a51d383d1a
+  metadata.gz: 9858266fb82670a9ef99550a3acb17c4d744299969634a16dc34f05a62b6e5e7
+  data.tar.gz: 445dd3768ef6674b7286fb55d7738f9c112c31f5d57841f8fb8b4390c64b31af
 SHA512:
-  metadata.gz: f2258c4ae8b77734f82837a883011591a5d6798d1110f3b63cf7ea557a3a3c60e8f5a358dd9a3dc963c02e0215979d91842d25dd94dfaf6c79e8cc3cc4483e59
-  data.tar.gz: 1495b280772066632effbc8bf484c9d5aa867e3c8fe86d745b6264fb1e0b029420be850bfe432765ade82bc0d5617fcb1dcce2ca2a5611e4c8e01b150483f5bb
+  metadata.gz: dae6e979f4abed3f7b287a9fe5d39d8a2b3c7d0e92f4048d1bc551ddedfd39fd365c26cc8bf7be1c67d6e21a63f22670107e292ba50728db824c09ed48cbaf91
+  data.tar.gz: 1c5feab440874cc4f8e75324b60c1f352eb4a0cc54a38ff55598250f898e02bd5fbe454ea68fb6542a12f3b6c1eeab8493a2f7c146861c3010295eaedb58a7c2

data/README.md

@@ -1,8 +1,6 @@
 # RenderTurboStream
 
-Defining templates like `(create|update).turbo_stream.haml` annoyed me.
-
-The biggest advantage of this gem is the testing strategy.
+Defining templates like `(create|update).turbo_stream.haml` annoyed me and I was looking for a 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.
 

data/app/controllers/render_turbo_stream/render_turbo_stream_render_controller.rb

@@ -0,0 +1,4 @@
+module RenderTurboStream
+  class RenderTurboStreamRenderController < ActionController::Base
+  end
+end

data/lib/render_turbo_stream/turbo_cable_helpers.rb

@@ -1,61 +1,70 @@
 module RenderTurboStream
   module TurboCableHelpers
 
-    def cable_to_all_authenticated_users
-      if user_signed_in?
+    # def cable_partial_to_all_authenticated_users
+    #   raise "Function cable_partial_to_all_authenticated_users is "
+    #   if user_signed_in?
+    #
+    #   end
+    # end
 
-      end
-    end
+    def cable_partial_to_channel(action, channel, partial, id, locals: nil)
 
-    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
-      rescue
-        Rails.logger.debug('  • ERROR RenderTurboStream.cable_to_me because current_user is not available')
-        return
-      end
+      # add headers for test
       if Rails.env.test?
         args = {
           target: "##{id}",
           action: action,
           type: 'cable-partial',
-          args: args,
           partial: partial,
           locals: locals
         }
+        html = RenderTurboStreamRenderController.render(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
+          k = "test-turbo-cable-#{i}"
+          unless h.keys.include?(k)
+            response.headers[k] = args.to_json
+            response.headers["#{k}-html"] = html.to_s
+            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'
-        # )
+
+      # send
+
+      Turbo::StreamsChannel.send(
+        "broadcast_#{action}_to",
+        channel.to_s,
+        target: id,
+        partial: partial,
+        locals: locals&.symbolize_keys,
+        layout: false
+      )
+    end
+
+    def cable_partial_to_me(partial, id, action: :replace, locals: nil)
+      begin
+        u_id = helpers.current_user&.id
+        a=1
+        unless u_id.present?
+          Rails.logger.debug('  • SKIP RenderTurboStream.cable_partial_to_me because current_user is nil')
+          return
+        end
+      rescue
+        Rails.logger.debug('  • ERROR RenderTurboStream.cable_partial_to_me because current_user is not available')
+        return
       end
+
+      cable_partial_to_channel(
+        action,
+        "current_user_#{helpers.current_user.id}",
+        partial,
+        id,
+        locals: locals
+        )
     end
 
   end

data/lib/render_turbo_stream/turbo_cable_view_helpers.rb

@@ -9,12 +9,16 @@ module RenderTurboStream
       end
     end
 
-    def cable_from_all_authenticated_users
-      if user_signed_in?
-        turbo_stream_from "all_authenticated_users"
-      else
-        Rails.logger.debug("  • SKIP CABLE_FROM_ALL_AUTHENTICATED_USERS because not authenticated")
-      end
+    # def cable_from_all_authenticated_users
+    #   if user_signed_in?
+    #     turbo_stream_from "all_authenticated_users"
+    #   else
+    #     Rails.logger.debug("  • SKIP CABLE_FROM_ALL_AUTHENTICATED_USERS because not authenticated")
+    #   end
+    # end
+
+    def cable_from_all
+        turbo_stream_from "all"
     end
 
     def local_model(object)

data/lib/render_turbo_stream/version.rb

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

data/lib/render_turbo_stream.rb

@@ -162,10 +162,10 @@ module RenderTurboStream
         streams.each do |s|
           next unless s.is_a?(Hash)
           Rails.logger.debug("  • Send by Cable => «#{s}»")
-          cable_to_me(
+          cable_partial_to_me(
+            s[:partial],
             s[:id],
-            :prepend,
-            partial: s[:partial],
+            action: flash_action,
             locals: s[:locals]
           )
         end
@@ -245,7 +245,8 @@ module RenderTurboStream
       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)
+        #html = ApplicationController.render(partial: args['partial'], locals: args['locals'].symbolize_keys)
+        html = response.headers["#{k}-html"]
         res.push(
           args.merge(
             {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - christian
@@ -24,11 +24,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.4.3
-description: This gem handles translated flash messages, sets status, and renders
-  partials via turbo-stream directly from the controller. No need to write *.turbo_stream.*
-  templates. Together with the turbo_power gem or custom turbo-stream actions, you
-  can run javascript. Redirects can now be handled easily and in multiple ways. Includes
-  helpers for enabling request tests.
+description: Handles translated flash messages, sets status, and renders partials
+  via Turbo Stream or Turbo::StreamsChannel directly from the controller. No need
+  to write *.turbo_stream.* templates. Together with the turbo_power gem or custom
+  turbo-stream actions, you can run javascript. Redirects can now be handled easily
+  and in multiple ways. Includes helpers for enabling request tests.
 email:
 - christian@sedlmair.ch
 executables: []
@@ -38,6 +38,7 @@ files:
 - README.md
 - Rakefile
 - app/controllers/render_turbo_stream/application_controller.rb
+- app/controllers/render_turbo_stream/render_turbo_stream_render_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