retryable 2.0.3 → 2.0.4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Retryable 2.0.4 ##
+
+*   :infinite value is now available as :tries paramater.  Use it for retrying your blocks infinitely until it stops failing.
+*   :sleep_method parameter has been added. This can be very useful when you are working with Celluloid which implements its own version of the method sleep.
+    Use `:sleep_method => Celluloid.method(:sleep)` in such cases.
+
 ## Retryable 2.0.3 ##
 
 *   gemspec contains explicit licence option from now on(MIT)

data/README.md

@@ -2,6 +2,7 @@ retryable gem
 =====
 
 [![Build Status](https://travis-ci.org/nfedyashev/retryable.png?branch=master)](https://travis-ci.org/nfedyashev/retryable)
+[![Dependency Status](https://www.versioneye.com/ruby/retryable/badge.svg)](https://www.versioneye.com/ruby/retryable)
 
 Description
 --------
@@ -9,7 +10,7 @@ Description
 Runs a code block, and retries it when an exception occurs. It's great when
 working with flakey webservices (for example).
 
-It's configured using five optional parameters `:tries`, `:on`, `:sleep`, `:matching`, `:ensure`, `:exception_cb`, `:not` and
+It's configured using several optional parameters `:tries`, `:on`, `:sleep`, `:matching`, `:ensure`, `:exception_cb`, `:not`, `:sleep_method` and
 runs the passed block. Should an exception occur, it'll retry for (n-1) times.
 
 Should the number of retries be reached without success, the last exception
@@ -29,6 +30,13 @@ Retryable.retryable(:tries => 3, :on => OpenURI::HTTPError) do
 end
 ```
 
+Try the block forever.
+```ruby
+Retryable.retryable(:tries => :infinite) do
+  # some code
+end
+```
+
 Do _something_, retry up to four times for either `ArgumentError` or
 `TimeoutError` exceptions.
 
@@ -56,7 +64,7 @@ end
 
 ## Defaults
 
-    :tries => 2, :on => StandardError, :sleep => 1, :matching  => /.*/, :ensure => Proc.new { }, :exception_cb => Proc.new { }, :not => []
+    :tries => 2, :on => StandardError, :sleep => 1, :matching  => /.*/, :ensure => Proc.new { }, :exception_cb => Proc.new { }, :not => [], :sleep_method => lambda { |n| Kernel.sleep(n) }
 
 Retryable also could be configured globally to change those defaults:
 
@@ -69,6 +77,7 @@ Retryable.configure do |config|
   config.sleep        = 1
   config.tries        = 2
   config.not          = []
+  config.sleep_method = Celluloid.method(:sleep)
 end
 ```
 
@@ -145,6 +154,17 @@ end
 
 ```
 
+Specify the sleep method to use
+--------
+This can be very useful when you are working with [Celluloid](https://github.com/celluloid/celluloid)
+which implements its own version of the method sleep.
+
+```
+Retryable.retryable(:sleep_method => Celluloid.method(:sleep)) do
+  retrieve_url
+end
+```
+
 Supported Ruby Versions
 -------
 

data/lib/retryable.rb

@@ -49,7 +49,8 @@ module Retryable
         :matching     => self.configuration.matching,
         :ensure       => self.configuration.ensure,
         :exception_cb => self.configuration.exception_cb,
-        :not          => self.configuration.not
+        :not          => self.configuration.not,
+        :sleep_method => self.configuration.sleep_method
       }
 
       check_for_invalid_options(options, opts)
@@ -70,11 +71,12 @@ module Retryable
       rescue *on_exception => exception
         raise unless configuration.enabled?
         raise unless exception.message =~ opts[:matching]
-        raise if retries+1 >= tries
+        raise if tries != :infinite && retries+1 >= tries
 
         # Interrupt Exception could be raised while sleeping
         begin
-          Kernel.sleep opts[:sleep].respond_to?(:call) ? opts[:sleep].call(retries) : opts[:sleep]
+          seconds = opts[:sleep].respond_to?(:call) ? opts[:sleep].call(retries) : opts[:sleep]
+          opts[:sleep_method].call(seconds)
         rescue *not_exception
           raise
         rescue *on_exception

data/lib/retryable/configuration.rb

@@ -8,7 +8,8 @@ module Retryable
       :on,
       :sleep,
       :tries,
-      :not
+      :not,
+      :sleep_method
     ].freeze
 
     attr_accessor :ensure
@@ -18,6 +19,7 @@ module Retryable
     attr_accessor :sleep
     attr_accessor :tries
     attr_accessor :not
+    attr_accessor :sleep_method
 
     attr_accessor :enabled
 
@@ -31,7 +33,7 @@ module Retryable
       @sleep        = 1
       @tries        = 2
       @not          = []
-
+      @sleep_method = lambda do |seconds| Kernel.sleep(seconds) end
       @enabled     = true
     end
 

data/lib/retryable/version.rb

@@ -2,7 +2,7 @@ module Retryable
   class Version
     MAJOR = 2 unless defined? Retryable::Version::MAJOR
     MINOR = 0 unless defined? Retryable::Version::MINOR
-    PATCH = 3 unless defined? Retryable::Version::PATCH
+    PATCH = 4 unless defined? Retryable::Version::PATCH
 
     class << self
 

data/retryable.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'bundler', '~> 1.0'
   gem.authors = ["Nikita Fedyashev", "Carlo Zottmann", "Chu Yeow"]
   gem.description = %q{Retryable#retryable, allow for retrying of code blocks.}
-  gem.email = %q{loci.master@gmail.com}
+  gem.email = %q{nfedyashev@gmail.com}
   gem.files = %w(CHANGELOG.md LICENSE.md README.md Rakefile retryable.gemspec)
   gem.files += Dir.glob("lib/**/*.rb")
   gem.files += Dir.glob("spec/**/*")

data/spec/lib/retryable_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'timeout'
 
 RSpec.describe 'Retryable.retryable' do
   before(:each) do
@@ -67,6 +68,16 @@ RSpec.describe 'Retryable.retryable' do
     expect(@try_count).to eq(3)
   end
 
+  it 'retries infinitely' do
+    expect do
+      Timeout::timeout(3) do
+        count_retryable(:tries => :infinite, :sleep => 0.1) { |tries, ex| raise StandardError }
+      end
+    end.to raise_error Timeout::Error
+
+    expect(@try_count).to be > 10
+  end
+
   it 'retries on default exception' do
     expect(Kernel).to receive(:sleep).once.with(1)
 
@@ -81,6 +92,14 @@ RSpec.describe 'Retryable.retryable' do
     end.to raise_error RangeError
   end
 
+  it 'calls :sleep_method option' do
+    sleep_method = double
+    expect(sleep_method).to receive(:call).twice
+    expect do
+      Retryable.retryable(:tries => 3, :sleep_method => sleep_method) { |tries, ex| raise RangeError if tries < 9}
+    end.to raise_error RangeError
+  end
+
   it 'does not retry any exception if :on is empty list' do
     expect do
       count_retryable(:on => []) { raise }

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/../lib/retryable'
 require 'rspec'
+require 'pry'
 
 RSpec.configure do |config|
   config.disable_monkey_patching!

metadata

@@ -1,74 +1,97 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: retryable
-version: !ruby/object:Gem::Version
-  version: 2.0.3
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: 
+  segments: 
+  - 2
+  - 0
+  - 4
+  version: 2.0.4
 platform: ruby
-authors:
+authors: 
 - Nikita Fedyashev
 - Carlo Zottmann
 - Chu Yeow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2016-07-14 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id001
 description: Retryable#retryable, allow for retrying of code blocks.
-email: loci.master@gmail.com
+email: nfedyashev@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - CHANGELOG.md
 - LICENSE.md
 - README.md
 - Rakefile
-- lib/retryable.rb
+- retryable.gemspec
 - lib/retryable/configuration.rb
 - lib/retryable/version.rb
-- retryable.gemspec
+- lib/retryable.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/retryable_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/nfedyashev/retryable
-licenses:
+licenses: 
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 1.6.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Retryable#retryable, allow for retrying of code blocks.
-test_files:
+test_files: 
 - spec/lib/configuration_spec.rb
 - spec/lib/retryable_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 86143d2b49dbb2f7d5c38fd48eb82ff3e43dd79e
-  data.tar.gz: 740cf211de57aa3579c4ad26ef6f360a23b8b257
-SHA512:
-  metadata.gz: 8efc21fece286e757cb446010f94aab27ca50beeb7336f3daf00b14f6021285357f0cc5a2cc50df2f62772fa0e39768f0b9a001b822aa7024084a511fa7d41ae
-  data.tar.gz: 1c1d0912ec01b1fc7319e9e8ea7d903c14baf4117f33e1b1edcefd11811344b4a23ead38d9dabdbc50dc332acfa64483f35651a224569f00432111d0a881ceaf