simple_cacheable 1.0.0 → 1.1.0

data/README.md

@@ -6,6 +6,11 @@ extracted from [rails-bestpractices.com][1].
 
 it supports activerecord >= 3.0.0
 
+Introduction
+------------
+
+Here is a blog post to introduce simple_cacheable gem, <http://rails-bestpractices.com/blog/posts/24-simple_cacheable>
+
 Usage
 -----
 
@@ -13,11 +18,13 @@ Usage
       include Cacheable
 
       has_many :posts
+      has_one :account
 
       model_cache do
-        with_key                   # User.find_cached(1)
-        with_attribute :login      # User.find_by_login('flyerhzm')
-        with_method :last_post     # user.cached_last_post
+        with_key                          # User.find_cached(1)
+        with_attribute :login             # User.find_cached_by_login('flyerhzm')
+        with_method :last_post            # user.cached_last_post
+        with_association :posts, :account # user.cached_posts, user.cached_account
       end
 
       def last_post
@@ -25,6 +32,10 @@ Usage
       end
     end
 
+    class Account < ActiveRecord::Base
+      belongs_to :user
+    end
+
     class Post < ActiveRecord::Base
       include Cacheable
 
@@ -32,8 +43,8 @@ Usage
       has_many :comments, :as => :commentable
 
       model_cache do
-        with_key                   # post.find_cached(1)
-        with_association :user     # post.cached_user
+        with_key                          # post.find_cached(1)
+        with_association :user, :comments # post.cached_user, post.cached_comments
       end
     end
 
@@ -47,5 +58,15 @@ Usage
       end
     end
 
+Install
+-------
+
+add the following code to your Gemfile
+
+    gem "simple_cacheable", :require => "cacheable"
+
+
+Copyright © 2011 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+
 
 [1]:https://github.com/flyerhzm/rails-bestpractices.com

data/Rakefile

@@ -1,2 +1,4 @@
 require 'bundler'
+
+include Rake::DSL
 Bundler::GemHelper.install_tasks

data/lib/cacheable/version.rb

@@ -1,3 +1,3 @@
 module Cacheable
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/cacheable.rb

@@ -63,7 +63,31 @@ module Cacheable
               polymorphic = association.options[:polymorphic]
               class_eval <<-EOF
                 def cached_#{association_name}
-                  Rails.cache.fetch association_cache_key("#{association_name}", #{polymorphic}) do
+                  Rails.cache.fetch belong_association_cache_key("#{association_name}", #{polymorphic}) do
+                    #{association_name}
+                  end
+                end
+              EOF
+            else
+              reverse_association = association.klass.reflect_on_all_associations(:belongs_to).find { |reverse_association|
+                reverse_association.options[:polymorphic] ? reverse_association.name == association.options[:as] : reverse_association.klass == self
+              }
+              association.klass.class_eval <<-EOF
+                after_save :expire_#{association_name}_cache
+                after_destroy :expire_#{association_name}_cache
+
+                def expire_#{association_name}_cache
+                  if respond_to? :cached_#{reverse_association.name}
+                    cached_#{reverse_association.name}.expire_association_cache(:#{association_name})
+                  else
+                    #{reverse_association.name}.expire_association_cache(:#{association_name})
+                  end
+                end
+              EOF
+
+              class_eval <<-EOF
+                def cached_#{association_name}
+                  Rails.cache.fetch have_association_cache_key("#{association_name}") do
                     #{association_name}
                   end
                 end
@@ -107,6 +131,10 @@ module Cacheable
     end
   end
 
+  def expire_association_cache(name)
+    Rails.cache.delete have_association_cache_key(name)
+  end
+
   def model_cache_key
     "#{self.class.name.tableize}/#{self.id.to_i}"
   end
@@ -115,11 +143,15 @@ module Cacheable
     "#{model_cache_key}/method/#{meth}"
   end
 
-  def association_cache_key(name, polymorphic=nil)
+  def belong_association_cache_key(name, polymorphic=nil)
     if polymorphic
       "#{self.send("#{name}_type").tableize}/#{self.send("#{name}_id")}"
     else
       "#{name.tableize}/#{self.send(name + "_id")}"
     end
   end
+
+  def have_association_cache_key(name)
+    "#{model_cache_key}/association/#{name}"
+  end
 end

data/spec/cacheable_spec.rb

@@ -5,13 +5,14 @@ describe Cacheable do
 
   before :all do
     @user = User.create(:login => 'flyerhzm')
+    @account = @user.create_account
     @post1 = @user.posts.create(:title => 'post1')
     @post2 = @user.posts.create(:title => 'post2')
     @comment1 = @post1.comments.create
-    @comment2 = @post2.comments.create
+    @comment2 = @post1.comments.create
   end
 
-  after :each do
+  before :each do
     cache.clear
   end
 
@@ -64,24 +65,74 @@ describe Cacheable do
   end
 
   context "with_association" do
-    it "should not cache association" do
-      cache.data["users/#{@user.id}"].should be_nil
-    end
-
-    it "should cache Post#user" do
-      @post1.cached_user.should == @user
-      cache.data["users/#{@user.id}"].should == @user
-    end
-
-    it "should cache Post#user multiple times" do
-      @post1.cached_user
-      @post1.cached_user.should == @user
-    end
-
-    it "should cache Comment#commentable with polymorphic" do
-      cache.data["posts/#{@post1.id}"].should be_nil
-      @comment1.cached_commentable.should == @post1
-      cache.data["posts/#{@post1.id}"].should == @post1
+    context "belongs_to" do
+      it "should not cache association" do
+        cache.data["users/#{@user.id}"].should be_nil
+      end
+
+      it "should cache Post#user" do
+        @post1.cached_user.should == @user
+        cache.data["users/#{@user.id}"].should == @user
+      end
+
+      it "should cache Post#user multiple times" do
+        @post1.cached_user
+        @post1.cached_user.should == @user
+      end
+
+      it "should cache Comment#commentable with polymorphic" do
+        cache.data["posts/#{@post1.id}"].should be_nil
+        @comment1.cached_commentable.should == @post1
+        cache.data["posts/#{@post1.id}"].should == @post1
+      end
+    end
+
+    context "has_many" do
+      it "should not cache associations" do
+        cache.data["users/#{@user.id}/association/posts"].should be_nil
+      end
+
+      it "should cache User#posts" do
+        @user.cached_posts.should == [@post1, @post2]
+        cache.data["users/#{@user.id}/association/posts"].should == [@post1, @post2]
+      end
+
+      it "should cache User#posts multiple times" do
+        @user.cached_posts
+        @user.cached_posts.should == [@post1, @post2]
+      end
+    end
+
+    context "has_many with polymorphic" do
+      it "should not cache associations" do
+        cache.data["posts/#{@post1.id}/association/comments"].should be_nil
+      end
+
+      it "should cache Post#comments" do
+        @post1.cached_comments.should == [@comment1, @comment2]
+        cache.data["posts/#{@post1.id}/association/comments"].should == [@comment1, @comment2]
+      end
+
+      it "should cache Post#comments multiple times" do
+        @post1.cached_comments
+        @post1.cached_comments.should == [@comment1, @comment2]
+      end
+    end
+
+    context "has_one" do
+      it "should not cache associations" do
+        cache.data["users/#{@user.id}/association/account"].should be_nil
+      end
+
+      it "should cache User#posts" do
+        @user.cached_account.should == @account
+        cache.data["users/#{@user.id}/association/account"].should == @account
+      end
+
+      it "should cache User#posts multiple times" do
+        @user.cached_account
+        @user.cached_account.should == @account
+      end
     end
   end
 
@@ -106,5 +157,26 @@ describe Cacheable do
       @user.expire_model_cache
       cache.data["users/#{@user.id}/method/last_post"].should be_nil
     end
+
+    it "should delete has_many with_association cache" do
+      @user.cached_posts
+      cache.data["users/#{@user.id}/association/posts"].should_not be_nil
+      @post1.save
+      cache.data["users/#{@user.id}/association/posts"].should be_nil
+    end
+
+    it "should delete has_many with polymorphic with_association cache" do
+      @post1.cached_comments
+      cache.data["posts/#{@post1.id}/association/comments"].should_not be_nil
+      @comment1.save
+      cache.data["posts/#{@post1.id}/association/comments"].should be_nil
+    end
+
+    it "should delete has_one with_association cache" do
+      @user.cached_account
+      cache.data["users/#{@user.id}/association/account"].should_not be_nil
+      @account.save
+      cache.data["users/#{@user.id}/association/account"].should be_nil
+    end
   end
 end

data/spec/models/account.rb

@@ -0,0 +1,3 @@
+class Account < ActiveRecord::Base
+  belongs_to :user
+end

data/spec/models/post.rb

@@ -6,6 +6,6 @@ class Post < ActiveRecord::Base
 
   model_cache do
     with_key
-    with_association :user
+    with_association :user, :comments
   end
 end

data/spec/models/user.rb

@@ -2,11 +2,13 @@ class User < ActiveRecord::Base
   include Cacheable
 
   has_many :posts
+  has_one :account
 
   model_cache do
     with_key
     with_attribute :login
     with_method :last_post
+    with_association :posts, :account
   end
 
   def last_post

data/spec/spec_helper.rb

@@ -65,6 +65,10 @@ RSpec.configure do |config|
         t.string :login
       end
 
+      create_table :accounts do |t|
+        t.integer :user_id
+      end
+
       create_table :posts do |t|
         t.integer :user_id
         t.string :title

metadata

@@ -2,7 +2,7 @@
 name: simple_cacheable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-05 00:00:00 +08:00
+date: 2011-10-06 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,6 +77,7 @@ files:
 - lib/cacheable.rb
 - lib/cacheable/version.rb
 - spec/cacheable_spec.rb
+- spec/models/account.rb
 - spec/models/comment.rb
 - spec/models/post.rb
 - spec/models/user.rb
@@ -111,6 +112,7 @@ specification_version: 3
 summary: a simple cache implementation based on activerecord
 test_files: 
 - spec/cacheable_spec.rb
+- spec/models/account.rb
 - spec/models/comment.rb
 - spec/models/post.rb
 - spec/models/user.rb