render_turbo_stream 0.1.35 → 0.1.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7009da829a23424793f7a032d3de9600465af5837204c63da84f28818a292aa2
-  data.tar.gz: 417b01b78e4939cd175e80a71bd80c593d91ca5c1578479afbe0a62554c0713a
+  metadata.gz: 5aec959a7ad9663de11285bba5734246b90b764235464a41da68e80a35dc2609
+  data.tar.gz: d38bc6507be14b63af99e268cf167c567836cd7021d6777e6c31dac02b73c80e
 SHA512:
-  metadata.gz: bac76150d7cdff0b7f2dcd895f798041e18381fcc0862a4afddbd8c7442a09cdb10dac85b80004d54e4c9c8e87cf99c2a5a20d86ea1f5399026033dd14b5b9ff
-  data.tar.gz: e9b03231a29046f79049d53e3c1c1eb2fea122661ce0e5ca28e2988afb507a4f13538b71ccb879f6c7d0ee1ab34727a0d2c9b0b845f307528f26500d35391a3b
+  metadata.gz: d0ab474fc5ea832bf2ea135af3696ea0fd3d032cb17ebe8847262d7fbd53ab86e038fa37e28b497b3b7d9892e2c680aa153ba06d9e059b21cff82d682bb18099
+  data.tar.gz: b9954342146266f214581d689fdbd0b1084fd8bb0d4d64e8e08bdbd07c931cb39e950953f6dc56c946941a922a3e39b3eee8401559548a0164ea2185d3f692d6

data/README.md

@@ -2,11 +2,15 @@
 
 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.
+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 comes with predefined helpers for enabling 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.
 
-An overview of how we design a rails-7 application with turbo is [published on dev.to](https://dev.to/chmich/rails-7-vite-wrapping-up-1pia).
+An overview of how we design a rails-7 application with turbo
+is [published on dev.to](https://dev.to/chmich/rails-7-vite-wrapping-up-1pia).
 
 ## Installation
 
@@ -34,35 +38,39 @@ end
 
 Redirection
 
-For redirection to work, you must follow the installation steps from [turbo_power](https://github.com/marcoroth/turbo_power).
+For redirection to work, you must follow the installation steps
+from [turbo_power](https://github.com/marcoroth/turbo_power).
 
 Required Configurations for Flash Partial
 
 ```ruby
     config.x.render_turbo_stream.flash_partial = 'layouts/flash'
-    config.x.render_turbo_stream.flash_id = 'flash-box'
-    config.x.render_turbo_stream.flash_action = 'prepend'
+config.x.render_turbo_stream.flash_id = 'flash-box'
+config.x.render_turbo_stream.flash_action = 'prepend'
 ```
 
 The corresponding partials for flashes could look [like this](https://gitlab.com/sedl/renderturbostream/-/wikis/flashes)
 
 ## Usage
 
-`turbo_stream_save` is a special method for streamlining `update` or `create` functions for `turbo_stream`, which might look like this:
+`turbo_stream_save` is a special method for streamlining `update` or `create` functions for `turbo_stream`, which might
+look like this:
 
 ```ruby
- def create
-    @customer = Customer.new(customer_params)
 
-    turbo_stream_save(
-      @customer.save,
-      redirect_on_success_to: edit_customer_path(@customer)
-    )
+def create
+  @customer = Customer.new(customer_params)
 
-  end
+  turbo_stream_save(
+    @customer.save,
+    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(
@@ -93,38 +101,37 @@ stream_partial(
 
 ## Testing
 
-For system testing we have 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 system testing we have 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:
 
-If the request format is not `turbo_stream`, which is the case on request specs, the method responds in a special html that contains the medadata that is interesting for our tests and is parsed 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 html
+that contains the medadata that is interesting for our tests and is parsed by included test helpers. So tests could look
+like this:
 
 ```ruby
 require 'rails_helper'
 include RenderTurboStream::TestHelpers
 
 RSpec.describe "Articles", type: :request do
-  
+
   let(:invalid_params) { { article: { title: '', desciption: 'abc' } } }
 
   it 'create failed' do
-    
+
     post articles_path(params: invalid_params)
 
-    # --- BASIC TEST ---
-    
-    # Count of rendered partials
-    expect(partials_count).to eq(2)
-    # Make sure that each of these partials is rendered exactly once.
-    expect(partials_once).to include('layouts/flash', 'articles/form')
-    
-    
-    
-    
-    # --- MORE OPTIONS ---
-
-    # to which html-ids turbo-stream would point
-    expect(partials_ids).to include('flash-box', 'form')
+    # ----- BASIC -----
+
+    # Exactly which partials were rendered to which ids
+    expect(
+      partials_once(
+        { partial: 'layouts/flash', id: 'flash-box' },
+        { partial: 'articles/form', id: 'form' })
+    ).to be_truthy
+
+    # ----- MORE OPTIONS -----
 
     # partial_response (singular) returns false unless partial responded exactly one time, otherwise the content in nokogiri format: https://nokogiri.org/tutorials/searching_a_xml_html_document.html#basic-searching
     r = partial_response(id: 'flash-box')
@@ -136,15 +143,17 @@ RSpec.describe "Articles", type: :request do
 
     # COUNTS
 
-    # Check the number of ids responded to
-    expect(partials_ids_count).to eq(2)
-
     # Check how many times a specific ID has been responded to.
     expect(partials_responses(id: 'flash-box').length).to eq(1)
 
     # Same with partials
-    
+
     expect(partials_responses(partial: 'layouts/flash').length).to eq(1)
+
+    # little helper for showing a array of prepared flashes and all what the renderer has done
+    expect(partials_log.join('')).to include('Article could not be created')
+    expect(partials_log.join('')).to include('layouts/flash')
+
   end
 end
 ```
@@ -161,7 +170,8 @@ 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.
+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 for turbo_stream_save
 
@@ -212,4 +222,5 @@ example value: `"%<model_name>s successfully created"`
 Contribution welcome.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/render_turbo_stream/request_test_helpers.rb

@@ -29,30 +29,6 @@ module RenderTurboStream
       res.map { |r| Nokogiri::HTML(r['html_response']) }
     end
 
-    def partials_ids_count
-      partials_ids.length
-    end
-
-    def partials_count
-      partials.length
-    end
-
-    # array of strings of ids of rendered partials that turbo_stream pointed to
-    def partials_ids
-      ary = partials_attributes
-      ids = []
-      ary.each { |a| ids.push(a['id']) unless ids.include?(a['id']) }
-      ids
-    end
-
-    # array of strings of paths by which partials are rendered, for example: ['articles/form'].
-    def partials
-      ary = partials_attributes
-      paths = []
-      ary.each { |a| paths.push(a['partial']) unless paths.include?(a['partial']) }
-      paths
-    end
-
     # without arguments: returns array of strings of paths by which partials that are exactly one time rendered, for example: ['articles/form'].
     # if arguments provided: compares with result and returns boolean
     # examples:
@@ -83,7 +59,7 @@ module RenderTurboStream
               if !paths_once.include?(_a[:partial])
                 res = false
               elsif _a.key?(:id)
-                r = ary.select{|a|a['partial'] == _a[:partial]}.first
+                r = ary.select { |a| a['partial'] == _a[:partial] }.first
                 res = r['id'] == _a[:id]
               end
             end
@@ -109,5 +85,25 @@ module RenderTurboStream
       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 flash[:alert].present?
+        r.push("flash[:alert]: «#{flash[:alert]}»")
+      end
+      if flash[:notice].present?
+        r.push("flash[:notice]: «#{flash[:notice]}»")
+      end
+      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']}»"].join(' ')
+          r.push(str)
+        end
+      end
+      r
+    end
   end
 end

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "0.1.35"
+  VERSION = "0.1.37"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 0.1.35
+  version: 0.1.37
 platform: ruby
 authors:
 - christian