retry_block 1.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in retry_block.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+task :test do
+  ruby "-I lib test/test_retry_block.rb"
+end

data/lib/retry_block/version.rb

@@ -0,0 +1,3 @@
+module RetryBlock
+  VERSION = "1.0.1"
+end

data/lib/retry_block.rb

@@ -0,0 +1,38 @@
+require "retry_block/version"
+
+module Kernel
+  def retry_block (opts={}, &block)
+    opts = {
+      :attempts => 1,          # Number of times to try block. Nil means to retry forever until success
+      :sleep => 0,             # Seconds to sleep between attempts
+      :catch => Exception,     # An exception or array of exceptions to listen for
+      :fail_callback => nil    # Proc/lambda that gets executed between attempts
+    }.merge(opts)
+
+    opts[:catch] = [ opts[:catch] ].flatten
+    attempts = 1
+
+    if (not opts[:attempts].nil?) and (not opts[:attempts].is_a? Integer or opts[:attempts] <= 0)
+      raise ArgumentError, "retry_block: :attempts must be an integer >= 0 or nil"
+    end
+
+    begin
+      return yield attempts
+    rescue *opts[:catch] => exception
+
+      # If a callable object was given for :fail_callback then call it
+      if opts[:fail_callback].respond_to? :call
+        callback_opts = [attempts, exception].slice(0, opts[:fail_callback].arity)
+        opts[:fail_callback].call *callback_opts
+      end
+      
+      # If we've maxed out our attempts, raise the exception to the calling code
+      raise if (not opts[:attempts].nil?) and (attempts += 1) > opts[:attempts]
+
+      # Sleep before the next retry if the option was given
+      sleep opts[:sleep] if opts[:sleep].is_a? Numeric and opts[:sleep] > 0
+      
+      retry
+    end #rescue
+  end # def
+end # module

data/retry_block.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "retry_block/version"
+
+Gem::Specification.new do |s|
+  s.name        = "retry_block"
+  s.version     = RetryBlock::VERSION
+  s.authors     = ["Alfred J. Fazio"]
+  s.email       = ["alfred.fazio@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Take control of unstable or indeterminate code with retry_block}
+  s.description = %q{Take control of unstable or indeterminate code with retry_block}
+
+  s.rubyforge_project = "retry_block"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/test_retry_block.rb

@@ -0,0 +1,174 @@
+require 'test/unit'
+require 'lib/retry_block'
+
+class TestRetryBlock < Test::Unit::TestCase
+  def setup
+    @fail_count = 0
+    @run_count = 0
+    @fail_callback = lambda do
+      @fail_count += 1
+    end
+  end
+
+  def test_runs_block_once
+    assert_nothing_raised do
+      retry_block(:fail_callback => @fail_callback) do
+        @run_count += 1
+      end
+    end
+    assert_equal 1, @run_count
+    assert_equal 0, @fail_count
+  end
+
+  def test_runs_block_twice
+    assert_nothing_raised do
+      retry_block(:attempts => 2, :fail_callback => @fail_callback) do
+        @run_count += 1
+        raise TestException if @run_count == 1
+      end
+    end
+    assert_equal 2, @run_count
+    assert_equal 1, @fail_count
+  end
+
+  def test_runs_block_twice_and_fails
+    assert_raises(TestException) do
+      retry_block(:attempts => 2, :fail_callback => @fail_callback) do
+        @run_count += 1
+        raise TestException
+      end
+    end
+    assert_equal 2, @run_count
+    assert_equal 2, @fail_count
+  end
+
+  def test_raises_unexpected_exception1
+    assert_raises(RuntimeError) do
+      retry_block(:attempts => 2, :catch => TestException, :fail_callback => @fail_callback) do
+        @run_count += 1
+        raise RuntimeError
+      end
+    end
+    assert_equal 1, @run_count
+    assert_equal 0, @fail_count
+  end
+
+  def test_raises_unexpected_exception2
+    assert_raises(RuntimeError) do
+      retry_block(:attempts => 2, :catch => [TestException], :fail_callback => @fail_callback) do
+        @run_count += 1
+        raise RuntimeError
+      end
+    end
+    assert_equal 1, @run_count
+    assert_equal 0, @fail_count
+  end
+
+  def test_catches_exception1
+    assert_nothing_raised do
+      retry_block(:attempts => 2, :catch => TestException, :fail_callback => @fail_callback) do
+        @run_count += 1
+        raise TestException unless @run_count == 2
+      end
+    end
+    assert_equal 2, @run_count
+    assert_equal 1, @fail_count
+  end
+
+  def test_catches_multiple_exception
+    assert_nothing_raised do
+      retry_block(:attempts => 3, :catch => [TestException, RuntimeError], :fail_callback => @fail_callback) do
+        @run_count += 1
+        raise TestException if @run_count == 1
+        raise RuntimeError if @run_count == 2
+      end
+    end
+    assert_equal 3, @run_count
+    assert_equal 2, @fail_count
+  end
+
+  def test_doesnt_catch_unexpected_exception_from_list
+    assert_raises(Exception) do
+      retry_block(:attempts => 4, :catch => [TestException, RuntimeError], :fail_callback => @fail_callback) do
+        @run_count += 1
+        raise TestException if @run_count == 1
+        raise RuntimeError if @run_count == 2
+        raise Exception if @run_count == 3
+      end
+    end
+    assert_equal 3, @run_count
+    assert_equal 2, @fail_count
+  end
+
+  def test_fails_on_bad_argument1
+    assert_raises(ArgumentError) do
+      retry_block(:attempts => -1, :fail_callback => @fail_callback) do
+        @run_count += 1
+      end
+    end
+    assert_equal 0, @run_count
+    assert_equal 0, @fail_count
+  end
+
+  def test_fails_on_bad_argument2
+    assert_raises(ArgumentError) do
+      retry_block(:attempts => 0.4, :fail_callback => @fail_callback) do
+        @run_count += 1
+      end
+    end
+    assert_equal 0, @run_count
+    assert_equal 0, @fail_count
+  end
+
+  def test_sleeps
+    sleep_time = 0.1     # Sleep for 1/10 of a second
+    attempts = 3
+    # Doesn't sleep after last failure
+    total_sleep_time = (attempts-1) * sleep_time
+    begin_time = Time.new
+    assert_raises(TestException) do
+      retry_block(:attempts => attempts, :fail_callback => @fail_callback, :sleep => sleep_time) do
+        @run_count += 1
+        raise TestException
+      end
+    end
+    end_time = Time.new
+    time_elapsed = end_time - begin_time
+    assert_equal attempts, @run_count
+    assert_equal attempts, @fail_count
+    # Things are never exact.  Expect that time_elapsed in seconds to be
+    # equal to total_sleep_time plus or minus 5%
+    assert_in_delta total_sleep_time, time_elapsed, total_sleep_time*0.05
+  end
+
+  def test_doesnt_sleep
+    begin_time = Time.new
+    assert_raises(TestException) do
+      retry_block(:attempts => 1, :fail_callback => @fail_callback, :sleep => 0.1) do
+        @run_count += 1
+        raise TestException
+      end
+    end
+    end_time = Time.new
+    time_elapsed = end_time - begin_time
+    assert_equal 1, @run_count
+    assert_equal 1, @fail_count
+    # plus or minus 1/100 of a second ;)
+    assert_in_delta 0.0, time_elapsed, 0.01
+  end
+
+  def test_runs_forever
+    assert_raises(RuntimeError) do
+      retry_block(:attempts => nil, :catch => TestException, :fail_callback => @fail_callback) do
+        @run_count += 1
+        raise TestException unless @run_count == 100
+        raise RuntimeError
+      end
+    end
+    assert_equal 100, @run_count
+    assert_equal 99, @fail_count
+  end
+end
+
+class TestException < Exception
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: retry_block
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Alfred J. Fazio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-04 00:00:00 Z
+dependencies: []
+
+description: Take control of unstable or indeterminate code with retry_block
+email: 
+- alfred.fazio@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/retry_block.rb
+- lib/retry_block/version.rb
+- retry_block.gemspec
+- test/test_retry_block.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: retry_block
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Take control of unstable or indeterminate code with retry_block
+test_files: 
+- test/test_retry_block.rb