nested_exceptions 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+bin
+.rbx

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.ruby_opts = '--debug'
+  spec.skip_bundler = true
+  spec.rcov = true
+  spec.rcov_opts = %w{--exclude generator_internal,jsignal_internal,gems\/,spec\/}
+end
+
+task :default => :spec

data/lib/nested_exceptions/define.rb

@@ -0,0 +1,23 @@
+module NestedExceptions
+  class << self
+    # Define a set of standard exception classes as recommended in
+    # http://exceptionalruby.com/
+    #
+    # I actually recommend that you just define these manually, but this may be
+    # a handy shortcut in smaller projects.
+    def define_standard_exception_classes_in(target_module)
+      definitions = %{
+        class Error < StandardError; include NestedExceptions; end
+          class UserError < Error; end
+          class LogicError < Error; end
+            class ClientError < LogicError; end
+            class InternalError < LogicError; end
+          class TransientError < Error; end
+      }
+      target_module.module_eval definitions
+      [:Error, :UserError, :LogicError, :ClientError, :InternalError, :TransientError].map do |name|
+        target_module.const_get name
+      end
+    end
+  end
+end

data/lib/nested_exceptions/global.rb

@@ -0,0 +1,7 @@
+require 'nested_exceptions'
+
+NestedExceptions::GLOBAL = true
+
+[NoMemoryError, ScriptError, SignalException, StandardError, SystemExit].each do |klass|
+  klass.send :include, NestedExceptions
+end

data/lib/nested_exceptions/version.rb

@@ -0,0 +1,11 @@
+module NestedExceptions
+  VERSION = "1.0.0"
+
+  def self.const_missing(name)
+    if name == 'GLOBAL' or name == :GLOBAL
+      NestedExceptions.const_set(name, false)
+    else
+      super
+    end
+  end
+end

data/lib/nested_exceptions.rb

@@ -0,0 +1,50 @@
+require "nested_exceptions/version"
+require "nested_exceptions/define"
+
+# Just include this module in your custom exception class
+module NestedExceptions
+  attr_reader :cause
+
+  def initialize(message = nil, cause = nil)
+    @cause = cause || $!
+    super(message)
+  end
+
+  if Object.const_defined? :RUBY_ENGINE and RUBY_ENGINE == 'jruby' or RUBY_ENGINE == 'rbx'
+    def backtrace
+      return @processed_backtrace if defined? @processed_backtrace and @processed_backtrace
+      @processed_backtrace = process_backtrace(super)
+    end
+  else
+    def set_backtrace(bt)
+      super process_backtrace(bt)
+    end
+  end
+
+  def root_cause
+    rc = e = self
+    while e
+      rc = e
+      break unless e.respond_to? :cause
+      e = e.cause
+    end
+    rc
+  end
+
+  protected
+
+  def process_backtrace(bt)
+    if cause
+      cause.backtrace.reverse.each do |line|
+        if bt.last == line
+          bt.pop
+        else
+          break
+        end
+      end
+      bt << "--- cause: #{cause.class.name}: #{cause}"
+      bt.concat cause.backtrace
+    end
+    bt
+  end
+end

data/nested_exceptions.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nested_exceptions/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nested_exceptions"
+  s.version     = NestedExceptions::VERSION
+  s.authors     = ["Darrick Wiebe"]
+  s.email       = ["dw@xnlogic.com"]
+  s.homepage    = ""
+  s.summary     = %q{Support nested exceptions in all rubies}
+  s.description = %q{Based on ideas in http://exceptionalruby.com/ and the nestegg gem which does not support JRuby.}
+
+  s.rubyforge_project = "nested_exceptions"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+end

data/spec/nested_exceptions_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+module ErrorSpec
+
+  NestedExceptions.define_standard_exception_classes_in ErrorSpec
+
+  class Example
+    def bug
+      raise 'bug'
+    end
+
+    def nested_bug
+      bug
+    end
+
+    def problem
+      nested_bug
+    rescue
+      raise InternalError, 'problem'
+    end
+
+    def nested_problem
+      problem
+    end
+
+    def double_bug
+      nested_problem
+    rescue
+      raise 'oops'
+    end
+  end
+end
+
+describe NestedExceptions do
+  let(:ex) { ErrorSpec::Example.new }
+  def in_rescue
+    if Object.const_defined? :RUBY_ENGINE and RUBY_ENGINE == 'jruby'
+      ''
+    elsif RUBY_VERSION =~ /^1\.[0-8]\./
+      ''
+    else
+      in_rescue = 'rescue in '
+    end
+  end
+
+  it 'should create a stack trace correctly' do
+    stack = raise rescue $!.backtrace
+    stack.first.should =~ /#{__FILE__}:#{__LINE__ - 1}/
+  end
+
+  describe 'normal StandardError' do
+    subject do
+      @stack = raise rescue $!.backtrace; ex.bug rescue $!
+    end
+    its(:message) { should == 'bug' }
+    its(:backtrace) { should == ["#{__FILE__}:9:in `bug'"] + @stack }
+  end
+
+  describe 'nested InternalError' do
+    subject do
+      @stack = raise rescue $!.backtrace; ex.problem rescue $!
+    end
+    its(:message) { should == 'problem' }
+    its('root_cause.message') { should == 'bug' }
+    its(:backtrace) do
+      should == [
+        "#{__FILE__}:19:in `#{in_rescue}problem'",
+        "--- cause: RuntimeError: bug",
+        "#{__FILE__}:9:in `bug'",
+        "#{__FILE__}:13:in `nested_bug'",
+        "#{__FILE__}:17:in `problem'"
+      ] + @stack
+    end
+  end
+
+  describe 'double nested StandardError' do
+    subject do
+      @stack = raise rescue $!.backtrace; ex.double_bug rescue $!
+    end
+    its(:message) { should == 'oops' }
+    its('root_cause.message') { should == 'bug' }
+    its(:backtrace) do
+      should == [
+        "#{__FILE__}:29:in `#{in_rescue}double_bug'",
+        "--- cause: ErrorSpec::InternalError: problem",
+        "#{__FILE__}:19:in `#{in_rescue}problem'",
+        "--- cause: RuntimeError: bug",
+        "#{__FILE__}:9:in `bug'",
+        "#{__FILE__}:13:in `nested_bug'",
+        "#{__FILE__}:17:in `problem'",
+        "#{__FILE__}:23:in `nested_problem'",
+        "#{__FILE__}:27:in `double_bug'"
+      ] + @stack
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'nested_exceptions/global'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: nested_exceptions
+version: !ruby/object:Gem::Version 
+  hash: 2387456872237229630
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Darrick Wiebe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-21 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 2002549777813010636
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Based on ideas in http://exceptionalruby.com/ and the nestegg gem which does not support JRuby.
+email: 
+- dw@xnlogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Rakefile
+- lib/nested_exceptions.rb
+- lib/nested_exceptions/define.rb
+- lib/nested_exceptions/global.rb
+- lib/nested_exceptions/version.rb
+- nested_exceptions.gemspec
+- spec/nested_exceptions_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2002549777813010636
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2002549777813010636
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: nested_exceptions
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Support nested exceptions in all rubies
+test_files: 
+- spec/nested_exceptions_spec.rb
+- spec/spec_helper.rb