render_turbo_stream 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 733ef3518b8c95cb2f5162d0abb6d6278e653219bf5a99b502159fa52e884be8
-  data.tar.gz: b526a407a00b9dee9e5e543a48d80d14c073d87bf2397ea9bf2c0027a3366527
+  metadata.gz: ef24460b794e7db6757f2ad199e94f9ce7df38615b9ed64bcdcfc0af978cf573
+  data.tar.gz: 1c14768ff0ee5277befcb9d039c37b7df5e549cf3f23910672583099ab387590
 SHA512:
-  metadata.gz: edf51ffaf2a192f7eb65f6147ba3d2b64cbb07d0c444a4bc00ec2d7a145cceaac943704ec1b50199e0ac1b4f42e3f524386679d682af728ca0f577b865dc72d9
-  data.tar.gz: '09e87e2f74275a48a459d47dac942c66787e2127d9cf61e08ff16a3e7dcf5cc63708d4c1b0d4d7fba89a429a0ff76f5e95a491906650ba167bf27bde82784afd'
+  metadata.gz: 805e49cacca8b70246a6549c52a7e4bde532989ab80dcd375e0c238ed880aedf55a6f51ebc1275b030ad81daf6dae81753ffdb3590af14ba309383a7aa9473da
+  data.tar.gz: 5d7f808aaf2fa1b77338fbf8f4f236ec41bcf1c4b89113e9d55608a56ac349416a8a91e3fb951b387383b937cdd125c2c19816fad78191bfc0285245e41ef854

data/README.md

@@ -33,7 +33,6 @@ ApplicationController
 
 ```ruby
 include RenderTurboStream::ControllerHelpers
-include RenderTurboStream::ControllerChannelHelpers
 ```
 
 spec/rails_helper.rb
@@ -54,7 +53,7 @@ Required Configurations for Flash Partial
     config.x.render_turbo_stream.flash_partial = 'layouts/flash'
     config.x.render_turbo_stream.flash_id = 'flash-box'
     config.x.render_turbo_stream.flash_action = 'prepend'
-    config.x.render_turbo_stream.use_cable_for_turbo_stream_save = true
+    config.x.render_turbo_stream.use_channel_for_turbo_stream_save = true
 ```
 
 The corresponding partials for flashes could look [like this](https://gitlab.com/sedl/renderturbostream/-/wikis/Flashes-example)
@@ -82,7 +81,7 @@ A comprehensive tutorial on turbo and how to check that it is working properly c
 
 **Turbo::StreamsChannel**
 
-The Rails team has 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-channels.md).
+The Rails team has integrated `ActionCable` as `Turbo::StreamsChannel` into `Turbo Rails`. For installation along with this gem, see the [README-channels](https://gitlab.com/sedl/renderturbostream/-/blob/main/README-channels.md).
 
 # Usage
 
@@ -159,7 +158,7 @@ Suppose you have a CRUD controller that should do all its actions inside a turbo
 There are two workarounds:
 
 ```ruby
-config.x.render_turbo_stream.use_cable_for_turbo_stream_save = true
+config.x.render_turbo_stream.use_channel_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.

data/lib/render_turbo_stream/channel_libs.rb

@@ -1,5 +1,6 @@
 module RenderTurboStream
   class ChannelLibs
+
     def self.render_to_channel(response, channel, target_id, action, partial: nil, template: nil, locals: nil)
 
       locals = {} unless locals # prevent error missing keys for nil

data/lib/render_turbo_stream/controller_helpers.rb

@@ -1,6 +1,10 @@
 module RenderTurboStream
   module ControllerHelpers
 
+    # Handles translated flash messages as defined in translations and configs.
+    # If :redirect_on_success_to and channel set up and use_channel_for_turbo_stream_save are configured, sends flash message by channel_to_me.
+    # you can add more stream actions to the same response
+
     def turbo_stream_save(
       save_action,
       redirect_on_success_to: nil, # does a regular redirect. Works if you are inside a turbo_frame and just want to redirect inside that frame BUT CANNOT STREAM OTHERS ACTIONS ON THE SAME RESPONSE https://github.com/rails/rails/issues/48056
@@ -151,7 +155,7 @@ module RenderTurboStream
                             ])
       elsif save_action && redirect_on_success_to.present?
         response.status = 302
-        if Rails.configuration.x.render_turbo_stream.use_cable_for_turbo_stream_save && helpers.user_signed_in?
+        if Rails.configuration.x.render_turbo_stream.use_channel_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}»")
@@ -178,6 +182,8 @@ module RenderTurboStream
       end
     end
 
+
+    # renders a array of partials to send by turbo-stream and / or actions like turbo_power gem includes, to turbo_stream
     def render_turbo_stream(array)
 
       ary = []
@@ -211,6 +217,8 @@ module RenderTurboStream
 
     end
 
+    # renders a partial to turbo_stream
+
     def stream_partial(
       id,
       partial: nil, #=> default: id

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

@@ -3,6 +3,8 @@ module RenderTurboStream
     module Request
       module ChannelHelpers
 
+        # Assert a action by turbo streams channel to the current_user
+
         def assert_channel_to_me(user, target_id, action: nil, count: 1, &block)
 
           channel = "authenticated-user-#{user.id}"
@@ -17,6 +19,8 @@ module RenderTurboStream
           )
         end
 
+        # Assert a action by turbo streams channel to a group of authenticated users
+
         def assert_channel_to_authenticated_group(group, target_id, action: nil, count: 1, &block)
 
           channel = "authenticated-group-#{group}"
@@ -31,6 +35,8 @@ module RenderTurboStream
           )
         end
 
+        # Assert a action by turbo streams channel to all visitors of the page
+
         def assert_channel_to_all(target_id, action: nil, count: 1, &block)
 
           libs = RenderTurboStream::Test::Request::Libs

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

@@ -3,6 +3,8 @@ module RenderTurboStream
     module Request
       module Helpers
 
+        # Assert that each of given target_ids is targeted exactly once
+
         def assert_once_targeted(*target_ids)
           responses = RenderTurboStream::Test::Request::Libs.all_turbo_responses(response)
           id_counts = {}
@@ -28,27 +30,18 @@ module RenderTurboStream
           end
         end
 
+        # Helper for the developer for writing tests: Array with all attributes of all turbo-stream and turbo-channel actions that runned on the last request
+
         def all_turbo_responses
           RenderTurboStream::Test::Request::Libs.all_turbo_responses(response)
         end
 
+        # Returns Array of all target_ids that arre affected at least once on the last response
         def turbo_targets
           RenderTurboStream::Test::Request::Libs.turbo_targets(response)
         end
 
-        def assert_response(target_id, type = nil, action: nil, count: 1, &block)
-
-          libs = RenderTurboStream::Test::Request::Libs
-
-          r = libs.select_responses(response, false, target_id, action, type: type, &block)
-
-          assert(
-            r[:responses].length == count,
-            libs.assert_error_message(count, r[:responses].length, r[:log])
-          )
-        end
-
-        # Returns the path to which turbo_stream.redirect_to would be applied.
+        # Returns the path sent to turbo_stream.redirect_to.
         def turbo_redirect_to
           resps = RenderTurboStream::Test::Request::Libs.all_turbo_responses(response)
           url = nil
@@ -66,11 +59,12 @@ module RenderTurboStream
           url
         end
 
-        def assert_stream_response(target_id, action: nil, count: 1, &block)
+        # assert one or more specific actions to a target_id
+        def assert_stream_response(target_id, action: nil, count: 1, type: :stream, &block)
 
           libs = RenderTurboStream::Test::Request::Libs
 
-          r = libs.select_responses(response, false, target_id, action, type: :stream, &block)
+          r = libs.select_responses(response, false, target_id, action, type: type, &block)
 
           assert(
             r[:responses].length == count,

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

@@ -149,6 +149,7 @@ module RenderTurboStream
           ]
           (config.present? ? config : default).map { |m| m.to_sym }.include?(method.to_sym)
         end
+
       end
     end
   end

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - christian