retry-this 1.0 → 1.1

data/lib/retry_this.rb

@@ -16,15 +16,18 @@
 
 module RetryThis
   def retry_this(options = {})
-    number_of_retries = options[:times] || 1
+    max_attempts = 1 + (options[:times] || 1)
     error_types = options[:error_types] || [StandardError]
-    (1 + number_of_retries).times do |attempt_number|
+    (1..max_attempts).inject(nil) do |result, attempt_number|
       begin
-        return yield if block_given?
+        return yield attempt_number if block_given?
       rescue *error_types => e
-        raise e unless attempt_number < number_of_retries
+        raise e if attempt_number == max_attempts
+        sleep options[:sleep] if options[:sleep]
       end
     end
   end
+  
+  module_function :retry_this
 end
 

data/test/retry_this_test.rb

@@ -15,7 +15,7 @@
 =end
 
 require 'test/unit'
-require File.join(File.dirname(__FILE__), '../lib/retry_this')
+require File.expand_path('../lib/retry_this', File.dirname(__FILE__))
 
 class RetryThisTest < Test::Unit::TestCase
   include RetryThis
@@ -23,12 +23,12 @@ class RetryThisTest < Test::Unit::TestCase
   def test_should_retry_block_for_given_number_of_times_for_given_error_types_and_raise_error_if_all_attempts_fail
     attempts = 0
     retry_this(:times => 3, :error_types => [TypeError, RuntimeError]) do
-    attempts += 1
-    if attempts % 2 == 0 
-      raise 'some runtime error'
-    else
-      'hi' + 1 # TypeError
-    end
+      attempts += 1
+      if attempts % 2 == 0 
+        raise 'some runtime error'
+      else
+        'hi' + 1 # TypeError
+      end
     end
   rescue => e
     assert e.kind_of?(TypeError) || e.kind_of?(RuntimeError)
@@ -38,8 +38,8 @@ class RetryThisTest < Test::Unit::TestCase
   def test_should_retry_block_for_default_1_time_for_default_standard_error_and_raise_error_if_all_attempts_fail
     attempts = 0
     retry_this do
-    attempts += 1
-    raise StandardError, 'some error'
+      attempts += 1
+      raise StandardError, 'some error'
     end
   rescue => e
     assert_equal('some error', e.message)
@@ -49,8 +49,8 @@ class RetryThisTest < Test::Unit::TestCase
   def test_should_pass_on_an_error_that_is_not_among_given_errors
     attempts = 0
     retry_this(:error_types => [TypeError]) do
-    attempts += 1
-    raise StandardError, 'some error'
+      attempts += 1
+      raise StandardError, 'some error'
     end
   rescue => e
     assert_equal('some error', e.message)
@@ -67,4 +67,56 @@ class RetryThisTest < Test::Unit::TestCase
     assert_equal('hi', value)
     assert_equal(1 + 1, attempts)
   end
+  
+  def test_should_return_value_of_block_in_one_attempt_if_no_error
+    attempts = 0
+    value = retry_this(:error_types => [IOError]) do
+      attempts += 1
+      'hi'
+    end
+    assert_equal('hi', value)
+    assert_equal(1, attempts)
+  end
+  
+  def test_should_allow_block_to_return_explicity_using_return_keyword_if_invoked_from_method
+    klass = Class.new do
+      include RetryThis
+      attr_reader :attempts
+      def do_something
+        @attempts ||= 0
+        value = retry_this do
+          @attempts += 1
+          return 'hi'
+        end        
+      end
+    end
+    object = klass.new
+    assert_equal('hi', object.do_something)
+    assert_equal(1, object.attempts)
+  end
+  
+  def test_should_expose_retry_this_as_module_function
+    assert RetryThis.respond_to? :retry_this
+  end
+  
+  def test_should_yield_attempt_number_to_block
+    attempts = []
+    retry_this(:times => 3) do |attempt_number|
+      attempts << attempt_number
+      raise StandardError, 'some error'
+    end
+  rescue
+    assert_equal([1, 2, 3, 4], attempts)
+  end
+  
+  def test_should_sleep_for_specified_seconds_before_a_retry
+    sleep_durations = []
+    class << self; self; end.send(:define_method, :sleep) { |secs| sleep_durations << secs  }
+    
+    retry_this(:times => 3, :sleep => 10) do
+      raise StandardError, 'some error'
+    end
+  rescue
+    assert_equal([10, 10, 10], sleep_durations)
+  end
 end

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 0
-  version: "1.0"
+  - 1
+  version: "1.1"
 platform: ruby
 authors: 
 - Aman King
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-13 00:00:00 +05:30
+date: 2010-12-01 00:00:00 +05:30
 default_executable: 
 dependencies: []
 
@@ -40,6 +40,7 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -47,6 +48,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -56,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: RetryThis provides a method that takes a block which it will invoke a given number of times before giving up for specified errors