cacheable_flash 0.2.8 → 0.2.9

data/{CHANGES → CHANGELOG}

@@ -1,3 +1,8 @@
+0.2.9 - AUG.08.2012
+- More rearranging
+- Improved integration test of CacheableFlash & CacheableFlash::TestHelpers
+- Updated to latest jquery.cookie
+
 0.2.8 - AUG.07.2012
 - switch from jeweler to gem-release for bumping and tagging
 - bundler update (1.0.24)

data/lib/cacheable_flash/railtie.rb

@@ -3,7 +3,7 @@ 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)
+        config.action_view.javascript_expansions[:cacheable_flash] = %w(jquery.cookie flash)
       end
     end
   end

data/{spec/support → lib/cacheable_flash}/test_helpers.rb

@@ -3,8 +3,8 @@ require 'json'
 module CacheableFlash
   module TestHelpers
     def flash_cookie
-      return {} unless cookies['flash']
-      JSON(cookies['flash'])
+      return {} unless response.cookies['flash']
+      JSON(response.cookies['flash'])
     rescue JSON::ParserError
       {}
     end

data/lib/cacheable_flash/version.rb

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

data/spec/cacheable_flash/test_helpers_spec.rb

@@ -1,36 +1,40 @@
-#require 'spec_helper'
-#
-#module CacheableFlash
-#  describe TestHelpers do
-#    attr_reader :controller, :request, :response, :flash, :cookies
-#    include TestHelpers
-#    before do
-#      @controller = ActionController::Base.new
-#      @request = ActionDispatch::TestRequest.new
-#      @response = ActionDispatch::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
+## Testing the cookie is now notoriously difficult, and entirely undocumented for Rails 3.2:
+## https://www.relishapp.com/rspec/rspec-rails/docs/controller-specs/cookies
+## CacheableFlash::TestHelpers is now integration tested in the controllers/dummy_controller_spec.rb
+#
+#require 'spec_helper'
+#
+#module CacheableFlash
+#  describe TestHelpers do
+#    attr_reader :controller, :request, :response, :flash, :cookies
+#    include TestHelpers
+#    before do
+#      @controller = ActionController::Base.new
+#      @request = ActionDispatch::TestRequest.new
+#      @response = ActionDispatch::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/controllers/dummy_controller_spec.rb

@@ -1,19 +1,26 @@
 require 'spec_helper'
 
 describe DummyController do
-  describe 'cacheable_flash works' do
-    render_views
-    before(:each) do
-      get :index
-    end
-    it "should assign flash" do
-      expected_flash = {
-        'errors' => "This is an Error",
-        'notice' => "This is a Notice"
-      }
-      flash[:errors].should == expected_flash['errors']
-      flash[:notice].should == expected_flash['notice']
+
+  include CacheableFlash::TestHelpers
+
+  render_views
+
+  before(:each) do
+    @expected_flash = {
+      'errors' => "This is an Error",
+      'notice' => "This is a Notice"
+    }
+    get :index
+  end
+
+  describe "TestHelpers" do
+    it "should assign flashes to cookie" do
+      flash_cookie['errors'].should == @expected_flash['errors']
+      flash_cookie['notice'].should == @expected_flash['notice']
+      flash_cookie.should == @expected_flash
     end
   end
+
 end
 

data/spec/dummy/app/controllers/dummy_controller.rb

@@ -1,4 +1,5 @@
 class DummyController < ApplicationController
+  include CacheableFlash
   def index
     expected_flash = {
     'errors' => "This is an Error",

data/spec/spec_helper.rb

@@ -16,7 +16,7 @@ require 'cacheable_flash'
 #$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 #$LOAD_PATH.unshift(File.dirname(__FILE__))
 
-require 'support/test_helpers'
+require 'cacheable_flash/test_helpers'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

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

@@ -1,91 +1,47 @@
-/*jslint browser: true */ /*global jQuery: true */
-
-/**
- * jQuery Cookie plugin
+/*!
+ * jQuery Cookie Plugin
+ * https://github.com/carhartl/jquery-cookie
  *
- * Copyright (c) 2010 Klaus Hartl (stilbuero.de)
- * Dual licensed under the MIT and GPL licenses:
+ * Copyright 2011, Klaus Hartl
+ * Dual licensed under the MIT or GPL Version 2 licenses.
  * http://www.opensource.org/licenses/mit-license.php
- * http://www.gnu.org/licenses/gpl.html
- *
+ * http://www.opensource.org/licenses/GPL-2.0
  */
+(function($) {
+    $.cookie = function(key, value, options) {
 
-// TODO JsDoc
+        // key and at least value given, set cookie...
+        if (arguments.length > 1 && (!/Object/.test(Object.prototype.toString.call(value)) || value === null || value === undefined)) {
+            options = $.extend({}, options);
 
-/**
- * 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
- */
+            if (value === null || value === undefined) {
+                options.expires = -1;
+            }
 
-/**
- * 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 (typeof options.expires === 'number') {
+                var days = options.expires, t = options.expires = new Date();
+                t.setDate(t.getDate() + days);
+            }
 
-        if (value === null || value === undefined) {
-            options.expires = -1;
-        }
+            value = String(value);
 
-        if (typeof options.expires === 'number') {
-            var days = options.expires, t = options.expires = new Date();
-            options.expires.setDate(t.getDate() + days);
+            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(''));
         }
-        
-        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;
-};
+        // key and possibly options given, get cookie...
+        options = value || {};
+        var decode = options.raw ? function(s) { return s; } : decodeURIComponent;
+
+        var pairs = document.cookie.split('; ');
+        for (var i = 0, pair; pair = pairs[i] && pairs[i].split('='); i++) {
+            if (decode(pair[0]) === key) return decode(pair[1] || ''); // IE saves cookies with empty string as "c; ", e.g. without "=" as opposed to EOMB, thus pair[1] may be undefined
+        }
+        return null;
+    };
+})(jQuery);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cacheable_flash
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
   prerelease: 
 platform: ruby
 authors:
@@ -172,17 +172,11 @@ extra_rdoc_files:
 files:
 - .document
 - .gitignore
-- CHANGES
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- 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
@@ -192,6 +186,7 @@ files:
 - lib/cacheable_flash/engine.rb
 - lib/cacheable_flash/middleware.rb
 - lib/cacheable_flash/railtie.rb
+- lib/cacheable_flash/test_helpers.rb
 - lib/cacheable_flash/version.rb
 - lib/generators/cacheable_flash/install/install_generator.rb
 - lib/tasks/cacheable-flash_tasks.rake
@@ -237,7 +232,6 @@ files:
 - 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
@@ -309,4 +303,3 @@ test_files:
 - spec/js_unit/cookie_test.html
 - spec/js_unit/flash_test.html
 - spec/spec_helper.rb
-- spec/support/test_helpers.rb

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

@@ -1,15 +0,0 @@
-// 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

@@ -1,13 +0,0 @@
-/*
- * 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

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

data/app/helpers/cacheable_flash/application_helper.rb

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

data/app/views/layouts/cacheable_flash/application.html.erb

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