render_turbo_stream 0.1.25 → 0.1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f77bf1ea988efddf104ee8327848fcfbcab2ae409a0956cebffe960959dedef
-  data.tar.gz: 7f3b3395c1573cd0f5169e940497032d0be567cd068af5772242bb985943b8ea
+  metadata.gz: 71ca68293cace6bf25ae1983f0c710669d00b624173185da8d22377094a5ec09
+  data.tar.gz: 83f6948953c0bae73584aacb28e23785e8bf1308ca8c0f326488dbe1b70c6e4e
 SHA512:
-  metadata.gz: 1f7d73436e44a44b0b9fa03c2d2571df60cf056d84d8cd34269e04f8297a6bf21daf5728574961b369e5f919906128ced08795dad7cc5664bb327718c69b0fc1
-  data.tar.gz: 97f95322bc0fc0963a276f20b92cb1fc345efab29ab6884cf0f6c12fe8fdf8e49ad2c188bc1d6365227dba820f55577f44f649c26176a0037dab252f5a37ab60
+  metadata.gz: 37f7dfac016b98ca2cb9b66f92b34bd534de52e285d1de7a44cd4b3ec8efeef5c0203178ffeef28ee77dd3e66029a76cb2714b7b1b0a398e15f6c774ec1df259
+  data.tar.gz: 3a4059c7f942fedc218b716822b8cf9ef854cae5c6ee4e6e40e68a464938568984d290e85d9a915be83993640cb4c5d9cb8237ed7ef869659aedfc11fc6efca4

data/README.md

@@ -6,6 +6,8 @@ Working consistently with turbo_stream means shooting lots of partials from the
 
 It sets the status, generates a flash message, handles redirection, pushes it all to the front and comes with predefined helpers for enabling request-specs.
 
+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).
+
 ## Installation
 
 ```ruby
@@ -83,9 +85,9 @@ stream_partial(
 
 ## Testing
 
-For system testing we have Capybara. This works great and is necessary, but it is good practice to break tests into smaller pieces. 
+For system testing we have Capybara. This works great and is necessary for javascript and backend combined apps, but it is good practice to break tests into smaller pieces. 
 
-For request-level tests, there are some helpers:
+For the much faster request-level tests, there are some helpers:
 
 If the request format is not `turbo_stream`, which is the case on request specs, the method responds in a special html that contains the medadata that is interesting for our tests and is parsed by included test helpers. So tests could look like this:
 
@@ -100,30 +102,25 @@ RSpec.describe "Articles", type: :request do
   it 'create failed' do
     post articles_path(params: invalid_params)
 
-    # singular (partial_*) returns false if this element is cero or multiple times rendered to, otherwise the content
-    expect(partial_html_by_id('flash-box')).to include('Article could not be created')
-
-    expect(response.status).to eq(422)
-    expect(partials_count).to eq(2)
-
-    expect(partials_paths).to include('articles/form', 'layouts/flash')
-    expect(partials_ids).to include('form', 'flash-box')
-
-    # ..partials_params_* are the params by what partials are called
-    # id is the id where, by example, a turbo_stream.replace points to
-    expect(partials_params_by_id['flash-box'].length).to eq(1)
-    expect(partials_params_by_id['flash-box'].first['partial']).to eq('layouts/flash')
-
-    # ..partials_html_* is the html returned from the partial as string
-    expect(partials_html_by_id['flash-box'].length).to eq(1)
-    expect(partials_html_by_id['flash-box'].first).to include('Article could not be created')
-
-    # *_path is the controller_path for calling the partial
-    expect(partials_params_by_path['layouts/flash'].length).to eq(1)
-    expect(partials_params_by_path['layouts/flash'].first['partial']).to eq('layouts/flash')
-
-    expect(partials_html_by_path['layouts/flash'].length).to eq(1)
-    expect(partials_html_by_path['layouts/flash'].first).to include('Article could not be created')
+    # to which html-ids turbo-stream would point
+    expect(partials_ids).to include('flash-box', 'form')
+    
+    # which partials where rendered
+    expect(partials_paths).to include('layouts/flash', 'articles/form')
+
+    # partial_response (singular) returns false unless partial responded exactly one time, otherwise the content in nokogiri format: https://nokogiri.org/tutorials/searching_a_xml_html_document.html#basic-searching
+    r = partial_response(id: 'flash-box')
+    expect(r.css('div.text-content').first.inner_html).to include('Article could not be created')
+
+    # partials_responses (plural) returns a array
+    r2 = partials_responses(id: 'flash-box')
+    expect(r2.length).to eq(1)
+
+    # same, based on path by which partial is rendered to
+    r = partial_response(partial: 'layouts/flash')
+    expect(r.css('div.text-content').first.inner_html).to include('Article could not be created')
+    r2 = partials_responses(partial: 'layouts/flash')
+    expect(r2.length).to eq(1)
   end
 end
 ```
@@ -134,7 +131,7 @@ The test for a redirection might look something like this:
 it 'update success' do
   a = FactoryBot.create(:article)
   patch article_path(a, params: valid_params)
-  expect(turbo_redirected_to).to eq(articles_path) #=> turbo_redirected_to includes a «expect(response.status).to eq(302)»
+  expect(turbo_redirected_to).to eq(articles_path)
 end
 ```
 
@@ -142,7 +139,7 @@ P.S.:
 
 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.
 
-## Parameters
+## Parameters for turbo_stream_save
 
 `save_action` (first parameter, boolean) true if successful
 

data/app/views/render_turbo_stream_partials.html.erb

@@ -1,33 +1,12 @@
-<% partials_count = 0 %>
 <% rendered_partials = [] %>
-<% htmls_by_id = {} %>
-<% params_by_id = {} %>
-<% htmls_by_path = {} %>
-<% params_by_path = {} %>
 
 <% streams.each do |s| %>
 
-  <% html = (render s[:partial], locals: s[:locals], formats: [:html ]) %>
-  <% htmls_by_id[s[:id]] ||= [] %>
-  <% htmls_by_id[s[:id]].push(html) %>
-  <% params_by_id[s[:id]] ||= [] %>
-  <% params_by_id[s[:id]].push(s) %>
+  <% html = (render s[:partial], locals: s[:locals], formats: [:html]) %>
 
-  <% htmls_by_path[s[:partial]] ||= [] %>
-  <% htmls_by_path[s[:partial]].push(html) %>
-  <% params_by_path[s[:partial]] ||= [] %>
-  <% params_by_path[s[:partial]].push(s) %>
-
-  <% partials_count += 1 %>
-  <% rendered_partials.push(s[:partial]) %>
+  <% rendered_partials.push({ html_response: html }.merge(s)) %>
 
 <% end %>
 
-<%= content_tag :div, htmls_by_id.to_json, id: 'htmls_by_id' %>
-<%= content_tag :div, params_by_id.to_json, id: 'params_by_id' %>
-
-<%= content_tag :div, htmls_by_path.to_json, id: 'htmls_by_path' %>
-<%= content_tag :div, params_by_path.to_json, id: 'params_by_path' %>
-
-<%= content_tag :div, check.to_json, id: 'check-json' %>
 <%= content_tag :div, rendered_partials.to_json, id: 'rendered-partials' %>
+

data/lib/render_turbo_stream/test_helpers.rb

@@ -1,57 +1,56 @@
 module RenderTurboStream
   module TestHelpers
 
-    # returns hash of arrays with responded html(as string) contents by ID
-    def partials_html_by_id
-      e = Nokogiri::HTML(response.body).search('#htmls_by_id').first
-      JSON.parse(e.inner_html)
-    end
-
-    # returns false if id is cero or multiple times rendered to
-    def partial_html_by_id(id)
-      p = partials_html_by_id[id]
-      if p.length != 1
+    # returns false if partial is rendered cero or multiple times
+    # response can be searched by nokogiri https://nokogiri.org/tutorials/searching_a_xml_html_document.html#basic-searching
+    def partial_response(id: nil, partial: nil)
+      res = partials_responses(id: id, partial: partial)
+      if res.length != 1
         false
       else
-        p.first
+        res.first
       end
     end
 
-    def partials_params_by_id
-      e = Nokogiri::HTML(response.body).search('#params_by_id').first
-      JSON.parse(e.inner_html)
-    end
-
-    # returns hash of arrays with responded html(as string) contents by partial-path
-    def partials_html_by_path
-      e = Nokogiri::HTML(response.body).search('#htmls_by_path').first
-      JSON.parse(e.inner_html)
-    end
+    # like partial_response, but returns an array with length of how many times partial was rendered
 
-    # returns hash of arrays with params by them rendered partials are called
-    def partials_params_by_path
-      e = Nokogiri::HTML(response.body).search('#params_by_path').first
-      JSON.parse(e.inner_html)
-    end
-
-    # count of rendered parials
-    def partials_count
-      partials_paths.length
+    def partials_responses(id: nil, partial: nil)
+      ary = partials_attributes
+      if id && partial
+        res = ary.select { |a| a['partial'] == partial && a['id'] == id }
+      elsif id
+        res = ary.select { |a| a['id'] == id }
+      elsif partial
+        res = ary.select { |a| a['partial'] == partial }
+      else
+        raise 'missing parameter'
+      end
+      res.map{|r| Nokogiri::HTML(r['html_response']) }
     end
 
-    # array of strings of rendered partial ids
+    # array of strings of ids of rendered partials that turbo_stream pointed to
     def partials_ids
-      e = Nokogiri::HTML(response.body).search('#check-json').first
-      JSON.parse(e.inner_html).keys
+      ary = partials_attributes
+      ids = []
+      ary.each {|a| ids.push(a['id']) unless ids.include?(a['id']) }
+      ids
     end
 
-    # array of strings of paths by them rendered partials are called, example: ['articles/form']
+    # array of strings of paths by which partials are rendered, for example: ['articles/form'].
     def partials_paths
+      ary = partials_attributes
+      paths = []
+      ary.each {|a| paths.push(a['partial']) unless paths.include?(a['partial']) }
+      paths
+    end
+
+    # returns an array of hashes with the attributes used to call partials and the response (html as string) from the partial.
+    def partials_attributes
       e = Nokogiri::HTML(response.body).search('#rendered-partials').first
       JSON.parse(e.inner_html)
     end
 
-    # check response status and return redirected_to path
+    # Returns the path to which turbo_stream.redirect_to would be applied.
     def turbo_redirected_to
       expect(response.status).to eq(302)
       r = JSON.parse(response.body)

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "0.1.25"
+  VERSION = "0.1.27"
 end

data/lib/render_turbo_stream.rb

@@ -8,11 +8,11 @@ module RenderTurboStream
   def turbo_stream_save(
     save_action,
     redirect_on_success_to: nil,
-    object: nil,
+    object: nil, # object used in save_action, example: @customer
     id: 'form', # if nil: no partial is rendered
-    partial: nil, # default: same like ID
-    action: 'replace',
-    locals: {},
+    partial: nil, # example: 'customers/form' default: "#{controller_path}/#{id}"
+    action: 'replace', # options: append, prepend
+    locals: {}, # locals used by the partial
     streams_on_success: [
       {
         id: nil,
@@ -20,7 +20,7 @@ module RenderTurboStream
         locals: {},
         action: 'replace'
       }
-    ],
+    ], # additional partials that should be rendered if save_action succeeded
     streams_on_error: [
       {
         id: nil,
@@ -28,7 +28,7 @@ module RenderTurboStream
         locals: {},
         action: 'replace'
       }
-    ],
+    ], # additional partials that should be rendered if save_action failed
     add_flash_alerts: [], #=> array of strings
     add_flash_notices: [], #=> array of strings
     flashes_on_success: [], #=> array of strings

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 0.1.25
+  version: 0.1.27
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails