render_turbo_stream 0.1.16 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d66da3caed655e785c5387c8fe154dfafa59596aabddfa78e66c78f3447db23
-  data.tar.gz: 9825d6878ed1f2df13c518e74383a714ead6c70c19514282f1afe55260c7e005
+  metadata.gz: fd4172769edde2afebf684b4a53c6497e255b1acf0e03b5ca8fe2ba93b64437d
+  data.tar.gz: 1c99586db62a402be30535c39bf3d60b279fdb269000b2b362b49e1fa935308d
 SHA512:
-  metadata.gz: 1819b9a272d55ffe7fb3abde7e36fc060c952669880767727b3e1e052a7fd16420ee367c63fe7e382b88197972f9a4abe54cb0521c6298a18c977b6f82c4fe3a
-  data.tar.gz: 134b4a2ed93a6d4b76e9ba47107f565d856bada2dfff5f2db4f07e4b323da1b4ce4620c5f1c333223531c1f291f12035669a6460935c985d0adfc6d2f77b0340
+  metadata.gz: 510284ee5f2b48df8161f0dc7a4552b5f9785b8c6d49a6b71dcdd98f37804bd22874a63e2f8f2f3b4967454fedfed8d3e2eb98bbfb85645a7e4cf83f4311c4d8
+  data.tar.gz: e0336ad09c42899b3c1b9d6d717cd1ec7b6a5781df932bf52956b643304170418dabd2334f4b99509e0059fa37f7a81f6a6672e22b9705890d400cd02a812eb0

data/README.md

@@ -4,7 +4,7 @@ Defining templates like `(create|update).turbo_stream.haml` annoyed me.
 
 Working consistently with turbo_stream means shooting lots of partials from the backend to the frontend, which always needs the same attributes: ID, partial, and maybe some locals. This gem serializes that: Partials can be controlled directly from the controller.
 
-It sets the status, generates a flash message, handles redirection, pushes it all to the front and prepares a response for request-specs.
+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.
 
 ## Installation
 
@@ -79,22 +79,26 @@ stream_partial(
 
 ## Testing
 
-For system testing you need capybara.
+For system testing there is capybara.
 
-For enabling request specs:
+For Tests on request level there are some helpers:
 
-If `request.format` is not `turbo_stream` the method responds as `json` with status.
-`response.body` returns a `json` where the key is the `html-ID` that is used by turbo-stream with the properties of the partials. Testing by rspec could look like this: 
+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:
 
 ```ruby
-it 'update failed' do
-  a = FactoryBot.create(:article)
-  patch article_path(a, params: invalid_params)
-  expect(response.status).to eq(422)
-  h = JSON.parse(response.body)
-  expect(h['form']['partial']).to eq('articles/form')
-  expect(h['flash-box']['partial']).to eq('layouts/flash')
-  expect(h.keys.length).to eq(2)
+require 'rails_helper'
+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)
+    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')
+  end
 end
 ```
 
@@ -102,11 +106,9 @@ Test for a redirection could look like this:
 
 ```ruby
 it 'update success' do
-    a = FactoryBot.create(:article)
-    patch article_path(a, params: valid_params)
-    expect(response.status).to eq(302)
-    r = JSON.parse(response.body)
-    expect(r['redirected_to']).to eq(articles_path)
+  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)»
 end
 ```
 

data/app/views/render_turbo_stream_partials.html.erb

@@ -0,0 +1,11 @@
+<% partials_count = 0 %>
+<% rendered_partials = [] %>
+<% streams.each do |s| %>
+  <% render s[:partial], locals: s[:locals], formats: [: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' %>

data/lib/render_turbo_stream/test_helpers.rb

@@ -0,0 +1,36 @@
+module RenderTurboStream
+  module TestHelpers
+    def rendered_ids
+      e = Nokogiri::HTML(response.body).search('#check-json').first
+      JSON.parse(e.inner_html).keys
+    end
+    def rendered_partials
+      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 }
+    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
+    end
+
+    def rendered_partials_count
+      rendered_partials.length
+    end
+    def turbo_redirected_to
+      expect(response.status).to eq(302)
+      r = JSON.parse(response.body)
+      r['redirected_to']
+    end
+  end
+end

data/lib/render_turbo_stream/version.rb

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

data/lib/render_turbo_stream.rb

@@ -1,6 +1,7 @@
 require "render_turbo_stream/version"
 require "render_turbo_stream/railtie"
 require 'render_turbo_stream/engine'
+require 'render_turbo_stream/test_helpers'
 
 module RenderTurboStream
 
@@ -149,13 +150,24 @@ module RenderTurboStream
     if request.format.to_sym == :turbo_stream
       render template: 'render_turbo_stream_partials', locals: { streams: ary }, layout: false
     else
+      if Rails.env.test?
+        check_ids = {}
+        ary.each do |a|
+          if a[:action] == 'replace'
+            check_ids[a[:id]] ||= 0
+            check_ids[a[:id]] += 1
+            throw "More than one partial rendered to ID «#{a[:id]}» by replace" if check_ids[a[:id]] >= 2
+          end
+        end
+      end
       check = {}
       ary.each do |a|
         b = a.dup
         b.delete(:id)
         check[a[:id]] = b
       end
-      render json: check
+      # render json: check
+      render template: 'render_turbo_stream_partials', locals: { check: check, streams: ary }, layout: false, formats: :html
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.18
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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.'
+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.
 email:
 - christian@sedlmair.ch
 executables: []
@@ -37,11 +37,13 @@ files:
 - README.md
 - Rakefile
 - app/controllers/render_turbo_stream/application_controller.rb
+- app/views/render_turbo_stream_partials.html.erb
 - app/views/render_turbo_stream_partials.turbo_stream.erb
 - app/views/render_turbo_stream_redirect.turbo_stream.erb
 - lib/render_turbo_stream.rb
 - lib/render_turbo_stream/engine.rb
 - lib/render_turbo_stream/railtie.rb
+- lib/render_turbo_stream/test_helpers.rb
 - lib/render_turbo_stream/version.rb
 - lib/tasks/render_turbo_stream_tasks.rake
 homepage: https://gitlab.com/sedl/renderturbostream