render_turbo_stream 0.1.41 → 0.1.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9094ebe69f34f4acb61696aff5741b6d1eecaf934b17662bd81d6e5dda8533f9
-  data.tar.gz: b2a90bca1d9489b59a2de3cc4522b35f9ea81298f55472582adfa597a2a5a553
+  metadata.gz: b7105e78e4f7d96782d8bb94cdddefdb3698c68855cd16155dd575660095fa83
+  data.tar.gz: ff253ad1317fe42d6c3c617c7c2bb23933c5101330bcf9d3710cd06d6ae09a97
 SHA512:
-  metadata.gz: c486823d9469018277398ee19ab7b95291ad0ed607e0abc6e01d1c1497358e2befca6f4ded2e6272ec86005e07c8eef9de2c66078a3c301300eaafb3d18ed0cb
-  data.tar.gz: a4e3e4cb03a640d6f64b4c4efee892e539c0c5dfd34074be5ee5d0fc6dc259f5707a86cca36fd5e7cfcfdf93cddba91cc4e96b9e209c084eec1d3ab806fcf257
+  metadata.gz: df9dd9941005c649c125778ca0c2d35ba4672f5bb742457040fe16513db1078ab34bc140b859400336aa79cce70e4695ba5a8f91bbd185209535867a2cd9da23
+  data.tar.gz: 6ef0ec59e35da7fcac18c697bc06c70ca3247107891a9ce02c1ba2f3987d34c439ef97cc18fa5591b7dae441a435a7a0c275e8e4e9ab7d62b548d9da41570762

data/README.md

@@ -58,19 +58,15 @@ look like this:
 
 ```ruby
 
-def create
-  @customer = Customer.new(customer_params)
-
+def update
   turbo_stream_save(
-    @customer.save,
+    @customer.update(customer_params),
     redirect_on_success_to: edit_customer_path(@customer)
   )
-
 end
 ```
 
-This will set a status, generate a flash message and perform `stream_partials`, which could result in something like
-this:
+This will set a status, generate a flash message and perform `stream_partials`, which could result in something like this:
 
 ```ruby
 stream_partials(
@@ -101,7 +97,7 @@ stream_partial(
 
 ## Testing
 
-For system testing we have Capybara. This works great and is necessary for javascript and backend combined apps, but it
+For system testing there is Capybara. This works great and is necessary for javascript and backend combined apps, but it
 is good practice to break tests into smaller pieces.
 
 For the much faster request-level tests, there are some helpers:
@@ -126,11 +122,20 @@ RSpec.describe "Articles", type: :request do
     expect(partials_log.join('')).to include('Article could not be created')
     expect(partials_log.join('')).to include('layouts/flash')
 
-    expect(partials_count).to eq(2) #=> 2 partials (form and a flash) are rendered
-    expect(assert_partials('layouts/flash', id: 'flash-box')).to be_truthy #=> expect flash to render exact one time to html-id 'flash-box' by turbo-stream
-    expect(assert_partials('articles/form', id: 'form')).to be_truthy #=> expect flash to render exact one time to html-id 'form' by turbo-stream
+    expect(partials_count).to eq(2)
+    #=> 2 partials in total: form, flash, no matter how many times each is rendered (example «flash»: a flash partial can be rendered several times)
 
+    expect(partial_response('form')).to eq(true)
+    expect(partial_response('layouts/flash')).to eq(true)
+    expect(partial_response('flash', id: 'flash-wrapper', count: 1)).to eq(true)
+    #=> id is the ID that turbo-stream pointed to (for replace/append/... an item)
+
+    expect(partial_response('flash'){|r|r.inner_html.include?('Article could not be created')}).to eq(true)
+    expect(partial_response('flash'){|r|r.css('div').inner_html.include?('Article could not be created')}).to eq(true)
+    #=> you can use the validators of nokogiri, check: https://nokogiri.org/tutorials/parsing_an_html_xml_document.html
+    #=> if a partial was rendered more than once: at least one response must match
   end
+
 end
 ```
 
@@ -151,29 +156,33 @@ includes the plugin and has tests done by rspec/request and capybara.
 
 ## Parameters for turbo_stream_save
 
-`save_action` (first parameter, boolean) true if successful
-
-`redirect_on_success_to:` path for redirection in case of success, if nil: no redirection.
-
-`success_message:` custom message if action is successful
-
-`error_message:` custom message if action has failed
-
-`object:` default: object (e.g. @customer) is derived from controller name
-
-`id:` html-ID for the object that is replaced by turbo_stream, if nil: no partial is rendered
-
-`partial:` default: 'form', assumes `controller_path`/_form
-
-`locals:` locals for the partial, as hash
-
-`replace_on_success:` array of hashes: `[{ id: nil, partial: '', locals: {} }]`
-
-`replace_on_error:` array of hashes: `[{ id: nil, partial: '', locals: {} }]`
-
-`add_flash_notices:` additional alerts for the case of failure, example: `["custom-success-message"]`
-
-`add_flash_alerts:` additional alerts for the case of success, example: `["custom-error-message"]`
+    save_action,
+    redirect_on_success_to: nil,
+    object: nil, # object used in save_action, example: @customer
+    id: 'form', # if nil: no partial is rendered
+    partial: nil, # example: 'customers/form' default: "#{controller_path}/#{id}"
+    action: 'replace', # options: append, prepend
+    locals: {}, # locals used by the partial
+    streams_on_success: [
+      {
+        id: nil,
+        partial: 'form',
+        locals: {},
+        action: 'replace'
+      }
+    ], # additional partials that should be rendered if save_action succeeded
+    streams_on_error: [
+      {
+        id: nil,
+        partial: 'form',
+        locals: {},
+        action: 'replace'
+      }
+    ], # additional partials that should be rendered if save_action failed
+    add_flash_alerts: [], #=> array of strings
+    add_flash_notices: [], #=> array of strings
+    flashes_on_success: [], #=> array of strings
+    flashes_on_error: [] #=> array of strings
 
 ## Requirements
 

data/lib/render_turbo_stream/test/request_helpers.rb

@@ -0,0 +1,52 @@
+module RenderTurboStream
+  module Test
+    module RequestHelpers
+
+      # count of rendered partials
+      # count rendering different partials (example: «customer/form»)
+      # doesnt check how often a specific partial is rendered
+
+      def partials_count
+        RenderTurboStream::Libs.partials_count(response)
+      end
+
+
+
+      # log as helper for the developer to see which flash is set and which partials are rendered to wich ids
+      def partials_log
+        all_responses = RenderTurboStream::Libs.all_responses(response)
+        r = []
+        if response.status == 302
+          r.push("redirect to #{turbo_redirect_to}")
+        else
+          all_responses.map do |a|
+            str = [
+              a['action'],
+              'id',
+              "«#{a['id']}»",
+              'by partial',
+              "«#{a['partial']}»",
+              (a['locals'].present? ? "locals: «#{a['locals']}»" : nil)
+            ].compact.join(' ')
+            r.push(str)
+          end
+        end
+        r
+      end
+
+
+      # Returns the path to which turbo_stream.redirect_to would be applied.
+      def turbo_redirect_to
+        expect(response.status).to eq(302)
+        r = JSON.parse(response.body)
+        r['redirected_to']
+      end
+
+
+      def partial_response(partial, id: nil, count: 1, &block)
+        RenderTurboStream::Libs.partial_response(response, partial, id, count, &block )
+      end
+
+    end
+  end
+end

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "0.1.41"
+  VERSION = "0.1.43"
 end

data/lib/render_turbo_stream.rb

@@ -1,7 +1,7 @@
 require "render_turbo_stream/version"
 require "render_turbo_stream/railtie"
 require 'render_turbo_stream/engine'
-require 'render_turbo_stream/request_test_helpers'
+require 'render_turbo_stream/test/request_helpers'
 
 module RenderTurboStream
 
@@ -191,4 +191,69 @@ module RenderTurboStream
       ]
     )
   end
+
+  class Libs
+    def self.all_responses(response)
+      e = Nokogiri::HTML(response.body).search('#rendered-partials').first
+      JSON.parse(e.inner_html)
+    end
+
+    # if partial is one word, its checked against the last behind the slash, example: 'articles/form' matches 'form'
+
+    def self.select_responses(response, partial, id)
+      all = all_responses(response)
+
+      all.select do |a|
+        partial_matched = if !partial.present?
+                            false
+                          elsif partial.include?('/')
+                            a['partial'] == partial
+                          else
+                            a['partial'].split('/').last == partial
+                          end
+        id_matched = if !id.present?
+                       false
+                     else
+                       a['id'] == id
+                     end
+        partial_matched || id_matched
+      end
+
+    end
+
+    def self.partials_count(response)
+      all = all_responses(response)
+      part = []
+      all.each do |p|
+        _p = p['partial']
+        unless part.include?(_p)
+          part.push(_p)
+        end
+      end
+      part.length
+    end
+
+    def self.partial_response(response, partial, id, count, &block)
+      responses = select_responses(response, partial, id)
+      if block_given?
+
+        success = false
+
+        responses.each do |r|
+          parsed = Nokogiri::HTML(r['html_response'])
+          r = yield parsed
+          success = true if r.present?
+        end
+        success
+
+      else
+        if count
+          responses.length == count
+        else
+          nil
+        end
+      end
+    end
+
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 0.1.41
+  version: 0.1.43
 platform: ruby
 authors:
 - christian
@@ -26,8 +26,8 @@ dependencies:
         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 through
-  turbo-stream. You can control it directly from the controller. It also handles redirection:
-  turbo_power is included. Comes with predefined test helpers.'
+  turbo-stream. You can control them directly from the controller. It also handles
+  redirection: turbo_power is included. Includes helpers for enabling request testing.'
 email:
 - christian@sedlmair.ch
 executables: []
@@ -43,7 +43,7 @@ files:
 - lib/render_turbo_stream.rb
 - lib/render_turbo_stream/engine.rb
 - lib/render_turbo_stream/railtie.rb
-- lib/render_turbo_stream/request_test_helpers.rb
+- lib/render_turbo_stream/test/request_helpers.rb
 - lib/render_turbo_stream/version.rb
 - lib/tasks/render_turbo_stream_tasks.rake
 homepage: https://gitlab.com/sedl/renderturbostream
@@ -71,5 +71,6 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Render turbo-stream partials directly from the controller
+summary: Render turbo-stream partials directly from the controller, including test
+  helpers
 test_files: []

data/lib/render_turbo_stream/request_test_helpers.rb

@@ -1,107 +0,0 @@
-module RenderTurboStream
-  module RequestTestHelpers
-
-    # returns false if partial is rendered cero or multiple times
-    # response can be searched by nokogiri https://nokogiri.org/tutorials/searching_a_xml_html_document.html#basic-searching
-    def partial_response(id: nil, partial: nil)
-      res = partials_responses(id: id, partial: partial)
-      if res.length != 1
-        false
-      else
-        res.first
-      end
-    end
-
-    # like partial_response, but returns an array with length of how many times partial was rendered
-    #
-
-    # def partials_responses(id: nil, partial: nil)
-    #   ary = partials_attributes
-    #   if id && partial
-    #     res = ary.select { |a| a['partial'] == partial && a['id'] == id }
-    #   elsif id
-    #     res = ary.select { |a| a['id'] == id }
-    #   elsif partial
-    #     res = ary.select { |a| a['partial'] == partial }
-    #   else
-    #     raise 'missing parameter'
-    #   end
-    #   res.map { |r| Nokogiri::HTML(r['html_response']) }
-    # end
-
-    # if no count given: expects exactly one match
-
-    def assert_partials(partial, id: nil, count: 1, &block)
-      partials = partials_attributes
-      if id && partial
-        part = partials.select { |a| a['partial'] == partial && a['id'] == id }
-      elsif id
-        part = partials.select { |a| a['id'] == id }
-      elsif partial
-        part = partials.select { |a| a['partial'] == partial }
-      else
-        raise 'missing parameter'
-      end
-      if block_given?
-        part.each do |r|
-          noko = Nokogiri::HTML(r['html_response'])
-        end
-      else
-        if count
-          part.length == count
-        else
-          part.length
-        end
-      end
-    end
-
-    # count of rendered partials
-    # count rendering different partials (example: «customer/form»)
-    # doesnt check how often a specific partial is rendered
-
-    def partials_count
-      part = []
-      partials_attributes.each do |p|
-        _p = p['partial']
-        unless part.include?(_p)
-          part.push(_p)
-        end
-      end
-      part.length
-    end
-
-    # returns an array of hashes with the attributes used to call partials and the response (html as string) from the partial.
-    def partials_attributes
-      e = Nokogiri::HTML(response.body).search('#rendered-partials').first
-      JSON.parse(e.inner_html)
-    end
-
-    # Returns the path to which turbo_stream.redirect_to would be applied.
-    def turbo_redirect_to
-      expect(response.status).to eq(302)
-      r = JSON.parse(response.body)
-      r['redirected_to']
-    end
-
-    # log as helper for the developer to see which flash is set and which partials are rendered to wich ids
-    def partials_log
-      r = []
-      if response.status == 302
-        r.push("redirect to #{turbo_redirect_to}")
-      else
-        partials_attributes.map do |a|
-          str = [
-            a['action'],
-            'id',
-            "«#{a['id']}»",
-            'by partial',
-            "«#{a['partial']}»",
-            (a['locals'].present? ? "locals: «#{a['locals']}»" : nil)
-          ].compact.join(' ')
-          r.push(str)
-        end
-      end
-      r
-    end
-  end
-end