retryable 1.2.2 → 1.2.3

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 two optional parameters --`:tries` and `:on`--, and
+It's configured using three optional parameters --`:tries`, `:on`, `:sleep` --, 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,8 +43,17 @@ end
 
 ## Defaults
 
-    :tries => 1, :on => Exception
-    
+    :tries => 2, :on => Exception, :sleep => 1
+
+Sleeping
+--------
+By default Retryable waits for one second between retries. You can change this and even provide your own exponential backoff scheme.
+
+```
+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
+```    
   
 Installation
 -------
@@ -52,7 +61,7 @@ Installation
 Install the gem:
 
 ``` bash
-$ gem install retryable
+$ gem install retryable --force
 ```
 
 Add it to your Gemfile:
@@ -64,6 +73,7 @@ gem 'retryable'
 
 ## Changelog
 
+*  v1.4.0: :sleep option added
 *  v1.3: 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,19 +1,20 @@
-# Code originally by Chu Yeow, see 
-# http://blog.codefront.net/2008/01/14/retrying-code-blocks-in-ruby-on-exceptions-whatever/
-# Slightly rewritten to allow for passing of more than just type of exception.
 
-def retryable(options = {}, &block)
-  opts = { :tries => 1, :on => Exception }.merge(options)
+module Kernel
+  def retryable(options = {}, &block)
+    opts = { :tries => 2, :sleep => 1, :on => Exception }.merge(options)
 
-  return nil if opts[:tries] == 0
+    return nil if opts[:tries] == 0
 
-  retry_exception, tries = [ opts[:on] ].flatten, opts[:tries]
+    retry_exception, tries = [ opts[:on] ].flatten, opts[:tries]
+    retries = 0
 
-  begin
-    return yield
-  rescue *retry_exception
-    retry if (tries -= 1) > 0
+    begin
+      return yield retries
+    rescue *retry_exception
+      raise if retries+1 >= opts[:tries]
+      sleep opts[:sleep].respond_to?(:call) ? opts[:sleep].call(retries) : opts[:sleep]
+      retries += 1
+      retry
+    end
   end
-
-  yield
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: retryable
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 1
   - 2
-  - 2
-  version: 1.2.2
+  - 3
+  version: 1.2.3
 platform: ruby
 authors: 
 - Nikita Fedyashev
@@ -17,57 +17,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-10 00:00:00 Z
+date: 2011-05-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id001
-  name: retryable
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 6
-        - 0
-        version: 1.6.0
-  version_requirements: *id002
-  name: jeweler
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id003
-  name: bundler
+  name: rspec
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -78,41 +33,22 @@ dependencies:
         - 5
         - 0
         version: 2.5.0
-  version_requirements: *id004
-  name: rspec
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id005
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 3
         segments: 
-        - 2
-        - 5
         - 0
-        version: 2.5.0
-  version_requirements: *id006
-  name: rspec
-  prerelease: false
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: Kernel#retryable, allow for retrying of code blocks.
 email: loci.master@gmail.com
 executables: []
@@ -122,15 +58,8 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 files: 
-- .travis.yml
-- Gemfile
-- README.markdown
-- Rakefile
-- VERSION
 - lib/retryable.rb
-- retryable.gemspec
-- spec/lib/retryable_spec.rb
-- spec/spec_helper.rb
+- README.markdown
 homepage: http://github.com/nfedyashev/retryable
 licenses: 
 - MIT
@@ -153,10 +82,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
@@ -166,3 +97,4 @@ specification_version: 3
 summary: Kernel#retryable, allow for retrying of code blocks.
 test_files: []
 
+has_rdoc: 

data/.travis.yml

@@ -1,4 +0,0 @@
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - ree

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-gemspec
-

data/Rakefile

@@ -1,44 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "retryable"
-  gem.homepage = "http://github.com/nfedyashev/retryable"
-  gem.license = "MIT"
-  gem.summary = %Q{Kernel#retryable, allow for retrying of code blocks.}
-  gem.description = %Q{Kernel#retryable, allow for retrying of code blocks.}
-  gem.email = "loci.master@gmail.com"
-  gem.authors = ["Nikita Fedyashev", "Carlo Zottmann", "Chu Yeow"]
-
-  gem.add_development_dependency 'bundler', ['>= 1.0.0']
-  gem.add_development_dependency 'rspec', '~> 2.5.0'
-
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "retryable #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-1.2.2

data/retryable.gemspec

@@ -1,62 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{retryable}
-  s.version = "1.2.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Nikita Fedyashev", "Carlo Zottmann", "Chu Yeow"]
-  s.date = %q{2011-05-10}
-  s.description = %q{Kernel#retryable, allow for retrying of code blocks.}
-  s.email = %q{loci.master@gmail.com}
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
-  s.files = [
-    ".travis.yml",
-    "Gemfile",
-    "README.markdown",
-    "Rakefile",
-    "VERSION",
-    "lib/retryable.rb",
-    "retryable.gemspec",
-    "spec/lib/retryable_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/nfedyashev/retryable}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.1}
-  s.summary = %q{Kernel#retryable, allow for retrying of code blocks.}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<retryable>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
-      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
-      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
-    else
-      s.add_dependency(%q<retryable>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-      s.add_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
-      s.add_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
-    end
-  else
-    s.add_dependency(%q<retryable>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-    s.add_dependency(%q<bundler>, [">= 1.0.0"])
-    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
-    s.add_dependency(%q<bundler>, [">= 1.0.0"])
-    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
-  end
-end
-

data/spec/lib/retryable_spec.rb

@@ -1,53 +0,0 @@
-require 'spec_helper'
-
-describe 'retryable' do
-
-  before(:each) do
-    @attempt = 0
-  end
-
-  it "should make another try on exception" do
-    retryable(:tries => 1, :on => RuntimeError) do
-      @attempt = @attempt + 1
-      raise RuntimeError unless @attempt == 2
-    end
-  end
-
-  it "should make another try if exception is in whitelist" do
-    retryable(:tries => 1, :on => [StandardError, ArgumentError, RuntimeError]) do
-      @attempt = @attempt + 1
-      raise ArgumentError unless @attempt == 2
-    end
-  end
-
-  it "should not try on unexpected exception" do
-    lambda do
-      retryable(:tries => 1, :on => RuntimeError) do
-        @attempt = @attempt + 1
-        raise StandardError unless @attempt == 2
-      end
-    end.should raise_error StandardError
-  end
-
-  it "should make always retry on default exception" do
-    retryable(:tries => 1) do
-      @attempt = @attempt + 1
-      raise StandardError unless @attempt == 2
-    end
-  end
-
-  it "should retry once unless :tries explicitly set" do
-    retryable do
-      @attempt = @attempt + 1
-      raise StandardError unless @attempt == 2
-    end
-  end
-
-  it "should retry twice" do
-    retryable(:tries => 2, :on => RuntimeError) do
-      @attempt = @attempt + 1
-      raise RuntimeError unless @attempt == 3
-    end
-  end
-
-end

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-
-require File.dirname(__FILE__) + '/../lib/retryable'
-require 'rspec'
-
-RSpec.configure do |config|
-  # Remove this line if you don't want RSpec's should and should_not
-  # methods or matchers
-  require 'rspec/expectations'
-end