autolog 0.0.1

data/README.md

@@ -0,0 +1,98 @@
+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?
+
+    Autolog.trace
+
+### Installation
+
+In your Gemfile, add:
+
+    gem 'autolog'
+
+Then:
+
+    bundle install
+
+### Usage
+
+Anywhere in your code after the gem is loaded, do one of these:
+
+    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
+
+What they do:
+
+* `Autolog.c_calls` - logs 'c-call'
+* `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'
+* `Autolog.classes` - logs 'class' and 'end'
+* `Autolog.method_calls` - logs 'call'
+* `Autolog.method_returns` - logs 'return'
+* `Autolog.methods` - logs 'call' and 'return'
+* `Autolog.lines` - logs 'line' (logs every Ruby line executed in this context, similar to a hook into Ruby's caller stack that logs/prints/puts all lines)
+* `Autolog.raises` - logs 'raise'
+* `Autolog.events` or `Autolog.event` - logs one or more provided events, converting each to string and substituting '_' with '-', of the supported events in [set_trace_func][set_trace_func]. Calling with no arguments or empty array will log all events.
+* `Autolog.trace` - logs all events
+* `Autolog.off` - turns off tracing (calls `set_trace_func nil`)
+
+### Changing the format, Using another logger, collecting stats, etc.
+
+Keep the ease of Autolog and its minimal controls while doing nuts things with it:
+
+    Autolog.proc = lambda {|event, file, line, id, binding, classname| puts "#{event} #{file}.#{line} #{binding} #{classname} #{id}"}
+
+### Warning
+
+Enabling some of these like lines or trace will significantly slow down execution and may generate a lot of output.
+
+### Contributing
+
+It's as easy as [forking][fork], making your changes, and [submitting a pull request][pull].
+
+### License
+
+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
+[set_trace_func]: http://apidock.com/ruby/Kernel/set_trace_func
+[lic]: http://github.com/garysweaver/autolog/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+#http://nicksda.apotomo.de/2010/10/testing-your-rails-3-engine-sitting-in-a-gem/
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/autolog.rb

@@ -0,0 +1,90 @@
+require 'autolog/version'
+
+module Autolog
+  class << self
+    # called procedure instead of proc because set_trace_func proc was calling the proc attribute. Fun!
+    attr_accessor :procedure
+
+    # log all specified events
+    def events(*args)
+      args.flatten!
+      args.collect!{|e|e.to_s.gsub('_','-')}
+
+      # 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.
+      if args.size == 1
+        eval "set_trace_func proc {|event, file, line, id, binding, classname| begin; Autolog.procedure.call(event, file, line, id, binding, classname) if event == #{args[0].inspect}; rescue SystemExit, Interrupt; raise; rescue Exception; end}"
+      elsif args.size > 1
+        eval "set_trace_func proc {|event, file, line, id, binding, classname| begin; Autolog.procedure.call(event, file, line, id, binding, classname) if #{args.inspect}.include?(event); rescue SystemExit, Interrupt; raise; rescue Exception; end}"
+      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
+    end
+    alias_method :event, :events
+
+    def trace
+      events
+    end
+
+    # log c-call events only
+    def c_calls
+      events 'c-call'
+    end
+
+    # log c-return events only
+    def c_returns
+      events 'c-return'
+    end
+
+    # log c-call and c-return events only
+    def c_calls_and_returns
+      events 'c-call', 'c-return'
+    end
+
+    # log class events only
+    def class_starts
+      events 'class'
+    end
+
+    # log end events only
+    def class_ends
+      events 'end'
+    end
+
+    # log class and end events only
+    def classes
+      events 'class', 'end'
+    end
+
+    # log call events only
+    def method_calls
+      events 'call'
+    end
+
+    # log return events only
+    def method_returns
+      events 'return'
+    end
+
+    # log call and return events only
+    def methods
+      events 'call', 'return'
+    end
+
+    # log raise events only
+    def raises
+      events 'raise'
+    end
+
+    # log line events only
+    def lines
+      events 'line'
+    end
+
+    def off
+      set_trace_func nil
+    end
+  end
+end
+
+Autolog.procedure = lambda {|event, file, line, id, binding, classname| puts "#{event} #{file}.#{line} #{binding} #{classname} #{id}"}

data/lib/autolog/version.rb

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

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: autolog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-17 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.
+email:
+- garysweaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/autolog/version.rb
+- lib/autolog.rb
+- Rakefile
+- README.md
+homepage: https://github.com/garysweaver/autolog
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Automatically logs Ruby events.
+test_files: []