cashier 0.2.0 → 0.4.0

data/lib/cashier/adapters/cache_store.rb

@@ -0,0 +1,45 @@
+module Cashier
+  module Adapters
+    class CacheStore
+      def self.store_fragment_in_tag(fragment, tag)
+        fragments = Rails.cache.fetch(tag) || []
+        new_fragments = fragments + [fragment]
+        Rails.cache.write(tag, new_fragments)
+      end
+
+      def self.store_tags(tags)
+        cashier_tags = Rails.cache.fetch(Cashier::CACHE_KEY) || []
+        cashier_tags = (cashier_tags + tags).uniq
+
+        Rails.cache.write(Cashier::CACHE_KEY, cashier_tags)
+      end
+
+      def self.remove_tags(tags)
+        cashier_tags = Rails.cache.fetch(Cashier::CACHE_KEY) || []
+        cashier_tags = (cashier_tags - tags).uniq
+        Rails.cache.write(Cashier::CACHE_KEY, cashier_tags)
+      end
+
+      def self.tags
+        Rails.cache.read(Cashier::CACHE_KEY) || []
+      end
+
+      def self.get_fragments_for_tag(tag)
+        Rails.cache.read(tag) || []
+      end
+
+      def self.delete_tag(tag)
+        Rails.cache.delete(tag)  
+      end
+
+      def self.clear
+        remove_tags(tags)
+        Rails.cache.delete(Cashier::CACHE_KEY)
+      end
+
+      def self.keys
+        tags.inject([]) { |arry, tag| arry += Rails.cache.fetch(tag) }.compact
+      end
+    end
+  end
+end

data/lib/cashier/adapters/redis_store.rb

@@ -0,0 +1,46 @@
+module Cashier
+  module Adapters
+    class RedisStore
+      def self.redis
+        @@redis
+      end
+
+      def self.redis=(redis_instance)
+        @@redis = redis_instance
+      end
+
+      def self.store_fragment_in_tag(fragment, tag)
+        redis.sadd(tag, fragment)
+      end
+
+      def self.store_tags(tags)
+        tags.each { |tag| redis.sadd(Cashier::CACHE_KEY, tag) }
+      end
+
+      def self.remove_tags(tags)
+        tags.each { |tag| redis.srem(Cashier::CACHE_KEY, tag) }
+      end
+
+      def self.tags
+        redis.smembers(Cashier::CACHE_KEY) || []
+      end
+
+      def self.get_fragments_for_tag(tag)
+        redis.smembers(tag) || []
+      end
+
+      def self.delete_tag(tag)
+        redis.del(tag)
+      end
+
+      def self.clear
+        remove_tags(tags)
+        redis.del(Cashier::CACHE_KEY)
+      end
+
+      def self.keys
+        tags.inject([]) { |arry, tag| arry += get_fragments_for_tag(tag) }.compact
+      end
+    end
+  end
+end

data/lib/cashier/application_controller.rb

@@ -0,0 +1,28 @@
+# Hooks into ApplicationController's write_fragment method.
+# write_fragment is used for action and fragment caching.
+# Create an alias method chain to call our customer method
+# which stores the associated key with the tag in a 
+# Redis Set. Then we can expire all those keys from anywhere
+# in the code using Rails.cache.delete
+#
+# I use alias_method_chain instead of calling 'super'
+# because there is a very rare case where someone 
+# may have redfined 'write_fragment' in their own 
+# controllers. Using an alias method chain
+# keeps those methods intact.
+
+class ApplicationController < ActionController::Base
+  def write_fragment_with_tagged_key(key, content, options = nil)
+    if options && options[:tag] && Cashier.perform_caching? 
+      tags = case options[:tag].class.to_s
+             when 'Proc', 'Lambda'
+               options[:tag].call(self)
+             else 
+               options[:tag]
+             end
+      Cashier.store_fragment fragment_cache_key(key), *tags
+    end
+    write_fragment_without_tagged_key(key, content, options)
+  end
+  alias_method_chain :write_fragment, :tagged_key
+end

data/lib/cashier/matchers.rb

@@ -1,6 +1,5 @@
 module Cashier
   module Matchers
-
     def be_cached
       Cache.new
     end

data/lib/cashier/railtie.rb

@@ -1,8 +1,9 @@
 module Cashier
   class Railtie < Rails::Railtie
     initializer 'cashier.initialize' do
-      ApplicationController.send :include, Cashier::ControllerHelper
+      ActiveSupport.on_load(:action_controller) do
+        require 'cashier/application_controller'
+      end
     end
   end
-end
-
+end

data/lib/cashier/version.rb

@@ -1,3 +1,3 @@
 module Cashier
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/spec/{application_controller_spec.rb → controllers/application_controller_spec.rb}

@@ -1,14 +1,6 @@
 require 'spec_helper'
 
-require 'rspec/rails'
-
-class ApplicationController
-  include Cashier::ControllerHelper
-end
-
 describe ApplicationController do
-  include Rspec::Rails::ControllerExampleGroup
-
   it "should be able to tag framgents" do
     Cashier.should_receive(:store_fragment).with('views/key', 'tag')
     controller.write_fragment('key', 'content', :tag => 'tag')

data/spec/{test_app → dummy}/config/application.rb

@@ -1,10 +1,6 @@
 require File.expand_path('../boot', __FILE__)
 
-require "active_model/railtie"
-require "active_record/railtie"
 require "action_controller/railtie"
-require "action_view/railtie"
-require "action_mailer/railtie"
 
 # If you have a Gemfile, require the gems listed there, including any gems
 # you've limited to :test, :development, or :production.

data/spec/{test_app → dummy}/config/environments/development.rb

@@ -14,9 +14,6 @@ TestApp::Application.configure do
   config.action_view.debug_rjs             = true
   config.action_controller.perform_caching = true
 
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
-
   # Print deprecation notices to the Rails logger
   config.active_support.deprecation = :log
 

data/spec/{test_app → dummy}/config/environments/production.rb

@@ -34,9 +34,6 @@ TestApp::Application.configure do
   # Enable serving of images, stylesheets, and javascripts from an asset server
   # config.action_controller.asset_host = "http://assets.example.com"
 
-  # Disable delivery errors, bad email addresses will be ignored
-  # config.action_mailer.raise_delivery_errors = false
-
   # Enable threaded mode
   # config.threadsafe!
 

data/spec/{test_app → dummy}/config/environments/test.rb

@@ -13,7 +13,7 @@ TestApp::Application.configure do
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = true
-  config.cache_store = :mem_cache_store
+  config.cache_store = :dalli_store
 
   # Raise exceptions instead of rendering exception templates
   config.action_dispatch.show_exceptions = false
@@ -21,11 +21,6 @@ TestApp::Application.configure do
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection    = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
   # Use SQL instead of Active Record's schema dumper when creating the test database.
   # This is necessary if your schema can't be completely dumped by the schema dumper,
   # like if you have constraints or database-specific column types

data/spec/lib/adapters/cache_store_spec.rb

@@ -0,0 +1,75 @@
+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
+end

data/spec/lib/adapters/redis_store_spec.rb

@@ -0,0 +1,89 @@
+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
+end