cashier-ftbpro 0.5.0

data/spec/dummy/public/javascripts/rails.js

@@ -0,0 +1,191 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var csrf_meta_tag = $$('meta[name=csrf-token]')[0];
+
+      if (csrf_meta_tag) {
+        var header = 'X-CSRF-Token',
+            token = csrf_meta_tag.readAttribute('content');
+
+        if (!request.options.requestHeaders) {
+          request.options.requestHeaders = {};
+        }
+        request.options.requestHeaders[header] = token;
+      }
+    }
+  });
+})();

data/spec/dummy/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/dummy/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionDispatch::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/spec/dummy/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/spec/integration/rails_cache_integration_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe "Rails cache integration" do
+  subject { Rails.cache }
+  let(:cashier) { Cashier }
+
+  before(:each) do
+    Cashier.adapter = :cache_store
+  end
+
+  it "should ensure that cache operations are instrumented" do
+    ActiveSupport::Cache::Store.instrument.should be_true
+  end
+
+  context "write" do
+    it "should write to cashier when I call Rails.cache.write with tags" do
+      cashier.should_receive(:store_fragment).with("foo", ["some_tag"])
+      subject.write("foo", "bar", :tag => ["some_tag"])
+    end
+
+    it "shuld not write to cashier when I call Rails.cache.write without tags" do
+      cashier.should_not_receive(:store_fragment)
+      subject.write("foo", "bar")
+    end
+
+    it "should not fail when I don't pass in any options" do
+      expect { subject.write("foo", "bar", nil) }.to_not raise_error
+    end
+  end
+
+  context "fetch" do
+    it "should write to cashier when I call Rails.cache.fetch with tags" do
+      cashier.should_receive(:store_fragment).with("foo", ["some_tag"])
+      subject.fetch("foo", :tag => ["some_tag"]) { "bar" }
+    end
+
+    it "shuld not write to cashier when I call Rails.cache.fetch without tags" do
+      cashier.should_not_receive(:store_fragment)
+      subject.fetch("foo") { "bar" }
+    end
+  end
+
+  context "read" do
+    it "should keep track of fragment container hierarchy" do
+      subject.fetch("foo1", :tag => ["some_tag", "some_other_tag"]) do
+        subject.fetch("foo2", :tag => ["some_inner_tag", "some_other_inner_tag"]) { "bar" }
+      end
+
+      cashier.get_containers(["some_inner_tag"]).should == ["some_tag", "some_other_tag"]
+      cashier.get_containers(["some_other_inner_tag"]).should == ["some_tag", "some_other_tag"]
+    end
+  end
+
+  context "expire" do
+    let(:notification_system) { ActiveSupport::Notifications }
+
+    it "should expire containers when expiring a tag" do
+      subject.fetch("foo3", :tag => ["outer_tag1", "outer_tag2"]) do
+        subject.fetch("foo4", :tag => ["inner_tag1", "inner_tag2"]) { "bar" }
+      end
+      cashier.adapter.get_fragments_for_tag("outer_tag1").should == ["foo3"]
+
+      cashier.expire("inner_tag1")
+      cashier.adapter.get_fragments_for_tag("outer_tag1").should == []
+    end
+  end
+
+end

data/spec/integration/rails_configuration_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "Rails configuration" do
+  it "should be configuration through rails" do
+    Rails.application.config.cashier.adapter = :redis_store
+
+    Cashier.adapter.should == Cashier::Adapters::RedisStore 
+  end
+end

data/spec/lib/cashier/adapters/cache_store_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+  
+describe Cashier::Adapters::CacheStore do
+  subject { Cashier::Adapters::CacheStore }
+  let(:cache) { Rails.cache }
+
+  it "should store the fragment in a tag" do
+    subject.store_fragment_in_tag('fragment-key', 'dashboard')
+    cache.fetch('dashboard').should eql(['fragment-key'])
+  end
+
+  it "should store the tag in the tags array" do
+    subject.store_tags(["dashboard"])
+    cache.fetch(Cashier::CACHE_KEY).should eql(['dashboard'])
+  end
+
+  it "should return all of the fragments for a given tag" do
+    subject.store_fragment_in_tag('fragment-key', 'dashboard')
+    subject.store_fragment_in_tag('fragment-key-2', 'dashboard')
+    subject.store_fragment_in_tag('fragment-key-3', 'dashboard')
+
+    subject.get_fragments_for_tag('dashboard').length.should == 3
+  end
+
+  it "should delete a tag from the cache" do
+    subject.store_fragment_in_tag('fragment-key', 'dashboard')
+    Rails.cache.read('dashboard').should_not be_nil
+
+    subject.delete_tag('dashboard')
+    Rails.cache.read('dashboard').should be_nil
+  end
+
+  it "should return the list of tags" do
+    (1..5).each {|i| subject.store_tags(["tag-#{i}"])}
+    subject.tags.length.should == 5
+  end
+
+  it "should return the tags correctly" do
+    subject.store_tags(["tag-1", "tag-2", "tag-3"])
+    subject.tags.include?("tag-1").should be_true
+  end
+
+  it "should remove tags from the tags list" do
+    (1..5).each {|i| subject.store_tags(["tag-#{i}"])}
+    subject.remove_tags(["tag-1", "tag-2", "tag-3", "tag-4", "tag-5"])
+    subject.tags.length.should == 0
+  end
+
+  context "clear" do
+    before(:each) do
+      subject.store_tags(['dashboard'])
+      subject.store_tags(['settings'])
+      subject.store_tags(['email'])
+    end
+
+    it "should clear the cache and remove all of the tags" do
+      subject.should_receive(:remove_tags).with(['dashboard','settings','email'])
+      subject.clear
+      Rails.cache.read(Cashier::CACHE_KEY).should be_nil
+    end
+  end
+
+  context "keys" do
+    it "should return the list of keys" do
+      subject.store_tags(['dashboard', 'settings', 'email'])
+
+      subject.store_fragment_in_tag('key1', 'dashboard')
+      subject.store_fragment_in_tag('key2', 'settings')
+      subject.store_fragment_in_tag('key3', 'email')
+
+      subject.keys.should eql(%w(key1 key2 key3))
+    end
+  end
+
+  context "containers" do
+    it "should be added to tags" do
+      subject.add_tags_containers(['key1', 'key2'], ['container1', 'container2'])
+      cache.fetch('cashier-tag-containers:key1').should == ['container1', 'container2']
+      cache.fetch('cashier-tag-containers:key2').should == ['container1', 'container2']
+      
+      subject.add_tags_containers(['key1', 'key3'], ['container3'])
+      cache.fetch('cashier-tag-containers:key1').should == ['container1', 'container2', 'container3']
+      cache.fetch('cashier-tag-containers:key3').should == ['container3']
+    end
+
+    it "should be returned for tags" do
+      subject.add_tags_containers(['key1', 'key2'], ['container1', 'container2'])
+      subject.get_tags_containers(['key1']).should == ['container1', 'container2']
+      subject.get_tags_containers(['key2']).should == ['container1', 'container2']
+    end
+  end
+end

data/spec/lib/cashier/adapters/redis_store_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Cashier::Adapters::RedisStore do
+  subject { Cashier::Adapters::RedisStore }
+  let(:cache) { Rails.cache }
+  let(:redis) { subject.redis }
+
+  context "setting and getting the redis instance" do
+    it "should allow to set the redis instance" do
+      subject.respond_to?(:redis=).should be_true
+    end
+
+    it "should allow to get the redis instance" do
+      subject.respond_to?(:redis).should be_true
+    end
+  end
+
+  it "should return the redis instance you set" do
+    subject.redis = redis
+    subject.redis.should == redis
+  end
+
+  it "should store the fragment in a tag" do
+    subject.store_fragment_in_tag('fragment-key', 'dashboard')
+    redis.smembers('dashboard').should eql(['fragment-key'])
+  end
+
+  it "should store the tag in the tags array" do
+    subject.store_tags(["dashboard"])
+    redis.smembers(Cashier::CACHE_KEY).should eql(['dashboard'])
+  end
+
+  it "should return all of the fragments for a given tag" do
+    subject.store_fragment_in_tag('fragment-key', 'dashboard')
+    subject.store_fragment_in_tag('fragment-key-2', 'dashboard')
+    subject.store_fragment_in_tag('fragment-key-3', 'dashboard')
+
+    subject.get_fragments_for_tag('dashboard').length.should == 3
+  end
+
+  it "should delete a tag from the cache" do
+    subject.store_fragment_in_tag('fragment-key', 'dashboard')
+    redis.smembers('dashboard').should_not be_nil
+
+    subject.delete_tag('dashboard')
+    redis.exists('dashboard').should be_false
+  end
+
+  it "should return the list of tags" do
+    (1..5).each {|i| subject.store_tags(["tag-#{i}"])}
+    subject.tags.length.should == 5
+  end
+
+  it "should return the tags correctly" do
+    subject.store_tags(["tag-1", "tag-2", "tag-3"])
+    subject.tags.include?("tag-1").should be_true
+  end
+
+  it "should remove tags from the tags list" do
+    (1..5).each {|i| subject.store_tags(["tag-#{i}"])}
+    subject.remove_tags(["tag-1", "tag-2", "tag-3", "tag-4", "tag-5"])
+    subject.tags.length.should == 0
+  end
+
+  context "clear" do
+    before(:each) do
+      subject.store_tags(['dashboard'])
+      subject.store_tags(['settings'])
+      subject.store_tags(['email'])
+    end
+
+    it "should clear the cache and remove all of the tags" do
+      subject.clear
+      redis.smembers(Cashier::CACHE_KEY).should eql([])
+    end
+  end
+
+  context "keys" do
+    it "should return the list of keys" do
+      subject.store_tags(['dashboard', 'settings', 'email'])
+
+      subject.store_fragment_in_tag('key1', 'dashboard')
+      subject.store_fragment_in_tag('key2', 'settings')
+      subject.store_fragment_in_tag('key3', 'email')
+
+      subject.keys.sort.should eql(%w(key1 key2 key3))
+    end
+  end
+
+  context "containers" do
+    it "should be added to tags" do
+      subject.add_tags_containers(['key1', 'key2'], ['container1', 'container2'])
+      subject.add_tags_containers(['key1', 'key3'], ['container2', 'container3'])
+
+      subject.get_tags_containers(['key1']).should == ['container1', 'container2', 'container3']
+      subject.get_tags_containers(['key2']).should == ['container1', 'container2']
+      subject.get_tags_containers(['key1', 'key2']).should == ['container1', 'container2', 'container3']
+    end
+
+    it "should be returned for tags" do
+      subject.add_tags_containers(['key1', 'key2'], ['container1', 'container2'])
+      subject.get_tags_containers(['key1']).should == ['container1', 'container2']
+      subject.get_tags_containers(['key2']).should == ['container1', 'container2']
+    end
+  end
+  
+end