cacheable_flash 0.2.2 → 0.2.3

data/Rakefile

@@ -1,54 +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
+# 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/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{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

@@ -1 +1 @@
-0.2.2
+0.2.3

data/cacheable_flash.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cacheable_flash"
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   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.date = "2012-01-14"
   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 = [
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
     "vendor/assets/javascripts/flash.js",
     "vendor/assets/javascripts/jquery.cookie.js"
   ]
-  s.homepage = "http://github.com/pboling/cacheable-flash"
+  s.homepage = "http://github.com/pivotal/cacheable-flash"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.10"
@@ -53,33 +53,30 @@ Gem::Specification.new do |s|
     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<rails>, ["> 3.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<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7.4"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.21"])
       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<rails>, ["> 3.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<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7.4"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.21"])
       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<rails>, ["> 3.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<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7.4"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.21"])
     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/init.rb

@@ -1,6 +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
+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

@@ -1,18 +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
+# 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

@@ -1,38 +1,39 @@
-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'
-    require 'cacheable_flash/rails/railtie'
-  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
+module CacheableFlash
+  require 'rails'
+  if ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR == 0
+    require 'cacheable_flash/rails/railtie'
+  elsif ::Rails.version >= "3.1"
+    require 'cacheable_flash/rails/engine'
+    require 'cacheable_flash/rails/railtie'
+  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

@@ -1,13 +1,8 @@
-# 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
+# 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 CacheableFlash
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/cacheable_flash/rails/railtie.rb

@@ -1,14 +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
+# 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

@@ -1,23 +1,23 @@
-# 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
-  #
-  class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path('../../../../../vendor/assets/javascripts/', __FILE__)
-
-    # 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
-    desc "Copies some JS files to public/javascripts/"
-    def copy_files
-      if ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR == 1
-        ActiveSupport::Deprecation.warn("Rails 3.1 has the asset pipeline, so you only need to copy javascript files if you aren't using it.")
-      end
-      template 'flash.js',     'public/javascripts/flash.js'
-      template 'jquery.cookie.js', 'public/javascripts/jquery.cookie.js'
-    end
-  end
-end
+# 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
+  #
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../../vendor/assets/javascripts/', __FILE__)
+
+    # 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
+    desc "Copies some JS files to public/javascripts/"
+    def copy_files
+      if ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR == 1
+        ActiveSupport::Deprecation.warn("Rails 3.1 has the asset pipeline, so you only need to copy javascript files if you aren't using it.")
+      end
+      template 'flash.js',     'public/javascripts/flash.js'
+      template 'jquery.cookie.js', 'public/javascripts/jquery.cookie.js'
+    end
+  end
+end

data/spec/cacheable_flash/cacheable_flash_spec.rb

@@ -1,101 +1,105 @@
-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
+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.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
+      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