active_model_cachers 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e51a19a8c47a1ea8bbdede0389a5768463081518ae322dba25155e1ce99eda9
-  data.tar.gz: 43c82003bf164a54f45ac022db12842e22da7eac45022e2f61a6a66779c243b3
+  metadata.gz: 21afadb49c4f398b05f590e42e2d68dc972c4156601327aba48b218b5bfce70f
+  data.tar.gz: c25d240a1b3c891ee31a191f72d8540e282724cc0638e79c3089cc17ada31dfc
 SHA512:
-  metadata.gz: 6e79837432ad52125b04f80761068dc366764e6ea944729f45bc2e2231629991645c6798369964f2adf27646c315e24190e31189cb349d3cad7fbb48813e3fbc
-  data.tar.gz: 2788c31af2ded6965ab755a72d8e0160421e7c4057d6c221d7b39485cc768a53ae1192ab4329e503b576de205e07ac4be6c546d628da993e54bbcf341a1adade
+  metadata.gz: 75634a849304a07c250dae3d82d9ff9eb579873b976482de1987e01b28f5cf95878edf53e3b83bc5eb794e7e1f31bf537018299a4d93bf4ba083dc74b4063403
+  data.tar.gz: 1b05f797d94393b3d95a3b172a3276808f5bd6f3088d168698e2aa4ce55588aa6c1d58a62afbd29ab45ad9bb2c12d08c472aae0f718f549a5470d2a8e7af9256

data/.travis.yml

@@ -1,22 +1,26 @@
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=02a53f73b72a95af756b1c0270d4b22a6f07d25a1c65048e341371e7b72671d9
 language: ruby
 rvm:
   - 2.2
   - 2.3
-sudo: required
-dist: trusty
-before_install: 
-  - gem install bundler
-  - gem update --system
-  - gem --version
 gemfile:
   - gemfiles/3.2.gemfile
   - gemfiles/4.2.gemfile
   - gemfiles/5.0.gemfile
   - gemfiles/5.1.gemfile
   - gemfiles/5.2.gemfile
-addons:
-    code_climate:
-        repo_token: 02a53f73b72a95af756b1c0270d4b22a6f07d25a1c65048e341371e7b72671d9
-after_success:
-  - bundle exec codeclimate-test-reporter
+before_install:
+  - gem install bundler
+  - gem update --system
+  - gem --version
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake test
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+## Change Log
+
+### [v2.1.0](https://github.com/khiav223577/active_model_cachers/compare/v2.0.3...v2.1.0) 2018/05/18
+- [#32](https://github.com/khiav223577/active_model_cachers/pull/32) Add test cases to test "store all data in hash" (@khiav223577)
+- [#31](https://github.com/khiav223577/active_model_cachers/pull/31) Change the syntax of getting self from cache (@khiav223577)
+- [#29](https://github.com/khiav223577/active_model_cachers/pull/29) test assigning association (@khiav223577)
+
+### [v2.0.3](https://github.com/khiav223577/active_model_cachers/compare/v2.0.2...v2.0.3) 2018/05/14
+- [#28](https://github.com/khiav223577/active_model_cachers/pull/28) No need to dump all association caches (@khiav223577)
+
+### [v2.0.2](https://github.com/khiav223577/active_model_cachers/compare/v2.0.1...v2.0.2) 2018/05/14
+- [#27](https://github.com/khiav223577/active_model_cachers/pull/27) [Fix] will send query even if has one association is cached (@khiav223577)
+
+### [v2.0.1](https://github.com/khiav223577/active_model_cachers/compare/v2.0.0...v2.0.1) 2018/05/13
+- [#26](https://github.com/khiav223577/active_model_cachers/pull/26) Prevent infinite loop if someone override default associations' method (@khiav223577)
+
+### v2.0.0 2018/05/13
+- [#25](https://github.com/khiav223577/active_model_cachers/pull/25) Support cache self by other column (@khiav223577)
+- [#24](https://github.com/khiav223577/active_model_cachers/pull/24) Support cleaning the cache manually (@khiav223577)
+- [#23](https://github.com/khiav223577/active_model_cachers/pull/23) use loaded model if possible to prevent extra queries (@khiav223577)
+- [#22](https://github.com/khiav223577/active_model_cachers/pull/22) Support caching result from outer service (@khiav223577)
+- [#21](https://github.com/khiav223577/active_model_cachers/pull/21) Support writing query in instance scope (@khiav223577)
+- [#20](https://github.com/khiav223577/active_model_cachers/pull/20) instance cacher (@khiav223577)
+- [#19](https://github.com/khiav223577/active_model_cachers/pull/19) Pass model to `delete` method to prevent an extra query (@khiav223577)
+- [#18](https://github.com/khiav223577/active_model_cachers/pull/18) [Test] show all sql queries if query count doesn't equal to expected count. (@khiav223577)
+- [#17](https://github.com/khiav223577/active_model_cachers/pull/17) Support cache at has_many association II - add test cases (@khiav223577)
+- [#16](https://github.com/khiav223577/active_model_cachers/pull/16) Support cache at has_many association I (@khiav223577)
+- [#15](https://github.com/khiav223577/active_model_cachers/pull/15) Adjust file structures (@khiav223577)
+- [#14](https://github.com/khiav223577/active_model_cachers/pull/14) Support cache at belongs_to association (@khiav223577)
+- [#13](https://github.com/khiav223577/active_model_cachers/pull/13) Fix that cache not cleaned if foreign_key is not `id` and calling `mode.delete` (@khiav223577)
+- [#12](https://github.com/khiav223577/active_model_cachers/pull/12) [Refactor] move the active_record extension to proper directory (@khiav223577)
+- [#11](https://github.com/khiav223577/active_model_cachers/pull/11) Fix id problem by specify foreign_key manually (@khiav223577)
+- [#10](https://github.com/khiav223577/active_model_cachers/pull/10) cache on falsy result (@khiav223577)
+- [#9](https://github.com/khiav223577/active_model_cachers/pull/9) Fix that all models cache with same id will be cleaned if any of one is cleaned (@khiav223577)
+- [#8](https://github.com/khiav223577/active_model_cachers/pull/8)  allow developer to specify whether the cache should expire (@khiav223577)
+- [#7](https://github.com/khiav223577/active_model_cachers/pull/7) custom query which allow you to specify how to expire the cache by `expire_by` option (@khiav223577)
+- [#6](https://github.com/khiav223577/active_model_cachers/pull/6) test cache self (@khiav223577)
+- [#5](https://github.com/khiav223577/active_model_cachers/pull/5) Deal with delete, dependent: :delete that do not fire after_commit callback (@khiav223577)
+- [#4](https://github.com/khiav223577/active_model_cachers/pull/4) split test cases to several files and refactor the code (@khiav223577)
+- [#3](https://github.com/khiav223577/active_model_cachers/pull/3) Safer cache mechanism: Prevent cache from being left over if someone forgets to write `cache_self` (@khiav223577)
+- [#2](https://github.com/khiav223577/active_model_cachers/pull/2) Adjust usage (@khiav223577)
+- [#1](https://github.com/khiav223577/active_model_cachers/pull/1) use after_commit hook to expire cached associations  (@khiav223577)

data/README.md

@@ -6,7 +6,7 @@
 [![Code Climate](https://codeclimate.com/github/khiav223577/active_model_cachers/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/active_model_cachers)
 [![Test Coverage](https://codeclimate.com/github/khiav223577/active_model_cachers/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/active_model_cachers/coverage)
 
-Provide cachers to the model so that you could specify which you want to cache. Data will be cached at `Rails.cache` and also at application level via `RequestStore` to cache values between requests. Cachers will maintain cached objects and expire them when they are changed (by create, update, destroy, and even delete).
+Provide cachers to the model so that you could specify which you want to cache. Data will be cached at `Rails.cache` and also at application level via `RequestStore` to cache values between requests. Cachers will maintain cached objects and expire them when they are changed (including create, update, destroy, and even delete).
 
 - [Multi-level Cache](#multi-level-cache)
 - Do not pollute original ActiveModel API.
@@ -14,6 +14,14 @@ Provide cachers to the model so that you could specify which you want to cache.
 - High test coverage
 
 
+## Compare with [identity_cache](https://github.com/Shopify/identity_cache)
+
+`active_model_cachers` allows you to specify what to cache and when to expire those caches. So that you could cache raw sql query results, time-consuming methods, responses of requests, and so on. It also supports AR associations / attibutes (has_many, has_one, belongs_to) and secondary indexes.
+
+`identity_cache` focuses on AR, and doesn't have the flexibility to specify the query. It has more features for caching AR associations / attibutes, such as caching attibutes by multiple keys, embedding associations to load data in one fetch, non-unique secondary indexes, and caching polymorphic associations, etc.
+
+There is also a difference worths mentioning, `active_model_cachers` encapsulates methods to `cacher`, while `identity_cache` adds a number of `fetch_*` method to `AR` directly. Therefore, it's more possible to have method name collision.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -74,7 +82,7 @@ You could access the cached data by calling `active_count` method on the cacher,
 ```rb
 class User < ActiveRecord::Base
   scope :active, ->{ where('last_login_at > ?', 7.days.ago) }
-  cache_at :active_count, ->{ User.active.count }, expire_by: 'User#last_login_at'
+  cache_at :active_count, ->{ active.count }, expire_by: 'User#last_login_at'
 end
 
 @count = User.cacher.active_count
@@ -88,7 +96,7 @@ In this example, the cache should be cleaned on user `destroyed`, or new user `c
 
 ```rb
 class User < ActiveRecord::Base
-  cache_at :count, ->{ User.count }, expire_by: 'User', on: [:create, :destroy]
+  cache_at :count, ->{ count }, expire_by: 'User', on: [:create, :destroy]
 end
 
 @count = User.cacher.count
@@ -151,7 +159,7 @@ One of the solution is that you could store a lookup table into cache, so that o
 
 ```rb
 class Skill < ActiveRecord::Base
-  cache_at :atk_powers, ->{ Skill.pluck(:id, :atk_power).to_h }, expire_by: 'Skill#atk_power'
+  cache_at :atk_powers, ->{ pluck(:id, :atk_power).to_h }, expire_by: 'Skill#atk_power'
 end
 
 # This will retrieve the data from cache servers only 1 times.
@@ -234,10 +242,6 @@ end
 @profile = User.cacher_at(user_id).profile
 ```
 
-### Caching Polymorphic Associations
-
-TODO
-
 ### Caching Self
 
 Cache self by id.
@@ -324,6 +328,15 @@ This option is needed to know which attribute should be passed to the parameter
 
   - Default value is `:id`
 
+## Future works
+
+- [ ] caching polymorphic associations
+- [ ] non-unique secondary indexes
+- [ ] caching attibutes by multiple keys
+- [ ] testing counter cache
+- [ ] testing has_many through
+- [ ] testing has_and_belongs_to_many
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/active_model_cachers.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["khiav reoy"]
   spec.email         = ["mrtmrt15xn@yahoo.com.tw"]
 
-  spec.summary       = %q{Let you cache whatever you want with ease by providing cachers to active model. Support Rails 3, 4, 5.}
-  spec.description   = %q{Let you cache whatever you want with ease by providing cachers to active model. Cachers will maintain cached objects and expire them when they are changed (by create, update, destroy, and even delete). Support Rails 3, 4, 5.}
+  spec.summary       = %q{Simply cache whatever you want by using cachers. Support Rails 3, 4, 5.}
+  spec.description   = %q{Simply cache whatever you want by using cachers which will help you maintain cached objects and expire them when they are changed. Support Rails 3, 4, 5.}
   spec.homepage      = "https://github.com/khiav223577/active_model_cachers"
   spec.license       = "MIT"
 

data/gemfiles/3.2.gemfile

@@ -5,7 +5,6 @@ gem "request_store", "~> 1.4.0"
 
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
 end
 
 gemspec :path => "../"

data/gemfiles/4.2.gemfile

@@ -5,7 +5,6 @@ gem "request_store", "~> 1.4.0"
 
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
 end
 
 gemspec :path => "../"

data/gemfiles/5.0.gemfile

@@ -5,7 +5,6 @@ gem "request_store", "~> 1.4.0"
 
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
 end
 
 gemspec :path => "../"

data/gemfiles/5.1.gemfile

@@ -5,7 +5,6 @@ gem "request_store", "~> 1.4.0"
 
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
 end
 
 gemspec :path => "../"

data/gemfiles/5.2.gemfile

@@ -5,7 +5,6 @@ gem "request_store", "~> 1.4.0"
 
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
 end
 
 gemspec :path => "../"

data/lib/active_model_cachers/active_record/extension.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'active_model_cachers/column_value_cache'
 require 'active_model_cachers/active_record/attr_model'
 require 'active_model_cachers/active_record/cacher'
 require 'active_model_cachers/hook/dependencies'
@@ -21,13 +20,11 @@ module ActiveModelCachers
         service_klass = CacheServiceFactory.create_for_active_model(attr, query)
         Cacher.define_cacher_method(attr, attr.primary_key || :id, [service_klass])
 
-        with_id = true if expire_by.is_a?(Symbol) or query.parameters.size == 1
-        expire_class, expire_column, foreign_key = get_expire_infos(attr, expire_by, foreign_key)
-        if expire_class
-          define_callback_for_cleaning_cache(expire_class, expire_column, foreign_key, on: on) do |id|
-            service_klass.clean_at(with_id ? id : nil)
-          end
+        if (infos = get_expire_infos(attr, expire_by, foreign_key))
+          with_id = (expire_by.is_a?(Symbol) || query.parameters.size == 1)
+          service_klass.define_callback_for_cleaning_cache(*infos, with_id, on: on)
         end
+
         return service_klass
       end
 
@@ -72,33 +69,6 @@ module ActiveModelCachers
           service_klasses << cache_self
         end
       end
-
-      @@column_value_cache = ActiveModelCachers::ColumnValueCache.new
-      def define_callback_for_cleaning_cache(class_name, column, foreign_key, on: nil, &clean)
-        ActiveSupport::Dependencies.onload(class_name) do
-          clean_ids = []
-
-          prepend_before_delete do |id, model|
-            clean_ids << @@column_value_cache.add(self, class_name, id, foreign_key, model)
-          end
-
-          before_delete do |_, model|
-            clean_ids.each{|s| clean.call(s.call) }
-            clean_ids = []
-          end
-
-          after_delete do
-            @@column_value_cache.clean_cache()
-          end
-
-          on_nullify(column){|ids| ids.each{|s| clean.call(s) }}
-
-          after_commit ->{
-            changed = column ? previous_changes.key?(column) : previous_changes.present?
-            clean.call(send(foreign_key)) if changed || destroyed?
-          }, on: on
-        end
-      end
     end
   end
 end

data/lib/active_model_cachers/cache_service.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'active_model_cachers/nil_object'
 require 'active_model_cachers/false_object'
+require 'active_model_cachers/column_value_cache'
 
 module ActiveModelCachers
   class CacheService
@@ -16,6 +17,40 @@ module ActiveModelCachers
       def clean_at(id)
         instance(id).clean_cache
       end
+
+      @@column_value_cache = ActiveModelCachers::ColumnValueCache.new
+      def define_callback_for_cleaning_cache(class_name, column, foreign_key, with_id, on: nil)
+        return if @callbacks_defined
+        @callbacks_defined = true
+
+        clean = ->(id){ clean_at(with_id ? id : nil) }
+
+        ActiveSupport::Dependencies.onload(class_name) do
+          clean_ids = []
+
+          prepend_before_delete do |id, model|
+            clean_ids << @@column_value_cache.add(self, class_name, id, foreign_key, model)
+          end
+
+          before_delete do |_, model|
+            clean_ids.each{|s| clean.call(s.call) }
+            clean_ids = []
+          end
+
+          after_delete do
+            @@column_value_cache.clean_cache
+          end
+
+          on_nullify(column){|ids| ids.each{|s| clean.call(s) }}
+
+          after_commit ->{
+            changed = column ? previous_changes.key?(column) : previous_changes.present?
+            clean.call(send(foreign_key)) if changed || destroyed?
+          }, on: on
+
+          after_touch ->{ clean.call(send(foreign_key)) }
+        end
+      end
     end
 
     # ----------------------------------------------------------------

data/lib/active_model_cachers/cache_service_factory.rb

@@ -22,6 +22,7 @@ module ActiveModelCachers
           klass = Class.new(CacheService)
           klass.cache_key = cache_key
           klass.query = query
+          klass.instance_variable_set(:@callbacks_defined, false) # to remove warning: instance variable @callbacks_defined not initialized
           next klass
         }[]
       end

data/lib/active_model_cachers/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ActiveModelCachers
-  VERSION = "2.1.0"
+  VERSION = '2.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_cachers
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,9 +94,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-description: Let you cache whatever you want with ease by providing cachers to active
-  model. Cachers will maintain cached objects and expire them when they are changed
-  (by create, update, destroy, and even delete). Support Rails 3, 4, 5.
+description: Simply cache whatever you want by using cachers which will help you maintain
+  cached objects and expire them when they are changed. Support Rails 3, 4, 5.
 email:
 - mrtmrt15xn@yahoo.com.tw
 executables: []
@@ -105,6 +104,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
@@ -155,6 +155,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Let you cache whatever you want with ease by providing cachers to active
-  model. Support Rails 3, 4, 5.
+summary: Simply cache whatever you want by using cachers. Support Rails 3, 4, 5.
 test_files: []