retriable 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b679f765910990f95431fe330d2ec2a1340056d
-  data.tar.gz: f3eb6ca16690e20b673d51cd7c93f240a846ab3f
+  metadata.gz: bfe5a1956e7b8921928094fd4306632da5852693
+  data.tar.gz: bc171d15fa1f55ce45151f6e6ce6976b2082a415
 SHA512:
-  metadata.gz: 613b716a3e0a2164f03def1a0db227868733f066830130da7bc05afeff520948100288eef753f1e94387b7cdd365207202aa8ff38cac69def7680e60305ff70e
-  data.tar.gz: c4ec29c385614fcbe2525b073e509a99b0e803ef889d8365ed45c7493167afa299424c55ec6bc8321d29769f76c2712c9b4fad8eb2f05358f2d4289e6536e990
+  metadata.gz: 80395340aa4890214aeb12f331904da265f42af80d4e8bd7400e532d7a47f4828abc659f7ae629a74f6d16ce77f1e88b23fc8518ca4531087d23a566ec5bcacc
+  data.tar.gz: c8385720ed1095508eae24dc918eb620ea4715b13d38ef7d2c921abd65f9fb05f6e95065307be644819405a1d9411e20961e95e06b734aae1333b54c3f45745d

data/.travis.yml

@@ -5,12 +5,12 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
   - rbx
   - jruby-9.0.5.0
-  - jruby-9.1.7.0
+  - jruby-9.1.8.0
   - ruby-head
   - jruby-head
 
@@ -23,7 +23,7 @@ matrix:
 before_install:
   - gem update --system
   - gem install bundler
-  
+
 addons:
   code_climate:
     repo_token: 20a1139ef1830b4f813a10a03d90e8aa179b5226f75e75c5a949b25756ebf558

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## HEAD
 
+## 3.0.2
+
+* Add configuration and options validation.
+
 ## 3.0.1
 * Add `rubocop` linter to enforce coding styles for this library. Also, fix rule violations.
 * Removed `attr_reader :config` that caused a warning. @bruno-

data/README.md

@@ -1,4 +1,4 @@
-#Retriable
+# Retriable
 
 [![Build Status](https://secure.travis-ci.org/kamui/retriable.svg)](http://travis-ci.org/kamui/retriable)
 [![Code Climate](https://codeclimate.com/github/kamui/retriable/badges/gpa.svg)](https://codeclimate.com/github/kamui/retriable)

data/lib/retriable.rb

@@ -15,16 +15,19 @@ module Retriable
   end
 
   def retriable(opts = {})
-    tries             = opts[:tries]            || config.tries
-    base_interval     = opts[:base_interval]    || config.base_interval
-    max_interval      = opts[:max_interval]     || config.max_interval
-    rand_factor       = opts[:rand_factor]      || config.rand_factor
-    multiplier        = opts[:multiplier]       || config.multiplier
-    max_elapsed_time  = opts[:max_elapsed_time] || config.max_elapsed_time
-    intervals         = opts[:intervals]        || config.intervals
-    timeout           = opts[:timeout]          || config.timeout
-    on                = opts[:on]               || config.on
-    on_retry          = opts[:on_retry]         || config.on_retry
+    local_config = opts.empty? ? config : Config.new(config.to_h.merge(opts))
+
+    tries             = local_config.tries
+    base_interval     = local_config.base_interval
+    max_interval      = local_config.max_interval
+    rand_factor       = local_config.rand_factor
+    multiplier        = local_config.multiplier
+    max_elapsed_time  = local_config.max_elapsed_time
+    intervals         = local_config.intervals
+    timeout           = local_config.timeout
+    on                = local_config.on
+    on_retry          = local_config.on_retry
+    sleep_disabled    = local_config.sleep_disabled
 
     start_time = Time.now
     elapsed_time = -> { Time.now - start_time }
@@ -58,7 +61,7 @@ module Retriable
         interval = intervals[index]
         on_retry.call(exception, try, elapsed_time.call, interval) if on_retry
         raise if try >= tries || (elapsed_time.call + interval) > max_elapsed_time
-        sleep interval if config.sleep_disabled != true
+        sleep interval if sleep_disabled != true
       end
     end
   end

data/lib/retriable/config.rb

@@ -1,29 +1,43 @@
+require_relative "exponential_backoff"
+
 module Retriable
   class Config
-    attr_accessor :sleep_disabled
-    attr_accessor :tries
-    attr_accessor :base_interval
-    attr_accessor :max_interval
-    attr_accessor :rand_factor
-    attr_accessor :multiplier
-    attr_accessor :max_elapsed_time
-    attr_accessor :intervals
-    attr_accessor :timeout
-    attr_accessor :on
-    attr_accessor :on_retry
+    ATTRIBUTES = ExponentialBackoff::ATTRIBUTES + [
+      :sleep_disabled,
+      :max_elapsed_time,
+      :intervals,
+      :timeout,
+      :on,
+      :on_retry,
+    ].freeze
+
+    attr_accessor(*ATTRIBUTES)
+
+    def initialize(opts = {})
+      backoff = ExponentialBackoff.new
+
+      @tries            = backoff.tries
+      @base_interval    = backoff.base_interval
+      @max_interval     = backoff.max_interval
+      @rand_factor      = backoff.rand_factor
+      @multiplier       = backoff.multiplier
+      @sleep_disabled   = false
+      @max_elapsed_time = 900 # 15 min
+      @intervals        = nil
+      @timeout          = nil
+      @on               = [StandardError]
+      @on_retry         = nil
+
+      opts.each do |k, v|
+        raise ArgumentError, "#{k} is not a valid option" if !ATTRIBUTES.include?(k)
+        instance_variable_set(:"@#{k}", v)
+      end
+    end
 
-    def initialize
-      @sleep_disabled    = false
-      @tries             = 3
-      @base_interval     = 0.5
-      @max_interval      = 60
-      @rand_factor       = 0.5
-      @multiplier        = 1.5
-      @max_elapsed_time  = 900 # 15 min
-      @intervals         = nil
-      @timeout           = nil
-      @on                = [StandardError]
-      @on_retry          = nil
+    def to_h
+      ATTRIBUTES.each_with_object({}) do |key, hash|
+        hash[key] = public_send(key)
+      end
     end
   end
 end

data/lib/retriable/exponential_backoff.rb

@@ -1,17 +1,26 @@
 module Retriable
   class ExponentialBackoff
-    attr_accessor :tries
-    attr_accessor :base_interval
-    attr_accessor :multiplier
-    attr_accessor :max_interval
-    attr_accessor :rand_factor
+    ATTRIBUTES = [
+      :tries,
+      :base_interval,
+      :multiplier,
+      :max_interval,
+      :rand_factor,
+    ].freeze
+
+    attr_accessor(*ATTRIBUTES)
 
     def initialize(opts = {})
-      @tries         = opts[:tries]         || Retriable.config.tries
-      @base_interval = opts[:base_interval] || Retriable.config.base_interval
-      @max_interval  = opts[:max_interval]  || Retriable.config.max_interval
-      @rand_factor   = opts[:rand_factor]   || Retriable.config.rand_factor
-      @multiplier    = opts[:multiplier]    || Retriable.config.multiplier
+      @tries         = 3
+      @base_interval = 0.5
+      @max_interval  = 60
+      @rand_factor   = 0.5
+      @multiplier    = 1.5
+
+      opts.each do |k, v|
+        raise ArgumentError, "#{k} is not a valid option" if !ATTRIBUTES.include?(k)
+        instance_variable_set(:"@#{k}", v)
+      end
     end
 
     def intervals

data/lib/retriable/version.rb

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

data/spec/config_spec.rb

@@ -44,4 +44,10 @@ describe Retriable::Config do
   it "on retry handler defaults to nil" do
     expect(subject.new.on_retry).must_be_nil
   end
+
+  it "raises errors on invalid configuration" do
+    assert_raises ArgumentError do
+      subject.new(does_not_exist: 123)
+    end
+  end
 end

data/spec/retriable_spec.rb

@@ -364,4 +364,16 @@ describe Retriable do
 
     expect(tries).must_equal 2
   end
+
+  it "raises NoMethodError on invalid configuration" do
+    assert_raises NoMethodError do
+      Retriable.configure { |c| c.does_not_exist = 123 }
+    end
+  end
+
+  it "raises ArgumentError on invalid option on #retriable" do
+    assert_raises ArgumentError do
+      Retriable.retriable(does_not_exist: 123)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-19 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Retriable is an simple DSL to retry failed code blocks with randomized exponential