render_turbo_stream 4.3.17 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91ec62a537df4902f5adcf7caf65a6b6a098365d2c983cda574a2d9ab1ffd22e
-  data.tar.gz: 28b80ad8d49000bc97b8b4fb0d66e1810befd61f0812aeb00712f8836d2dca3d
+  metadata.gz: 2cfb040091b3e5fcee2eb48a126e707316ff2e88f56d5375cf491df3ec7008af
+  data.tar.gz: 0deefe1b7acb1528606695a512eaa596fc6d31c4874807398484213e22eef7e0
 SHA512:
-  metadata.gz: 343b599092acb9ccb1dc2f046175af02a6771696f0883f573b9f5f99e3891ff86fe6064510e761a05deba57feb814d0a473da61f8842eea0ea4642fc16d33996
-  data.tar.gz: ea135fc6460784cf9a2a7c5f738fe37e639e23645577b53b5e761443ca20bca141167eb6d68a8adcf466b7f90e4c4caea8aef55ba4838c3f29b9231670fd7139
+  metadata.gz: c7c1f91debd98ecede2af7bdab72cebea1218d2a47f80c5eb2e27872f54b9c93668ab37ad34721836f8f65b65c6a8fe06a175e666aff3b60c870f3a0449b50a0
+  data.tar.gz: 10e8f7ba4a595c97db9762747938e456e3c57df9bdaebcb44daa50f293c3f93bbfc5051f7739709577fb3281328d9f6c719481091fa66f3a769600be024ec35e

data/lib/render_turbo_stream/channel.rb

@@ -0,0 +1,43 @@
+class Channel
+
+  def initialize(channel, partial: nil, template: nil, target_id: nil, action: :replace)
+    @channel = channel
+    @partial = partial
+    @template = template
+    @target_id = target_id
+    @action = action
+    @test_responses = []
+  end
+
+  def target_id=(target_id)
+    @target_id = target_id
+  end
+
+  def action=(action)
+    @action = action
+  end
+
+  def send(locals: {})
+    libs = RenderTurboStream::ChannelLibs.new
+    libs.render_to_channel(
+      @channel,
+      RenderTurboStream::Libs.target_id_to_target(@target_id),
+      @action,
+      template: @template,
+      partial: @partial,
+      locals: locals
+    )
+    @test_responses = libs.test_responses
+  end
+
+  def test_responses
+    @test_responses
+  end
+
+  private
+
+  def validate_params
+    raise 'Arguments partial and template cannot both be specified' if @partial && @template
+  end
+
+end

data/lib/render_turbo_stream/{controller_channel_helpers.rb → channel_controller_helpers.rb}

@@ -1,8 +1,8 @@
 module RenderTurboStream
-  module ControllerChannelHelpers
+  module ChannelControllerHelpers
 
     def render_to_all(target_id = nil, action = :replace, partial: nil, template: nil, locals: nil)
-      #evaluate_instance_variables
+      # evaluate_instance_variables
       render_to_channel(
         'all',
         target_id,
@@ -55,7 +55,7 @@ module RenderTurboStream
       )
     end
 
-    def render_to_channel(channel, target_id = nil, action = :replace, partial: nil, template: nil, locals: nil, instance_variables: true)
+    def render_to_channel(channel, target_id = nil, action = :replace, partial: nil, template: nil, locals: nil)
 
       raise 'Arguments partial and template cannot both be specified' if partial && template
 
@@ -76,18 +76,21 @@ module RenderTurboStream
         @render_cable_template_was_called = true
       end
 
-      #evaluate_instance_variables
+      # evaluate_instance_variables
 
-      libs = RenderTurboStream::ChannelLibs.new(response)
-      libs.render_to_channel(
+      libs = RenderTurboStream::ChannelLibs.new
+      loc = fetch_instance_variables(locals, _partial, _template, action)
+      res = libs.render_to_channel(
         channel,
         RenderTurboStream::Libs.target_id_to_target(target_id),
         action,
-        self,
         template: _template,
-        partial: _partial, locals: locals
+        partial: _partial,
+        locals: loc
       )
+      RenderTurboStream::Libs.set_test_responses(response, libs.test_responses)
 
+      res
     end
 
     def action_to_all(action, *arguments)
@@ -127,8 +130,10 @@ module RenderTurboStream
     end
 
     def action_to_channel(channel, command, arguments)
-      libs = RenderTurboStream::ChannelLibs.new(response)
-      libs.action_to_channel(channel, command, arguments)
+      libs = RenderTurboStream::ChannelLibs.new
+      r = libs.action_to_channel(channel, command, arguments)
+      RenderTurboStream::Libs.set_test_responses(response, libs.test_responses)
+      r
     end
 
     def turbo_channel_save(
@@ -146,8 +151,7 @@ module RenderTurboStream
       add_notices: nil, # array of strings
       add_alerts: nil,
 
-      flash_controller_action_name: action_name, # options: 'update', 'create', otherwise you have to declare a translation in config/locales like "activerecord.success.#{flash_controller_action_name}" and "activerecord.errors.#{flash_controller_action_name}"
-      instance_variables: true # options: if false, nothing happens, if true: Instance variables that matching to controller name like @article or @articles are set to locals. By Array you can add more, example: [:my_var]
+      flash_controller_action_name: action_name # options: 'update', 'create', otherwise you have to declare a translation in config/locales like "activerecord.success.#{flash_controller_action_name}" and "activerecord.errors.#{flash_controller_action_name}"
     )
 
       # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
@@ -199,13 +203,13 @@ module RenderTurboStream
       #==                      RENDER TO CHANNEL
       # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
-      libs = RenderTurboStream::ChannelLibs.new(response)
+      libs = RenderTurboStream::ChannelLibs.new
       if (helpers.current_user.id rescue false)
         libs.send_actions_to_channel(
           "authenticated_user_#{helpers.current_user.id}",
-          turbo_actions,
-          instance_variables: instance_variables
+          turbo_actions
         )
+        RenderTurboStream::Libs.set_test_responses(response, libs.test_responses)
       end
 
       if save_action && if_success_redirect_to.present?
@@ -215,14 +219,29 @@ module RenderTurboStream
 
     end
 
-    @render_turbo_stream_evaluate_instance_variables = nil
+    private
 
-    def evaluate_instance_variables
-      @render_turbo_stream_evaluate_instance_variables ||= (
-        { var_test: 'alpha' }
+    def fetch_instance_variables(locals, partial, template, action)
+      _locals = (locals ? locals : {})
+
+      # instance variables
+
+      check_template = RenderTurboStream::CheckTemplate.new(
+        partial: partial,
+        template: template,
+        available_instance_variables: self.instance_variables,
+        action: action
       )
 
+      # add instance_variables to locals
+
+      check_template.templates_instance_variables.each do |v|
+        _locals[:"render_turbo_stream_instance_variable_#{v}"] = self.instance_variable_get(v.to_s)
+      end
+
+      _locals
     end
 
+
   end
 end

data/lib/render_turbo_stream/channel_libs.rb

@@ -1,29 +1,14 @@
 module RenderTurboStream
   class ChannelLibs
 
-    def initialize(response)
-      @response = response
+    def initialize
+      @test_responses = []
     end
 
-    def render_to_channel(channel, target, action, controller_self, partial: nil, template: nil, locals: nil)
+    def render_to_channel(channel, target, action, partial: nil, template: nil, locals: nil)
 
       _locals = (locals ? locals : {})
 
-      # instance variables
-
-      check_template = RenderTurboStream::CheckTemplate.new(
-        partial: partial,
-        template: template,
-        available_instance_variables: controller_self.instance_variables,
-        action: action
-      )
-
-      # add instance_variables to locals
-
-      check_template.templates_instance_variables.each do |v|
-        _locals[:"render_turbo_stream_instance_variable_#{v}"] = controller_self.instance_variable_get(v.to_s)
-      end
-
       # fetch target-id
 
       target_id = RenderTurboStream::Libs.target_to_target_id(target)
@@ -48,7 +33,7 @@ module RenderTurboStream
       # add headers for test
 
       if Rails.env.test?
-        props = {
+        test_response = {
           target: target,
           action: action,
           type: 'channel-partial',
@@ -56,19 +41,9 @@ module RenderTurboStream
           channel: channel,
           html_response: rendered_html.to_s
         }
-
-        props[:partial] = partial if partial
-        props[:template] = template if template
-        h = @response.headers.to_h
-        i = 1
-        loop do
-          k = "test-turbo-channel-#{i}"
-          unless h.keys.include?(k)
-            @response.headers[k] = props.to_json
-            break
-          end
-          i += 1
-        end
+        test_response[:partial] = partial if partial
+        test_response[:template] = template if template
+        @test_responses.push(test_response)
       end
 
       # send
@@ -98,7 +73,7 @@ module RenderTurboStream
 
       if Rails.env.test?
 
-        props = {
+        test_response = {
           action: command,
           type: 'channel-command',
           channel: channel,
@@ -106,19 +81,9 @@ module RenderTurboStream
         }
         if RenderTurboStream::Test::Request::Libs.first_arg_is_html_id(command)
           target_id = (arguments.first[0..0] == '#' ? arguments.first[1..-1] : arguments.first)
-          props[:target] = RenderTurboStream::Libs.target_id_to_target(target_id)
-        end
-
-        h = @response.headers.to_h
-        i = 1
-        loop do
-          k = "test-turbo-channel-#{i}"
-          unless h.keys.include?(k)
-            @response.headers[k] = props.to_json
-            break
-          end
-          i += 1
+          test_response[:target] = RenderTurboStream::Libs.target_id_to_target(target_id)
         end
+        @test_responses.push(test_response)
       end
 
       content = RenderController.render(template: 'render_turbo_stream_command', layout: false, locals: { command: command, arguments: arguments })
@@ -129,17 +94,21 @@ module RenderTurboStream
       )
     end
 
-    def send_actions_to_channel(channel, actions, instance_variables)
+    def send_actions_to_channel(channel, actions)
       actions.each do |a|
         if a.is_a?(Array)
           action_to_channel(channel, a.first, a[1..-1])
         else
-          render_to_channel(channel, a[:target], a[:action], instance_variables, partial: a[:partial], template: a[:template], locals: a[:locals])
+          render_to_channel(channel, a[:target], a[:action], partial: a[:partial], template: a[:template], locals: a[:locals])
         end
       end
     end
 
     def self.fetch_partials_variables(relative_path) end
 
+    def test_responses
+      @test_responses || []
+    end
+
   end
 end

data/lib/render_turbo_stream/controller_helpers.rb

@@ -1,6 +1,11 @@
+
+
+
 module RenderTurboStream
   module ControllerHelpers
 
+
+
     # Handles translated flash messages as defined in translations and configs.
     # If :if_success_redirect_to and channel set up and allow_channel_to_me_for_turbo_stream_save are configured, sends flash message by channel_to_me.
     # you can add more stream actions to the same response
@@ -109,9 +114,11 @@ module RenderTurboStream
         response.status = 303
 
         if allow_channel
+
           Rails.logger.debug("  • Send actions through Turbo::StreamsChannel")
-          c_libs = RenderTurboStream::ChannelLibs.new(response)
-          c_libs.send_actions_to_channel("authenticated_user_#{helpers.current_user.id}", streams, @render_turbo_stream_evaluate_instance_variables)
+          c_libs = RenderTurboStream::ChannelLibs.new
+          c_libs.send_actions_to_channel("authenticated_user_#{helpers.current_user.id}", streams)
+          set_test_responses(c_libs.test_responses)
         else
           flash[:alert] = flashes[:alerts]
           flash[:notice] = flashes[:notices]
@@ -183,5 +190,23 @@ module RenderTurboStream
       render_turbo_stream([{ partial: partial, locals: locals, id: id, action: action }])
     end
 
+
+    def set_test_responses(test_responses)
+      if Rails.env.test?
+        h = response.headers.to_h
+        i = 1
+        test_responses.each do |test_response|
+          loop do
+            k = "turbo-response-test-#{i}"
+            unless h.keys.include?(k)
+              response.headers[k] = test_response.to_json
+              break
+            end
+            i += 1
+          end
+        end
+      end
+    end
+
   end
 end

data/lib/render_turbo_stream/libs.rb

@@ -5,8 +5,8 @@ module RenderTurboStream
       if target_id.present?
         if target_id[0] == '#'
           target_id
-          else
-        "##{target_id}"
+        else
+          "##{target_id}"
         end
       else
         nil
@@ -89,14 +89,31 @@ module RenderTurboStream
     end
 
     def self.debug_save_errors(object, controller_action_name)
-        if object.id.present?
-          Rails.logger.debug("  • #{controller_action_name} #{object.class}:#{object.id} FAILED:")
-        else
-          Rails.logger.debug("  • #{controller_action_name} #{object.class} FAILED:")
-        end
-        object.errors.full_messages.each do |e|
-          Rails.logger.debug("    => #{e}")
+      if object.id.present?
+        Rails.logger.debug("  • #{controller_action_name} #{object.class}:#{object.id} FAILED:")
+      else
+        Rails.logger.debug("  • #{controller_action_name} #{object.class} FAILED:")
+      end
+      object.errors.full_messages.each do |e|
+        Rails.logger.debug("    => #{e}")
+      end
+    end
+
+    def self.set_test_responses(response, test_responses)
+      if Rails.env.test?
+        h = response.headers.to_h
+        i = 1
+        test_responses.each do |test_response|
+          loop do
+            k = "turbo-response-test-#{i}"
+            unless h.keys.include?(k)
+              response.headers[k] = test_response.to_json
+              break
+            end
+            i += 1
+          end
         end
+      end
     end
 
   end

data/lib/render_turbo_stream/test/request/libs.rb

@@ -8,10 +8,11 @@ module RenderTurboStream
         end
 
         def all_turbo_responses
+
           e = Nokogiri::HTML(@response.body).search('#rendered-partials').first
           res = (e.present? ? JSON.parse(e.inner_html) : [])
           @response.headers.each do |k, v|
-            next unless k.match(/^test-turbo-channel-[\d]+$/)
+            next unless k.match(/^turbo-response-test-[\d]+$/)
             h = JSON.parse(v)
             res.push(h)
           end

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "4.3.17"
+  VERSION = "4.4.0"
 end

data/lib/render_turbo_stream.rb

@@ -8,9 +8,11 @@ require 'render_turbo_stream/test/system/helpers'
 require 'render_turbo_stream/test/request/libs'
 
 require 'render_turbo_stream/controller_helpers'
-require 'render_turbo_stream/controller_channel_helpers'
 
+require 'render_turbo_stream/channel'
+require 'render_turbo_stream/channel_controller_helpers'
 require 'render_turbo_stream/channel_view_helpers'
+
 require 'render_turbo_stream/view_helpers'
 
 require 'render_turbo_stream/channel_libs'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 4.3.17
+  version: 4.4.0
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-17 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -49,10 +49,11 @@ files:
 - app/views/render_turbo_stream_request_test.html.erb
 - db/migrate/20230616070450_create_render_turbo_stream_options.rb
 - lib/render_turbo_stream.rb
+- lib/render_turbo_stream/channel.rb
+- lib/render_turbo_stream/channel_controller_helpers.rb
 - lib/render_turbo_stream/channel_libs.rb
 - lib/render_turbo_stream/channel_view_helpers.rb
 - lib/render_turbo_stream/check_template.rb
-- lib/render_turbo_stream/controller_channel_helpers.rb
 - lib/render_turbo_stream/controller_helpers.rb
 - lib/render_turbo_stream/controller_libs.rb
 - lib/render_turbo_stream/engine.rb