render_turbo_stream 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c88aab0f6268663008843f37d2b7cd052f5883d4751c8c1558a16a166e06752
-  data.tar.gz: 97188c8d6d19998f7a6e617eb07a9de4a92c88b96d917908b738932301a0bc11
+  metadata.gz: 9a070060e95c95882e3bb687a37859fca7a46d6e4557695b5b1779fc2a37f9d9
+  data.tar.gz: cb01fb80b57bbc96d7418fed0164fff2ac72515ed13a1281672ea9a793e0ba00
 SHA512:
-  metadata.gz: cd3b7d91aa83267ff6f6f5da938fbf8e65704396b60cba5ff14ca82f9d15ad88954b330bbe170043514cba4cb67f7971ac57b55062828860e9e13c7129ef91b7
-  data.tar.gz: 3d7c1b8917846500a637dbb8ccb46b0535db82e4d64690c488d0fe8b98d070b51a88cb7d3c5cd41296c55f9f5d51b2bec66a0dea8fd981e9ab407e273568a93c
+  metadata.gz: 6ba050699fcda283665e128c364182ea115c5ba9d18090f2e17082597e182589f91a5a2165e6368fa5e4c6fc0a451d46fa869e3632cae50c9f91fb738a5eb3da
+  data.tar.gz: 33cdee02b396b110582ff6804e35702fb8d324148694f3c1b1246688a1ae757296167a22557b7b95703881de7cf0e7aa72ed812a989bc770684c0d58b03d9a85

data/README.md

@@ -28,6 +28,7 @@ spec/rails_helper.rb
 ```ruby
 RSpec.configure do |config|
   config.include RenderTurboStream::Test::RequestHelpers, type: :request
+  config.include RenderTurboStream::Test::RspecRequestHelpers, type: :request #=> if you are on rspec
 end
 ```
 
@@ -100,19 +101,25 @@ If the request format is not `turbo_stream`, which is the case on request specs,
 that contains the medadata that is interesting for our tests and is parsed by included test helpers. So tests could look
 like this:
 
-**The easiest test**
+**The fastest**
 
-If you want to check if a controller action succeeded, just check for `response.status`.
+If you want to check if a controller action succeeded, just check for `response.status`. The `turbo_stream_save` method returns three statuses: `200` if `save_action` is true, otherwise `422` and `302` for redirect. If one of the declared partials does not exist or breaks, the server will respond with exception anyway. 
+
+**rspec**
+
+For rspec there is a special helper, for a successful save action:
 
-The `turbo_stream_save` method returns three statuses: `200` if `save_action` is true, otherwise `422` and `302` for redirect. If one of the declared partials does not exist or breaks, the server will respond with exception anyway. So a test might look like this:
 ```ruby
-  it 'update failed' do
-  patch article_path(article, params: invalid_params)
-  expect(response.status).to eq(422)
+it 'update failed' do
+  patch article_path(article, params: valid_params)
+  expect_successful_saved('form', 'flash-box')
+  # expects response.status 200
+  # Make sure that the responses point to exactly these 2 IDs ('form' and 'flash-box').
+  # Make sure that each ID is responded to exactly once.
 end
 ```
 
-**Test redirection**
+**Redirection**
 ```ruby
   it 'update success' do
     patch article_path(article, params: valid_params)
@@ -134,7 +141,7 @@ expect(partial_response('articles/form', id: 'form', css: '.field_with_errors',
 # Check the content inside at least one in any of the elements that match the given css and check the id that turbo has pointed to..
 ```
 
-**More detailed test**
+**More detailed**
 
 Consider a controller action that should respond in 2 flashes.
 
@@ -155,6 +162,9 @@ expect(
   end
 ).to eq(1)
 ```
+`partial_response_count` always returns the number of matched responses.
+
+Possible matches can be found at [Nokogiri](https://nokogiri.org/tutorials/searching_a_xml_html_document.html)
 
 P.S.:
 

data/app/views/render_turbo_stream_partials.html.erb

@@ -2,7 +2,7 @@
 
 <% streams.each do |s| %>
 
-  <% html = (render s[:partial], locals: s[:locals].symbolize_keys, formats: [:html]) %>
+  <% html = (render s[:partial], locals: s[:locals]&.symbolize_keys, formats: [:html]) %>
 
   <% rendered_partials.push({ html_response: html }.merge(s)) %>
 

data/app/views/render_turbo_stream_partials.turbo_stream.erb

@@ -17,21 +17,21 @@
     <% ctl[:action] = :replace %>
     <% Rails.logger.debug("  • render-turbo-stream REPLACE => #{info}") %>
     <%= turbo_stream.replace s[:id] do %>
-      <%= render s[:partial], locals: s[:locals].symbolize_keys %>
+      <%= render s[:partial], locals: s[:locals]&.symbolize_keys %>
     <% end %>
 
   <% elsif s[:action].to_sym == :prepend %>
     <% ctl[:action] = :prepend %>
     <% Rails.logger.debug("  • render-turbo-stream PREPEND => #{info}") %>
     <%= turbo_stream.prepend s[:id] do %>
-      <%= render s[:partial], locals: s[:locals].symbolize_keys %>
+      <%= render s[:partial], locals: s[:locals]&.symbolize_keys %>
     <% end %>
 
   <% elsif s[:action].to_sym == :append %>
     <% ctl[:action] = :append %>
     <% Rails.logger.debug("  • render-turbo-stream APPEND => #{info}") %>
     <%= turbo_stream.prepend s[:id] do %>
-      <%= render s[:partial], locals: s[:locals].symbolize_keys %>
+      <%= render s[:partial], locals: s[:locals]&.symbolize_keys %>
     <% end %>
 
   <% else %>

data/lib/render_turbo_stream/test/request_helpers.rb

@@ -58,6 +58,9 @@ module RenderTurboStream
         c == 1
       end
 
+      def partial_ids
+        RenderTurboStream::Libs.partial_ids(response)
+      end
     end
   end
 end

data/lib/render_turbo_stream/test/rspec_request_helpers.rb

@@ -0,0 +1,26 @@
+module RenderTurboStream
+  module Test
+    module RspecRequestHelpers
+
+
+      # expect status 200 and a each one time response to given ids
+
+      def expect_successful_saved(*ids)
+        responses = RenderTurboStream::Libs.all_responses(response)
+        counts = {}
+        responses.each do |r|
+          counts[r['id']] ||= 0
+          counts[r['id']] +=1
+        end
+
+        expect(response.status).to eq(200)
+        expect(counts.keys.length).to eq(ids.length)
+        ids.each do |id|
+          expect(counts.key?(id)).to be_truthy
+          expect(counts[id]).to eq(1)
+        end
+      end
+
+    end
+  end
+end

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "1.1.0"
+  VERSION = "1.2.1"
 end

data/lib/render_turbo_stream.rb

@@ -2,6 +2,7 @@ require "render_turbo_stream/version"
 require "render_turbo_stream/railtie"
 require 'render_turbo_stream/engine'
 require 'render_turbo_stream/test/request_helpers'
+require 'render_turbo_stream/test/rspec_request_helpers'
 
 module RenderTurboStream
 
@@ -233,6 +234,18 @@ module RenderTurboStream
       part.length
     end
 
+    def self.partial_ids(response)
+      all = all_responses(response)
+      ids = []
+      all.each do |p|
+        _p = p['id']
+        unless ids.include?(_p)
+          ids.push(_p)
+        end
+      end
+      ids
+    end
+
     def self.partial_response_count(response, partial, id, total, &block)
       responses = select_responses(response, partial, id)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - christian
@@ -44,6 +44,7 @@ files:
 - lib/render_turbo_stream/engine.rb
 - lib/render_turbo_stream/railtie.rb
 - lib/render_turbo_stream/test/request_helpers.rb
+- lib/render_turbo_stream/test/rspec_request_helpers.rb
 - lib/render_turbo_stream/version.rb
 - lib/tasks/render_turbo_stream_tasks.rake
 homepage: https://gitlab.com/sedl/renderturbostream
@@ -71,5 +72,5 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Render turbo-stream partials directly from the controller. Test helpers included
+summary: Render turbo-stream partials directly from the controller. Test helpers included.
 test_files: []