simple_cacheable 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b46d1110354d90d106fe5abdfed1eaa6801dd7e4
-  data.tar.gz: 763dac9a0c34135095974d09bb2575fbc5106ed2
+  metadata.gz: 84641f34cae9d9da455523484d0a802851c938ed
+  data.tar.gz: 951f43891133aa8e58d6235d686cc2427b407dcb
 SHA512:
-  metadata.gz: f0fd40d41856c6efb7ecdfa1d8263ab2178b98c4cc8656d5bde2f3e67d71029c8cdebacf72a9d127abd775867d1d452fe86e8b122ec8f8adb315b9fab444999b
-  data.tar.gz: 322aad0ed21db8769cc06557df6461f8e8a29ddad18597922a4410480dc71a3d639217ea07a88b3c861db899802b4cf05c615242dc5069a9aab55325bfb0983a
+  metadata.gz: 99d9989b5970e995a3212583ae721802d04e1acb6e5ca4384213083926e03235f97f663027c599cdc4bbaba28ba6d0fc832813e18df2e7439e6994ead01f2985
+  data.tar.gz: 8dd71f349161ed02e8f63482e9a0e9dd88f98c12cdbbd7e2555fe3a217a7099c29ff5ec414dd79f98e2835a88878503a75f5cc32640129d25d691a79e5d708c8

data/.travis.yml

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

data/ChangeLog

@@ -1,3 +1,9 @@
+1.4.0
+* Fixed after_commit silent failure for assocations that didn't exist
+* Fixed association for has_many through when there are several belongs_to relationships
+* Fixed multiple calls to model_cache
+* Fixed STI/inheritance use cases
+
 1.3.3
 * File Reorganization
 * Rails 4 Compatibility

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_cacheable (1.3.2)
+    simple_cacheable (1.3.3)
       rails (>= 3.0.0)
 
 GEM

data/README.md

@@ -4,7 +4,7 @@ cacheable
 cacheable is a simple cache implementation based on activerecord, it is
 extracted from [rails-bestpractices.com][1].
 
-it supports activerecord >= 3.0.0, works on 1.9.2, 1.9.3 and jruby.
+it supports activerecord >= 3.0.0, tested on 1.9.3 and 2.0.0 and works with jruby.
 
 Introduction
 ------------
@@ -68,7 +68,7 @@ Install
 
 add the following code to your Gemfile
 
-    gem "simple_cacheable", :require => "cacheable"
+    gem "simple_cacheable"
 
 
 Gotchas

data/lib/cacheable/types/association_cache.rb

@@ -2,7 +2,8 @@ module Cacheable
   module AssocationCache
 
     def with_association(*association_names)
-      self.cached_associations = association_names
+      self.cached_associations ||= []
+      self.cached_associations += association_names
 
       association_names.each do |association_name|
         association = reflect_on_association(association_name)
@@ -20,8 +21,9 @@ module Cacheable
           if through_reflection_name = association.options[:through]
             through_association = self.reflect_on_association(through_reflection_name)
 
-            # 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
+            reverse_through_association = through_association.klass.reflect_on_all_associations(:belongs_to).detect do |assoc|
+              assoc.klass.ancestors.include?(Cacheable) && assoc.klass.reflect_on_association(association.name)
+            end
 
             # 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|
@@ -33,10 +35,11 @@ module Cacheable
 
                 define_method("expire_#{association_name}_cache") do
                   if respond_to? "expire_#{reverse_association.name}_cache".to_sym
-                    # cached_viewable.expire_association_cache
                     send("cached_#{reverse_association.name}").expire_association_cache(association_name)
                   else
-                    send(reverse_association.name).send(reverse_through_association.name).expire_association_cache(association_name)
+                    if send(reverse_association.name) && send(reverse_association.name).respond_to?(reverse_through_association.name)
+                      send(reverse_association.name).send(reverse_through_association.name).expire_association_cache(association_name)
+                    end
                   end
                 end
               end

data/lib/cacheable/types/attribute_cache.rb

@@ -1,7 +1,10 @@
 module Cacheable
   module AttributeCache
     def with_attribute(*attributes)
-      self.cached_indices = attributes.inject({}) { |indices, attribute| indices[attribute] = {} }
+      self.cached_indices ||= {}
+      self.cached_indices = self.cached_indices.merge(attributes.each_with_object({}) {
+        |attribute, indices| indices[attribute] = {}
+      })
 
       class_eval do
         after_commit :expire_attribute_cache, :on => :update

data/lib/cacheable/types/class_method_cache.rb

@@ -3,7 +3,7 @@ module Cacheable
     # Cached class method
     # Should expire on any instance save
     def with_class_method(*methods)
-      self.cached_class_methods = methods.inject({}) { |indices, meth| indices[meth] = {} }
+      self.cached_class_methods = methods.each_with_object({}) { |meth, indices| indices[meth] = {} }
 
       class_eval do
         after_commit :expire_class_method_cache, on: :update

data/lib/cacheable/types/method_cache.rb

@@ -1,7 +1,8 @@
 module Cacheable
   module MethodCache
     def with_method(*methods)
-      self.cached_methods = methods
+      self.cached_methods ||= []
+      self.cached_methods += methods
 
       class_eval do
         after_commit :expire_method_cache, :on => :update

data/lib/cacheable/version.rb

@@ -1,3 +1,3 @@
 module Cacheable
-  VERSION = "1.3.3"
+  VERSION = "1.4.0"
 end

data/lib/cacheable.rb

@@ -8,16 +8,20 @@ module Cacheable
     base.extend(Cacheable::Caches)
     base.send :include, Cacheable::Keys
     base.send :include, Cacheable::Expiry
-
+    base.send :extend,  ClassMethods
     base.class_eval do
-      def self.model_cache(&block)
-        class_attribute :cached_key,
+      class_attribute   :cached_key,
                         :cached_indices,
                         :cached_methods,
                         :cached_class_methods,
                         :cached_associations
-        instance_exec &block
-      end
+    end
+
+  end
+
+  module ClassMethods
+    def model_cache(&block)
+      instance_exec &block
     end
   end
 

data/spec/cacheable/expiry_cache_spec.rb

@@ -3,11 +3,13 @@ require 'spec_helper'
 describe Cacheable do
   let(:cache) { Rails.cache }
   let(:user)  { User.create(:login => 'flyerhzm') }
+  let(:descendant) { Descendant.create(:login => "scotterc")}
 
   before :all do
     @post1 = user.posts.create(:title => 'post1')
     user2 = User.create(:login => 'PelegR')
     user2.posts.create(:title => 'post3')
+    @post3 = descendant.posts.create(:title => 'post3')
   end
 
   before :each do
@@ -68,7 +70,6 @@ describe Cacheable do
       Rails.cache.read("posts/class_method/retrieve_with_both/1+1").should be_nil
     end
 
-    # TODO: should we cache empty arrays?
     it "should delete associations cache" do
       user.cached_images
       Rails.cache.read("users/#{user.id}/association/images").should_not be_nil
@@ -78,4 +79,89 @@ describe Cacheable do
 
   end
 
+  context "single table inheritance bug" do
+    context "user" do
+      it "has cached indices" do
+        User.cached_indices.should_not be_nil
+      end
+
+      it "has specific cached indices" do
+        User.cached_indices.keys.should include :login
+        User.cached_indices.keys.should_not include :email
+      end
+
+      it "should have cached_methods" do
+        User.cached_methods.should_not be_nil
+        User.cached_methods.should == [:last_post]
+      end
+    end
+
+    context "expiring class_method cache" do
+      it "expires correctly from inherited attributes" do
+        Rails.cache.read("users/class_method/default_name").should be_nil
+        User.cached_default_name
+        Rails.cache.read("users/class_method/default_name").should == "flyerhzm"
+        user.expire_model_cache
+        Rails.cache.read("users/class_method/default_name").should be_nil
+      end
+    end
+
+    context "descendant" do
+
+      it "should have cached indices hash" do
+        Descendant.cached_indices.should_not be_nil
+      end
+
+      it "has specific cached indices" do
+        Descendant.cached_indices.keys.should include :login
+        Descendant.cached_indices.keys.should include :email
+      end
+
+      it "should have cached_methods" do
+        Descendant.cached_methods.should_not be_nil
+        Descendant.cached_methods.should == [:last_post, :name]
+      end
+
+      context "expiring method cache" do
+        it "expires correctly from inherited attributes" do
+          Rails.cache.read("descendants/#{descendant.id}/method/last_post").should be_nil
+          descendant.cached_last_post.should == descendant.last_post
+          Rails.cache.read("descendants/#{descendant.id}/method/last_post").should == descendant.last_post
+          descendant.expire_model_cache
+          Rails.cache.read("descendants/#{descendant.id}/method/last_post").should be_nil
+        end
+      end
+
+      context "expiring attribute cache" do
+        it "expires correctly from inherited attributes" do
+          Rails.cache.read("descendants/attribute/login/scotterc").should be_nil
+          Descendant.find_cached_by_login("scotterc").should == descendant
+          Rails.cache.read("descendants/attribute/login/scotterc").should == descendant
+          descendant.expire_model_cache
+          Rails.cache.read("descendants/attribute/login/scotterc").should be_nil
+        end
+      end
+
+      context "expiring association cache" do
+        it "expires correctly from inherited attributes" do
+          Rails.cache.read("descendants/#{descendant.id}/association/posts").should be_nil
+          descendant.cached_posts.should == [@post3]
+          Rails.cache.read("descendants/#{descendant.id}/association/posts").should == [@post3]
+          descendant.expire_model_cache
+          Rails.cache.read("descendants/#{descendant.id}/association/posts").should be_nil
+        end
+      end
+
+      context "expiring class_method cache" do
+        it "expires correctly from inherited attributes" do
+          Rails.cache.read("descendants/class_method/default_name").should be_nil
+          Descendant.cached_default_name
+          Rails.cache.read("descendants/class_method/default_name").should == "ScotterC"
+          descendant.expire_model_cache
+          Rails.cache.read("descendants/class_method/default_name").should be_nil
+        end
+      end
+    end
+  end
+
 end

data/spec/cacheable/types/association_cache_spec.rb

@@ -15,6 +15,7 @@ describe Cacheable do
     @tag2 = @post1.tags.create(title: "Caching")
     @group1 = Group.create(name: "Ruby On Rails")
     @account = user.create_account(group: @group1)
+    @location = @post1.create_location(city: "New York")
   end
 
   before :each do
@@ -163,4 +164,32 @@ describe Cacheable do
 
   end
 
+  describe "after_commit bug" do
+    it "normal" do
+      @image1.expects(:do_something).once
+      @image1.save
+    end
+
+    it "new image fails without association" do
+      image = Image.new
+      image.expects(:do_something).once
+      image.save
+    end
+
+    it "new image fails with missing association" do
+      image = @group1.images.new
+      image.expects(:do_something).once
+      image.save
+    end
+  end
+
+  describe "belongs_to bug" do
+
+    it "shouldn't hit location" do
+      @location.expects(:expire_association_cache).with(:images).never
+      user.save
+    end
+
+  end
+
 end

data/spec/cacheable/types/attribute_cache_spec.rb

@@ -3,10 +3,12 @@ require 'spec_helper'
 describe Cacheable do
   let(:cache) { Rails.cache }
   let(:user)  { User.create(:login => 'flyerhzm') }
+  let(:descendant) { Descendant.create(:login => "scotterc")}
 
   before :all do
     @post1 = user.posts.create(:title => 'post1')
     @post2 = user.posts.create(:title => 'post2')
+    @post3 = descendant.posts.create(:title => 'post3')
   end
 
   before :each do
@@ -57,4 +59,31 @@ describe Cacheable do
     end
   end
 
+  context "descendant" do
+    it "should not cache Descendant.find_by_login" do
+      Rails.cache.read("descendants/attribute/login/scotterc").should be_nil
+    end
+
+    it "should cache by Descendant.find_by_login" do
+      Descendant.find_cached_by_login("scotterc").should == descendant
+      Rails.cache.read("descendants/attribute/login/scotterc").should == descendant
+    end
+
+    it "should get cached by Descendant.find_by_login multiple times" do
+      Descendant.find_cached_by_login("scotterc")
+      Descendant.find_cached_by_login("scotterc").should == descendant
+    end
+
+    it "should escape whitespace" do
+      new_descendant = Descendant.create(:login => "descendant space")
+      Descendant.find_cached_by_login("descendant space").should == new_descendant
+    end
+
+    it "maintains cached methods" do
+      Rails.cache.read("descendants/#{descendant.id}/method/name").should be_nil
+      descendant.cached_name.should == descendant.name
+      Rails.cache.read("descendants/#{descendant.id}/method/name").should == descendant.name
+    end
+  end
+
 end

data/spec/cacheable/types/method_cache_spec.rb

@@ -3,10 +3,12 @@ require 'spec_helper'
 describe Cacheable do
   let(:cache) { Rails.cache }
   let(:user)  { User.create(:login => 'flyerhzm') }
+  let(:descendant) { Descendant.create(:login => "scotterc")}
 
   before :all do
     @post1 = user.posts.create(:title => 'post1')
     @post2 = user.posts.create(:title => 'post2')
+    @post3 = descendant.posts.create(:title => 'post3')
   end
 
   before :each do
@@ -28,6 +30,38 @@ describe Cacheable do
       user.cached_last_post
       user.cached_last_post.should == user.last_post
     end
+
+    context "descendant should inherit methods" do
+      it "should not cache Descendant.last_post" do
+        Rails.cache.read("descendants/#{descendant.id}/method/last_post").should be_nil
+      end
+
+      it "should cache Descendant#last_post" do
+        descendant.cached_last_post.should == descendant.last_post
+        Rails.cache.read("descendants/#{descendant.id}/method/last_post").should == descendant.last_post
+      end
+
+      it "should cache Descendant#last_post multiple times" do
+        descendant.cached_last_post
+        descendant.cached_last_post.should == descendant.last_post
+      end
+
+      context "as well as new methods" do
+        it "should not cache Descendant.name" do
+          Rails.cache.read("descendants/#{descendant.id}/method/name").should be_nil
+        end
+
+        it "should cache Descendant#name" do
+          descendant.cached_name.should == descendant.name
+          Rails.cache.read("descendants/#{descendant.id}/method/name").should == descendant.name
+        end
+
+        it "should cache Descendant#name multiple times" do
+          descendant.cached_name
+          descendant.cached_name.should == descendant.name
+        end
+      end
+    end
   end
 
 end

data/spec/models/descendant.rb

@@ -0,0 +1,20 @@
+class Descendant < User
+
+  belongs_to :location
+
+  model_cache do
+    with_attribute :email
+    with_method :name
+    with_association :location
+    with_class_method :default_name
+  end
+
+  def name
+    "ScotterC"
+  end
+
+  def self.default_name
+    "ScotterC"
+  end
+
+end

data/spec/models/group.rb

@@ -1,4 +1,6 @@
 class Group < ActiveRecord::Base
 
   has_many :accounts
+
+  has_many :images, as: :viewable
 end

data/spec/models/image.rb

@@ -2,4 +2,9 @@ class Image < ActiveRecord::Base
 
   belongs_to :viewable, :polymorphic => true
 
+  after_commit :do_something
+
+  def do_something
+    e = 1337
+  end
 end

data/spec/models/location.rb

@@ -0,0 +1,3 @@
+class Location < ActiveRecord::Base
+
+end

data/spec/models/post.rb

@@ -1,6 +1,7 @@
 class Post < ActiveRecord::Base
   include Cacheable
 
+  belongs_to :location
   belongs_to :user
 
   has_many :comments, :as => :commentable

data/spec/models/user.rb

@@ -12,9 +12,15 @@ class User < ActiveRecord::Base
     with_attribute :login
     with_method :last_post
     with_association :posts, :account, :images, :group
+    with_class_method :default_name
   end
 
   def last_post
     posts.last
   end
+
+  def self.default_name
+    "flyerhzm"
+  end
+
 end

data/spec/spec_helper.rb

@@ -8,14 +8,11 @@ require 'mocha/api'
 require 'memcached'
 require 'cacheable'
 
-# MODELS = File.join(File.dirname(__FILE__), "models")
-# $LOAD_PATH.unshift(MODELS)
-# Dir[ File.join(MODELS, "*.rb") ].each { |f| require f }
-
 # 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/location'
 require 'models/account'
 require 'models/group'
 require 'models/comment'
@@ -23,6 +20,7 @@ require 'models/image'
 require 'models/tag'
 require 'models/post'
 require 'models/user'
+require 'models/descendant'
 
 ActiveRecord::Migration.verbose = false
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
@@ -45,6 +43,7 @@ RSpec.configure do |config|
     ::ActiveRecord::Schema.define(:version => 1) do
       create_table :users do |t|
         t.string :login
+        t.string :email
       end
 
       create_table :accounts do |t|
@@ -55,6 +54,7 @@ RSpec.configure do |config|
       create_table :posts do |t|
         t.integer :user_id
         t.string :title
+        t.integer :location_id
       end
 
       create_table :comments do |t|
@@ -65,6 +65,7 @@ RSpec.configure do |config|
       create_table :images do |t|
         t.integer :viewable_id
         t.string :viewable_type
+        t.string :name
       end
 
       create_table :tags do |t|
@@ -79,6 +80,10 @@ RSpec.configure do |config|
       create_table :groups do |t|
         t.string :name
       end
+
+      create_table :locations do |t|
+        t.string :city
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_cacheable
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Richard Huang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -91,8 +91,10 @@ files:
 - spec/cacheable_spec.rb
 - spec/models/account.rb
 - spec/models/comment.rb
+- spec/models/descendant.rb
 - spec/models/group.rb
 - spec/models/image.rb
+- spec/models/location.rb
 - spec/models/post.rb
 - spec/models/tag.rb
 - spec/models/user.rb
@@ -130,8 +132,10 @@ test_files:
 - spec/cacheable_spec.rb
 - spec/models/account.rb
 - spec/models/comment.rb
+- spec/models/descendant.rb
 - spec/models/group.rb
 - spec/models/image.rb
+- spec/models/location.rb
 - spec/models/post.rb
 - spec/models/tag.rb
 - spec/models/user.rb