cashier 0.1.0 → 0.2.0

data/lib/cashier/controller_helper.rb

@@ -17,17 +17,13 @@ module Cashier
       klass.class_eval do
         def write_fragment_with_tagged_key(key, content, options = nil)
           if options && options[:tag] && Cashier.perform_caching? 
-            passed_tags = case options[:tag].class.to_s
+            tags = case options[:tag].class.to_s
                    when 'Proc', 'Lambda'
                      options[:tag].call(self)
                    else 
                      options[:tag]
                    end
-            tags = passed_tags.is_a?(Array) ? passed_tags : [passed_tags]
-            tags.each do |tag|
-              Cashier.redis.sadd tag, fragment_cache_key(key)
-              Cashier.redis.sadd Cashier::STORAGE_KEY, tag
-            end
+            Cashier.store_fragment fragment_cache_key(key), *tags
           end
           write_fragment_without_tagged_key(key, content, options)
         end

data/lib/cashier/cucumber.rb

@@ -0,0 +1,6 @@
+World(Cashier::Matchers)
+
+Before('@caching') do
+  Cashier.clear
+  Rails.cache.clear
+end

data/lib/cashier/matchers.rb

@@ -0,0 +1,39 @@
+module Cashier
+  module Matchers
+
+    def be_cached
+      Cache.new
+    end
+
+    class Cache
+      def matches?(target)
+        @target = target
+
+        @test_results = Cashier.keys_for(@target).inject({}) do |hash, key|
+          hash.merge(key => Rails.cache.exist?(key))
+        end
+
+        flag = @test_results.values.inject(true) { |f, v| f && v }
+        flag && Cashier.keys_for(@target).present?
+      end
+
+      def failure_message_for_should
+        <<-msg
+          expected the Rails.cache to include all these keys:
+          #{Cashier.keys_for(@target).to_sentence}, but
+          it did not include these keys:
+          #{@test_results.keys.select {|k| @test_results[k] == false }.to_sentence}
+        msg
+      end
+
+      def failure_message_for_should_not
+        <<-msg
+          expected the Rails.cache to not include all these keys:
+          #{Cashier.keys_for(@target).to_sentence}, but
+          it did include these keys:
+          #{@test_results.keys.select {|k| @test_results[k] == true }.to_sentence}
+        msg
+      end
+    end
+  end
+end

data/lib/cashier/railtie.rb

@@ -0,0 +1,8 @@
+module Cashier
+  class Railtie < Rails::Railtie
+    initializer 'cashier.initialize' do
+      ApplicationController.send :include, Cashier::ControllerHelper
+    end
+  end
+end
+

data/lib/cashier/version.rb

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

data/readme.md

@@ -6,14 +6,14 @@ Manage your cache keys with tags, forget about keys!
 
     # in your view
     cache @some_record, :tag => 'some-component'
-    
+
     # in another view
     cache @some_releated_record, :tag => 'some-component'
 
     # can have multiple tags
     cache @something, :tag => ['dashboard', 'settings'] # can expire from either tag
 
-    # in your sweeper
+    # in an observer
     Cashier.expire 'some-component' # don't worry about keys! Much easier to sweep with confidence
 
     # in your controller
@@ -22,7 +22,6 @@ Manage your cache keys with tags, forget about keys!
       c.params
     }
 
-
     # need to access the controller?
     caches_action :tag => proc {|c|
       # c is the controller
@@ -37,7 +36,7 @@ Manage your cache keys with tags, forget about keys!
     Cashier.tags
 
     # sweep all stored keys
-    Cashier.wipe
+    Cashier.clear
 
 ## How it Came About
 
@@ -49,44 +48,60 @@ I needed a better solution. I wanted to expire things logically as a viewed them
 a record was added, I wanted to say "expire that page". Problem was that page contained ~1000 different keys.
 So I needed something to store the keys for me and associate them with tags. That's exactly what cashier does.
 Cache associate individual cache keys with a tag, then expire them all at once. This took my 7 layer loop
-down two one line of code. It's also made managing the cache throught my application much easier.
+down to one line of code. It's also made managing the cache throught my application much easier.
 
 ## Why Tag Based Caching is Useful
 
-  1. You don't worry about keys. How many times have you created a complicated key for a fragment or action
-  then messed up when you tried to expire the cache
-  2. Associate your cached content into groups of related content. If you have records that are closely associated
-  or displayed together, then you can tag them and expire them at once.
-  3. **Expire cached content from anywhere.** If you've done any serious development, you know that Rails caching
-  does not work (easily) outside the scope of an HTTP request. If you have background jobs that manipulate data
-  or potentially invalidate cached data, you know how much of a pain it is to say `expire_fragment` in some random code.
-  4. Don't do anything differently! All you have to do is pass `:tag => 'something'` into `cache` (in the view) or `caches_action` 
-  in the controller.
+1. You don't worry about keys. How many times have you created a complicated key for a fragment or action
+then messed up when you tried to expire the cache
+2. Associate your cached content into groups of related content. If you have records that are closely associated
+or displayed together, then you can tag them and expire them at once.
+3. **Expire cached content from anywhere.** If you've done any serious development, you know that Rails caching
+does not work (easily) outside the scope of an HTTP request. If you have background jobs that manipulate data
+or potentially invalidate cached data, you know how much of a pain it is to say `expire_fragment` in some random code.
+4. Don't do anything differently! All you have to do is pass `:tag => 'something'` into `cache` (in the view) or `caches_action` 
+in the controller.
 
 ## How it Works
 
 Cashier hooks into Rails' `expire_fragment` method using `alias_method_chain` to run some code that captures the key
-and tag then stores that as a set in redis. Then uses the set members to loop over keys to deleting using `Rails.cache.delete`
+and tag then stores that in the rails cache. **No external processes are
+needed. All tag/fragment information is stored in the Rails.cache.**
 
 ## Configuration
 
-Cashier needs Redis to function correctly. Create a yaml file. You may call it `config/cashier.yml`
+**if you're using Rails 3, there is no configuration.** If you're using
+Rails 2, include `Cashier::ControllerHelper` into ApplicationController
+like so:
+
+    require 'cashier'
+
+    class ApplicationController
+      include Cashier::ControllerHelper
+    end
 
-    development: localhost:6379
-    test: localhost:6379/test
+## Testing
 
-Then write a simple initializer to configure Cahiser. Drop this file in in `config/initializers/cashier.rb`
+I've also included some Rspec Matchers and a cucumber helper for testing
+caching. The rspec matchers can be used like this:
 
-    resque_config = YAML.load_file(Raisl.root.join 'config', 'cashiser.yml')
-    Cashier.redis = resque_config[Rails.env]
+  describe "get index" do
+    it "should cache the action" do
+      get :index
+      'some-tag'.should be_cached
+    end
+  end
 
-Now in your `application_controller.rb` file just include the module
+Testing w/cucumber is more involved. **Make sure you set perform_caching = true in test.rb**
+Then require `cashier/cucumber` to use the matchers in your steps. Here
+is an example of a possible step
 
-    class ApplicationController < ActionController::Base
-      include Cashier::ControllerHelper
+    Then /the dashboard should be cached/ do
+      "dashboard".should be_cached
     end
 
-Now you're good to go!
+Including `cashier/cucumber` will also wipe the cache before every
+scenario.
 
 ## Contributing to Cashier
  

data/spec/application_controller_spec.rb

@@ -0,0 +1,31 @@
+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')
+  end
+
+  it "should be able write a fragment with multiple tags" do
+    Cashier.should_receive(:store_fragment).with('views/key', 'tag1', 'tag2')
+    controller.write_fragment('key', 'content', :tag => %w(tag1 tag2))
+  end
+
+  it "should able to create a tag with a proc" do
+    Cashier.should_receive(:store_fragment).with('views/key', 'tag')
+    controller.write_fragment('key', 'content', :tag => proc {|c| 'tag' })
+  end
+
+  it "should able to create a tag with a lambda" do
+    Cashier.should_receive(:store_fragment).with('views/key', 'tag')
+    controller.write_fragment('key', 'content', :tag => lambda {|c| 'tag' })
+  end
+end

data/spec/cashier_spec.rb

@@ -1,7 +1,89 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Cashier" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  subject { Cashier }
+  
+  let(:cache) { Rails.cache }
+
+  describe "#store_fragment" do
+    it "should write the tag to the cache" do
+      subject.store_fragment('fragment-key', 'dashboard')
+
+      cache.fetch('dashboard').should eql(['fragment-key'])
+    end
+
+    it "should store the tag for book keeping" do
+      subject.store_fragment('fragment-key', 'dashboard', 'settings')
+      cache.fetch(Cashier::CACHE_KEY).should eql(%w(dashboard settings))
+    end
+  end
+
+  describe "#expire" do
+    before do
+      subject.store_fragment('fragment-key', 'dashboard')
+    end
+
+    it "should remove delete the fragment key" do
+      subject.expire('dashboard')
+      Rails.cache.fetch('fragment-key').should be_nil
+    end
+
+    it "should remove the tag" do
+      subject.expire('dashboard')
+      Rails.cache.fetch('dashboard').should be_nil
+    end
+
+    it "should remove the tag from the list of tracked tags"  do
+      subject.expire('dashboard')
+      Rails.cache.fetch(Cashier::CACHE_KEY).should eql([])
+    end
+  end
+
+  describe "#tags" do
+    it "should return a list of active tags" do
+      subject.store_fragment('key1', 'dashboard')
+      subject.store_fragment('key2', 'settings')
+      subject.store_fragment('key3', 'email')
+
+      subject.tags.should eql(%w(dashboard settings email))
+    end
+  end
+
+  describe '#clear' do
+    before(:each) do
+      subject.store_fragment('key1', 'dashboard')
+      subject.store_fragment('key2', 'settings')
+      subject.store_fragment('key3', 'email')
+    end
+
+    it "should expire all tags" do
+      subject.should_receive(:expire).with('dashboard','settings','email')
+      subject.clear
+    end
+
+    it "should clear the list of tracked tags" do
+      subject.clear
+      cache.fetch(Cashier::CACHE_KEY).should be_nil
+    end
+  end
+
+  describe '#keys' do
+    it "should return an array of all the tracked keys" do
+      subject.store_fragment('key1', 'dashboard')
+      subject.store_fragment('key2', 'settings')
+      subject.store_fragment('key3', 'email')
+
+      subject.keys.should eql(%w(key1 key2 key3))
+    end
+  end
+
+  describe '#keys_for' do
+    it "should return an array of all the keys for the tag" do
+      subject.store_fragment('key1', 'dashboard')
+      subject.store_fragment('key2', 'dashboard')
+      subject.store_fragment('key3', 'dashboard')
+
+      subject.keys_for('dashboard').should eql(%w(key1 key2 key3))
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,10 +3,16 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'cashier'
 
+ENV['RAILS_ENV'] = 'test'
+require 'test_app/config/environment'
+
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
   
+  config.before(:each) do
+    Rails.cache.clear
+  end
 end

data/spec/test_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/spec/test_app/Gemfile

@@ -0,0 +1,31 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.4'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/spec/test_app/Gemfile.lock

@@ -0,0 +1,73 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.4)
+      actionpack (= 3.0.4)
+      mail (~> 2.2.15)
+    actionpack (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+    activesupport (3.0.4)
+    arel (2.0.8)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.4)
+      actionmailer (= 3.0.4)
+      actionpack (= 3.0.4)
+      activerecord (= 3.0.4)
+      activeresource (= 3.0.4)
+      activesupport (= 3.0.4)
+      bundler (~> 1.0)
+      railties (= 3.0.4)
+    railties (3.0.4)
+      actionpack (= 3.0.4)
+      activesupport (= 3.0.4)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (= 3.0.4)
+  sqlite3