ar_cache 1.2.0 → 2.1.0

data/lib/ar_cache/version.rb

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

data/lib/ar_cache/where_clause.rb

@@ -8,7 +8,14 @@ module ArCache
       @klass = klass
       @table = klass.ar_cache_table
       @predicates = predicates
-      @missed_values = []
+    end
+
+    def missed_values
+      @missed_values ||= []
+    end
+
+    def invalid_keys
+      @invalid_keys ||= []
     end
 
     def cacheable?
@@ -24,8 +31,8 @@ module ArCache
         count = 0
 
         bool = index.all? do |column|
-          where_values_hash[column].tap do |value|
-            if value.is_a?(Array)
+          (Thread.current[:ar_cache_reflection] ? where_values_hash.key?(column) : where_values_hash[column]).tap do
+            if where_values_hash[column].is_a?(Array)
               @multi_values_key = column
               count += 1
             end
@@ -52,15 +59,15 @@ module ArCache
       @cache_hash = {}
       multi_values_key = @multi_values_key || @index.first
 
-      Array(where_values_hash[multi_values_key]).each do |v|
+      Array.wrap(where_values_hash[multi_values_key]).each do |v|
         @cache_hash[table.cache_key(where_values_hash, @index, multi_values_key, v)] = v
       end
 
       return @cache_hash if primary_key_index?
 
       @original_cache_hash = @cache_hash
-      @cache_hash = ArCache::Store.read_multi(@cache_hash.keys)
-      @original_cache_hash.each { |k, v| @missed_values << v unless @cache_hash.key?(k) }
+      @cache_hash = ArCache.read_multi(*@cache_hash.keys, raw: true)
+      @original_cache_hash.each { |k, v| missed_values << v unless @cache_hash.key?(k) }
       @cache_hash = @cache_hash.invert
 
       @cache_hash
@@ -73,26 +80,28 @@ module ArCache
     end
 
     def missed_hash
-      @missed_hash ||= @missed_values.empty? ? {} : { (@multi_values_key || @index.first) => @missed_values }
+      @missed_hash ||= missed_values.empty? ? {} : { (@multi_values_key || @index.first) => missed_values }
     end
 
     def add_missed_values(key)
       if primary_key_index?
-        @missed_values << cache_hash[key]
+        missed_values << cache_hash[key]
       else
-        @missed_values << @original_cache_hash[cache_hash[key]]
+        missed_values << @original_cache_hash[cache_hash[key]]
       end
     end
 
-    def add_invalid_keys(key)
-      @invalid_keys ||= []
-      @invalid_keys << key
-      @invalid_keys << cache_hash[key] unless primary_key_index?
-      @invalid_keys
+    def add_blank_primary_cache_key(key)
+      invalid_keys << key
+    end
+
+    def add_invalid_second_cache_key(key)
+      # invalid_keys << key # The primary key index is reliable.
+      invalid_keys << cache_hash[key] unless primary_key_index?
     end
 
     def delete_invalid_keys
-      ArCache::Store.delete_multi(@invalid_keys) if @invalid_keys
+      ArCache.delete_multi(invalid_keys) if invalid_keys.any?
     end
 
     # This module is based on ActiveRecord::Relation::WhereClause modified
@@ -100,13 +109,10 @@ module ArCache
       def where_values_hash
         @where_values_hash ||= equalities(predicates).each_with_object({}) do |node, hash|
           # Don't support Arel::Nodes::NamedFunction.
-          # But we don't judge it, because it will raise exception if it is Arel::Nodes::NamedFunction object.
           next if table.name != node.left.relation.name
 
           name = node.left.name.to_s
           value = extract_node_value(node.right)
-          next if value.respond_to?(:size) && value.size > ArCache::Configuration.index_column_max_size
-
           hash[name] = value
         end
       rescue NoMethodError, ActiveModel::RangeError
@@ -133,15 +139,18 @@ module ArCache
       end
 
       private def extract_node_value(node)
-        value = case node
-                when Array
-                  node.map { |v| extract_node_value(v) }
-                when Arel::Nodes::BindParam
-                  node.value.value_for_database # Maybe raise ActiveModel::RangeError
-                when Arel::Nodes::Casted, Arel::Nodes::Quoted
-                  node.value_for_database # Maybe raise ActiveModel::RangeError
-                end
+        case node
+        when Array
+          node.map { |v| extract_node_value(v) }
+        when Arel::Nodes::BindParam
+          value_for_database(node.value)
+        when Arel::Nodes::Casted, Arel::Nodes::Quoted
+          value_for_database(node)
+        end
+      end
 
+      private def value_for_database(node)
+        value = node.value_for_database # Maybe raise ActiveModel::RangeError
         value.is_a?(Date) ? value.to_s : value
       end
     end

data/lib/generators/ar_cache/install_generator.rb

@@ -1,21 +1,14 @@
 # frozen_string_literal: true
 
 require 'rails/generators'
-require 'rails/generators/migration'
-require 'rails/generators/active_record/migration'
 
 module ArCache
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-      include ::ActiveRecord::Generators::Migration
-
       source_root File.expand_path('templates', __dir__)
 
       def copy_initializer_file
         copy_file 'configuration.rb', 'config/initializers/ar_cache.rb'
-
-        migration_template 'migrate/create_ar_cache_records.rb', 'db/migrate/create_ar_cache_records.rb'
       end
     end
   end

data/lib/generators/ar_cache/templates/configuration.rb

@@ -2,33 +2,33 @@
 
 # For more information, please see: https://github.com/OuYangJinTing/ar_cache/README.md
 ArCache.configure do |config|
-  # WARNING: The should uncomment only when your database default isolation level is "READ UNCOMMITTED"!
-  # config.read_uncommitted = true # defaul false
-
-  # config.cache_store = ActiveSupport::Cache::Store # default Rails.cache || ActiveSupport::Cache::MemoryStore.new
-
-  # Cache key automatic expiration time.
-  # config.expires_in = Numeric # default 1 week
-
-  # Serialize and deserialize cached data.
-  # config.coder = [YAML|JSON] # default YAML
-
-  # Support the maximum length of index column value.
-  # config.index_column_max_size = Integer # default 64
-
-  # ArCache switch.
-  # config.disabled = Boolean # default false
-
-  # Whether to support selecct columns query
-  # config.select_disabled = Boolean # default true
-
-  # config.tables_options = {
-  #   table_name: {
-  #     disabled: Boolean,
-  #     select_disabled: Boolean,
-  #     unique_indexes: Array # eg: [:id, [:name, :statue]], The default is the unique index column of the table.
-  #     ignored_columns: Array # eg: [:created_at, :updated_at], defaule [].
-  #   },
-  #   ...
-  # }
+  # The cache tool. It must be an instance of ActiveSupport::Cache::Store.
+  config.cache_store = defined?(Rails) ? Rails.cache : ActiveSupport::Cache::MemoryStore.new
+
+  # NOTE: Please use cache lock if it casue database happened dead lock.
+  # ArCache default use database share lock('FOR SHARE' or 'LOCK IN SHARE MODE') to ensure that the cache is correct.
+  # You can customize the lock statement, if your database don't support lock (eg: SQLite3), please use cache lock.
+  # config.lock_statement = 'custom lock statement'
+
+  # WARNING: If the cache store is not Redis nor Memcached, the cache lock may be unreliable.
+  config.cache_lock = false # Boolean
+
+  # The cache key valid time.
+  config.expires_in = 1.week # Integer
+
+  # ArCache switch (default).
+  config.disabled = false # Boolean
+
+  # Whether to support select column sql (default)..
+  config.select_disabled = true # Boolean
+
+  # WARNING: If you use database lock, you should not custom unique index, otherwise may be happen lock table.
+  config.tables_options = {
+    # table_name: { # Database's table name.
+    #   disabled: Boolean, # sArCache switch.
+    #   select_disabled: Boolean, # Whether to support select column sql.
+    #   unique_indexes: Array # eg: [:id, [:name, :statue]], The default is the unique index column of the table.
+    # },
+    # ...
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_cache
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.0
 platform: ruby
 authors:
 - OuYangJinTing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 description: An modern cacheing library for ActiveRecord inspired by cache-money and
   second_level_cache.
 email:
@@ -48,6 +68,7 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- README.zh-CN.md
 - Rakefile
 - ar_cache.gemspec
 - bin/activerecord-test
@@ -72,14 +93,11 @@ files:
 - lib/ar_cache/marshal.rb
 - lib/ar_cache/mock_table.rb
 - lib/ar_cache/query.rb
-- lib/ar_cache/record.rb
-- lib/ar_cache/store.rb
 - lib/ar_cache/table.rb
 - lib/ar_cache/version.rb
 - lib/ar_cache/where_clause.rb
 - lib/generators/ar_cache/install_generator.rb
 - lib/generators/ar_cache/templates/configuration.rb
-- lib/generators/ar_cache/templates/migrate/create_ar_cache_records.rb.tt
 homepage: https://github.com/OuYangJinTing/ar_cache
 licenses:
 - MIT

data/lib/ar_cache/record.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module ArCache
-  class Record < ActiveRecord::Base # rubocop:disable Rails/ApplicationRecord
-    self.table_name = 'ar_cache_records'
-
-    def self.get(table_name)
-      ArCache.skip { find_by(table_name: table_name) }
-    end
-
-    def self.version(table)
-      (get(table.name) || store(table)).version
-    end
-
-    def self.update_version(table)
-      record = get(table.name)
-      return store(table).version unless record
-
-      record.update_version
-      record.version
-    end
-
-    def self.store(table)
-      record = get(table.name) || new(table_name: table.name)
-      record.store(table)
-      record
-    end
-
-    def store(table)
-      with_optimistic_retry do
-        self.version += 1 unless table_md5 == table.md5
-        self.table_md5 = table.md5
-
-        save! if changed?
-      end
-    end
-
-    def update_version
-      with_optimistic_retry do
-        self.version += 1
-        save!
-      end
-    end
-
-    private def with_optimistic_retry
-      yield
-    rescue ::ActiveRecord::StaleObjectError
-      reload
-      retry
-    end
-  end
-end

data/lib/ar_cache/store.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module ArCache
-  class Store
-    @options = { raw: true, expires_in: ArCache::Configuration.expires_in }.freeze
-
-    class << self
-      delegate :delete, :delete_multi, :clear, :exist?, to: 'ArCache::Configuration.cache_store'
-
-      def write(name, value)
-        ArCache::Configuration.cache_store.write(name, dump(value), @options)
-      end
-
-      def write_multi(hash)
-        hash.each { |k, v| hash[k] = dump(v) }
-        ArCache::Configuration.cache_store.write_multi(hash, @options)
-      end
-
-      def read(name)
-        load(ArCache::Configuration.cache_store.read(name, @options))
-      end
-
-      def read_multi(names)
-        entries = ArCache::Configuration.cache_store.read_multi(*names, @options)
-        entries.each { |k, v| entries[k] = load(v) }
-        entries
-      end
-
-      private def dump(value)
-        ArCache::Configuration.coder.dump(value)
-      end
-
-      private def load(value)
-        ArCache::Configuration.coder.load(value) if value
-      end
-    end
-  end
-end

data/lib/generators/ar_cache/templates/migrate/create_ar_cache_records.rb.tt

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-class CreateArCacheMonitors < ActiveRecord::Migration[<%= ActiveRecord::VERSION::MAJOR %>.<%= ActiveRecord::VERSION::MINOR %>]
-  def change
-    create_table :ar_cache_records do |t|
-      t.string  :table_name, null: false
-      t.string  :table_md5, null: false, limit: 32, default: '0' * 32
-      t.integer :version, null: false, default: 0
-      t.integer :lock_version, null: false, default: 0
-
-      t.timestamps null: false
-
-      t.index :table_name, unique: true
-    end
-  end
-end