turbo_flash 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b64991ca74590443beba07f47dad71373ef249fed3ddc1000dfbf94ffd559cd3
-  data.tar.gz: 6313bd6233fb417fcdc1c4271db595d7752fbabc4df4740debc71417ff386411
+  metadata.gz: f918c2e85cac1ba1b597b7cd82cf991b367cb066d5067eca31d62b1bfd0fb020
+  data.tar.gz: 4a87182a3f842d5d185c03b8a2810ce772f858df0e79fdd007c08d3d2269bb46
 SHA512:
-  metadata.gz: 7401f202da75e70870a25d26a667d6074e21390bca980ea8006d7651af41177f99ab2bbda5a0d309c37aa7de8a3259a6550c3c6fb7d43c2368f26404b6daf4ee
-  data.tar.gz: 6da6ba2930f45f5606d2e7d2945838cf1dc7ab510476aef2d730c55e21cff28c0d73da5df729e791134cd1139c6296bea1f572b6626a53525da25e9540394dcb
+  metadata.gz: 24be5d4a002ba202f00808efe47256fd4ff39a861b3001372325adf3c1dec612ed91bf5a7ff71f7b02aa92805e5ee6b4f15332aafdc0c15240cc75a862b1e6f2
+  data.tar.gz: 828855342363d5bb5e1007555b57084329ba6d74bc673e99ba202eaf4fef4109a598ea911225cded5a501158b207fcbc5174e3f4e92a31ff7f7acea0d7a45787

data/README.md

@@ -2,11 +2,14 @@
 
 Automagically include your flash messages in your Ruby on Rails [TurboStream](https://github.com/hotwired/turbo-rails) responses.
 
-![Video demo](https://i.imgur.com/vOmf6FV.mp4)
+![Video demo](https://i.imgur.com/pVqX9ZV.gif)
 
 ## Usage
 
-TurboFlash exposes a `flash.turbo` method that's similar to `flash.now`:
+By default, TurboFlash will inherit all flashes that you normally set. This can be turned off with the `inherit_flashes`
+configuration flag.
+
+To explicitly set flashes, TurboFlash exposes a `flash.turbo` method that's similar to `flash`:
 
 ```ruby
 class UsersController < ApplicationController
@@ -37,8 +40,6 @@ class UsersController < ApplicationController
 end
 ```
 
-Note: You must explicitly call `flash.turbo` (for now). This will not use the original flash hash.
-
 Of course, the response will be what you expect:
 
 ```ruby
@@ -112,10 +113,16 @@ Ensure that the TurboStream target — a tag with an `id` of `flash` exists in y
 
 ## Configuration
 
-In an initializer:
+In an initializer (defaults are shown):
 
 ```
 TurboFlash.configure do |config|
+  # make all flashes TurboFlash-flashes
+  # config.inherit_flashes = true 
+  
+  # clear the TurboFlash target if there are no flashes in a TurboStream response
+  # config.clear_target_unless_flashed = true 
+  
   # the default TurboStream target element ID
   # config.target = "flash"
   
@@ -133,6 +140,16 @@ TurboFlash.configure do |config|
 end
 ```
 
+## Gotchas
+
+If `TurboFlash.configuration.inherit_flashes` is `false`, and you want to copy over the regular flashes,
+you can invoke `flash.turbo!(options = {})` to copy over the flashes that are currently stored in the session.
+
+If `TurboFlash.configuration.clear_target_unless_flashed` is `false`, and you would like to clear flashes in the TurboStream
+response, you can invoke `flash.turbo.clear_target!` to clear the TurboStream target if there are no flashes.
+
+If you want to clear all potential TurboFlashes, call `flash.turbo.clear!`
+
 ## Contributing
 
 There wasn't much thought put into this, but it works for me, so it might work for you!

data/lib/turbo_flash/configuration.rb

@@ -2,14 +2,24 @@
 
 module TurboFlash
   class Configuration
-    attr_accessor :target, :action, :partial, :key, :value
+    attr_accessor :target, :action, :partial, :key, :value, :clear_unless_flashed, :inherit_flashes
 
     def initialize
       @target = 'flash'
-      @action = :append
+      @action = :update
       @partial = 'shared/flash'
       @key = :role
       @value = :message
+      @clear_target_unless_flashed = true
+      @inherit_flashes = true
+    end
+
+    def inherit_flashes?
+      @inherit_flashes
+    end
+
+    def clear_target_unless_flashed?
+      @clear_target_unless_flashed
     end
   end
 end

data/lib/turbo_flash/flash_hash.rb

@@ -4,8 +4,20 @@ require 'turbo_flash/flash_turbo'
 
 module TurboFlash
   module FlashHash
+    # create a Flash::Turbo instance.
+    #
+    # Behaves just like `flash.now`, but gets injected into your TurboStream response.
+    #
+    #   flash.turbo[:notice] = "There was an error"
     def turbo
       @turbo ||= ::TurboFlash::FlashTurbo.new(self)
     end
+
+    # Copy over flashes
+    def turbo!(options = {})
+      turbo.from_flashes(@flashes, options)
+
+      true
+    end
   end
 end

data/lib/turbo_flash/flash_turbo.rb

@@ -7,12 +7,62 @@ module TurboFlash
 
     def initialize(flash)
       super
+      @copied_flashes = false
       @temp_options = nil
       @default_render_target = TurboFlash.configuration.target
       @default_render_options = { action: TurboFlash.configuration.action, partial: TurboFlash.configuration.partial }
       @locals_key = TurboFlash.configuration.key
       @locals_value = TurboFlash.configuration.value
       @options = {}
+      @clear_target = false
+      @cleared = false
+    end
+
+    def copied_flashes?
+      @copied_flashes
+    end
+
+    def from_flashes(other_flashes, options)
+      other_flashes.each do |k,v|
+        from_flash(k, v, options)
+      end
+      @copied_flashes = true
+
+      true
+    end
+
+    def cleared?
+      @cleared
+    end
+
+    def unclear!
+      @cleared = false
+    end
+
+    def clear!
+      @cleared = true
+    end
+
+    def from_flash(k, v, options = {})
+      set_options(options)[k] = v
+
+      true
+    end
+
+    def clear_target?
+      @clear_target
+    end
+
+    def clear_target!
+      @clear_target = true
+    end
+
+    def reset_clear_target!
+      @clear_target = false
+    end
+
+    def flashes
+      @flash.instance_variable_get(:@flashes)
     end
 
     def []=(k, v)

data/lib/turbo_flash/renderer.rb

@@ -5,10 +5,37 @@ module TurboFlash
     def render(*args)
       result = super
       if request.format.turbo_stream?
+        return result if flash.turbo.cleared?
+
+        flashed = false
         flash_turbo_options = flash.turbo.options
-        flash.turbo.instance_variable_get(:@flash).instance_variable_get(:@flashes).each do |key, _value|
+        flash.turbo.flashes.each do |key, value|
           flash_options = flash_turbo_options[key]
+          if TurboFlash.configuration.inherit_flashes?
+            flash.turbo.from_flash(key, value)
+            flash_options = flash_turbo_options[key]
+          end
+
+          if flash_options.nil?
+            flash.discard(key)
+            next
+          end
+
           result << turbo_stream.send(flash_options.delete(:action), flash_options.delete(:target), **flash_options)
+          flashed = true
+          flash.turbo.flash.discard(key)
+        end
+
+        flash.clear
+
+        puts "flashed? #{flashed}"
+        puts "Clear unless flashed: #{TurboFlash.configuration.clear_target_unless_flashed?}"
+        puts "flash.turbo.clear_target : #{flash.turbo.clear_target?}"
+        if (!flashed && TurboFlash.configuration.clear_target_unless_flashed?) || flash.turbo.clear_target?
+          result << turbo_stream.send(:update, TurboFlash.configuration.target) do
+            ""
+          end
+          flash.turbo.reset_clear_target!
         end
       end
       result

data/lib/turbo_flash/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TurboFlash
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo_flash
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Josh Brody