kasket 4.5.1 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e712453519dbc2e9d65176a7b2643f5d93f5fbc
-  data.tar.gz: fe75bab997f46475cb7fdcf23302d02f85335e9f
+  metadata.gz: a81925a9561dbeb413c751be411178db3ca412f1
+  data.tar.gz: 32e1620ff89925cc429d4c9f8e8bfdc95e34208e
 SHA512:
-  metadata.gz: 5c7846aae753e06fd1a39bff78cb6bc84b6602cd8c6245dc2bff0d4b9705ded35723f005f2e27b4bf838e05afba59542d5c826793c90be5d6afd4fc702ad2532
-  data.tar.gz: 4ae174cf74a6176f843ff40bffcc965ccb9ea78dba55a3f6d19f2621b2d96ae218d0521391173c0b250e586c4e427c07c3e41d37e5779aed2619342a56604616
+  metadata.gz: c57079f331c15b58809288a45c123ff8e044763c81f0e170a9706305fcb0ea6d7f0fd336566815bf99e843d4193e9dbc1b6d96ad4543317e4fb6d79a89eece28
+  data.tar.gz: d8a5b52ce07b72b361727649697a8a1187c55fe790dbbf82b7b358897cf942fe64456ce89959a9849f9f941f99b854e2a2b41931c178890ddf4d1bae9c06e8aa

data/README.md

@@ -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

@@ -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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kasket
 version: !ruby/object:Gem::Version
-  version: 4.5.1
+  version: 4.6.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: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A write back caching layer on active record