readthis 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c3b9c325211a544d3cdffbbb4356c7c392a5c04
-  data.tar.gz: ecd6d0982a96bcff0f9bfafff60b6d758ab5ee55
+  metadata.gz: 3fc72dc492c9faadf1cdb788cffc7cc7f884b718
+  data.tar.gz: 9f3953c2e151c2533518c58deb434d0018cfa898
 SHA512:
-  metadata.gz: 92323a5bfb41f8a29ea0b3082ff500078af9944d85fd756a1147b2cc1a7899e7fa4900c086463bfaa775608cf3d7c86137b4e54084f72ce1a2110b3f14d55c2b
-  data.tar.gz: f2d19489b82236baee8be73033b07f3a375585195fc251b17c5ce9f15972911e696e038b282a949a513c8afda4465706f2a581b90c99529da7255e364fe9517b
+  metadata.gz: 4773d7f739dce07c3ee5f193f6966599d9dd12619bf8bfe1ad9d325563b1d00c70fcac0014e9b0d408167b929e6629401d44332bded3facc4b2581c3cb78ae7b
+  data.tar.gz: 709e8fdbfab3668d51e8a428223e8e976e9e49e60c1e3e10fa397dc6bf0d8445127466830472c203f8e3e663c42d789db474e2acecfc91d61f9d69148ef50f81

data/README.md

@@ -90,6 +90,17 @@ Readthis::Cache.new(expires_in: 1.week) # don't do this
 Readthis::Cache.new(expires_in: 1.week.to_i) # do this
 ```
 
+By using the `refresh` option the TTL for keys can be refreshed automatically
+every time the key is read. This is helpful for ensuring commonly hit keys are
+kept cached, effectively making the cache a hybrid LRU.
+
+```ruby
+Readthis::Cache.new(refresh: true)
+```
+
+Be aware that `refresh` adds a slight overhead to all read operations, as they
+are now all write operations as well.
+
 ### Compression
 
 Compression can be enabled for all actions by passing the `compress` flag. By

data/lib/readthis.rb

@@ -4,8 +4,6 @@ require 'readthis/serializers'
 require 'readthis/version'
 
 module Readthis
-  extend self
-
   # The current, global, instance of serializers that is used by all cache
   # instances.
   #
@@ -39,4 +37,6 @@ module Readthis
     @fault_tolerant = nil
     @serializers = nil
   end
+
+  module_function :serializers, :fault_tolerant?, :fault_tolerant=, :reset!
 end

data/lib/readthis/cache.rb

@@ -18,17 +18,19 @@ module Readthis
 
     # Creates a new Readthis::Cache object with the given options.
     #
-    # @option [Hash]    :redis Options that will be passed to the underlying redis connection
+    # @option [Hash]    :redis Options that will be passed to the redis connection
     # @option [Boolean] :compress (false) Enable or disable automatic compression
-    # @option [Number]  :compression_threshold (8k) The size a string must be for compression
+    # @option [Number]  :compression_threshold (8k) Minimum string size for compression
     # @option [Number]  :expires_in The number of seconds until an entry expires
-    # @option [Module]  :marshal (Marshal) Any module that responds to `dump` and `load`
+    # @option [Boolean] :refresh (false) Automatically refresh key expiration
+    # @option [Module]  :marshal (Marshal) Module that responds to `dump` and `load`
     # @option [String]  :namespace Prefix used to namespace entries
     # @option [Number]  :pool_size (5) The number of threads in the pool
     # @option [Number]  :pool_timeout (5) How long before a thread times out
     #
     # @example Create a new cache instance
-    #   Readthis::Cache.new(namespace: 'cache', redis: { url: 'redis://localhost:6379/0' })
+    #   Readthis::Cache.new(namespace: 'cache',
+    #                       redis: { url: 'redis://localhost:6379/0' })
     #
     # @example Create a compressed cache instance
     #   Readthis::Cache.new(compress: true, compression_threshold: 2048)
@@ -60,10 +62,14 @@ module Readthis
     #   cache.read('matched') # => 'some value'
     #
     def read(key, options = {})
+      options = merged_options(options)
+
       invoke(:read, key) do |store|
-        value = store.get(namespaced_key(key, merged_options(options)))
+        key = namespaced_key(key, options)
+
+        refresh_entity(key, store, options)
 
-        entity.load(value)
+        entity.load(store.get(key))
       end
     end
 
@@ -97,6 +103,7 @@ module Readthis
     #
     #   cache.delete('existing-key') # => true
     #   cache.delete('random-key')   # => false
+    #
     def delete(key, options = {})
       namespaced = namespaced_key(key, merged_options(options))
 
@@ -130,7 +137,7 @@ module Readthis
     #   cache.fetch('city') do
     #     'Duckburgh'
     #   end
-    #   cache.fetch('city')   # => "Duckburgh"
+    #   cache.fetch('city') # => "Duckburgh"
     #
     # @example Cache Miss
     #
@@ -214,6 +221,8 @@ module Readthis
       invoke(:read_multi, keys) do |store|
         values = store.mget(*mapping).map { |value| entity.load(value) }
 
+        refresh_entity(mapping, store, options)
+
         keys.zip(values).to_h
       end
     end
@@ -310,12 +319,22 @@ module Readthis
 
     protected
 
+    def refresh_entity(keys, store, options)
+      return unless options[:refresh] && options[:expires_in]
+
+      store.multi do
+        Array(keys).each do |key|
+          store.expire(key, coerce_expiration(options[:expires_in]))
+        end
+      end
+    end
+
     def write_entity(key, value, store, options)
       namespaced = namespaced_key(key, options)
       dumped = entity.dump(value, options)
 
-      if expiration = options[:expires_in]
-        store.setex(namespaced, expiration.to_i, dumped)
+      if (expiration = options[:expires_in])
+        store.setex(namespaced, coerce_expiration(expiration), dumped)
       else
         store.set(namespaced, dumped)
       end
@@ -324,12 +343,15 @@ module Readthis
     private
 
     def alter(key, amount, options)
-      number = read(key, options)
-      delta  = number.to_i + amount
+      delta = read(key, options).to_i + amount
       write(key, delta, options)
       delta
     end
 
+    def coerce_expiration(expires_in)
+      Float(expires_in).ceil
+    end
+
     def instrument(name, key)
       if self.class.notifications
         name    = "cache_#{name}.active_support"

data/lib/readthis/passthrough.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Readthis
   module Passthrough
     def self.dump(value)

data/lib/readthis/serializers.rb

@@ -36,9 +36,9 @@ module Readthis
     def <<(serializer)
       case
       when serializers.frozen?
-        fail SerializersFrozenError
+        raise SerializersFrozenError
       when serializers.length > SERIALIZER_LIMIT
-        fail SerializersLimitError
+        raise SerializersLimitError
       else
         @serializers[serializer] = flags.max.succ
         @inverted = @serializers.invert
@@ -76,7 +76,7 @@ module Readthis
       flag = serializers[serializer]
 
       unless flag
-        fail UnknownSerializerError, "'#{serializer}' hasn't been configured"
+        raise UnknownSerializerError, "'#{serializer}' hasn't been configured"
       end
 
       flag

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'.freeze
 end

data/spec/matchers/redis_matchers.rb

@@ -0,0 +1,13 @@
+module RedisMatchers
+  extend RSpec::Matchers::DSL
+
+  matcher :have_ttl do |expected|
+    match do |cache|
+      cache.pool.with do |client|
+        expected.all? do |(key, value)|
+          client.ttl(key) == value
+        end
+      end
+    end
+  end
+end

data/spec/readthis/cache_spec.rb

@@ -1,6 +1,9 @@
 require 'readthis'
+require 'matchers/redis_matchers'
 
 RSpec.describe Readthis::Cache do
+  include RedisMatchers
+
   let(:cache) { Readthis::Cache.new }
 
   after do
@@ -48,16 +51,23 @@ RSpec.describe Readthis::Cache do
     end
 
     it 'uses a custom expiration' do
-      cache = Readthis::Cache.new(namespace: 'cache', expires_in: 86_400)
+      cache = Readthis::Cache.new(expires_in: 10)
 
       cache.write('some-key', 'some-value')
       cache.write('other-key', 'other-value', expires_in: 1)
 
       expect(cache.read('some-key')).not_to be_nil
       expect(cache.read('other-key')).not_to be_nil
-      sleep 1.01
-      expect(cache.read('some-key')).not_to be_nil
-      expect(cache.read('other-key')).to be_nil
+
+      expect(cache).to have_ttl('some-key' => 10, 'other-key' => 1)
+    end
+
+    it 'rounds floats to a valid expiration value' do
+      cache = Readthis::Cache.new
+
+      cache.write('some-key', 'some-value', expires_in: 0.1)
+
+      expect(cache).to have_ttl('some-key' => 1)
     end
 
     it 'expands non-string keys' do
@@ -73,6 +83,18 @@ RSpec.describe Readthis::Cache do
     it 'gracefully handles nil options' do
       expect { cache.read('whatever', nil) }.not_to raise_error
     end
+
+    it 'can refresh the expiration of an entity' do
+      cache = Readthis::Cache.new(refresh: true)
+
+      cache.write('some-key', 'some-value', expires_in: 1)
+
+      cache.read('some-key', expires_in: 2)
+      expect(cache).to have_ttl('some-key' => 2)
+
+      cache.read('some-key', expires_in: 0.1)
+      expect(cache).to have_ttl('some-key' => 1)
+    end
   end
 
   describe 'serializers' do
@@ -204,6 +226,17 @@ RSpec.describe Readthis::Cache do
     it 'returns {} with no keys' do
       expect(cache.read_multi(namespace: 'cache')).to eq({})
     end
+
+    it 'refreshes each key that is read' do
+      cache = Readthis::Cache.new(refresh: true)
+
+      cache.write('a', 1, expires_in: 1)
+      cache.write('b', 2, expires_in: 1)
+
+      cache.read_multi('a', 'b', expires_in: 2)
+
+      expect(cache).to have_ttl('a' => 2, 'b' => 2)
+    end
   end
 
   describe '#write_multi' do
@@ -224,8 +257,8 @@ RSpec.describe Readthis::Cache do
 
       expect(cache.read('a')).to be_nil
       expect(cache.read('a', namespace: 'multi')).to eq(1)
-      sleep 1.01
-      expect(cache.read('a', namespace: 'multi')).to be_nil
+
+      expect(cache).to have_ttl('multi:a' => 1)
     end
   end
 
@@ -328,10 +361,10 @@ RSpec.describe Readthis::Cache do
       cache.read('a')
 
       expect(events.length).to eq(2)
-      expect(events.map(&:name)).to eq(%w[
+      expect(events.map(&:name)).to eq %w[
         cache_write.active_support
         cache_read.active_support
-      ])
+      ]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2016-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -125,6 +125,7 @@ files:
 - lib/readthis/passthrough.rb
 - lib/readthis/serializers.rb
 - lib/readthis/version.rb
+- spec/matchers/redis_matchers.rb
 - spec/readthis/cache_spec.rb
 - spec/readthis/entity_spec.rb
 - spec/readthis/expanders_spec.rb
@@ -157,6 +158,7 @@ signing_key:
 specification_version: 4
 summary: Pooled active support compliant caching with redis
 test_files:
+- spec/matchers/redis_matchers.rb
 - spec/readthis/cache_spec.rb
 - spec/readthis/entity_spec.rb
 - spec/readthis/expanders_spec.rb