exception_utilities 1.0.0

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kenta Murata
+
+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,69 @@
+# ExceptionUtilities
+
+Utilities for handling exceptions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exception_utilities'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception_utilities
+
+## Usage
+
+### Ignoring specific exceptions
+
+Use ```exceptions_ignoring_eval```:
+
+```ruby
+require 'exception_utilities/kernel'
+
+exceptions_ignoring_eval(LoadError) do
+  require 'foo'
+end
+```
+
+### Rescue exceptions having specific message
+
+Use ```exceptions_with_message```:
+
+```ruby
+require 'exception_utilities/kernel'
+
+begin
+  SomeModel.create!
+rescue exceptions_with_message(/\Bfoo_bar_id\B/, ActiveRecord::RecordNotFound)
+  Rails.logger.debug([$!.message, *$!.backtrace].join("\n"))
+end
+```
+
+### Creating exception matcher
+
+Use ```exception_matcher```:
+
+```ruby
+require 'exception_utilities/kernel'
+
+begin
+  # some routine
+rescue exception_matcher {|exc| exc.count <=1 }
+  # ignore
+rescue exception_matcher {|exc| exc.count > 1 }
+  raise
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/exception_utilities.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/exception_utilities/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kenta Murata"]
+  gem.email         = ["mrkn@mrkn.jp"]
+  gem.description   = %q{Utilities for handling exceptions}
+  gem.summary       = %q{Exception handling utilities}
+  gem.homepage      = "http://github.com/mrkn/exception_utilities"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "exception_utilities"
+  gem.require_paths = ["lib"]
+  gem.version       = ExceptionUtilities::VERSION
+
+  gem.add_development_dependency('rspec', '~> 2.12.0')
+  if RUBY_VERSION < '1.9'
+    gem.add_development_dependency('rcov', '~> 1.0.0')
+  else
+    gem.add_development_dependency('simplecov-rcov', '~> 0.2.3')
+  end
+end

data/lib/exception_utilities.rb

@@ -0,0 +1,38 @@
+require "exception_utilities/version"
+
+module ExceptionUtilities
+  class Error < StandardError; end
+
+  module_function
+
+  def exceptions_ignoring_eval(*modules)
+    unless modules.all? {|ec| Module === ec }
+      raise Error, 'only Module instances are accepted'
+    end
+    begin
+      yield
+    rescue *modules => exception
+      exception
+    end
+  end
+
+  def exception_matcher(&block)
+    Module.new do
+      (class << self; self; end).class_eval do
+        define_method(:===, &block)
+      end
+    end
+  end
+
+  def exceptions_with_message(pattern, *exception_classes)
+    exception_classes << StandardError if exception_classes.empty?
+    exception_matcher do |exception|
+      case exception
+      when *exception_classes
+        pattern === exception.message rescue false
+      else
+        false
+      end
+    end
+  end
+end

data/lib/exception_utilities/version.rb

@@ -0,0 +1,3 @@
+module ExceptionUtilities
+  VERSION = "1.0.0"
+end

data/spec/exception_utilities_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe ExceptionUtilities do
+  describe '.exceptions_ignoring_eval' do
+    context 'when called with an exception class' do
+      it 'should ignore an exception which is an instance of specified exception class' do
+        expect {
+          described_class.exceptions_ignoring_eval(RuntimeError) { raise }
+        }.to_not raise_error(RuntimeError)
+      end
+
+      it 'should return the ignored exception' do
+        described_class.exceptions_ignoring_eval(RuntimeError) { raise }.should be_a(RuntimeError)
+
+        exc = Class.new(RuntimeError)
+        described_class.exceptions_ignoring_eval(RuntimeError) { raise exc }.should be_a(exc)
+      end
+
+      it 'should ignore an exception which is an instance_of an exception class that is a subclass of the specified one' do
+        exc = Class.new(RuntimeError)
+        expect {
+          described_class.exceptions_ignoring_eval(RuntimeError) { raise exc }
+        }.to_not raise_error(exc)
+      end
+
+      it 'should not ignore an exception which is an instance of an exception class that is not a subclass of the specified one' do
+        exc = Class.new(TypeError)
+        expect {
+          described_class.exceptions_ignoring_eval(RuntimeError) { raise exc }
+        }.to raise_error(exc)
+      end
+    end
+
+    context 'when called with two exception classes' do
+      it 'should ignore an exception which is an instance of an exception class that is a subclass of each of these' do
+        expect {
+          described_class.exceptions_ignoring_eval(LoadError, RuntimeError) { raise LoadError }
+        }.to_not raise_error(LoadError)
+
+        exc = Class.new(RuntimeError)
+        expect {
+          described_class.exceptions_ignoring_eval(LoadError, RuntimeError) { raise exc }
+        }.to_not raise_error(RuntimeError)
+      end
+    end
+
+    context 'when called with an object not an exception class' do
+      it 'should raise ExceptionUtilities::Error' do
+        expect {
+          described_class.exceptions_ignoring_eval(Object.new) { }
+        }.to raise_error(ExceptionUtilities::Error)
+      end
+    end
+
+    context 'when called with an exception class and an object not an exception class' do
+      it 'should raise ExceptionUtilities::Error' do
+        expect {
+          described_class.exceptions_ignoring_eval(LoadError, Object.new) { }
+        }.to raise_error(ExceptionUtilities::Error)
+      end
+    end
+  end
+
+  describe '#exception_matcher' do
+    context 'when called with a block' do
+      context 'when subject.=== is called with an object' do
+        it 'should call the block with the object' do
+          obj = double('object')
+          obj.should_receive(:confirm).and_return(:block_called)
+          (described_class.exception_matcher {|x| x.confirm } === obj).should == :block_called
+        end
+      end
+    end
+  end
+
+  describe '#exceptions_with_message' do
+    context 'when called with "foo bar"' do
+      subject { described_class.exceptions_with_message('foo bar') }
+
+      it { should_not === Exception.new('foo bar') }
+
+      it { should === StandardError.new('foo bar') }
+
+      it { should === RuntimeError.new('foo bar') }
+
+      it { should_not === 'foo bar' }
+    end
+
+    context 'when called with "foo bar", RuntimeError, and TypeError' do
+      subject { described_class.exceptions_with_message('foo bar', RuntimeError, TypeError) }
+
+      it { should_not === Exception.new('foo bar') }
+
+      it { should === RuntimeError.new('foo bar') }
+
+      it { should === TypeError.new('foo bar') }
+
+      it { should_not === 'foo bar' }
+    end
+
+    context 'when called with /foo bar/' do
+      subject { described_class.exceptions_with_message(/foo bar/) }
+
+      it { should_not === Exception.new('abc foo bar xyz') }
+
+      it { should === StandardError.new('abc foo bar xyz') }
+
+      it { should === RuntimeError.new('abc foo bar xyz') }
+
+      it { should_not === 'abc foo bar xyz' }
+    end
+
+    context 'when called with /foo bar/, RuntimeError, and TypeError' do
+      subject { described_class.exceptions_with_message(/foo bar/, RuntimeError, TypeError) }
+
+      it { should_not === Exception.new('abc foo bar xyz') }
+
+      it { should === RuntimeError.new('abc foo bar xyz') }
+
+      it { should === TypeError.new('abc foo bar xyz') }
+
+      it { should_not === 'abc foo bar xyz' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+require 'exception_utilities'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: exception_utilities
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Kenta Murata
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 2
+        - 12
+        - 0
+        version: 2.12.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+description: Utilities for handling exceptions
+email: 
+- mrkn@mrkn.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exception_utilities.gemspec
+- lib/exception_utilities.rb
+- lib/exception_utilities/version.rb
+- spec/exception_utilities_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mrkn/exception_utilities
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Exception handling utilities
+test_files: 
+- spec/exception_utilities_spec.rb
+- spec/spec_helper.rb