backtracer 0.4.1 → 0.5.0

data/README

@@ -1,25 +1,40 @@
-backtracer: ruby gem to output higher quality backtraces if an unhandled exception is thrown.  
+backtracer: gem to output higher quality backtraces if an unhandled exception occurs.  
 
 
 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.
+If you've ever wished an exception printout would display the code of the lines in a backtrace (a la Python), this is for you.
 
-There are several options available.
+It displays the full back trace (no ...'s), along with the code from each line!  It can even display local variables at each level of the call stack, if desired.
 
-example:
+Examples:
 
-a script that used to output:
-
->ruby crash.rb
+a script that once output:
+$ ruby crash.rb
 crash.rb:2:in `go2': unhandled exception
         from crash.rb:6:in `go'
         from crash.rb:9
 
 Now outputs:
->backtracer --locals crash.rb
+
+$ backtracer crash.rb
+
+   RuntimeError
+crash.rb:2:in `go2'
+        raise
+crash.rb:7:in `go'
+        go2(a, 55)
+crash.rb:10
+        go '3'
+
+
+(Note--has the code lines, and if there had been ...'s, would have ovecome them).
+
+or the --locals option
+
+$backtracer --locals crash.rb
 
 unhandled exception: crash.rb:2:   raise
         locals: {"a"=>"3", "b"=>55}
@@ -28,85 +43,75 @@ unhandled exception: crash.rb:2:   raise
                 locals: {"a"=>"3", "b"=>55}
         crash.rb:5 go(a=>3)
                 locals: {"a"=>"3"}
-or
->backtracer 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
 
-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.
+(displays locals, parameters kind of)
 
-To see all possible options run
+Also included is a --ping option, which periodically dumps current threads' backtrace(s)--quite useful for profiling to see where you code is spending a lot of its time (thanks xray gem!).  There is also an option that will print out thread dumps whenever you hit ctrl+c.
+
+To see all possible backtrace options run
 $ backtracer -h
+or
+$ backtracer --help
+
+
+More example outputs:
+
+http://github.com/rdp/backtracer/blob/master/examples/example_test_all_output
+http://github.com/rdp/backtracer/blob/master/examples/example_test_large_output
+http://github.com/rdp/backtracer/blob/master/examples/pinger_example
 
 == Installation ==
 
 == 1.8.x ==
 
-$ gem install ruby-debug
-$ gem sources add http://gemcutter.org # if necessary
+$ gem install ruby-debug # only necessary for the --locals option
+$ gem install jeweler && jeweler tumble # if necessary
 $ gem install backtracer
 
 now run like
-$ backtracer script_name
-$ backtracer --locals script_name
+
+$ backtracer script_name.rb
+$ backtracer --locals script_name.rb arg1 arg2
 
 == 1.9.1 ==
 
-$ gem install ruby-debug19 # if you want some of the more exotic backtraces
-$ gem sources add http://gemcutter.org # if necessary
+$ gem install ruby-debug19 # only necessary for the --locals option
+$ gem install jeweler && jeweler tumble # if necessary
 $ gem install backtracer
 
 run as above (backtracer executable), or as a ruby require:
 $ ruby -rbacktracer script_name
 $ ruby -rbacktracer_locals script_name
 
-== Descriptions ==
-
-Try out the options:
-create a file like
-
-  def go(a)
-   raise
-  end
-  go(3)
-
-then run backtracer against it.
-
 == Other ==
 
-Note that you can load the better backtracing capability within a script itself:
+Note that you can load backtracing capability within a script itself by:
 
 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.
+which 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, so sometimes you just want to add this by default.  If so, then add it to your RUBYOPT variable.  (Once I did this, I wondered why I would ever want anything else).  Here's how:
 
-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:
 
 $ export RUBYOPT=-rbacktracer
+or
+$ export RUBYOPT=-rbacktracer_simple # or whichever one you want
+
+1.8:
 
-1.8.7:
-you'll need to install a helper loader since gems can't load on the command line for some reason.
+you'll need to install a helper gem since rubygems can't load both itself and a gem on the command line for some reason.
 
-$ sudo gem install faster_rubygems # the helper--installs faster_rubygems.rb and some other files to your site_ruby
+$ sudo gem install faster_rubygems # the helper--installs faster_rubygems.rb and some other files to your site_ruby dir
 $ export RUBYOPT='-rfaster_rubygems -rbacktracer'
+or
+$ export RUBYOPT='-rfaster_rubygems -rbacktracer_simple'
 
 Enjoy.
 
-== Related projects ==
-unroller, http://eigenclass.org/hiki/method+arguments+via+introspection, liveconsole, ruby-debug
+== Other related projects ==
+
+unroller, http://eigenclass.org/hiki/method+arguments+via+introspection, liveconsole, ruby-debug (thanks guys!)
 
-Comments welcome 
-rdp on github.
+Comments welcome.
 
 http://github.com/rdp/backtracer

data/Rakefile

@@ -7,7 +7,6 @@ begin
 #    gemspec.homepage = "http://github.com/technicalpickles/the-perfect-gem"
 #    gemspec.description = "TODO"
 #    gemspec.authors = ["Josh Nichols"]
-    gemspec.add_dependency 'sane', '>= 0.9.1'
     gemspec.add_dependency 'xray'
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/bin/backtracer

@@ -7,8 +7,9 @@ if (ARGV.include? '-h') || (ARGV.include? '--help')
   puts '--' + File.basename(file)[11..-4] # of backtracer_locals.rb, just locals
  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)'
+ puts '$ backtracer --simple filename.rb arg1 arg2'
+ puts 'or its equivalent: $ ruby -rbacktracer_simple filename.rb arg1 arg2'
+ puts '$ ruby -rtracerr'
  exit
 end
 
@@ -22,6 +23,7 @@ else
  require 'backtracer'
 end
 
-$0 = File.expand_path ARGV[0] # for their benefit :)
+$0 = a = File.expand_path( ARGV[0]) # set $0 for their benefit :)
+# known buggy on mingw for some reason?
 ARGV.shift
-load $0
+load a

data/examples/example_test_all_output

@@ -1,39 +1,56 @@
 
 
+running ruby -rfaster_rubygems -r../lib/backtracer_ctrl_c_debugger.rb crash.rb
+hit ctrl + c to drop into a debugger
 
-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
-==== 
+     RuntimeError
 crash.rb:2:in `go2'
-crash.rb:6:in `go'
-crash.rb:9
-====
+        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
 
 
-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
-==== 
+
+running ruby -rfaster_rubygems -r../lib/backtracer_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", "b"=>3}
+
+
+
+running ruby -rfaster_rubygems -r../lib/backtracer_ping.rb crash.rb
+
+     RuntimeError
 crash.rb:2:in `go2'
-	raise
-crash.rb:6:in `go'
-	go2(a, 55);
-crash.rb:9
-	go '3'
-====
+        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
 
 
-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"}
+running ruby -rfaster_rubygems -r../lib/backtracer_simple.rb crash.rb
+====
+crash.rb:2:in `go2'
+crash.rb:7:in `go'
+crash.rb:10
+====
+crash.rb:2:in `go2': unhandled exception
+        from crash.rb:7:in `go'
+        from crash.rb:10

data/examples/example_test_large_output

@@ -1,42 +1,45 @@
-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"}
+running
+ruby -v -r../lib/backtracer_locals.rb crash.rb
+ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32]
+#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:10::-: go '3'
+ |#0:crash.rb:5:Object:>: def go(a)
+args were [["a", "3"]]
+ |#0:crash.rb:6:Object:-:  b = 3
+ |#0:crash.rb:7: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:6:Object:<:  b = 3
+
+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", "b"=>3}

data/examples/pinger_example

@@ -0,0 +1,30 @@
+
+C:\dev\ruby\old\backtracer\examples>backtracer --pinger sleeper.rb
+c:/ruby18/lib/ruby/gems/1.8/gems/backtracer-0.4.1/lib/backtracer.rb:3: warning: already initialized constant WINDOZE
+All threads:[#<Thread:0x3411420 run>, #<Thread:0x28b5580 run>]
+Current thread:#<Thread:0x28b5580>
+C:/dev/ruby/old/backtracer/examples/sleeper.rb:2:in `call'
+C:/dev/ruby/old/backtracer/examples/sleeper.rb:2:in `sleep'
+C:/dev/ruby/old/backtracer/examples/sleeper.rb:2:in `go'
+C:/dev/ruby/old/backtracer/examples/sleeper.rb:4
+c:/ruby18/lib/ruby/gems/1.8/gems/backtracer-0.4.1/bin/backtracer:29:in `load'
+c:/ruby18/lib/ruby/gems/1.8/gems/backtracer-0.4.1/bin/backtracer:29
+c:/ruby18/bin/backtracer:19:in `load'
+c:/ruby18/bin/backtracer:19
+"current stack trace"
+Wed Nov 11 10:57:52 -0700 2009
+1
+All threads:[#<Thread:0x3411420 run>, #<Thread:0x28b5580 run>]
+Current thread:#<Thread:0x28b5580>
+C:/dev/ruby/old/backtracer/examples/sleeper.rb:2:in `call'
+C:/dev/ruby/old/backtracer/examples/sleeper.rb:2:in `sleep'
+C:/dev/ruby/old/backtracer/examples/sleeper.rb:2:in `go'
+C:/dev/ruby/old/backtracer/examples/sleeper.rb:4
+c:/ruby18/lib/ruby/gems/1.8/gems/backtracer-0.4.1/bin/backtracer:29:in `load'
+c:/ruby18/lib/ruby/gems/1.8/gems/backtracer-0.4.1/bin/backtracer:29
+c:/ruby18/bin/backtracer:19:in `load'
+c:/ruby18/bin/backtracer:19
+"current stack trace"
+Wed Nov 11 10:57:57 -0700 2009
+1
+C:\>

data/examples/run_all_styles_of_backtracer.rb

@@ -1,10 +1,11 @@
-for file in Dir.glob("../lib/backtrace_*") do
+require 'faster_rubygems'
+for file in Dir.glob("../lib/backtracer_*") do
+ next if file =~ /_tracer/
  commands = []
  for crash_file in ['crash.rb'] do
-  commands << "ruby -r#{file} #{crash_file}"
+  commands << "ruby -rfaster_rubygems -r#{file} #{crash_file}"
  end
- #commands << "ruby -v -r../backtrace_with_code_and_locals.rb ../crash.rb"
- for command in commands
+  for command in commands
   puts "\n\n\nrunning #{command}\n"
   system(command)
  end

data/examples/run_large_style_output.rb

@@ -1 +1,3 @@
-system "ruby -v -r../lib/backtrace_with_code_and_locals.rb crash.rb"
+command = "ruby -v -r../lib/backtracer_locals.rb crash.rb"
+puts 'running', command
+system command

data/examples/sleeper.rb

@@ -0,0 +1,4 @@
+def go
+ sleep 10
+end
+go

data/lib/backtracer.rb

@@ -1,30 +1,35 @@
 # this one display full BT with code, at the end [no performance loss]
+require 'rbconfig'
+WINDOZE = Config::CONFIG['host_os'] =~ /mswin|mingw/
 
 require File.dirname(__FILE__) + "/shared"
-require 'sane'
 
 at_exit {
-  if $! && !$!.is_a?(SystemExit) # SystemExit's are just normal, not exceptional
+  if $! && !$!.is_a?(SystemExit) # SystemExit's are normal, not exceptional
     puts "\n     " + $!.inspect + ' ' + $!.to_s
     bt2 = $!.backtrace
     backtrace_with_code = $!.backtrace.map{ |bt_line|
-      if OS.windows? && bt_line[1..1] == ':'
-        #["C", "/dev/ruby/allgems/lib/allgems/GemWorker.rb", "91", "in `unpack'"]      
+      next if bt_line.include? 'bin/backtracer' # binary lines...
+      if WINDOZE && bt_line[1..1] == ':'
+        
         drive, file, line, junk = bt_line.split(":")
+	#["C", "/dev/ruby/allgems/lib/allgems/GemWorker.rb", "91", "in `unpack'"]              
         file = drive + ":" + file
       else
         file, line, junk = bt_line.split(":")
       end
       line = line.to_i
-#      line -= 1 unless line == 0 # not sure if needed
       actual_line = Tracer.get_line(file, line)
+
       "#{bt_line}\n\t#{actual_line.strip if actual_line}"
-    }
+    }.compact
     puts backtrace_with_code
-#    puts "===="
+    puts
+    puts 'original backtrace:'
   else
-    puts "(no exception found to backtrace)" if $VERBOSE
+    puts "(backtracer: no exception found to backtrace)" if $VERBOSE
   end
   # exit! TODO I guess do this once ours isn't *so* ugly
+  # I'm not sure it's safe to do that, in case there are other at_exit's [?]
   # TODO compare with that fella xray
 }

data/lib/{backtracer_ping.rb → backtracer_pinger.rb}

@@ -1,5 +1,9 @@
 require 'pp'
-require 'sane/os'
+
+
+require 'rbconfig'
+WINDOZE = Config::CONFIG['host_os'] =~ /mswin|mingw/
+
 
 def xray
  require 'xray'
@@ -24,8 +28,7 @@ elsif respond_to? :caller_for_all_threads
   end
 else
  # weak sauce for the old school users :)
- if OS.windows?
-
+ if WINDOZE
    trap("ILL") { puts "All threads:" + Thread.list.inspect, "Current thread:" + Thread.current.to_s, caller } # puts current thread caller
    fella = proc {  Process.kill "ILL", Process.pid } # send myself a signal
  else

data/lib/core_backtracer.rb

@@ -7,8 +7,8 @@
 require 'rubygems'
 require 'ruby-debug'
 Debugger.start # we use this to track args.
+$print_trace = nil unless defined?($print_trace) # avoid warnings
 
-#Debugger.keep_frame_binding = true # whatever this did :P
 #
 # tracer main class
 #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backtracer
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors: []
 
@@ -9,19 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-10 00:00:00 -07:00
+date: 2009-11-11 00:00:00 -07:00
 default_executable: backtracer
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: sane
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.9.1
-    version: 
 - !ruby/object:Gem::Dependency 
   name: xray
   type: :runtime
@@ -49,12 +39,13 @@ files:
 - examples/crash_longer.rb
 - examples/example_test_all_output
 - examples/example_test_large_output
+- examples/pinger_example
 - examples/run_all_styles_of_backtracer.rb
 - examples/run_large_style_output.rb
 - lib/backtracer.rb
 - lib/backtracer_ctrl_c_debugger.rb
 - lib/backtracer_locals.rb
-- lib/backtracer_ping.rb
+- lib/backtracer_pinger.rb
 - lib/backtracer_simple.rb
 - lib/backtracer_tracer.rb
 - lib/backtracer_tracer_args.rb
@@ -94,3 +85,4 @@ test_files:
 - examples/crash_longer.rb
 - examples/run_all_styles_of_backtracer.rb
 - examples/run_large_style_output.rb
+- examples/sleeper.rb