kasket 4.4.5 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9f87cf99e6a474e1fbd9cc065f70b7d3fdf8d63e
-  data.tar.gz: b80fdd81db181a37ce17307b766b8226b1d585f0
+SHA256:
+  metadata.gz: e5cec0e5e944a74b977fd8e8113983160e1a5075eade70a499e6b16863abfde6
+  data.tar.gz: d9ee5a1d6a974e998191ad656b4b962b5a7ea74e0327be3944813790bf6e7e8c
 SHA512:
-  metadata.gz: 55d6fee7b35ff8fe213842590551a8855c52b26213f6a90a3993d2165fb39dc6abad1a95c8d1262dfe123124d7a269c771b8a153bbba102b45397062812434c0
-  data.tar.gz: 51e4d7e84544db2ca0fb9f36525167bf863847d31c7b10962fab41f45070e3e2cceec3733a00186c00e5034927b6bb6ebf215fd94f11a230b3b5de74a606e430
+  metadata.gz: 9aca01c0f69b403d2476b5db05b610604899f2a38f450b0c29d8f19b60f5f2e3e67777c172690672ae83a1a4ce14e316c85175989d5dd4df826afdbf6b8e530c
+  data.tar.gz: 1645f52ca823c5c628d9fa5c1aba45393feffc9ac3f0c0e70e1552582bd55de79df20f8870f72deca67d8e0faae036d5fc5d1fa67b7be80dcf836d86808b7c68

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,7 +27,8 @@ 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)
 

data/lib/kasket/configuration_mixin.rb

@@ -37,8 +37,8 @@ module Kasket
       else
         key = attribute_value_pairs.map do |attribute, value|
           column = columns_hash[attribute.to_s]
-          value = nil if value.blank?
-          "#{attribute}=#{quoted_value_for_column(value, column)}"
+          value = nil if value.blank? && value != false
+          "#{attribute}=#{kasket_quoted_value_for_column(value, column)}"
         end.join('/')
 
         if key.size > (250 - kasket_key_prefix.size) || key =~ /\s/
@@ -91,21 +91,23 @@ 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
 
-    def quoted_value_for_column(value, column)
+    def kasket_quoted_value_for_column(value, column)
       if column
+        conn = connection
         casted_value =
-          if connection.respond_to?(:type_cast_from_column)
-            connection.type_cast_from_column(column, value)
-          elsif column.respond_to?(:type_cast_for_database)
-            column.type_cast_for_database(value) # Rails 4.2
-          else
-            column.type_cast(value)
+          case ActiveRecord::VERSION::MAJOR
+          when 3 then column.type_cast(value)
+          when 4 then column.type_cast_for_database(value)
+          else conn.type_cast_from_column(column, value)
           end
-        connection.quote(casted_value).downcase
+        conn.quote(casted_value).downcase
       else
         value.to_s
       end

data/lib/kasket/read_mixin.rb

@@ -16,7 +16,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))

data/lib/kasket/relation_mixin.rb

@@ -6,7 +6,7 @@ module Kasket
         if ActiveRecord::VERSION::MAJOR < 5
           arel.to_kasket_query(klass, (binds || bind_values))
         else
-          arel.to_kasket_query(klass, (@values[:where].binds.map(&:value_for_database) + Array(@values[:limit])))
+          arel.to_kasket_query(klass, (@values[:where].to_h.values + Array(@values[:limit])))
         end
       end
     rescue TypeError # unsupported object in ast

data/lib/kasket/version.rb

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

data/lib/kasket/visitor.rb

@@ -119,11 +119,15 @@ module Kasket
       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
 
@@ -132,7 +136,11 @@ module Kasket
     end
 
     def visit_Arel_Nodes_Casted(node, *_)
-      quoted(node.val) unless node.val.nil?
+      case node.val
+      when nil    then nil
+      when String then node.val
+      else quoted(node.val)
+      end
     end
 
     def visit_TrueClass(_node)
@@ -144,7 +152,6 @@ module Kasket
     end
 
     def quoted(node)
-      return node if node.is_a?(String)
       @model_class.connection.quote(node)
     end
 
@@ -155,6 +162,8 @@ module Kasket
 
     alias_method :visit_String, :literal
     alias_method :visit_Fixnum, :literal
+    alias_method :visit_Integer, :literal
+    alias_method :visit_Bignum, :literal
     alias_method :visit_Arel_Nodes_SqlLiteral, :literal
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kasket
 version: !ruby/object:Gem::Version
-  version: 4.4.5
+  version: 4.8.0
 platform: ruby
 authors:
 - Mick Staugaard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,20 +17,20 @@ 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
   requirement: !ruby/object:Gem::Requirement
@@ -173,15 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A write back caching layer on active record