readthis 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c15a08e16c0c3499ba92207c32a0fb3cd07d6bea
-  data.tar.gz: 77b6b856ee036051b59a83c7a2013af49ef4c898
+  metadata.gz: 3e47cddbb974aaa2df5258b6279db5ac65ac1b7c
+  data.tar.gz: d729c1a37bbd6b2ab51d20ff20944e4b51aab561
 SHA512:
-  metadata.gz: e1c2bd1bcadb0b1d4636de110c1202adf9f4c197bc189ef5282d86f4765612d5383ec9792d435b0629012732151e5a7468a965cc7d99a8b14e9e95100d6312af
-  data.tar.gz: 8ab80c80422fa2ad11d70e03ad6697c6a5d5d78fc76460b27cf1a332b023b9b0419c40020d291cc8db01638844dfe33a693c12a59e1d28474b9f858dc06998cf
+  metadata.gz: 5b9e58cf2f1dda31681d653e770153d190b1fb5958e52881222b8a350cf94b71eac28c9043e56d1d2ab6673952db14b63872d52452006926cf2818d74837961d
+  data.tar.gz: f4950c2133cd938ee7e5b9da6a4ed5605506ef4da347b0b34379ad07b97fcc66d2c63dab6c56ddba72e41a4490313338517360860924bd7a5171fb9d21561b05

data/README.md

@@ -137,6 +137,19 @@ sticky and a flag is stored with each cached value. If you subsequently go to
 deserialize values and haven't configured the same serializers in the same order
 your application will raise errors.
 
+## Fault Tolerance
+
+In some situations it is desirable to keep serving requests from disk or the
+database if Redis crashes. This can be achieved wiht connection fault tolerance
+by enabling it at the top level:
+
+```ruby
+Readthis.fault_tolerant = true
+```
+
+The default value is `false`, because while it may work for `fetch` operations,
+it isn't compatible with other state-based commands like `increment`.
+
 ## Differences From ActiveSupport::Cache
 
 Readthis supports all of standard cache methods except for the following:

data/lib/readthis.rb

@@ -16,4 +16,27 @@ module Readthis
   def serializers
     @serializers ||= Readthis::Serializers.new
   end
+
+  # Indicates whether connection error tolerance is enabled. With tolerance
+  # enabled every operation will return a `nil` value.
+  #
+  # @returns [Boolean] True for enabled, false for disabled
+  #
+  def fault_tolerant?
+    @fault_tolerant
+  end
+
+  # Toggle fault tolerance for connection errors.
+  #
+  # @param [Boolean] The new value for fault tolerance
+  #
+  def fault_tolerant=(value)
+    @fault_tolerant = value
+  end
+
+  # @private
+  def reset!
+    @fault_tolerant = nil
+    @serializers = nil
+  end
 end

data/lib/readthis/cache.rb

@@ -345,6 +345,8 @@ module Readthis
       instrument(operation, key) do
         pool.with(&block)
       end
+    rescue Redis::BaseError => error
+      raise error unless Readthis.fault_tolerant?
     end
 
     def extract_options!(array)

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/readthis/cache_spec.rb

@@ -48,7 +48,7 @@ RSpec.describe Readthis::Cache do
     end
 
     it 'uses a custom expiration' do
-      cache = Readthis::Cache.new(namespace: 'cache', expires_in: 86400)
+      cache = Readthis::Cache.new(namespace: 'cache', expires_in: 86_400)
 
       cache.write('some-key', 'some-value')
       cache.write('other-key', 'other-value', expires_in: 1)
@@ -166,6 +166,16 @@ RSpec.describe Readthis::Cache do
       cache.write('great-key', 'great')
       expect(cache.fetch('great-key', nil)).to eq('great')
     end
+
+    it 'serves computed content when the cache is down and tolerance is enabled' do
+      Readthis.fault_tolerant = true
+
+      allow(cache.pool).to receive(:with).and_raise(Redis::CannotConnectError)
+
+      computed = cache.fetch('error-key') { 'computed' }
+
+      expect(computed).to eq('computed')
+    end
   end
 
   describe '#read_multi' do

data/spec/readthis_spec.rb

@@ -6,4 +6,16 @@ RSpec.describe Readthis do
       expect(Readthis.serializers.marshals).to include(Marshal, JSON)
     end
   end
+
+  describe '#fault_tolerant?' do
+    it 'defaults to being false' do
+      expect(Readthis).not_to be_fault_tolerant
+    end
+
+    it 'can be enabled' do
+      Readthis.fault_tolerant = true
+
+      expect(Readthis).to be_fault_tolerant
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -20,4 +20,8 @@ RSpec.configure do |config|
 
   config.order = :random
   Kernel.srand config.seed
+
+  config.before do
+    Readthis.reset!
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2015-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis