exception_helper 0.1.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gem 'activesupport', '>= 2.3.5'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rake'
+  gem 'shoulda'
+  gem 'bundler'
+  gem 'mocha'
+  gem 'log4r' #used for null logger
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Backupify
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= exception_helper
+
+Description goes here.
+
+== Contributing to exception_helper
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Jason Haruska. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/config/log4r.yml

@@ -0,0 +1,24 @@
+log4r_config:
+  # define all loggers ...
+  loggers:
+    - name      : test
+      level     : DEBUG
+      trace     : 'true'
+      outputters :
+      - datefile
+    - name      : development
+      level     : DEBUG
+      trace     : 'true'
+      outputters :
+      - datefile
+
+  # define all outputters (incl. formatters)
+  outputters:
+  - type: DateFileOutputter
+    name: datefile
+    dirname: "log"
+    file: "my_log" # this will be overrided by lumber config.
+    formatter:
+      date_pattern: '%H:%M:%S'
+      pattern     : '%d %l: %m '
+      type        : PatternFormatter

data/exception_helper.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exception_helper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "exception_helper"
+  gem.version       = ExceptionHelper::VERSION
+  gem.authors       = ["Jason Haruska"]
+  gem.email         = ["jason@haruska.com"]
+  gem.description   = %q{Common mixins for handling exceptions}
+  gem.summary       = %q{Common mixins for handling exceptions including retries.}
+  gem.homepage      = "https://github.com/backupify/exception_helper"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "shoulda"
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "log4r"
+end
+
+

data/lib/exception_helper.rb

@@ -0,0 +1,5 @@
+require 'exception_helper/version'
+require 'exception_helper/retry'
+
+module ExceptionHelper
+end

data/lib/exception_helper/retry.rb

@@ -0,0 +1,71 @@
+require 'active_support/concern'
+require 'active_support/core_ext/module/aliasing'
+
+module ExceptionHelper
+  module Retry
+    extend ActiveSupport::Concern
+
+    included do
+      unless defined?(logger)
+        require 'log4r'
+
+        #always return the null logger
+        def self.logger
+          Log4r::Logger.root
+        end
+      end
+    end
+
+    def retry_on_failure(*exception_list, &block)
+      self.class.retry_on_failure(*exception_list, &block)
+    end
+
+    def wrap_with_retry(*methods)
+      self.class.wrap_with_retry(*methods)
+    end
+
+    module ClassMethods
+      # execute the given block, retrying only when one of the given exceptions is raised
+      def retry_on_failure(*exception_list, &block)
+        opts = exception_list.last.is_a?(Hash) ? exception_list.pop : {}
+        opts = {:retry_count => 3}.merge(opts)
+        retry_count = opts[:retry_count]
+        begin
+          yield block
+        rescue *exception_list => e
+          if retry_count > 0
+            retry_count -= 1
+            logger.info "Exception, trying again #{retry_count} more times"
+            sleep opts[:retry_sleep].to_f if opts[:retry_sleep]
+            retry
+          else
+            logger.error "Too many exceptions...re-raising"
+            raise
+          end
+        end
+      end
+
+      # Wraps a method with `retry_on_failure` to handle exceptions.  It does this via alias_method_chain,
+      # so the original method name will be preserved and the method will simply be decorated with the retry logic.
+      def wrap_with_retry(*methods)
+        opts = methods.last.is_a?(Hash) ? methods.pop : {}
+        exception_list = opts.delete(:exceptions)
+        methods.each do |method|
+          # Extract the punctuation character from the method name if one exists.
+          aliased_method, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
+
+          # Create the decorated method that `alias_method_chain` will look for.
+          define_method("#{aliased_method}_with_retry#{punctuation}") do |*args|
+            retry_on_failure(*exception_list, opts) do
+              send("#{aliased_method}_without_retry#{punctuation}", *args)
+            end
+          end
+
+          # Set up the method chain.
+          alias_method_chain method, :retry
+        end
+      end
+    end
+
+  end
+end

data/lib/exception_helper/version.rb

@@ -0,0 +1,3 @@
+module ExceptionHelper
+  VERSION = '0.1.2'
+end

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'shoulda'
+require 'mocha/setup'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'exception_helper'
+
+class Test::Unit::TestCase
+end

data/test/retry_test.rb

@@ -0,0 +1,112 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper.rb')
+
+class RetryTest < Test::Unit::TestCase
+
+  include ExceptionHelper::Retry
+
+  class TestException1 < Exception
+  end
+
+  class TestException2 < Exception
+  end
+
+  should "have no impact on passing code" do
+    expects(:puts).with("hello").once
+    retry_on_failure(TestException1) do
+      puts "hello"
+    end
+  end
+
+  should "retry for specified exceptions" do
+    expects(:puts).with("hello").at_least(2)
+    assert_raise(TestException1) do
+      retry_on_failure(TestException1) do
+        puts "hello"
+        raise TestException1.new
+      end
+    end
+  end
+
+  should "retry by given count for specified exceptions" do
+    expects(:puts).with("hello").times(6)
+    assert_raise(TestException1) do
+      retry_on_failure(TestException1, TestException2, :retry_count => 5) do
+        puts "hello"
+        raise TestException1.new
+      end
+    end
+  end
+
+  should "not retry for unspecified exceptions" do
+    expects(:puts).with("hello").once
+    assert_raise(TestException1) do
+      retry_on_failure(TestException2) do
+        puts "hello"
+        raise TestException1.new
+      end
+    end
+  end
+
+  should "sleep if retry_sleep given" do
+    RetryTest.expects(:sleep).with(1)
+    assert_raise(TestException1) do
+      retry_on_failure(TestException1, :retry_count => 1, :retry_sleep => 1) do
+        raise TestException1.new
+      end
+    end
+  end
+
+  should "not sleep if retry_sleep not given" do
+    RetryTest.expects(:sleep).never
+    assert_raise(TestException1) do
+      retry_on_failure(TestException1, :retry_count => 1) do
+        raise TestException1.new
+      end
+    end
+  end
+
+  should "wrap method with retry" do
+    class WithRetry
+      include ExceptionHelper::Retry
+
+      def mymethod
+        true
+      end
+
+      wrap_with_retry :mymethod
+    end
+
+    WithRetry.stubs(:mymethod_without_retry).raises(Exception).then.returns(true)
+
+    # We should handle the exceptions. retry, and then move on without raising any further exceptions.
+    WithRetry.new.mymethod
+  end
+
+  should "wrap method with retry with options" do
+    class WithRetry
+      include ExceptionHelper::Retry
+
+      def mymethod
+        true
+      end
+
+      wrap_with_retry :mymethod, :exceptions => [TestException1, TestException2], :retry_count => 9, :retry_sleep => 8
+    end
+
+    WithRetry.any_instance.expects(:retry_on_failure).with(TestException1, TestException2, {:retry_count => 9, :retry_sleep => 8})
+
+    WithRetry.new.mymethod
+  end
+
+  should "not override logger on include" do
+    class WithLogger
+      def self.logger
+        "Doesn't really do much"
+      end
+
+      include ExceptionHelper::Retry
+    end
+
+    assert_equal "Doesn't really do much", WithLogger.logger
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: exception_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Jason Haruska
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: shoulda
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: bundler
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: mocha
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: log4r
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Common mixins for handling exceptions
+email:
+- jason@haruska.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- config/log4r.yml
+- exception_helper.gemspec
+- lib/exception_helper.rb
+- lib/exception_helper/retry.rb
+- lib/exception_helper/version.rb
+- log/.gitkeep
+- test/helper.rb
+- test/retry_test.rb
+homepage: https://github.com/backupify/exception_helper
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Common mixins for handling exceptions including retries.
+test_files:
+- test/helper.rb
+- test/retry_test.rb
+has_rdoc: