retryable 1.2.5 → 1.3.0

data/README.markdown

@@ -9,7 +9,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 three optional parameters --`:tries`, `:on`, `:sleep` --, and
+It's configured using four optional parameters --`:tries`, `:on`, `:sleep`, `:matching`--, 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
@@ -43,7 +43,7 @@ end
 
 ## Defaults
 
-    :tries => 2, :on => Exception, :sleep => 1, :matching  => /.*/ 
+    :tries => 2, :on => StandardError, :sleep => 1, :matching  => /.*/ 
 
 Sleeping
 --------
@@ -58,8 +58,9 @@ retryable(:sleep => lambda { |n| 4**n }) { }   # sleep 1, 4, 16, etc. each try
 Matching error messages
 --------
 You can also retry based on the exception message:
+
 ```
-:retryable(:matching => /IO timeout/) do |retries, exception|
+retryable(:matching => /IO timeout/) do |retries, exception|
   raise "yo, IO timeout!" if retries == 0
 end
 ```
@@ -67,6 +68,7 @@ end
 Block Parameters
 --------
 Your block is called with two optional parameters: the number of tries until now, and the most recent exception.
+
 ```
 retryable do |retries, exception|
   puts "try #{retries} failed with exception: #{exception}" if retries > 0
@@ -92,6 +94,8 @@ gem 'retryable'
 
 ## Changelog
 
+*  v1.3.0: StandardError is now default exception for rescuing.
+*  v1.2.5: became friendly to any rubygems version installed
 *  v1.2.4: added :matching option + better options validation
 *  v1.2.3: fixed dependencies
 *  v1.2.2: added :sleep option
@@ -101,6 +105,7 @@ gem 'retryable'
 
 ## Thanks
 
-Many thanks to [Chu Yeow for this nifty piece of code](http://blog.codefront.net/2008/01/14/retrying-code-blocks-in-ruby-on-exceptions-whatever/). Look, I liked it
-enough to enhance it a little bit and build a gem from it! :)
+[Chu Yeow for this nifty piece of code](http://blog.codefront.net/2008/01/14/retrying-code-blocks-in-ruby-on-exceptions-whatever/)
+[Scott Bronson](https://github.com/bronson/retryable)
+
 

data/lib/retryable.rb

@@ -3,22 +3,30 @@ module Kernel
   class InvalidRetryableOptions < RuntimeError; end
 
   def retryable(options = {}, &block)
-    opts = { :tries => 2, :sleep => 1, :on => Exception, :matching  => /.*/ }
+    opts = { :tries => 2, :sleep => 1, :on => StandardError, :matching  => /.*/ }
     check_for_invalid_options(options, opts)
     opts.merge!(options)
 
     return nil if opts[:tries] == 0
 
-    retry_exception, tries = [ opts[:on] ].flatten, opts[:tries]
+    on_exception, tries = [ opts[:on] ].flatten, opts[:tries]
     retries = 0
-
+    retry_exception = nil
+    
     begin
-      return yield retries
-    rescue *retry_exception => exception
+      return yield retries, retry_exception
+    rescue *on_exception => exception
       raise unless exception.message =~ opts[:matching]
       raise if retries+1 >= opts[:tries]
-      sleep opts[:sleep].respond_to?(:call) ? opts[:sleep].call(retries) : opts[:sleep]
+
+      # Interrupt Exception could be raised while sleeping
+      begin
+        sleep opts[:sleep].respond_to?(:call) ? opts[:sleep].call(retries) : opts[:sleep]
+      rescue *on_exception
+      end
+
       retries += 1
+      retry_exception = exception
       retry
     end
   end

data/spec/lib/retryable_spec.rb

@@ -6,6 +6,13 @@ describe 'retryable' do
     @attempt = 0
   end
 
+  it "should only catch StandardError by default" do    
+    lambda do
+      count_retryable(:tries => 2) { |tries, ex| raise Exception if tries < 1 }
+    end.should raise_error Exception
+    @try_count.should == 1
+  end
+  
   it "should retry on default exception" do
     Kernel.should_receive(:sleep).once.with(1)
 
@@ -13,6 +20,16 @@ describe 'retryable' do
     @try_count.should == 2
   end
 
+  it "should pass retry count and exception on retry" do
+    Kernel.should_receive(:sleep).once.with(1)
+
+    count_retryable(:tries => 2) do |tries, ex| 
+      ex.class.should == StandardError if tries > 0
+      raise StandardError if tries < 1 
+    end
+    @try_count.should == 2
+  end
+  
   it "should make another try if exception is covered by :on" do
     Kernel.stub!(:sleep)
     count_retryable(:on => [StandardError, ArgumentError, RuntimeError] ) { |tries, ex| raise ArgumentError if tries < 1 }

metadata

@@ -1,119 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: retryable
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 1.3.0
   prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 5
-  version: 1.2.5
 platform: ruby
-authors: 
+authors:
 - Nikita Fedyashev
 - Carlo Zottmann
 - Chu Yeow
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-17 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157041380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
-        version: 2.5.0
+      - !ruby/object:Gem::Version
+        version: 2.10.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: autotest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2157041380
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &2157040720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 4
-        - 4
-        - 6
+      - !ruby/object:Gem::Version
         version: 4.4.6
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2157040720
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2157040080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *2157040080
 description: Kernel#retryable, allow for retrying of code blocks.
 email: loci.master@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
-files: 
+files:
 - lib/retryable.rb
 - README.markdown
 - spec/lib/retryable_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/nfedyashev/retryable
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.1
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Kernel#retryable, allow for retrying of code blocks.
-test_files: 
+test_files:
 - spec/lib/retryable_spec.rb
 - spec/spec_helper.rb
-has_rdoc: