backtracer 0.0.1

data/README

@@ -0,0 +1,39 @@
+ruby_backtracer: a library to output higher quality backtraces if an unhandled exception is raised
+
+ex:
+running given script examples/crash.rb used to output:
+examples>ruby crash.rb
+crash.rb:2:in `go2': unhandled exception
+        from crash.rb:6:in `go'
+        from crash.rb:9
+
+now outputs:
+examples>ruby -r../backtrace_with_code_and_locals crash.rb
+
+unhandled exception: crash.rb:2:   raise
+        locals: {"a"=>"3", "b"=>55}
+          from:
+        crash.rb:1 go2(a=>3, b=>55)
+                locals: {"a"=>"3", "b"=>55}
+        crash.rb:5 go(a=>3)
+                locals: {"a"=>"3"}
+
+Now wasn't that prettier?
+
+There are several other tracing options provided, if you don't want as much output, or want more speed.  Specify which by script name.
+
+ex: backtrace_nothing_swallowed.rb outputs the same as the default exception output, except it doesn't have the 
+...skip 24 lines... 
+line in the middle (also no speed slowdown, and no local variables displayed).
+
+Try them out by running test_all.rb in the examples folder, or eyeball the example output files in examples/example_output*
+
+http://github.com/rogerdpack/ruby_backtracer/tree/master
+
+Note: some options depends on ruby-debug [MRI] gem, some don't.
+
+To install clone from github, above, then ruby -rscriptname your_script.
+
+related projects: unroller, http://eigenclass.org/hiki/method+arguments+via+introspection, liveconsole, ruby-debug
+
+send comments to rogerdpack on github.

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "backtracer"
+    gemspec.summary = gemspec.description = "Quality backtraces for ruby"
+    gemspec.email = "rogerdpack@gmail.com"
+#    gemspec.homepage = "http://github.com/technicalpickles/the-perfect-gem"
+#    gemspec.description = "TODO"
+#    gemspec.authors = ["Josh Nichols"]
+#    gemspec.dependency
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/crash.rb

@@ -0,0 +1,10 @@
+def go2(a, b)
+ raise
+end
+
+def go(a); 
+ go2(a, 55); 
+end
+
+go '3'
+

data/examples/crash_longer.rb

@@ -0,0 +1,22 @@
+# more "complicated" file to show off backtraces
+def go2(a, b)
+ 3
+ b = 3
+ within_go2 = 4
+ raise
+end
+def go(a); 
+ within_go = 2
+ go2(a, 55); 
+ 'abc'
+end
+
+def does_nothing a
+
+end
+
+does_nothing 3
+does_nothing 4
+does_nothing 5
+
+go '3'

data/examples/example_test_all_output

@@ -0,0 +1,39 @@
+
+
+
+running ruby -r../backtrace_nothing_swallowed.rb crash.rb
+crash.rb:2:in `go2': unhandled exception
+	from crash.rb:6:in `go'
+	from crash.rb:9
+==== 
+crash.rb:2:in `go2'
+crash.rb:6:in `go'
+crash.rb:9
+====
+
+
+
+running ruby -r../backtrace_with_code.rb crash.rb
+crash.rb:2:in `go2': unhandled exception
+	from crash.rb:6:in `go'
+	from crash.rb:9
+==== 
+crash.rb:2:in `go2'
+	raise
+crash.rb:6:in `go'
+	go2(a, 55);
+crash.rb:9
+	go '3'
+====
+
+
+
+running ruby -r../backtrace_with_code_and_locals.rb crash.rb
+
+unhandled exception: crash.rb:2:   raise
+	locals: {"a"=>"3", "b"=>55}
+	  from:
+	crash.rb:1 go2(a=>3, b=>55)
+		locals: {"a"=>"3", "b"=>55}
+	crash.rb:5 go(a=>3)
+		locals: {"a"=>"3"}

data/examples/example_test_large_output

@@ -0,0 +1,42 @@
+ruby 1.8.6 (2009-3-4 mbari 8B/0x8770 on patchlevel 287) [i686-linux]
+#0:crash.rb:1::-: def go2(a, b)
+ |#0:crash.rb:1:Module:>: def go2(a, b)
+args were []
+#0:crash.rb:1:Module:<: def go2(a, b)
+#0:crash.rb:5::-: def go(a); 
+ |#0:crash.rb:5:Module:>: def go(a); 
+args were []
+#0:crash.rb:5:Module:<: def go(a); 
+#0:crash.rb:9::-: go '3'
+ |#0:crash.rb:5:Object:>: def go(a); 
+args were [["a", "3"]]
+ |#0:crash.rb:6:Object:-:  go2(a, 55); 
+ | |#0:crash.rb:1:Object:>: def go2(a, b)
+args were [["a", "3"], ["b", 55]]
+ | |#0:crash.rb:2:Object:-:  raise
+ | | |#0:crash.rb:2:Kernel:>:  raise
+args were []
+ | | | |#0:crash.rb:2:Class:>:  raise
+args were []
+ | | | | |#0:crash.rb:2:Exception:>:  raise
+args were []
+ | | | |#0:crash.rb:2:Exception:<:  raise
+ | | |#0:crash.rb:2:Class:<:  raise
+ | | | |#0:crash.rb:2:Exception:>:  raise
+args were []
+ | | |#0:crash.rb:2:Exception:<:  raise
+ | | | |#0:crash.rb:2:Exception:>:  raise
+args were []
+ | | |#0:crash.rb:2:Exception:<:  raise
+ | | |#0:crash.rb:2:Object:R:  raise
+ | |#0:crash.rb:2:Kernel:<:  raise
+ |#0:crash.rb:3:Object:<: end
+#0:crash.rb:7:Object:<: end
+
+unhandled exception: crash.rb:2:   raise
+	locals: {"a"=>"3", "b"=>55}
+	  from:
+	crash.rb:1 go2(a=>3, b=>55)
+		locals: {"a"=>"3", "b"=>55}
+	crash.rb:5 go(a=>3)
+		locals: {"a"=>"3"}

data/examples/run_all_styles_of_backtracer.rb

@@ -0,0 +1,12 @@
+for file in Dir.glob("../lib/backtrace_*") do
+ commands = []
+ for crash_file in ['crash.rb'] do
+  commands << "ruby -r#{file} #{crash_file}"
+ end
+ #commands << "ruby -v -r../backtrace_with_code_and_locals.rb ../crash.rb"
+ for command in commands
+  puts "\n\n\nrunning #{command}\n"
+  system(command)
+ end
+  
+end

data/examples/run_large_style_output.rb

@@ -0,0 +1 @@
+system "ruby -v -r../lib/backtrace_with_code_and_locals.rb crash.rb"

data/lib/backtrace_nothing_swallowed.rb

@@ -0,0 +1,6 @@
+# this one is easy
+at_exit {
+ puts "==== "
+ puts $!.backtrace.join("\n")
+ puts "===="
+}

data/lib/backtrace_with_code_and_locals.rb

@@ -0,0 +1,2 @@
+# this is the default
+require File.dirname(__FILE__) + '/core_backtracer.rb'

data/lib/backtracer.rb

@@ -0,0 +1,16 @@
+# this one display full BT with code, at the end [no performance loss]
+SCRIPT_LINES__ = {}
+at_exit {
+ puts "==== "
+ 
+ backtrace_with_code = $!.backtrace.map{|bt| 
+   file, line, junk = bt.split(":")
+   line = line.to_i - 1 
+   actual_file = SCRIPT_LINES__[file]
+   actual_line = actual_file[line] if actual_file
+   "#{bt}\n\t#{actual_line.strip if actual_line}"
+ } 
+   
+ puts backtrace_with_code
+ puts "===="
+}

data/lib/core_backtracer.rb

@@ -0,0 +1,277 @@
+#
+#   backtracer.rb - display backtrace of most recent error on exit [quality back trace, mind you]
+# 	based off tracer.rb, unroller, python
+#   	original tracer.rb by Keiju ISHITSUKA(Nippon Rational Inc.)
+# Tons of the code is useless and could be removed, but at least it works
+
+require 'rubygems'
+require 'ruby-debug'
+Debugger.start # we use this to track args.
+
+#Debugger.keep_frame_binding = true # whatever this did :P
+#
+# tracer main class
+#
+class Tracer
+  @RCS_ID='-$Id: tracer.rb,v 1.8 1998/05/19 03:42:49 keiju Exp keiju $-'
+
+  @stdout = STDOUT
+  @verbose = false
+  class << self
+    attr :verbose, true
+    alias verbose? verbose
+    attr :stdout, true
+  end
+  
+  EVENT_SYMBOL = {
+    "line" => "-",
+    "call" => ">",
+    "return" => "<",
+    "class" => "C",
+    "end" => "E",
+    "c-call" => ">",
+    "c-return" => "<",
+    "raise" => "R"
+  }
+  
+  def initialize
+    @threads = Hash.new
+    if defined? Thread.main
+      @threads[Thread.main.object_id] = 0
+    else
+      @threads[Thread.current.object_id] = 0
+    end
+
+    @get_line_procs = {}
+
+    @filters = []
+  end
+  
+  def stdout
+    Tracer.stdout
+  end
+
+  def on
+    if block_given?
+      on
+      begin
+	yield
+      ensure
+	off
+      end
+    else
+      set_trace_func method(:trace_func).to_proc
+      stdout.print "Trace on\n" if Tracer.verbose?
+    end
+  end
+  
+  def off
+    set_trace_func nil
+    stdout.print "Trace off\n" if Tracer.verbose?
+  end
+
+  def add_filter(p = proc)
+    @filters.push p
+  end
+
+  def set_get_line_procs(file, p = proc)
+    @get_line_procs[file] = p
+  end
+
+  def get_line(file, line)
+   self.class.get_line(file, line)
+  end
+
+  def self.get_line(file, line)
+    @get_line_procs ||= {}
+    if p = @get_line_procs[file]
+      return p.call(line)
+    end
+
+    unless list = SCRIPT_LINES__[file]
+      begin
+	f = open(file)
+	begin 
+	  SCRIPT_LINES__[file] = list = f.readlines
+	ensure
+	  f.close
+	end
+      rescue
+	SCRIPT_LINES__[file] = list = []
+      end
+    end
+
+    if l = list[line - 1]
+      l
+    else
+      "-\n"
+    end
+  end
+  
+  def get_thread_no
+    if no = @threads[Thread.current.object_id]
+      no
+    else
+      @threads[Thread.current.object_id] = @threads.size
+    end
+  end
+
+  require 'pp' 
+  @@depths = {} # I think I added this [rdp]
+  @@last_line = nil
+  @@last_file = nil
+  @@last_symbol = nil
+  def trace_func(event, file, line, id, binding, klass, *nothing)
+   begin
+    return if file == __FILE__
+
+    type = EVENT_SYMBOL[event] # "<" or ">"
+    thread_no = get_thread_no
+    Thread.current['backtrace'] ||= []
+    @@depths[thread_no] ||= 0
+    Thread.current['backtrace'] << nil if Thread.current['backtrace'].length  < (@@depths[thread_no] ) # pad it :)
+    if type == ">"
+      @@depths[thread_no] += 1
+    elsif type == "<"
+      @@depths[thread_no] -= 1
+    end
+
+    for p in @filters
+      return unless p.call event, file, line, id, binding, klass
+    end
+    return if file.include? 'ruby-debug' # debugger output
+
+    saved_crit = Thread.critical
+    Thread.critical = true
+# TODO only do the backtrace if last command was 'raise'
+    if type == 'R'
+         Thread.current['backtrace'][@@depths[thread_no] - 1] = [[file, line], [], binding]
+         Thread.current['backtrace'] = Thread.current['backtrace'][0..@@depths[thread_no]] # clear old stuffs
+    end
+
+    if [file, line] != @@last_line # for output sake [not output too many lines]
+      if @@last_symbol == '>' # then we need to add to the backtrace--we've advanced down a call in the callstack and can now glean its variables' values
+         previous_frame_binding = Debugger.current_context.frame_binding(2)
+	 collected = []
+         args = Debugger.current_context.frame_args 1 rescue nil # maybe it had no arguments [ltodo check]
+
+	 if args
+	   for arg in args
+		value =  eval(arg, previous_frame_binding)
+		collected << [arg, value]
+	   end 
+	 else
+	   print "WEIRD--please report err spot 1, how to reproduce"
+         end
+         print 'args were ', collected.inspect, "\n" if $VERBOSE
+
+	 Thread.current['backtrace'][@@depths[thread_no] - 1] = [[@@last_file, @@last_line], collected, previous_frame_binding]
+      end
+    end
+
+    out = " |" * @@depths[thread_no] + sprintf("#%d:%s:%d:%s:%s: %s",
+       get_thread_no,
+       file,
+       line,
+       klass || '',
+       type,
+       get_line(file, line))
+
+   print out if $VERBOSE
+   @@last_line =  line
+   @@last_file = file
+   @@last_symbol = type
+
+   Thread.critical = saved_crit
+   rescue Exception => e
+	# TODO investigate print "BAD" + e.to_s + e.backtrace.inspect
+   end
+  end
+
+  Single = new
+  def Tracer.on
+    if block_given?
+      Single.on{yield}
+    else
+      Single.on
+    end
+  end
+  
+  def Tracer.off
+    Single.off
+  end
+  
+  def Tracer.set_get_line_procs(file_name, p = proc)
+    Single.set_get_line_procs(file_name, p)
+  end
+
+  
+  def Tracer.add_filter(p = proc)
+    Single.add_filter(p)
+  end
+
+  def Tracer.output_locals(previous_binding, prefix="\t\t")
+    locals_name = Kernel.eval("local_variables", previous_binding)
+    locals = {}
+    for name in locals_name do
+	locals[name] = Kernel.eval(name, previous_binding)
+    end
+    
+    puts "#{prefix}locals: " + locals.inspect
+  end
+
+
+  at_exit do # at_exit seems to be run by the last running Thread. Or an exiting thread? Not sure for always.
+    off
+    raise_location = Thread.current['backtrace'].pop
+    loc = raise_location[0]
+    puts
+    puts "unhandled exception: #{loc[0]}:#{loc[1]}:  #{get_line loc[0], loc[1]}"
+    if(defined?($NO_LOCALS))
+      no_locals = true
+    else
+     no_locals = false
+    end
+    output_locals(raise_location[2], "\t") unless no_locals
+    puts "\t  from:\n"
+
+    # last most one is redundant with the raise one...
+    Thread.current['backtrace'].pop
+
+    for loc, params, binding in Thread.current['backtrace'].reverse do
+        original_line = get_line loc[0], loc[1]
+	# TODO handle non parentheses
+	line_no_params = original_line.split('(')[0]
+	line_no_params.gsub!('def ', '')
+	line_params = line_no_params + "("
+	comma = ""
+	for param in params do
+	 line_params += param[0].to_s + "=>" + param[1].to_s + ", "
+	 comma = ", "
+	end
+	line_params = line_params[0..-3] # strip off ending comma
+	line_params += ")" if line_params =~ /\(/
+        puts "\t#{loc[0]}:#{loc[1]} #{line_params}" 
+	output_locals binding unless no_locals
+    end
+
+
+    exit!
+  end
+end
+
+SCRIPT_LINES__ = {} unless defined? SCRIPT_LINES__
+Tracer::on
+if $0 == __FILE__
+  # direct call
+    
+  $0 = ARGV[0]
+  ARGV.shift
+  Tracer.on
+  require $0
+elsif caller(0).size == 1
+  Tracer.on
+end
+
+# TODO: do are arg snapshots capture it right [soon enough]?
+# TODO: don't output error if none thrown :)

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: backtracer
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-29 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Quality backtraces for ruby
+email: rogerdpack@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- VERSION
+- examples/crash.rb
+- examples/crash_longer.rb
+- examples/example_test_all_output
+- examples/example_test_large_output
+- examples/run_all_styles_of_backtracer.rb
+- examples/run_large_style_output.rb
+- lib/backtrace_nothing_swallowed.rb
+- lib/backtrace_with_code_and_locals.rb
+- lib/backtracer.rb
+- lib/core_backtracer.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Quality backtraces for ruby
+test_files: 
+- examples/crash.rb
+- examples/crash_longer.rb
+- examples/run_all_styles_of_backtracer.rb
+- examples/run_large_style_output.rb