cacheable_flash 0.2.7 → 0.2.8

data/.gitignore

@@ -0,0 +1,75 @@
+# gem generated
+*.gem
+Gemfile.lock
+
+# bundle generated
+.bundle
+lib/bundler/man
+
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+*.tmproj
+tmtags
+
+# For RubyMine
+.idea
+
+# For emacs:
+*~
+\#*
+.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+.redcar
+
+# For rubinius:
+*.rbc
+
+# From bundle gem my_gem's .gitignore (good practice?)
+.config
+InstalledFiles
+doc/
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Other
+log/*.log
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/CHANGES

@@ -1,3 +1,19 @@
+0.2.8 - AUG.07.2012
+- switch from jeweler to gem-release for bumping and tagging
+- bundler update (1.0.24)
+- Escape HTML in flash values unless they're html_safe
+- Add CacheableFlash rack middleware
+
+0.2.7 - JUN.21.2012
+- Note: Does not support flash.now feature of the FlashHash in Rails
+- Corrected directory names for controllers/layouts
+
+0.2.6 - unreleased
+- all specs pass with rspec 2.10
+
+0.2.5 - MAR.01.2012
+- Real integration test!
+
 0.2.4 - FEB.27.2012
 - Dependency diet!  No longer requires all of rails - only railties.
 
@@ -7,14 +23,14 @@
 - Updated specs, to running and passing condition!
 - Made rails > 3.0 a dependency, since it is (uses ::Rails::Engine and :Rails::Railtie)
 
-0.2.2
+0.2.2 - SEP.10.2011
 - Improved deprecation warnings about using the generator (not needed with asset pipeline)
 - Improved README setup instructions
 
-0.2.1
+0.2.1 - SEP.10.2011
 - Fixed bug in generator for those not using asset pipeline, or pre Rails 3.1
 
-0.2.0 [Peter Boling begins gemification process]
+0.2.0 - SEP.10.2011 [Peter Boling begins gemification process]
 - Converted to a gem
 - Updated to improved, patched jquery.cookie from https://github.com/pboling/jquery-cookie
 - Merged a few other forks of cacheable-flash

data/Gemfile

@@ -1,4 +1,4 @@
-#source "http://rubygems.org"
+source "http://rubygems.org"
 
 gem "json"
 
@@ -15,7 +15,7 @@ group :development, :test do
 
   gem "rspec-rails", ">= 2.8.0"
   gem "rdoc", ">= 3.12"
-  gem "bundler", ">= 1.0.21"
+  gem "bundler", ">= 1.0.24"
   gem "jeweler", ">= 1.6.4"
   gem "reek", ">= 1.2.8"
   gem "roodi", ">= 2.1.0"

data/{MIT-LICENSE → LICENSE}

@@ -1,6 +1,8 @@
 Copyright (c) 2007-2010 Pivotal Labs
 Copyright (c) 2011-2012 Peter H. Boling (http://peterboling.com)
 
+MIT License
+
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including

data/README.rdoc

@@ -1,151 +1,168 @@
-= CacheableFlash
-
-== Description
-
-This plugin enables greater levels of page caching by rendering flash
-messages from a cookie using JavaScript, instead of in your Rails
-view template.  Flash contents are converted to JSON and placed in
-a cookie by an after_filter in a controller.
-
-== Installation as plugin
-
-ruby script/plugin install git://github.com/pivotal/cacheable-flash.git
-
-== Installation as gem
-
-gem install 'cacheable_flash'
-
-add to your Gemfile:
-gem 'cacheable_flash'
-
-== Setup
-
-=== Without asset pipeline, or pre-Rails 3.1:
-
-First copy the JS assets into your app:
-  rails generate cacheable_flash:install
-
-CacheableFlash adds its javascript dependencies as a Rails 3 javascript 'expansion',
-which are only used if you are NOT using the asset pipeline (apparently?).
-
-So if you have config.assets.enabled = false in application.rb then in your layout:
-  javascript_include_tag :cacheable_flash
-
-Otherwise, in your layout, just source them like normal:
-  javascript_include_tag 'flash', 'jquery.cookie'
-
-=== With asset pipeline (requires Rails 3.1)
-
-The asset pipeline should have access to the assets in this gem via your app/assets/javascripts/application.js:
-  //= require flash
-  //= require jquery.cookie
-
-== Mailing List
-
-http://groups.google.com/group/PivotalLabsOpenSource
-
-== Bug/Feature Tracker
-
-https://github.com/pivotal/cacheable-flash/issues
-
-== Wiki
-
-Please help document!
-
-https://github.com/pivotal/cacheable-flash/wiki
-
-=== Usage
-
-To use, include the CacheableFlash module in your controller.
-It's all or none on the actions in your controller, so you can't
-mix JS and HTML display of your flash message in a controller.
-No other modifications to the controller are needed.  You will need
-to add divs and some javascript to your view or layout templates
-to render the flash in the browser.
-
-Note that the cookie holding the flash messages is removed as the
-page is displayed, so a refresh will clear the flash message (just
-as happens normally).
-
-=== Example Controller
-
-class MyController < ActionController::Base
-  include CacheableFlash
-  # ...
-end
-
-=== Example Template Markup
-
-  <div id="error_div_id" class="flash flash_error"></div>
-  <div id="notice_div_id" class="flash flash_notice"></div>
-  <script type="text/javascript">
-    Flash.transferFromCookies();
-    Flash.writeDataTo('error', $('#error_div_id'));
-    Flash.writeDataTo('notice', $('#notice_div_id'));
-  </script>
-
-== Testing
-You can test your flash cookies by making assertions on the json of the "flash" cookie.
-Cacheable Flash provides test helpers which includes the flash_cookie method.
-
-=== Test::Unit Example
-  require "cacheable_flash/test_helpers"
-
-  class TestController < ActionController::Base
-    def index
-      flash["notice"] = "In index"
-    end
-  end
-
-  class ControllerTest < Test::Unit::TestCase
-    include CacheableFlash::TestHelpers
-
-    def setup
-      @controller = TestController.new
-      @request = ActionController::TestRequest.new
-      @response = ActionController::TestResponse.new
-    end
-
-    def test_cacheable_flash_action
-      get :index
-      asset_equal "In index", flash_cookie["notice"]
-    end
-  end
-
-=== Rspec Example
-  require "cacheable_flash/test_helpers"
-
-  class TestController < ActionController::Base
-    def index
-      flash["notice"] = "In index"
-    end
-  end
-
-  describe TestController, "#index" do
-    include CacheableFlash::TestHelpers
-    
-    it "writes to the flash cookie" do
-      get :index
-      flash_cookie["notice"].should == "In index"
-    end
-  end
-
-== Contributing to cacheable-flash
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Licensed under the MIT License.
-
-- Copyright (c) 2011-2012 Peter H. Boling (http://peterboling.com). See LICENSE.txt for further details.
-- Copyright (c) 2007-2010 Pivotal Labs
-
-
-
+= CacheableFlash {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/pivotal/cacheable-flash]
+
+== Description
+
+This plugin enables greater levels of page caching by rendering flash
+messages from a cookie using JavaScript, instead of in your Rails
+view template.  Flash contents are converted to JSON and placed in
+a cookie by an after_filter in a controller or a Rack middleware in
+your application.
+
+== Installation as gem
+
+gem install 'cacheable_flash'
+
+add to your Gemfile:
+gem 'cacheable_flash'
+
+== Installation as plugin (For old Rails)
+
+ruby script/plugin install git://github.com/pivotal/cacheable-flash.git
+
+== Setup
+
+=== Without asset pipeline, or pre-Rails 3.1:
+
+First copy the JS assets into your app:
+  rails generate cacheable_flash:install
+
+CacheableFlash adds its javascript dependencies as a Rails 3 javascript 'expansion',
+which are only used if you are NOT using the asset pipeline (apparently?).
+
+So if you have config.assets.enabled = false in application.rb then in your layout:
+  javascript_include_tag :cacheable_flash
+
+Otherwise, in your layout, just source them like normal:
+  javascript_include_tag 'flash', 'jquery.cookie'
+
+=== With asset pipeline (requires Rails 3.1)
+
+The asset pipeline should have access to the assets in this gem via your app/assets/javascripts/application.js:
+  //= require flash
+  //= require jquery.cookie
+
+== Mailing List
+
+http://groups.google.com/group/PivotalLabsOpenSource
+
+== Bug/Feature Tracker
+
+https://github.com/pivotal/cacheable-flash/issues
+
+== Wiki
+
+Please help document!
+
+https://github.com/pivotal/cacheable-flash/wiki
+
+== Usage as an around filter
+
+To use as an around filter, include the CacheableFlash module
+in your controller.
+It's all or none on the actions in your controller, so you can't
+mix JS and HTML display of your flash message in a controller.
+No other modifications to the controller are needed.  You will need
+to add divs and some javascript to your view or layout templates
+to render the flash in the browser.
+
+Note that the cookie holding the flash messages is removed as the
+page is displayed, so a refresh will clear the flash message (just
+as happens normally).
+
+=== Example Controller
+
+  class MyController < ActionController::Base
+    include CacheableFlash
+    # ...
+  end
+
+== Usage as a Rack middleware (requires Rails 3)
+
+To use as a Rack Middleware, swap the Rails flash middleware with the
+Cacheable flash middleware.
+Use this method if you set flash messages inside a rescue_from block:
+
+  rescue_from CanCan::AccessDenied do |exception|
+    redirect_to root_url, :alert => exception.message
+  end
+
+=== In your application.rb:
+
+  # Swap the ActionDispatch::Flash middleware with the CacheableFlash one
+  config.middleware.swap ActionDispatch::Flash, CacheableFlash::Middleware
+
+== Example Template Markup
+
+  <div id="error_div_id" class="flash flash_error"></div>
+  <div id="notice_div_id" class="flash flash_notice"></div>
+  <script type="text/javascript">
+    Flash.transferFromCookies();
+    Flash.writeDataTo('error', $('#error_div_id'));
+    Flash.writeDataTo('notice', $('#notice_div_id'));
+  </script>
+
+== Testing
+You can test your flash cookies by making assertions on the json of the "flash" cookie.
+Cacheable Flash provides test helpers which includes the flash_cookie method.
+
+=== Test::Unit Example
+  require "cacheable_flash/test_helpers"
+
+  class TestController < ActionController::Base
+    def index
+      flash["notice"] = "In index"
+    end
+  end
+
+  class ControllerTest < Test::Unit::TestCase
+    include CacheableFlash::TestHelpers
+
+    def setup
+      @controller = TestController.new
+      @request = ActionController::TestRequest.new
+      @response = ActionController::TestResponse.new
+    end
+
+    def test_cacheable_flash_action
+      get :index
+      asset_equal "In index", flash_cookie["notice"]
+    end
+  end
+
+=== Rspec Example
+  require "cacheable_flash/test_helpers"
+
+  class TestController < ActionController::Base
+    def index
+      flash["notice"] = "In index"
+    end
+  end
+
+  describe TestController, "#index" do
+    include CacheableFlash::TestHelpers
+    
+    it "writes to the flash cookie" do
+      get :index
+      flash_cookie["notice"].should == "In index"
+    end
+  end
+
+== Contributing to cacheable-flash
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Licensed under the MIT License.
+
+- Copyright (c) 2011-2012 Peter H. Boling (http://peterboling.com). See LICENSE for further details.
+- Copyright (c) 2007-2010 Pivotal Labs
+
+
+

data/Rakefile

@@ -1,35 +1,8 @@
 # encoding: utf-8
 #!/usr/bin/env rake
-require 'rubygems'
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
+require "bundler/gem_tasks"
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "cacheable_flash"
-  gem.homepage = "http://github.com/pivotal/cacheable-flash"
-  gem.license = "MIT"
-  gem.summary = %Q{Render flash messages from a cookie using JavaScript, instead of in your Rails
-view template}
-  gem.description = %Q{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 in a controller.}
-  gem.email = "peter.boling@gmail.com"
-  gem.authors = ["Peter H. Boling","Brian Takita"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
@@ -69,6 +42,5 @@ RDoc::Task.new(:rdoc) do |rdoc|
 end
 
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks

data/cacheable_flash.gemspec

@@ -1,94 +1,22 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cacheable_flash/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name = "cacheable_flash"
-  s.version = "0.2.7"
+  s.version = CacheableFlash::VERSION
 
   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-06-21"
-  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 in a controller."
+  s.date = "2012-08-07"
+  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 = [
-    "LICENSE.txt",
+    "LICENSE",
     "README.rdoc"
   ]
-  s.files = [
-    ".document",
-    "CHANGES",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "MIT-LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "app/assets/images/cacheable_flash/.gitkeep",
-    "app/assets/javascripts/cacheable_flash/application.js",
-    "app/assets/stylesheets/cacheable_flash/application.css",
-    "app/controllers/cacheable_flash/application_controller.rb",
-    "app/helpers/cacheable_flash/application_helper.rb",
-    "app/views/layouts/cacheable_flash/application.html.erb",
-    "cacheable_flash.gemspec",
-    "config/routes.rb",
-    "init.rb",
-    "install.rb",
-    "lib/cacheable_flash.rb",
-    "lib/cacheable_flash/engine.rb",
-    "lib/cacheable_flash/railtie.rb",
-    "lib/cacheable_flash/version.rb",
-    "lib/generators/cacheable_flash/install/install_generator.rb",
-    "lib/tasks/cacheable-flash_tasks.rake",
-    "script/rails",
-    "spec/cacheable_flash/cacheable_flash_spec.rb",
-    "spec/cacheable_flash/install_spec.rb",
-    "spec/cacheable_flash/test_helpers_spec.rb",
-    "spec/controllers/dummy_controller_spec.rb",
-    "spec/dummy/README.rdoc",
-    "spec/dummy/Rakefile",
-    "spec/dummy/app/assets/javascripts/application.js",
-    "spec/dummy/app/assets/stylesheets/application.css",
-    "spec/dummy/app/controllers/application_controller.rb",
-    "spec/dummy/app/controllers/dummy_controller.rb",
-    "spec/dummy/app/helpers/application_helper.rb",
-    "spec/dummy/app/mailers/.gitkeep",
-    "spec/dummy/app/models/.gitkeep",
-    "spec/dummy/app/views/dummy/index.html.erb",
-    "spec/dummy/app/views/layouts/application.html.erb",
-    "spec/dummy/config.ru",
-    "spec/dummy/config/application.rb",
-    "spec/dummy/config/boot.rb",
-    "spec/dummy/config/database.yml",
-    "spec/dummy/config/environment.rb",
-    "spec/dummy/config/environments/development.rb",
-    "spec/dummy/config/environments/production.rb",
-    "spec/dummy/config/environments/test.rb",
-    "spec/dummy/config/initializers/backtrace_silencers.rb",
-    "spec/dummy/config/initializers/inflections.rb",
-    "spec/dummy/config/initializers/mime_types.rb",
-    "spec/dummy/config/initializers/secret_token.rb",
-    "spec/dummy/config/initializers/session_store.rb",
-    "spec/dummy/config/initializers/wrap_parameters.rb",
-    "spec/dummy/config/locales/en.yml",
-    "spec/dummy/config/routes.rb",
-    "spec/dummy/lib/assets/.gitkeep",
-    "spec/dummy/log/.gitkeep",
-    "spec/dummy/public/404.html",
-    "spec/dummy/public/422.html",
-    "spec/dummy/public/500.html",
-    "spec/dummy/public/favicon.ico",
-    "spec/dummy/script/rails",
-    "spec/js_unit/cookie_test.html",
-    "spec/js_unit/flash_test.html",
-    "spec/spec_helper.rb",
-    "spec/support/test_helpers.rb",
-    "tasks/cacheable_flash_tasks.rake",
-    "vendor/assets/javascripts/flash.js",
-    "vendor/assets/javascripts/jquery.cookie.js"
-  ]
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.homepage = "http://github.com/pivotal/cacheable-flash"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
@@ -104,7 +32,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jquery-rails>, [">= 0"])
       s.add_development_dependency(%q<rspec-rails>, [">= 2.8.0"])
       s.add_development_dependency(%q<rdoc>, [">= 3.12"])
-      s.add_development_dependency(%q<bundler>, [">= 1.0.21"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.24"])
       s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
       s.add_development_dependency(%q<reek>, [">= 1.2.8"])
       s.add_development_dependency(%q<roodi>, [">= 2.1.0"])
@@ -114,7 +42,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jquery-rails>, [">= 0"])
       s.add_dependency(%q<rspec-rails>, [">= 2.8.0"])
       s.add_dependency(%q<rdoc>, [">= 3.12"])
-      s.add_dependency(%q<bundler>, [">= 1.0.21"])
+      s.add_dependency(%q<bundler>, [">= 1.0.24"])
       s.add_dependency(%q<jeweler>, [">= 1.6.4"])
       s.add_dependency(%q<reek>, [">= 1.2.8"])
       s.add_dependency(%q<roodi>, [">= 2.1.0"])
@@ -125,7 +53,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jquery-rails>, [">= 0"])
     s.add_dependency(%q<rspec-rails>, [">= 2.8.0"])
     s.add_dependency(%q<rdoc>, [">= 3.12"])
-    s.add_dependency(%q<bundler>, [">= 1.0.21"])
+    s.add_dependency(%q<bundler>, [">= 1.0.24"])
     s.add_dependency(%q<jeweler>, [">= 1.6.4"])
     s.add_dependency(%q<reek>, [">= 1.2.8"])
     s.add_dependency(%q<roodi>, [">= 2.1.0"])

data/install.rb

@@ -1,5 +1,5 @@
 # Only executed when installed as plugin.
-# When installed as a gem must use the generator, unless using Rails >= 3.1,
+# When installed as a gem must use the generator, unless using Rails >= 3.1 and asset pipeline,
 #   in which case the asset pipeline takes care of everything
 require 'fileutils'
 include FileUtils

data/lib/cacheable_flash.rb

@@ -2,16 +2,16 @@ require 'json'
 
 module CacheableFlash
   if defined?(Rails) && ::Rails::VERSION::MAJOR == 3
-    if ::Rails::VERSION::MINOR >= 1
-      require "cacheable_flash/engine"
-      require 'cacheable_flash/railtie'
-    elsif ::Rails::VERSION::MINOR == 0
-      require 'cacheable_flash/railtie'
-    end
-  else
+    require 'cacheable_flash/middleware'
+    require 'cacheable_flash/engine' if ::Rails::VERSION::MINOR >= 1
+    require 'cacheable_flash/railtie'
+  else 
     # For older rails use generator
   end
 
+  require 'cacheable_flash/cookie_flash'
+  include CookieFlash
+
   def self.included(base)
     #base must define around_filter, as in Rails
     base.around_filter :write_flash_to_cookie
@@ -19,25 +19,9 @@ module CacheableFlash
 
   def write_flash_to_cookie
     yield if block_given?
-    cookie_flash = if cookies['flash']
-      begin
-        JSON(cookies['flash'])
-      rescue
-        {}
-      end
-    else
-      {}
-    end
 
-    flash.each do |key, value|
-      if cookie_flash[key.to_s].blank?
-        cookie_flash[key.to_s] = value.kind_of?(Numeric) ? value.to_s : value
-      else
-        cookie_flash[key.to_s] << "<br/>#{value}"
-      end
-    end
     # Base must define cookies, as in Rails
-    cookies['flash'] = cookie_flash.to_json.gsub("+", "%2B")
+    cookies['flash'] = cookie_flash(flash, cookies)
     # Base must define flash, as in Rails
     # TODO: Does not support flash.now feature of the FlashHash in Rails, 
     #       because flashes are only removed from cookies when they are used.

data/lib/cacheable_flash/cookie_flash.rb

@@ -0,0 +1,15 @@
+module CookieFlash
+  def cookie_flash(flash, cookies)
+    cookie_flash = (JSON(cookies['flash']) if cookies['flash']) || {} rescue {}
+
+    flash.each do |key, value|
+      value = ERB::Util.html_escape(value) unless value.is_a?(Hash) || value.html_safe?
+      if cookie_flash[key.to_s].blank?
+        cookie_flash[key.to_s] = value.kind_of?(Numeric) ? value.to_s : value
+      else
+        cookie_flash[key.to_s] << "<br/>#{value}"
+      end
+    end
+    cookie_flash.to_json.gsub("+", "%2B")
+  end
+end

data/lib/cacheable_flash/middleware.rb

@@ -0,0 +1,26 @@
+module CacheableFlash
+  class Middleware
+    require 'cacheable_flash/cookie_flash'
+    include CookieFlash
+    FLASH_HASH_KEY = "action_dispatch.request.flash_hash".freeze
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      flash = env[FLASH_HASH_KEY]
+
+      if flash
+        response = Rack::Response.new(body, status, headers)
+
+        cookies = env["rack.cookies"] || {}
+        response.set_cookie("flash", { :value => cookie_flash(flash, cookies), :path => "/" })
+        response.finish
+      else
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/cacheable_flash/version.rb

@@ -1,3 +1,3 @@
 module CacheableFlash
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/spec/cacheable_flash/cacheable_flash_spec.rb

@@ -1,106 +1,118 @@
-require 'spec_helper'
-
-describe 'CacheableFlash' do
-  attr_reader :controller_class, :controller, :cookies
-  before do
-    @controller_class = Struct.new(:cookies, :flash)
-    @controller_class.stub(:around_filter)
-    @controller_class.send(:include, CacheableFlash)
-    @controller = @controller_class.new({}, {})
-    @cookies = {}
-    @controller.stub(:cookies).and_return(@cookies)
-  end
-
-  describe "#write_flash_to_cookie" do
-    context "when there is not an existing flash cookie" do
-      it "sets the flash cookie with a JSON representation of the Hash" do
-        expected_flash = {
-          'errors' => "This is an Error",
-          'notice' => "This is a Notice"
-        }
-        controller.flash = expected_flash.dup
-        controller.write_flash_to_cookie
-
-        JSON(@controller.cookies['flash']).should == expected_flash
-      end
-    end
-
-    context "when there is an existing flash cookie" do
-      context "when the flash cookie is valid json" do
-        it "appends new data to existing flash cookie" do
-          @cookies['flash'] = {
-            'notice' => "Existing notice",
-            'errors' => "Existing errors",
-          }.to_json
-
-          @controller.flash = {
-            'notice' => 'New notice',
-            'errors' => 'New errors',
-          }
-
-          @controller.write_flash_to_cookie
-
-          expected_flash = {
-            'notice' => "Existing notice<br/>New notice",
-            'errors' => "Existing errors<br/>New errors",
-          }
-          JSON(@controller.cookies['flash']).should == expected_flash
-        end
-      end
-
-      context "when the flash cookie is 'invalid' json" do
-        it "does not have an error and starts with an empty Hash" do
-          @cookies['flash'] = ""
-          lambda do
-            JSON(@cookies['flash'])
-          end.should raise_error(JSON::ParserError)
-
-          @controller.write_flash_to_cookie
-
-          JSON(@cookies['flash']).should == {}
-        end
-      end
-    end
-    
-    it "converts flash value to string before storing in cookie if value is a number" do
-      @controller.flash = { 'quantity' => 5 }
-      @controller.write_flash_to_cookie
-      JSON(@controller.cookies['flash']).should == { 'quantity' => "5" }
-    end
-    
-    it "does not convert flash value to string before storing in cookie if value is anything other than a number" do
-      @controller.flash = { 'foo' => { 'bar' => 'baz' } }
-      @controller.write_flash_to_cookie
-      JSON(@controller.cookies['flash']).should == { 'foo' => { 'bar' => 'baz' } }
-    end
-    
-    it "encodes plus signs in generated JSON before storing in cookie" do
-      @controller.flash = { 'notice' => 'Life, Love + Liberty' }
-      @controller.write_flash_to_cookie
-#      puts "JSON::VERSION: #{JSON::VERSION}, #{JSON::VERSION >= "1.6"}"
-#      if JSON::VERSION >= "1.6"
-        @controller.cookies['flash'].should == "{\"notice\":\"Life, Love %2B Liberty\"}"
-#      else
-#        @controller.cookies['flash'].should == "{\"notice\": \"Life, Love %2B Liberty\"}"
-#      end
-    end
-
-    it "clears the controller.flash hash provided by Rails" do
-      flash = {
-        'errors' => "This is an Error",
-        'notice' => "This is a Notice"
-      }
-      @controller.flash = flash
-      @controller.write_flash_to_cookie
-
-      @controller.flash.should == {}
-    end
-  end
-
-  describe ".included" do
-    it "sets the around_filter on the controller to call #write_flash_to_cookie" do
-      @controller_class.should_receive(:around_filter).with(:write_flash_to_cookie)
-      @controller_class.send(:include, CacheableFlash)
-    end
-  end
-end
+require 'spec_helper'
+
+describe 'CacheableFlash' do
+  attr_reader :controller_class, :controller, :cookies
+  before do
+    @controller_class = Struct.new(:cookies, :flash)
+    @controller_class.stub(:around_filter)
+    @controller_class.send(:include, CacheableFlash)
+    @controller = @controller_class.new({}, {})
+    @cookies = {}
+    @controller.stub(:cookies).and_return(@cookies)
+  end
+
+  describe "#write_flash_to_cookie" do
+    context "when there is not an existing flash cookie" do
+      it "sets the flash cookie with a JSON representation of the Hash" do
+        expected_flash = {
+          'errors' => "This is an Error",
+          'notice' => "This is a Notice"
+        }
+        controller.flash = expected_flash.dup
+        controller.write_flash_to_cookie
+
+        JSON(@controller.cookies['flash']).should == expected_flash
+      end
+    end
+
+    context "when there is an existing flash cookie" do
+      context "when the flash cookie is valid json" do
+        it "appends new data to existing flash cookie" do
+          @cookies['flash'] = {
+            'notice' => "Existing notice",
+            'errors' => "Existing errors",
+          }.to_json
+
+          @controller.flash = {
+            'notice' => 'New notice',
+            'errors' => 'New errors',
+          }
+
+          @controller.write_flash_to_cookie
+
+          expected_flash = {
+            'notice' => "Existing notice<br/>New notice",
+            'errors' => "Existing errors<br/>New errors",
+          }
+          JSON(@controller.cookies['flash']).should == expected_flash
+        end
+      end
+
+      context "when the flash cookie is 'invalid' json" do
+        it "does not have an error and starts with an empty Hash" do
+          @cookies['flash'] = ""
+          lambda do
+            JSON(@cookies['flash'])
+          end.should raise_error(JSON::ParserError)
+
+          @controller.write_flash_to_cookie
+
+          JSON(@cookies['flash']).should == {}
+        end
+      end
+    end
+    
+    it "converts flash value to string before storing in cookie if value is a number" do
+      @controller.flash = { 'quantity' => 5 }
+      @controller.write_flash_to_cookie
+      JSON(@controller.cookies['flash']).should == { 'quantity' => "5" }
+    end
+    
+    it "does not convert flash value to string before storing in cookie if value is anything other than a number" do
+      @controller.flash = { 'foo' => { 'bar' => 'baz' } }
+      @controller.write_flash_to_cookie
+      JSON(@controller.cookies['flash']).should == { 'foo' => { 'bar' => 'baz' } }
+    end
+    
+    it "encodes plus signs in generated JSON before storing in cookie" do
+      @controller.flash = { 'notice' => 'Life, Love + Liberty' }
+      @controller.write_flash_to_cookie
+#      puts "JSON::VERSION: #{JSON::VERSION}, #{JSON::VERSION >= "1.6"}"
+#      if JSON::VERSION >= "1.6"
+        @controller.cookies['flash'].should == "{\"notice\":\"Life, Love %2B Liberty\"}"
+#      else
+#        @controller.cookies['flash'].should == "{\"notice\": \"Life, Love %2B Liberty\"}"
+#      end
+    end
+
+    it "clears the controller.flash hash provided by Rails" do
+      flash = {
+        'errors' => "This is an Error",
+        'notice' => "This is a Notice"
+      }
+      @controller.flash = flash
+      @controller.write_flash_to_cookie
+
+      @controller.flash.should == {}
+    end
+    
+    it "escapes HTML if the flash value is not html safe" do
+      @controller.flash = { 'quantity' => "<div>foobar</div>" }
+      @controller.write_flash_to_cookie
+      JSON(@controller.cookies['flash']).should == { 'quantity' => "&lt;div&gt;foobar&lt;/div&gt;" }
+    end
+    
+    it "does not escape flash HTML if the value is html safe" do
+      @controller.flash = { 'quantity' => '<div>foobar</div>'.html_safe }
+      @controller.write_flash_to_cookie
+      JSON(@controller.cookies['flash']).should == { 'quantity' => "<div>foobar</div>" }
+    end
+  end
+
+  describe ".included" do
+    it "sets the around_filter on the controller to call #write_flash_to_cookie" do
+      @controller_class.should_receive(:around_filter).with(:write_flash_to_cookie)
+      @controller_class.send(:include, CacheableFlash)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cacheable_flash
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -99,7 +99,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.21
+        version: 1.0.24
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -107,7 +107,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.21
+        version: 1.0.24
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -162,23 +162,21 @@ description: ! 'Allows caching of pages with flash messages by rendering flash
 
   view template.  Flash contents are converted to JSON and placed in
 
-  a cookie by an after_filter in a controller.'
+  a cookie by an after_filter (default) or a Rack Middleware (option).'
 email: peter.boling@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE.txt
+- LICENSE
 - README.rdoc
 files:
 - .document
+- .gitignore
 - CHANGES
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- MIT-LICENSE
+- LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - app/assets/images/cacheable_flash/.gitkeep
 - app/assets/javascripts/cacheable_flash/application.js
 - app/assets/stylesheets/cacheable_flash/application.css
@@ -190,7 +188,9 @@ files:
 - init.rb
 - install.rb
 - lib/cacheable_flash.rb
+- lib/cacheable_flash/cookie_flash.rb
 - lib/cacheable_flash/engine.rb
+- lib/cacheable_flash/middleware.rb
 - lib/cacheable_flash/railtie.rb
 - lib/cacheable_flash/version.rb
 - lib/generators/cacheable_flash/install/install_generator.rb
@@ -254,9 +254,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2422206270089663668
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -270,4 +267,46 @@ signing_key:
 specification_version: 3
 summary: Render flash messages from a cookie using JavaScript, instead of in your
   Rails view template
-test_files: []
+test_files:
+- spec/cacheable_flash/cacheable_flash_spec.rb
+- spec/cacheable_flash/install_spec.rb
+- spec/cacheable_flash/test_helpers_spec.rb
+- spec/controllers/dummy_controller_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/dummy_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.gitkeep
+- spec/dummy/app/models/.gitkeep
+- spec/dummy/app/views/dummy/index.html.erb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/lib/assets/.gitkeep
+- spec/dummy/log/.gitkeep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/js_unit/cookie_test.html
+- spec/js_unit/flash_test.html
+- spec/spec_helper.rb
+- spec/support/test_helpers.rb

data/Gemfile.lock

@@ -1,132 +0,0 @@
-GEM
-  specs:
-    actionmailer (3.1.3)
-      actionpack (= 3.1.3)
-      mail (~> 2.3.0)
-    actionpack (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      i18n (~> 0.6)
-      rack (~> 1.3.5)
-      rack-cache (~> 1.1)
-      rack-mount (~> 0.8.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.0.3)
-    activemodel (3.1.3)
-      activesupport (= 3.1.3)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-      arel (~> 2.2.1)
-      tzinfo (~> 0.3.29)
-    activeresource (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-    activesupport (3.1.3)
-      multi_json (~> 1.0)
-    arel (2.2.1)
-    builder (3.0.0)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    git (1.2.5)
-    hike (1.2.1)
-    i18n (0.6.0)
-    jeweler (1.8.3)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    jquery-rails (1.0.19)
-      railties (~> 3.0)
-      thor (~> 0.14)
-    json (1.7.3)
-    mail (2.3.0)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.6)
-    polyglot (0.3.3)
-    rack (1.3.6)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-mount (0.8.3)
-      rack (>= 1.0.0)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.1.3)
-      actionmailer (= 3.1.3)
-      actionpack (= 3.1.3)
-      activerecord (= 3.1.3)
-      activeresource (= 3.1.3)
-      activesupport (= 3.1.3)
-      bundler (~> 1.0)
-      railties (= 3.1.3)
-    railties (3.1.3)
-      actionpack (= 3.1.3)
-      activesupport (= 3.1.3)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    reek (1.2.12)
-      ripper_ruby_parser (~> 0.0.7)
-      ruby2ruby (~> 1.2.5)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    ripper_ruby_parser (0.0.7)
-      sexp_processor (~> 3.0)
-    roodi (2.1.0)
-      ruby_parser
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    rspec-rails (2.10.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.10.0)
-    ruby2ruby (1.2.5)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    ruby_parser (2.3.1)
-      sexp_processor (~> 3.0)
-    sexp_processor (3.2.0)
-    sprockets (2.0.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    thor (0.14.6)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (>= 1.0.21)
-  jeweler (>= 1.6.4)
-  jquery-rails
-  json
-  rails (~> 3.1.3)
-  rdoc (>= 3.12)
-  reek (>= 1.2.8)
-  roodi (>= 2.1.0)
-  rspec-rails (>= 2.8.0)

data/LICENSE.txt

@@ -1,21 +0,0 @@
-Copyright (c) 2007-2010 Pivotal Labs
-Copyright (c) 2011 Peter H. Boling (http://peterboling.com)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION

@@ -1 +0,0 @@
-0.2.7