rescue_each 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gemspec
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jason Weathered
+
+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.markdown

@@ -0,0 +1,44 @@
+# `rescue_each`
+## Rescue multiple exceptions when working with Enumerable objects.
+
+Say you have a batch rake task which runs from cron which consists of many independent tasks ran in a loop.
+These tasks could be anything from updating cached database entries to file conversions.
+
+Once of these tasks fails, perhaps there's a corrupt image. Normally this would mean the entire batch task fails. But with rescue_each the other items can be processed and any errors will be re-raised at the end to be caught by your cron script.
+
+### Usage
+
+#### Basics
+
+Simply replace your `each` and `each_with_index` calls with `rescue_each` and `rescue_each_with_index` respectively:
+
+    BatchTasks.all.each &:process!
+
+transforms into:
+
+    BatchTasks.all.rescue_each &:process!
+
+#### Verbosity
+
+`rescue_each` also supports a option to output error summary info to `stderr` during the loop:
+
+    (1..5).rescue_each :stderr => true do |i|
+      sleep 1
+      raise 'example'
+    end
+
+You'll probably find this handy if your batch task normally has its own status output.
+
+### Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+### Copyright
+
+Copyright (c) 2010 Jason Weathered. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the rescue_each plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rescue_each"
+    gem.summary = "Rescue multiple exceptions when working with Enumerable objects"
+    gem.email = "jason@jasoncodes.com"
+    gem.homepage = "http://github.com/jasoncodes/rescue_each"
+    gem.authors = ["Jason Weathered"]
+    gem.has_rdoc = false
+    gem.add_dependency 'activesupport'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/rescue_each.rb

@@ -0,0 +1,93 @@
+require 'active_support'
+
+module RescueEach
+  class Error < StandardError
+    
+    attr_reader :errors
+    
+    def initialize(errors)
+      @errors = errors
+    end
+    
+    class Item < Struct.new :exception, :args
+      
+      def title
+        "#{exception.message} (#{exception.class})"
+      end
+      def args_short
+        args_str = args.map do |arg|
+          lines = arg.inspect.lines.collect
+          if lines.size == 1
+            lines.first
+          else
+            lines.first + " [#{lines.size-1} more...]"
+          end
+        end
+        "args: " + args_str.join(", ")
+      end
+      def args_full
+        "args: #{args.inspect}"
+      end
+      def backtrace_s
+        "\t#{exception.backtrace.join "\n\t"}"
+      end
+      
+      def short_message
+        "#{title} (#{args_short})"
+      end
+      
+      def message
+        "#{title}\n#{args_full}\n#{backtrace_s}"
+      end
+      
+      def to_s
+        "\n#{message}"
+      end
+      
+    end
+    
+    def to_s
+      msg = []
+      errors.each_with_index do |error, idx|
+        msg << "rescue_each catch ##{idx+1}: "
+        msg << error.to_s
+        msg << "\n"
+      end
+      msg << "rescue_each caught #{errors.size} errors"
+      msg.join
+    end
+    
+  end
+end
+
+module Enumerable
+  
+  def rescue_each(options = {})
+    
+    options.assert_valid_keys :stderr, :method
+    options.reverse_merge! :method => :each
+    
+    errors = []
+    send options[:method] do |*args|
+      begin
+        yield *args
+      rescue Exception => e
+        item = RescueEach::Error::Item.new e, args
+        if options[:stderr] == :full
+          $stderr.puts "rescue_each error: #{item}" if options[:stderr]
+        elsif options[:stderr]
+          $stderr.puts "rescue_each error: #{item.short_message}"
+        end
+        errors << item
+      end
+    end
+    raise RescueEach::Error, errors unless errors.empty?
+    self
+  end
+  
+  def rescue_each_with_index(options = {}, &block)
+    options = options.reverse_merge :method => :each_with_index
+    rescue_each(options, &block)
+  end
+  
+end

data/test/rescue_each_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+class RescueEachTest < ActiveSupport::TestCase
+  
+  test "return value" do
+    enum = (1..5)
+    assert_equal enum, enum.each(&:nil?)
+  end
+  
+  test "calls block" do
+    output = []
+    (1..5).rescue_each do |x|
+      output << x
+    end
+    assert_equal (1..5).collect, output
+  end
+  
+  test "continues after an error" do
+    output = []
+    assert_raise RescueEach::Error do
+      (1..5).rescue_each do |x|
+        output << x
+        raise 'test' if x == 3
+      end
+    end
+    assert_equal (1..5).collect, output
+  end
+  
+  test "empty array doesn't call block" do
+    [].rescue_each do
+      raise 'test'
+    end
+  end
+  
+  test "empty block doesn't raise" do
+    [42].rescue_each do
+    end
+  end
+  
+  test "no param block can raise" do
+    assert_raise RescueEach::Error do
+      [42].rescue_each do
+        raise 'test'
+      end
+    end
+  end
+  
+  test "each_with_index args pass through correctly" do
+    output = []
+    [:foo, :bar].rescue_each_with_index do |obj,i|
+      output << [obj,i]
+    end
+    expected = [[:foo, 0], [:bar, 1]]
+    assert_equal expected, output
+  end
+  
+  test "error object contains args that triggered error" do
+    error_object = nil
+    begin
+      (1..10).rescue_each do |i|
+        raise 'foo' if (i%2) == 0
+      end
+    rescue RescueEach::Error => e
+      error_object = e
+    end
+    assert_equal [[2],[4],[6],[8],[10]], error_object.errors.map(&:args)
+  end
+  
+  def foo_abc
+    bar_def
+  end
+  
+  def bar_def
+    raise 'baz'
+  end
+  
+  test "captured error message and backtrace" do
+    
+    error_object = nil
+    begin
+      [42].rescue_each do |i|
+        foo_abc
+      end
+    rescue RescueEach::Error => e
+      error_object = e
+    end
+    
+    assert_equal 1, error_object.errors.size
+    the_exception = error_object.errors.first.exception
+    
+    assert_kind_of RuntimeError, the_exception
+    assert_equal 'baz', the_exception.message
+    
+    assert_true the_exception.backtrace.size > 2
+    assert_match /:in `bar_def'\Z/, the_exception.backtrace[0]
+    assert_match /:in `foo_abc'\Z/, the_exception.backtrace[1]
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+require 'rescue_each'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: rescue_each
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jason Weathered
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-15 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: jason@jasoncodes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/rescue_each.rb
+- test/rescue_each_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jasoncodes/rescue_each
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rescue multiple exceptions when working with Enumerable objects
+test_files: 
+- test/rescue_each_test.rb
+- test/test_helper.rb