pretty_backtrace 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3572b7c273aed0de085880965919d39ff5f695a9
+  data.tar.gz: 32482304d2e4fb3b662b0ea4b7831d156fe4f317
+SHA512:
+  metadata.gz: 978793b5cabdf4f7272dfc058fef5a496c920dda00b5071bee94216bd85596da4080cac020bf3b615f1b02c9b3cc8cfc11f126601fd0d164dbd42ceb77aea3dc
+  data.tar.gz: d1a1c7c98bbe2c7a6d259ed3087ce1a97f7cca53d92e22f615e2cdcc6f18044e4d2a7e01f72f562a128684c6814e3f584a9d23633f5d1529ef134f8816b394f5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Koichi Sasada
+
+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,63 @@
+# PrettyBacktrace
+
+Pretty your exception backtrace.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pretty_backtrace'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pretty_backtrace
+
+## Usage
+
+Use like that:
+
+```ruby
+require 'pretty_backtrace'
+PrettyBacktrace.enable
+
+def recursive n
+  str = "Hi #{n}!!" * 128
+  if n > 0
+    recursive n - 1
+  else
+    raise "bottom of recursive"
+  end
+end
+
+recursive 3
+```
+
+and you can see prettier backtrace (you can see local variable names and values).
+
+```
+test.rb:10:in `recursive' (n = 0, str = "Hi 0!!Hi 0!!Hi 0!!Hi...): bottom of recursive (RuntimeError)
+        from test.rb:8:in `recursive' (n = 1, str = "Hi 1!!Hi 1!!Hi 1!!Hi...)
+        from test.rb:8:in `recursive' (n = 2, str = "Hi 2!!Hi 2!!Hi 2!!Hi...)
+        from test.rb:8:in `recursive' (n = 3, str = "Hi 3!!Hi 3!!Hi 3!!Hi...)
+        from test.rb:14:in `<main>'
+```
+
+You only need to require "pretty_backtrace/enable" to eliminate "PrettyBacktrace.enable call".
+
+PrettyBacktrace::CONFIG can change behaviour. See source code files for details.
+
+## Contributing
+
+There are no spec tests. I love to get your contributions!
+
+1. Fork it ( https://github.com/ko1/pretty_backtrace/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task 'run' do
+  ruby 'test.rb'
+end

data/lib/pretty_backtrace.rb

@@ -0,0 +1,89 @@
+require "pretty_backtrace/version"
+require 'debug_inspector'
+
+module PrettyBacktrace
+  CONFIG = {
+    truncate_length: 20,
+    disabled_exception_classes: {},
+  }
+
+  EXCEPTION_MODIFIER_TRACE = TracePoint.new(:raise){|tp|
+    begin
+      e = tp.raised_exception
+
+      CONFIG[:disabled_exception_classes].each{|klass, _|
+        next if e.kind_of?(klass)
+      }
+
+      RubyVM::DebugInspector.open{|dc|
+        locs = dc.backtrace_locations
+        pretty_backtrace = locs.map.with_index{|loc, i|
+          next if i < 2
+
+          iseq = dc.frame_iseq(i)
+
+          if iseq
+            b = dc.frame_binding(i)
+            lvs = iseq_local_variables(iseq)
+            lvs_val = lvs.inject({}){|r, lv|
+              v = b.local_variable_get(lv).inspect
+              r[lv] = v; r
+            }
+          else
+            lvs_val = {}
+          end
+
+          modify_trace_line loc, lvs_val
+        }.compact
+        e.set_backtrace pretty_backtrace
+      }
+    rescue => e
+      puts e
+      puts e.backtrace
+      fail "PrettyBacktrace BUG"
+    end
+  }
+
+  def self.enable
+    if block_given?
+      EXCEPTION_MODIFIER_TRACE.enable{
+        yield
+      }
+    else
+      EXCEPTION_MODIFIER_TRACE.enable
+    end
+  end
+
+  def self.disable
+    if block_given?
+      EXCEPTION_MODIFIER_TRACE.disable{
+        yield
+      }
+    else
+      EXCEPTION_MODIFIER_TRACE.disable
+    end
+  end
+
+  def self.iseq_local_variables iseq
+    _,_,_,_,arg_info,name,path,a_path,_,type,lvs, * = iseq.to_a
+    lvs
+  end
+
+  #
+  # local_variables_values is a Hash object containing pairs of
+  # a local variable name and value of local variable.
+  #
+  def self.modify_trace_line backtrace_location, local_variables_values
+    trace_line = backtrace_location.to_s
+
+    unless local_variables_values.empty?
+      additional = local_variables_values.map{|lv, v|
+        v = v[0..CONFIG[:truncate_length]] + '...' if v.length > CONFIG[:truncate_length]
+        "#{lv} = #{v.to_s}"
+      }.join(", ")
+      trace_line = "#{trace_line} (#{additional})"
+    end
+
+    trace_line
+  end
+end

data/lib/pretty_backtrace/enable.rb

@@ -0,0 +1,3 @@
+require "pretty_backtrace"
+PrettyBacktrace.enable
+

data/lib/pretty_backtrace/version.rb

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

data/pretty_backtrace.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pretty_backtrace/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pretty_backtrace"
+  spec.version       = PrettyBacktrace::VERSION
+  spec.authors       = ["Koichi Sasada"]
+  spec.email         = ["ko1@atdot.net"]
+  spec.summary       = %q{Pretty your exception backtrace.}
+  spec.description   = %q{Pretty your exception backtrace.}
+  spec.homepage      = "http://github.com/ko1/pretty_backtrace"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "debug_inspector", "~> 0.0.1"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test.rb

@@ -0,0 +1,13 @@
+$: << './lib'
+require 'pretty_backtrace/enable'
+
+def recursive n
+  str = "Hi #{n}!!" * 128
+  if n > 0
+    recursive n - 1
+  else
+    raise "bottom of recursive"
+  end
+end
+
+recursive 3

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: pretty_backtrace
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Koichi Sasada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug_inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Pretty your exception backtrace.
+email:
+- ko1@atdot.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pretty_backtrace.rb
+- lib/pretty_backtrace/enable.rb
+- lib/pretty_backtrace/version.rb
+- pretty_backtrace.gemspec
+- test.rb
+homepage: http://github.com/ko1/pretty_backtrace
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Pretty your exception backtrace.
+test_files: []