backtracer 0.0.2 → 0.1.0

data/README

@@ -1,16 +1,14 @@
-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.
+ruby_backtracer: a library to output higher quality backtraces if an unhandled exception is raised
 
-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:
+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
 
-Using backtracer, it now outputs:
-examples>ruby -rbacktracer_locals crash.rb
+now outputs:
+examples>ruby -r../backtrace_with_code_and_locals crash.rb
 
 unhandled exception: crash.rb:2:   raise
         locals: {"a"=>"3", "b"=>55}
@@ -19,92 +17,23 @@ 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?
 
-== Other ==
+There are several other tracing options provided, if you don't want as much output, or want more speed.  Specify which by script name.
 
-Note that you can [if desired] load these within a script iself
-require 'backtracer'
+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).
 
-and it will output a backtrace if one exists at exit time.
+Try them out by running test_all.rb in the examples folder, or eyeball the example output files in examples/example_output*
 
-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
+http://github.com/rogerdpack/ruby_backtracer/tree/master
 
-if desired.
+Note: some options depends on ruby-debug [MRI] gem, some don't.
 
-== Related projects ==
-unroller, http://eigenclass.org/hiki/method+arguments+via+introspection, liveconsole, ruby-debug
+To install clone from github, above, then ruby -rscriptname your_script.
 
-Comments welcome to rdp on github.
+related projects: unroller, http://eigenclass.org/hiki/method+arguments+via+introspection, liveconsole, ruby-debug
 
-http://github.com/rdp/backtracer
+send comments to rogerdpack on github.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/examples/crash.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backtracer
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: []
 
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-31 00:00:00 -06:00
+date: 2009-10-29 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -32,9 +32,8 @@ files:
 - examples/run_all_styles_of_backtracer.rb
 - examples/run_large_style_output.rb
 - lib/backtracer.rb
-- lib/backtracer_locals.rb
+- lib/backtracer_all.rb
 - lib/backtracer_simple.rb
-- lib/backtracer_tracer.rb
 - lib/core_backtracer.rb
 has_rdoc: true
 homepage: 

data/lib/backtracer_tracer.rb

@@ -1,3 +0,0 @@
-# this is the default
-$VERBOSE = true # now it will output everything :)
-require File.dirname(__FILE__) + '/core_backtracer.rb'