rescue_me 0.1.0 → 0.1.1

data/lib/rescue_me/version.rb

@@ -0,0 +1,3 @@
+module RescueMe
+  VERSION = '0.1.1' unless defined? RescueMe::VERSION
+end

data/lib/rescue_me.rb

@@ -10,17 +10,16 @@ module Kernel
   #       strongly encouraged to provide arguments that capture temporary
   #       exceptional conditions that are likely to work upon a retry.
   def rescue_and_retry(max_attempts=7, *temporary_exceptions)
-    retry_interval = 2    # A good initial start value. Tweak as needed.
-    temporary_exceptions << Exception if temporary_exceptions.empty?
-    begin 
+    retry_interval = 2 # A good initial start value. Tweak as needed.
+    temporary_exceptions << StandardError if temporary_exceptions.empty?
+    begin
       yield
     rescue *temporary_exceptions => e
       attempt = (attempt || 0) + 1
-      message = "rescue and retry (attempt #{attempt}/#{max_attempts}): " +
-          "#{caller.first},  <#{e.class}: #{e.message}>"
-      # TODO AS: Is there a better way to access and use a logger?
-      (defined? logger) ? logger.warn(message) : puts(message)
+      RescueMe::Logger.warn(attempt, max_attempts, caller, e)
+
       raise(e) if attempt >= max_attempts
+
       # Retry immediately before exponential waits (1, 2, 4, 16, ... sec)
       sleep retry_interval**(attempt - 2) if attempt >= 2
       retry
@@ -28,3 +27,31 @@ module Kernel
   end
 
 end
+
+module RescueMe
+  require "logger"
+
+  class << self
+    def logger
+      @logger ||= defined?(Rails) && Rails.respond_to?(:logger) ? Rails.logger : ::Logger.new($stdout)
+    end
+  end
+
+  module Logger
+
+    class << self
+      def warn(attempt, max_attempts, kaller, exception)
+        if RescueMe.logger && RescueMe.logger.respond_to?(:warn)
+          RescueMe.logger.warn(rescued_message(attempt, max_attempts, kaller, exception))
+        end
+      end
+
+      def rescued_message(attempt, max_attempts, kaller, exception)
+        "rescue and retry (attempt #{attempt}/#{max_attempts}): " +
+        "#{kaller.first}, <#{exception.class}: #{exception.message}>"
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,90 +1,101 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rescue_me
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Arild Shirazi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-08-24 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: Provides a convenience method to retry blocks of code that might fail due to temporary errors, e.g. a network service that becomes temporarily unavailable.  The retries are timed to back-off exponentially (2^n seconds), hopefully giving time for the remote server to recover.
-email: as4@eshirazi.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a convenience method to retry blocks of code that might fail
+  due to temporary errors, e.g. a network service that becomes temporarily unavailable.
+  The retries are timed to back-off exponentially (2^n seconds), hopefully giving
+  time for the remote server to recover.
+email:
+- as4@eshirazi.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
-- .document
-- .gitignore
+extra_rdoc_files: []
+files:
+- lib/rescue_me/version.rb
+- lib/rescue_me.rb
 - LICENSE
 - README.rdoc
-- Rakefile
-- VERSION
-- lib/rescue_me.rb
-- test/helper.rb
-- test/test_rescue_me.rb
-has_rdoc: true
-homepage: http://github.com/ashirazi/rescue_me
+homepage: https://github.com/ashirazi/rescue_me
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: rescue_me
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Retry a block of code that might fail due to temporary errors.
-test_files: 
-- test/helper.rb
-- test/test_rescue_me.rb
+test_files: []
+has_rdoc: 

data/.document

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

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/Rakefile

@@ -1,57 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "rescue_me"
-    gem.summary = %Q{Retry a block of code that might fail due to temporary errors.}
-    gem.description = %Q{Provides a convenience method to retry blocks of code \
-that might fail due to temporary errors, e.g. a network service that becomes \
-temporarily unavailable.  The retries are timed to back-off exponentially (2^n \
-seconds), hopefully giving time for the remote server to recover.}
-    gem.email = "as4@eshirazi.com"
-    gem.homepage = "http://github.com/ashirazi/rescue_me"
-    gem.authors = ["Arild Shirazi"]
-    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    gem.add_development_dependency "shoulda", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rescue_me #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.1.0

data/test/helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rescue_me'
-
-class Test::Unit::TestCase
-end

data/test/test_rescue_me.rb

@@ -1,86 +0,0 @@
-require 'helper'
-
-class TestRescueMe < Test::Unit::TestCase
-
-  class ExceptionCounter
-
-    require 'net/smtp'
-    attr_reader :method_called_count
-
-    def initialize
-      @method_called_count = 0;
-    end
-
-    def exception_free
-      @method_called_count += 1
-      "This method does not raise exceptions"
-    end
-
-    def raise_zero_division_error
-      @method_called_count += 1
-      12/0
-    end
-
-    # Will raise SMTPServerBusy the first x times this method is called,
-    # after which this method does nothing.
-    def raise_smtp_exception_until_call(times)
-      @method_called_count += 1
-      @smtp_exception_count = (@smtp_exception_count ||= 0) + 1
-      raise Net::SMTPServerBusy until times > @smtp_exception_count
-    end
-
-  end # ExceptionCounter
-
-  context "rescue_and_retry of code that might raise temporary exceptions" do
-    setup do
-      @exception_counter = ExceptionCounter.new
-      @previous_call_count = @exception_counter.method_called_count
-    end
-
-    should "run an exception-free block of code once" do
-      assert_nothing_raised do
-        rescue_and_retry {
-          @exception_counter.exception_free
-        }
-      end
-      assert 1, @exception_counter.method_called_count
-    end
-
-    should "attempt to run a block that raises an unexpected exception " +
-        "only once" do
-      assert_raise(ZeroDivisionError) do
-        rescue_and_retry(5, IOError) {
-          @exception_counter.raise_zero_division_error
-        }
-      end
-      assert 1, @exception_counter.method_called_count
-    end
-
-    should "re-run the block of code for exactly max_attempt number of times" do
-      assert_raise(ZeroDivisionError) do
-        rescue_and_retry(3, IOError) {
-          @exception_counter.raise_zero_division_error
-        }
-      end
-      assert 3, @exception_counter.method_called_count - @previous_call_count 
-
-      assert_raise(ZeroDivisionError) do
-        rescue_and_retry(1, IOError) {
-          @exception_counter.raise_zero_division_error
-        }
-      end
-      assert 1, @exception_counter.method_called_count - @previous_call_count 
-    end
-
-    should "not re-run the block of code after it has run successfully" do
-      assert_nothing_raised do
-        rescue_and_retry(5, Net::SMTPServerBusy) {
-          @exception_counter.raise_smtp_exception_until_call(3)
-        }
-      end
-      assert 3, @exception_counter.method_called_count
-    end
-
-  end
-
-end