cacheable_flash 0.3.1 → 0.3.2

data/CHANGELOG

@@ -1,3 +1,6 @@
+0.3.2 - AUG.23.2012
+* Properly handles stacked flash in cookie flash according to config :append_as option [Peter Boling]
+
 0.3.1 - AUG.22.2012
 * Add specs for non stacking use [Peter Boling]
 * Use stackable_flash/test_helpers instead of reinventing the wheel [Peter Boling]

data/cacheable_flash.gemspec

@@ -7,7 +7,6 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter H. Boling", "Brian Takita"]
-  s.date = "2012-08-13"
   s.description = "Allows caching of pages with flash messages by rendering flash\nmessages from a cookie using JavaScript, instead of statically in your Rails\nview template.  Flash contents are converted to JSON and placed in\na cookie by an after_filter (default) or a Rack Middleware (option)."
   s.email = "peter.boling@gmail.com"
   s.extra_rdoc_files = [

data/lib/cacheable_flash.rb

@@ -13,7 +13,7 @@ module CacheableFlash
   # By default stacking is false, but it can be turned on with:
   # CacheableFlash.configure do |config|
   #   config[:stacking] = true
-  #   config[:append_as] = :br
+  #   config[:append_as] = :br # Pick a value, set your own proc, or don't: passes the JSON'd array to the cookie
   # end
   StackableFlash.stacking = false
 
@@ -37,4 +37,9 @@ module CacheableFlash
     #       because flashes are only removed from cookies when they are used.
     flash.clear
   end
+
+  # simply abstracts the StackableFlash.stacking method
+  def self.stacking
+    StackableFlash.stacking
+  end
 end

data/lib/cacheable_flash/config.rb

@@ -21,17 +21,19 @@ module CacheableFlash
       yield @config
       if @config[:stacking]
         StackableFlash.stacking = true
-        StackableFlash::Config.configure do
-            # by default behave like regular non-stacking flash
+        StackableFlash::Config.configure do |config|
+          # by default behave like regular non-stacking flash
           if @config[:append_as].respond_to?(:call)
-            @config[:stack_with_proc] = @config[:append_as]
+            config[:stack_with_proc] = @config[:append_as]
           else
-            @config[:stack_with_proc] = case @config[:append_as]
-              when :br then Proc.new {|arr| arr.join('<br/>') }
-              when :array then Proc.new {|arr| arr }
-              when :p then Proc.new {|arr| arr.map! {|x| "<p>#{x}</p>"}.join }
-              when :ul then Proc.new {|arr| '<ul>' + arr.map! {|x| "<li>#{x}</li>"}.join + '</ul>' }
-              when :ol then Proc.new {|arr| '<ol>' + arr.map! {|x| "<li>#{x}</li>"}.join + '</ol>' }
+            config[:stack_with_proc] = case @config[:append_as]
+              # Escape as many strings as we can!
+              when :br then Proc.new {|arr| arr.map { |x| x.kind_of?(String) && !x.html_safe? ? ERB::Util.html_escape(x) : x }.join('<br/>') }
+              when :array then Proc.new {|arr| arr.map { |x| x.kind_of?(String) && !x.html_safe? ? ERB::Util.html_escape(x) : x } }
+              when :p then Proc.new {|arr| arr.map! {|x| "<p>#{x.kind_of?(String) && !x.html_safe? ? ERB::Util.html_escape(x) : x }</p>"}.join }
+              when :ul then Proc.new {|arr| '<ul>' + arr.map! {|x| "<li>#{x.kind_of?(String) && !x.html_safe? ? ERB::Util.html_escape(x) : x }</li>"}.join + '</ul>' }
+              when :ol then Proc.new {|arr| '<ol>' + arr.map! {|x| "<li>#{x.kind_of?(String) && !x.html_safe? ? ERB::Util.html_escape(x) : x }</li>"}.join + '</ol>' }
+              else Proc.new {|arr| arr.map { |x| x.kind_of?(String) && !x.html_safe? ? ERB::Util.html_escape(x) : x }.join('<br/>') }
             end
           end
         end

data/lib/cacheable_flash/cookie_flash.rb

@@ -1,23 +1,33 @@
 module CacheableFlash
   module CookieFlash
+
+    # @parameters
+    #   cookies -
+    #     There might be crusty flash from a previous request, or set elsewhere, already in the cookie.
+    #     Pull it out and parse it so we can preserve it.
+    #   flash -
+    #     This is the fresh, super-stacked (by stackable_flash gem) FlashHash from the current request.
+    #     Needs to be added to the cookie flash.
     def cookie_flash(flash, cookies)
       cflash = (JSON.parse(cookies['flash']) if cookies['flash']) || {} rescue {}
-      flash.each do |key, value|
-        # Since v0.3.0 only escaping strings
-        if value.kind_of?(String)
-          value = ERB::Util.html_escape(value) unless value.html_safe?
-        end
+
+      flash.each do |key, value| # key like :notice, or :error, or :sticky
+        # When stacking we won't be escaping anything here, because will be array, not string
+        value = ERB::Util.html_escape(value) if value.kind_of?(String) && !value.html_safe? # Since v0.3.0 only escaping strings
         skey = key.to_s
         # This allows any data type to be stored in the cookie; important for using an array as the value with
         # stackable_flash
-        if cflash[skey].kind_of?(Array) # Already Stackable!!!
-          if value.kind_of?(Array)
-            cflash[skey] += value # Add the values from the other array, which is already a stackable flash
+        # The cookie flash will generally be set to a value stacked according to the :stack_with_proc of stackable_flash
+        # But when there is already a value for the cookie when we get here, we need to join them somehow.
+        stacked_value = value.respond_to?(:stack) ? value.stack : value
+        if cflash[skey].kind_of?(Array) # Just because it could be an array
+          if stacked_value.kind_of?(Array)
+            cflash[skey] += stacked_value
           else
-            cflash[skey] << value
+            cflash[skey] << stacked_value
           end
         else
-          cflash[skey] = value
+          cflash[skey] = stacked_value
         end
       end
       # I have forgotten why the gsub + matters, so NOTE: to future self: document weird shit.

data/lib/cacheable_flash/middleware.rb

@@ -15,11 +15,13 @@ module CacheableFlash
       env_flash = env[FLASH_HASH_KEY]
 
       if env_flash
+        # There is a flash set from this request, merge it into the cookie flash (which may already be populated)
         response = Rack::Response.new(body, status, headers)
         cookies = env["rack.cookies"] || {}
         response.set_cookie("flash", { :value => cookie_flash(env_flash, cookies), :path => "/" })
         response.finish
       else
+        # There is no flash set in this request but there are leftovers from previous requests still in the cookie
         request = ActionDispatch::Request.new(env)
         cflash = request.respond_to?(:cookie_jar) ?
           request.cookie_jar['flash'] :

data/lib/cacheable_flash/version.rb

@@ -1,3 +1,3 @@
 module CacheableFlash
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/controllers/comparison_cotroller_spec.rb

@@ -39,6 +39,7 @@ describe ComparisonController do
         before(:each) do
           CacheableFlash::Config.configure do |config|
             config[:stacking] = true
+            config[:append_as] = :array
           end
         end
         after(:each) do
@@ -164,6 +165,7 @@ describe ComparisonController do
         before(:each) do
           CacheableFlash::Config.configure do |config|
             config[:stacking] = true
+            config[:append_as] = :array
           end
         end
         after(:each) do

data/spec/controllers/dummy_controller_spec.rb

@@ -40,6 +40,7 @@ describe DummyController do
         before(:each) do
           CacheableFlash::Config.configure do |config|
             config[:stacking] = true
+            config[:append_as] = :array
           end
         end
         after(:each) do

data/spec/requests/integration_spec.rb

@@ -4,6 +4,7 @@ describe DummyController do
   before(:each) do
     CacheableFlash::Config.configure do |config|
       config[:stacking] = true
+      config[:append_as] = :array
     end
   end
   after(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cacheable_flash
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-13 00:00:00.000000000 Z
+date: 2012-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stackable_flash