tries 0.1.0 → 0.2.0

data/README.md

@@ -4,7 +4,9 @@
 [![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)
 
-Solidify your code and retry on petty exceptions
+Solidify your code and retry on petty exceptions.
+
+Read the accompanying [blog post](http://www.krautcomputing.com/blog/2012/12/19/new-gem-tries/).
 
 ## Requirements
 
@@ -44,13 +46,13 @@ end
 FooError = Class.new(StandardError)
 BarError = Class.new(StandardError)
 
-@counter = 0
+@error_counter = 0
 
 def method_that_raises_exception
-  @counter += 1
-  puts "Counter is #{@counter}"
+  @error_counter += 1
+  puts "Counter is #{@error_counter}"
 
-  case @counter
+  case @error_counter
   when 1 then raise FooError
   when 2 then raise FooError
   when 3 then raise BarError
@@ -63,40 +65,76 @@ end
 
 ```ruby
 # Rescue all errors
-
 4.tries do
   method_that_raises_exception
 end
 
-> Counter is 1
-> Counter is 2
-> Counter is 3
-> Counter is 4
-> Counter is 5
-> You made it through!
+=> Counter is 1
+=> Counter is 2
+=> Counter is 3
+=> Counter is 4
+=> Counter is 5
+=> You made it through!
 ```
 
 ```ruby
-# Rescue only certain errors
-
+# Rescue a specific error
 3.tries on: FooError do
   method_that_raises_exception
 end
 
-> Counter is 1
-> Counter is 2
-> Counter is 3
-> BarError: BarError
+=> Counter is 1
+=> Counter is 2
+=> Counter is 3
+=> BarError: BarError
+```
 
+```ruby
+# Rescue multiple errors
 3.tries on: [FooError, BarError] do
   method_that_raises_exception
 end
 
-> Counter is 1
-> Counter is 2
-> Counter is 3
-> Counter is 4
-> StandardError: StandardError
+=> Counter is 1
+=> Counter is 2
+=> Counter is 3
+=> Counter is 4
+=> StandardError: StandardError
+```
+
+```ruby
+# Delay execution after error
+# "delay" parameter is in seconds, fractions are possible
+4.tries delay: 1.5 do
+  method_that_raises_exception
+end
+
+=> Counter is 1
+waits 1.5 seconds...
+=> Counter is 2
+waits 1.5 seconds...
+=> Counter is 3
+waits 1.5 seconds...
+=> Counter is 4
+waits 1.5 seconds...
+=> Counter is 5
+=> You made it through!
+
+# you can also have an incremental "delay"
+4.tries delay: 1.5, incremental: true do
+  method_that_raises_exception
+end
+
+=> Counter is 1
+waits 1.5 seconds...
+=> Counter is 2
+waits 3 seconds...
+=> Counter is 3
+waits 4.5 seconds...
+=> Counter is 4
+waits 6 seconds...
+=> Counter is 5
+=> You made it through!
 ```
 
 ## Contributing

data/lib/tries.rb

@@ -2,17 +2,25 @@ require 'tries/version'
 
 class Integer
   def tries(options = {}, &block)
-    attempts          = self
+    attempts          = 1
     exception_classes = Array(options[:on] || StandardError)
     delay             = options[:delay]
+    incremental       = options[:incremental]
 
     begin
       return yield
     rescue *exception_classes
-      Kernel.sleep delay if delay
-      retry if (attempts -= 1) > 0
+      Kernel.sleep calculate_delay(delay, attempts, incremental) if delay
+      retry if (attempts += 1) <= self
     end
 
     yield
   end
+
+  private
+  def calculate_delay(delay, attempts, incremental)
+    return delay unless incremental
+
+    delay * attempts
+  end
 end

data/lib/tries/version.rb

@@ -1,3 +1,3 @@
 module Tries
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/tries/tries_spec.rb

@@ -72,6 +72,23 @@ describe Tries do
       rescue StandardError
       end
     end
+
+    context 'when setting incremental as true' do
+      let(:delay) { 1 }
+
+      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
+
+        begin
+          3.tries on: [FooError, BarError], delay: delay, incremental: true do
+            raise_foo_foo_bar_bar_standard
+          end
+        rescue StandardError
+        end
+      end
+    end
   end
 end
 
@@ -82,15 +99,10 @@ def raise_foo_foo_bar_bar_standard
   @error_counter += 1
 
   case @error_counter
-  when 1
-    raise FooError
-  when 2
-    raise FooError
-  when 3
-    raise BarError
-  when 4
-    raise BarError
-  when 5
-    raise StandardError
+  when 1 then raise FooError
+  when 2 then raise FooError
+  when 3 then raise BarError
+  when 4 then raise BarError
+  when 5 then raise StandardError
   end
 end

metadata

@@ -1,17 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: tries
 version: !ruby/object:Gem::Version
-  version: 0.1.0
   prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -19,15 +27,15 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
-  type: :development
+- !ruby/object:Gem::Dependency
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
-- !ruby/object:Gem::Dependency
+        version: 10.0.1
   name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -35,15 +43,15 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.0.1
-  type: :development
+- !ruby/object:Gem::Dependency
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.1
-- !ruby/object:Gem::Dependency
+        version: 0.9.2
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -51,15 +59,15 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
-  type: :development
+- !ruby/object:Gem::Dependency
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
-- !ruby/object:Gem::Dependency
+        version: 1.5.2
   name: guard
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -67,15 +75,15 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.2
-  type: :development
+- !ruby/object:Gem::Dependency
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
-- !ruby/object:Gem::Dependency
+        version: 2.1.2
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -83,14 +91,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.1.2
 description: Solidify your code and retry on petty exceptions
 email: manuel.meurer@gmail.com
 executables: []
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Solidify your code and retry on petty exceptions