second_level_cache 2.2.6 → 2.3.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9040d6157f9c761c4b806764f7007b44f6c9c483
-  data.tar.gz: bd364513a045cd7817b4fa7b9b86d5a0e2a6e93c
+  metadata.gz: 98025234cd167d1057980109b910f6988747877b
+  data.tar.gz: 40f729aac59034003e7f6404321f47bfd8f67a55
 SHA512:
-  metadata.gz: 1e1970b11a1dcb57cba266b95f71680f01bafafab459f91feb950ccee18a628eeb40563867f8c9f6bbf6a898fe7ad089186dabde46f4779c3989dda1b0d7b301
-  data.tar.gz: 7894b59c9ecfcd52b5cb03bdbff19f9d6a088c490d34453a6170793a03171e703233e2f5a543d4037279726e80f8a4ac6699b62822c0e07ea8c59cfb0e145476
+  metadata.gz: fb1d412af6f56f3e20938b4744f0a48b3d18abc4a556847001edf4a1fa13aaabb9ece974fa9d11720177f011970c3f085d0fd984e920bf21b4b9018dac47b01e
+  data.tar.gz: dcec779ee5c1733a03b8058a3a7dc243ce33698af648e583d4ce118a879032f36f1da961da1a61c096edded58ccbdddb77bc44c812557f57fa3898460a919353

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+2.2.7
+-----
+
+* Use `second_level_cache` instead of `acts_as_cached` method to setup in model. (#56)
+
+2.2.6
+-----
+
+* Fix warning in Ruby 2.4.0. (#54)
+
 2.2.5
 -----
 

data/README.md

@@ -40,7 +40,7 @@ For example, cache User objects:
 
 ```ruby
 class User < ActiveRecord::Base
-  acts_as_cached(version: 1, expires_in: 1.week)
+  second_level_cache expires_in: 1.week
 end
 ```
 
@@ -67,7 +67,9 @@ Expires cache:
 user = User.find(1)
 user.expire_second_level_cache
 ```
+
 or expires cache using class method:
+
 ```ruby
 User.expire_second_level_cache(1)
 ```
@@ -97,15 +99,15 @@ User.select("id, name").find(1)
 ```ruby
 # user and account's write_second_level_cache operation will invoke after the logger.
 ActiveRecord::Base.transaction do
-   user.save
-   account.save
-   Rails.logger.info "info"
+  user.save
+  account.save
+  Rails.logger.info "info"
 end # <- Cache write
 
 # if you want to do something after user and account's write_second_level_cache operation, do this way:
 ActiveRecord::Base.transaction do
-   user.save
-   account.save
+  user.save
+  account.save
 end # <- Cache write
 Rails.logger.info "info"
 ```
@@ -119,8 +121,9 @@ DatabaseCleaner.strategy = :truncation
 ## Configure
 
 In production env, we recommend to use [Dalli](https://github.com/mperham/dalli) as Rails cache store.
+
 ```ruby
- config.cache_store = [:dalli_store, APP_CONFIG["memcached_host"], { namespace: "ns", compress: true }]
+config.cache_store = [:dalli_store, APP_CONFIG["memcached_host"], { namespace: "ns", compress: true }]
 ```
 
 ## Tips:
@@ -131,15 +134,17 @@ you can only change the `cache_key_prefix`:
 ```ruby
 SecondLevelCache.configure.cache_key_prefix = "slc1"
 ```
-* When schema of your model changed, just change the `version` of the speical model, avoding clear all the cache.
+
+* SecondLevelCache was added model schema digest as cache version, this means when you add/remove/change columns, the caches of this Model will expires.
+* When your want change the model cache version by manualy, just add the `version` option like this:
 
 ```ruby
 class User < ActiveRecord::Base
-  acts_as_cached(version: 2, expires_in: 1.week)
+  second_level_cache version: 2, expires_in: 1.week
 end
 ```
 
-* It provides a great feature, not hits db when fetching record via unique key(not primary key).
+* It provides a great feature, not hits db when fetching record via unique key (not primary key).
 
 ```ruby
 # this will fetch from cache
@@ -156,6 +161,7 @@ user = User.fetch_by_uniq_keys!(nick_name: "hooopo") # this will raise `ActiveRe
 Answer.includes(:question).limit(10).order("id DESC").each{|answer| answer.question.title}
 Answer Load (0.2ms)  SELECT `answers`.* FROM `answers` ORDER BY id DESC LIMIT 10 # Only one SQL query and one Rails.cache.read_multi fetching operation.
 ```
+
 [Details for read_multi feature](http://hooopo.writings.io/articles/a9cae5e0).
 
 ## Contributors

data/lib/second_level_cache/active_record/fetch_by_uniq_key.rb

@@ -21,7 +21,7 @@ module SecondLevelCache
       end
 
       def fetch_by_uniq_keys!(where_values)
-        fetch_by_uniq_keys(where_values) || fail(::ActiveRecord::RecordNotFound)
+        fetch_by_uniq_keys(where_values) || raise(::ActiveRecord::RecordNotFound)
       end
 
       def fetch_by_uniq_key(value, uniq_key_name)
@@ -33,7 +33,7 @@ module SecondLevelCache
       def fetch_by_uniq_key!(value, uniq_key_name)
         # puts "[Deprecated] will remove in the future,
         # use fetch_by_uniq_keys! method instead."
-        fetch_by_uniq_key(value, uniq_key_name) || fail(::ActiveRecord::RecordNotFound)
+        fetch_by_uniq_key(value, uniq_key_name) || raise(::ActiveRecord::RecordNotFound)
       end
 
       private

data/lib/second_level_cache/record_marshal.rb

@@ -31,6 +31,9 @@ module RecordMarshal
         next if attributes[name].nil? || attributes[name].is_a?(String)
         if coder.is_a?(::ActiveRecord::Coders::YAMLColumn)
           attributes[name] = coder.dump(attributes[name]) if attributes[name].is_a?(coder.object_class)
+        elsif coder.is_a?(::ActiveRecord::Store::IndifferentCoder)
+          # https://github.com/rails/rails/blob/5b14129/activerecord/lib/active_record/store.rb#L179
+          attributes[name] = coder.dump(attributes[name])
         elsif coder == ::ActiveRecord::Coders::JSON
           attributes[name] = attributes[name].to_json
         end

data/lib/second_level_cache/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SecondLevelCache
-  VERSION = '2.2.6'.freeze
+  VERSION = '2.3.0.beta'.freeze
 end

data/lib/second_level_cache.rb

@@ -20,11 +20,11 @@ module SecondLevelCache
 
       delegate :logger, :cache_store, :cache_key_prefix, to: SecondLevelCache
 
-      def acts_as_cached(options = {})
+      def second_level_cache(options = {})
         @second_level_cache_enabled = true
         @second_level_cache_options = options
-        @second_level_cache_options[:expires_in] ||= 1.week
         @second_level_cache_options[:version] ||= 0
+        @second_level_cache_options[:expires_in] ||= 1.week
         relation.class.send :prepend, SecondLevelCache::ActiveRecord::FinderMethods
         prepend SecondLevelCache::ActiveRecord::Core
       end
@@ -46,8 +46,15 @@ module SecondLevelCache
         @second_level_cache_enabled = old
       end
 
+      # Get MD5 digest of this Model schema
+      # http://api.rubyonrails.org/classes/ActiveRecord/Core/ClassMethods.html#method-i-inspect
       def cache_version
-        second_level_cache_options[:version]
+        return @cache_version if defined? @cache_version
+        # This line is copy from:
+        # https://github.com/rails/rails/blob/f9a5f48/activerecord/lib/active_record/core.rb#L236
+        attr_list = attribute_types.map { |name, type| "#{name}: #{type.type}" } * ', '
+        model_schema_digest = Digest::MD5.hexdigest(attr_list)
+        @cache_version = "#{second_level_cache_options[:version]}/#{model_schema_digest}"
       end
 
       def second_level_cache_key(id)

data/second_level_cache.gemspec

@@ -37,5 +37,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'database_cleaner', '~> 1.3.0'
-  gem.add_development_dependency 'rubocop', '~> 0.36.0'
+  gem.add_development_dependency 'rubocop'
 end

data/test/model/account.rb

@@ -6,6 +6,6 @@ ActiveRecord::Base.connection.create_table(:accounts, force: true) do |t|
 end
 
 class Account < ActiveRecord::Base
-  acts_as_cached expires_in: 3.days
+  second_level_cache expires_in: 3.days
   belongs_to :user
 end

data/test/model/animal.rb

@@ -5,9 +5,9 @@ ActiveRecord::Base.connection.create_table(:animals, force: true) do |t|
 end
 
 class Animal < ActiveRecord::Base
-  acts_as_cached
+  second_level_cache
 end
 
 class Dog < Animal
-  acts_as_cached
+  second_level_cache
 end

data/test/model/book.rb

@@ -6,7 +6,7 @@ ActiveRecord::Base.connection.create_table(:books, force: true) do |t|
 end
 
 class Book < ActiveRecord::Base
-  acts_as_cached
+  second_level_cache
 
   belongs_to :user, counter_cache: true
   has_many :images, as: :imagable

data/test/model/image.rb

@@ -5,7 +5,7 @@ ActiveRecord::Base.connection.create_table(:images, force: true) do |t|
 end
 
 class Image < ActiveRecord::Base
-  acts_as_cached
+  second_level_cache
 
   belongs_to :imagable, polymorphic: true, counter_cache: true
 end

data/test/model/post.rb

@@ -5,6 +5,6 @@ ActiveRecord::Base.connection.create_table(:posts, force: true) do |t|
 end
 
 class Post < ActiveRecord::Base
-  acts_as_cached
+  second_level_cache
   belongs_to :topic, touch: true
 end

data/test/model/topic.rb

@@ -6,7 +6,7 @@ ActiveRecord::Base.connection.create_table(:topics, force: true) do |t|
 end
 
 class Topic < ActiveRecord::Base
-  acts_as_cached
+  second_level_cache
 
   has_many :posts
 end

data/test/model/user.rb

@@ -1,6 +1,7 @@
 ActiveRecord::Base.connection.create_table(:users, force: true) do |t|
   t.text    :options
   t.text    :json_options
+  t.text    :extras
   t.string  :name, unique: true
   t.string  :email
   t.integer :status, default: 0
@@ -24,9 +25,12 @@ end
 
 class User < ActiveRecord::Base
   CACHE_VERSION = 3
+  second_level_cache(version: CACHE_VERSION, expires_in: 3.days)
+
   serialize :options, Array
   serialize :json_options, JSON if ::ActiveRecord::VERSION::STRING >= '4.1.0'
-  acts_as_cached(version: CACHE_VERSION, expires_in: 3.days)
+  store :extras, accessors: [:tagline, :gender]
+
   has_one  :account
   has_one  :forked_user_link, foreign_key: 'forked_to_user_id'
   has_one  :forked_from_user, through: :forked_user_link
@@ -39,7 +43,7 @@ class User < ActiveRecord::Base
 end
 
 class Namespace < ActiveRecord::Base
-  acts_as_cached version: 1, expires_in: 3.days
+  second_level_cache version: 1, expires_in: 3.days
 
   belongs_to :user
 end

data/test/record_marshal_test.rb

@@ -4,14 +4,17 @@ class RecordMarshalTest < ActiveSupport::TestCase
   def setup
     if ::ActiveRecord::VERSION::STRING >= '4.1.0'
       @json_options = { 'name' => 'Test', 'age' => 18, 'hash' => { 'name' => 'dup' } }
+      @extras = { 'tagline' => 'Hello world', 'gender' => 1 }
       @user = User.create name: 'csdn',
                           email: 'test@csdn.com',
                           options: [1, 2],
+                          extras: @extras,
                           json_options: @json_options,
                           status: :active
     else
       @user = User.create name: 'csdn',
                           email: 'test@csdn.com',
+                          extras: @extras,
                           options: [1, 2]
     end
   end
@@ -30,6 +33,9 @@ class RecordMarshalTest < ActiveSupport::TestCase
     assert_equal Array, User.read_second_level_cache(@user.id).reload.options.class
     assert_equal User.read_second_level_cache(@user.id).changed?, false
     assert_equal [1, 2], User.read_second_level_cache(@user.id).options
+    assert_equal @extras, User.read_second_level_cache(@user.id).extras
+    assert_equal 'Hello world', User.read_second_level_cache(@user.id).tagline
+    assert_equal 1, User.read_second_level_cache(@user.id).gender
     if ::ActiveRecord::VERSION::STRING >= '4.1.0'
       result = User.read_second_level_cache(@user.id)
       assert_equal @json_options['name'], result.json_options['name']

data/test/second_level_cache_test.rb

@@ -6,7 +6,10 @@ class SecondLevelCacheTest < ActiveSupport::TestCase
   end
 
   def test_should_get_cache_key
-    assert_equal "slc/users/#{@user.id}/#{User::CACHE_VERSION}", @user.second_level_cache_key
+    attr_list = User.attribute_types.map { |name, type| "#{name}: #{type.type}" } * ', '
+    table_digest = Digest::MD5.hexdigest(attr_list)
+    refute_nil table_digest
+    assert_equal "slc/users/#{@user.id}/#{User::CACHE_VERSION}/#{table_digest}", @user.second_level_cache_key
   end
 
   def test_should_write_and_read_cache

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: second_level_cache
 version: !ruby/object:Gem::Version
-  version: 2.2.6
+  version: 2.3.0.beta
 platform: ruby
 authors:
 - Hooopo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,16 +110,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: '0'
 description: Write Through and Read Through caching library inspired by CacheMoney
   and cache_fu, support  ActiveRecord 4.
 email:
@@ -184,9 +184,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1