deferred_exception 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d06b37f13627db3218a4ee56857298de1f3a55d
+  data.tar.gz: bfa53bcf72cd17287592042b5083eaea28af880d
+SHA512:
+  metadata.gz: 11684832cbd0259c401cf0b4759d0b20e5da08f97481baf265ed273f750402b8a2b419462fa9c5479f65b1e18906d81a8ff1b25a360f09cc4a5a1bafd01261c9
+  data.tar.gz: a001aac8c73da616bde363b58359d1d7aa2d345157a50f31e664b4f781c1fb232d171b90e99965402d1845917a0b3c8317ea7a2e7ddaee9cb3e1b6a99e94e306

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - '1.9.3'
+  - '1.9.2'
+  - '2.0.0'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deferred_exception.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    deferred_exception (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.9)
+    method_source (0.8.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    slop (3.4.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  deferred_exception!
+  pry
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 sonnym
+
+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.md

@@ -0,0 +1,73 @@
+# Deferred Exception
+
+[![Build Status](https://travis-ci.org/sonnym/deferred_exception.png?branch=master)](https://travis-ci.org/sonnym/deferred_exception)
+[![Code Climate](https://codeclimate.com/github/sonnym/deferred_exception.png)](https://codeclimate.com/github/sonnym/deferred_exception)
+
+Have you ever found yourself writing code like this? Have you presumed that you
+would notice a problem and go looking in your logs to find the problem?
+
+```ruby
+class EmailBlaster
+  def self.process_all!
+    all.each { |email| email.blast! }
+  end
+
+  def blast!
+    begin
+      # do some atomic work here
+    rescue StandardError => e
+      Logger.debug("Something went wrong #{e.message}")
+    end
+  end
+
+  # &c.
+end
+```
+
+Wouldn't it be nice, nay preferable, to accrue exceptions without stopping the
+subsequent atomic operations?
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deferred_exception'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deferred_exception
+
+## Usage
+
+Deferred Exception adds a `defer_exceptions` method to the `Enumerable` module
+that wraps the enumberable object and stores any exceptions that are raised
+during iteration.
+
+```ruby
+class EmailBlaster
+  def self.process_all!
+    all.defer_exceptions.each do { |email| email.blast! }
+  end
+
+  def blast!
+    # important, atomic work here
+  end
+end
+```
+
+Any exceptions will be caught and queued into a `ExceptionSet` class, a
+subclass of `StandardError` and will be raised once the iteration is complete.
+`ExceptionSet#message` will be a string containing messages and backtraces from
+all caught exceptions
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/deferred_exception'
+  t.test_files = FileList['test/lib/deferred_exception/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/deferred_exception.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deferred_exception/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'deferred_exception'
+  spec.version       = DeferredException::VERSION
+  spec.authors       = ['sonnym']
+  spec.email         = ['michaud.sonny@gmail.com']
+  spec.description   = 'Collect exceptions rather than exiting early when enumerating atomic operations.'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/sonnym/deferred_exception'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+end

data/deferred_exception/.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/lib/deferred_exception.rb

@@ -0,0 +1,9 @@
+require_relative 'deferred_exception/version'
+require_relative 'deferred_exception/enumerator'
+require_relative 'deferred_exception/exception_set'
+
+module Enumerable
+  def defer_exceptions
+    DeferredException::Enumerator.new(self)
+  end
+end

data/lib/deferred_exception/enumerator.rb

@@ -0,0 +1,31 @@
+module DeferredException
+  class Enumerator
+    include Enumerable
+
+    attr_accessor :enumerator
+
+    def initialize(enumerator)
+      self.enumerator = enumerator
+    end
+
+    def each(&block)
+      enumerator.each do |item|
+        begin
+          block.call(item)
+        rescue StandardError => e
+          exceptions.push(e)
+        end
+      end
+
+      unless exceptions.empty?
+        raise DeferredException::ExceptionSet.new(exceptions)
+      end
+
+      enumerator
+    end
+
+    def exceptions
+      @exceptions ||= []
+    end
+  end
+end

data/lib/deferred_exception/exception_set.rb

@@ -0,0 +1,18 @@
+module DeferredException
+  class ExceptionSet < StandardError
+    attr_accessor :exceptions
+    
+    def initialize(exceptions)
+      self.exceptions = exceptions
+    end
+
+    def message
+      exceptions.map { |exception| individual_message(exception) }.join("\n#{'=' * 5}\n") 
+    end
+
+    private
+    def individual_message(exception)
+      "#{exception.message}#{"\n#{exception.backtrace.join("\n")}" unless exception.backtrace.nil?}"
+    end
+  end
+end

data/lib/deferred_exception/version.rb

@@ -0,0 +1,3 @@
+module DeferredException
+  VERSION = '1.0.0'
+end

data/test/lib/deferred_exception/deferred_exception_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper'
+
+describe DeferredException do
+  it 'should create a #defer_exceptions method' do
+    assert_respond_to [], :defer_exceptions
+  end
+end

data/test/lib/deferred_exception/enumerator_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../test_helper'
+
+describe DeferredException::Enumerator do
+  it 'is an enumerable' do
+    enumerator = DeferredException::Enumerator.new([:foo, :bar, :baz])
+    assert_kind_of Enumerable, enumerator
+  end
+
+  it 'returns the original enumerable after processing' do
+    original = [:foo, :bar, :baz]
+    enumerator = DeferredException::Enumerator.new(original)
+    assert_equal original, enumerator.each {}
+  end
+
+  it 'raises ExceptionSet if exceptions occur' do
+    items = [-> { raise StandardError(:foo) },
+             -> { raise StandardError(:bar) },
+             -> { raise StandardError(:baz) }]
+
+    enumerator = DeferredException::Enumerator.new(items)
+
+    assert_raises(DeferredException::ExceptionSet) do
+      enumerator.each { |fn| fn.call }
+    end
+  end
+
+  it 'contiues processing elements after an exception is encountered' do
+    mock = MiniTest::Mock.new
+    mock.expect(:bar, true)
+
+    items = [-> { raise StandardError(:foo) },
+             -> { mock.send(:bar) }]
+
+    
+    enumerator = DeferredException::Enumerator.new(items)
+
+    begin
+      enumerator.each { |fn| fn.call }
+    rescue
+    end
+  end
+end
+

data/test/lib/deferred_exception/exception_set.rb

@@ -0,0 +1,15 @@
+require_relative '../../test_helper'
+
+describe DeferredException::ExceptionSet do
+  it 'should return a compound message' do
+    exceptions = [StandardError.new('foo'), StandardError.new('bar')]
+    exception_set = DeferredException::ExceptionSet.new(exceptions)
+    assert_equal "foo\n=====\nbar", exception_set.message
+  end
+
+  it 'should return a compound message' do
+    exceptions = [StandardError.new('foo'), StandardError.new('bar')]
+    exception_set = DeferredException::ExceptionSet.new(exceptions)
+    assert_equal "foo\n=====\nbar", exception_set.message
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'pry'
+
+require File.expand_path('../../lib/deferred_exception.rb', __FILE__)

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: deferred_exception
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sonnym
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Collect exceptions rather than exiting early when enumerating atomic
+  operations.
+email:
+- michaud.sonny@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- deferred_exception.gemspec
+- deferred_exception/.gitignore
+- lib/deferred_exception.rb
+- lib/deferred_exception/enumerator.rb
+- lib/deferred_exception/exception_set.rb
+- lib/deferred_exception/version.rb
+- test/lib/deferred_exception/deferred_exception_test.rb
+- test/lib/deferred_exception/enumerator_test.rb
+- test/lib/deferred_exception/exception_set.rb
+- test/test_helper.rb
+homepage: https://github.com/sonnym/deferred_exception
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Collect exceptions rather than exiting early when enumerating atomic operations.
+test_files:
+- test/lib/deferred_exception/deferred_exception_test.rb
+- test/lib/deferred_exception/enumerator_test.rb
+- test/lib/deferred_exception/exception_set.rb
+- test/test_helper.rb