render_turbo_stream 2.0.4 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22acef464fc16c9de34be6cd641963d7a400a310567e39a36a3f0172bd472e9d
-  data.tar.gz: 82b659e72efec3e187032b15c111695dd7756ae6311c1f3af7970377f16288a2
+  metadata.gz: ac522064ae87773819b4fdd059166e10a8bbb805de1dbbd020781f806ac6faeb
+  data.tar.gz: a78259d9e2468305da273618929296735f3217592ed0ac2f0311e14b9c913eaf
 SHA512:
-  metadata.gz: 567c9a920ca6e8fde6b7db21c31d5bd7474802df3b99ed9fe2bfa5b3316a68248813eef71d01125548f0deafc5786b38cb84fcbf5ddbb149a0822a7afc9c904c
-  data.tar.gz: 58d1c1332ae8fc1bc7f149cbe8f748a1bc8a0af41ee4fd33fa6be96faf31f357416bbec75b50bd2c6f3bd4de9edb1b78409be186da12fe47125ce123cba05e2f
+  metadata.gz: b9e22fa2a8dbb9d7bb85d9fd19993ac6511c4cf9364c20da4b950b4bb368839c48f8c6ac93f31452592bc286f717d4c63107db7757731e339f1a37b871c7332a
+  data.tar.gz: 5c13d3c56d66450c20920403cef30c18c18e0101ba0c3de86516d9db26d57edcd5c3a37866dc6e2c9052e0f2be34c2751486b29361dd93a5b1f54f5255660dc6

data/README.md

@@ -1,12 +1,16 @@
 # RenderTurboStream
 
-Defining templates like `(create|update).turbo_stream.haml` annoyed me and I was looking for a testing strategy.
+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. Includes helpers for enabling request tests.
+Working consistently with turbo_stream or Turbo Streams Channel means shooting a lot 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, and maybe generate a translated flash message for update or create actions. All this can be done in one step directly from the controller.
 
-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.
+There are many ways and tedious details to handle redirects since Turbo! Below described are options.
 
-ATTENTION: This plugin is in a early state.
+Turbo has seamlessly integrated Action Cable. The intention here is to bring it all together in a unified workflow with a sufficient testing strategy.
+
+Execute [turbo_power](https://github.com/marcoroth/turbo_power) commands, such as adding a css class to an html element, pushing a state to the browser history, or running custom javascript actions through Turbo Stream (cable not yet integrated here) can be written in pure ruby code. No need for embeds like `.html.erb`.
+
+This plugin is in a early state.
 
 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).
@@ -15,6 +19,8 @@ A quick and dirty application with all the features, including tests, built in i
 
 Hope it can help you.
 
+**Chris**
+
 ## Installation
 
 ```ruby
@@ -76,7 +82,7 @@ A comprehensive tutorial on turbo and how to check that it is working properly c
 **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
+# 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:
 
@@ -207,7 +213,7 @@ def update
     flashes_on_error: [] #=> array of strings
 
 
-## Testing Scenarios
+# Testing Scenarios
 
 For system testing there is Capybara. Its the only way to check if frontend and backend work together. But its a good practice to break tests into smaller pieces. The much larger number of tests we will write on the much faster request tests, examples here in rspec.
 
@@ -288,7 +294,7 @@ For more detailed testing of partials, there are view tests.
 Testing the plugin itself: There is a [quick-and-dirty app](https://gitlab.com/sedl/renderturbostream_railsapp) which
 includes the plugin and has tests done by rspec/request and capybara.
 
-## More Configs
+# More Configs
 
 On test helpers, the marker for a turbo-stream target is in most cases the id of the target element. This is true for the standard turbo-stream functions. On `turbo_power` it is the same in most cases. `RenderTurboStream::Libs.first_arg_is_html_id()` checks for which methods this is true. You can override this:
 
@@ -299,14 +305,14 @@ config.x.render_turbo_stream.first_argument_is_html_id = %[replace append prepen
 This setting is relevant for testing helpers.
 
 
-## Contributing
+# Contributing
 
 Contribution welcome.
 
-## License
+# License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Thanks
+# Thanks
 
 Thanks to Marco Roth for turbo_power and thanks to DHH and the rails team for taking a bold new step by creating turbo.

data/lib/render_turbo_stream/turbo_cable_helpers.rb

@@ -1,32 +1,32 @@
 module RenderTurboStream
   module TurboCableHelpers
 
-    # def cable_partial_to_all_authenticated_users
-    #   raise "Function cable_partial_to_all_authenticated_users is "
-    #   if user_signed_in?
-    #
-    #   end
-    # end
+    def partial_to_all_authenticated_users
+      raise "Function partial_to_all_authenticated_users is not yet implemented"
+      if user_signed_in?
 
-    def cable_partial_to_channel(action, channel, partial, id, locals: nil)
+      end
+    end
+
+    def partial_to_channel(action, channel, partial, id, locals: nil)
 
       # add headers for test
       if Rails.env.test?
-        args = {
+        html = RenderTurboStreamRenderController.render(partial: partial, locals: locals)
+        props = {
           target: "##{id}",
           action: action,
           type: 'cable-partial',
           partial: partial,
-          locals: locals
+          locals: locals,
+          html_response: html.to_s
         }
-        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
-            response.headers["#{k}-html"] = html.to_s
+            response.headers[k] = props.to_json
             break
           end
           i += 1
@@ -45,22 +45,22 @@ module RenderTurboStream
       )
     end
 
-    def cable_partial_to_me(partial, id, action: :replace, locals: nil)
+    def 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')
+          Rails.logger.debug('  • SKIP RenderTurboStream.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')
+        Rails.logger.debug('  • ERROR RenderTurboStream.partial_to_me because current_user is not available')
         return
       end
 
-      cable_partial_to_channel(
+      partial_to_channel(
         action,
-        "current_user_#{helpers.current_user.id}",
+        "authenticated-user-#{helpers.current_user.id}",
         partial,
         id,
         locals: locals

data/lib/render_turbo_stream/turbo_cable_view_helpers.rb

@@ -3,19 +3,20 @@ module RenderTurboStream
 
     def cable_from_me
       if current_user
-        turbo_stream_from "current_user_#{current_user.id}"
+        turbo_stream_from "authenticated-user-#{current_user.id}"
       else
         Rails.logger.debug("  • SKIP CABLE_FROM_ME because not authenticated")
       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
-    # end
+    def cable_from_all_authenticated_users
+      raise "Function cable_from_all_authenticated_users is not yet implemented"
+      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"

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "2.0.4"
+  VERSION = "2.1.1"
 end

data/lib/render_turbo_stream.rb

@@ -162,7 +162,7 @@ module RenderTurboStream
         streams.each do |s|
           next unless s.is_a?(Hash)
           Rails.logger.debug("  • Send by Cable => «#{s}»")
-          cable_partial_to_me(
+          partial_to_me(
             s[:partial],
             s[:id],
             action: flash_action,
@@ -237,23 +237,11 @@ module RenderTurboStream
   class Libs
     def self.all_responses(response)
       e = Nokogiri::HTML(response.body).search('#rendered-partials').first
-      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)
-        html = response.headers["#{k}-html"]
-        res.push(
-          args.merge(
-            {
-              'html_response' => html,
-            }
-          )
-        )
+      res = (e.present? ? JSON.parse(e.inner_html) : [])
+      response.headers.each do |k, v|
+        next unless k.match(/^test-turbo-cable-[\d]+$/)
+        h = JSON.parse(v)
+        res.push(h)
       end
       res
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.1
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,7 +27,7 @@ dependencies:
 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
+  actions, it can run javascript. Redirects can be handled easily and in multiple
   ways. Through request testing helpers, this allows for consistent testing strategy.
 email:
 - christian@sedlmair.ch