ar_cache 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09eeda930c7263476f3b09e53747f9ec87ac070e65f18031856cdb05ad57a083'
-  data.tar.gz: 425c321debdcc05d81d4c0815abecb0d9e19fa417bb251265ba6dab420dd03e1
+  metadata.gz: a01b3342ccad3bf06ce4438f714f00ffc467efc32f58809ab940163ebaf440d7
+  data.tar.gz: 453c9232cbc03dee8572b1133972f01d6dd1c2501df0c9279a32a5e4243ebeb0
 SHA512:
-  metadata.gz: 827f0ecdf9e583870a454c16cfaa44c95b9d7b0ba4f3942097daf1c76fed218adfdafcd5733b68fa6476297c8b6d35c728e1a1b6f66db615d9fde834183ea4e8
-  data.tar.gz: 273bef3daea68391d681045c384488bf9266a1f75cd5ea7057b6aaf70928ebe97934cb65daadf3f6a3442177d948923116867be503f479c6ac8ab06ac23bb286
+  metadata.gz: 7d6a3bb90d4ac0eb3384650fd17fbed43be74da2ca0a57b55c9d19b9c68722b2d23785fd42e00cbdec8a4563cc10c6c44ac7609a8b4a09d9b4a813f47c3f2ae1
+  data.tar.gz: 2105bf0e6e89c3d438f30b43bef1dd64b66b511968fec5c393068043ddb52ee833762f0508a4a84d25940ddac36c686c8b5fd4e6ef73d75802de878645ac265b

data/CHANGELOG.md

@@ -2,12 +2,20 @@
 
 ## main
 
-## 1.0.0 (2021-03-02)
+## 1.2.0 (2021-03-12)
 
-- Initial version.
+[Commit [#c830907](https://github.com/OuYangJinTing/ar_cache/commit/c830907595b7d1d46a2f29204ee6051ecc3ff30c)]:
+
+- Remove methods: `ArCache::MockTable#enabled?`, `ArCache::MockTable#select_enabled?`, `ArCache::Table.enabled?`, `ArCache::Table.select_enabled?`, `ActiveRecord::Relation#skip_ar_cache`.
+- Rename methods: `ArCache#skip_cache? => ArCache#skip?`, `ArCache#skip_cache => ArCache#skip`, `ArCache#pre_expire? => ArCache#expire?`, `ArCache#pre_expire => ArCache#expire`.
+- Now, `ArCache#skip` method only skip read cache, but still try delete cache.
 
 ## 1.1.0 (2021-03-11)
 
-- Fully automatic delete cache when call delete_all/update_all method.
-- Optimize has_one(through:) cache implementation.
-- ActiveRecord::Relation#reload and ActiveRecord::Associations::Association#reload should skip read cache if associated target is already loaded.
+- [Commit [#92965d2](https://github.com/OuYangJinTing/ar_cache/commit/92965d26e130da9a13bd52ea31f3f668851f6f12)] Fully automatic delete cache when call delete_all/update_all method.
+- [Commit [#231cfd3](https://github.com/OuYangJinTing/ar_cache/commit/231cfd35c2c197bf41628f4f914ba39fb8debd81)] Optimize has_one(through:) cache implementation.
+- [Commit [#ce5444c](https://github.com/OuYangJinTing/ar_cache/commit/ce5444c8c4ec0a61bec5e07d694295d3cc5decf8)]  ActiveRecord::Relation#reload and ActiveRecord::Associations::Association#reload should skip read cache if associated target is already loaded.
+
+## 1.0.0 (2021-03-02)
+
+- Initial version.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ar_cache (1.1.0)
+    ar_cache (1.2.0)
       activerecord (>= 6.1, < 7)
 
 GEM

data/README.md

@@ -55,17 +55,31 @@ rake db:migrate
 
 Skip cache:
 
+- `ArCache#skip`, eg:
+
+```ruby
+# All queries in the block will not use the cache.
+ArCache.skip { User.find(1) }
+```
+
 - `ActiveRecord::Persistence#reload`, eg:
 
 ```ruby
 User.find(1).reload
 ```
 
-- `ActiveRecord::Relation#skip_ar_cache`, eg:
+- `ActiveRecord::Relation#reload`, eg:
+
+```ruby
+# When reload is called after the associated target has been loaded, the cache will be skipped.
+User.where(id: 1).load.reload
+```
+
+- `ActiveRecord::Associations::Association#reload`, eg:
 
 ```ruby
-User.skip_ar_cache.find(1)
-User.where(id: [1, 2]).skip_ar_cache.load
+# When reload is called after the associated target has been loaded, the cache will be skipped.
+user.association(:account).load_target.reload
 ```
 
 Delete cache:
@@ -91,7 +105,7 @@ If all the following conditions are met, ArCache will try to read the cache:
 - No call `#select` or select value is table column.
 - No call `#order` or order value is table column and only one.
 - No call `#limit` or value of the unique index isn't array.
-- No call `#joins`, `#left_joins`, `#skip_query_cache!`, `#skip_ar_cache`, `#explain`, `#from`, `#group`, `#offset`, `#lock`
+- No call `#joins`, `#left_joins`, `#skip_query_cache!`, `#explain`, `#from`, `#group`, `#offset`, `#lock`
 - ...
 
 **Cacheable example:**

data/lib/ar_cache.rb

@@ -23,26 +23,26 @@ module ArCache
   class << self
     delegate :configure, to: Configuration
 
-    def skip_cache?
-      Thread.current[:ar_cache_skip_cache]
+    def skip?
+      Thread.current[:ar_cache_skip]
     end
 
-    def skip_cache
-      Thread.current[:ar_cache_skip_cache] = true
+    def skip
+      Thread.current[:ar_cache_skip] = true
       yield
     ensure
-      Thread.current[:ar_cache_skip_cache] = false
+      Thread.current[:ar_cache_skip] = false
     end
 
-    def pre_expire?
-      Thread.current[:ar_cache_pre_expire]
+    def expire?
+      Thread.current[:ar_cache_expire]
     end
 
-    def pre_expire
-      Thread.current[:ar_cache_pre_expire] = true
+    def expire
+      Thread.current[:ar_cache_expire] = true
       yield
     ensure
-      Thread.current[:ar_cache_pre_expire] = false
+      Thread.current[:ar_cache_expire] = false
     end
   end
 end

data/lib/ar_cache/active_record/associations/association.rb

@@ -5,7 +5,7 @@ module ArCache
     module Associations
       module Association
         def reload(...)
-          loaded? ? ArCache.skip_cache { super } : super
+          loaded? ? ArCache.skip { super } : super
         end
       end
     end

data/lib/ar_cache/active_record/associations/has_one_through_association.rb

@@ -4,7 +4,8 @@ module ArCache
   module ActiveRecord
     module Associations
       module HasOneThroughAssociation
-        private def find_target
+        private def find_target # rubocop:disable Metrics/CyclomaticComplexity
+          return super if ArCache.skip?
           return super if reflection.klass.ar_cache_table.disabled?
           return super if reflection.through_reflection.klass.ar_cache_table.disabled?
 

data/lib/ar_cache/active_record/associations/singular_association.rb

@@ -5,10 +5,12 @@ module ArCache
     module Associations
       module SingularAssociation
         private def skip_statement_cache?(...)
+          return super if ArCache.skip?
+
           # Polymorphic associations do not support computing the class, so can't judge ArCache status.
           # But SingularAssociation query usually can hit the unique index, so here return true directly.
           return true if is_a?(::ActiveRecord::Associations::BelongsToPolymorphicAssociation)
-          return true if reflection.klass.ar_cache_table.enabled?
+          return true unless reflection.klass.ar_cache_table.disabled?
 
           super
         end

data/lib/ar_cache/active_record/connection_adapters/abstract/database_statements.rb

@@ -46,24 +46,24 @@ module ArCache
         end
 
         private def update_ar_cache_by_arel(arel)
-          return if ArCache.pre_expire?
+          return if ArCache.expire?
 
           arel_table = arel.ast.relation.is_a?(Arel::Table) ? arel.ast.relation : arel.ast.relation.left
           klass = arel_table.instance_variable_get(:@klass)
-          current_transaction.update_ar_cache_table(klass.ar_cache_table) if klass.ar_cache_table.enabled?
+          current_transaction.update_ar_cache_table(klass.ar_cache_table) unless klass.ar_cache_table.disabled?
         end
 
         private def update_ar_cache_by_sql(sql)
           sql = sql.downcase
 
           ArCache::Table.all.each do |table|
-            current_transaction.update_ar_cache_table(table) if table.enabled? && sql.include?(table.name)
+            current_transaction.update_ar_cache_table(table) if !table.disabled? && sql.include?(table.name)
           end
         end
 
         private def update_ar_cache_by_table(table_name)
           ArCache::Table.all.each do |table|
-            current_transaction.update_ar_cache_table(table) if table.enabled? && table_name.casecmp?(table.name)
+            current_transaction.update_ar_cache_table(table) if !table.disabled? && table_name.casecmp?(table.name)
           end
         end
       end

data/lib/ar_cache/active_record/core.rb

@@ -4,16 +4,14 @@ module ArCache
   module ActiveRecord
     module Core
       module ClassMethods
-        delegate :skip_ar_cache, to: :all
-
         # The #find use statement cache execute querying first, so need force skip.
         def find(...)
-          ar_cache_table.enabled? ? all.find(...) : super
+          ArCache.skip? || ar_cache_table.disabled? ? super : all.find(...)
         end
 
         # The #find_by use statement cache execute querying first, so need force skip.
         def find_by(...)
-          ar_cache_table.enabled? ? all.find_by(...) : super
+          ArCache.skip? || ar_cache_table.disabled? ? super : all.find_by(...)
         end
       end
     end

data/lib/ar_cache/active_record/persistence.rb

@@ -5,14 +5,14 @@ module ArCache
     module Persistence
       module ClassMethods
         def _update_record(_, constraints)
-          ArCache.pre_expire do
+          ArCache.expire do
             delete_ar_cache_key(constraints[@primary_key])
             super
           end
         end
 
         def _delete_record(constraints)
-          ArCache.pre_expire do
+          ArCache.expire do
             delete_ar_cache_key(constraints[@primary_key])
             super
           end
@@ -26,7 +26,7 @@ module ArCache
       end
 
       def reload(...)
-        ArCache.skip_cache { super }
+        ArCache.skip { super }
       end
     end
   end

data/lib/ar_cache/active_record/relation.rb

@@ -4,25 +4,19 @@ module ArCache
   module ActiveRecord
     module Relation
       def reload
-        @skip_ar_cache = true if loaded?
-        super
-      end
-
-      def skip_ar_cache
-        tap { @skip_ar_cache = true }
+        loaded? ? ArCache.skip { super } : super
       end
 
       def explain
-        @skip_ar_cache = true
-        super
+        ArCache.skip { super }
       end
 
       def update_all(...)
-        ArCache.pre_expire { delete_ar_cache_keys ? super : 0 }
+        ArCache.expire { delete_ar_cache_keys ? super : 0 }
       end
 
       def delete_all
-        ArCache.pre_expire { delete_ar_cache_keys ? super : 0 }
+        ArCache.expire { delete_ar_cache_keys ? super : 0 }
       end
 
       private def delete_ar_cache_keys
@@ -43,7 +37,7 @@ module ArCache
       end
 
       private def exec_queries(&block)
-        @skip_ar_cache ? super : ArCache::Query.new(self).exec_queries(&block).freeze
+        ArCache.skip? ? super : ArCache::Query.new(self).exec_queries(&block).freeze
       end
     end
   end

data/lib/ar_cache/mock_table.rb

@@ -7,18 +7,10 @@ module ArCache
         true
       end
 
-      def enabled?
-        false
-      end
-
       def select_disabled?
         true
       end
 
-      def select_enabled?
-        false
-      end
-
       def version
         -1
       end

data/lib/ar_cache/query.rb

@@ -12,7 +12,7 @@ module ArCache
 
     def exec_queries(&block) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       return [] if relation.where_clause.contradiction?
-      return relation.skip_ar_cache.send(:exec_queries, &block) unless exec_queries_cacheable?
+      return ArCache.skip { relation.send(:exec_queries, &block) } unless exec_queries_cacheable?
 
       records = table.read(where_clause, @select_values, &block)
 

data/lib/ar_cache/record.rb

@@ -4,10 +4,8 @@ module ArCache
   class Record < ActiveRecord::Base # rubocop:disable Rails/ApplicationRecord
     self.table_name = 'ar_cache_records'
 
-    default_scope { skip_ar_cache }
-
     def self.get(table_name)
-      find_by(table_name: table_name)
+      ArCache.skip { find_by(table_name: table_name) }
     end
 
     def self.version(table)

data/lib/ar_cache/table.rb

@@ -43,21 +43,13 @@ module ArCache
     end
 
     def disabled?
-      @disabled || ArCache.skip_cache?
-    end
-
-    def enabled?
-      !disabled?
+      @disabled
     end
 
     def select_disabled?
       @select_disabled
     end
 
-    def select_enabled?
-      !@select_disabled
-    end
-
     def version
       version = ArCache::Store.read(cache_key_prefix)
       unless version

data/lib/ar_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ArCache
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_cache
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - OuYangJinTing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord