retriable 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caa61297a00e84eb47ae1cb5ba47e5c6c7c1ac15
-  data.tar.gz: 58ae81f587962572385c25a174c937ab64498108
+  metadata.gz: 9b679f765910990f95431fe330d2ec2a1340056d
+  data.tar.gz: f3eb6ca16690e20b673d51cd7c93f240a846ab3f
 SHA512:
-  metadata.gz: a46713eaf3682dff2cab88edae795817fba5087edb2d79092d8d9c70b7db74376a0b57cf7fcae425c7862d835459ebce48421294b1f0347cc673c742d8343b52
-  data.tar.gz: b7ab15c4766136e3136a8b48686d6709439987d31b369dd04802e236def0b463f02f3a95d73f010fcba0e129bc14c36010e513c0ec8f01f3930acf63d4a71654
+  metadata.gz: 613b716a3e0a2164f03def1a0db227868733f066830130da7bc05afeff520948100288eef753f1e94387b7cdd365207202aa8ff38cac69def7680e60305ff70e
+  data.tar.gz: c4ec29c385614fcbe2525b073e509a99b0e803ef889d8365ed45c7493167afa299424c55ec6bc8321d29769f76c2712c9b4fad8eb2f05358f2d4289e6536e990

data/.rubocop.yml

@@ -0,0 +1,38 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+  
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/InheritException:
+  Enabled: false
+
+Style/IndentArray:
+  Enabled: false
+
+Style/IndentHash:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false

data/.travis.yml

@@ -10,16 +10,20 @@ rvm:
   - 2.4.0
   - rbx
   - jruby-9.0.5.0
-  - jruby-9.1.6.0
+  - jruby-9.1.7.0
   - ruby-head
   - jruby-head
 
 matrix:
   allow_failures:
-    - rvm: rbs
+    - rvm: rbx
     - rvm: ruby-head
     - rvm: jruby-head
 
+before_install:
+  - gem update --system
+  - gem install bundler
+  
 addons:
   code_climate:
     repo_token: 20a1139ef1830b4f813a10a03d90e8aa179b5226f75e75c5a949b25756ebf558

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## HEAD
 
+## 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-
+* Clean up Rakefile testing cruft. @bruno-
+* Use `.any?` in the `:on` hash processing. @apurvis
+
 ## 3.0.0
 * Require ruby 2.0+.
 * Breaking Change: `on` with a `Hash` value now matches subclassed exceptions. Thanks @apurvis!

data/Gemfile

@@ -5,11 +5,15 @@ gemspec
 
 group :test do
   # gem "ruby_gntp"
-  gem "minitest-focus"
   gem "codeclimate-test-reporter", require: false
+  gem "minitest-focus"
   gem "simplecov", require: false
 end
 
+group :development do
+  gem "rubocop"
+end
+
 group :development, :test do
   gem "pry"
 end

data/Guardfile

@@ -4,5 +4,5 @@
 guard :minitest do
   watch(%r{^spec/(.*)_spec\.rb})
   watch(%r{^lib/retriable/(.+)\.rb})  { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^spec/spec_helper\.rb})    { 'spec' }
+  watch(%r{^spec/spec_helper\.rb})    { "spec" }
 end

data/README.md

@@ -1,6 +1,6 @@
 #Retriable
 
-[![Build Status](https://secure.travis-ci.org/kamui/retriable.png)](http://travis-ci.org/kamui/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)
 [![Test Coverage](https://codeclimate.com/github/kamui/retriable/badges/coverage.svg)](https://codeclimate.com/github/kamui/retriable)
 

data/Rakefile

@@ -6,11 +6,7 @@ Bundler::GemHelper.install_tasks
 require "rake/testtask"
 task default: :test
 
-desc "Run tests"
-task :test do
-  Rake::TestTask.new do |t|
-    t.libs << "lib" << "spec"
-    t.pattern = "spec/**/*_spec.rb"
-    t.verbose = true
-  end
-end
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = true
+end

data/lib/retriable.rb

@@ -4,9 +4,7 @@ require_relative "retriable/exponential_backoff"
 require_relative "retriable/version"
 
 module Retriable
-  extend self
-
-  attr_reader :config
+  module_function
 
   def self.configure
     yield(config)
@@ -39,28 +37,22 @@ module Retriable
         base_interval:  base_interval,
         multiplier:     multiplier,
         max_interval:   max_interval,
-        rand_factor:    rand_factor
+        rand_factor:    rand_factor,
       ).intervals
     end
 
-    exception_list = on.kind_of?(Hash) ? on.keys : on
+    exception_list = on.is_a?(Hash) ? on.keys : on
 
     tries.times do |index|
       try = index + 1
       begin
-        if timeout
-          Timeout::timeout(timeout) { return yield(try) }
-        else
-          return yield(try)
-        end
+        return Timeout.timeout(timeout) { return yield(try) } if timeout
+        return yield(try)
       rescue *[*exception_list] => exception
-        if on.kind_of?(Hash)
-          message_match = exception_list.select { |e| exception.is_a?(e) }.inject(false) do |match, e|
-            break match if match
-            match || [*on[e]].empty? || [*on[e]].any? { |pattern| exception.message =~ pattern }
+        if on.is_a?(Hash)
+          raise unless exception_list.any? do |e|
+            exception.is_a?(e) && ([*on[e]].empty? || [*on[e]].any? { |pattern| exception.message =~ pattern })
           end
-
-          raise unless message_match
         end
 
         interval = intervals[index]

data/lib/retriable/exponential_backoff.rb

@@ -16,17 +16,18 @@ module Retriable
 
     def intervals
       intervals = Array.new(tries) do |iteration|
-        [base_interval * multiplier ** iteration, max_interval].min
+        [base_interval * multiplier**iteration, max_interval].min
       end
 
-      return intervals if rand_factor == 0
+      return intervals if rand_factor.zero?
 
       intervals.map { |i| randomize(i) }
     end
 
     private
+
     def randomize(interval)
-      return interval if rand_factor == 0
+      return interval if rand_factor.zero?
       delta = rand_factor * interval * 1.0
       min = interval - delta
       max = interval + delta

data/lib/retriable/version.rb

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

data/retriable.gemspec

@@ -1,5 +1,5 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "retriable/version"
 
@@ -8,10 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Retriable::VERSION
   spec.authors       = ["Jack Chu"]
   spec.email         = ["jack@jackchu.com"]
-  spec.summary       = %q{Retriable is an simple DSL to retry failed code blocks with randomized exponential backoff}
-  spec.description   = %q{Retriable is an simple DSL to retry failed code blocks with randomized exponential backoff. This is especially useful when interacting external api/services or file system calls.
-}
-  spec.homepage      = %q{http://github.com/kamui/retriable}
+  spec.summary       = "Retriable is an simple DSL to retry failed code blocks with randomized exponential backoff"
+  spec.description   = "Retriable is an simple DSL to retry failed code blocks with randomized exponential backoff. This is especially useful when interacting external api/services or file system calls."
+  spec.homepage      = "http://github.com/kamui/retriable"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,13 +18,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = ">= 2.0.0"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 12.0"
 
   spec.add_development_dependency "minitest", "~> 5.10"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-minitest"
-  spec.add_development_dependency "listen", "~> 3.1"
+
+  if RUBY_VERSION < "2.3"
+    spec.add_development_dependency "ruby_dep", "~> 1.3.1"
+    spec.add_development_dependency "listen", "~> 3.0.8"
+  else
+    spec.add_development_dependency "listen", "~> 3.1"
+  end
 end

data/spec/exponential_backoff_spec.rb

@@ -35,7 +35,7 @@ describe Retriable::ExponentialBackoff do
       4.350816718580626,
       5.339852157217869,
       11.889873261212443,
-      18.756037881636484
+      18.756037881636484,
     ])
   end
 
@@ -47,7 +47,7 @@ describe Retriable::ExponentialBackoff do
     expect(subject.new(base_interval: 1).intervals).must_equal([
       1.0488135024422882,
       1.8227840477522461,
-      2.4812175837998227
+      2.4812175837998227,
     ])
   end
 
@@ -55,7 +55,7 @@ describe Retriable::ExponentialBackoff do
     expect(subject.new(multiplier: 1).intervals).must_equal([
       0.5244067512211441,
       0.607594682584082,
-      0.5513816852888495
+      0.5513816852888495,
     ])
   end
 
@@ -63,7 +63,7 @@ describe Retriable::ExponentialBackoff do
     expect(subject.new(max_interval: 1.0, rand_factor: 0.0).intervals).must_equal([
       0.5,
       0.75,
-      1.0
+      1.0,
     ])
   end
 
@@ -71,14 +71,14 @@ describe Retriable::ExponentialBackoff do
     expect(subject.new(rand_factor: 0.2).intervals).must_equal([
       0.5097627004884576,
       0.8145568095504492,
-      1.1712435167599646
+      1.1712435167599646,
     ])
   end
 
   it "generates 10 non-randomized intervals" do
     expect(subject.new(
       tries: 10,
-      rand_factor: 0.0
+      rand_factor: 0.0,
     ).intervals).must_equal([
       0.5,
       0.75,
@@ -89,7 +89,7 @@ describe Retriable::ExponentialBackoff do
       5.6953125,
       8.54296875,
       12.814453125,
-      19.2216796875
+      19.2216796875,
     ])
   end
 end

data/spec/retriable_spec.rb

@@ -43,7 +43,7 @@ describe Retriable do
       expect do
         subject.retriable do
           tries += 1
-          raise StandardError.new
+          raise StandardError.new, "StandardError occurred"
         end
       end.must_raise StandardError
 
@@ -56,7 +56,7 @@ describe Retriable do
       expect do
         subject.retriable do
           tries += 1
-          raise TestError.new
+          raise TestError.new, "TestError occurred"
         end
       end.must_raise TestError
 
@@ -69,7 +69,7 @@ describe Retriable do
       expect do
         subject.retriable on: TestError do
           tries += 1
-          raise TestError.new
+          raise TestError.new, "TestError occurred"
         end
       end.must_raise TestError
 
@@ -80,11 +80,9 @@ describe Retriable do
       tries = 0
 
       expect do
-        subject.retriable(
-          tries: 10,
-        ) do
+        subject.retriable(tries: 10) do
           tries += 1
-          raise StandardError.new
+          raise StandardError.new, "StandardError occurred"
         end
       end.must_raise StandardError
 
@@ -103,7 +101,7 @@ describe Retriable do
       tries = 0
       time_table = []
 
-      handler = ->(exception, try, elapsed_time, next_interval) do
+      handler = lambda do |exception, _try, _elapsed_time, next_interval|
         expect(exception.class).must_equal ArgumentError
         time_table << next_interval
       end
@@ -115,7 +113,7 @@ describe Retriable do
           tries: 10,
         ) do
           tries += 1
-          raise ArgumentError.new
+          raise ArgumentError.new, "ArgumentError occurred"
         end
       end.must_raise ArgumentError
 
@@ -141,7 +139,7 @@ describe Retriable do
         @try_count = 0
         @time_table = {}
 
-        handler = ->(exception, try, elapsed_time, next_interval) do
+        handler = lambda do |exception, try, _elapsed_time, next_interval|
           expect(exception.class).must_equal ArgumentError
           @time_table[try] = next_interval
         end
@@ -153,7 +151,7 @@ describe Retriable do
           tries: tries,
         ) do
           @try_count += 1
-          raise ArgumentError.new if @try_count < tries
+          raise ArgumentError.new, "ArgumentError occurred" if @try_count < tries
         end
       end
 
@@ -162,13 +160,13 @@ describe Retriable do
       end
 
       it "applies a non-randomized exponential backoff to each try" do
-        expect(@time_table).must_equal({
+        expect(@time_table).must_equal(
           1 => 0.5,
           2 => 0.75,
           3 => 1.125,
           4 => 1.6875,
           5 => 2.53125,
-        })
+        )
       end
     end
 
@@ -176,7 +174,7 @@ describe Retriable do
       tries = 0
       time_table = {}
 
-      handler = ->(exception, try, elapsed_time, next_interval) do
+      handler = lambda do |_exception, try, _elapsed_time, next_interval|
         time_table[try] = next_interval
       end
 
@@ -189,17 +187,17 @@ describe Retriable do
           max_interval: 1.5,
         ) do
           tries += 1
-          raise StandardError.new
+          raise StandardError.new, "StandardError occurred"
         end
       end.must_raise StandardError
 
-      expect(time_table).must_equal({
+      expect(time_table).must_equal(
         1 => 0.5,
         2 => 0.75,
         3 => 1.125,
         4 => 1.5,
         5 => nil,
-      })
+      )
     end
 
     it "#retriable with custom defined intervals" do
@@ -212,7 +210,7 @@ describe Retriable do
       ]
       time_table = {}
 
-      handler = ->(exception, try, elapsed_time, next_interval) do
+      handler = lambda do |_exception, try, _elapsed_time, next_interval|
         time_table[try] = next_interval
       end
 
@@ -224,18 +222,18 @@ describe Retriable do
           intervals: intervals,
         ) do
           try_count += 1
-          raise StandardError.new
+          raise StandardError.new, "StandardError occurred"
         end
       end.must_raise StandardError
 
-      expect(time_table).must_equal({
+      expect(time_table).must_equal(
         1 => 0.5,
         2 => 0.75,
         3 => 1.125,
         4 => 1.5,
         5 => 1.5,
         6 => nil,
-      })
+      )
 
       expect(try_count).must_equal(6)
     end
@@ -243,7 +241,7 @@ describe Retriable do
     it "#retriable with a hash exception where the value is an exception message pattern" do
       e = expect do
         subject.retriable on: { TestError => /something went wrong/ } do
-          raise TestError.new('something went wrong')
+          raise TestError, "something went wrong"
         end
       end.must_raise TestError
 
@@ -252,12 +250,17 @@ describe Retriable do
 
     it "#retriable with a hash exception list matches exception subclasses" do
       class SecondTestError < TestError; end
+      class DifferentTestError < Exception; end
 
       tries = 0
       e = expect do
-        subject.retriable on: { TestError => /something went wrong/ }, tries: 4 do
+        subject.retriable on: {
+            DifferentTestError => /should never happen/,
+            TestError => /something went wrong/,
+            DifferentTestError => /also should never happen/,
+          }, tries: 4 do
           tries += 1
-          raise SecondTestError.new('something went wrong')
+          raise SecondTestError, "something went wrong"
         end
       end.must_raise SecondTestError
 
@@ -269,10 +272,10 @@ describe Retriable do
       class SecondTestError < TestError; end
 
       tries = 0
-      e = expect do
+      expect do
         subject.retriable on: { TestError => /something went wrong/ }, tries: 4 do
           tries += 1
-          raise SecondTestError.new('not a match')
+          raise SecondTestError, "not a match"
         end
       end.must_raise SecondTestError
 
@@ -282,7 +285,7 @@ describe Retriable do
     it "#retriable with a hash exception list where the values are exception message patterns" do
       tries = 0
       exceptions = []
-      handler = ->(exception, try, elapsed_time, next_interval) do
+      handler = lambda do |exception, try, _elapsed_time, _next_interval|
         exceptions[try] = exception
       end
 
@@ -291,13 +294,13 @@ describe Retriable do
           tries += 1
           case tries
           when 1
-            raise TestError.new('foo')
+            raise TestError, "foo"
           when 2
-            raise TestError.new('bar')
+            raise TestError, "bar"
           when 3
-            raise StandardError.new
+            raise StandardError
           else
-            raise TestError.new('crash')
+            raise TestError, "crash"
           end
         end
       end.must_raise TestError
@@ -324,7 +327,7 @@ describe Retriable do
       expect do
         retriable do
           tries += 1
-          raise StandardError.new
+          raise StandardError
         end
       end.must_raise StandardError
 
@@ -342,7 +345,7 @@ describe Retriable do
     tries = 0
     time_table = {}
 
-    handler = ->(exception, try, elapsed_time, next_interval) do
+    handler = lambda do |_exception, try, elapsed_time, _next_interval|
       time_table[try] = elapsed_time
     end
 
@@ -355,7 +358,7 @@ describe Retriable do
         on_retry: handler,
       ) do
         tries += 1
-        raise EOFError.new
+        raise EOFError
       end
     end.must_raise EOFError
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,11 +94,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-description: 'Retriable is an simple DSL to retry failed code blocks with randomized
+description: Retriable is an simple DSL to retry failed code blocks with randomized
   exponential backoff. This is especially useful when interacting external api/services
   or file system calls.
-
-'
 email:
 - jack@jackchu.com
 executables: []
@@ -106,6 +104,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -123,7 +122,6 @@ files:
 - spec/exponential_backoff_spec.rb
 - spec/retriable_spec.rb
 - spec/spec_helper.rb
-- wercker.yml
 homepage: http://github.com/kamui/retriable
 licenses:
 - MIT
@@ -144,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Retriable is an simple DSL to retry failed code blocks with randomized exponential

data/wercker.yml

@@ -1,27 +0,0 @@
-box: wercker/rvm
-# Build definition
-build:
-    # The steps that will be executed on build
-    # See the Ruby section on the wercker devcenter:
-    # http://devcenter.wercker.com/articles/languages/ruby.html
-    steps:
-        # Uncomment this to force RVM to use a specific Ruby version
-        - rvm-use:
-            version: 2.3.1
-
-        # A step that executes `bundle install` command
-        - bundle-install
-
-        # A custom script step, name value is used in the UI
-        # and the code value contains the command that get executed
-        - script:
-            name: echo ruby information
-            code: |
-                echo "ruby version $(ruby --version) running"
-                echo "from location $(which ruby)"
-                echo -p "gem list: $(gem list)"
-
-        # Add more steps here:
-        - script:
-             name: rake
-             code: bundle exec rake