render_turbo_stream 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc78913dcbad95c4f8de2b0188ab6eff2db1ac2390590a491427af071f2fa55
-  data.tar.gz: c2d381f27a631862490811f5c140f91245370ad3b1b82e3ba41771707adae732
+  metadata.gz: aa9b9cefa95d380af39fd2f096f569cb4eabe94fe024164722cae8497b7d076f
+  data.tar.gz: 9973fe128954730c6b1dc9f52ecc63a6b633951d118f06eae0e2672c54a519d2
 SHA512:
-  metadata.gz: 5873014fd22b2b1d4d2ded650f37bdc5f6e865ada01608c82ad2c891199c1e342bb6e7a4d94319c6e92c0cfea196fb19230cdebc931915fb2b2e420cc3ab1653
-  data.tar.gz: 854105573f8b7a5b8f34ac031d93c4e0a01eb2f5b4263a1495cfac17d53a391431c0ec5a339a5666e4ec8340d029218c2914501fba1a65869508185661d0eab9
+  metadata.gz: 1738911b840851ed5d3974702bea36029f8bcb453786b5524bef7c1f2fee0ee78dccfc0f275e8e5f72b724f787425aa13f821c7c251c5ad92876c5c728b2bad5
+  data.tar.gz: 6be68eb76a040ab06fb97380d80d03ce16e55096819062a5c8760604a5d9df5808ba1c72229afe7a9807e9ec6c6e69a305b17be2a94ed110eae4ec8461c148cd

data/README.md

@@ -12,13 +12,19 @@ Currently it is only possible by copy and paste the code, see below.
 
 ## Installation
 
-Because of [that issue](https://github.com/rails/rails/issues/47954) appying this feature is currently only possible by copy and paste following files to your app
+```ruby
+gem 'render_turbo_stream'
+```
 
-[application_controller](https://gitlab.com/sedl/renderturbostream/-/wikis/application_controller)
+```shell
+bundle install
+```
 
-[layout/render_partials.turbo_stream.erb](https://gitlab.com/sedl/renderturbostream/-/wikis/layout/render.turbo_stream.erb)
+**ApplicationController**
 
-[layouts/render_redirect.turbo_stream.erb](https://gitlab.com/sedl/renderturbostream/-/wikis/layouts/render_redirect.turbo_stream.erb)
+```ruby
+include RenderTurboStream
+```
 
 The corresponding partials for flashes could look [like this](https://gitlab.com/sedl/renderturbostream/-/wikis/flashes)
 
@@ -72,13 +78,9 @@ stream_partial(
 For system testing you need capybara.
 
 For enabling request specs:
-If `request.format` is not `turbo_stream` the method responds as `json` with status:
-
-Success and redirection: `302`
-Success without redirection: `200`
-Save Action failed: `422` `:unprocessable_entity`
 
-Testing the `response.body` by rspec could look like this: 
+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: 
 
 ```ruby
 it 'update failed' do
@@ -92,6 +94,18 @@ it 'update failed' do
 end
 ```
 
+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)
+end
+```
+
 ## Parameters
 
 `save_action` (first parameter, boolean) true if successful

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "0.1.11"
+  VERSION = "0.1.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - christian
@@ -24,7 +24,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.4.3
-description: Coming soon
+description: 'Writing views like (create|update).turbo_stream.haml annoyed me. This
+  gem handles translated flash messages, set status and renders turbo-stream partials.
+  You can steer your turbo-stream partials directly from the contoller. It also handles
+  redirection: turbo_power is included.'
 email:
 - christian@sedlmair.ch
 executables: []
@@ -66,5 +69,5 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Coming soon
+summary: Rendering turbo-stream partials directly from controller
 test_files: []