justified 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Petr Chalupa <git@pitr.ch>
+
+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/lib/justified/standard_error.rb

@@ -0,0 +1,7 @@
+require 'justified'
+
+class StandardError
+  include Justified::Error
+end
+
+

data/lib/justified.rb

@@ -0,0 +1,74 @@
+module Justified
+  SKIP_STR   = '    ... skipped %s lines'
+  CAUSED_STR = 'caused by:'
+
+  module Error
+    def initialize(message = nil, cause = $!)
+      super(message)
+      set_cause cause
+      @backtrace = nil
+    end
+
+    # Set cause of the exception
+    # @param [nil, Exception] exception
+    def cause=(exception)
+      set_cause exception
+      set_backtrace
+    end
+
+    # @return [Exception] cause of the exception
+    def cause
+      @cause
+    end
+
+    def set_backtrace(backtrace = nil)
+      @backtrace ||= backtrace
+      backtrace  ||= @backtrace
+
+      if backtrace
+        unless cause
+          super backtrace
+        else
+          cause_backtrace, rest   = split_cause_backtrace
+          same_line_count         = calculate_same_line_count backtrace, cause_backtrace
+          cause_backtrace_striped = cause_backtrace[0..-(same_line_count+1)]
+
+          super backtrace +
+                    ["#{CAUSED_STR} (#{cause.class}) #{cause.message}"] +
+                    cause_backtrace_striped +
+                    [SKIP_STR % same_line_count] +
+                    recalculate_rest(rest, same_line_count)
+        end
+      end
+    end
+
+    private
+
+    def set_cause(cause)
+      cause.nil? or exception.kind_of? Exception or
+          raise ArgumentError, 'cause must be kind of Exception'
+      @cause = cause
+    end
+
+    def split_cause_backtrace
+      _, cause_index = cause.backtrace.each_with_index.find { |line, _| line =~ /^#{CAUSED_STR}/ }
+      if cause_index
+        [cause.backtrace[0...cause_index], cause.backtrace[cause_index..-1]]
+      else
+        [cause.backtrace, []]
+      end
+    end
+
+    def recalculate_rest(rest, same_line_count)
+      rest.map do |line|
+        line.gsub(/^#{SKIP_STR % '(\d+)'}$/) do
+          SKIP_STR % ($1.to_i - same_line_count)
+        end
+      end
+    end
+
+    def calculate_same_line_count(backtrace, cause_backtrace)
+      backtrace.reverse.zip(cause_backtrace.reverse).select { |a, b| a == b }.size
+    end
+  end
+end

data/spec/justified.rb

@@ -0,0 +1,92 @@
+require 'minitest/autorun'
+
+require 'pp'
+require 'justified/standard_error'
+
+class AnError < StandardError
+end
+
+class Test
+  def bad_code
+    raise AnError, 'bad'
+  end
+
+  def handle_error
+    raise AnError, 'something'
+  end
+
+  def something
+    bad_code
+  rescue
+    handle_error
+  end
+
+  def do_something
+    something
+  end
+end
+
+
+describe 'justified' do
+  let :error do
+    Test.new.do_something rescue $!
+  end
+
+  describe 'normal raise' do
+    it { error.message.must_equal 'something' }
+    it { error.cause.message.must_equal 'bad' }
+    it { error.backtrace.must_include 'caused by: (AnError) bad' }
+    it do
+      assert error.backtrace.any? { |l| l =~ %r"/justified/spec/justified\.rb:\d+:in `bad_code'" }
+    end
+  end
+
+  describe 'erasing cause' do
+    let :error2 do
+      error.tap { |e| e.cause = nil }
+    end
+
+    it { error2.message.must_equal 'something' }
+    it { error2.cause.must_be_nil }
+    it { error2.backtrace.wont_include 'caused by: (AnError) bad' }
+    it do
+      refute error2.backtrace.
+                 any? { |l| l =~ %r"/justified/spec/justified\.rb:15:in `bad_code'" }
+    end
+  end
+
+  describe 'set different cause' do
+    let :error2 do
+      cause = raise('other') rescue $!
+      error.tap { |e| e.cause = cause }
+    end
+
+    it { error2.message.must_equal 'something' }
+    it { error2.cause.message.must_equal 'other' }
+    it { error2.backtrace.must_include 'caused by: (RuntimeError) other' }
+    it do
+      assert error2.backtrace.any? do |l|
+        l =~ %r"/justified/spec/justified\.rb:\d+:in `block \(\d levels\)'"
+      end
+    end
+  end
+
+  describe 'manual creation' do
+    let :error do
+      cause = raise('other') rescue $!
+      error       = AnError.new 'something'
+      error.cause = cause
+      raise(error) rescue $!
+    end
+
+    it { error.message.must_equal 'something' }
+    it { error.cause.message.must_equal 'other' }
+    it { error.backtrace.must_include 'caused by: (RuntimeError) other' }
+    it do
+      assert error.backtrace.any? do |l|
+        l =~ %r"/justified/spec/justified\.rb:\d+:in `block \(\d levels\)'"
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: justified
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Petr Chalupa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: pry
+  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: yard
+  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: redcarpet
+  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: github-markup
+  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'
+description: ! '    Provides causes for exceptions.
+
+'
+email: git@pitr.ch
+executables: []
+extensions: []
+extra_rdoc_files:
+- MIT-LICENSE
+files:
+- lib/justified/standard_error.rb
+- lib/justified.rb
+- MIT-LICENSE
+- spec/justified.rb
+homepage: https://github.com/pitr-ch/justified
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Exception causes
+test_files:
+- spec/justified.rb
+has_rdoc: