backtracer 0.3.0 → 0.4.0

data/README

@@ -1,16 +1,25 @@
-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.
+backtracer: ruby gem to output higher quality backtraces if an unhandled exception is thrown.  
 
-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
+If you've ever seen 
+...24 levels... 
+and disliked it, this is the gem for you.
+
+It displays the full back trace, with or without code and/or local variables, etc.
+
+There are several options available.
+
+example:
+
+a script that used to output:
+
+>ruby crash.rb
 crash.rb:2:in `go2': unhandled exception
         from crash.rb:6:in `go'
         from crash.rb:9
 
-Using backtracer, it now outputs:
-examples>ruby -rbacktracer_locals crash.rb
+Now outputs:
+>backtracer --locals crash.rb
 
 unhandled exception: crash.rb:2:   raise
         locals: {"a"=>"3", "b"=>55}
@@ -20,7 +29,7 @@ unhandled exception: crash.rb:2:   raise
         crash.rb:5 go(a=>3)
                 locals: {"a"=>"3"}
 or
-examples>ruby -rbacktracer crash.rb
+>backtracer crash.rb
 ====
 crash.rb:2:in `go2'
         raise
@@ -33,78 +42,71 @@ crash.rb:2:in `go2': unhandled exception
         from crash.rb:7:in `go'
         from crash.rb:10
 
+Also included is a --ping option which periodically dumps the current running threads' backtrace(s)--quite useful for figuring out where you code is spending a lot of its time.
 
-All the options are backtracer, backtracer_locals, backtracer_simple, backtracer_tracer
-
+To see all possible options run
+$ backtracer -h
 
 == Installation ==
 
-== 1.9 ==
+== 1.8.x ==
 
-$ gem install ruby-debug19
+$ gem install ruby-debug
 $ gem sources add http://gemcutter.org # if necessary
 $ gem install backtracer
 
-run as above 
-$ ruby -rbacktracer script_name
+now run like
+$ backtracer script_name
+$ backtracer --locals script_name
 
-== 1.8.x ==
+== 1.9.1 ==
 
-$ gem install ruby-debug
+$ gem install ruby-debug19 # if you want some of the more exotic backtraces
 $ 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]
+run as above (backtracer executable), or as a ruby require:
+$ ruby -rbacktracer script_name
+$ ruby -rbacktracer_locals script_name
 
 == Descriptions ==
 
-Try these out if desired:
-create a file like:
+Try out the options:
+create a file like
 
   def go(a)
    raise
   end
   go(3)
 
-then run ruby against it like
+then run backtracer against it.
 
-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
+== Other ==
 
+Note that you can load the better backtracing capability within a script itself:
 
-or in 1.8.x
-ruby -rubygemsf -rbacktracer name
-etc.
+require 'backtracer'
 
+will cause it to output a coded backtrace at exit time, if an unhandled exception occurs.  Backtracer default and backtracer_simple don't cause runtime slowdown.
 
-== Other ==
+You can also add it to your RUBYOPT variable if you always want it to run against all scripts (backtracer_simple and backtracer don't cause any slowdowns).
+Here's how:
+1.9:
 
-Note that you can [if desired] load these within a script iself
-require 'backtracer'
+$ export RUBYOPT=-rbacktracer
 
-and it will output a backtrace if one exists at exit time.
+1.8.7:
+you'll need to install a helper loader since gems can't load on the command line for some reason.
 
-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
+$ sudo gem install faster_rubygems # the helper--installs faster_rubygems.rb and some other files to your site_ruby
+$ export RUBYOPT='-rfaster_rubygems -rbacktracer'
 
-if desired.
+Enjoy.
 
 == Related projects ==
 unroller, http://eigenclass.org/hiki/method+arguments+via+introspection, liveconsole, ruby-debug
 
-Comments welcome to rdp on github.
+Comments welcome 
+rdp on github.
 
 http://github.com/rdp/backtracer

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/bin/backtracer

@@ -1,10 +1,27 @@
 #!/usr/bin/env ruby
-# gems will fill this in for me
 
-if true # (ARGV.include? '-h') || (ARGV.include? '--help')
+if (ARGV.include? '-h') || (ARGV.include? '--help')
  dir = File.dirname(__FILE__) + '/../lib'
- puts 'options: ( -r filename) '
- for file in Dir[dir + '/*.rb']
-  puts File.basename(file)
+ puts 'options: '
+ for file in Dir[dir + '/backtracer_*.rb']
+  puts '--' + File.basename(file)[11..-4] # of backtracer_locals.rb, just locals
  end
-end
+ puts 'ex: $ backtracer filename.rb arg1 arg2'
+ puts 'ex: $ backtracer --simple filename.rb arg1 arg2'
+ puts 'you can also do $ ruby -rtracerr for an improved tracer (though 1.9.2 has the same already patched)'
+ exit
+end
+
+# expect
+# backtracer --plain --simple filename options
+
+if ARGV[0][0..1] == '--'
+ require 'backtracer_' + ARGV[0][2..-1] # take it off, too
+ ARGV.shift
+else
+ require 'backtracer'
+end
+
+$0 = File.expand_path ARGV[0] # for their benefit :)
+ARGV.shift
+load $0

data/lib/backtracer.rb

@@ -4,8 +4,8 @@ require File.dirname(__FILE__) + "/shared"
 require 'sane'
 
 at_exit {
-  if $!
-    puts "==== " + $!.inspect + ' ' + $!.to_s
+  if $! && !$!.is_a?(SystemExit) # SystemExit's are just normal, not exceptional
+    puts "==== ", $!.inspect + ' ' + $!.to_s
     bt2 = $!.backtrace
     backtrace_with_code = $!.backtrace.map{ |bt_line|
       if OS.windows? && bt_line[1..1] == ':'
@@ -23,7 +23,7 @@ at_exit {
     puts backtrace_with_code
     puts "===="
   else
-    puts "(no exception found to backtrace)"
+    puts "(no exception found to backtrace)" if $VERBOSE
   end
   # exit! TODO I guess do this once ours isn't *so* ugly
   # TODO compare with that fella xray

data/lib/backtracer_ping.rb

@@ -39,10 +39,12 @@ time = 1 if $0 == __FILE__
 Thread.new {
   loop {
     sleep time
-    pp fella.call
+    pp 'current stack trace', Time.now, fella.call
   }
 }
 
-if $0 == __FILE__ # a test
+require File.dirname(__FILE__) + '/backtracer' # we want the normal backtracer, too
+
+if $0 == __FILE__ # i.e. a test
  sleep
 end

data/lib/backtracer_tracer.rb

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

data/lib/core_backtracer.rb

@@ -154,7 +154,7 @@ class Tracer
        type,
        get_line(file, line))
 
-   print out if $VERBOSE
+   print out if $print_trace || $VERBOSE
    @@last_line =  line
    @@last_file = file
    @@last_symbol = type

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backtracer
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: []
 
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-05 00:00:00 -07:00
-default_executable: 
+date: 2009-11-10 00:00:00 -07:00
+default_executable: backtracer
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sane
@@ -36,7 +36,6 @@ description: Quality backtraces for ruby
 email: rogerdpack@gmail.com
 executables: 
 - backtracer
-- backtracer~
 extensions: []
 
 extra_rdoc_files: 

data/bin/backtracer~

@@ -1,7 +0,0 @@
-if (ARGV.include? '-h') || (ARGV.include? '--help')
- dir = File.dirname(__FILE__) + '/../lib'
- puts 'options:'
- for file in Dir[dir + '/*']
-  puts File.basename(file)
- end
-end