retriable 1.3.1 → 1.3.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.3.2
+* Clean up option defaults.
+* By default, rescue StandardError and Timeout::Error instead of [Exception](http://www.mikeperham.com/2012/03/03/the-perils-of-rescue-exception).
+
 ## 1.3.1
 * Add `rake` dependency for travis-ci.
 * Update gemspec summary and description.

data/README.md

@@ -25,18 +25,6 @@ In your Gemfile:
 gem 'retriable'
 ```
 
-By default, requiring 'retriable' will include the #retriable method into th Kernel so that you can use it anywhere. If you don't want this behaviour, you can load a non-kernel included version:
-
-```ruby
-gem 'retriable', require => 'retriable/no_kernel'
-```
-
-Or in your ruby script:
-
-```ruby
-require 'retriable/no_kernel'
-```
-
 Usage
 ---------------
 
@@ -58,9 +46,13 @@ end
 Here are the available options:
 
 `tries` (default: 3) - Number of attempts to make at running your code block
+
 `interval` (default: 0) - Number of seconds to sleep between attempts
+
 `timeout` (default: 0) - Number of seconds to allow the code block to run before raising a Timeout::Error
+
 `on` (default: Exception) - Exception or array of exceptions to rescue for each attempt
+
 `on_retry` - (default: nil) - Proc to call after each attempt is rescued
 
 You can pass options via an options `Hash`. This example will only retry on a `Timeout::Error`, retry 3 times and sleep for a full second before each attempt.
@@ -98,9 +90,13 @@ end
 Retriable also provides a callback called `:on_retry` that will run after an exception is rescued. This callback provides the number of `tries`, and the `exception` that was raised in the current attempt. As these are specified in a `Proc`, unnecessary variables can be left out of the parameter list.
 
 ```ruby
-on_retry = Proc.new do |exception, tries|
+do_this_on_each_retry = Proc.new do |exception, tries|
   log "#{exception.class}: '#{exception.message}' - #{tries} attempts."}
 end
+
+retriable :on_retry => do_this_on_each_retry do
+  # code here...
+end
 ```
 
 What if I want to execute a code block at the end, whether or not an exception was rescued ([ensure](http://ruby-doc.org/docs/keywords/1.9/Object.html#method-i-ensure))? Or, what if I want to execute a code block if no exception is raised ([else](http://ruby-doc.org/docs/keywords/1.9/Object.html#method-i-else))? Instead of providing more callbacks, I recommend you just wrap retriable in a begin/retry/else/ensure block:
@@ -119,6 +115,29 @@ ensure
 end
 ```
 
+Non Kernel included version
+---------------------------
+By default, requiring 'retriable' will include the #retriable method into th Kernel so that you can use it anywhere. If you don't want this behaviour, you can load a non-kernel included version:
+
+```ruby
+gem 'retriable', require => 'retriable/no_kernel'
+```
+
+Or in your ruby script:
+
+```ruby
+require 'retriable/no_kernel'
+```
+
+In this case, you'll just execute a retriable block from the Retriable module:
+
+```ruby
+Retriable.retriable do
+  # code here...
+end
+```
+
+
 Credits
 -------
 

data/lib/retriable/retriable.rb

@@ -1,8 +1,10 @@
-# encoding: utf-8
+ # encoding: utf-8
 
 require 'timeout'
 
 module Retriable
+  extend self
+
   class Retry
     attr_accessor :tries
     attr_accessor :interval
@@ -14,7 +16,7 @@ module Retriable
       @tries      = 3
       @interval   = 0
       @timeout    = nil
-      @on         = Exception
+      @on         = [StandardError, Timeout::Error]
       @on_retry   = nil
 
       yield self if block_given?
@@ -42,21 +44,13 @@ module Retriable
     end
   end
 
-  def retriable(options = {}, &block)
-    opts = {
-      :tries => 3,
-      :on => Exception,
-      :interval => 1
-    }
-
-    opts.merge!(options)
-
-    raise 'No block given' unless block_given?
+  def retriable(opts = {}, &block)
+    raise 'no block given' unless block_given?
 
     Retry.new do |r|
-      r.tries      = opts[:tries]
-      r.on         = opts[:on]
-      r.interval   = opts[:interval]
+      r.tries      = opts[:tries] if opts[:tries]
+      r.on         = opts[:on] if opts[:on]
+      r.interval   = opts[:interval] if opts[:interval]
       r.timeout    = opts[:timeout] if opts[:timeout]
       r.on_retry   = opts[:on_retry] if opts[:on_retry]
     end.perform(&block)

data/lib/retriable/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Retriable
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
 end

data/test/retriable_test.rb

@@ -9,9 +9,9 @@ class RetriableTest < MiniTest::Unit::TestCase
 
     retriable do
       i += 1
-      raise Exception.new
+      raise StandardError.new
     end
-  rescue Exception
+  rescue StandardError
     assert_equal 3, i
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-14 00:00:00.000000000 Z
+date: 2012-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2163262180 !ruby/object:Gem::Requirement
+  requirement: &70283922934020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2163262180
+  version_requirements: *70283922934020
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2163261740 !ruby/object:Gem::Requirement
+  requirement: &70283922933200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2163261740
+  version_requirements: *70283922933200
 description: Retriable is an simple DSL to retry code if an exception is raised. This
   is especially useful when interacting external api/services or file system calls.
 email:
@@ -81,4 +81,3 @@ specification_version: 3
 summary: Retriable is an simple DSL to retry code if an exception is raised.
 test_files:
 - test/retriable_test.rb
-has_rdoc: