cacheable_flash 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+-
+features/**/*.feature
+LICENSE.txt

data/CHANGES

@@ -0,0 +1,29 @@
+0.2.0 by Peter Boling
+- 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
+- Added Engine to hook into Rails 3.1 asset pipeline
+- Added Railtie to improve usability with Rails 3.0
+- Added Generator to improve usability with Rails < 3
+
+Unreleased
+- Implicitly adding js files to Rails include defaults (Patch from Michael Erb)
+
+0.1.5
+- Requiring version >= 1.1.2 of the json gem
+- Converted tests into specs
+
+0.1.4
+- Added TestHelpers
+- Added flash_cookie method for tests
+
+0.1.3
+- Require json in init.rb
+
+0.1.2
+- Flash on the Rails side is cleared when written to the cookie
+- Uses existing cookie flash value
+- Using Scriptaculous cookie.js library
+
+0.1.1
+- Added cookies.js

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+#gem "rails"
+#We don't really need all of rails... so:
+gem "activesupport"
+gem "actionpack"
+gem "json"
+
+# Develop dependencies (everything needed to run rake, tests, features, etc.)
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "reek", "~> 1.2.8"
+  gem "roodi", "~> 2.1.0"
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    bcrypt-ruby (3.0.0)
+    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.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.4)
+    multi_json (1.0.3)
+    rack (1.3.2)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby2ruby (1.3.0)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.3.0)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.6)
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    tilt (1.3.3)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  activesupport
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  json
+  reek (~> 1.2.8)
+  roodi (~> 2.1.0)
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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/README.rdoc

@@ -0,0 +1,150 @@
+CacheableFlash
+==============
+
+Note: This fork (http://github.com/pboling/cacheable-flash/tree/master) of
+cacheable-flash aims to be a drop-in replacement for the original cacheable-flash
+(by Pivotal) but uses JQuery instead of Prototype, and merged several of the forks
+of the project to collect the best features and improvements.  It has also been made
+compatible with Rails 3, hooked into the asset pipeline for rails 3.1, and turned into a gem.
+
+== Installation as plugin
+
+ruby script/plugin install git://github.com/pboling/cacheable-flash.git
+
+== Installation as gem
+
+gem install 'cacheable_flash'
+
+add to your Gemfile:
+gem 'cacheable_flash'
+
+== Setup
+
+CacheableFlash adds its javascript dependencies as a Rails 3 javascript 'expansion',
+which are only used is you are Note 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, the asset pipeline should have access to the assets in this gem in your app/assets/application.js:
+
+//= require flash
+//= require jquery.cookie
+
+== 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.
+
+== Mailing List
+
+http://groups.google.com/group/PivotalLabsOpenSource
+*This mailing list is for the original CacheableFlash, and may not be able to help with issues with this gem.
+
+== Bug/Feature Tracker
+
+https://github.com/pboling/cacheable-flash/issues
+
+== Wiki
+
+Please help document!
+
+https://github.com/pboling/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 Peter H. Boling (http://peterboling.com). See LICENSE.txt for further details.
+Copyright (c) 2007-2010 Pivotal Labs
+
+
+

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+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 '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/pboling/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{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.}
+  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|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/cacheable_flash.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cacheable_flash"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter H. Boling", "Brian Takita"]
+  s.date = "2011-09-10"
+  s.description = "This plugin enables greater levels of page caching by rendering flash\nmessages from a cookie using JavaScript, instead of in your Rails\nview template.  Flash contents are converted to JSON and placed in\na cookie by an after_filter in a controller."
+  s.email = "peter.boling@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "CHANGES",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "cacheable_flash.gemspec",
+    "init.rb",
+    "install.rb",
+    "lib/cacheable_flash.rb",
+    "lib/cacheable_flash/rails/engine.rb",
+    "lib/cacheable_flash/rails/railtie.rb",
+    "lib/generators/cacheable_flash/install/install_generator.rb",
+    "spec/cacheable_flash/cacheable_flash_spec.rb",
+    "spec/cacheable_flash/install_spec.rb",
+    "spec/cacheable_flash/test_helpers_spec.rb",
+    "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.homepage = "http://github.com/pboling/cacheable-flash"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Render flash messages from a cookie using JavaScript, instead of in your Rails view template"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<actionpack>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      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"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<actionpack>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<reek>, ["~> 1.2.8"])
+      s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<actionpack>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<reek>, ["~> 1.2.8"])
+    s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1,6 @@
+require "json"
+require "cacheable_flash"
+#use Rails::VERSION::STRING for rails < 1 somehow -- or perhaps, who cares??
+if ::Rails::VERSION::MAJOR == 2
+  ActionView::Helpers::AssetTagHelper.register_javascript_include_default('jquery.cookie','flash')
+end

data/install.rb

@@ -0,0 +1,18 @@
+# Only executed when installed as plugin.
+# When installed as a gem must use the generator, unless using Rails >= 3.1,
+#   in which case the asset pipeline takes care of everything
+require 'fileutils'
+include FileUtils
+
+dir = "#{File.dirname(__FILE__)}/vendor/assets/javascripts"
+rails_javascripts_dir = "#{Rails.root}/public/javascripts"
+
+puts "copying flash.js to #{rails_javascripts_dir}"
+cp "#{dir}/flash.js", rails_javascripts_dir
+
+if File.exists?("#{rails_javascripts_dir}/jquery.cookie.js")
+  puts "#{rails_javascripts_dir}/jquery.cookie.js already exists"
+else
+  puts "copying jquery.cookie.js to #{rails_javascripts_dir}"
+  cp "#{dir}/jquery.cookie.js", rails_javascripts_dir
+end

data/lib/cacheable_flash.rb

@@ -0,0 +1,37 @@
+module CacheableFlash
+  if ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR == 0
+    require 'cacheable_flash/rails/railtie'
+  elsif ::Rails.version >= "3.1"
+    require 'cacheable_flash/rails/engine'
+  else
+    # For older rails use generator
+  end
+
+  def self.included(base)
+    base.around_filter :write_flash_to_cookie
+  end
+
+  def write_flash_to_cookie
+    yield if block_given?
+    cookie_flash = if cookies['flash']
+      begin
+        ActiveSupport::JSON.decode(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
+
+    cookies['flash'] = cookie_flash.to_json.gsub("+", "%2B")
+    flash.clear
+  end
+end

data/lib/cacheable_flash/rails/engine.rb

@@ -0,0 +1,13 @@
+# Configure Rails 3.1:
+#   This gem contains this empty engine class which inherits from Rails::Engine.
+#   By doing this, Rails is informed that the directory for this gem may contain assets and the
+#   app/assets, lib/assets and vendor/assets directories of this engine are added to the search path of Sprockets.
+module Jquery
+  module Rails
+
+    class Engine < ::Rails::Engine
+
+    end
+
+  end
+end

data/lib/cacheable_flash/rails/railtie.rb

@@ -0,0 +1,14 @@
+# Add cacheable flash JS to defaults for Rails < 3.1 (not needed with asset pipeline)
+module Jquery
+  module Rails
+
+    class Railtie < ::Rails::Railtie
+      if ::Rails::VERSION::MAJOR == 3
+        config.before_configuration do
+          config.action_view.javascript_expansions[:cacheable_flash] = %w(flash jquery.cookie)
+        end
+      end
+    end
+
+  end
+end

data/lib/generators/cacheable_flash/install/install_generator.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module CacheableFlash
+  # Copies javascript libraries flash.js and jquery.cookie.js to public/javascripts/ (Rails 3.0.X only, Rails 3.1 has asset pipeline)
+  #
+  # @example
+  #   $ rails generate cacheable_flash:install
+  #
+  # @todo Test with Rails 3.0
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../vendor/assets/javascripts', __FILE__)
+    class_option :template_engine
+
+    # Rails 3.1 has the asset pipeline, no need to copy javascript files anymore
+    # Rails 3.0 doesn't have an asset pipeline, so we copy in javascript files
+    if ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR == 0
+      desc "Copies some JS files to public/javascripts/"
+      def copy_files
+        template 'flash.js',     'public/javascripts/flash.js'
+        template 'jquery.cookie.js', 'public/javascripts/jquery.cookie.js'
+      end
+    end
+  end
+end

data/spec/cacheable_flash/cacheable_flash_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe 'CacheableFlash' do
+  attr_reader :controller_class, :controller, :cookies
+  before do
+    @controller_class = Struct.new(:cookies, :flash)
+    stub(@controller_class).around_filter
+    @controller_class.send(:include, CacheableFlash)
+    @controller = @controller_class.new({}, {})
+    @cookies = {}
+    stub(@controller).cookies {@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.parse(@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.parse(@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.parse(@cookies['flash'])
+          end.should raise_error(JSON::ParserError)
+
+          @controller.write_flash_to_cookie
+
+          JSON.parse(@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.parse(@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.parse(@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
+      @controller.cookies['flash'].should == "{\"notice\": \"Life, Love %2B Liberty\"}"
+    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
+      mock(@controller_class).around_filter(:write_flash_to_cookie)
+      @controller_class.send(:include, CacheableFlash)
+    end
+  end
+end

data/spec/cacheable_flash/install_spec.rb

@@ -0,0 +1,68 @@
+#This should only be tested for older rails when the generator is used, so commenting out for now.
+
+#require 'spec_helper'
+#
+#describe "install.rb" do
+#  include FileUtils
+#
+#  before do
+#    @rails_root = "#{Dir.tmpdir}/cachable_flash_#{Time.now.to_f}"
+#    Object.send(:remove_const, :RAILS_ROOT) if Object.const_defined?(:RAILS_ROOT)
+#    Object.const_set(:RAILS_ROOT, @rails_root)
+#
+#    @stdout = StringIO.new("")
+#    $stdout = @stdout
+#
+#    @js_dir = "#{@rails_root}/public/javascripts"
+#    FileUtils.mkdir_p(@js_dir)
+#    @install_path = "#{File.dirname(__FILE__)}/../../install.rb"
+#  end
+#
+#  after do
+#    $stdout = STDOUT
+#  end
+#
+#  describe "when project does not have json.js" do
+#    it "installs javascript files including json.js" do
+#      File.exists?("#{@js_dir}/flash.js").should be_false
+#      File.exists?("#{@js_dir}/json.js").should be_false
+#      File.exists?("#{@js_dir}/cookie.js").should be_false
+#      load(@install_path)
+#      File.exists?("#{@js_dir}/flash.js").should be_true
+#      File.exists?("#{@js_dir}/json.js").should be_true
+#      File.exists?("#{@js_dir}/cookie.js").should be_true
+#    end
+#  end
+#
+#  describe "when project has json.js" do
+#    it "does not overwrite the existing json.js and installs other javascript files" do
+#      File.open("#{@js_dir}/json.js", "w") do |f|
+#        f.write "Original json.js"
+#      end
+#      File.exists?("#{@js_dir}/json.js").should be_true
+#      File.exists?("#{@js_dir}/flash.js").should be_false
+#      File.exists?("#{@js_dir}/cookie.js").should be_false
+#      load(@install_path)
+#      File.exists?("#{@js_dir}/flash.js").should be_true
+#      File.exists?("#{@js_dir}/cookie.js").should be_true
+#      File.exists?("#{@js_dir}/json.js").should be_true
+#      File.read("#{@js_dir}/json.js").should == "Original json.js"
+#    end
+#  end
+#
+#  describe "when project has cookie.js" do
+#    it "does not overwrite the existing cookie.js" do
+#      File.open("#{@js_dir}/cookie.js", "w") do |f|
+#        f.write "Original cookie.js"
+#      end
+#      File.exists?("#{@js_dir}/json.js").should be_false
+#      File.exists?("#{@js_dir}/flash.js").should be_false
+#      File.exists?("#{@js_dir}/cookie.js").should be_true
+#      load(@install_path)
+#      File.exists?("#{@js_dir}/flash.js").should be_true
+#      File.exists?("#{@js_dir}/json.js").should be_true
+#      File.exists?("#{@js_dir}/cookie.js").should be_true
+#      File.read("#{@js_dir}/cookie.js").should == "Original cookie.js"
+#    end
+#  end
+#end

data/spec/cacheable_flash/test_helpers_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module CacheableFlash
+  describe TestHelpers do
+    attr_reader :controller, :request, :response, :flash, :cookies
+    include TestHelpers
+    before do
+      @controller = ActionController::Base.new
+      @request = ActionController::TestRequest.new
+      @response = ActionController::TestResponse.new
+      controller.send(:initialize_template_class, response)
+      controller.send(:assign_shortcuts, request, response)
+
+      @flash = controller.send(:flash)
+      class << controller
+        include CacheableFlash
+      end
+    end
+
+    describe "#flash_cookie" do
+      it "returns the flash hash send as a cookie" do
+        expected_flash = {
+        'errors' => "This is an Error",
+        'notice' => "This is a Notice"
+        }
+        flash['errors'] = expected_flash['errors']
+        flash['notice'] = expected_flash['notice']
+
+        controller.write_flash_to_cookie
+        @cookies = response.cookies # simulate setting the cookie instance variable in rails tests
+
+        flash_cookie.should == expected_flash
+      end
+    end
+  end
+end

data/spec/js_unit/cookie_test.html

@@ -0,0 +1,60 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <!-- You will need to change this to point to your jsUnitCore.js -->
+  <script src="http://localhost:3000/jsunit/app/jsUnitCore.js" type="text/javascript"></script>
+
+  <script src="../../javascripts/jquery.js" type="text/javascript"></script>
+  <script src="../../javascripts/cookie.js" type="text/javascript"></script>
+
+  <script language="javascript" type="text/javascript">
+  var content;
+  function setUp() {
+    content = $('#content');
+    Cookie.eraseAll();
+  }
+
+  function tearDown() {
+    Cookie.eraseAll();
+  }
+
+  function test_read() {
+    var expires = new Date();
+    expires.setYear(expires.getFullYear() + 1);
+    document.cookie = "foobar=baz; path=/; expires=" + expires.toGMTString();
+
+    assertEquals('baz', Cookie.get('foobar'));
+  }
+
+  function test_write() {
+    Cookie.set('foobar', 'baz');
+    assertEquals("baz", Cookie.get('foobar'));
+  }
+
+  function test_expire() {
+    Cookie.set('foobar', 'baz');
+    Cookie.erase('foobar');
+    assertNull(Cookie.get('foobar'));
+  }
+
+  function test_expireAll() {
+    Cookie.set('foobar', 'baz');
+    Cookie.set('another', 'cookie');
+
+    Cookie.eraseAll();
+
+    assertNull(Cookie.get('foobar'));
+    assertNull(Cookie.get('another'));
+  }
+
+  </script>
+
+</head>
+
+<body>
+  <div id="fixture">
+    <div id="content"></div>
+  </div>
+</body>
+</html>

data/spec/js_unit/flash_test.html

@@ -0,0 +1,112 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <!-- You will need to change this to point to your jsUnitCore.js -->
+  <script src="http://localhost:3000/jsunit/app/jsUnitCore.js" type="text/javascript"></script>
+
+  <script src="../../javascripts/jquery.js" type="text/javascript"></script>
+  <script src="../../javascripts/cookie.js" type="text/javascript"></script>
+  <script src="../../javascripts/json.js" type="text/javascript"></script>
+  <script src="../../vendor/assets/javascripts/flash.js" type="text/javascript"></script>
+  <script type="text/javascript">
+    Include.jsUnitCore();
+    Include.allProduction();
+    Include.allCommonTest();
+    Include.testHelper();
+  </script>
+
+  <script language="javascript" type="text/javascript">
+  var content;
+  function setUp() {
+    content = $('#content');
+    content.html("");
+    Cookie.eraseAll();
+  }
+
+  function tearDown() {
+    Cookie.eraseAll();
+  }
+
+  function test_transferFromCookies_setsFlashData_whenCookieExists() {
+    var expectedData = {
+      'error': "The Error",
+      'notice': "The Notice"
+    };
+    setUpCookieWithData(expectedData);
+    Flash.transferFromCookies();
+    assertHashEquals(expectedData, Flash.data);
+  }
+
+  function test_transferFromCookies_setsFlashDataToEmptyHash_whenCookieDoesNotExist() {
+    Flash.transferFromCookies();
+    assertHashEquals({}, Flash.data);
+  }
+
+  function test_transferFromCookies_setsFlashDataToEmptyHash_whenCookieIsEmpty() {
+    setUpCookieWithData("");
+    Flash.transferFromCookies();
+    assertHashEquals({}, Flash.data);
+  }
+
+  function test_transferFromCookies_removeFlashCookie() {
+    setUpCookieWithData({
+      'error': "The Error",
+      'notice': "The Notice"
+    });
+    Flash.transferFromCookies();
+    assertNull(Cookie.get("flash"));
+  }
+  
+  // how do I test this??
+  function test_transferFromCookies_whenValueContainsAPlusSign() {
+    setUpCookieWithData({
+      'notice': "Book+%2B+Gift+Box"
+    });
+    Flash.transferFromCookies();
+    assertEquals("Book + Gift Box", Cookie.get("notice"));
+  }
+
+  function test_writeDataTo_whenThereIsACookieValue() {
+    setUpCookieWithData({
+      'error': "This+is%20An+Error"
+    });
+    Flash.transferFromCookies();
+    Flash.writeDataTo('error', content);
+
+    assertEquals("This is An Error", content.html());
+  }
+
+  function test_writeDataTo_whenThereIsNoCookieValue() {
+    setUpCookieWithData({});
+    Flash.transferFromCookies();
+    Flash.writeDataTo('notice', content);
+
+    assertEquals("", content.html());
+  }
+
+  function test_writeDataTo_whenPassedAnElementId() {
+    setUpCookieWithData({
+      'error': "This+is%20An+Error"
+    });
+
+    Flash.transferFromCookies();
+    Flash.writeDataTo('error', '#content');
+
+    assertEquals("This is An Error", content.html());
+  }
+  
+  function setUpCookieWithData(values) {
+    Cookie.set('flash', JSON.stringify(values));
+  }
+
+  </script>
+
+</head>
+
+<body>
+  <div id="fixture">
+    <div id="content"></div>
+  </div>
+</body>
+</html>

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+#TODO: Specs will need a 'test' rails app to run within, or to mock things like ::Rails.root
+
+require 'rspec'
+require "json"
+require "active_support"
+require "action_controller"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'cacheable_flash'
+require "support/test_helpers"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/spec/support/test_helpers.rb

@@ -0,0 +1,10 @@
+module CacheableFlash
+  module TestHelpers
+    def flash_cookie
+      return {} unless cookies['flash']
+      ActiveSupport::JSON.decode(cookies['flash'])
+    rescue JSON::ParserError
+      {}
+    end
+  end
+end

data/tasks/cacheable_flash_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cacheable_flash do
+#   # Task goes here
+# end

data/vendor/assets/javascripts/flash.js

@@ -0,0 +1,21 @@
+// refactoring from https://github.com/leonid-shevtsov/cacheable-flash-jquery
+var Flash = new Object();
+
+Flash.data = {};
+
+Flash.transferFromCookies = function() {
+  var data = JSON.parse(unescape($.cookie("flash")));
+  if(!data) data = {};
+  Flash.data = data;
+  $.cookie('flash',null, {path: '/'});
+};
+
+Flash.writeDataTo = function(name, element) {
+  element = $(element);
+  var content = "";
+  if (Flash.data[name]) {
+    message = Flash.data[name].toString().replace(/\+/g, ' ');
+    element.html(message);
+    element.show();
+  }
+};

data/vendor/assets/javascripts/jquery.cookie.js

@@ -0,0 +1,91 @@
+/*jslint browser: true */ /*global jQuery: true */
+
+/**
+ * jQuery Cookie plugin
+ *
+ * Copyright (c) 2010 Klaus Hartl (stilbuero.de)
+ * Dual licensed under the MIT and GPL licenses:
+ * http://www.opensource.org/licenses/mit-license.php
+ * http://www.gnu.org/licenses/gpl.html
+ *
+ */
+
+// TODO JsDoc
+
+/**
+ * Create a cookie with the given key and value and other optional parameters.
+ *
+ * @example $.cookie('the_cookie', 'the_value');
+ * @desc Set the value of a cookie.
+ * @example $.cookie('the_cookie', 'the_value', { expires: 7, path: '/', domain: 'jquery.com', secure: true });
+ * @desc Create a cookie with all available options.
+ * @example $.cookie('the_cookie', 'the_value');
+ * @desc Create a session cookie.
+ * @example $.cookie('the_cookie', null);
+ * @desc Delete a cookie by passing null as value. Keep in mind that you have to use the same path and domain
+ *       used when the cookie was set.
+ *
+ * @param String key The key of the cookie.
+ * @param String value The value of the cookie.
+ * @param Object options An object literal containing key/value pairs to provide optional cookie attributes.
+ * @option Number|Date expires Either an integer specifying the expiration date from now on in days or a Date object.
+ *                             If a negative value is specified (e.g. a date in the past), the cookie will be deleted.
+ *                             If set to null or omitted, the cookie will be a session cookie and will not be retained
+ *                             when the the browser exits.
+ * @option String path The value of the path atribute of the cookie (default: path of page that created the cookie).
+ * @option String domain The value of the domain attribute of the cookie (default: domain of page that created the cookie).
+ * @option Boolean secure If true, the secure attribute of the cookie will be set and the cookie transmission will
+ *                        require a secure protocol (like HTTPS).
+ * @type undefined
+ *
+ * @name $.cookie
+ * @cat Plugins/Cookie
+ * @author Klaus Hartl/klaus.hartl@stilbuero.de
+ */
+
+/**
+ * Get the value of a cookie with the given key.
+ *
+ * @example $.cookie('the_cookie');
+ * @desc Get the value of a cookie.
+ *
+ * @param String key The key of the cookie.
+ * @return The value of the cookie.
+ * @type String
+ *
+ * @name $.cookie
+ * @cat Plugins/Cookie
+ * @author Klaus Hartl/klaus.hartl@stilbuero.de
+ */
+jQuery.cookie = function (key, value, options) {
+    
+    // key and at least value given, set cookie...
+    if (arguments.length > 1 && String(value) !== "[object Object]") {
+        options = jQuery.extend({}, options);
+
+        if (value === null || value === undefined) {
+            options.expires = -1;
+        }
+
+        if (typeof options.expires === 'number') {
+            var days = options.expires, t = options.expires = new Date();
+            options.expires.setDate(t.getDate() + days);
+        }
+        
+        value = String(value);
+        
+        return (document.cookie = [
+            encodeURIComponent(key), '=',
+            options.raw ? value : encodeURIComponent(value),
+            options.expires ? '; expires=' + options.expires.toUTCString() : '', // use expires attribute, max-age is not supported by IE
+            options.path ? '; path=' + options.path : '',
+            options.domain ? '; domain=' + options.domain : '',
+            options.secure ? '; secure' : ''
+        ].join(''));
+    }
+
+    // key and possibly options given, get cookie...
+    options = value || {};
+    var result, decode = options.raw ? function (s) { return s; } : decodeURIComponent;
+    return (result = new RegExp('(?:^|; )' + encodeURIComponent(key) + '=([^;]*)').exec(document.cookie)) ? decode(result[1]) : null;
+};

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: cacheable_flash
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Peter H. Boling
+- Brian Takita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70270132209960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70270132209960
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70270132209460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70270132209460
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70270132208960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70270132208960
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70270132208460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70270132208460
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70270132207920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70270132207920
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70270132207420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70270132207420
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70270132206920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70270132206920
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: &70270132206360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :development
+  prerelease: false
+  version_requirements: *70270132206360
+- !ruby/object:Gem::Dependency
+  name: roodi
+  requirement: &70270132205880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *70270132205880
+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.'
+email: peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- CHANGES
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- cacheable_flash.gemspec
+- init.rb
+- install.rb
+- lib/cacheable_flash.rb
+- lib/cacheable_flash/rails/engine.rb
+- lib/cacheable_flash/rails/railtie.rb
+- lib/generators/cacheable_flash/install/install_generator.rb
+- spec/cacheable_flash/cacheable_flash_spec.rb
+- spec/cacheable_flash/install_spec.rb
+- spec/cacheable_flash/test_helpers_spec.rb
+- 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
+homepage: http://github.com/pboling/cacheable-flash
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1173852377275099503
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Render flash messages from a cookie using JavaScript, instead of in your
+  Rails view template
+test_files: []