tries 0.2.1 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTJlYjM1ZTlmYTFkYTM3MTU5NWNiOTQ3ZTkyZTEzOGI0ZjBjYmRjOA==
-  data.tar.gz: !binary |-
-    ZWE3MmQ5ODFlOWUyODllZmNkMTVkNzM0MjA2YjlhZTE0ZWY0YWNhOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NmJlZWY0MzJmNmU0ZjkyOWM5OWUyMjcyODJhMDA0NjRhN2RkOTUxZmZiZGYw
-    OGViYTYxZGFmMjBiN2M2NmM5ZDRlNmNjMDRiMzY5YTFjYjllODlmNTM4ZTc0
-    NTUzMjMxMWJkYTJiNjczYjVkNjc3YjM0OWIyNWQ4NjBlMDAxNDk=
-  data.tar.gz: !binary |-
-    NzMyNmQ1YTc1NTFjOTRlZWJiZGE0ZGQyN2U5ZDI4MjE2YTQzNDgxZjJhNWZi
-    NzVlZDM1NzVlODVlMThmYTAwYmIwM2U2ZmFlNWM4YjZjNmEyOGFhMWRmOTBh
-    YTc2M2YyMjdhOTNkMWFjNGMyMmZiODJjNTlhMGFjZDMzNGFmMGM=
+SHA1:
+  metadata.gz: 858991b157959d16b2013139b86b0177bf8fa8f7
+  data.tar.gz: 78375500627b00b518e892279a631421287fb2fb
+SHA512:
+  metadata.gz: 2c0552f9fb62b8bbf2ab74221ed5b89d67a27dc35ca88a7907849ce244a1c734a2f1ecd0c6fada7cf1a99e15be01a52e0403820dc919cc43e89df6cfd27577c1
+  data.tar.gz: 8fd511848722e6f26db4ffa07ad06cbf8cd556f83ab47ebcf5e7f62f5def8b2ae0cb0a6e3aaf3430d35ebbd9ff4e4df29937ef56ad0a4ab2983e67486764e5a8

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 kraut computing UG (haftungsbeschränkt)
+Copyright (c) 2013 kraut computing UG (haftungsbeschränkt)
 
 MIT License
 

data/README.md

@@ -1,8 +1,9 @@
 # Tries
 
+[![Gem Version](https://badge.fury.io/rb/tries.png)](http://badge.fury.io/rb/tries)
 [![Build Status](https://secure.travis-ci.org/krautcomputing/tries.png)](http://travis-ci.org/krautcomputing/tries)
 [![Dependency Status](https://gemnasium.com/krautcomputing/tries.png)](https://gemnasium.com/krautcomputing/tries)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/krautcomputing/tries)
+[![Code Climate](https://codeclimate.com/github/krautcomputing/tries.png)](https://codeclimate.com/github/krautcomputing/tries)
 
 Solidify your code and retry on petty exceptions.
 
@@ -40,9 +41,9 @@ end
 
 ## Detailed usage
 
-```ruby
-# Helper code to explain how it works
+### Helper code to explain how it works
 
+```ruby
 FooError = Class.new(StandardError)
 BarError = Class.new(StandardError)
 
@@ -63,8 +64,9 @@ def method_that_raises_exception
 end
 ```
 
+### Rescue all errors
+
 ```ruby
-# Rescue all errors
 4.tries do
   method_that_raises_exception
 end
@@ -77,8 +79,9 @@ end
 => You made it through!
 ```
 
+### Rescue a specific error
+
 ```ruby
-# Rescue a specific error
 3.tries on: FooError do
   method_that_raises_exception
 end
@@ -86,11 +89,12 @@ end
 => Counter is 1
 => Counter is 2
 => Counter is 3
-=> BarError: BarError
+=> BarError
 ```
 
+### Rescue multiple errors
+
 ```ruby
-# Rescue multiple errors
 3.tries on: [FooError, BarError] do
   method_that_raises_exception
 end
@@ -99,12 +103,16 @@ end
 => Counter is 2
 => Counter is 3
 => Counter is 4
-=> StandardError: StandardError
+=> StandardError
 ```
 
+### Delay execution after error
+
+`delay` is in seconds, fractions are possible
+
+#### Static delay
+
 ```ruby
-# Delay execution after error
-# "delay" parameter is in seconds, fractions are possible
 4.tries delay: 1.5 do
   method_that_raises_exception
 end
@@ -119,8 +127,11 @@ waits 1.5 seconds...
 waits 1.5 seconds...
 => Counter is 5
 => You made it through!
+```
 
-# you can also have an incremental "delay"
+#### Incremental delay
+
+```ruby
 4.tries delay: 1.5, incremental: true do
   method_that_raises_exception
 end
@@ -137,6 +148,71 @@ waits 6 seconds...
 => You made it through!
 ```
 
+### Callback on error
+
+You can set a method or Proc to be called every time an exception occurs. Either set it globally in an initializer, e.g. to log all exceptions to a service like [Airbrake](https://airbrake.io/), or locally when calling `tries`. If both a global callback and a local callback are set, both are called, the global one first.
+
+#### Global callback
+
+```ruby
+# config/initializers/tries.rb
+Tries.configure do |config|
+  config.on_error = lambda do |exception, attempts, next_delay|
+    puts "Whow, a #{exception.class} just occurred! It was attempt nr. #{attempts} to do whatever I was doing."
+    if next_delay
+      puts "I'm gonna wait #{next_delay} seconds and try again."
+    else
+      puts "A delay was not configured so I'm gonna go for it again immediately."
+    end
+  end
+end
+```
+
+```ruby
+3.tries delay: 0.5, incremental: true do
+  method_that_raises_exception
+end
+
+=> Counter is 1
+=> Whow, a FooError just occurred! It was attempt nr. 1 to do whatever I was doing.
+=> I'm gonna wait 0.5 seconds and try again.
+waits 0.5 seconds...
+=> Counter is 2
+=> Whow, a FooError just occurred! It was attempt nr. 2 to do whatever I was doing.
+=> I'm gonna wait 1.0 seconds and try again.
+waits 1 second...
+=> Counter is 3
+=> Whow, a BarError just occurred! It was attempt nr. 3 to do whatever I was doing.
+=> I'm gonna wait 1.5 seconds and try again.
+waits 1.5 seconds...
+=> Counter is 4
+=> StandardError
+```
+
+#### Local callback
+
+```ruby
+callback = lambda do |exception, attempts, next_delay|
+  puts "Local callback! Exception: #{exception.class}, attempt: #{attempts}, next_delay: #{next_delay}"
+end
+
+3.tries delay: 0.5, incremental: true, on_error: callback do
+  method_that_raises_exception
+end
+
+=> Counter is 1
+=> Local callback! Exception: FooError, attempt: 1, next_delay: 0.5
+waits 0.5 seconds...
+=> Counter is 2
+=> Local callback! Exception: FooError, attempt: 2, next_delay: 1.0
+waits 1 second...
+=> Counter is 3
+=> Local callback! Exception: BarError, attempt: 3, next_delay: 1.5
+waits 1.5 seconds...
+=> Counter is 4
+=> StandardError
+```
+
 ## Contributing
 
 1. Fork it

data/lib/tries.rb

@@ -1,4 +1,13 @@
 require 'tries/version'
+require 'gem_config'
+
+module Tries
+  include GemConfig::Base
+
+  with_configuration do
+    has :on_error, classes: Proc
+  end
+end
 
 class Integer
   def tries(options = {}, &block)
@@ -9,8 +18,11 @@ class Integer
 
     begin
       return yield
-    rescue *exception_classes
-      Kernel.sleep calculate_delay(delay, attempts, incremental) if delay
+    rescue *exception_classes => exception
+      next_delay = calculate_delay(delay, attempts, incremental) if delay
+      Tries.configuration.on_error.call(exception, attempts, next_delay) if Tries.configuration.on_error
+      options[:on_error].call(exception, attempts, next_delay) if options[:on_error]
+      Kernel.sleep next_delay if delay
       retry if (attempts += 1) <= self
     end
 

data/lib/tries/version.rb

@@ -1,3 +1,3 @@
 module Tries
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/tries/tries_spec.rb

@@ -60,26 +60,26 @@ describe Tries do
   end
 
   context 'when specifying a delay' do
-    let(:delay) { 1.1 }
+    let(:delay) { 0.1 }
 
-    it 'sleeps the specified delay' do
-      Kernel.should_receive(:sleep).with(delay).exactly(2).times
+    context 'static delay' do
+      it 'sleeps the specified delay' do
+        Kernel.should_receive(:sleep).with(0.1).exactly(2).times
 
-      begin
-        3.tries on: FooError, delay: delay do
-          raise_foo_foo_bar_bar_standard
+        begin
+          3.tries on: FooError, delay: delay do
+            raise_foo_foo_bar_bar_standard
+          end
+        rescue StandardError
         end
-      rescue StandardError
       end
     end
 
-    context 'when setting incremental as true' do
-      let(:delay) { 1 }
-
+    context 'incremental delay' do
       it 'sleeps incrementally' do
-        Kernel.should_receive(:sleep).with(1).ordered
-        Kernel.should_receive(:sleep).with(2).ordered
-        Kernel.should_receive(:sleep).with(3).ordered
+        Kernel.should_receive(:sleep).with(0.1).ordered
+        Kernel.should_receive(:sleep).with(0.2).ordered
+        Kernel.should_receive(:sleep).with(0.3).ordered
 
         begin
           3.tries on: [FooError, BarError], delay: delay, incremental: true do
@@ -90,6 +90,62 @@ describe Tries do
       end
     end
   end
+
+  context 'on_error' do
+    context 'when a global callback is set' do
+      it 'calls the global callback with the correct parameters' do
+        global_on_error = Proc.new {}
+        Tries.configure do |config|
+          config.on_error = global_on_error
+        end
+        global_on_error.should_receive(:call).with(an_instance_of(FooError), 1, 0.1).ordered
+        global_on_error.should_receive(:call).with(an_instance_of(FooError), 2, 0.2).ordered
+        global_on_error.should_receive(:call).with(an_instance_of(BarError), 3, 0.3).ordered
+        begin
+          3.tries on: [FooError, BarError], delay: 0.1, incremental: true do
+            raise_foo_foo_bar_bar_standard
+          end
+        rescue StandardError
+        end
+      end
+    end
+
+    context 'when a local callback is set' do
+      it 'calls the local callback with the correct parameters' do
+        local_on_error = Proc.new {}
+        local_on_error.should_receive(:call).with(an_instance_of(FooError), 1, 0.1).ordered
+        local_on_error.should_receive(:call).with(an_instance_of(FooError), 2, 0.2).ordered
+        local_on_error.should_receive(:call).with(an_instance_of(BarError), 3, 0.3).ordered
+        begin
+          3.tries on: [FooError, BarError], delay: 0.1, incremental: true, on_error: local_on_error do
+            raise_foo_foo_bar_bar_standard
+          end
+        rescue StandardError
+        end
+      end
+    end
+
+    context 'when both a global and a local callback are set' do
+      it 'calls both callbacks with the correct parameters in the correct order' do
+        local_on_error, global_on_error = Proc.new {}, Proc.new {}
+        global_on_error.should_receive(:call).with(an_instance_of(FooError), 1, 0.1).ordered
+        local_on_error.should_receive(:call).with(an_instance_of(FooError), 1, 0.1).ordered
+        global_on_error.should_receive(:call).with(an_instance_of(FooError), 2, 0.2).ordered
+        local_on_error.should_receive(:call).with(an_instance_of(FooError), 2, 0.2).ordered
+        global_on_error.should_receive(:call).with(an_instance_of(BarError), 3, 0.3).ordered
+        local_on_error.should_receive(:call).with(an_instance_of(BarError), 3, 0.3).ordered
+        Tries.configure do |config|
+          config.on_error = global_on_error
+        end
+        begin
+          3.tries on: [FooError, BarError], delay: 0.1, incremental: true, on_error: local_on_error do
+            raise_foo_foo_bar_bar_standard
+          end
+        rescue StandardError
+        end
+      end
+    end
+  end
 end
 
 FooError = Class.new(StandardError)

data/tries.gemspec

@@ -14,15 +14,16 @@ Gem::Specification.new do |gem|
   gem.summary       = 'Solidify your code and retry on petty exceptions'
   gem.description   = 'Solidify your code and retry on petty exceptions'
   gem.homepage      = 'https://github.com/krautcomputing/tries'
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r(^bin/)).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r(^(test|spec|features)/))
   gem.require_paths = ['lib']
 
+  gem.add_development_dependency 'rake', '>= 0.9.0'
   gem.add_development_dependency 'rspec', '~> 2.13.0'
-  gem.add_development_dependency 'rake', '~> 10.0.1'
   gem.add_development_dependency 'rb-fsevent', '~> 0.9.2'
-  gem.add_development_dependency 'guard', '~> 1.6.2'
   gem.add_development_dependency 'guard-rspec', '~> 2.5.0'
+  gem.add_runtime_dependency 'gem_config', '~> 0.2.4'
 end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: tries
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 0.9.0
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.13.0
-  type: :development
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.1
+        version: 2.13.0
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.1
-  type: :development
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
-  prerelease: false
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
-  type: :development
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: guard
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 2.5.0
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.2
-  type: :development
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: guard-rspec
+  name: gem_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :development
+        version: 0.2.4
 description: Solidify your code and retry on petty exceptions
 email: manuel.meurer@gmail.com
 executables: []
@@ -99,7 +99,8 @@ files:
 - spec/tries/tries_spec.rb
 - tries.gemspec
 homepage: https://github.com/krautcomputing/tries
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -107,20 +108,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: Solidify your code and retry on petty exceptions
 test_files:
 - spec/spec_helper.rb
 - spec/tries/tries_spec.rb
+has_rdoc: