simple_cacheable 1.3.1 → 1.3.2

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
   - 1.9.3
-  - jruby-19mode
 env: DB=sqlite
 service:
   - memcached

data/Gemfile

@@ -13,3 +13,5 @@ platforms :jruby do
   gem "activerecord-jdbcsqlite3-adapter"
   gem "jruby-memcached"
 end
+
+gem "debugger"

data/README.md

@@ -43,8 +43,13 @@ Usage
       has_many :comments, :as => :commentable
 
       model_cache do
-        with_key                          # post.find_cached(1)
-        with_association :user, :comments # post.cached_user, post.cached_comments
+        with_key                                # post.find_cached(1)
+        with_class_method  :default_post        # Post.default_post
+        with_association   :user, :comments     # post.cached_user, post.cached_comments
+      end
+
+      def self.default_post
+        Post.first
       end
     end
 
@@ -66,7 +71,15 @@ add the following code to your Gemfile
     gem "simple_cacheable", :require => "cacheable"
 
 
+Gotchas
+-------
+
+Caching, and caching invalidation specifically, can be hard and confusing.  Simple Cacheable methods should
+expire correctly in most cases.  Be careful using `with_method` and `with_class_method`, they should
+specifically not be used to return collections.  This is demonstrated well Tobias Lutke's presentation: [Rockstar Memcaching][2].
+
 Copyright © 2011 Richard Huang (flyerhzm@gmail.com), released under the MIT license
 
 
 [1]:https://github.com/flyerhzm/rails-bestpractices.com
+[2]:http://www.infoq.com/presentations/lutke-rockstar-memcaching

data/cacheable.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "simple_cacheable"
   s.version     = Cacheable::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Richard Huang"]
-  s.email       = ["flyerhzm@gmail.com"]
+  s.authors     = ["Richard Huang", "Scott Carleton"]
+  s.email       = ["flyerhzm@gmail.com", "scott@artsicle.com"]
   s.homepage    = "https://github.com/flyerhzm/simple-cacheable"
   s.summary     = %q{a simple cache implementation based on activerecord}
   s.description = %q{a simple cache implementation based on activerecord}

data/lib/cacheable/version.rb

@@ -1,3 +1,3 @@
 module Cacheable
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/lib/cacheable.rb

@@ -3,9 +3,13 @@ require 'uri'
 module Cacheable
   def self.included(base)
     base.class_eval do
-      class <<self
+      class << self
         def model_cache(&block)
-          class_attribute :cached_key, :cached_indices, :cached_methods
+          class_attribute :cached_key,
+                          :cached_indices,
+                          :cached_methods,
+                          :cached_class_methods,
+                          :cached_associations
           instance_exec &block
         end
 
@@ -70,9 +74,33 @@ module Cacheable
           end
         end
 
+        # Cached class method
+        # Should expire on any instance save
+        def with_class_method(*methods)
+          self.cached_class_methods = methods
+
+          class_eval <<-EOF
+            after_commit :expire_class_method_cache, on: :update
+          EOF
+
+          methods.each do |meth|
+            class_eval <<-EOF
+              def self.cached_#{meth}
+                Rails.cache.fetch class_method_cache_key("#{meth}") do
+                  #{meth}
+                end
+              end
+            EOF
+          end
+
+        end
+
         def with_association(*association_names)
+          self.cached_associations = association_names
+
           association_names.each do |association_name|
             association = reflect_on_association(association_name)
+
             if :belongs_to == association.macro
               polymorphic = association.options[:polymorphic]
               polymorphic ||= false
@@ -90,32 +118,55 @@ module Cacheable
                 # FIXME it should be the only reflection but I'm not 100% positive
                 reverse_through_association = through_association.klass.reflect_on_all_associations(:belongs_to).first
 
+                # In a through association it doesn't have to be a belongs_to
                 reverse_association = association.klass.reflect_on_all_associations(:belongs_to).find { |reverse_association|
                   reverse_association.options[:polymorphic] ? reverse_association.name == association.source_reflection.options[:as] : reverse_association.klass == self
                 }
 
-                association.klass.class_eval <<-EOF
-                  after_commit :expire_#{association_name}_cache
+                if reverse_association
+                  association.klass.class_eval <<-EOF
+                    after_commit :expire_#{association_name}_cache
 
-                  def expire_#{association_name}_cache
-                    if respond_to? :cached_#{reverse_association.name}
-                      # cached_viewable.expire_association_cache
-                      cached_#{reverse_association.name}.expire_association_cache(:#{association_name})
-                    else
-                      #{reverse_association.name}.#{reverse_through_association.name}.expire_association_cache(:#{association_name})
+                    def expire_#{association_name}_cache
+                      if respond_to? :cached_#{reverse_association.name}
+                        # cached_viewable.expire_association_cache
+                        cached_#{reverse_association.name}.expire_association_cache(:#{association_name})
+                      else
+                        #{reverse_association.name}.#{reverse_through_association.name}.expire_association_cache(:#{association_name})
+                      end
                     end
-                  end
-                EOF
+                  EOF
+                end
+              elsif :has_and_belongs_to_many == association.macro
+                  # No such thing as a polymorphic has_and_belongs_to_many
+                  reverse_association = association.klass.reflect_on_all_associations(:has_and_belongs_to_many).find { |reverse_association|
+                    reverse_association.klass == self
+                  }
+
+                  association.klass.class_eval <<-EOF
+                    after_commit :expire_#{association_name}_cache
+
+                    def expire_#{association_name}_cache
+                      if respond_to? :cached_#{reverse_association.name}
+                        # cached_viewable.expire_association_cache
+                        cached_#{reverse_association.name}.expire_association_cache(:#{association_name})
+                      else
+                        #{reverse_association.name}.each do |assoc|
+                          assoc.expire_association_cache(:#{association_name})
+                        end
+                      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_commit :expire_#{association_name}_cache
 
                   def expire_#{association_name}_cache
                     if respond_to? :cached_#{reverse_association.name}
-                      # cached_viewable.expire_association_cache
                       cached_#{reverse_association.name}.expire_association_cache(:#{association_name})
                     else
                       #{reverse_association.name}.expire_association_cache(:#{association_name})
@@ -123,7 +174,6 @@ module Cacheable
                   end
                 EOF
               end
-
               class_eval <<-EOF
                 def cached_#{association_name}
                   Rails.cache.fetch have_association_cache_key("#{association_name}") do
@@ -142,8 +192,15 @@ module Cacheable
         def all_attribute_cache_key(attribute, value)
           "#{name.tableize}/attribute/#{attribute}/all/#{URI.escape(value.to_s)}"
         end
+
+        def class_method_cache_key(meth)
+          "#{name.tableize}/class_method/#{meth}"
+        end
+
       end
+
     end
+
   end
 
   def expire_model_cache
@@ -151,6 +208,13 @@ module Cacheable
     expire_attribute_cache if self.class.cached_indices.present?
     expire_all_attribute_cache if self.class.cached_indices.present?
     expire_method_cache if self.class.cached_methods.present?
+    expire_class_method_cache if self.class.cached_class_methods.present?
+
+    if self.class.cached_associations.present?
+      self.class.cached_associations.each do |assoc|
+        expire_association_cache(assoc)
+      end
+    end
   end
 
   def expire_key_cache
@@ -177,6 +241,12 @@ module Cacheable
     end
   end
 
+  def expire_class_method_cache
+    self.class.cached_class_methods.each do |meth|
+      Rails.cache.delete self.class.class_method_cache_key(meth)
+    end
+  end
+
   def expire_association_cache(name)
     Rails.cache.delete have_association_cache_key(name)
   end

data/spec/cacheable_spec.rb

@@ -5,13 +5,16 @@ describe Cacheable do
 
   before :all do
     @user = User.create(:login => 'flyerhzm')
-    @account = @user.create_account
+    @group1 = Group.create(name: "Ruby On Rails")
+    @account = @user.create_account(group: @group1)
     @post1 = @user.posts.create(:title => 'post1')
     @post2 = @user.posts.create(:title => 'post2')
     @image1 = @post1.images.create
     @image2 = @post1.images.create
     @comment1 = @post1.comments.create
     @comment2 = @post1.comments.create
+    @tag1 = @post1.tags.create(title: "Rails")
+    @tag2 = @post1.tags.create(title: "Caching")
   end
 
   before :each do
@@ -94,6 +97,22 @@ describe Cacheable do
     end
   end
 
+  context "with_class_method" do
+    it "should not cache Post.default_post" do
+      Rails.cache.read("posts/class_method/default_post").should be_nil
+    end
+
+    it "should cache Post.default_post" do
+      Post.cached_default_post.should == @post1
+      Rails.cache.read("posts/class_method/default_post").should == @post1
+    end
+
+    it "should cache Post.default_post multiple times" do
+      Post.cached_default_post
+      Post.cached_default_post.should == @post1
+    end
+  end
+
   context "with_association" do
     context "belongs_to" do
       it "should not cache association" do
@@ -190,6 +209,49 @@ describe Cacheable do
       end
     end
 
+    context "has_one through belongs_to" do
+      it "should not cache associations" do
+        Rails.cache.read("users/#{@user.id}/association/group").should be_nil
+      end
+
+      it "should cache User#group" do
+        @user.cached_group.should == @group1
+        Rails.cache.read("users/#{@user.id}/association/group").should == @group1
+      end
+
+      it "should cache User#group multiple times" do
+        @user.cached_group
+        @user.cached_group.should == @group1
+      end
+
+    end
+
+    context "has_and_belongs_to_many" do
+
+      it "should not cache associations off the bat" do
+        Rails.cache.read("posts/#{@post1.id}/association/tags").should be_nil
+      end
+
+      it "should cache Post#tags" do
+        @post1.cached_tags.should == [@tag1, @tag2]
+        Rails.cache.read("posts/#{@post1.id}/association/tags").should == [@tag1, @tag2]
+      end
+
+      it "should handle multiple requests" do
+        @post1.cached_tags
+        @post1.cached_tags.should == [@tag1, @tag2]
+      end
+
+      context "expiry" do
+        it "should have the correct collection" do
+          @tag3 = @post1.tags.create!(title: "Invalidation is hard")
+          Rails.cache.read("posts/#{@post1.id}/association/tags").should be_nil
+          @post1.cached_tags.should == [@tag1, @tag2, @tag3]
+          Rails.cache.read("posts/#{@post1.id}/association/tags").should == [@tag1, @tag2, @tag3]
+        end
+      end
+    end
+
   end
 
   context "expire_model_cache" do
@@ -214,6 +276,23 @@ describe Cacheable do
       Rails.cache.read("users/#{@user.id}/method/last_post").should be_nil
     end
 
+    it "should delete with_class_method cache" do
+      Post.cached_default_post
+      Rails.cache.read("posts/class_method/default_post").should_not be_nil
+      @post1.expire_model_cache
+      Rails.cache.read("posts/class_method/default_post").should be_nil
+    end
+
+    it "should delete associations cache" do
+      @user.cached_images
+      Rails.cache.read("users/#{@user.id}/association/images").should_not be_nil
+      @user.expire_model_cache
+      Rails.cache.read("users/#{@user.id}/association/images").should be_nil
+    end
+
+  end
+
+  context "object#save" do
     it "should delete has_many with_association cache" do
       @user.cached_posts
       Rails.cache.read("users/#{@user.id}/association/posts").should_not be_nil
@@ -241,5 +320,19 @@ describe Cacheable do
       @account.save
       Rails.cache.read("users/#{@user.id}/association/account").should be_nil
     end
+
+    it "should delete has_and_belongs_to_many with_association cache" do
+      @post1.cached_tags
+      Rails.cache.read("posts/#{@post1.id}/association/tags").should_not be_nil
+      @tag1.save
+      Rails.cache.read("posts/#{@post1.id}/association/tags").should be_nil
+    end
+
+    it "should delete has_one through belongs_to with_association cache" do
+      @group1.save
+      Rails.cache.read("users/#{@user.id}/association/group").should be_nil
+      @user.cached_group.should == @group1
+      Rails.cache.read("users/#{@user.id}/association/group").should == @group1
+    end
   end
 end

data/spec/models/account.rb

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

data/spec/models/group.rb

@@ -0,0 +1,4 @@
+class Group < ActiveRecord::Base
+
+  has_many :accounts
+end

data/spec/models/post.rb

@@ -2,13 +2,20 @@ class Post < ActiveRecord::Base
   include Cacheable
 
   belongs_to :user
-  has_many :comments, :as => :commentable
 
+  has_many :comments, :as => :commentable
   has_many :images, :as => :viewable
 
+  has_and_belongs_to_many :tags
+
   model_cache do
     with_key
     with_attribute :user_id
-    with_association :user, :comments, :images
+    with_association :user, :comments, :images, :tags
+    with_class_method :default_post
+  end
+
+  def self.default_post
+    Post.first
   end
 end

data/spec/models/tag.rb

@@ -0,0 +1,5 @@
+class Tag < ActiveRecord::Base
+
+  has_and_belongs_to_many :posts
+
+end

data/spec/models/user.rb

@@ -5,11 +5,13 @@ class User < ActiveRecord::Base
   has_one :account
   has_many :images, through: :posts
 
+  has_one :group, through: :account
+
   model_cache do
     with_key
     with_attribute :login
     with_method :last_post
-    with_association :posts, :account, :images
+    with_association :posts, :account, :images, :group
   end
 
   def last_post

data/spec/spec_helper.rb

@@ -4,18 +4,29 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require 'rails'
 require 'active_record'
 require 'rspec'
-require 'mocha_standalone'
+require 'mocha/api'
 require 'memcached'
-
 require 'cacheable'
+require 'debugger'
 
-ActiveRecord::Migration.verbose = false
-ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+# MODELS = File.join(File.dirname(__FILE__), "models")
+# $LOAD_PATH.unshift(MODELS)
+# Dir[ File.join(MODELS, "*.rb") ].each { |f| require f }
 
-MODELS = File.join(File.dirname(__FILE__), "models")
-$LOAD_PATH.unshift(MODELS)
+# It needs this order otherwise cacheable throws
+# errors when looking for reflection classes
+# Specifically, post can't be before tag
+# and user can't be before post
+require 'models/account'
+require 'models/group'
+require 'models/comment'
+require 'models/image'
+require 'models/tag'
+require 'models/post'
+require 'models/user'
 
-Dir[ File.join(MODELS, "*.rb") ].sort.each { |file| require File.basename(file) }
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
 
 module Rails
   class <<self
@@ -39,6 +50,7 @@ RSpec.configure do |config|
 
       create_table :accounts do |t|
         t.integer :user_id
+        t.integer :group_id
       end
 
       create_table :posts do |t|
@@ -55,7 +67,21 @@ RSpec.configure do |config|
         t.integer :viewable_id
         t.string :viewable_type
       end
+
+      create_table :tags do |t|
+        t.string :title
+      end
+
+      create_table :posts_tags, id: false do |t|
+        t.integer :post_id
+        t.integer :tag_id
+      end
+
+      create_table :groups do |t|
+        t.string :name
+      end
     end
+
   end
 
   config.after :all do

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: simple_cacheable
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
   prerelease: 
 platform: ruby
 authors:
 - Richard Huang
+- Scott Carleton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -62,6 +63,7 @@ dependencies:
 description: a simple cache implementation based on activerecord
 email:
 - flyerhzm@gmail.com
+- scott@artsicle.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -79,8 +81,10 @@ files:
 - spec/cacheable_spec.rb
 - spec/models/account.rb
 - spec/models/comment.rb
+- spec/models/group.rb
 - spec/models/image.rb
 - spec/models/post.rb
+- spec/models/tag.rb
 - spec/models/user.rb
 - spec/spec_helper.rb
 homepage: https://github.com/flyerhzm/simple-cacheable
@@ -95,18 +99,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -672054861354724444
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -672054861354724444
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -117,7 +115,9 @@ test_files:
 - spec/cacheable_spec.rb
 - spec/models/account.rb
 - spec/models/comment.rb
+- spec/models/group.rb
 - spec/models/image.rb
 - spec/models/post.rb
+- spec/models/tag.rb
 - spec/models/user.rb
 - spec/spec_helper.rb