render_turbo_stream 0.1.19 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f816fb8eab0243274dc8b448982358b90e12fe3d7d431f104dd12d3e56d2aacb
-  data.tar.gz: 1b515e61a40ac0126aba2cc43940b181f3fca19e3305320d13eb0e5848f4fc7e
+  metadata.gz: 9b84c79cfe97c99b55813d6a22ebcf0267e6dc7ee66b9a6c8bb922c8f5cf812b
+  data.tar.gz: 420971446a65cbda6c141be9c32941ddf991944cbb3c84f9f2eb259cf077c3b6
 SHA512:
-  metadata.gz: a98cc8fff61ac5044c0af6051a59262383b1f41d5b1559bcfc2ccd3b87e46df14a576fd7615286c51617e76b2570046f84c10dade94c71c9757103fe29116a3b
-  data.tar.gz: c09722e38db120023eb577187ef4f7c1b1e3562a6ab6af6cf9ed3f86f2b8acf36df96d1aa621cbc796ad73cf272d9adbb67d9ebd2f3872cbfcc73447b9041438
+  metadata.gz: 3bc0935233cc25323b8f92e12227308d680b24d6ea532786e685c75d6500158d68991dd9babe5d2bc1424ca8c93f43912528cc8a4abac6363c636331d8929fd5
+  data.tar.gz: f2ee4939746a8b7d4dc06df81920e55baa3c5bce6ee26b04778b91e5067ffb846e436fddeed2c4868f9ea9b0ca5876a8f4e29a65f146fc438c362bfbc7c13c05

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,32 @@ 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')
+    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')
+
+    expect(partials_params_by_id['flash-box'].length).to eq(1)
+    expect(partials_params_by_id['flash-box'].first['partial']).to eq('layouts/flash')
+
+    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')
+
+    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
 ```
 
-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 +126,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,34 @@
 <% partials_count = 0 %>
 <% rendered_partials = [] %>
+<%# htmls = [] %>
+<% htmls_by_id = {} %>
+<% params_by_id = {} %>
+<% htmls_by_path = {} %>
+<% params_by_path = {} %>
 <% 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) %>
+  <% 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, rendered_partials.to_json, id: 'rendered-partials' %>
+<%#= 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

@@ -1,32 +1,47 @@
 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
-    def rendered_partials
-      e = Nokogiri::HTML(response.body).search('#rendered-partials').first
+
+    def partials_params_by_id
+      e = Nokogiri::HTML(response.body).search('#params_by_id').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
+    # 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)
-      partials.select{|p| p[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
+    # 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)
-      partials.select{|p| p[id] == id }.first
     end
 
-    def rendered_partials_count
-      rendered_partials.length
+    # count of rendered parials
+    def partials_count
+      partials_paths.length
     end
+
+    # 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
+
+    # 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.19"
+  VERSION = "0.1.21"
 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.19
+  version: 0.1.21
 platform: ruby
 authors:
 - christian