attempt_this 0.9.0 → 0.9.1

data/Gemfile

@@ -1,7 +1,3 @@
 source 'http://rubygems.org'
 
-gem 'rspec'
-
-group :test do
-	gem 'simplecov', require: false	
-end
+gemspec

data/Gemfile.lock

@@ -1,8 +1,17 @@
+PATH
+  remote: .
+  specs:
+    attempt_this (0.9.1)
+
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.2.4)
-    multi_json (1.7.7)
+    docile (1.1.2)
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
+    multi_json (1.8.4)
+    rake (10.1.1)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -11,15 +20,23 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.1)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    systemu (2.5.2)
+    uuid (2.3.7)
+      macaddr (~> 1.0)
 
 PLATFORMS
   ruby
   x86-mingw32
 
 DEPENDENCIES
+  attempt_this!
+  bundler
+  rake
   rspec
   simplecov
+  uuid

data/README.md

@@ -5,7 +5,7 @@ Exception-based retry policy mix-in for Ruby project. Its purpose it to retry a
 ```ruby
 
 attempt(3.times) do
-	# Do something
+    # Do something
 end
 ```
 This will retry the code block up to three times. If the last attempt will result in an exception, that exception will be thrown outside of the attempt block.
@@ -14,7 +14,7 @@ If you don't like that behavior, you can specify a function to be called after a
 is_failed = false
 attempt(3.times)
 .and_default_to(->{is_failed = true}) do
-	# Do something
+    # Do something
 end
 ```
 
@@ -22,7 +22,7 @@ You may want to retry on specific exception types:
 ```ruby
 attempt(3.times)
 .with_filter(RecoverableError1, RecoverableError2) do
-	# Do something
+    # Do something
 end
 ```
 
@@ -30,9 +30,9 @@ You may chose how to reset the environment between failed attempts. This is usef
 ```ruby
 attempt(3.times)
 .with_reset(->{rollback}) do
-	start_transaction
-	# Do something
-	commit_transaction
+    start_transaction
+    # Do something
+    commit_transaction
 end
 ```
 You can specify delay between failed attempts:
@@ -42,19 +42,19 @@ You can specify delay between failed attempts:
 # Wait for 5 seconds between failures.
 attempt(3.times)
 .with_delay(5) do
-	# Do something
+    # Do something
 end
 
 # Random delay between 30 and 60 seconds.
 attempt(3.times)
 .with_delay([30..60]) do
-	# Do something
+    # Do something
 end
 
 # Start with 10 seconds delay and double it after each failed attempt.
 attempt(5.times)
 .with_binary_backoff(10) do
-	# Do something
+    # Do something
 end
 ```
 
@@ -77,8 +77,11 @@ AttemptThis.attempt(5.times).with_filter(*RECOVERABLE_HTTP_ERRORS).scenario(:htt
 
 # And run this from your method:
 attempt(:http) do
-	# Make an HTTP call
+    # Make an HTTP call
 end
 ```
 
+# Return values
+Calling 'attempt' will return result of the code block if there was no exception; otherwise it will return result of the default handler.
+
 Enjoy! And feel free to contribute; just make sure you haven't broken any tests by running 'rake' from project's root.

data/attempt_this.gemspec

@@ -1,15 +1,22 @@
 Gem::Specification.new do |s|
-	s.name				= 'attempt_this'
-	s.version			= '0.9.0'
-	s.date				= '2013-05-05'
-	s.summary			= 'Retry policy mix-in'
-	s.description		= <<EOM
+  s.name				= 'attempt_this'
+  s.version			= '0.9.1'
+  s.date				= '2014-02-18'
+  s.summary			= 'Retry policy mix-in'
+  s.description		= <<EOM
 Retry policy mix-in with configurable number of attempts, delays, exception filters, and fall back strategies.
 
 See project's home page for usage examples and more information.
 EOM
-	s.authors			= ['Aliaksei Baturytski']
-	s.email				= 'abaturytski@gmail.com'
-	s.files				= `git ls-files`.split($/)
-	s.homepage			= 'https://github.com/aliakb/attempt_this'
+  s.authors			= ['Aliaksei Baturytski']
+  s.email				= 'abaturytski@gmail.com'
+  s.files				= `git ls-files`.split($/)
+  s.homepage		= 'https://github.com/aliakb/attempt_this'
+  s.license     = 'MIT'
+
+  s.add_development_dependency('bundler')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('uuid')
 end

data/lib/attempt_this/attempt_object.rb

@@ -2,133 +2,125 @@ require_relative 'binary_backoff_policy.rb'
 require_relative 'exception_type_filter.rb'
 
 module AttemptThis
-	# Retry policy implementation.
-	# This class is internal and is not supposed to be used outside of the module.
-	class AttemptObject
-		@@scenarios = {}					# All registered scenarios
-
-		# Resets all static data.
-		def self.reset
-			@@scenarios = {}
-		end
-
-		def self.get_object(id_or_enumerator)
-			impl = @@scenarios[id_or_enumerator]
-			impl ||= AttemptObject.new(id_or_enumerator)
-			impl
-		end
-
-		# Initializes object with enumerator.
-		def initialize(enumerator)
-			@enumerator = enumerator
-		end
-
-		# Executes the code block.
-		def attempt(block)
-			if (block)
-				last_exception = nil
-				first_time = true
-
-				@delay_policy = ->{} unless @delay_policy
-				@reset_method = ->{} unless @reset_method
-				@exception_filter = ExceptionTypeFilter.new([StandardError]) unless @exception_filter 
-
-				@enumerator.rewind
-				@enumerator.each do
-					@delay_policy.call unless first_time
-					last_exception = nil
-					begin
-						block.call
-						break
-					rescue => ex
-						raise unless @exception_filter.include?(ex)
-						last_exception = ex
-						@reset_method.call
-					end
-					first_time = false
-				end
-
-				# Re-raise the last exception
-				if (last_exception)
-					if (@default_method)
-						@default_method.call
-					else
-						raise last_exception
-					end
-				end
-			end
-
-			# Return self to allow chaining calls.
-			self
-		end
-
-		# Specifies delay in seconds between failed attempts. 
-		def with_delay(delay, &block)
-			# Delay should be either an integer or a range of integers.
-			if (delay.is_a?(Numeric))
-				raise(ArgumentError, "Delay should be a non-negative number; got #{delay}!") unless delay >= 0
-				delay = delay..delay
-			elsif delay.is_a?(Range)
-				raise(ArgumentError, "Range members should be numbers; got #{delay}!") unless delay.first.is_a?(Numeric) && delay.last.is_a?(Numeric)
-				raise(ArgumentError, "Range members should be non-negative; got #{delay}!") unless delay.first >= 0 && delay.last >= 0
-				raise(ArgumentError, "Range's end should be greater than or equal to range's start; got #{delay}!") unless delay.first <= delay.last
-			else
-				raise(ArgumentError, "Delay should be either an number or a range of numbers; got #{delay}!")
-			end
-			raise(ArgumentError, 'Delay policy has already been specified!') if @delay_policy
-			@delay_policy = ->{Kernel.sleep(rand(delay))}
-
-			attempt(block)
-		end
-
-		# Specifies reset method that will be called after each failed attempt.
-		def with_reset(reset_method, &block)
-			raise(ArgumentError, 'Reset method is nil!') unless reset_method
-			raise(ArgumentError, 'Reset method has already been speicifed!') if @reset_method
-
-			@reset_method = reset_method
-			attempt(block)
-		end
-
-		# Specifies default method that should be called after all attempts have failed.
-		def and_default_to(default_method, &block)
-			raise(ArgumentError, 'Default method is nil!') unless default_method
-			raise(ArgumentError, 'Default method has already been specified!') if @default_method
-
-			@default_method = default_method
-			attempt(block)
-		end
-
-		# Specifies delay which doubles between failed attempts.
-		def with_binary_backoff(initial_delay, &block)
-			raise(ArgumentError, "Delay should be a number; got ${initial_delay}!") unless initial_delay.is_a?(Numeric)
-			raise(ArgumentError, "Delay should be a positive number; got #{initial_delay}!") unless initial_delay > 0
-			raise(ArgumentError, "Delay policy has already been specified!") if @delay_policy
-
-			@delay_policy = BinaryBackoffPolicy.new(initial_delay)
-			attempt(block)
-		end
-
-		# Specifies exceptions 
-		def with_filter(*exceptions, &block)
-			raise(ArgumentError, "Empty exceptions list!") unless exceptions.size > 0
-			# Everything must be an exception.
-			exceptions.each do |e|
-				raise(ArgumentError, "Not an exception: #{e}!") unless e <= Exception
-			end
-
-			raise(ArgumentError, "Exception filter has already been specified!") if @exception_filter
-
-			@exception_filter = ExceptionTypeFilter.new(exceptions)
-			attempt(block)
-		end
-
-		# Creates a scenario with the given id.
-		def scenario(id)
-			raise(ArgumentError, 'Blank id!') if id.nil? || id.empty?
-			raise(ArgumentError, "There is already a scenario with id #{id}") if @@scenarios.has_key?(id)
-
-			@@scenarios[id] = self
-		end
-	end
+  # Retry policy implementation.
+  # This class is internal and is not supposed to be used outside of the module.
+  class AttemptObject
+    @@scenarios = {}					# All registered scenarios
+
+    # Resets all static data.
+    def self.reset
+      @@scenarios = {}
+    end
+
+    def self.get_object(id_or_enumerator)
+      impl = @@scenarios[id_or_enumerator]
+      impl ||= AttemptObject.new(id_or_enumerator)
+      impl
+    end
+
+    # Initializes object with enumerator.
+    def initialize(enumerator)
+      @enumerator = enumerator
+    end
+
+    # Executes the code block.
+    def attempt(block)
+      # Returning self will allow chaining calls
+      return self unless block
+
+      last_exception = nil
+      first_time = true
+
+      @delay_policy = ->{} unless @delay_policy
+      @reset_method = ->{} unless @reset_method
+      @exception_filter = ExceptionTypeFilter.new([StandardError]) unless @exception_filter
+
+      @enumerator.rewind
+      @enumerator.with_index do |i|
+        @delay_policy.call unless i == 0
+        last_exception = nil
+        begin
+          return block.call
+        rescue Exception => ex
+          raise unless @exception_filter.include?(ex)
+          @reset_method.call
+          last_exception = ex
+        end
+      end
+
+      if (last_exception)
+        return @default_method[] if @default_method
+        raise last_exception
+      end
+    end
+
+    # Specifies delay in seconds between failed attempts.
+    def with_delay(delay, &block)
+      # Delay should be either an integer or a range of integers.
+      if (delay.is_a?(Numeric))
+        raise(ArgumentError, "Delay should be a non-negative number; got #{delay}!") unless delay >= 0
+        delay = delay..delay
+      elsif delay.is_a?(Range)
+        raise(ArgumentError, "Range members should be numbers; got #{delay}!") unless delay.first.is_a?(Numeric) && delay.last.is_a?(Numeric)
+        raise(ArgumentError, "Range members should be non-negative; got #{delay}!") unless delay.first >= 0 && delay.last >= 0
+        raise(ArgumentError, "Range's end should be greater than or equal to range's start; got #{delay}!") unless delay.first <= delay.last
+      else
+        raise(ArgumentError, "Delay should be either an number or a range of numbers; got #{delay}!")
+      end
+      raise(ArgumentError, 'Delay policy has already been specified!') if @delay_policy
+      @delay_policy = ->{Kernel.sleep(rand(delay))}
+
+      attempt(block)
+    end
+
+    # Specifies reset method that will be called after each failed attempt.
+    def with_reset(reset_method, &block)
+      raise(ArgumentError, 'Reset method is nil!') unless reset_method
+      raise(ArgumentError, 'Reset method has already been speicifed!') if @reset_method
+
+      @reset_method = reset_method
+      attempt(block)
+    end
+
+    # Specifies default method that should be called after all attempts have failed.
+    def and_default_to(default_method, &block)
+      raise(ArgumentError, 'Default method is nil!') unless default_method
+      raise(ArgumentError, 'Default method has already been specified!') if @default_method
+
+      @default_method = default_method
+      attempt(block)
+    end
+
+    # Specifies delay which doubles between failed attempts.
+    def with_binary_backoff(initial_delay, &block)
+      raise(ArgumentError, "Delay should be a number; got ${initial_delay}!") unless initial_delay.is_a?(Numeric)
+      raise(ArgumentError, "Delay should be a positive number; got #{initial_delay}!") unless initial_delay > 0
+      raise(ArgumentError, "Delay policy has already been specified!") if @delay_policy
+
+      @delay_policy = BinaryBackoffPolicy.new(initial_delay)
+      attempt(block)
+    end
+
+    # Specifies exceptions
+    def with_filter(*exceptions, &block)
+      raise(ArgumentError, "Empty exceptions list!") unless exceptions.size > 0
+      # Everything must be an exception.
+      exceptions.each do |e|
+        raise(ArgumentError, "Not an exception: #{e}!") unless e <= Exception
+      end
+
+      raise(ArgumentError, "Exception filter has already been specified!") if @exception_filter
+
+      @exception_filter = ExceptionTypeFilter.new(exceptions)
+      attempt(block)
+    end
+
+    # Creates a scenario with the given id.
+    def scenario(id)
+      raise(ArgumentError, 'Blank id!') if id.nil? || id.empty?
+      raise(ArgumentError, "There is already a scenario with id #{id}") if @@scenarios.has_key?(id)
+
+      @@scenarios[id] = self
+    end
+  end
 end

data/lib/attempt_this/attempt_this.rb

@@ -1,18 +1,18 @@
 require 'attempt_this/attempt_object.rb'
 
 module AttemptThis
-	extend self
+  extend self
 
-	# Attempts code block until it doesn't throw an exception or the end of enumerator has been reached.
-	def attempt(enumerator, &block)
-		raise(ArgumentError, 'Nil enumerator!') if enumerator.nil?
+  # Attempts code block until it doesn't throw an exception or the end of enumerator has been reached.
+  def attempt(enumerator, &block)
+    raise(ArgumentError, 'Nil enumerator!') if enumerator.nil?
 
-		impl = AttemptObject::get_object(enumerator)
-		impl.attempt(block)
-	end
+    impl = AttemptObject::get_object(enumerator)
+    impl.attempt(block)
+  end
 
-	# Resets all static data (scenarios). This is intended to use by tests only (to reset scenarios)
-	def self.reset
-		AttemptObject.reset
-	end
+  # Resets all static data (scenarios). This is intended to use by tests only (to reset scenarios)
+  def self.reset
+    AttemptObject.reset
+  end
 end