retries 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd3d179ec65dd4b129917c3de75d16a2338e976f
+  data.tar.gz: 203b004f805b262a373a6a1f013c179aa830a2a6
+SHA512:
+  metadata.gz: 6777f2702802e0eb96db8f76bd97bc8e15da966b3a8d78f31d6cdd819c8a3681d6fc4441d583dcd9d85def9f4a66c56da6bcd12a28f732e34c0c007dec591751
+  data.tar.gz: ab72433058a85d5e6d0844f54aeecc22fa70032fe07965c6200c019dc87c2328f423fd3d75b4239120039e316812213f850d5546b19327ce66f5a5b426b6c427

data/README.md

@@ -48,12 +48,13 @@ end
 ### Handlers
 
 `with_retries` allows you to pass a custom handler that will be called each time before the block is retried.
-The handler will be called with two arguments: `exception` (the rescued exception) and `attempt_number` (the
-number of attempts that have been made thus far).
+The handler will be called with three arguments: `exception` (the rescued exception), `attempt_number` (the
+number of attempts that have been made thus far), and `total_delay` (the number of seconds since the start
+of the time the block was first attempted, including all retries).
 
 ``` ruby
-handler = Proc.new do |exception, attempt_number|
-  puts "Handler saw a #{exception.class}; retry attempt #{attempt_number}"
+handler = Proc.new do |exception, attempt_number, total_delay|
+  puts "Handler saw a #{exception.class}; retry attempt #{attempt_number}; #{total_delay} seconds have passed."
 end
 with_retries(:max_tries => 5, :handler => handler, :rescue => [RuntimeError, ZeroDivisionError]) do |attempt|
   (1 / 0) if attempt == 3
@@ -61,13 +62,13 @@ with_retries(:max_tries => 5, :handler => handler, :rescue => [RuntimeError, Zer
 end
 ```
 
-This will print:
+This will print something like:
 
 ```
-Handler saw a RuntimeError; retry attempt 1
-Handler saw a RuntimeError; retry attempt 2
-Handler saw a ZeroDivisionError; retry attempt 3
-Handler saw a RuntimeError; retry attempt 4
+Handler saw a RuntimeError; retry attempt 1; 2.9e-05 seconds have passed.
+Handler saw a RuntimeError; retry attempt 2; 0.501176 seconds have passed.
+Handler saw a ZeroDivisionError; retry attempt 3; 1.129921 seconds have passed.
+Handler saw a RuntimeError; retry attempt 4; 1.886828 seconds have passed.
 ```
 
 ### Delay parameters

data/lib/retries.rb

@@ -18,7 +18,8 @@ module Kernel
   # @option options [Float] :base_sleep_seconds (0.5) The starting delay between retries.
   # @option options [Float] :max_sleep_seconds (1.0) The maximum to which to expand the delay between retries.
   # @option options [Proc] :handler (nil) If not `nil`, a `Proc` that will be called for each retry. It will be
-  #         passed two arguments, `exception` (the rescued exception) and `attempt_number`.
+  #         passed three arguments, `exception` (the rescued exception), `attempt_number`,
+  #         and `total_delay` (seconds since start of first attempt).
   # @option options [Exception, <Exception>] :rescue (StandardError) This may be a specific exception class to
   #         rescue or an array of classes.
   # @yield [attempt_number] The (required) block to be executed, which is passed the attempt number as a
@@ -34,18 +35,18 @@ module Kernel
       raise "#{options_error_string} :base_sleep_seconds cannot be greater than :max_sleep_seconds."
     end
     handler = options[:handler]
-    exception_types_to_rescue = options[:rescue] || StandardError
-    exception_types_to_rescue = [exception_types_to_rescue] unless exception_types_to_rescue.is_a?(Array)
+    exception_types_to_rescue = Array(options[:rescue]) || [StandardError]
     raise "#{options_error_string} with_retries must be passed a block" unless block_given?
 
     # Let's do this thing
     attempts = 0
+    start_time = Time.now
     begin
       attempts += 1
       return block.call(attempts)
     rescue *exception_types_to_rescue => exception
       raise exception if attempts >= max_tries
-      handler.call(exception, attempts) if handler
+      handler.call(exception, attempts, Time.now - start_time) if handler
       # Don't sleep at all if sleeping is disabled (used in testing).
       if Retries.sleep_enabled
         # The sleep time is an exponentially-increasing function of base_sleep_seconds. But, it never exceeds

data/lib/retries/version.rb

@@ -1,3 +1,3 @@
 class Retries
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/retries.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   # For running the tests
   gem.add_development_dependency "rake"
   gem.add_development_dependency "scope"
+  gem.add_development_dependency "rr"
 
   # For generating the documentation
   gem.add_development_dependency "yard"

data/test/retries_test.rb

@@ -1,10 +1,17 @@
 require "scope"
 require "minitest/autorun"
 require "timeout"
+require "rr"
 
 $:.unshift File.join(File.dirname(__FILE__), "../lib")
 require "retries"
 
+module Scope
+  class TestCase
+    include RR::Adapters::MiniTest
+  end
+end
+
 class CustomErrorA < RuntimeError; end
 class CustomErrorB < RuntimeError; end
 
@@ -66,8 +73,8 @@ class RetriesTest < Scope::TestCase
         assert_equal exception_handler_run_times, attempt_number
         assert exception.is_a?(CustomErrorA)
       end
-      with_retries(:max_tries => 4, :base_sleep_seconds => 0, :max_sleep_seconds => 0, :handler => handler,
-                   :rescue => CustomErrorA) do
+      with_retries(:max_tries => 4, :base_sleep_seconds => 0, :max_sleep_seconds => 0,
+                   :handler => handler, :rescue => CustomErrorA) do
         tries += 1
         raise CustomErrorA.new if tries < 4
       end
@@ -75,6 +82,21 @@ class RetriesTest < Scope::TestCase
       assert_equal 3, exception_handler_run_times
     end
 
+    should "pass total elapsed time to :handler upon each handled exception" do
+      Retries.sleep_enabled = false
+      fake_time = -10
+      stub(Time).now { fake_time += 10 }
+      handler = Proc.new do |exception, attempt_number, total_delay|
+        # Check that the handler is passed the proper total delay time
+        assert_equal fake_time, total_delay
+      end
+      tries = 0
+      with_retries(:max_tries => 3, :handler => handler, :rescue => CustomErrorA) do
+        tries += 1
+        raise CustomErrorA.new if tries < 3
+      end
+    end
+
     should "not sleep if Retries.sleep_enabled is false" do
       Retries.sleep_enabled = false
       assert_raises(RuntimeError) do # If we get a Timeout::Error, this won't pass.

metadata

@@ -1,78 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: retries
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Caleb Spare
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-14 00:00:00.000000000 Z
+date: 2013-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: scope
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Retries is a gem for retrying blocks with randomized exponential backoff.
@@ -94,27 +99,26 @@ files:
 - test/retries_test.rb
 homepage: https://github.com/ooyala/retries
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Retries is a gem for retrying blocks with randomized exponential backoff.
 test_files:
 - test/retries_test.rb