render_turbo_stream 0.1.18 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd4172769edde2afebf684b4a53c6497e255b1acf0e03b5ca8fe2ba93b64437d
-  data.tar.gz: 1c99586db62a402be30535c39bf3d60b279fdb269000b2b362b49e1fa935308d
+  metadata.gz: 5c9a8ce6edc86ce1bf4adb28042784f90665fb915d32c663899fa66fa6f6a764
+  data.tar.gz: cb31e25e686751127e6eb21562ab31bb0a15c25a7760691be2ace27fd32872a2
 SHA512:
-  metadata.gz: 510284ee5f2b48df8161f0dc7a4552b5f9785b8c6d49a6b71dcdd98f37804bd22874a63e2f8f2f3b4967454fedfed8d3e2eb98bbfb85645a7e4cf83f4311c4d8
-  data.tar.gz: e0336ad09c42899b3c1b9d6d717cd1ec7b6a5781df932bf52956b643304170418dabd2334f4b99509e0059fa37f7a81f6a6672e22b9705890d400cd02a812eb0
+  metadata.gz: 073a9bd4038390487978547dfd72e566744bba02032b7fc43989a5914b5dcde55612009774828101f88467ba37b86bb73693d0819441f6ddf7f3bc5fbd0b5736
+  data.tar.gz: 41836ea59255674882a518e861526d9d9460bb786943e5651304f48670e7af2cf7feedc5a6a7c2ae924b45f785f3b2e957afe4cb5bd454ab06869c5781dfa6af

data/README.md

@@ -22,7 +22,7 @@ ApplicationController
 include RenderTurboStream
 ```
 
-necessary configs for flash partials
+Required Configurations for Flash Partial
 
 ```ruby
     config.x.render_turbo_stream.flash_partial = 'layouts/flash'
@@ -34,7 +34,7 @@ The corresponding partials for flashes could look [like this](https://gitlab.com
 
 ## Usage
 
-`turbo_stream_save` is a special method for streamline `update` or `create` functions for `turbo_stream`, which could look like so:
+`turbo_stream_save` is a special method for streamlining `update` or `create` functions for `turbo_stream`, which might look like this:
 
 ```ruby
  def create
@@ -48,7 +48,7 @@ The corresponding partials for flashes could look [like this](https://gitlab.com
   end
 ```
 
-This sets a status, generates a flash message and performs `stream_partials`, which could result like that:
+This will set a status, generate a flash message and perform `stream_partials', which could result in something like this:
 
 ```ruby
 stream_partials(
@@ -66,7 +66,7 @@ stream_partials(
 )
 ```
 
-The `stream_partial` method is nothing else than a singular of `stream_partials`
+The `stream_partial' method is nothing more than a singular of `stream_partials'.
 
 ```ruby
 stream_partial(
@@ -79,11 +79,11 @@ stream_partial(
 
 ## Testing
 
-For system testing there is capybara.
+For system testing, there is Capybara.
 
-For Tests on request level there are some helpers:
+For request-level tests, there are some helpers:
 
-If request format is not `turbo_stream`, which is the case on request specs, the method responds in a html by a special format that can easily be 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 format html that can be easily checked by included test helpers. So tests could look like this:
 
 ```ruby
 require 'rails_helper'
@@ -91,18 +91,29 @@ include RenderTurboStream::TestHelpers
 
 RSpec.describe "Articles", type: :request do
   let(:invalid_params) { { article: { title: '', desciption: 'abc' } } }
-  it 'update failed' do
-    a = FactoryBot.create(:article)
-    patch article_path(a, params: invalid_params)
+  it 'create failed' do
+    post articles_path(params: invalid_params)
     expect(response.status).to eq(422)
     expect(rendered_partials_count).to eq(2)
-    expect(rendered_partials).to include('articles/form', 'layouts/flash')
-    expect(streamed_ids).to include('form', 'flash-box')
+
+    # .._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)
   end
 end
 ```
 
-Test for a redirection could look like this: 
+The test for a redirection might look something like this:
 
 ```ruby
 it 'update success' do
@@ -112,6 +123,10 @@ it 'update success' do
 end
 ```
 
+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
 
 `save_action` (first parameter, boolean) true if successful

data/app/views/render_turbo_stream_partials.html.erb

@@ -1,11 +1,19 @@
 <% partials_count = 0 %>
 <% rendered_partials = [] %>
+<% htmls = [] %>
+<% htmls_by_id = {} %>
 <% streams.each do |s| %>
-  <% render s[:partial], locals: s[:locals], formats: [:html ] %>
+  <% html = (render s[:partial], locals: s[:locals], formats: [:html ]) %>
+  <% htmls.push(html) %>
+  <% htmls_by_id[s[:id]] ||= [] %>
+  <% htmls_by_id[s[:id]].push(html) %>
   <% partials_count += 1 %>
   <% rendered_partials.push(s[:partial]) %>
 <% end %>
 
 
 <%= content_tag :div, check.to_json, id: 'check-json' %>
-<%= content_tag :div, rendered_partials.to_json, id: 'rendered-partials' %>
+<%= 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

@@ -4,28 +4,40 @@ module RenderTurboStream
       e = Nokogiri::HTML(response.body).search('#check-json').first
       JSON.parse(e.inner_html).keys
     end
-    def rendered_partials
+
+    # returns array of strings of rendered partials inner-html
+    def rendered_partials_html
+      e = Nokogiri::HTML(response.body).search('#htmls').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
+      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
       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_where_id(id)
-      partials = Nokogiri::HTML(response.body).search('#rendered-partials').first
-      JSON.parse(e.inner_html)
-      partials.select{|p| p[id] == id }
+    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}
     end
 
     # returns the first partial that would be streamed to a given ID
-    def rendered_partials_find_id(id)
-      partials = Nokogiri::HTML(response.body).search('#rendered-partials').first
-      JSON.parse(e.inner_html)
-      partials.select{|p| p[id] == id }.first
+    def rendered_partials_params_find_id(id)
+      rendered_partials_params_where_id(id).first
     end
 
     def rendered_partials_count
-      rendered_partials.length
+      rendered_partials_paths.length
     end
     def turbo_redirected_to
       expect(response.status).to eq(302)

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "0.1.18"
+  VERSION = "0.1.20"
 end

data/lib/render_turbo_stream.rb

@@ -138,7 +138,8 @@ module RenderTurboStream
   def stream_partials(array)
 
     ary = []
-    array.dup.each do |props|
+    array.dup.each do |pr|
+      props = pr.symbolize_keys
       part = (props[:partial].present? ? props[:partial] : props[:id]).gsub('-', '_')
       partial = (part.to_s.include?('/') ? part : [controller_path, part].join('/'))
       r = props

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.20
 platform: ruby
 authors:
 - christian
@@ -24,10 +24,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.4.3
-description: |-
-  Writing views like (create|update).turbo_stream.haml annoyed me. This gem handles translated flash messages, sets status, and renders partials by turbo-stream. You can control them directly from the controller. It also handles redirection: turbo_power is included.
-
-  Comes with predefined helpers for enabling request-specs.
+description: 'Writing views like (create|update).turbo_stream.haml annoyed me. This
+  gem handles translated flash messages, sets status, and renders partials through
+  turbo-stream. You can control it directly from the controller. It also handles redirection:
+  turbo_power is included. Comes with predefined test helpers.'
 email:
 - christian@sedlmair.ch
 executables: []