render_turbo_stream 4.0.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 525e9a802269d71e60be6cbc44fe62ebbe677a89fd49e048b1dbc11c6ae4d2b0
-  data.tar.gz: 5b47c7b9a7dcc49491e4ab20eb2637654b62e971afe0abdf481ec9210e97f145
+  metadata.gz: 35750e37d2f65c71588b62ebcd0b7986d0e0012bd8674808dd0149f81b5ee967
+  data.tar.gz: 3937766529f3c5418b29895196c5a8acbb1bfeecf0e6464faf7c310d1a5ac097
 SHA512:
-  metadata.gz: c532c3c9a5307547f260ff1feefea8e43b3cb09e42c43eacad1771c8a72b16a9843703024e1a58891a0498592c53dd296f2a6d7ef0dac72554c838c7c42d3915
-  data.tar.gz: f1c5cf8193d9c3214d60c492d73e7ebaf844b848dfa88a602ee235af9c0fbe90d757584938cf3b58d661d507b119791d4fe544968580654406c63abdfe4c1864
+  metadata.gz: c0cd96285c1d01d203b5afd33094f4be26606c40e70bab2161a36202219f713f273ae97534dc35bf722b5fe7091e034b68028c0f2f9513e20b3346d45c3f1b67
+  data.tar.gz: ebdbca94432c7e14d01e93729e8d9361d5ffacba0ea90b20148d22882e2e7bd248dda610d8a840db6cfecdddffbe94eaa139f7527e432079fc8231525a709541

data/README.md

@@ -2,24 +2,24 @@
 
 2021 DHH annouced a great milestone in web development with [Rails 7, "Fulfilling a Vision"](https://rubyonrails.org/2021/12/15/Rails-7-fulfilling-a-vision).
 
-TTo say it up front: If you want to have all the benefits of Turbo without disturbing the handy default Rails workflow, you have to use WebSockets, which are well integrated in Turbo, see [README Turbo::StreamsChannel](https://gitlab.com/sedl/renderturbostream/-/blob/main/README-channels.md). But the starting point is here. And I recommend that you download my [Quick-and-dirty test project](https://gitlab.com/sedl/renderturbostream_railsapp), set it up, see all the tests succeed, and then read through this README.
+To say it up front: If you want to have all the benefits of Turbo without disturbing the handy default Rails workflow, you must use WebSockets sometimes, which are well integrated in Turbo, see [README Turbo::StreamsChannel](https://gitlab.com/sedl/renderturbostream/-/blob/main/README-channels.md). But the starting point is here. And I recommend that you download my [Quick-and-dirty test project](https://gitlab.com/sedl/renderturbostream_railsapp), set it up, see all the tests succeed, and then read through this README.
 
-Defining templates like `(create|update).turbo_stream.haml` annoyed me. Because it is a heavy mix of logic and view. Working consistently with turbo_stream or Turbo Streams Channel means shooting a lot of partials from the backend to the frontend. This gem checks if a partial has the necessary frames, wraps it, and includes a helper to make instance variables work for Turbo Streams as well. This way, a simple as-usual partial is compatible for withh and without turbo, and can be sent in any way.
+Defining templates like `(create|update).turbo_stream.haml` is a heavy mix of logic and view. This gem separates logic and view so that `*.turbo_stream.*` templates are no longer necessary and the logic can stay on the ruby side.
 
-It has a testing strategy!
+For `:replace` actions, responses must be wrapped inside a `turbo_frame_tag` with a matching `target_id`. The gem will regex the content and wrap it by a `turbo_frame_tag` if necessary but not present. This way the matching `target_id` is only defined in one place. This check only happens on the first call after restarting the application in production and on every call if precompile assets is set to true in configs.
 
-A lot of details for handling many different ways of redirect, that are possible and necessary since Turbo, are handled.
+If the turbo stream action is `:replace' and the content is not wrapped by `turbo_frame_tag', the gem will wrap it. So the partial content is checked by regex. This check only happens on the first call after restarting the application in production and on every call if precompile assets is set to true in configs.
 
-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 can be written in pure ruby code. No need for embeds like `.html.erb`.
+There are many different ways to handle **redirects** since turbo. Some details are handled here.
 
-Logic to Ruby, views to views, and the space in between for the gem! And all this together with a testing strategy for the Ruby side.
+Execute [turbo_power](https://github.com/marcoroth/turbo_power) commands such as adding a css class to an html element, can be sent directly from the controller.
+
+Has a testing strategy.
 
 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).
 
-Hope it can help you.
-
-April 2023 first released this gem is in a very early state. I am happy if others contribute for increase the quality of this new kind of working with rails 7.
+I am happy if it can help.
 
 **Chris**
 

data/lib/render_turbo_stream/check_template.rb

@@ -13,7 +13,7 @@ module RenderTurboStream
       @action = action
       @partial_path = partial
       @template_path = template
-      @available_instance_variables = available_instance_variables
+      @available_instance_variables = nil #available_instance_variables #=> because if an instance variable was not set on production and the first call, and it was set on a later call, the gem would not know that and not set it.
       prt = (partial ? partial : template).split('/')
       if prt.length < 2
         raise 'Partial or template path must always be specified with the controller path, for example «articles/partial_name».'

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "4.0.0"
+  VERSION = "4.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.2
 platform: ruby
 authors:
 - christian
@@ -24,12 +24,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.3
-description: Handles translated flash messages, sets status, wrapps partials in the
-  necessary frames and renders 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, it can run javascript. Redirects
-  can be handled easily and in multiple ways. Through request testing helpers, this
-  allows for consistent testing strategy.
+description: 'It brings TurboStreams and TurboStreams::Channel together in a unified
+  workflow with one testing strategy. It separates logic and views: All partial handling
+  can be controlled directly from the controller. No need to write *.turbo_stream.*
+  templates. A normal partial can be sent in any way. Execution of javascript actions
+  can be done directly from the controller. Demo project with all this built in along
+  with system and request tests is available.'
 email:
 - christian@sedlmair.ch
 executables: []
@@ -85,5 +85,5 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Complete workflow for turbo that just works and has a testing strategy.
+summary: Complete workflow for turbo with a testing strategy.
 test_files: []