render_turbo_stream 4.3.0 → 4.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28e02fddd9493b46170e9e2767651c82748da1c0a0984940e57044489a24d472
-  data.tar.gz: a75224ab07323e2eef5d8f6905776c849a852068074d5e10a356303178b7d30a
+  metadata.gz: 9f3b950cec2aadef6d1acea45b6d15e0bb10a2b6c47adaf49bad4e4ed909ffba
+  data.tar.gz: a1ec0bf02392b4cebf5416aed80723f9a2d2c34f2996262bc451733dc56c9442
 SHA512:
-  metadata.gz: 45161e756cf12ebee2a2fd8941e93471ac001153bd39905597777f3fed48f5bb91e26fb254b41f0f30e340b4f47d1f743c2ec744a969e59e6b21baefdde40d5e
-  data.tar.gz: 8e610e79ae595f3af6290b450fb7b61a97c0166e883db6a5cae71bb095dac3481644d2964218478176376c1d0461144235cb6f2526d9af2dba97e21df999e57d
+  metadata.gz: f9ca2767f8ac34efd99bdb31f3abb5bc5654c0d130482d3a999f815b435a08cb3eecce4eec88272919feefc0e4e5584fa7a61970b3e9535ba2550945c10bac9a
+  data.tar.gz: 97b79f7d79095632faa08dc7838e959188e3342ce9eb62168e0a2e2cacac1de67eb6279dd2fecb31b289aa4d6a84799f3a129c3ee6a7692db4c6a16f4e8ee9c5

data/README.md

@@ -1,7 +1,5 @@
 # RenderTurboStream
 
-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).
-
 This gem has a second [README Turbo::StreamsChannel](https://gitlab.com/sedl/renderturbostream/-/blob/main/README-channels.md). 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.
 
 As of v4.3, locals inside partials should work as expected. If you are working with turbo but without this gem, please read [readme-locals](https://gitlab.com/sedl/renderturbostream/-/blob/main/readme-locals.md) to avoid tedious details.
@@ -39,6 +37,12 @@ ApplicationController
 include RenderTurboStream::ControllerHelpers
 ```
 
+Create a Initializer
+
+```ruby
+ActionView::Base.send :include, RenderTurboStream::ChannelViewHelpers
+```
+
 spec/rails_helper.rb
 
 ```ruby
@@ -104,12 +108,28 @@ The Rails team has integrated `ActionCable` as `Turbo::StreamsChannel` into `Tur
 def update
   turbo_stream_save(
     @article.update(article_params),
-    if_success_turbo_redirect_to: articles_path,
-    target_id: 'customer-form'
+    if_success_redirect_to: articles_path,
+    partial: 'form'
   )
 end
 ```
-This will set a status, generate a flash message, and run `render_turbo_stream`. If it fails, it would result in something like this:
+
+Assuming we want to build a form that works within a turbo-frame, including flash messages and redirects, we have to build all that inside a `turbo-frame`, and, within that we need a target-id, that must not be a turbo-frame. For that, there is a helper:
+
+```haml
+= turbo_target_tag do
+  = simple_form ... 
+```
+
+This will generate an element like `<turbo-target id="new-article-form">`.
+
+And the form should work!
+
+If the update succeeds, it sends a flash message by channel(!), because stream cannot work alongside redirect, and redirects to articles#index. If it fails, it sends a flash message by stream and replaces the form tag by stream so that the invalid fields are marked red and you can see the errors inside the form.
+
+Technical details? see later in this README.
+
+As mentioned above, the turbo stream actions are handled by the `render_turbo_stream` controller helper:
 
 ```ruby
 render_turbo_stream(
@@ -129,19 +149,6 @@ render_turbo_stream(
 
 If the update succeeds, it will do a `redirect_to` action from turbo_power
 
-The `stream_partial` method is for rendering a partial alone.
-
-```ruby
-stream_partial(
-  'flash-box',
-  partial: nil, #=> default: id.gsub('-','_')
-  locals: { title: 'my title' },
-  action: nil #=> default: :replace
-)
-```
-
-**locals**: The hash for locals goes through a `symbolize_keys`, so you need to use locals in used partials like this: `locals[:message]`.
-
 **More options**
 
 `render_turbo_stream` interprets a hash as a partial to be sent by `turbo_stream` and an array as a command to be sent. This allows you to perform most actions from, e.g., [turbo_power](https://github.com/marcoroth/turbo_power). An example of adding a css class to an html element and updating the browser history would look like this:
@@ -172,7 +179,24 @@ If this config is set to true, Turbo::StreamsChannel is installed and a current
 
 If an `if_success_redirect_to` argument is provided and the save action was successful, `turbo_stream_save` would send the partials by channel.
 
-**target-ID: Avoid the same definition in multiple places**
+**Target-ID**
+
+The target ID for turbo has to be safely unique, and it has to be nice, because at least during testing the developer has to deal with it. Since the default ID builder `dom_id` is too simple for this, there are some helpers. How it works is best shown by the `request-test helper target_id`:
+
+```ruby
+# target_id(virtual_view_path, object)
+target_id('customers/_form', Customer.new) #=> 'new-customer-form'
+target_id('customers/_form', Customer.first) #=> 'customer-1-form'
+target_id('customers/_form', nil) #=> 'customers-form'
+```
+View-helpers, assuming we are inside `customers/_form`:
+
+```ruby
+target_id #=> this checks automatically for @customer => if present => 'customer-1-form'
+target_id(Customer.new) #=> 'new-customer-form'
+```
+
+**Target-ID: Avoid the same definition in multiple places**
 
 Without this gem a turbo action would be wrapped within two frames, for example:
 
@@ -196,7 +220,7 @@ This means that the target id must be defined in several places: inside a partia
 In order to avoid this kind of tedious coding, the gem has a kind of fallback built in: If the argument `partial` is given, but the attribute `target_id` is not, the gem will get the target_id from the partial. The process is:
 
 1. Render the partial with the provided locals
-2. Grabs into the partial by Nokogiri and looks for a turbo_frame_tag and fetches the target_id.
+2. Grabs into the partial by Nokogiri and looks for the first `turbo-frame` or `turbo-target` element, get the id and uses this as target_id.
 3. If all that not is found it raises a exception
 4. wraps the partial within the `turbo_stream.*` and sends this to the front.
 
@@ -252,15 +276,17 @@ config.x.render_turbo_stream.first_argument_is_html_id = %[replace append prepen
 
 This setting is relevant for testing helpers.
 
-# Conclusion
+# Personal note
 
 The World Wide Web, founded around 1990 by [Tim Berners-Lee](https://en.wikipedia.org/wiki/Tim_Berners-Lee), was an html response from the server.
 
-Frameworks like Angular, Ember, React, Vue brought a much better user experience, so called "single page applications". But they changed something: Now Javascript was the processor of HTML, which is far from the [Progressive Enhancement] (https://developer.mozilla.org/en-US/docs/Glossary/Progressive_Enhancement)
+Frameworks like Angular, Ember, React, Vue brought a much better user experience, so called "single page applications". But they changed a paradigma: Now Javascript was the processor of HTML, which is far from the [Progressive Enhancement](https://developer.mozilla.org/en-US/docs/Glossary/Progressive_Enhancement).
+
+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). The Rails core now has done a big step, for bringing a user experience like a single page app, but by reducing javascript. This is a modern back to the roots. Thank you Rails Team!
 
-The Rails core team has now achieved a milestone by turbo, for bringing a user experience like a single page app, but by reducing javascript. Somehow modern, back to the roots. Thank you.
+But as of 2023, I searched for months and found nothing to solve all these details to make this Vision really work for rails. Now i am really happy and i cannot imagine working without Turbo!
 
-This gem is an attempt to make this approach more convenient for developers. 
+Let us build on this vision and make rails what it has always been: A framework ahead of its time!
 
 # Contributing
 

data/app/models/render_turbo_stream/option.rb

@@ -0,0 +1,4 @@
+module RenderTurboStream
+  class Option < ApplicationRecord
+  end
+end

data/app/views/render_turbo_stream.turbo_stream.erb

@@ -16,8 +16,14 @@
 
 
     <% locals = args[:locals]&.symbolize_keys %>
-    <% partial = args[:partial] %>
-    <% rendered_html = render(partial: partial, locals: locals, formats: [:html]) %>
+
+    <% if args[:partial].present? %>
+      <% rendered_html = render(partial: args[:partial], locals: locals, formats: [:html]) %>
+    <% else %>
+      <% rendered_html = render(template: args[:template], locals: locals, formats: [:html]) %>
+    <% end %>
+
+
     <% unless args[:target].present? %>
       <% args[:target] = RenderTurboStream::Libs.fetch_arguments_from_rendered_string(rendered_html)[:target] %>
       <% unless args[:target].present? %>

data/app/views/render_turbo_stream_request_test.html.erb

@@ -12,8 +12,11 @@
 
 
     <% locals = s[:locals]&.symbolize_keys %>
-    <% partial = s[:partial] %>
-    <% html = (render partial: partial, locals: locals, formats: [:html]) %>
+    <% if s[:partial].present? %>
+      <% html = (render partial: s[:partial], locals: locals, formats: [:html]) %>
+    <% else %>
+      <% html = (render template: s[:template], locals: locals, formats: [:html]) %>
+    <% end %>
 
 
 

data/db/migrate/20230616070450_create_render_turbo_stream_options.rb

@@ -0,0 +1,9 @@
+class CreateRenderTurboStreamOptions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :render_turbo_stream_options do |t|
+      t.string :title
+
+      t.timestamps
+    end
+  end
+end

data/lib/render_turbo_stream/controller_channel_helpers.rb

@@ -61,9 +61,9 @@ module RenderTurboStream
 
       disable_default = false
       if partial.present?
-        _partial = RenderTurboStream::Libs.partial_path(nil, target_id, controller_path, partial)
+        _partial = RenderTurboStream::Libs.partial_path(controller_path, partial)
       elsif template.present?
-        _template = RenderTurboStream::Libs.partial_path(nil, target_id, controller_path, template)
+        _template = RenderTurboStream::Libs.partial_path(controller_path, template)
         disable_default = true
       else
         _template = [controller_path, action_name].join('/')

data/lib/render_turbo_stream/controller_helpers.rb

@@ -12,10 +12,10 @@ module RenderTurboStream
       if_success_redirect_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
       if_success_turbo_redirect_to: nil, # does a full page redirect (break out of all frames by turbo_power redirect)
 
-      target_id: nil, # IF NIL: no partial will be rendered AND IF allowed by config: it would send by channel *_to_me and not affect the default response-rendering
-      partial: nil,
+      target_id: nil, # IF NIL: the gem grabs inside the rendered content for turbo-frame tag or turbo-target (element from helper of this gem) tag and takes the id from there.
+      partial: nil, # if nil: the gem renders the default template by turbo-stream
       action: 'replace', # options: append, prepend
-      locals: {}, # locals used by the target_id
+      locals: {},
 
       if_success_add: nil, # hash for a partial to render or array with actions (as array) or hashes for partials within
       if_error_add: nil, # additional partials that should be rendered if save_action failed
@@ -29,12 +29,6 @@ module RenderTurboStream
       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
-      #                    EXCEPTIONS
-      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-
-      raise 'render_turbo_stream: arguments target_id and if_success_redirect_to cannot be provided both' if target_id && if_success_redirect_to
-
       # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
       #                    LOGIC
       # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
@@ -49,7 +43,7 @@ module RenderTurboStream
       libs = RenderTurboStream::ControllerLibs.new(save_action)
       model_name = object.model_name.human
 
-      streams = (target_id ? libs.generate_action(controller_path, target_id, action, partial, locals) : [])
+      streams = []
 
       flashes = libs.generate_flash(
         model_name,
@@ -93,10 +87,11 @@ module RenderTurboStream
                                 if_success_turbo_redirect_to
                               ]
                             ])
+
       elsif save_action && if_success_redirect_to.present?
-        response.status = 302
+        response.status = 303
         if allow_channel
-          Rails.logger.debug("  • Sent #{streams.length} actions through Turbo::StreamsChannel to enable defined redirection because allowed in configs.")
+          Rails.logger.debug("  • Sent #{streams.length} actions through Turbo::StreamsChannel because allowed in configs.")
           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)
         else
@@ -107,13 +102,10 @@ module RenderTurboStream
         end
         redirect_to if_success_redirect_to
 
-      elsif !target_id.present? && allow_channel
-        Rails.logger.debug("  • Sent #{streams.length} actions through Turbo::StreamsChannel because no target_id defined and allowed in configs.")
-        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)
-
       else
+        streams += libs.generate_action(controller_path, target_id, action, partial, (partial ? nil : action_name), locals)
         render_turbo_stream(streams)
+
       end
     end
 
@@ -134,7 +126,11 @@ module RenderTurboStream
           end
           r.delete(:target_id)
           r[:action] = (props[:action].present? ? props[:action] : :replace)
-          r[:partial] = RenderTurboStream::Libs.partial_path(props[:target], props[:target_id], controller_path, props[:partial])
+          if props[:partial].present?
+            r[:partial] = RenderTurboStream::Libs.partial_path(controller_path, props[:partial])
+          else
+            r[:template] = RenderTurboStream::Libs.partial_path(controller_path, props[:template])
+          end
           r[:type] = 'stream-partial'
 
           ary.push(r)
@@ -155,20 +151,5 @@ module RenderTurboStream
 
     end
 
-    # renders a partial to turbo_stream
-
-    def stream_partial(target_id = nil, partial: nil, action: :replace, locals: {})
-      render_turbo_stream(
-        [
-          {
-            target: RenderTurboStream::Libs.target_id_to_target(target_id),
-            partial: partial,
-            action: action,
-            locals: locals
-          }
-        ]
-      )
-    end
-
   end
 end

data/lib/render_turbo_stream/controller_libs.rb

@@ -76,11 +76,16 @@ module RenderTurboStream
 
     end
 
-    def generate_action(controller_path, target_id, action, partial, locals)
+    def generate_action(controller_path, target_id, action, partial, template, locals)
       libs = RenderTurboStream::Libs
       target = libs.target_id_to_target(target_id)
-      _partial = libs.partial_path(nil, target_id, controller_path, partial)
+      if partial
+      _partial = libs.partial_path(controller_path, partial)
       [target: target, partial: _partial, locals: locals, action: action]
+      else
+        _template = libs.template_path(controller_path, template)
+        [target: target, template: _template, locals: locals, action: action]
+      end
     end
 
     def action_errors(actions)

data/lib/render_turbo_stream/libs.rb

@@ -17,30 +17,64 @@ module RenderTurboStream
       end
     end
 
-    def self.partial_path(target, target_id, controller_path, partial)
+    def self.partial_path(controller_path, partial)
       if partial && partial.to_s.include?('/')
         partial
       elsif partial.present?
         [controller_path, partial].join('/')
-      elsif target_id.present?
-        [controller_path, target_id.gsub('-', '_')].join('/')
-      elsif target.present?
-        [controller_path, RenderTurboStream::Libs.target_to_target_id(target).gsub('-', '_')].join('/')
+      end
+    end
+
+    def self.template_path(controller_path, template)
+      if template && template.to_s.include?('/')
+        template
+      elsif template.present?
+        [controller_path, template].join('/')
       end
     end
 
     def self.fetch_arguments_from_rendered_string(rendered_string)
       noko = Nokogiri::HTML(rendered_string)
       frame = noko.at_css('turbo-frame')
+      ele = noko.at_css('turbo-target')
       if frame.present?
         {
           target_id: frame[:id],
           target: target_id_to_target(frame[:id])
         }
+      elsif ele.present?
+        {
+          target_id: ele[:id],
+          target: target_id_to_target(ele[:id])
+        }
       else
         {}
       end
     end
 
+    def self.target_id(virt_view_path, id)
+      if id.is_a?(String)
+        id
+      elsif !id
+        [
+          virt_view_path.gsub('/', '-').gsub('-_', '-')
+        ].join('-')
+      else
+        unless id.methods.include?(:id)
+          raise("target_id / argument ID: Only String or object with method :id accepted")
+        end
+        (
+          (
+            id.id ?
+              [id.class.to_s.downcase, id.id] :
+              ['new', id.class.to_s.downcase]
+          ) +
+            [
+              virt_view_path.split('/').last.sub(/^_/, '')
+            ]
+        ).join('-')
+      end
+    end
+
   end
 end

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

@@ -84,6 +84,11 @@ module RenderTurboStream
           )
         end
 
+        def target_id(relative_view_path, object)
+          libs = RenderTurboStream::Libs
+          libs.target_id(relative_view_path, object)
+        end
+
       end
     end
   end

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "4.3.0"
+  VERSION = "4.3.2"
 end

data/lib/render_turbo_stream/view_helpers.rb

@@ -0,0 +1,20 @@
+module RenderTurboStream
+  module ViewHelpers
+
+    def turbo_target_tag(id = nil, &block)
+      content_tag :'turbo-target', id: target_id(id) do
+        if block_given?
+          capture(&block)
+        end
+      end
+    end
+
+    def target_id(id = nil)
+      libs = RenderTurboStream::Libs
+      virt_path = self.instance_variable_get('@current_template').instance_variable_get('@virtual_path')
+      obj = (id ? id : eval("@#{controller_name.singularize}"))
+      libs.target_id(virt_path, obj)
+    end
+
+  end
+end

data/lib/render_turbo_stream.rb

@@ -10,6 +10,7 @@ require 'render_turbo_stream/controller_helpers'
 require 'render_turbo_stream/controller_channel_helpers'
 
 require 'render_turbo_stream/channel_view_helpers'
+require 'render_turbo_stream/view_helpers'
 
 require 'render_turbo_stream/channel_libs'
 require 'render_turbo_stream/controller_libs'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.3.2
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2023-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -29,8 +29,8 @@ description: 'A set of helpers that allow a UNIFIED WORKFLOW for TurboStream and
   from the controller. There is no need to write *.turbo_stream.* templates anymore.
   Logic can stay on in the controller. Javascript actions can also be executed directly
   from the controller. TESTING: To reduce the amount of hard-to-maintain system tests,
-  this gem allows detailed request tests. A DEMO PROJECT with all this built in, along
-  with system and request tests, is linked in the README.'
+  request tests are possible. A DEMO PROJECT with all this built in, along with system
+  and request tests, is linked in the README.'
 email:
 - christian@sedlmair.ch
 executables: []
@@ -41,11 +41,13 @@ files:
 - Rakefile
 - app/controllers/render_turbo_stream/application_controller.rb
 - app/controllers/render_turbo_stream/render_controller.rb
+- app/models/render_turbo_stream/option.rb
 - app/views/layouts/_add_turbo_frame_tag.html.erb
 - app/views/render_turbo_stream.turbo_stream.erb
 - app/views/render_turbo_stream_command.html.erb
 - app/views/render_turbo_stream_empty_template.html.erb
 - 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_libs.rb
 - lib/render_turbo_stream/channel_view_helpers.rb
@@ -60,6 +62,7 @@ files:
 - lib/render_turbo_stream/test/request/helpers.rb
 - lib/render_turbo_stream/test/request/libs.rb
 - lib/render_turbo_stream/version.rb
+- lib/render_turbo_stream/view_helpers.rb
 - lib/tasks/render_turbo_stream_tasks.rake
 homepage: https://gitlab.com/sedl/renderturbostream
 licenses: