dexc 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+Gemfile.lock
+pkg/*
+vendor/*

data/BSDL

@@ -0,0 +1,23 @@
+Copyright (C) 2013 Kazuki Tsujimoto, All rights reserved.
+Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved. (lib/irb.rb)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/COPYING

@@ -0,0 +1,58 @@
+Copyright (C) 2013 Kazuki Tsujimoto, All rights reserved.
+Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved. (lib/irb.rb)
+
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.rdoc

@@ -0,0 +1,60 @@
+= dexc
+== About
+Automatically start the REPL and show trace on an exception to debug.
+
+== Requirements
+* Ruby 2.0.0 or later
+* Pry(optional)
+
+== Installation
+ $ gem install dexc
+
+== Examples
+ $ cat t.rb
+ def m(obj)
+   obj.to_s + 1
+ end
+
+ m(0)
+
+ $ ruby -rdexc t.rb
+  0:lib/dexc.rb:82>     tp.enable
+    TracePoint#enable: false
+  1:lib/dexc.rb:83>   end
+    Dexc#start: false
+  2:lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45>       return gem_original_require(path)
+    Kernel#gem_original_require: true
+  3:lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45>       return gem_original_require(path)
+    Kernel#require: true
+  4:t.rb:0>
+    IO#set_encoding: #<File:t.rb (closed)>
+  5:t.rb:0>
+    IO#set_encoding: #<File:t.rb (closed)>
+  6:t.rb:1> def m(obj)
+    Module#method_added: nil
+  7:t.rb:2>   obj.to_s + 1
+    Fixnum#to_s: "0"
+  8:t.rb:2>   obj.to_s + 1
+    Exception#initialize: #<TypeError: no implicit conversion of Fixnum into String>
+  9:t.rb:2>   obj.to_s + 1
+    Class#new: #<TypeError: no implicit conversion of Fixnum into String>
+ 10:t.rb:2>   obj.to_s + 1
+    Exception#exception: #<TypeError: no implicit conversion of Fixnum into String>
+ 11:t.rb:2>   obj.to_s + 1
+    Exception#backtrace: nil
+
+ TypeError: no implicit conversion of Fixnum into String
+         from t.rb:2:in `+'
+         from t.rb:2:in `m'
+         from t.rb:4:in `<main>'
+
+ From: t.rb @ line 2 Object#m:
+
+     1: def m(obj)
+  => 2:   obj.to_s + 1
+     3: end
+
+ [1] pry(main)> obj
+ => 0
+ [2] pry(main)> hist[7] # or dexc_hist[7]
+ => "0"

data/Rakefile

@@ -0,0 +1,10 @@
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', __FILE__)
+require 'bundler/setup'
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.test_files = FileList["test/test_*.rb"]
+end

data/dexc.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'dexc/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dexc'
+  s.version     = Dexc::VERSION
+  s.authors     = ['Kazuki Tsujimoto']
+  s.email       = ['kazuki@callcc.net']
+  s.homepage    = 'https://github.com/k-tsj/dexc'
+  s.summary     = %q{A library that helps you to debug an exception}
+  s.description = %q{Automatically start the REPL and show trace on an exception to debug.}
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f) }
+  s.require_paths    = ['lib']
+  s.add_development_dependency 'rake'
+  s.extra_rdoc_files = ['README.rdoc']
+  s.rdoc_options     = ['--main', 'README.rdoc']
+end

data/lib/dexc.rb

@@ -0,0 +1,138 @@
+# dexc.rb
+#
+# Copyright (C) 2013 Kazuki Tsujimoto, All rights reserved.
+
+require 'dexc/version'
+
+module Dexc
+  EXC_BINDING_VAR = :@dexc_binding
+
+  class RingBuffer
+    def initialize(n)
+      @n = n
+      @buf = []
+      @idx = 0
+    end
+
+    def add(val)
+      @buf[@idx] = val
+      @idx = (@idx + 1) % @n
+    end
+
+    def to_a
+      @buf[@idx..-1] + @buf[0...@idx]
+    end
+  end
+
+  RaiseEvent  = Struct.new(:event, :raised_exception)
+  ReturnEvent = Struct.new(:event, :lineno, :path, :defined_class, :method_id, :return_value)
+
+  def start
+    events = RingBuffer.new(30)
+
+    tp = TracePoint.new(:raise, :return, :c_return, :b_return) do |tp|
+      if tp.event == :raise
+        exc = tp.raised_exception
+        exc.instance_variable_set(EXC_BINDING_VAR, tp.binding)
+        events.add(RaiseEvent.new(tp.event, exc))
+      else
+        events.add(ReturnEvent.new(tp.event, tp.lineno, tp.path, tp.defined_class, tp.method_id, tp.return_value))
+      end
+    end
+
+    at_exit do
+      exc = $!
+      tp.disable
+      b = exc.instance_variable_get(EXC_BINDING_VAR)
+      if exc.kind_of?(StandardError) and b
+        raise_idx = events.to_a.find_index {|i| i.event == :raise and i.raised_exception == exc }
+        latest_events = raise_idx ? events.to_a[0...raise_idx] : []
+        return_events = latest_events.find_all {|i| i.event != :raise }
+        return_values = return_events.map(&:return_value)
+
+        show_trace(return_events)
+        error_print(exc)
+
+        Kernel.module_eval do
+          define_method(:dexc_hist) do
+            return_values
+          end
+          alias_method :hist, :dexc_hist
+        end
+
+        begin
+          require 'pry'
+          b.pry
+        rescue LoadError
+          require 'irb'
+          IRB::Irb.module_eval do
+            alias_method :eval_input_orig, :eval_input
+            define_method(:eval_input) do
+              IRB::Irb.module_eval { alias_method :eval_input, :eval_input_orig }
+              require 'irb/ext/multi-irb'
+              IRB.irb(nil, b)
+            end
+          end
+          IRB.start
+        end
+        exit!
+      end
+    end
+
+    tp.enable
+  end
+  module_function :start
+
+  def show_trace(events)
+    idx_width = (events.length - 1).to_s.length
+    file_cache = {}
+    events.each_with_index do |i, idx|
+      show_line(i.path, i.lineno, idx, idx_width, file_cache)
+      puts " " * (idx_width + 1) + "#{i.defined_class}##{i.method_id}#{i.event == :b_return ? '(block)' : ''}: #{i.return_value.inspect}"
+    end
+    puts
+  end
+  module_function :show_trace
+
+  def show_line(path, lineno, index, index_width, cache)
+    print "#{"%#{index_width}d" % index}:#{path}:#{lineno}"
+    begin
+      cache[path] ||= open(path).each_line.map(&:chomp)
+      print "> #{lineno > 0 ? cache[path][lineno - 1] : ''}"
+    rescue Errno::ENOENT
+      cache[path] = []
+    end
+    puts
+  end
+  module_function :show_line
+
+  # from Irb#eval_input(lib/irb.rb)
+  def error_print(exc)
+    print exc.class, ": ", exc, "\n"
+    messages = []
+    lasts = []
+    levels = 0
+    back_trace_limit = 30
+    for m in exc.backtrace
+      if m
+        if messages.size < back_trace_limit
+          messages.push "\tfrom "+m
+        else
+          lasts.push "\tfrom "+m
+          if lasts.size > back_trace_limit
+            lasts.shift
+            levels += 1
+          end
+        end
+      end
+    end
+    print messages.join("\n"), "\n"
+    unless lasts.empty?
+      printf "... %d levels...\n", levels if levels > 0
+      print lasts.join("\n")
+    end
+  end
+  module_function :error_print
+end
+
+Dexc.start

data/lib/dexc/version.rb

@@ -0,0 +1,3 @@
+module Dexc
+  VERSION = "0.0.1"
+end

data/test/test_dexc.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+class TestDexc < Test::Unit::TestCase
+  def test_load
+    assert_nothing_raised do
+      require_relative '../lib/dexc'
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: dexc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kazuki Tsujimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Automatically start the REPL and show trace on an exception to debug.
+email:
+- kazuki@callcc.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- BSDL
+- COPYING
+- Gemfile
+- README.rdoc
+- Rakefile
+- dexc.gemspec
+- lib/dexc.rb
+- lib/dexc/version.rb
+- test/test_dexc.rb
+homepage: https://github.com/k-tsj/dexc
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2613877154168346120
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2613877154168346120
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A library that helps you to debug an exception
+test_files: []