autolog 0.0.1 → 0.1.0

data/README.md

@@ -22,9 +22,11 @@ To trace Ruby, you can just define `set_trace_func`, e.g.
         line prog.rb:4        test     Test
       return prog.rb:4        test     Test
 
-But, why not use fewer keystrokes to output debug information?
+But, why not use fewer keystrokes to output debug information? And what about just logging certain sets of events? How about:
 
-    Autolog.trace
+    Autolog.events :raise, :c_call
+
+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.
 
 ### Installation
 
@@ -38,7 +40,27 @@ Then:
 
 ### Usage
 
-Anywhere in your code after the gem is loaded, do one of these:
+In the main object/IRB, or in any object, call autolog with parameters, e.g.:
+
+    autolog :methods
+    autolog :c_calls
+    autolog :c_returns
+    autolog :c_calls_and_returns
+    autolog :class_starts
+    autolog :class_ends
+    autolog :classes
+    autolog :method_calls
+    autolog :method_returns
+    autolog :methods
+    autolog :lines
+    autolog :raises
+    autolog :trace
+    autolog :event :c_return
+    autolog :events 'raise', 'c-call'
+    autolog :events :raise, :c_call
+    autolog :off
+
+Or call it on Autolog if that is easier:
 
     Autolog.c_calls
     Autolog.c_returns
@@ -57,10 +79,47 @@ Anywhere in your code after the gem is loaded, do one of these:
     Autolog.events :raise, :c_call
     Autolog.off
 
-What they do:
+### Blocks
+
+    autolog do
+      puts "this is something"
+      puts "this is something 2"
+    end
+
+or
+
+    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
+      # ...
+    end
+
+### What you can trace
 
 * `Autolog.c_calls` - logs 'c-call'
-* `Autolog.c_returns` - logs'c-return'
+* `Autolog.c_returns` - logs 'c-return'
 * `Autolog.c_calls_and_returns` - logs 'c-call' and 'c-return'
 * `Autolog.class_starts` - logs 'class'
 * `Autolog.class_ends` - logs 'end'
@@ -94,5 +153,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
 [set_trace_func]: http://apidock.com/ruby/Kernel/set_trace_func
 [lic]: http://github.com/garysweaver/autolog/blob/master/LICENSE

data/lib/autolog.rb

@@ -1,4 +1,5 @@
 require 'autolog/version'
+require 'autolog/methods'
 
 module Autolog
   class << self
@@ -9,6 +10,7 @@ module Autolog
     def events(*args)
       args.flatten!
       args.collect!{|e|e.to_s.gsub('_','-')}
+      puts "events method received #{args.inspect}"
 
       # What's up with the Exception hiding?
       # Ruby bug 7180: can use up 100% cpu in 1.9.3p194 if let anything be raised. We'll silently rescue and ignore issues. Otherwise, it produces a deluge of output.
@@ -19,72 +21,135 @@ module Autolog
       else
         set_trace_func proc {|event, file, line, id, binding, classname| begin; Autolog.procedure.call(event, file, line, id, binding, classname); rescue SystemExit, Interrupt; raise; rescue Exception; end}
       end
+
+      if block_given?
+        yield
+        off
+      end
     end
     alias_method :event, :events
 
-    def trace
-      events
+    def trace(*args)
+      if block_given?
+        events args, &Proc.new
+      else
+        events args
+      end
     end
 
     # log c-call events only
-    def c_calls
-      events 'c-call'
+    def c_calls(*args)
+      if block_given?
+        events ['c-call', args].flatten, &Proc.new
+      else
+        events ['c-call', args].flatten
+      end
     end
 
     # log c-return events only
-    def c_returns
-      events 'c-return'
+    def c_returns(*args)
+      if block_given?
+        events ['c-return', args].flatten, &Proc.new
+      else
+        events ['c-return', args].flatten
+      end
     end
 
     # log c-call and c-return events only
-    def c_calls_and_returns
-      events 'c-call', 'c-return'
+    def c_calls_and_returns(*args)
+      if block_given?
+        events ['c-call', 'c-return', args].flatten, &Proc.new
+      else
+        events ['c-call', 'c-return', args].flatten
+      end
     end
 
     # log class events only
-    def class_starts
-      events 'class'
+    def class_starts(*args)
+      if block_given?
+        events ['class', args].flatten, &Proc.new
+      else
+        events ['class', args].flatten
+      end
     end
 
     # log end events only
-    def class_ends
-      events 'end'
+    def class_ends(*args)
+      if block_given?
+        events ['end', args].flatten, &Proc.new
+      else
+        events ['end', args].flatten
+      end
     end
 
     # log class and end events only
-    def classes
-      events 'class', 'end'
+    def classes(*args)
+      if block_given?
+        events ['class', 'end', args].flatten, &Proc.new
+      else
+        events ['class', 'end', args].flatten
+      end
     end
 
     # log call events only
-    def method_calls
-      events 'call'
+    def method_calls(*args)
+      if block_given?
+        events ['call', args].flatten, &Proc.new
+      else
+        events ['call', args].flatten
+      end
     end
 
     # log return events only
-    def method_returns
-      events 'return'
+    def method_returns(*args)
+      if block_given?
+        events ['return', args].flatten, &Proc.new
+      else
+        events ['return', args].flatten
+      end
     end
 
     # log call and return events only
-    def methods
-      events 'call', 'return'
+    def methods(*args)
+      if block_given?
+        events ['call', 'return'], &Proc.new
+      else
+        events ['call', 'return', args].flatten
+      end
     end
 
     # log raise events only
-    def raises
-      events 'raise'
+    def raises(*args)
+      if block_given?
+        events ['raise', args].flatten, &Proc.new
+      else
+        events ['raise', args].flatten
+      end
     end
 
     # log line events only
-    def lines
-      events 'line'
+    def lines(*args)
+      if block_given?
+        events ['line', args].flatten, &Proc.new
+      else
+        events ['line', args].flatten
+      end
     end
 
-    def off
+    # turn logging off
+    def off(*args)
+      # accepts *args to make implementation of autolog in methods easier, but ignores them
       set_trace_func nil
     end
   end
 end
 
-Autolog.procedure = lambda {|event, file, line, id, binding, classname| puts "#{event} #{file}.#{line} #{binding} #{classname} #{id}"}
+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
+end
+
+# make autolog a method in main
+TOPLEVEL_BINDING.eval('include Autolog::Methods')

data/lib/autolog/methods.rb

@@ -0,0 +1,25 @@
+module Autolog
+  module Methods
+    def autolog(*args)
+      args.flatten!
+      puts "autolog method got #{args.inspect}"
+      if args.size > 0
+        if Autolog.respond_to?(args[0])
+          if block_given?
+            Autolog.send(args.delete_at(0), args, &Proc.new)
+          else
+            Autolog.send(args.delete_at(0), args)
+          end
+        elsif block_given?
+          Autolog.events args, &Proc.new
+        else
+          Autolog.events args
+        end
+      elsif block_given?
+        Autolog.events &Proc.new
+      else
+        Autolog.events
+      end
+    end
+  end
+end

data/lib/autolog/version.rb

@@ -1,3 +1,3 @@
 module Autolog
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autolog
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -19,6 +19,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/autolog/methods.rb
 - lib/autolog/version.rb
 - lib/autolog.rb
 - Rakefile