will_cache 0.0.1

data/README.md

@@ -0,0 +1,30 @@
+WillCache
+=========
+
+WillCache provides simple API for caching ActiveRecord objects that uses ActiveSupport Cache Store internally so that it's trivial to switch cache storage. WillCache API is heavily inspired by excellent but no longer maintained [cache_fu plugin](https://github.com/defunkt/cache_fu) and one of the goals of the gem is to provide drop-in replacement for it.
+
+
+## Example usage
+
+    >> User.last.cached(:profile)
+      User Load (0.000581) (1 Row)   SELECT * FROM `users` ORDER BY users.id DESC LIMIT 1
+      Cache miss: users:65:profile
+      Profile Load (0.000454) (1 Row)   SELECT * FROM `profiles` WHERE (`profiles`.user_id = 65) LIMIT 1
+      Cache write (will save 1.64ms): users:65:profile
+    => #<Profile id: 65, first_name: nil, last_name: nil, ...>
+
+Example shows [inline log in Rails console](http://rors.org/2011/07/17/inline-logging-in-rails-console.html). 
+
+
+## Install
+
+Specify the gem in Gemfile of the project
+
+    gem "will_cache"
+
+
+## Credits
+
+Author: [Dejan Simic](http://github.com/dejan)<br/>
+
+Initial development of the gem was sponsored by [LessEverything](http://lesseverything.com)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+desc 'Default: run tests'
+task :default => :test
+
+desc 'Test WillCache'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+end

data/lib/will_cache/cacheable.rb

@@ -0,0 +1,39 @@
+module WillCache
+  module Cacheable
+    def expire_cache(method_name, args = {})
+      with = args[:with]
+      Rails.cache.delete(method_cache_key(method_name, with))
+    end
+
+    def cached(method_name, args = {})
+      with = args[:with]
+      Rails.cache.fetch(method_cache_key(method_name, with)) {
+        do_send(method_name, with)
+      }
+    end
+
+    def do_send(method_name, with)
+      if with.blank?
+        send(method_name)
+      else
+        send(method_name, with)
+      end
+    end
+
+    def method_cache_key(method_name, with)
+      if self.is_a?(ActiveRecord::Base)
+        base = "#{self.class}:#{id}:#{method_name}"
+      else
+        base = "#{self}:#{method_name}"
+      end
+      if with.blank?
+        base
+      else
+        "#{base}(#{with.inspect})"
+      end
+    end
+  end
+end
+
+
+

data/lib/will_cache.rb

@@ -0,0 +1,20 @@
+require File.expand_path("../will_cache/cacheable", __FILE__)
+
+module WillCache
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    include Cacheable
+    def acts_as_cached
+      send :include, InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+    include Cacheable
+  end
+end
+
+ActiveRecord::Base.send :include, WillCache

data/test/fixtures/database.yml

@@ -0,0 +1,5 @@
+sqlite3:
+  adapter: sqlite3
+  database: test.sqlite3
+  pool: 5
+  timeout: 5000

data/test/fixtures/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define do
+  create_table "articles", :force => true do |t|
+    t.column "title",         :string
+    t.column "body",          :text
+    t.column "user_id",       :integer
+    t.column "created_at",    :datetime
+    t.column "updated_at",    :datetime
+  end
+
+  create_table "users", :force => true do |t|
+    t.column "name",         :string
+    t.column "bio",          :text
+  end
+end

data/test/functional/will_cache_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class Rails
+  def self.cache
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :articles
+  acts_as_cached
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :user
+  acts_as_cached
+end
+
+class WillCacheTest < Test::Unit::TestCase
+  def setup
+    fixtures_dir = File.dirname(__FILE__) + '/../fixtures'
+    connections = YAML.load_file("#{fixtures_dir}/database.yml")
+    ActiveRecord::Base.establish_connection(connections['sqlite3'])
+    ActiveRecord::Migration.verbose = false
+    load "#{fixtures_dir}/schema.rb"
+    
+    @user = User.create!
+    @user.articles << Article.new(:body => 'hey')
+  end
+
+  def test_cached_on_class_method
+    mock(Rails.cache).fetch("User:count") { 1 }
+    assert_equal 1, User.cached(:count)
+  end
+
+  def test_cached_on_instance_method
+    mock(Rails.cache).fetch("User:1:articles") { @user.articles }
+    assert_equal @user.articles, @user.cached(:articles)
+  end
+
+  def test_expire_cache
+    mock(Rails.cache).delete("User:1:articles")
+    @user.expire_cache(:articles)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rr'
+
+rails_version = ENV['RAILS_VERSION']
+if rails_version
+  gem "activerecord", rails_version
+  gem "actionpack", rails_version
+end
+
+require 'test/unit'
+require 'active_record'
+require 'active_support/core_ext/class'
+
+require File.dirname(__FILE__) + '/../init'
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: will_cache
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dejan Simic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-18 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: WillCache provides simple API for caching ActiveRecord objects that uses ActiveSupport Cache Store internally so that it's trivial to switch cache storage. WillCache API is heavily inspired by excellent but no longer maintained cache_fu plugin and one of the goals of the gem is to provide drop-in replacement for it.
+email: desimic@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/will_cache/cacheable.rb
+- lib/will_cache.rb
+- test/fixtures/database.yml
+- test/fixtures/schema.rb
+- test/functional/will_cache_test.rb
+- test/test_helper.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/dejan/will_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Drop-in replacement for cache_fu that uses Rails.cache store
+test_files: []
+