retriable 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56415871220fd82fcfd72e2748a5a8283072bfa9
-  data.tar.gz: 93dfae047c70da13dc9b9a64331d1b1e62273ced
+  metadata.gz: caa61297a00e84eb47ae1cb5ba47e5c6c7c1ac15
+  data.tar.gz: 58ae81f587962572385c25a174c937ab64498108
 SHA512:
-  metadata.gz: 42de39c02026a18aa580bac6186038460f1d83a48681b703da8fbe40bb1bcdd5a6f4e06d9cbc9daf5e2129d1e9f32c0cb05ce1f153de721e07341ed0f00dbb8c
-  data.tar.gz: 42dd35b52204d819e1b1d0c31eaadc5eef643b8a1daf69e694e29aff900d7995aa159ec2060bf4d414f66ffb2e5b6fd458ec2574a61d4192064cb0fc802a43e1
+  metadata.gz: a46713eaf3682dff2cab88edae795817fba5087edb2d79092d8d9c70b7db74376a0b57cf7fcae425c7862d835459ebce48421294b1f0347cc673c742d8343b52
+  data.tar.gz: b7ab15c4766136e3136a8b48686d6709439987d31b369dd04802e236def0b463f02f3a95d73f010fcba0e129bc14c36010e513c0ec8f01f3930acf63d4a71654

data/.travis.yml

@@ -3,21 +3,22 @@
 sudo: false
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.7
-  - 2.2.3
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
   - rbx
-  - jruby-9.0.0.0
+  - jruby-9.0.5.0
+  - jruby-9.1.6.0
   - ruby-head
   - jruby-head
 
 matrix:
   allow_failures:
-    - rvm: 1.9.3
+    - rvm: rbs
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: jruby-9.0.0.0
 
 addons:
   code_climate:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## HEAD
 
+## 3.0.0
+* Require ruby 2.0+.
+* Breaking Change: `on` with a `Hash` value now matches subclassed exceptions. Thanks @apurvis!
+* Remove `awesome_print` from development environment.
+
 ## 2.1.0
 
 * Fix bug #17 due to confusing the initial try as a retry.

data/Gemfile

@@ -12,5 +12,4 @@ end
 
 group :development, :test do
   gem "pry"
-  gem "awesome_print"
 end

data/README.md

@@ -4,17 +4,15 @@
 [![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)
 
-Retriable is an simple DSL to retry failed code blocks with randomized [exponential backoff](http://en.wikipedia.org/wiki/Exponential_backoff) time intervals. This is especially useful when interacting external api/services or file system calls.
+Retriable is a simple DSL to retry failed code blocks with randomized [exponential backoff](http://en.wikipedia.org/wiki/Exponential_backoff) time intervals. This is especially useful when interacting external api/services or file system calls.
 
 ## Requirements
 
-Ruby 1.9.3+
+Ruby 2.0.0+
 
-If you need ruby 1.8.x to 1.9.2 support, use the [1.x branch](https://github.com/kamui/retriable/tree/1.x).
+If you need ruby 1.9.3 support, use the [2.x branch](https://github.com/kamui/retriable/tree/2.x) by specifying `~2.1` in your Gemfile.
 
-There's a [1.x to 2.x migration wiki entry](https://github.com/kamui/retriable/wiki/Migrating-to-2.x) available.
-
-WARNING: 2.x isn't API compatible with 1.x.
+If you need ruby 1.8.x to 1.9.2 support, use the [1.x branch](https://github.com/kamui/retriable/tree/1.x) by specifying `~1.4` in your Gemfile.
 
 ## Installation
 
@@ -33,7 +31,7 @@ require 'retriable'
 In your Gemfile:
 
 ```ruby
-gem 'retriable', '~> 2.0'
+gem 'retriable', '~> 3.0'
 ```
 
 ## Usage
@@ -90,7 +88,7 @@ randomized_interval = retry_interval * (random value in range [1 - randomization
 
 `timeout` (default: nil) - Number of seconds to allow the code block to run before raising a `Timeout::Error` inside each try. Default is `nil` means the code block can run forever without raising error.
 
-`on` (default: [StandardError]) - An `Array` of exceptions to rescue for each try, a `Hash` where the keys are `Exception` classes and the values can be a single `Regexp` pattern or a list of patterns, or a single `Exception` type.
+`on` (default: [StandardError]) - An `Array` of exceptions to rescue for each try, a `Hash` where the keys are `Exception` classes and the values can be a single `Regexp` pattern or a list of patterns, or a single `Exception` type. Subclasses of the listed exceptions will be retried and have their messages matched in the same way.
 
 `on_retry` - (default: nil) - Proc to call after each try is rescued.
 
@@ -135,7 +133,7 @@ Retriable.retriable on: {
 end
 ```
 
-You can also specify a timeout if you want the code block to only make an try for X amount of seconds. This timeout is per try.
+You can also specify a timeout if you want the code block to only try for X amount of seconds. This timeout is per try.
 
 ```ruby
 Retriable.retriable timeout: 60 do
@@ -199,7 +197,7 @@ end
 
 ```ruby
 do_this_on_each_retry = Proc.new do |exception, try, elapsed_time, next_interval|
-  log "#{exception.class}: '#{exception.message}' - #{try} tries in #{elapsed_time} seconds and #{next_interval} seconds until the next try."}
+  log "#{exception.class}: '#{exception.message}' - #{try} tries in #{elapsed_time} seconds and #{next_interval} seconds until the next try."
 end
 
 Retriable.retriable on_retry: do_this_on_each_retry do

data/lib/retriable.rb

@@ -55,14 +55,11 @@ module Retriable
         end
       rescue *[*exception_list] => exception
         if on.kind_of?(Hash)
-          patterns = [*on[exception.class]]
-          message_match = patterns.empty? ? true : false
-          patterns.each do |pattern|
-            if !!(exception.message =~ pattern)
-              message_match = true
-              break
-            end
+          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 }
           end
+
           raise unless message_match
         end
 

data/lib/retriable/version.rb

@@ -1,3 +1,3 @@
 module Retriable
-  VERSION = "2.1.0"
+  VERSION = "3.0.0"
 end

data/retriable.gemspec

@@ -19,12 +19,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 12.0"
 
-  spec.add_development_dependency "minitest", "~> 5.6"
+  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"
 end

data/spec/retriable_spec.rb

@@ -250,6 +250,35 @@ describe Retriable do
       expect(e.message).must_equal "something went wrong"
     end
 
+    it "#retriable with a hash exception list matches exception subclasses" do
+      class SecondTestError < TestError; end
+
+      tries = 0
+      e = expect do
+        subject.retriable on: { TestError => /something went wrong/ }, tries: 4 do
+          tries += 1
+          raise SecondTestError.new('something went wrong')
+        end
+      end.must_raise SecondTestError
+
+      expect(e.message).must_equal "something went wrong"
+      expect(tries).must_equal 4
+    end
+
+    it "#retriable with a hash exception list does not retry matching exception subclass but not message" do
+      class SecondTestError < TestError; end
+
+      tries = 0
+      e = expect do
+        subject.retriable on: { TestError => /something went wrong/ }, tries: 4 do
+          tries += 1
+          raise SecondTestError.new('not a match')
+        end
+      end.must_raise SecondTestError
+
+      expect(tries).must_equal 1
+    end
+
     it "#retriable with a hash exception list where the values are exception message patterns" do
       tries = 0
       exceptions = []

data/spec/spec_helper.rb

@@ -5,17 +5,10 @@ CodeClimate::TestReporter.configure do |config|
   config.logger.level = Logger::WARN
 end
 
-SimpleCov.start do
-  formatter SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    CodeClimate::TestReporter::Formatter
-  ]
-  add_filter 'spec/'
-end
+SimpleCov.start
 
 require "minitest/autorun"
 require "minitest/focus"
-require "awesome_print"
 require "pry"
 
 require_relative "../lib/retriable"

data/wercker.yml

@@ -7,7 +7,7 @@ build:
     steps:
         # Uncomment this to force RVM to use a specific Ruby version
         - rvm-use:
-            version: 2.2.3
+            version: 2.3.1
 
         # A step that executes `bundle install` command
         - bundle-install

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2017-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +80,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-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.
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+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: []
@@ -119,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -127,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Retriable is an simple DSL to retry failed code blocks with randomized exponential