autolog 0.1.2 → 0.2.0

data/README.md

@@ -3,30 +3,15 @@ Autolog
 
 Automatically log tracing events in Ruby more easily.
 
-To trace Ruby, you can just define `set_trace_func`, e.g.
-
-    set_trace_func proc { |event, file, line, id, binding, classname|
-      printf "%8s %s:%-2d %10s %8s\n", event, file, line, id, classname
-    }
-    t = Test.new
-    t.test
-
-        line prog.rb:11               false
-      c-call prog.rb:11        new    Class
-      c-call prog.rb:11 initialize   Object
-    c-return prog.rb:11 initialize   Object
-    c-return prog.rb:11        new    Class
-        line prog.rb:12               false
-        call prog.rb:2        test     Test
-        line prog.rb:3        test     Test
-        line prog.rb:4        test     Test
-      return prog.rb:4        test     Test
-
-But, why not use fewer keystrokes to output debug information? And what about just logging certain sets of events? How about:
+To trace Ruby, you can just define `set_trace_func`. But, why not use fewer keystrokes to output debug information? And what about just logging certain sets of events? How about:
 
-    Autolog.events :raise, :c_call
+    autolog
+
+### See also
 
-Also, check out the Ruby stdlib's [Tracer][tracer], which does similar if you are just looking for a simple trace or need the other options or added speed that it may provide. Autolog is really just meant to be a shortcut for Kernel's set_trace_func, which is a lot more flexible in some ways, since it lets you hook into/log other types of events specifically.
+* [set_trace_func][set_trace_func]
+* [Tracer][tracer] (part of Ruby stdlib)
+* [Tracepoint][tracepoint]
 
 ### Installation
 
@@ -86,36 +71,50 @@ Or call it on Autolog if that is easier:
 
 ### Blocks
 
+Blocks are nice, because they do an `ensure` to make sure that `autolog :off` happens.
+
+For example, this will still stop tracing in the end of the block:
+
     autolog do
-      puts "this is something"
-      puts "this is something 2"
+      raise Exception.new
     end
 
-or
+But, this won't:
+
+    autolog
+    raise Exception.new
+    autolog :off
+
+Although this would:
+
+    begin
+      autolog
+      raise Exception.new
+    ensure
+      autolog :off
+    end
+      
+More examples:
 
     autolog :methods do
       # ...
     end
 
-or
 
     autolog :lines do
       # ...
     end
 
-or
 
     autolog :events, :line, :c_call do
       # ...
     end
 
-or
 
     Autolog.methods do
       # ...
     end
 
-or
 
     Autolog.events :line, :c_call do
       # ...
@@ -159,5 +158,6 @@ Copyright (c) 2012 Gary S. Weaver, released under the [MIT license][lic].
 [fork]: https://help.github.com/articles/fork-a-repo
 [pull]: https://help.github.com/articles/using-pull-requests
 [tracer]: http://www.ruby-doc.org/stdlib-1.9.3/libdoc/tracer/rdoc/index.html
+[tracepoint]: https://github.com/rubyworks/tracepoint
 [set_trace_func]: http://apidock.com/ruby/Kernel/set_trace_func
 [lic]: http://github.com/garysweaver/autolog/blob/master/LICENSE

data/lib/autolog.rb

@@ -5,6 +5,7 @@ module Autolog
   class << self
     # called procedure instead of proc because set_trace_func proc was calling the proc attribute. Fun!
     attr_accessor :procedure
+    attr_accessor :flush
 
     # log all specified events
     def events(*args)
@@ -23,8 +24,11 @@ module Autolog
       end
 
       if block_given?
-        yield
-        off
+        begin
+          yield
+        ensure
+          off
+        end
       end
     end
     alias_method :event, :events
@@ -147,8 +151,10 @@ end
 Autolog.procedure = lambda {|event, file, line, id, binding, classname| begin; puts "#{event} #{file}.#{line} #{binding} #{classname} #{id}"; rescue SystemExit, Interrupt; raise; rescue Exception; end}
 
 class Object
-  # make autolog a method in any object
-  extend Autolog::Methods
+  # make autolog a method on every object except main (?)
+  class << self
+    extend Autolog::Methods
+  end
 end
 
 # make autolog a method in main

data/lib/autolog/version.rb

@@ -1,3 +1,3 @@
 module Autolog
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autolog
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies: []
 description: Automatically log events like executed lines, methods, class and module
   definitions, C-language routines, and/or raises in Ruby.