render_turbo_stream 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b84c79cfe97c99b55813d6a22ebcf0267e6dc7ee66b9a6c8bb922c8f5cf812b
-  data.tar.gz: 420971446a65cbda6c141be9c32941ddf991944cbb3c84f9f2eb259cf077c3b6
+  metadata.gz: 5656c817324a84016e78f1ab49a2f390448d79095f1c0b29a2ca9a459fdfdf04
+  data.tar.gz: a250f2ff61d1f9f0f622a097e9c725b9741169d794bc2a46f6fa792dfa2d33a9
 SHA512:
-  metadata.gz: 3bc0935233cc25323b8f92e12227308d680b24d6ea532786e685c75d6500158d68991dd9babe5d2bc1424ca8c93f43912528cc8a4abac6363c636331d8929fd5
-  data.tar.gz: f2ee4939746a8b7d4dc06df81920e55baa3c5bce6ee26b04778b91e5067ffb846e436fddeed2c4868f9ea9b0ca5876a8f4e29a65f146fc438c362bfbc7c13c05
+  metadata.gz: e999d3ce725859885ca2127c54ba2e79f8ea27104ca07ceeebfd750cb23734055ca43c38ed5e8d591a8b7efcd24cde28bc8bf4db75a787e917ea6a31147922e1
+  data.tar.gz: 8c6973e93202a10fc265fa7cc6a01cabe3ee125f3e48e8b7fd4511de7bdc05c8239146b834051321a47c883fbd2b55a3b731bc4bfab25dbb50c6f05d5d12e42f

data/README.md

@@ -79,34 +79,42 @@ 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(partials_count).to eq(2)
 
-    # .._params means: check the params used to generate the partials.
     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')
 

data/app/views/render_turbo_stream_partials.html.erb

@@ -1,13 +1,13 @@
 <% 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]] ||= [] %>
@@ -20,6 +20,7 @@
 
   <% partials_count += 1 %>
   <% rendered_partials.push(s[:partial]) %>
+
 <% end %>
 
 <%= content_tag :div, htmls_by_id.to_json, id: 'htmls_by_id' %>
@@ -29,6 +30,4 @@
 <%= 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, rendered_partials.to_json, id: 'rendered-partials' %>
-<%#= content_tag :div, streams.to_json, id: 'streams' %>

data/lib/render_turbo_stream/test_helpers.rb

@@ -7,6 +7,16 @@ module RenderTurboStream
       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
+
     def partials_params_by_id
       e = Nokogiri::HTML(response.body).search('#params_by_id').first
       JSON.parse(e.inner_html)

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "0.1.21"
+  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.21
+  version: 0.1.22
 platform: ruby
 authors:
 - christian