render_turbo_stream 0.1.20 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c9a8ce6edc86ce1bf4adb28042784f90665fb915d32c663899fa66fa6f6a764
-  data.tar.gz: cb31e25e686751127e6eb21562ab31bb0a15c25a7760691be2ace27fd32872a2
+  metadata.gz: 5656c817324a84016e78f1ab49a2f390448d79095f1c0b29a2ca9a459fdfdf04
+  data.tar.gz: a250f2ff61d1f9f0f622a097e9c725b9741169d794bc2a46f6fa792dfa2d33a9
 SHA512:
-  metadata.gz: 073a9bd4038390487978547dfd72e566744bba02032b7fc43989a5914b5dcde55612009774828101f88467ba37b86bb73693d0819441f6ddf7f3bc5fbd0b5736
-  data.tar.gz: 41836ea59255674882a518e861526d9d9460bb786943e5651304f48670e7af2cf7feedc5a6a7c2ae924b45f785f3b2e957afe4cb5bd454ab06869c5781dfa6af
+  metadata.gz: e999d3ce725859885ca2127c54ba2e79f8ea27104ca07ceeebfd750cb23734055ca43c38ed5e8d591a8b7efcd24cde28bc8bf4db75a787e917ea6a31147922e1
+  data.tar.gz: 8c6973e93202a10fc265fa7cc6a01cabe3ee125f3e48e8b7fd4511de7bdc05c8239146b834051321a47c883fbd2b55a3b731bc4bfab25dbb50c6f05d5d12e42f

data/README.md

@@ -79,36 +79,47 @@ stream_partial(
 
 ## Testing
 
-For system testing, there is Capybara.
+For system testing we have Capybara. This works great and is necessary, but it is good practice to break tests into smaller pieces. 
 
 For 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 format html that can be easily checked by included test helpers. So tests could look like this:
+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:
 
 ```ruby
 require 'rails_helper'
 include RenderTurboStream::TestHelpers
 
 RSpec.describe "Articles", type: :request do
+  
   let(:invalid_params) { { article: { title: '', desciption: 'abc' } } }
+  
   it 'create failed' do
     post articles_path(params: invalid_params)
+
     expect(response.status).to eq(422)
-    expect(rendered_partials_count).to eq(2)
-
-    # .._params means: check the params used to generate the partials.
-    expect(rendered_partials_paths).to include('articles/form', 'layouts/flash')
-    expect(rendered_ids).to include('form', 'flash-box')
-    expect(rendered_partials_params_find_id('flash-box')['partial']).to eq('layouts/flash')
-    expect(rendered_partials_params_where_id('flash-box').first['partial']).to eq('layouts/flash')
-    expect(rendered_partials_params_where_id('flash-box').is_a?(Array)).to eq(true)
-
-    # check html (returned as string) resulting from the rendered partials
-    h = rendered_partials_html
-    expect(h.join('')).to include('Article could not be created')
-    h = rendered_partials_html_by_id
-    expect(h['flash-box'].first).to include('Article could not be created')
-    expect(h['flash-box'].length).to eq(1)
+    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')
+
+    # unique_partial returns false if this ID is cero or multiple times rendered to
+    expect(unique_partial_html_by_id('flash-box')).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')
   end
 end
 ```

data/app/views/render_turbo_stream_partials.html.erb

@@ -1,19 +1,33 @@
 <% partials_count = 0 %>
 <% rendered_partials = [] %>
-<% htmls = [] %>
 <% 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.push(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) %>
+
+  <% 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]) %>
+
 <% 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, htmls.to_json, id: 'htmls' %>
-<%= content_tag :div, htmls_by_id.to_json, id: 'htmls_by_id' %>
 <%= content_tag :div, rendered_partials.to_json, id: 'rendered-partials' %>
-<%= content_tag :div, streams.to_json, id: 'streams' %>

data/lib/render_turbo_stream/test_helpers.rb

@@ -1,44 +1,57 @@
 module RenderTurboStream
   module TestHelpers
-    def rendered_ids
-      e = Nokogiri::HTML(response.body).search('#check-json').first
-      JSON.parse(e.inner_html).keys
+
+    # 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 unique_partial_html_by_id(id)
+      p = partials_html_by_id[id]
+      if p.length != 1
+        false
+      else
+        p.first
+      end
     end
 
-    # returns array of strings of rendered partials inner-html
-    def rendered_partials_html
-      e = Nokogiri::HTML(response.body).search('#htmls').first
+    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 ID
-    def rendered_partials_html_by_id
-      e = Nokogiri::HTML(response.body).search('#htmls_by_id').first
+    # 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
 
-    # array of strings of paths by them rendered partials are called, example: ['articles/form']
-    def rendered_partials_paths
-      e = Nokogiri::HTML(response.body).search('#rendered-partials').first
+    # 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
 
-    # returns all partials that would be streamed to a given ID
-    # note: if more than one partial by turbo_stream.replace are streamed to same ID, render_turbo_stream, in test mode already throws a error
-    def rendered_partials_params_where_id(id)
-      partials = Nokogiri::HTML(response.body).search('#streams').first
-      h = JSON.parse(partials.inner_html)
-      h.select{|e| e['id'] == id}
+    # count of rendered parials
+    def partials_count
+      partials_paths.length
     end
 
-    # returns the first partial that would be streamed to a given ID
-    def rendered_partials_params_find_id(id)
-      rendered_partials_params_where_id(id).first
+    # array of strings of rendered partial ids
+    def partials_ids
+      e = Nokogiri::HTML(response.body).search('#check-json').first
+      JSON.parse(e.inner_html).keys
     end
 
-    def rendered_partials_count
-      rendered_partials_paths.length
+    # array of strings of paths by them rendered partials are called, example: ['articles/form']
+    def partials_paths
+      e = Nokogiri::HTML(response.body).search('#rendered-partials').first
+      JSON.parse(e.inner_html)
     end
+
+    # check response status and return redirected_to path
     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.20"
+  VERSION = "0.1.22"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.22
 platform: ruby
 authors:
 - christian