rails_cacheable_flash 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrey
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+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.md

@@ -0,0 +1,30 @@
+rails_cacheable_flash
+===============
+
+Кэшируемый флеш. Позволяет отрабатывать флеш-нотисы на кэшируемых страницах.
+
+Может использоваться совместно со Spree.
+
+Подключение:
+
+1. В нужном контроллере подключаете джем (фактически там, где потенциально могут появляться флеш-нотисы)
+
+include RailsCacheableFlash
+
+2. В йаваскрипте подключаете js-библиотеку джема и даете указания выводить флеш нотисы перед определенным контейнером
+
+//= require cacheable_flah
+
+...
+
+$(document).ready(function() {
+
+  ...
+
+  Flash.transferFromCookies();
+
+  Flash.writeDataFrom('notice', '#container980');
+
+  Flash.writeDataFrom('error', '#container980');
+
+});

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/cacheable_flash.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails_cacheable_flash/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrey"]
+  gem.email         = ["railscode@gmail.com"]
+  gem.description   = "Кэшируемый флеш"
+  gem.summary       = "Суммари"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rails_cacheable_flash"
+  gem.require_paths = ["lib"]
+  gem.version       = RailsCacheableFlash::VERSION
+end

data/lib/rails_cacheable_flash/engine.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+module RailsCacheableFlash
+  class Engine < ::Rails::Engine
+    if ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MAJOR >= 1
+      isolate_namespace RailsCacheableFlash
+    end
+  end
+
+  def self.included(base)
+    base.after_filter :write_flash_to_cookie
+  end
+
+  def write_flash_to_cookie
+    cookie_flash = JSON.parse(cookies['flash']) rescue {}
+    flash.each do |key, value|
+      cookie_flash[key.to_s] = value
+    end
+    cookies['flash'] = cookie_flash.to_json
+    flash.clear
+
+    if defined?(Spree::Core)
+      set_customizer_cookies
+      # save_referrer_to_order
+    end
+  end
+
+  # TODO: реализовать и проверить save_referrer_to_order на кэшируемых страницах
+  # def save_referrer_to_order
+  #   session[:referrer] = nil # request.env['HTTP_REFERER'] if !session[:referrer]
+  #   puts "===================="
+  #   puts "current_order: #{current_order}"
+  #   puts "request.env['HTTP_REFERER']: #{request.env['HTTP_REFERER']}"
+  #   puts "session[:referrer]: #{session[:referrer]}"
+  #   puts "===================="
+  # end
+
+  def set_customizer_cookies
+    cookies[:authenticity_token] = session[:_csrf_token] ||= SecureRandom.base64(32)
+    cookies[:current_user_id] = current_user.try(:id)
+  end
+end

data/lib/rails_cacheable_flash/version.rb

@@ -0,0 +1,3 @@
+module RailsCacheableFlash
+  VERSION = "0.0.2"
+end

data/lib/rails_cacheable_flash.rb

@@ -0,0 +1,2 @@
+require "cacheable_flash/version"
+require "cacheable_flash/engine"

data/vendor/assets/javascripts/cacheable_flash.js

@@ -0,0 +1,4 @@
+//= require flash/cookie
+//= require flash/json
+//= require flash/flash
+//= require flash/notice

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

@@ -0,0 +1,49 @@
+// From http://wiki.script.aculo.us/scriptaculous/show/Cookie
+var Cookie = {
+  set: function(name, value, daysToExpire) {
+    var expire = '';
+    if(!daysToExpire) daysToExpire = 365;
+    var d = new Date();
+    d.setTime(d.getTime() + (86400000 * parseFloat(daysToExpire)));
+    expire = 'expires=' + d.toGMTString();
+    var path = "path=/"
+    var cookieValue = escape(name) + '=' + escape(value || '') + '; ' + path + '; ' + expire + ';';
+    return document.cookie = cookieValue;
+  },
+  get: function(name) {
+    var cookie = document.cookie.match(new RegExp('(^|;)\\s*' + escape(name) + '=([^;\\s]+)'));
+    return (cookie ? unescape(cookie[2]) : null);
+  },
+  erase: function(name) {
+    var cookie = Cookie.get(name) || true;
+    Cookie.set(name, '', -1);
+    return cookie;
+  },
+  eraseAll: function() {
+    // Get cookie string and separate into individual cookie phrases:
+    var cookieString = "" + document.cookie;
+    var cookieArray = cookieString.split("; ");
+
+    // Try to delete each cookie:
+    for(var i = 0; i < cookieArray.length; ++ i)
+    {
+      var singleCookie = cookieArray[i].split("=");
+      if(singleCookie.length != 2)
+        continue;
+      var name = unescape(singleCookie[0]);
+      Cookie.erase(name);
+    }
+  },
+  accept: function() {
+    if (typeof navigator.cookieEnabled == 'boolean') {
+      return navigator.cookieEnabled;
+    }
+    Cookie.set('_test', '1');
+    return (Cookie.erase('_test') === '1');
+  },
+  exists: function(cookieName) {
+    var cookieValue = Cookie.get(cookieName);
+    if(!cookieValue) return false;
+    return cookieValue.toString() != "";
+  }
+};

data/vendor/assets/javascripts/flash/flash.js

@@ -0,0 +1,29 @@
+var Flash = new Object();
+
+Flash.data = {};
+
+Flash.transferFromCookies = function() {
+  var data = JSON.parse(unescape(Cookie.get("flash")));
+  if(!data) data = {};
+  Flash.data = data;
+  Cookie.erase("flash");
+};
+
+Flash.writeDataTo = function(name, element) {
+  element = $(element);
+  var content = "";
+  if(Flash.data[name]) {
+    content = Flash.data[name].toString().replace(/\+/g, ' ');
+  }
+  element.html(unescape(content));
+};
+
+Flash.writeDataFrom = function(name, before_selector) {
+  var content = "";
+  if(Flash.data[name]) {
+    content = Flash.data[name].toString().replace(/\+/g, ' ');
+  }
+  if (content != ""){
+    $('<div id="flash" class="flash flash-'+name+'"><div class="closer" id="closer">x</div><div class="message">'+unescape(content)+'</div></div>').insertBefore(before_selector);
+  }
+};

data/vendor/assets/javascripts/flash/json.js

@@ -0,0 +1,139 @@
+/*
+Copyright (c) 2005 JSON.org
+
+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 Software shall be used for Good, not Evil.
+
+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.
+*/
+
+/*
+    The global object JSON contains two methods.
+
+    JSON.stringify(value) takes a JavaScript value and produces a JSON text.
+    The value must not be cyclical.
+
+    JSON.parse(text) takes a JSON text and produces a JavaScript value. It will
+    return false if there is an error.
+*/
+var JSON = function () {
+    var m = {
+            '\b': '\\b',
+            '\t': '\\t',
+            '\n': '\\n',
+            '\f': '\\f',
+            '\r': '\\r',
+            '"' : '\\"',
+            '\\': '\\\\'
+        },
+        s = {
+            'boolean': function (x) {
+                return String(x);
+            },
+            number: function (x) {
+                return isFinite(x) ? String(x) : 'null';
+            },
+            string: function (x) {
+                if (/["\\\x00-\x1f]/.test(x)) {
+                    x = x.replace(/([\x00-\x1f\\"])/g, function(a, b) {
+                        var c = m[b];
+                        if (c) {
+                            return c;
+                        }
+                        c = b.charCodeAt();
+                        return '\\u00' +
+                            Math.floor(c / 16).toString(16) +
+                            (c % 16).toString(16);
+                    });
+                }
+                return '"' + x + '"';
+            },
+            object: function (x) {
+                if (x) {
+                    var a = [], b, f, i, l, v;
+                    if (x instanceof Array) {
+                        a[0] = '[';
+                        l = x.length;
+                        for (i = 0; i < l; i += 1) {
+                            v = x[i];
+                            f = s[typeof v];
+                            if (f) {
+                                v = f(v);
+                                if (typeof v == 'string') {
+                                    if (b) {
+                                        a[a.length] = ',';
+                                    }
+                                    a[a.length] = v;
+                                    b = true;
+                                }
+                            }
+                        }
+                        a[a.length] = ']';
+                    } else if (x instanceof Object) {
+                        a[0] = '{';
+                        for (i in x) {
+                            v = x[i];
+                            f = s[typeof v];
+                            if (f) {
+                                v = f(v);
+                                if (typeof v == 'string') {
+                                    if (b) {
+                                        a[a.length] = ',';
+                                    }
+                                    a.push(s.string(i), ':', v);
+                                    b = true;
+                                }
+                            }
+                        }
+                        a[a.length] = '}';
+                    } else {
+                        return;
+                    }
+                    return a.join('');
+                }
+                return 'null';
+            }
+        };
+    return {
+        copyright: '(c)2005 JSON.org',
+        license: 'http://www.JSON.org/license.html',
+/*
+    Stringify a JavaScript value, producing a JSON text.
+*/
+        stringify: function (v) {
+            var f = s[typeof v];
+            if (f) {
+                v = f(v);
+                if (typeof v == 'string') {
+                    return v;
+                }
+            }
+            return null;
+        },
+/*
+    Parse a JSON text, producing a JavaScript value.
+    It returns false if there is a syntax error.
+*/
+        parse: function (text) {
+            try {
+                return !(/[^,:{}\[\]0-9.\-+Eaeflnr-u \n\r\t]/.test(
+                        text.replace(/"(\\.|[^"\\])*"/g, ''))) &&
+                    eval('(' + text + ')');
+            } catch (e) {
+                return false;
+            }
+        }
+    };
+}();

data/vendor/assets/javascripts/flash/notice.js

@@ -0,0 +1,14 @@
+function close_flash() {
+  $("#closer").live('click', function(){
+    var flash = $(this).parents('div:first');
+    flash.animate({opacity: 1.0, top: '+=20'});
+    flash.animate({opacity: 0.75, top: '-=500'}, 300, function() {
+      flash.remove();
+    });
+    return false;
+  });
+};
+
+$(document).ready(function() {
+  close_flash();
+});

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rails_cacheable_flash
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Andrey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-05 00:00:00.000000000 Z
+dependencies: []
+description: Кэшируемый флеш
+email:
+- railscode@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cacheable_flash.gemspec
+- lib/rails_cacheable_flash.rb
+- lib/rails_cacheable_flash/engine.rb
+- lib/rails_cacheable_flash/version.rb
+- vendor/assets/javascripts/cacheable_flash.js
+- vendor/assets/javascripts/flash/cookie.js
+- vendor/assets/javascripts/flash/flash.js
+- vendor/assets/javascripts/flash/json.js
+- vendor/assets/javascripts/flash/notice.js
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Суммари
+test_files: []