cacheable_flash 0.2.3 → 0.2.4

data/CHANGES

@@ -1,3 +1,6 @@
+0.2.4 - FEB.27.2012
+- Dependency diet!  No longer requires all of rails - only railties.
+
 0.2.3 - JAN.13.2012
 - Fixed problems loading assets: Sprockets::FileNotFound - thanks jlxw
 - reflect move back to pivotal's repo in README.

data/Gemfile

@@ -1,18 +1,19 @@
 source "http://rubygems.org"
 
-gem "rails", "> 3.0"
-#We don't really need all of rails... so:
-#  Actually we do now that we have rails engine and rails railtie
-#  TODO: Investigate making a rails free version
-#gem "activesupport"
-#gem "activemodel"
-#gem "actionpack"
 gem "json"
 
-# Develop dependencies (everything needed to run rake, tests, features, etc.)
-group :development do
-  gem "rspec", "~> 2.8.0"
-  gem "yard", "~> 0.7.4"
+# Development dependencies (everything needed to run rake, tests, features, etc.)
+group :development, :test do
+  gem "rails", "~> 3.1.3"
+
+  # jquery-rails is used by the dummy application
+  gem "jquery-rails"
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+  gem "rspec-rails", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0.21"
   gem "jeweler", "~> 1.6.4"
   gem "reek", "~> 1.2.8"

data/Gemfile.lock

@@ -40,13 +40,16 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.6.4)
+    jquery-rails (1.0.19)
+      railties (~> 3.0)
+      thor (~> 0.14)
+    json (1.6.5)
     mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.17.2)
-    multi_json (1.0.4)
+    multi_json (1.1.0)
     polyglot (0.3.3)
     rack (1.3.6)
     rack-cache (1.1)
@@ -89,6 +92,11 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    rspec-rails (2.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.8.0)
     ruby2ruby (1.3.1)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
@@ -105,7 +113,6 @@ GEM
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.31)
-    yard (0.7.4)
 
 PLATFORMS
   ruby
@@ -113,9 +120,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.21)
   jeweler (~> 1.6.4)
+  jquery-rails
   json
-  rails (> 3.0)
+  rails (~> 3.1.3)
+  rdoc (~> 3.12)
   reek (~> 1.2.8)
   roodi (~> 2.1.0)
-  rspec (~> 2.8.0)
-  yard (~> 0.7.4)
+  rspec-rails (~> 2.8.0)

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2007-2010 Pivotal Labs
+Copyright (c) 2011-2012 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

@@ -1,10 +1,8 @@
-CacheableFlash
-==============
+= CacheableFlash
 
-cacheable-flash > v0.2 (organized by Peter Boling from many of the community forks)
-aims to be a drop-in replacement for the original cacheable-flash v0.1 (by Pivotal)
-but uses JQuery instead of Prototype.  The idea was to merge forks  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.
+Note: This fork, http://github.com/pboling/cacheable-flash, of
+cacheable-flash is where I play with new features & refactoring.  I, pboling, 
+am a maintainer of the the official repository here https://github.com/pivotal/cacheable-flash.
 
 == Installation as plugin
 
@@ -151,8 +149,8 @@ Cacheable Flash provides test helpers which includes the flash_cookie method.
 
 Licensed under the MIT License.
 
-Copyright (c) 2011-2012 Peter H. Boling (http://peterboling.com). See LICENSE.txt (MIT license) for further details.
-Copyright (c) 2007-2010 Pivotal Labs
+- Copyright (c) 2011-2012 Peter H. Boling (http://peterboling.com). See LICENSE.txt for further details.
+- Copyright (c) 2007-2010 Pivotal Labs
 
 
 

data/Rakefile

@@ -1,7 +1,11 @@
 # encoding: utf-8
-
+#!/usr/bin/env rake
 require 'rubygems'
-require 'bundler'
+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
@@ -50,5 +54,24 @@ end
 
 task :default => :spec
 
-require 'yard'
-YARD::Rake::YardocTask.new
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "CacheableFlash #{version}"
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/app/assets/javascripts/cacheable_flash/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/cacheable_flash/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/app/controllers/cacheable-flash/application_controller.rb

@@ -0,0 +1,5 @@
+module CacheableFlash
+  class ApplicationController < ActionController::Base
+    include CacheableFlash
+  end
+end

data/app/helpers/cacheable_flash/application_helper.rb

@@ -0,0 +1,4 @@
+module CacheableFlash
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/cacheable-flash/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>CacheableFlash</title>
+  <%= stylesheet_link_tag    "cacheable_flash/application", :media => "all" %>
+  <%= javascript_include_tag "cacheable_flash/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/cacheable_flash.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cacheable_flash"
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   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-01-14"
+  s.date = "2012-03-01"
   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 = [
@@ -22,19 +22,65 @@ Gem::Specification.new do |s|
     "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/rails/engine.rb",
-    "lib/cacheable_flash/rails/railtie.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",
@@ -53,29 +99,32 @@ 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<rails>, ["> 3.0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.7.4"])
+      s.add_development_dependency(%q<rails>, ["~> 3.1.3"])
+      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<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<rails>, ["> 3.0"])
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<yard>, ["~> 0.7.4"])
+      s.add_dependency(%q<rails>, ["~> 3.1.3"])
+      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<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<rails>, ["> 3.0"])
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<yard>, ["~> 0.7.4"])
+    s.add_dependency(%q<rails>, ["~> 3.1.3"])
+    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<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<reek>, ["~> 1.2.8"])

data/config/routes.rb

@@ -0,0 +1,2 @@
+CacheableFlash::Engine.routes.draw do
+end

data/lib/cacheable_flash.rb

@@ -1,15 +1,19 @@
+require 'json'
+
 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'
+  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
     # For older rails use generator
   end
 
   def self.included(base)
+    #base must define around_filter, as in Rails
     base.around_filter :write_flash_to_cookie
   end
 
@@ -17,7 +21,7 @@ module CacheableFlash
     yield if block_given?
     cookie_flash = if cookies['flash']
       begin
-        ActiveSupport::JSON.decode(cookies['flash'])
+        JSON(cookies['flash'])
       rescue
         {}
       end
@@ -32,8 +36,9 @@ module CacheableFlash
         cookie_flash[key.to_s] << "<br/>#{value}"
       end
     end
-
+    # Base must define cookies, as in Rails
     cookies['flash'] = cookie_flash.to_json.gsub("+", "%2B")
+    # Base must define flash, as in Rails
     flash.clear
   end
 end

data/lib/cacheable_flash/engine.rb

@@ -0,0 +1,7 @@
+module CacheableFlash
+  class Engine < ::Rails::Engine
+    if ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MAJOR >= 1
+      isolate_namespace CacheableFlash
+    end
+  end
+end

data/lib/cacheable_flash/railtie.rb

@@ -0,0 +1,10 @@
+# Add cacheable flash JS to defaults for Rails < 3.1 (not needed with asset pipeline)
+module CacheableFlash
+  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

data/lib/cacheable_flash/version.rb

@@ -0,0 +1,3 @@
+module CacheableFlash
+  VERSION = "0.2.4"
+end

data/lib/tasks/cacheable-flash_tasks.rake

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