backtracer 0.1.0 → 0.2.0

data/README

@@ -1,14 +1,16 @@
-ruby_backtracer: a library to output higher quality backtraces if an unhandled exception is raised
+ruby_backtracer: output higher quality backtraces if an unhandled exception occurs.  Originally inspired by the frustration of seeling ...24 levels... a few too many times.
 
-ex:
-running given script examples/crash.rb used to output:
+There are several options available (the more verbose ones rely on ruby-debug, which slows things down a bit).
+
+ex:
+a script 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
+Using backtracer, it now outputs:
+examples>ruby -rbacktracer_locals crash.rb
 
 unhandled exception: crash.rb:2:   raise
         locals: {"a"=>"3", "b"=>55}
@@ -17,23 +19,92 @@ unhandled exception: crash.rb:2:   raise
                 locals: {"a"=>"3", "b"=>55}
         crash.rb:5 go(a=>3)
                 locals: {"a"=>"3"}
+or
+examples>ruby -rbacktracer crash.rb
+====
+crash.rb:2:in `go2'
+        raise
+crash.rb:7:in `go'
+        go2(a, 55)
+crash.rb:10
+        go '3'
+====
+crash.rb:2:in `go2': unhandled exception
+        from crash.rb:7:in `go'
+        from crash.rb:10
+
+
+All the options are backtracer, backtracer_locals, backtracer_simple, backtracer_tracer
+
+
+== Installation ==
+
+== 1.9 ==
+
+$ gem install ruby-debug19
+$ gem sources add http://gemcutter.org # if necessary
+$ gem install backtracer
+
+run as above 
+$ ruby -rbacktracer script_name
+
+== 1.8.x ==
+
+$ gem install ruby-debug
+$ gem sources add http://gemcutter.org # if necessary
+$ sudo gem install faster_rubygems # necessary to be able to load gems from the command line -- installs the file rubygemsf into your site_ruby
+$ gem install backtracer
+
+now run them like
+$ ruby -rubygemsf -rbacktracer script_name
+
+the rubygemsf is necessary because for some reason running
+$ ruby -rubygems -rbacktracer script_name 
+
+fails [probably a bug in ruby]
+
+== Descriptions ==
+
+Try these out if desired:
+create a file like:
+
+  def go(a)
+   raise
+  end
+  go(3)
+
+then run ruby against it like
+
+ruby -rbacktracer name
+  outputs full backtrace with code of each line [a la Python]
+ruby -rbacktracer_locals name
+  outputs full backtrace with local variables and parameters
+ruby -rbacktracer_simple name
+  outputs backtrace without the ...24 levels... [yea!]
+ruby -backtracer_tracer name
+  same as backtracer_locals except it shows traces of calls as they're made
+
+
+or in 1.8.x
+ruby -rubygemsf -rbacktracer name
+etc.
 
-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.
+== Other ==
 
-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).
+Note that you can [if desired] load these within a script iself
+require 'backtracer'
 
-Try them out by running test_all.rb in the examples folder, or eyeball the example output files in examples/example_output*
+and it will output a backtrace if one exists at exit time.
 
-http://github.com/rogerdpack/ruby_backtracer/tree/master
+You can also add it to your RUBYOPT variable if you always want it to run [backtracer_simple and backtracer don't cause any slowdown].
+$ export RUBYOPT=-rbacktracer
 
-Note: some options depends on ruby-debug [MRI] gem, some don't.
+if desired.
 
-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
 
-related projects: unroller, http://eigenclass.org/hiki/method+arguments+via+introspection, liveconsole, ruby-debug
+Comments welcome to rdp on github.
 
-send comments to rogerdpack on github.
+http://github.com/rdp/backtracer

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/examples/crash.rb

@@ -2,8 +2,9 @@ def go2(a, b)
  raise
 end
 
-def go(a); 
- go2(a, 55); 
+def go(a)
+ b = 3
+ go2(a, 55)
 end
 
 go '3'

data/lib/backtracer_tracer.rb

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

data/lib/backtracer_tracer_args.rb

@@ -0,0 +1,3 @@
+# this is the default
+$VERBOSE = 1 # how we tell it to do args currently
+require File.dirname(__FILE__) + '/core_backtracer.rb'

data/lib/core_backtracer.rb

@@ -90,12 +90,14 @@ class Tracer
 
     unless list = SCRIPT_LINES__[file]
       begin
-	f = open(file)
-	begin 
-	  SCRIPT_LINES__[file] = list = f.readlines
-	ensure
-	  f.close
-	end
+          raise 'might be a .so file' if file =~ /\.so$/
+	  f = open(file)
+	  begin
+	    SCRIPT_LINES__[file] = list = f.readlines
+	  ensure
+	    f.close
+	  end
+      
       rescue
 	SCRIPT_LINES__[file] = list = []
       end
@@ -143,7 +145,7 @@ class Tracer
 
     saved_crit = Thread.critical
     Thread.critical = true
-# TODO only do the backtrace if last command was 'raise'
+    # 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
@@ -163,7 +165,8 @@ class Tracer
 	 else
 	   print "WEIRD--please report err spot 1, how to reproduce"
          end
-         print 'args were ', collected.inspect, "\n" if $VERBOSE
+
+         print 'args were ', collected.inspect, "\n" if $VERBOSE # we still collect them for the end backtrace if !$VERBOSE
 
 	 Thread.current['backtrace'][@@depths[thread_no] - 1] = [[@@last_file, @@last_line], collected, previous_frame_binding]
       end

data/lib/tracerr.rb

@@ -0,0 +1,168 @@
+#
+#   tracer.rb - 
+#   	$Release Version: 0.2$
+#   	$Revision: 1.8 $
+#   	$Date: 1998/05/19 03:42:49 $
+#   	by Keiju ISHITSUKA(Nippon Rational Inc.)
+#
+# --
+#
+#   
+#
+
+#
+# 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" => "<",
+  }
+  
+  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)
+    if p = @get_line_procs[file]
+      return p.call(line)
+    end
+
+    unless list = SCRIPT_LINES__[file]
+      begin
+        raise 'binary file' if file =~ /\.so$/
+	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
+  
+  def trace_func(event, file, line, id, binding, klass, *)
+    return if file == __FILE__
+    
+    for p in @filters
+      return unless p.call event, file, line, id, binding, klass
+    end
+    
+    saved_crit = Thread.critical
+    Thread.critical = true
+    stdout.printf("#%d:%s:%d:%s:%s: %s",
+      get_thread_no,
+      file,
+      line,
+      klass || '',
+      EVENT_SYMBOL[event],
+      get_line(file, line))
+    Thread.critical = saved_crit
+  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
+  
+end
+
+SCRIPT_LINES__ = {} unless defined? SCRIPT_LINES__
+
+if $0 == __FILE__
+  # direct call
+    
+  $0 = ARGV[0]
+  ARGV.shift
+  Tracer.on
+  require $0
+elsif caller(0).size == 1
+  Tracer.on
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backtracer
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: []
 
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-29 00:00:00 -06:00
+date: 2009-11-03 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -32,9 +32,12 @@ files:
 - examples/run_all_styles_of_backtracer.rb
 - examples/run_large_style_output.rb
 - lib/backtracer.rb
-- lib/backtracer_all.rb
+- lib/backtracer_locals.rb
 - lib/backtracer_simple.rb
+- lib/backtracer_tracer.rb
+- lib/backtracer_tracer_args.rb
 - lib/core_backtracer.rb
+- lib/tracerr.rb
 has_rdoc: true
 homepage: 
 licenses: []
@@ -59,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: Quality backtraces for ruby