cashier 0.2.0 → 0.4.0

data/..gemspec

@@ -1,21 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "./version"
-
-Gem::Specification.new do |s|
-  s.name        = "."
-  s.version     = .::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["TODO: Write your name"]
-  s.email       = ["TODO: Write your email address"]
-  s.homepage    = ""
-  s.summary     = %q{TODO: Write a gem summary}
-  s.description = %q{TODO: Write a gem description}
-
-  s.rubyforge_project = "."
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-end

data/.infinity_test

@@ -1,19 +0,0 @@
-infinity_test do
-  notifications :growl
-
-  use  :test_framework => :rspec
-
-  before_run do
-    clear :terminal
-  end
-
-  heuristics do
-    add('lib/(.+)\.rb') do |file|
-      run :all => :tests
-    end
-    
-    add('rails_app') do |file|
-      run :all => :tests
-    end
-  end
-end

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.2@cashier

data/Gemfile.lock

@@ -1,118 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cashier (0.2.0)
-
-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)
-    archive-tar-minitar (0.5.2)
-    arel (2.0.8)
-    builder (2.1.2)
-    columnize (0.3.2)
-    diff-lcs (1.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    i18n (0.5.0)
-    infinity_test (1.0.2)
-      notifiers (>= 1.1.0)
-      watchr (>= 0.7)
-    linecache19 (0.5.11)
-      ruby_core_source (>= 0.1.4)
-    mail (2.2.15)
-      activesupport (>= 2.3.6)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    memcache-client (1.8.5)
-    mime-types (1.16)
-    notifiers (1.1.0)
-    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)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    rspec-rails (2.5.0)
-      actionpack (~> 3.0)
-      activesupport (~> 3.0)
-      railties (~> 3.0)
-      rspec (~> 2.5.0)
-    ruby-debug-base19 (0.11.24)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.4)
-      archive-tar-minitar (>= 0.5.2)
-    sqlite3 (1.3.3)
-    thor (0.14.6)
-    treetop (1.4.9)
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.24)
-    watchr (0.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  cashier!
-  infinity_test
-  memcache-client
-  rails
-  rspec
-  rspec-rails
-  ruby-debug19
-  sqlite3

data/lib/cashier/controller_helper.rb

@@ -1,34 +0,0 @@
-# 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.
-
-module Cashier
-  module ControllerHelper
-    def self.included(klass)
-      klass.class_eval do
-        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
-    end
-  end
-end  

data/readme.md

@@ -1,120 +0,0 @@
-# Cashier: Tag Based Caching for Rails
-
-Manage your cache keys with tags, forget about keys!
-
-## What Is It?
-
-    # 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 an observer
-    Cashier.expire 'some-component' # don't worry about keys! Much easier to sweep with confidence
-
-    # in your controller
-    caches_action :tag => 'complicated-action', :cache_path => proc { |c| 
-      # huge complicated mess of parameters
-      c.params
-    }
-
-    # need to access the controller?
-    caches_action :tag => proc {|c|
-      # c is the controller
-      "users/#{c.current_user.id}/dashboard"      
-    }
-
-    # in your sweeper, in your observers, in your resque jobs...wherever
-    Cashier.expire 'complicated-action'
-    Cashier.expire 'tag1', 'tag2', 'tag3', 'tag4'
-
-    # what's cached
-    Cashier.tags
-
-    # sweep all stored keys
-    Cashier.clear
-
-## How it Came About
-
-I work on an application that involves all sorts of caching. I try to use action caching whenever I possible.
-I had an index action that had maybe ~20 different combination of filters and sorting. If you want to use
-action caching you have to create a **unique** key for every combination. This created a nice 6 nested loop
-to expire the cache. Once you had pagination, then you have even more combinations of possible cache keys.
-I needed a better solution. I wanted to expire things logically as a viewed them on the page. IE, if 
-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 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.
-
-## 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 in the rails cache. **No external processes are
-needed. All tag/fragment information is stored in the Rails.cache.**
-
-## Configuration
-
-**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
-
-## Testing
-
-I've also included some Rspec Matchers and a cucumber helper for testing
-caching. The rspec matchers can be used like this:
-
-  describe "get index" do
-    it "should cache the action" do
-      get :index
-      'some-tag'.should be_cached
-    end
-  end
-
-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
-
-    Then /the dashboard should be cached/ do
-      "dashboard".should be_cached
-    end
-
-Including `cashier/cucumber` will also wipe the cache before every
-scenario.
-
-## Contributing to Cashier
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-## Copyright
-
-Copyright (c) 2010 Adam Hawkins. See LICENSE.txt for
-further details.
-

data/spec/cashier_spec.rb

@@ -1,89 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Cashier" do
-  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/test_app/Gemfile.lock

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