kasket 4.5.1 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e712453519dbc2e9d65176a7b2643f5d93f5fbc
-  data.tar.gz: fe75bab997f46475cb7fdcf23302d02f85335e9f
+SHA256:
+  metadata.gz: e1399453146b7dcf0974eb42a7b80375291b2978415269d686ff66ccb77b9f53
+  data.tar.gz: 4649d5f06595e558f859472439733208e62229841901bf9dc81b602c3f78e07e
 SHA512:
-  metadata.gz: 5c7846aae753e06fd1a39bff78cb6bc84b6602cd8c6245dc2bff0d4b9705ded35723f005f2e27b4bf838e05afba59542d5c826793c90be5d6afd4fc702ad2532
-  data.tar.gz: 4ae174cf74a6176f843ff40bffcc965ccb9ea78dba55a3f6d19f2621b2d96ae218d0521391173c0b250e586c4e427c07c3e41d37e5779aed2619342a56604616
+  metadata.gz: 7a6eeea3f1cdfe9bb349379cb07f4d13a21bfa0867ed09e9795746d91f74a69349ee15eb83d76e6f4776a717d8d4f2b8ce1479d41a095ac2e275502e3b54c99c
+  data.tar.gz: fd34ac51846f1748a47cf0de7b2c5f27ef843abe93429285e3830a8a8c3afb53822f7eab19452af3df5c99483323e1c0d9fd2a727ddda535626e58408a5a28e1

data/README.md

@@ -1,4 +1,4 @@
-# Kasket [![Build Status](https://secure.travis-ci.org/zendesk/kasket.svg)](http://travis-ci.org/zendesk/kasket)
+# Kasket [![Build status](https://circleci.com/gh/zendesk/kasket.svg?style=svg)](https://circleci.com/gh/zendesk/kasket)
 
 ### Puts a cap on your queries
 A caching layer for ActiveRecord (3.x and 4.x)
@@ -34,8 +34,8 @@ This will include the required modules into ActiveRecord.
 By default, Kasket will cache each instance collection with a maximum length of 100.
 You can override this by passing the `:max_collection_size` option to the `Kasket.setup` call:
 
-```
-Kasket.setup(:max_collection_size => 50)
+```ruby
+Kasket.setup(max_collection_size: 50)
 ```
 
 #### Write-Through Caching
@@ -44,8 +44,8 @@ By default, when a model is saved, Kasket will invalidate cache entries by delet
 You can pass ':write_through => true' to the `Kasket.setup` call to get write-through cache
 semantics instead. In this mode, the model will be updated in the cache as well as the database.
 
-```
-Kasket.setup(:write_through => true)
+```ruby
+Kasket.setup(write_through: true)
 ```
 
 ## Configuring caching of your models
@@ -55,7 +55,7 @@ configuration.
 
 If you have an `Account` model, you can can do the simplest caching configuration like:
 
-```
+```ruby
 Account.has_kasket
 ```
 
@@ -65,7 +65,7 @@ All other calls (say, `Account.find_by_subdomain('zendesk')`) are untouched.
 
 If you wanted to configure a caching index on the subdomain attribute of the Account model, you would simply write
 
-```
+```ruby
 Account.has_kasket_on :subdomain
 ```
 
@@ -81,6 +81,7 @@ The goal of Kasket is to be as safe as possible to use, so the cache is expired
 * When you save a model instance
 * When your database schema changes
 * When you install a new version of Kasket
+* After a global or per-model TTL
 * When you ask it to
 
 ### Cache expiry on instance save
@@ -96,12 +97,26 @@ If you somehow change your table schema, all cache entries for that table will a
 
 All Kasket cache keys contain the Kasket version number, so upgrading Kasket will expire all Kasket cache entries.
 
+### Cache expiry by TTL
+
+Sometimes caches like memcache can become incoherent. One layer of mitigation for this problem is to specify the maximum length a value may stay in cache before being expired and re-calculated. You can configure an optional default TTL value at setup:
+
+```ruby
+Kasket.setup(default_expires_in: 24.hours)
+```
+
+You can further specify per-model TTL values:
+
+```ruby
+Account.kasket_expires_in 5.minutes
+```
+
 ### Manually expiring caches
 
 If you have model methods that update the database behind the back of ActiveRecord, you need to mark these methods
 as being dirty.
 
-```
+```ruby
 Account.kasket_dirty_methods :update_last_action
 ```
 

data/lib/kasket.rb

@@ -15,7 +15,11 @@ module Kasket
   autoload :SelectManagerMixin,     'kasket/select_manager_mixin'
   autoload :RelationMixin,          'kasket/relation_mixin'
 
-  CONFIGURATION = { max_collection_size: 100, write_through: false } # rubocop:disable Style/MutableConstant
+  CONFIGURATION = { # rubocop:disable Style/MutableConstant
+    max_collection_size: 100,
+    write_through: false,
+    default_expires_in: nil
+  }
 
   module_function
 
@@ -23,13 +27,14 @@ module Kasket
     return if ActiveRecord::Base.respond_to?(:has_kasket)
 
     CONFIGURATION[:max_collection_size] = options[:max_collection_size] if options[:max_collection_size]
-    CONFIGURATION[:write_through] = options[:write_through] if options[:write_through]
+    CONFIGURATION[:write_through]       = options[:write_through]       if options[:write_through]
+    CONFIGURATION[:default_expires_in]  = options[:default_expires_in]  if options[:default_expires_in]
 
     ActiveRecord::Base.extend(Kasket::ConfigurationMixin)
 
     if defined?(ActiveRecord::Relation)
-      ActiveRecord::Relation.send(:include, Kasket::RelationMixin)
-      Arel::SelectManager.send(:include, Kasket::SelectManagerMixin)
+      ActiveRecord::Relation.include Kasket::RelationMixin
+      Arel::SelectManager.include Kasket::SelectManagerMixin
     end
   end
 
@@ -37,10 +42,15 @@ module Kasket
     @cache_store = ActiveSupport::Cache.lookup_store(options)
   end
 
-  def self.cache
+  def self.cache_store
     @cache_store ||= Rails.cache
   end
 
+  # Alias cache_store to cache
+  class << self
+    alias_method :cache, :cache_store
+  end
+
   # Keys are the records being saved.
   # Values are either the saved record, or nil if the record has been destroyed.
   def self.pending_records

data/lib/kasket/configuration_mixin.rb

@@ -37,7 +37,7 @@ module Kasket
       else
         key = attribute_value_pairs.map do |attribute, value|
           column = columns_hash[attribute.to_s]
-          value = nil if value.blank?
+          value = nil if value.blank? && value != false
           "#{attribute}=#{kasket_quoted_value_for_column(value, column)}"
         end.join('/')
 
@@ -91,7 +91,10 @@ module Kasket
       @kasket_ttl = time
     end
 
-    attr_reader :kasket_ttl
+    def kasket_ttl
+      @kasket_ttl ||= nil
+      @kasket_ttl || Kasket::CONFIGURATION[:default_expires_in]
+    end
 
     private
 

data/lib/kasket/query_parser.rb

@@ -6,8 +6,8 @@ module Kasket
     # SELECT * FROM `users` WHERE (`users`.`id` = 2) LIMIT 1
     # 'SELECT * FROM \'posts\' WHERE (\'posts\'.\'id\' = 574019247) '
 
-    AND = /\s+AND\s+/i
-    VALUE = /'?(\d+|\?|(?:(?:[^']|''|\\')*))'?/ # Matches: 123, ?, '123', '12''3'
+    AND = /\s+AND\s+/i.freeze
+    VALUE = /'?(\d+|\?|(?:(?:[^']|''|\\')*))'?/.freeze # Matches: 123, ?, '123', '12''3'
 
     def initialize(model_class)
       @model_class = model_class

data/lib/kasket/read_mixin.rb

@@ -8,6 +8,7 @@ module Kasket
       end
     end
 
+    # *args can be replaced with (sql, *args) once we stop supporting Rails < 5.2
     def find_by_sql_with_kasket(*args)
       sql = args[0]
 
@@ -16,7 +17,11 @@ module Kasket
           if ActiveRecord::VERSION::MAJOR < 5
             sql.to_kasket_query(self, args[1])
           else
-            sql.to_kasket_query(self, args[1].map(&:value_for_database))
+            if ActiveRecord::VERSION::STRING < '5.2'
+              sql.to_kasket_query(self, args[1].map(&:value_for_database))
+            else
+              sql.to_kasket_query(self)
+            end
           end
         else
           kasket_parser.parse(sanitize_sql(sql))
@@ -28,11 +33,27 @@ module Kasket
           find_by_sql_with_kasket_on_id_array(query[:key])
         else
           if value = Kasket.cache.read(query[:key])
-            if value.is_a?(Array)
+            # Identified a specific edge case where memcached server returns 0x00 binary protocol response with no data
+            # when the node is being rebooted which causes the Dalli memcached client to return a TrueClass object instead of nil
+            # see: https://github.com/petergoldstein/dalli/blob/31dabf19d3dd94b348a00a59fe5a7b8fa80ce3ad/lib/dalli/server.rb#L520
+            # and: https://github.com/petergoldstein/dalli/issues/390
+            #
+            # The code in this first condition of TrueClass === true  will
+            # skip the kasket cache for these specific objects and go directly to SQL for retrieval.
+            result_set = if value.is_a?(TrueClass)
+              find_by_sql_without_kasket(*args)
+            elsif value.is_a?(Array)
               filter_pending_records(find_by_sql_with_kasket_on_id_array(value))
             else
               filter_pending_records(Array.wrap(value).collect { |record| instantiate(record.dup) })
             end
+
+            payload = {
+              record_count: result_set.length,
+              class_name: to_s
+            }
+
+            ActiveSupport::Notifications.instrument('instantiation.active_record', payload) { result_set }
           else
             store_in_kasket(query[:key], find_by_sql_without_kasket(*args))
           end
@@ -76,7 +97,7 @@ module Kasket
       if records.size == 1
         records.first.store_in_kasket(key)
       elsif records.empty?
-        ActiveRecord::Base.logger.info("[KASKET] would have stored an empty resultset") if ActiveRecord::Base.logger
+        ActiveRecord::Base.logger.debug("[KASKET] would have stored an empty resultset") if ActiveRecord::Base.logger
       elsif records.size <= Kasket::CONFIGURATION[:max_collection_size]
         if records.all?(&:kasket_cacheable?)
           instance_keys = records.map(&:store_in_kasket)

data/lib/kasket/relation_mixin.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 module Kasket
   module RelationMixin
+    # binds can be removed when support for Rails < 5 is removed
     def to_kasket_query(binds = nil)
       if arel.is_a?(Arel::SelectManager)
         if ActiveRecord::VERSION::MAJOR < 5
           arel.to_kasket_query(klass, (binds || bind_values))
+        elsif ActiveRecord::VERSION::STRING < '5.2'
+          arel.to_kasket_query(klass, (@values[:where].to_h.values + Array(@values[:limit])))
         else
-          arel.to_kasket_query(klass, (@values[:where].binds.map(&:value_for_database) + Array(@values[:limit])))
+          arel.to_kasket_query(klass)
         end
       end
     rescue TypeError # unsupported object in ast
-      return nil
+      nil
     end
   end
 end

data/lib/kasket/select_manager_mixin.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module Kasket
   module SelectManagerMixin
+    # binds can be removed once we stop supporting Rails < 5.2
     def to_kasket_query(klass, binds = [])
       begin
         query = Kasket::Visitor.new(klass, binds).accept(ast)

data/lib/kasket/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Kasket
-  VERSION = '4.5.1'
+  VERSION = '4.9.0'
   class Version
     MAJOR = Kasket::VERSION.split('.')[0]
     MINOR = Kasket::VERSION.split('.')[1]

data/lib/kasket/visitor.rb

@@ -3,6 +3,7 @@ require 'arel'
 
 module Kasket
   class Visitor < Arel::Visitors::Visitor
+    # binds can be removed once we stop supporting Rails < 5.2
     def initialize(model_class, binds)
       @model_class = model_class
       @binds       = binds.dup
@@ -75,6 +76,7 @@ module Kasket
     def visit_Arel_Nodes_JoinSource(node, *_)
       return :unsupported if !node.left || node.right.any?
       return :unsupported unless node.left.is_a?(Arel::Table)
+
       visit(node.left)
     end
 
@@ -85,6 +87,7 @@ module Kasket
     def visit_Arel_Nodes_And(node, *_)
       attributes = node.children.map { |child| visit(child) }
       return :unsupported if attributes.include?(:unsupported)
+
       attributes.sort! { |pair1, pair2| pair1[0].to_s <=> pair2[0].to_s }
       { attributes: attributes }
     end
@@ -112,18 +115,26 @@ module Kasket
     end
 
     def literal(node, *_)
-      if node == '?'
-        @binds.shift.last.to_s
+      if ActiveRecord::VERSION::STRING < '5.2'
+        if node == '?'
+          @binds.shift.last.to_s
+        else
+          node.to_s
+        end
       else
         node.to_s
       end
     end
 
-    def visit_Arel_Nodes_BindParam(_x, *_)
+    def visit_Arel_Nodes_BindParam(node, *_)
       if ActiveRecord::VERSION::MAJOR < 5
         visit(@binds.shift[1])
       else
-        visit(@binds.shift)
+        if ActiveRecord::VERSION::STRING < '5.2'
+          visit(@binds.shift)
+        else
+          visit(node.value.value) unless node.value.value.nil?
+        end
       end
     end
 
@@ -131,11 +142,13 @@ module Kasket
       node.map {|value| visit(value) }
     end
 
-    def visit_Arel_Nodes_Casted(node, *_)
-      case node.val
-      when nil    then nil
-      when String then node.val
-      else quoted(node.val)
+    if ActiveRecord::VERSION::STRING < '5.2'
+      def visit_Arel_Nodes_Casted(node, *_)
+        case node.val
+        when nil    then nil
+        when String then node.val
+        else quoted(node.val)
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kasket
 version: !ruby/object:Gem::Version
-  version: 4.5.1
+  version: 4.9.0
 platform: ruby
 authors:
 - Mick Staugaard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,22 +17,22 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -60,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -74,7 +74,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,7 +88,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -102,7 +102,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,7 +116,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -130,7 +130,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: wwtd
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -173,15 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A write back caching layer on active record