render_turbo_stream 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b06017b9c29e990812a3d57b546b9a8eeb186f5f1ae5ab8171385eadd6e2758c
-  data.tar.gz: 6d99078f970bf560e1b972f61c608ed50fb14af4e069bcf3b3d29eef7b974f66
+  metadata.gz: cac97d150139e91688215e97b30997a047a8f9390b64f56f2e6f570f10d6bd87
+  data.tar.gz: d6c539d5bce3f59669f7254c4d24ccbc21a7a5c7580cde83966ac7b88b82fb50
 SHA512:
-  metadata.gz: 28a103e903c7a0fcee861d08253087f0d5fd7fc685a9afc7f79c19568b8dc6941b8e9afe3794b449ad844845c169f5d504ba99009a7106c48f71f8b7cf81ff83
-  data.tar.gz: 69623d364528f03e3a0911c6a7d122d0220ad1175ab124fd1ee7458ce49c3d4317b68263caca5e6782d227fa45568d5978dbeb7128fa4d9a2fba9afff072235f
+  metadata.gz: 9afe5322b9a60b20f44d2950c8f01fcf37df46a5d3b886dcce02919bdbaeb544a2bfdb2b2fa20f317a10f828b89e094449ccdafffbec24caff3cb950cd09b311
+  data.tar.gz: 5d3d1ddb2d36a746b6ee8a60601747205b21179b4a9cd9260f002247d320a4f36036909346a85a7cc5a9b92ec84dfc64361425f3de8e55c70e951f06344d009e

data/README.md

@@ -1,5 +1,9 @@
 # RenderTurboStream
 
+Creating a gem currently is not possible because of [rails issue](https://github.com/rails/rails/issues/47954)
+
+So, applying this idea is currently only possible by copy and paste a method and a view, see below.
+
 Working consistently by turbo_stream means: shooting a lot of partials to the html which always needs the same attributes: ID, partial and maybe some locals. This gem is a attempt to serialize that, especially for `update` and `create` action.
 
 Logic is better placed inside the controller, instead of the view and it's boring to write always the same `ifs` inside the `update.turbo_stream.haml`. So this gem holds a `.turbo_stream.html.erb` view that loops through all the partials that should be rendered.
@@ -7,23 +11,16 @@ Logic is better placed inside the controller, instead of the view and it's borin
 In 90% of cases you have just define your partials, like `_form.haml` and steer them from the controller directly, without a `.turbo_stream.haml` view.
 
 ## Installation
-Add this line to your application's Gemfile:
 
-```ruby
-gem "render_turbo_stream"
-```
+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
 
-And then execute:
-```bash
-$ bundle
-```
+[application_controller](https://gitlab.com/sedl/renderturbostream/-/wikis/application_controller)
 
-Or install it yourself as:
-```bash
-$ gem install render_turbo_stream
-```
+[layout/render_partials.turbo_stream.erb](https://gitlab.com/sedl/renderturbostream/-/wikis/layout/render.turbo_stream.erb)
 
-and follow the instructions of `turbo_power`, not rails side, but npm package and imports on javascript side, for making redirects working.
+[layouts/render_redirect.turbo_stream.erb](https://gitlab.com/sedl/renderturbostream/-/wikis/layouts/render_redirect.turbo_stream.erb)
+
+The corresponding partials for flashes could look [like this](https://gitlab.com/sedl/renderturbostream/-/wikis/flashes)
 
 ## Usage
 
@@ -34,7 +31,7 @@ and follow the instructions of `turbo_power`, not rails side, but npm package an
     render_turbo_stream(
       @customer.save,
       redirect_on_success_to: edit_customer_path(@customer),
-      frame_id: 'customer-form-wrapper',
+      id: 'customer-form-wrapper',
       partial: 'customer_form',
     )
 
@@ -111,6 +108,8 @@ and a corresponding html-ID for pushing the partial to the right destination ins
 
 `config.x.render_turbo_stream.flash_id` #=> example: `flash-wrapper`
 
+`config.x.render_turbo_stream.flash_action` #=> example: 'prepend'
+
 ## Contributing
 
 Contribution welcome.

data/lib/render_turbo_stream/version.rb

@@ -1,3 +1,3 @@
 module RenderTurboStream
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/render_turbo_stream.rb

@@ -1,7 +1,12 @@
 require "render_turbo_stream/version"
 require "render_turbo_stream/railtie"
-require "render_turbo_stream/render_turbo_stream"
 
 module RenderTurboStream
   # Your code goes here...
+  def testmethod
+    render template: 'layouts/render', layout: false
+    respond_to do |format|
+      format.turbo_stream { render template: 'layouts/render', layout: false }
+    end
+  end
 end

data/lib/tasks/render_turbo_stream_tasks.rake

@@ -1,7 +1,4 @@
-# desc "install the turbo_stream"
-# namespace :render_turbo_stream do
-#   task install: :environment do
-#     gem_views = Bundler.rubygems.find_name('render_turbo_stream').first.full_gem_path + '/turbo_stream'
-#     FileUtils.copy_entry gem_views, Rails.application.root.join('app', 'turbo_stream', 'test')
-#   end
+# desc "Explaining what the task does"
+# task :render_turbo_stream do
+#   # Task goes here
 # end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_turbo_stream
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -35,13 +35,8 @@ files:
 - Rakefile
 - lib/render_turbo_stream.rb
 - lib/render_turbo_stream/railtie.rb
-- lib/render_turbo_stream/render_turbo_stream.rb
 - lib/render_turbo_stream/version.rb
 - lib/tasks/render_turbo_stream_tasks.rake
-- views/turbo_stream_partials.html.erb
-- views/turbo_stream_partials.turbo_stream.html.erb
-- views/turbo_stream_redirect.html.erb
-- views/turbo_stream_redirect.turbo_stream.html.erb
 homepage: https://gitlab.com/sedl/render-turbo-stream
 licenses:
 - MIT
@@ -67,5 +62,5 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: NOT USABLE YET
+summary: 'NOT USABLE AS GEM, because: https://github.com/rails/rails/issues/47954'
 test_files: []

data/lib/render_turbo_stream/render_turbo_stream.rb

@@ -1,144 +0,0 @@
-module RenderTurboStream
-  module RenderTurboStream
-    # extend ActiveSupport::Concern
-    #
-    # class_methods do
-    #   def render_turbo_stream(options = {})
-    #     "doing"
-    #   end
-    # end
-    def render_turbo_stream(
-      save_action,
-      redirect_on_success_to: nil,
-      success_message: nil,
-      error_message: nil,
-      object: nil,
-      id: nil, # if no frame-id given: no partial is rendered
-      partial: 'form',
-      locals: {},
-      replace_on_success: [
-        {
-          id: nil,
-          partial: 'form',
-          locals: {}
-        }
-      ],
-      replace_on_error: [
-        {
-          id: nil,
-          partial: 'form',
-          locals: {}
-        }
-      ],
-      add_flash_alerts: [],
-      add_flash_notices: []
-    )
-
-      #== flash partial
-
-      @render_turbo_flash_partial = Rails.configuration.x.render_turbo_stream.flash_partial
-      @render_turbo_flash_id = Rails.configuration.x.render_turbo_stream.flash_id
-
-      #== object
-
-      unless object
-        object = eval("@#{controller_name.classify.underscore}")
-      end
-
-      #== set status
-
-      if save_action == false
-        response.status = :unprocessable_entity
-      end
-
-      #== generate message
-
-      if save_action
-        _msg = if success_message
-                 success_message
-               elsif action_name == 'create'
-                 I18n.t('activerecord.success.successfully_created')
-               elsif action_name == 'update'
-                 I18n.t('activerecord.success.successfully_updated')
-               end
-        messages = [
-          [
-            object.model_name.human,
-            _msg
-          ].join(' ')
-        ]
-      else
-        _msg = if error_message
-                 error_message
-               elsif action_name == 'create'
-                 I18n.t('activerecord.errors.messages.could_not_create')
-               elsif action_name == 'update'
-                 I18n.t('activerecord.errors.messages.could_not_update')
-               end
-        messages = [
-          [
-            object.model_name.human,
-            _msg
-          ].join(' ')
-        ]
-      end
-
-      #== replace frames
-
-      replace_frames = []
-      if id
-        replace_frames.push({
-                              id: id,
-                              partial: partial,
-                              locals: locals
-                            })
-      end
-      if save_action
-        replace_on_success.each do |f|
-          next unless f[:id]
-          replace_frames.push(f)
-        end
-      else
-        replace_on_error.each do |f|
-          next unless f[:id]
-          replace_frames.push(f)
-        end
-      end
-
-      #== render
-
-      views_folder = Pathname.new(Bundler.rubygems.find_name('render_turbo_stream').first.full_gem_path).join('views')
-      suffix = (request.format.to_sym == :html ? '.html.erb' : '.turbo_stream.html.erb')
-
-      if save_action && redirect_on_success_to
-        flash[:notice] = messages.to_a + add_flash_notices.to_a
-        flash[:alert] = add_flash_alerts
-        render file: views_folder.join("turbo_stream_redirect#{suffix}"),
-               locals: {
-                 url: redirect_on_success_to
-               },
-               layout: false,
-               status: 302
-
-      elsif save_action
-        flash.now[:notice] = messages.to_a + add_flash_notices.to_a
-        flash.now[:alert] = add_flash_alerts
-        render file: views_folder.join("turbo_stream_partials#{suffix}"),
-               locals: {
-                 replace_frames: replace_frames
-               },
-               layout: false
-      else
-        flash.now[:alert] = messages.to_a + add_flash_alerts.to_a
-        flash.now[:notice] = add_flash_notices
-        render file: views_folder.join("turbo_stream_partials#{suffix}"),
-               locals: {
-                 replace_frames: replace_frames
-               },
-               layout: false
-
-      end
-
-    end
-  end
-end

data/views/turbo_stream_partials.turbo_stream.html.erb

@@ -1,8 +0,0 @@
-
-<% replace_frames.each do |f| %>
-  <%= turbo_stream.replace f[:id] do %>
-    <% Rails.logger.debug("  RENDER TURBO STREAM ERROR => REPLACE ID: #{f[:id]}") %>
-    <%= render f[:partial], locals: f[:locals] %>
-  <% end %>
-<% end %>
-<%= turbo_stream.prepend @render_turbo_flash_id, partial: @render_turbo_flash_partial %>

data/views/turbo_stream_redirect.turbo_stream.html.erb

@@ -1,5 +0,0 @@
-
-<%= turbo_stream.redirect_to(url) %>
-<% if Rails.env.development? %>
-  <% Rails.logger.debug("RENDER TURBO STREAM => REDIRECT => #{url}") %>
-<% end %>