retriable 2.0.0.beta4 → 2.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fb94b8f9e411a4f0939d03f213928e28e002375
-  data.tar.gz: 703fe21cb7abce08770c7cd5d308099233e8c614
+  metadata.gz: a7f89877bb9506abc02a59892b97c55a0f995b38
+  data.tar.gz: 7b9e325e86386e6e0e739bb4a51df12882327c1b
 SHA512:
-  metadata.gz: d5ed763d75076b92d366854009dd0a0a2df4eeafa184a664c13ba3a01d74968274bff2a61d9a66d201d3c0ad3d913c6e4caf4c75761ba74de447f6aa9eed3d86
-  data.tar.gz: 06b33e84de325d990cf32790460dfc30dc5eb765db574c344fa64762463ad668ec47d23db41646f748fdb8d658fd3feff069cfac0f748c7ddf238a84479a188b
+  metadata.gz: 4fc3260da9272d6fe2a8b29c939ea661e49cb45d28b7a082021a44d6823c96d1612860d6a8cdfe5acc0973c0bdbbeeaa55869f0831999396826b2653c47a29c2
+  data.tar.gz: 11113a95d8b63b1bed523f0fd98755dd9b4a176435b40a3cbf877d5eabd136e30aec8eba5ee9b3369d8c1af3311f8883910f7965d19747b077e3dbf9ab867b50

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.0.0.beta5
+* Change :max_tries back to :tries.
+
 ## 2.0.0.beta4
 * Change #retry back to #retriable. Didn't like the idea of defining a method that is also a reserved word.
 * Add ability for `:on` argument to accept a `Hash` where the keys are exception types and the values are a single or list of `Regexp` pattern(s) to match against exception messages for retrial.

data/README.md

@@ -23,7 +23,7 @@ gem install retriable
 In your ruby script:
 
 ```ruby
-require 'retriable'
+require 'retriable', '~> 2.0'
 ```
 
 In your Gemfile:
@@ -66,7 +66,7 @@ end
 
 Here are the available options:
 
-`max_tries` (default: 3) - Number of attempts to make at running your code block.
+`tries` (default: 3) - Number of attempts to make at running your code block.
 
 `base_interval` (default: 0.5) - The initial interval in seconds between attempts.
 
@@ -82,7 +82,7 @@ randomized_interval = retry_interval * (random value in range [1 - randomization
 
 `max_elapsed_time`  (default: 900 (15 min)) - The maximum amount of total time that code is allowed to keep being retried.
 
-`intervals`  (default: nil) - Skip generated intervals and provide your own array of intervals in seconds. Setting this option will ignore `max_tries`, `base_interval`, `max_interval`, `rand_factor`, and `multiplier` values.
+`intervals`  (default: nil) - Skip generated intervals and provide your own array of intervals in seconds. Setting this option will ignore `tries`, `base_interval`, `max_interval`, `rand_factor`, and `multiplier` values.
 
 `timeout` (default: 0) - Number of seconds to allow the code block to run before raising a Timeout::Error
 
@@ -96,7 +96,7 @@ You can change the global defaults with a `#configure` block:
 
 ```ruby
 Retriable.configure do |c|
-  c.max_tries = 5
+  c.tries = 5
   c.max_elapsed_time = 3600 # 1 hour
 end
 ```
@@ -106,7 +106,7 @@ end
 `Retriable.retriable` accepts custom arguments. This example will only retry on a `Timeout::Error`, retry 3 times and sleep for a full second before each attempt.
 
 ```ruby
-Retriable.retriable on: Timeout::Error, max_tries: 3, base_interval: 1 do
+Retriable.retriable on: Timeout::Error, tries: 3, base_interval: 1 do
   # code here...
 end
 ```
@@ -149,7 +149,7 @@ end
 
 ### Custom Interval Array
 
-You can also bypass the built-in interval generation and provide your own array of intervals. Supplying your own intervals overrides the `max_tries`, `base_interval`, `max_interval`, `rand_factor`, and `multiplier` parameters.
+You can also bypass the built-in interval generation and provide your own array of intervals. Supplying your own intervals overrides the `tries`, `base_interval`, `max_interval`, `rand_factor`, and `multiplier` parameters.
 
 ```ruby
 Retriable.retriable intervals: [0.5, 1.0, 2.0, 2.5] do

data/lib/retriable.rb

@@ -17,7 +17,7 @@ module Retriable
   end
 
   def retriable(
-    max_tries:         config.max_tries,
+    tries:             config.tries,
     base_interval:     config.base_interval,
     max_interval:      config.max_interval,
     rand_factor:       config.rand_factor,
@@ -33,14 +33,14 @@ module Retriable
     elapsed_time = -> { Time.now - start_time }
 
     if intervals
-      max_tries = intervals.size
+      tries = intervals.size
     else
       intervals = ExponentialBackoff.new(
-        max_tries: max_tries,
-        base_interval: base_interval,
-        multiplier: multiplier,
-        max_interval: max_interval,
-        rand_factor: rand_factor
+        tries:          tries,
+        base_interval:  base_interval,
+        multiplier:     multiplier,
+        max_interval:   max_interval,
+        rand_factor:    rand_factor
       ).intervals
     end
 
@@ -67,7 +67,7 @@ module Retriable
         end
 
         on_retry.call(exception, attempt, elapsed_time.call, interval) if on_retry
-        raise if attempt >= max_tries || (elapsed_time.call + interval) > max_elapsed_time
+        raise if attempt >= tries || (elapsed_time.call + interval) > max_elapsed_time
         sleep interval if config.sleep_disabled != true
       end
     end

data/lib/retriable/config.rb

@@ -1,7 +1,7 @@
 module Retriable
   class Config
     attr_accessor :sleep_disabled
-    attr_accessor :max_tries
+    attr_accessor :tries
     attr_accessor :base_interval
     attr_accessor :max_interval
     attr_accessor :rand_factor
@@ -14,7 +14,7 @@ module Retriable
 
     def initialize
       @sleep_disabled    = false
-      @max_tries         = 3
+      @tries             = 3
       @base_interval     = 0.5
       @max_interval      = 60
       @rand_factor       = 0.5

data/lib/retriable/exponential_backoff.rb

@@ -1,24 +1,28 @@
 module Retriable
   class ExponentialBackoff
-    attr_accessor :max_tries, :base_interval, :multiplier, :max_interval, :rand_factor
+    attr_accessor :tries
+    attr_accessor :base_interval
+    attr_accessor :multiplier
+    attr_accessor :max_interval
+    attr_accessor :rand_factor
 
     def initialize(
-      max_tries: Retriable.config.max_tries,
-      base_interval: Retriable.config.base_interval,
-      multiplier: Retriable.config.multiplier,
-      max_interval: Retriable.config.max_interval,
-      rand_factor: Retriable.config.rand_factor
+      tries:            Retriable.config.tries,
+      base_interval:    Retriable.config.base_interval,
+      multiplier:       Retriable.config.multiplier,
+      max_interval:     Retriable.config.max_interval,
+      rand_factor:      Retriable.config.rand_factor
       )
 
-      @max_tries = max_tries
-      @base_interval = base_interval
-      @multiplier = multiplier
-      @max_interval = max_interval
-      @rand_factor = rand_factor
+      @tries          = tries
+      @base_interval  = base_interval
+      @multiplier     = multiplier
+      @max_interval   = max_interval
+      @rand_factor    = rand_factor
     end
 
     def intervals
-      intervals = Array.new(max_tries) do |iteration|
+      intervals = Array.new(tries) do |iteration|
         [base_interval * multiplier ** iteration, max_interval].min
       end
 

data/lib/retriable/version.rb

@@ -1,3 +1,3 @@
 module Retriable
-  VERSION = "2.0.0.beta4"
+  VERSION = "2.0.0.beta5"
 end

data/spec/config_spec.rb

@@ -9,8 +9,8 @@ describe Retriable::Config do
     subject.new.sleep_disabled.must_equal false
   end
 
-  it "max tries defaults to 3" do
-    subject.new.max_tries.must_equal 3
+  it "tries defaults to 3" do
+    subject.new.tries.must_equal 3
   end
 
   it "max interval defaults to 60" do

data/spec/exponential_backoff_spec.rb

@@ -5,8 +5,8 @@ describe Retriable::ExponentialBackoff do
     Retriable::ExponentialBackoff
   end
 
-  it "max tries defaults to 3" do
-    subject.new.max_tries.must_equal 3
+  it "tries defaults to 3" do
+    subject.new.tries.must_equal 3
   end
 
   it "max interval defaults to 60" do
@@ -22,7 +22,7 @@ describe Retriable::ExponentialBackoff do
   end
 
   it "generates randomized intervals" do
-    i = subject.new(max_tries: 9).intervals
+    i = subject.new(tries: 9).intervals
     i[0].between?(0.25, 0.75).must_equal true
     i[1].between?(0.375, 1.125).must_equal true
     i[2].between?(0.562, 1.687).must_equal true
@@ -36,7 +36,7 @@ describe Retriable::ExponentialBackoff do
 
   it "generates 5 non-randomized intervals" do
     subject.new(
-      max_tries: 5,
+      tries: 5,
       rand_factor: 0.0
     ).intervals.must_equal([
       0.5,

data/spec/retriable_spec.rb

@@ -56,11 +56,11 @@ describe Retriable do
       end.must_raise TestError
     end
 
-    it "#retriable with 10 max tries" do
+    it "#retriable tries 10 times" do
       attempts = 0
 
       subject.retriable(
-        max_tries: 10
+        tries: 10
       ) do
           attempts += 1
           raise EOFError.new if attempts < 10
@@ -91,7 +91,7 @@ describe Retriable do
           on: [EOFError, ArgumentError],
           on_retry: handler,
           rand_factor: 0.0,
-          max_tries: 9
+          tries: 9
         ) do
           @attempts += 1
           raise ArgumentError.new
@@ -111,7 +111,7 @@ describe Retriable do
 
     describe "retries with an on_#retriable handler, 6 max retries, and a 0.0 rand_factor" do
       before do
-        max_tries = 6
+        tries = 6
         @attempts = 0
         @time_table = {}
 
@@ -124,10 +124,10 @@ describe Retriable do
           on: [EOFError, ArgumentError],
           on_retry: handler,
           rand_factor: 0.0,
-          max_tries: max_tries
+          tries: tries
         ) do
           @attempts += 1
-          raise ArgumentError.new if @attempts < max_tries
+          raise ArgumentError.new if @attempts < tries
         end
       end
 
@@ -147,7 +147,7 @@ describe Retriable do
     end
 
     it "#retriable has a max interval of 1.5 seconds" do
-      max_tries = 6
+      tries = 6
       attempts = 0
       time_table = {}
 
@@ -159,11 +159,11 @@ describe Retriable do
         on: EOFError,
         on_retry: handler,
         rand_factor: 0.0,
-        max_tries: max_tries,
+        tries: tries,
         max_interval: 1.5
       ) do
         attempts += 1
-        raise EOFError.new if attempts < max_tries
+        raise EOFError.new if attempts < tries
       end
 
       time_table.must_equal({
@@ -226,7 +226,7 @@ describe Retriable do
       end
 
       e = -> do
-        subject.retriable max_tries: 4, on: { EOFError => nil, TestError => [/foo/, /bar/] }, on_retry: handler do
+        subject.retriable tries: 4, on: { EOFError => nil, TestError => [/foo/, /bar/] }, on_retry: handler do
           attempts += 1
           case attempts
           when 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta4
+  version: 2.0.0.beta5
 platform: ruby
 authors:
 - Jack Chu