retryable 1.2.3 → 1.2.4

data/README.markdown

@@ -43,7 +43,7 @@ end
 
 ## Defaults
 
-    :tries => 2, :on => Exception, :sleep => 1
+    :tries => 2, :on => Exception, :sleep => 1, :matching  => /.*/ 
 
 Sleeping
 --------
@@ -54,14 +54,33 @@ retryable(:sleep => 0) { }                # don't pause at all between retries
 retryable(:sleep => 10) { }               # sleep ten seconds between retries
 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|
+  raise "yo, IO timeout!" if retries == 0
+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
+  pick_up_soap
+end
+```
+
 Installation
 -------
 
 Install the gem:
 
 ``` bash
-$ gem install retryable --force
+$ gem install retryable
 ```
 
 Add it to your Gemfile:
@@ -73,8 +92,10 @@ gem 'retryable'
 
 ## Changelog
 
-*  v1.4.0: :sleep option added
-*  v1.3: stability -- Thoroughly unit-tested
+*  v1.2.4: added :matching option + better options validation
+*  v1.2.3: fixed dependencies
+*  v1.2.2: added :sleep option
+*  v1.2.1: stability -- Thoroughly unit-tested
 *  v1.2: FIX -- block would run twice when `:tries` was set to `0`. (Thanks for the heads-up to [Tuker](http://github.com/tuker).)
 
 

data/lib/retryable.rb

@@ -1,7 +1,11 @@
 
 module Kernel
+  class InvalidRetryableOptions < RuntimeError; end
+
   def retryable(options = {}, &block)
-    opts = { :tries => 2, :sleep => 1, :on => Exception }.merge(options)
+    opts = { :tries => 2, :sleep => 1, :on => Exception, :matching  => /.*/ }
+    check_for_invalid_options(options, opts)
+    opts.merge!(options)
 
     return nil if opts[:tries] == 0
 
@@ -10,11 +14,19 @@ module Kernel
 
     begin
       return yield retries
-    rescue *retry_exception
+    rescue *retry_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]
       retries += 1
       retry
     end
   end
+
+  private
+
+  def check_for_invalid_options(custom_options, default_options)
+    invalid_options = default_options.merge(custom_options).keys - default_options.keys
+    raise InvalidRetryableOptions.new("Invalid options: #{invalid_options.join(", ")}") unless invalid_options.empty?
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: retryable
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 1
   - 2
-  - 3
-  version: 1.2.3
+  - 4
+  version: 1.2.4
 platform: ruby
 authors: 
 - Nikita Fedyashev
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 Z
+date: 2011-05-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -36,9 +36,25 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: autotest
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 4
+        - 4
+        - 6
+        version: 4.4.6
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -48,7 +64,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 description: Kernel#retryable, allow for retrying of code blocks.
 email: loci.master@gmail.com
 executables: []