retriable 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfe5a1956e7b8921928094fd4306632da5852693
-  data.tar.gz: bc171d15fa1f55ce45151f6e6ce6976b2082a415
+  metadata.gz: 9be10833c09da3a93748eaaae5d13577ee8c520a
+  data.tar.gz: a370e7ea1a328865b3235f316e07bacdc19b6bb1
 SHA512:
-  metadata.gz: 80395340aa4890214aeb12f331904da265f42af80d4e8bd7400e532d7a47f4828abc659f7ae629a74f6d16ce77f1e88b23fc8518ca4531087d23a566ec5bcacc
-  data.tar.gz: c8385720ed1095508eae24dc918eb620ea4715b13d38ef7d2c921abd65f9fb05f6e95065307be644819405a1d9411e20961e95e06b734aae1333b54c3f45745d
+  metadata.gz: bd0ff1af0d8f50320fa8ff29ed4e53b56fbb33d62638a00206d2e9a816ae11082638b10ae6642f7bf98895f3f48b87e886bbe3dc1997b19863825f0c330ed759
+  data.tar.gz: aec007409a818cb5758c3e853cb6bd684d4676deee14c089f4b10f7fd3284554f71dd5d8079345622b1b99e4f23bf3a874f1c2371916e5e9b8fce13d35009318

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.DS_Store

data/.rubocop.yml

@@ -6,7 +6,7 @@ Style/Documentation:
 
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
-  
+
 Style/TrailingCommaInLiteral:
   EnforcedStyleForMultiline: comma
 
@@ -19,6 +19,9 @@ Style/IndentArray:
 Style/IndentHash:
   Enabled: false
 
+Style/NegatedIf:
+  Enabled: false
+
 Metrics/ClassLength:
   Enabled: false
 

data/.travis.yml

@@ -10,7 +10,7 @@ rvm:
   - 2.4.1
   - rbx
   - jruby-9.0.5.0
-  - jruby-9.1.8.0
+  - jruby-9.1.12.0
   - ruby-head
   - jruby-head
 

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## HEAD
 
+## 3.1.0
+
+* Added contexts feature. Thanks to @apurvis.
+
 ## 3.0.2
 
 * Add configuration and options validation.

data/README.md

@@ -223,6 +223,49 @@ ensure
 end
 ```
 
+## Contexts
+
+Contexts allow you to coordinate sets of Retriable options across an application.  Each context is basically an argument hash for `Retriable.retriable` that is stored in the `Retriable.config` as a simple `Hash` and is accessible by name. For example:
+
+```ruby
+Retriable.configure do |c|
+  c.contexts[:aws] = {
+    tries: 3,
+    base_interval: 5,
+    on_retry: Proc.new { puts 'Curse you, AWS!' }
+  }
+  c.contexts[:mysql] = {
+    tries: 10,
+    multiplier: 2.5,
+    on: Mysql::DeadlockException
+  }
+end
+```
+
+This will create two contexts, `aws` and `mysql`, which allow you to reuse different backoff strategies across your application without continually passing those strategy options to the `retriable` method.
+
+These are used simply by calling `Retriable.with_context`:
+
+```ruby
+# Will retry all exceptions
+Retriable.with_context(:aws) do
+  # aws_call
+end
+
+# Will retry Mysql::DeadlockException
+Retriable.with_context(:mysql) do
+  # write_to_table
+end
+```
+
+You can even temporarily override individual options for a configured context:
+
+```ruby
+Retriable.with_context(:mysql, tries: 30) do
+  # write_to_table
+end
+```
+
 ## Kernel Extension
 
 If you want to call `Retriable.retriable` without the `Retriable` module prefix and you don't mind extending `Kernel`,
@@ -246,6 +289,10 @@ and then you can call `#retriable` in any context like this:
 retriable do
   # code here...
 end
+
+retriable_with_context(:api) do
+  # code here...
+end
 ```
 
 ## Proxy Wrapper Object

data/lib/retriable.rb

@@ -6,7 +6,7 @@ require_relative "retriable/version"
 module Retriable
   module_function
 
-  def self.configure
+  def configure
     yield(config)
   end
 
@@ -14,6 +14,14 @@ module Retriable
     @config ||= Config.new
   end
 
+  def with_context(context_key, options = {}, &block)
+    if !config.contexts.key?(context_key)
+      raise ArgumentError, "#{context_key} not found in Retriable.config.contexts. Here the available contexts: #{config.contexts.keys}"
+    end
+
+    retriable(config.contexts[context_key].merge(options), &block) if block
+  end
+
   def retriable(opts = {})
     local_config = opts.empty? ? config : Config.new(config.to_h.merge(opts))
 
@@ -40,7 +48,7 @@ module Retriable
         base_interval:  base_interval,
         multiplier:     multiplier,
         max_interval:   max_interval,
-        rand_factor:    rand_factor,
+        rand_factor:    rand_factor
       ).intervals
     end
 

data/lib/retriable/config.rb

@@ -9,6 +9,7 @@ module Retriable
       :timeout,
       :on,
       :on_retry,
+      :contexts,
     ].freeze
 
     attr_accessor(*ATTRIBUTES)
@@ -27,6 +28,7 @@ module Retriable
       @timeout          = nil
       @on               = [StandardError]
       @on_retry         = nil
+      @contexts          = {}
 
       opts.each do |k, v|
         raise ArgumentError, "#{k} is not a valid option" if !ATTRIBUTES.include?(k)

data/lib/retriable/core_ext/kernel.rb

@@ -4,4 +4,8 @@ module Kernel
   def retriable(opts = {}, &block)
     Retriable.retriable(opts, &block)
   end
+
+  def retriable_with_context(context_key, opts = {}, &block)
+    Retriable.with_context(context_key, opts, &block)
+  end
 end

data/lib/retriable/version.rb

@@ -1,3 +1,3 @@
 module Retriable
-  VERSION = "3.0.2".freeze
+  VERSION = "3.1.0".freeze
 end

data/spec/config_spec.rb

@@ -45,6 +45,10 @@ describe Retriable::Config do
     expect(subject.new.on_retry).must_be_nil
   end
 
+  it "contexts defaults to {}" do
+    expect(subject.new.contexts).must_equal Hash.new
+  end
+
   it "raises errors on invalid configuration" do
     assert_raises ArgumentError do
       subject.new(does_not_exist: 123)

data/spec/retriable_spec.rb

@@ -376,4 +376,59 @@ describe Retriable do
       Retriable.retriable(does_not_exist: 123)
     end
   end
+
+  describe "#with_context" do
+    before do
+      Retriable.configure do |c|
+        c.sleep_disabled = true
+        c.contexts[:sql] = { tries: 1 }
+        c.contexts[:api] = { tries: 3 }
+      end
+    end
+
+    it "sql context stops at first try if the block does not raise an exception" do
+      tries = 0
+      subject.with_context(:sql) do
+        tries += 1
+      end
+
+      expect(tries).must_equal 1
+    end
+
+    it "with_context respects the context options" do
+      tries = 0
+
+      expect do
+        subject.with_context(:api) do
+          tries += 1
+          raise StandardError.new, "StandardError occurred"
+        end
+      end.must_raise StandardError
+
+      expect(tries).must_equal 3
+    end
+
+    it "with_context allows override options" do
+      tries = 0
+
+      expect do
+        subject.with_context(:sql, tries: 5) do
+          tries += 1
+          raise StandardError.new, "StandardError occurred"
+        end
+      end.must_raise StandardError
+
+      expect(tries).must_equal 5
+    end
+
+    it "raises an ArgumentError when the context isn't found" do
+      tries = 0
+
+      expect do
+        subject.with_context(:wtf) do
+          tries += 1
+        end
+      end.must_raise ArgumentError
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler