render_turbo_stream 4.2.0 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0baf30f6152a1308687add8e14fda8ae815bfa43e54f9b4ffc6d859accc5e5b
-  data.tar.gz: a61f84ab272df1447b3a4cd38ef5dcbf3702390e360cbb03d5f172f0056aa760
+  metadata.gz: 414f885f38878ae67239db4d797a57f1a0826daf8fdea5f94d6ce7a1b2a0a54a
+  data.tar.gz: eb8b5012eec604e899f088337697491c41522337bf4cec7fc66067462089cc2a
 SHA512:
-  metadata.gz: 5f6b26a244628091a4385883b04d588d682f1da0144dd56a827e74cceb5d61df5bdeeb8eb72e041c9203995b25f1b62605fde0d5d4eadc611b3ef7a02dd8df54
-  data.tar.gz: bf8a7eaae4377b4a52f4200057f9dd4e8e8273fdee243f258cf1e65a63f935873d11a9686e73e1e353b54c5a05458781a6811c991f76650d1810da6dfa2b5e0a
+  metadata.gz: 454f651f6801fdb48a2bd2a76167a8d8d0fafd2712242aa9ce5db5f4d72d30bc95a7e4406e7d9da0f67b1542262b2d46a0c60b47cf52ce4773544fc94cdb636b
+  data.tar.gz: 386d2f4bf0d2a940969fe14fd280cb9afe9d09fac6568b9fc5ea98ddcd054a48de547d1a677275e6c418389efe309b10f621258e617c515329105db72b5960eb

data/README.md

@@ -1,9 +1,9 @@
 # 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.
+
 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.
 
 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.
@@ -17,7 +17,7 @@ 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).
 
-I am happy if it can help.
+Hope it helps :)
 
 **Chris**
 
@@ -103,12 +103,15 @@ def update
   turbo_stream_save(
     @article.update(article_params),
     if_success_turbo_redirect_to: articles_path,
-    target_id: 'customer-form'
+    target_id: 'customer-form',
+    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:
 
+If no partial is given, it renders the default template as turbo_stream.
+
 ```ruby
 render_turbo_stream(
   [
@@ -127,16 +130,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]`.
 
@@ -194,7 +187,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_tag` **OR** a element with the attribute `data_turbo_target`, 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.
 
@@ -250,10 +243,21 @@ config.x.render_turbo_stream.first_argument_is_html_id = %[replace append prepen
 
 This setting is relevant for testing helpers.
 
+# 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 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!
+
+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!
+
+Let us build on this vision and make rails what it has always been: A framework ahead of its time!
 
 # Contributing
 
-Contribution welcome.
+Contributors welcome.
 
 # License
 

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

@@ -15,8 +15,15 @@
     <% ctl = { partial: args[:partial], target_id: args[:target_id], action: args[:action] } %>
 
 
+    <% locals = args[:locals]&.symbolize_keys %>
+
+    <% 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 %>
+
 
-    <% rendered_html = render(partial: args[:partial], locals: args[:locals]&.symbolize_keys, formats: [:html]) %>
     <% 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

@@ -11,7 +11,12 @@
   <% else %>
 
 
-      <% html = (render s[:partial], locals: s[:locals]&.symbolize_keys, formats: [:html]) %>
+    <% locals = s[:locals]&.symbolize_keys %>
+    <% 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 element with attribute data_turbo_target 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,8 +87,9 @@ 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.")
           c_libs = RenderTurboStream::ChannelLibs.new(response)
@@ -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,26 +17,36 @@ 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('[data_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

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "4.2.0"
+  VERSION = "4.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.1
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-06-16 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
@@ -86,5 +88,5 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Makes working with Turbo fun and ensures quality.
+summary: Make working with Turbo fun!
 test_files: []