cache_cow 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/.gitignore.bak

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--debugger

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.1 (2011-10-26)
+
+* support read, write, delete, fetch cache in models
+* basic spec for cached_id_list
+* convention for AR cache_keys

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in cache_cow.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+gem 'ruby-debug19', :platform => :ruby_19, :require => 'ruby-debug'
+gem 'ruby-debug',   :platform => :ruby_18

data/Gemfile.lock

@@ -0,0 +1,176 @@
+PATH
+  remote: .
+  specs:
+    cache_cow (0.0.1)
+      rails (~> 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.1)
+      actionpack (= 3.1.1)
+      mail (~> 2.3.0)
+    actionpack (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.2)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    ammeter (0.2.1)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.2)
+      rspec-rails (~> 2.2)
+    archive-tar-minitar (0.5.2)
+    arel (2.2.1)
+    builder (3.0.0)
+    capybara (1.1.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    columnize (0.3.4)
+    dalli (1.1.3)
+    database_cleaner (0.6.7)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    factory_girl (2.2.0)
+      activesupport
+    factory_girl_rails (1.3.0)
+      factory_girl (~> 2.2.0)
+      railties (>= 3.0.0)
+    ffi (1.0.9)
+    hike (1.2.1)
+    i18n (0.6.0)
+    json (1.6.1)
+    json_pure (1.6.1)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.1)
+    multi_json (1.0.3)
+    nokogiri (1.5.0)
+    polyglot (0.3.2)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.1)
+      actionmailer (= 3.1.1)
+      actionpack (= 3.1.1)
+      activerecord (= 3.1.1)
+      activeresource (= 3.1.1)
+      activesupport (= 3.1.1)
+      bundler (~> 1.0)
+      railties (= 3.1.1)
+    railties (3.1.1)
+      actionpack (= 3.1.1)
+      activesupport (= 3.1.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rbx-require-relative (0.0.5)
+    rdoc (3.11)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    rspec-rails (2.7.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.7.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.25)
+      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.5)
+      archive-tar-minitar (>= 0.5.2)
+    rubyzip (0.9.4)
+    selenium-webdriver (2.9.1)
+      childprocess (>= 0.2.1)
+      ffi (= 1.0.9)
+      json_pure
+      rubyzip
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.4)
+    steak (2.0.0)
+      capybara (>= 1.0.0)
+      rspec-rails (>= 2.5.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.30)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ammeter
+  cache_cow!
+  capybara
+  dalli
+  database_cleaner
+  factory_girl_rails
+  rspec
+  rspec-rails
+  ruby-debug
+  ruby-debug19
+  sqlite3
+  steak

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,48 @@
+# CacheCow
+
+CacheCow allows ActiveRecord models to `acts_as_cached``
+
+
+## Install
+
+In your Gemfile
+
+    gem "cache_cow"
+
+Or via command line
+
+    gem install cache_cow
+
+
+## Overview
+
+CacheCow provides an api for caching results of methods and associations on ActiveRecord models.
+
+To use in a model, declare `acts_as_cached`
+
+``` ruby
+
+    class Post
+      acts_as_cached
+    end
+
+```
+
+Instances of a cache_cow model can read, write, fetch, and expire their own cache keys. Cache keys
+are namespaced and versioned by convention as <class_name>:<version>:<id>:<cache_suffix>. An instances
+id is the cache suffix be default.
+
+``` ruby
+
+    # Post.cache_cow_version = 1
+
+    post = Post.find(123)
+
+    post.fetch_cache { "great post" }     # fetches from cache key 'Post:1:123', store 'great post' on cache miss
+
+    post.write_cache("foo", "bar")        # writes 'bar to cache key 'Post:1:123:foo'
+
+    post.read_cache("foo")                # returns 'bar' from cache key 'Post:1:123:foo'
+
+````
+

data/Rakefile

@@ -0,0 +1,54 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Seymour'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path(".././spec/dummy/Rakefile", __FILE__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+desc "Run the specs"
+task :default => ["spec"]
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/cache_cow.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cache_cow/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cache_cow"
+  s.version     = CacheCow::VERSION
+  s.authors     = ["Ross Kaffenberger"]
+  s.email       = ["rosskaff@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Allows ActiveRecord models to "acts_as_cached"}
+  s.description = %q{CacheCow provides an api for caching results of methods and associations on ActiveRecord models.}
+
+  s.rubyforge_project = "cache_cow"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", "~> 3.0"
+
+  s.add_development_dependency "dalli"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency 'steak'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'ammeter'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl_rails'
+  s.add_development_dependency "sqlite3"
+end

data/lib/cache_cow.rb

@@ -0,0 +1,8 @@
+require "cache_cow/version"
+require "cache_cow/cacheable"
+require "cache_cow/cached_id_list"
+require "cache_cow/acts_as_cached"
+
+module CacheCow
+  # Your code goes here...
+end

data/lib/cache_cow/acts_as_cached.rb

@@ -0,0 +1,172 @@
+module CacheCow
+  module ActsAsCached
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def acts_as_cached
+        include Cacheable
+        include CachedIdList
+      end
+
+      def acts_as_cached_options
+        @acts_as_cached_options ||= {}
+      end
+
+      def acts_as_cached_version
+        acts_as_cached_options[:version] || 1
+      end
+
+    end
+  end
+end
+
+
+class ActiveRecord::Base
+  include CacheCow::ActsAsCached
+end
+
+# ActiveRecord::Base.send :include, CacheCow::ActsAsCached
+
+# def self.included(base)
+#   base.extend ClassMethods
+# end
+#
+# module ClassMethods
+#   @@nil_sentinel = :_nil
+#
+#   def self.extended(a_class)
+#     class << a_class
+#       alias_method_chain :inherited, :acts_as_cached
+#     end
+#   end
+#
+#   def inherited_with_acts_as_cached(subclass)
+#     inherited_without_acts_as_cached(subclass)
+#     subclass.acts_as_cached acts_as_cached_options
+#   end
+#
+#   def acts_as_cached(options = {})
+#     @acts_as_cached_options = options
+#   end
+#
+#   def acts_as_cached_options
+#     @acts_as_cached_options ||= {}
+#   end
+#
+#   def acts_as_cached_version
+#     acts_as_cached_options[:version] || 1
+#   end
+#
+#   def cached(method, options = {})
+#     fetch_cache(method, options) { send(method) }
+#   end
+#
+#   def fetch_cache(*args, &block)
+#     options = args.last.is_a?(Hash) ? args.pop : {}
+#     keys    = args.flatten
+#
+#     raise "Doesn't support multiget" unless keys.size == 1
+#
+#     if (value = Rails.cache.read(cache_key(keys.first), options))
+#       value == @@nil_sentinel ? nil : value
+#     else
+#       value = fetch_cachable_data(keys.first, &block)
+#       value_to_cache = value.nil? ? @@nil_sentinel : value
+#       Rails.cache.write(cache_key(keys.first), value_to_cache, options)
+#       return value
+#     end
+#   end
+#
+#   def get_multi(cache_ids, &block)
+#     cache_keys = cache_ids.map { |cache_id| cache_key(cache_id) }
+#     cache_hits = Rails.cache.read_multi(*cache_keys)
+#     yield MultigetContext.new(self, cache_hits)
+#   end
+#
+#   def fetch_cachable_data(cache_id = nil, &block)
+#     if block_given?
+#       yield(cache_id)
+#     else
+#       find(cache_id)
+#     end
+#   end
+#
+#   def cached?(cache_id = nil)
+#     read_cache(cache_id).nil? ? false : true
+#   end
+#
+#   def read_cache(cache_id = nil)
+#     Rails.cache.read(cache_key(cache_id))
+#   end
+#
+#   def set_cache(cache_id, value, ttl = nil)
+#     returning(value) do |v|
+#       v = @@nil_sentinel if v.nil?
+#       Rails.cache.write(cache_key(cache_id), v, :expires_in => (ttl || 1500))
+#     end
+#   end
+#
+#   def expire_cache(cache_id = nil)
+#     Rails.cache.delete cache_key(cache_id)
+#     true
+#   end
+#
+#   def cache_name
+#     @cache_name ||= respond_to?(:base_class) ? base_class.name : name
+#   end
+#
+#   def max_key_length
+#     200
+#   end
+#
+#   def cache_key(cache_id)
+#     [cache_name, acts_as_cached_version, cache_id].compact.join(':').gsub(' ', '_')[0..(max_key_length - 1)]
+#   end
+#
+#   private
+#
+#   NIL_SENTINEL = @@nil_sentinel
+#
+#   class MultigetContext
+#     def initialize(klass, cache_hits)
+#       @klass = klass
+#       @cache_hits = cache_hits
+#     end
+#
+#     def fetch_cache(*args, &block)
+#       args_temp = args.dup
+#       options   = args_temp.last.is_a?(Hash) ? args.pop  : {}
+#       keys      = args_temp.flatten
+#       if value = @cache_hits[@klass.cache_key(keys.first)]
+#         value == NIL_SENTINEL ? nil : value
+#       else
+#         @klass.fetch_cache(args, options, &block)
+#       end
+#     end
+#   end
+# end
+#
+# def fetch_cache(key = nil, options = {}, &block)
+#   self.class.fetch_cache(cache_id(key), options, &block)
+# end
+#
+# def cached(method, options = {})
+#   self.class.fetch_cache(cache_id(method), options) { send(method) }
+# end
+#
+# def cached?(key = nil)
+#   self.class.cached? cache_id(key)
+# end
+#
+# def read_cache(key = nil)
+#   self.class.read_cache cache_id(key)
+# end
+#
+# def expire_cache(key = nil)
+#   self.class.expire_cache(cache_id(key))
+# end
+#
+# def cache_id(key = nil)
+#   key.nil? ? id.to_s : "#{id}:#{key}"
+# end