second_level_cache 1.6.2 → 2.0.0.beta

data/CHANGELOG.md

@@ -1,50 +1,55 @@
-1.2.0
+1.6.2
 -----
-* [clear cache after update_counters](https://github.com/csdn-dev/second_level_cache/commit/240dde81199124092e0e8ad0500c167ac146e301)
+* [can disable/enable fetch_by_uinq_key method]
+* [Fix Bug: serialized attribute columns marshal issue #11]
 
-1.2.1
+1.6.1
 -----
-* [fix polymorphic association bug]
+* [Fix bug: undefined method `select_all_column?' for []:ActiveRecord::Relation] by sishen
 
-1.3.0
+1.6.0
 -----
-* [clean cache after touch]
+* [write through cache]
+* [disable SecondLevelCache for spicial model]
+* [only cache `SELECT *` query]
 
-1.3.1
+1.5.1
 -----
-* [clean cache after update_column/increment!/decrement!]
+* [use new marshal machanism to avoid clear assocation cache manually]
 
-1.3.2
+1.5.0
 -----
-* [fix has one assciation issue]
+* [add cache version to quick clear cache for special model]
+
+1.4.1
+-----
+* [fix errors when belongs_to association return nil]
 
 1.4.0
 -----
 * [cache has one assciation]
 
-1.4.1
+1.3.2
 -----
-* [fix errors when belongs_to association return nil]
+* [fix has one assciation issue]
 
-1.5.0
+1.3.1
 -----
-* [add cache version to quick clear cache for special model]
+* [clean cache after update_column/increment!/decrement!]
 
-1.5.1
+1.3.0
 -----
-* [use new marshal machanism to avoid clear assocation cache manually]
+* [clean cache after touch]
 
-1.6.0
+1.2.1
 -----
-* [write through cache]
-* [disable SecondLevelCache for spicial model]
-* [only cache `SELECT *` query]
+* [fix polymorphic association bug]
 
-1.6.1
+1.2.0
 -----
-* [Fix bug: undefined method `select_all_column?' for []:ActiveRecord::Relation] by sishen
+* [clear cache after update_counters](https://github.com/csdn-dev/second_level_cache/commit/240dde81199124092e0e8ad0500c167ac146e301)
+
+
+
+
 
-1.6.2
------
-* [can disable/enable fetch_by_uinq_key method]
-* [Fix Bug: serialized attribute columns marshal issue #11]

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in second_level_cache.gemspec
 gemspec

data/README.md

@@ -1,11 +1,11 @@
 # SecondLevelCache
 
 [![Gem Version](https://badge.fury.io/rb/second_level_cache.png)](http://badge.fury.io/rb/second_level_cache)
-[![Dependency Status](https://gemnasium.com/csdn-dev/second_level_cache.png)](https://gemnasium.com/csdn-dev/second_level_cache)
-[![Build Status](https://travis-ci.org/csdn-dev/second_level_cache.png?branch=master)](https://travis-ci.org/csdn-dev/second_level_cache)
-[![Code Climate](https://codeclimate.com/github/csdn-dev/second_level_cache.png)](https://codeclimate.com/github/csdn-dev/second_level_cache)
+[![Dependency Status](https://gemnasium.com/hooopo/second_level_cache.png)](https://gemnasium.com/hooopo/second_level_cache)
+[![Build Status](https://travis-ci.org/hooopo/second_level_cache.png?branch=master)](https://travis-ci.org/hooopo/second_level_cache)
+[![Code Climate](https://codeclimate.com/github/hooopo/second_level_cache.png)](https://codeclimate.com/github/hooopo/second_level_cache)
 
-SecondLevelCache is a write-through and read-through caching library inspired by Cache Money and cache_fu, support only Rails3 and ActiveRecord.
+SecondLevelCache is a write-through and read-through caching library inspired by Cache Money and cache_fu, support ActiveRecord 4.
 
 Read-Through: Queries by ID, like `current_user.articles.find(params[:id])`, will first look in cache store and then look in the database for the results of that query. If there is a cache miss, it will populate the cache.
 
@@ -17,7 +17,7 @@ Write-Through: As objects are created, updated, and deleted, all of the caches a
 In your gem file:
 
 ```ruby
-gem "second_level_cache", "~> 1.5"
+gem "second_level_cache", "~> 2.0.0"
 ```
 
 ## Usage
@@ -34,9 +34,6 @@ Then it will fetch cached object in this situations:
 
 ```ruby
 User.find(1)
-User.find_by_id(1)
-User.find_by_id!(1)
-User.find_by_id_and_name(1, "Hooopo")
 User.where(:status => 1).find_by_id(1)
 user.articles.find_by_id(1)
 user.articles.find(1)
@@ -143,23 +140,3 @@ user = User.fetch_by_uniq_key!("hooopo", :nick_name) # this will raise `ActiveRe
 ## License
 
 MIT License
-
-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/lib/second_level_cache/active_record/fetch_by_uniq_key.rb

@@ -4,8 +4,8 @@ module SecondLevelCache
     module FetchByUniqKey
       def fetch_by_uniq_key(value, uniq_key_name)
         return self.where(uniq_key_name => value).first unless self.second_level_cache_enabled?
-        if iid = SecondLevelCache.cache_store.read(cache_uniq_key(value, uniq_key_name))
-          self.find_by_id(iid)
+        if _id = SecondLevelCache.cache_store.read(cache_uniq_key(value, uniq_key_name))
+          self.find_by_id(_id)
         else
           record = self.where(uniq_key_name => value).first
           record.tap{|record| SecondLevelCache.cache_store.write(cache_uniq_key(value, uniq_key_name), record.id)} if record

data/lib/second_level_cache/active_record/finder_methods.rb

@@ -9,11 +9,11 @@ module SecondLevelCache
       included do
         class_eval do
           alias_method_chain :find_one, :second_level_cache
-          alias_method_chain :find_by_attributes, :second_level_cache
         end
       end
 
-      # TODO fetch multi ids
+      # TODO find_some
+      # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/finder_methods.rb#L289-L309
       #
       # Cacheable:
       #
@@ -28,56 +28,28 @@ module SecondLevelCache
       def find_one_with_second_level_cache(id)
         return find_one_without_second_level_cache(id) unless second_level_cache_enabled?
         return find_one_without_second_level_cache(id) unless select_all_column?
-
+        
         id = id.id if ActiveRecord::Base === id
-        if ::ActiveRecord::IdentityMap.enabled? && cachable? && record = from_identity_map(id)
-          return record
-        end
 
         if cachable?
-          return record if record = @klass.read_second_level_cache(id)
+          if record = @klass.read_second_level_cache(id)
+            return record
+          end
         end
-
+       
         if cachable_without_conditions?
           if record = @klass.read_second_level_cache(id)
             return record if where_match_with_cache?(where_values, record)
           end
         end
-
+ 
         record = find_one_without_second_level_cache(id)
         record.write_second_level_cache
         record
       end
 
-      # TODO cache find_or_create_by_id
-      def find_by_attributes_with_second_level_cache(match, attributes, *args)
-        return find_by_attributes_without_second_level_cache(match, attributes, *args) unless second_level_cache_enabled?
-        return find_by_attributes_without_second_level_cache(match, attributes, *args) unless select_all_column?
-
-        conditions = Hash[attributes.map {|a| [a, args[attributes.index(a)]]}]
-
-        if conditions.has_key?("id")
-          result = wrap_bang(match.bang?) do
-            if conditions.size == 1
-              find_one_with_second_level_cache(conditions["id"])
-            else
-              where(conditions.except("id")).find_one_with_second_level_cache(conditions["id"])
-            end
-          end
-          yield(result) if block_given? #edge rails do this bug rails3.1.0 not
-
-          return result
-        end
-
-        find_by_attributes_without_second_level_cache(match, attributes, *args)
-      end
-
       private
 
-      def wrap_bang(bang)
-        bang ? yield : (yield rescue nil)
-      end
-
       def cachable?
         where_values.blank? &&
           limit_one? && order_values.blank? &&
@@ -106,10 +78,6 @@ module SecondLevelCache
       def select_all_column?
         select_values.blank?
       end
-
-      def from_identity_map(id)
-        ::ActiveRecord::IdentityMap.get(@klass, id)
-      end
     end
   end
 end

data/lib/second_level_cache/active_record/preloader.rb

@@ -0,0 +1,46 @@
+# -*- encoding : utf-8 -*-
+module SecondLevelCache
+  module ActiveRecord
+    module Associations
+      class Preloader
+        module Association
+          extend ActiveSupport::Concern
+
+          included do
+            class_eval do
+              alias_method_chain :records_for, :second_level_cache
+            end
+          end
+
+          def records_for_with_second_level_cache(ids)
+            return records_for_without_second_level_cache(ids) unless klass.second_level_cache_enabled?
+
+            map_cache_keys = ids.map{|id| klass.second_level_cache_key(id)}
+            records_from_cache = ::SecondLevelCache.cache_store.read_multi(*map_cache_keys)
+
+            # NOTICE 
+            # Rails.cache.read_multi return hash that has keys only hitted.
+            # eg. Rails.cache.read_multi(1,2,3) => {2 => hit_value, 3 => hit_value} 
+            hitted_ids = records_from_cache.map{|key, _| key.split("/")[2]}
+            missed_ids = ids - hitted_ids
+
+            ::SecondLevelCache::Config.logger.info "missed ids -> #{missed_ids.inspect} | hitted ids -> #{hitted_ids.inspect}"
+
+            if missed_ids.empty?
+              RecordMarshal.load_multi(records_from_cache.values)
+            else
+              records_from_db = records_for_without_second_level_cache(missed_ids)
+              records_from_db.map{|record| write_cache(record); record} + RecordMarshal.load_multi(records_from_cache.values)
+            end
+          end
+
+          private
+
+          def write_cache(record)
+            record.write_second_level_cache
+          end
+        end
+      end
+    end 
+  end
+end

data/lib/second_level_cache/active_record.rb

@@ -5,11 +5,13 @@ require 'second_level_cache/active_record/finder_methods'
 require 'second_level_cache/active_record/persistence'
 require 'second_level_cache/active_record/belongs_to_association'
 require 'second_level_cache/active_record/has_one_association'
+require 'second_level_cache/active_record/preloader'
 
 ActiveRecord::Base.send(:include, SecondLevelCache::Mixin)
 ActiveRecord::Base.send(:include, SecondLevelCache::ActiveRecord::Base)
 ActiveRecord::Base.send(:extend, SecondLevelCache::ActiveRecord::FetchByUniqKey)
-ActiveRecord::Relation.send(:include, SecondLevelCache::ActiveRecord::FinderMethods)
+
 ActiveRecord::Base.send(:include, SecondLevelCache::ActiveRecord::Persistence)
 ActiveRecord::Associations::BelongsToAssociation.send(:include, SecondLevelCache::ActiveRecord::Associations::BelongsToAssociation)
 ActiveRecord::Associations::HasOneAssociation.send(:include, SecondLevelCache::ActiveRecord::Associations::HasOneAssociation)
+ActiveRecord::Associations::Preloader::Association.send(:include, SecondLevelCache::ActiveRecord::Associations::Preloader::Association)

data/lib/second_level_cache/record_marshal.rb

@@ -23,5 +23,9 @@ module RecordMarshal
       record.init_with('attributes' => serialized[1])
       record
     end
+
+    def load_multi(serializeds)
+      serializeds.map{|serialized| load(serialized)}
+    end
   end
 end

data/lib/second_level_cache/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module SecondLevelCache 
-  VERSION = "1.6.2"
+  VERSION = "2.0.0.beta"
 end

data/lib/second_level_cache.rb

@@ -23,6 +23,7 @@ module SecondLevelCache
         @second_level_cache_options = options
         @second_level_cache_options[:expires_in] ||= 1.week
         @second_level_cache_options[:version] ||= 0
+        relation.class.send :include, SecondLevelCache::ActiveRecord::FinderMethods
       end
 
       def second_level_cache_enabled?

data/second_level_cache.gemspec

@@ -4,9 +4,9 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["wangxz"]
-  gem.email         = ["wangxz@csdn.net"]
-  gem.description   = %q{Write Through and Read Through caching library inspired by CacheMoney and cache_fu, support only Rails3 and ActiveRecord.}
+  gem.authors       = ["Hooopo"]
+  gem.email         = ["hoooopo@gmail.com"]
+  gem.description   = %q{Write Through and Read Through caching library inspired by CacheMoney and cache_fu, support  ActiveRecord 4.}
   gem.summary       = <<-SUMMARY
   SecondLevelCache is a write-through and read-through caching library inspired by Cache Money and cache_fu, support only Rails3 and ActiveRecord.
 
@@ -21,7 +21,6 @@ Gem::Specification.new do |gem|
     "README.md",
     "Rakefile",
     "Gemfile",
-    "init.rb",
     "CHANGELOG.md",
     "second_level_cache.gemspec"
   ]
@@ -31,9 +30,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = SecondLevelCache::VERSION
 
-  gem.add_runtime_dependency "activesupport", ["~> 3.2.0"]
+  gem.add_runtime_dependency "activesupport", ["~> 4.0.0.beta1"]
 
-  gem.add_development_dependency "activerecord", ["~> 3.2.0"]
+  gem.add_development_dependency "activerecord", ["~> 4.0.0.beta1"]
   gem.add_development_dependency "sqlite3"
   gem.add_development_dependency "rake"
+  gem.add_development_dependency "database_cleaner", "~> 1.0.0.RC1"
 end

data/test/active_record/preloader_test.rb

@@ -0,0 +1,28 @@
+# -*- encoding : utf-8 -*-
+require 'active_record/test_helper'
+
+class ActiveRecord::PreloaderTest < Test::Unit::TestCase
+  def setup
+    DatabaseCleaner[:active_record].start
+    @topic1 = Topic.create :title => "title1", :body => "body1"
+    @topic2 = Topic.create :title => "title2", :body => "body2"
+    @topic3 = Topic.create :title => "title3", :body => "body3"
+    @post1 = @topic1.posts.create :body => "post1"
+    @post2 = @topic2.posts.create :body => "post2"
+    @post3 = @topic3.posts.create :body => "post3"
+  end
+
+  def test_preload_work_properly
+    results = Post.includes(:topic).order("id ASC").to_a
+    assert_equal results.size, 3
+    assert_equal results.first.topic, @topic1
+  end
+
+  def test_when_read_multi_missed_from_cache_AR_will_fetch_missed_records_from_db
+    @topic1.expire_second_level_cache
+    results = Post.includes(:topic).order("id ASC").to_a
+    assert_equal results.size, 3
+    assert_equal results.first.topic, @topic1
+    assert_match /IN\s+\(#{@topic1.id}\)/m, $sql_logger
+  end
+end

data/test/active_record/test_helper.rb

@@ -24,7 +24,20 @@ class Test::Unit::TestCase
   end
 
   def teardown
-    User.delete_all
+    $sql_logger = nil
+    DatabaseCleaner[:active_record].clean
+  end
+end
+
+module ActiveRecord
+  module Querying
+    def find_by_sql_with_test(sql, binds = [])
+      $sql_logger ||= ""
+      $sql_logger << sql.to_sql
+      $sql_logger << "\n"
+      find_by_sql_without_test(sql, binds)
+    end
+    alias_method_chain :find_by_sql, :test
   end
 end
 

data/test/require_test.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'test_helper'
 require 'active_record'
 

data/test/test_helper.rb

@@ -3,6 +3,9 @@ require 'rubygems'
 require 'bundler/setup'
 require 'second_level_cache'
 require 'test/unit'
+require 'database_cleaner'
+
+DatabaseCleaner[:active_record].strategy = :transaction
 
 SecondLevelCache.configure do |config|
   config.cache_store = ActiveSupport::Cache::MemoryStore.new

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: second_level_cache
 version: !ruby/object:Gem::Version
-  version: 1.6.2
-  prerelease: 
+  version: 2.0.0.beta
+  prerelease: 6
 platform: ruby
 authors:
-- wangxz
+- Hooopo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0.beta1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0.beta1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0.beta1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -75,46 +75,63 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.RC1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.RC1
 description: Write Through and Read Through caching library inspired by CacheMoney
-  and cache_fu, support only Rails3 and ActiveRecord.
+  and cache_fu, support  ActiveRecord 4.
 email:
-- wangxz@csdn.net
+- hoooopo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/second_level_cache.rb
-- lib/second_level_cache/config.rb
-- lib/second_level_cache/active_record.rb
-- lib/second_level_cache/active_record/fetch_by_uniq_key.rb
-- lib/second_level_cache/active_record/persistence.rb
 - lib/second_level_cache/active_record/base.rb
-- lib/second_level_cache/active_record/finder_methods.rb
 - lib/second_level_cache/active_record/belongs_to_association.rb
+- lib/second_level_cache/active_record/fetch_by_uniq_key.rb
+- lib/second_level_cache/active_record/finder_methods.rb
 - lib/second_level_cache/active_record/has_one_association.rb
+- lib/second_level_cache/active_record/persistence.rb
+- lib/second_level_cache/active_record/preloader.rb
+- lib/second_level_cache/active_record.rb
+- lib/second_level_cache/arel/wheres.rb
+- lib/second_level_cache/config.rb
 - lib/second_level_cache/record_marshal.rb
 - lib/second_level_cache/version.rb
-- lib/second_level_cache/arel/wheres.rb
+- lib/second_level_cache.rb
 - README.md
 - Rakefile
 - Gemfile
-- init.rb
 - CHANGELOG.md
 - second_level_cache.gemspec
-- test/require_test.rb
-- test/active_record/finder_methods_test.rb
-- test/active_record/belongs_to_association_test.rb
 - test/active_record/base_test.rb
-- test/active_record/persistence_test.rb
-- test/active_record/test_helper.rb
-- test/active_record/polymorphic_association_test.rb
+- test/active_record/belongs_to_association_test.rb
+- test/active_record/finder_methods_test.rb
+- test/active_record/model/book.rb
 - test/active_record/model/image.rb
 - test/active_record/model/post.rb
-- test/active_record/model/book.rb
-- test/active_record/model/user.rb
 - test/active_record/model/topic.rb
+- test/active_record/model/user.rb
+- test/active_record/persistence_test.rb
+- test/active_record/polymorphic_association_test.rb
+- test/active_record/preloader_test.rb
 - test/active_record/second_level_cache_test.rb
+- test/active_record/test_helper.rb
 - test/record_marshal_test.rb
+- test/require_test.rb
 - test/test_helper.rb
 homepage: https://github.com/csdn-dev/second_level_cache
 licenses: []
@@ -131,12 +148,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: ! 'SecondLevelCache is a write-through and read-through caching library inspired
@@ -146,19 +163,19 @@ summary: ! 'SecondLevelCache is a write-through and read-through caching library
   is a cache miss, it will populate the cache.  Write-Through: As objects are created,
   updated, and deleted, all of the caches are automatically kept up-to-date and coherent.'
 test_files:
-- test/require_test.rb
-- test/active_record/finder_methods_test.rb
-- test/active_record/belongs_to_association_test.rb
 - test/active_record/base_test.rb
-- test/active_record/persistence_test.rb
-- test/active_record/test_helper.rb
-- test/active_record/polymorphic_association_test.rb
+- test/active_record/belongs_to_association_test.rb
+- test/active_record/finder_methods_test.rb
+- test/active_record/model/book.rb
 - test/active_record/model/image.rb
 - test/active_record/model/post.rb
-- test/active_record/model/book.rb
-- test/active_record/model/user.rb
 - test/active_record/model/topic.rb
+- test/active_record/model/user.rb
+- test/active_record/persistence_test.rb
+- test/active_record/polymorphic_association_test.rb
+- test/active_record/preloader_test.rb
 - test/active_record/second_level_cache_test.rb
+- test/active_record/test_helper.rb
 - test/record_marshal_test.rb
+- test/require_test.rb
 - test/test_helper.rb
-has_rdoc: 

data/init.rb

@@ -1,2 +0,0 @@
-# -*- encoding : utf-8 -*-
-require File.expand_path("../lib/second_level_cache", __FILE__)