my_stuff-logger 0.0.1 → 0.0.2

data/README.rdoc

@@ -0,0 +1,64 @@
+= What is this?
+
+A drop-in replacement for Ruby's standard Logger class, if you're just
+using the basic features.
+
+= How do I get it?
+
+ gem install my_stuff-logger
+
+= How do I use it?
+
+Create an instance, then just like the standard Logger class; take a look
+at example.rb.
+
+= Why would I use it instead?
+
+http://f.cl.ly/items/1M0f083q0Q3p3u103a3o/Image%202011.08.30%2008:06:08.png
+
+== It's got more information.
+
+* The filename, line number, and method are *always* included
+* By default, a backtrace is included for errors and fatals. This can be
+  tuned to any level, including even for debug, or for none at all.
+
+File names are shown relative to a choosable root (which defaults to
+File.dirname(File.expand_path($0))) — if a file isn't in that root, you
+get the full path, not '../../../../../../foo/bar/baz' :p
+
+== It's easier to see what's important.
+
+http://f.cl.ly/items/1I0p3c3J2i1u0D1E3Q3s/Image%202011.08.30%2020:05:20.png
+
+== You can choose what's relevant.
+
+There's per-app settings for where output goes, what levels are logged,
+and what levels get backtraces — but you can also change this per-instance,
+and it'll stick that way even if the global is changed later.
+
+== You can plug in your own filters to make the log messages more readable.
+
+A couple of examples:
+
+* The priority colorization is a filter
+* There's also a filter shipped (but not enabled by default) for use with
+  {MyStuff::MultiDB}[https://github.com/fredemmott/my_stuff-multidb], which
+  turns 'Foo::MYSTUFF_MULTIDB_DB_aloadofhex::Bar' into
+  'Foo::<localhost:3307/test>::Bar'
+
+These filters are only enabled for log viewing; they don't affect what's
+written to disk.
+
+By default, colors are enabled if the output device (STDOUT usually) is
+a TTY, but disabled otherwised — of course, this can be overidden.
+
+== It's easier/faster to machine-process.
+
+* The number in the second field is a unix timestamp
+* The filename is always in the same place, in the same format, making it
+  easier to use with grep, or something more in-depth.
+
+= What's coming soon?
+
+* a 'msl-cat' command, applying the filters
+* a 'msl-tail' command, emulating/wrapping 'tail -F'

data/example.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+_DIR = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.push(File.join(_DIR, 'lib'))
+
+require 'optparse'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.on(
+    '--level=debug|info|warn|error|fatal|disable',
+    'What level of output to show',
+    /^debug|info|warn|error|fatal|disable$/
+  ) do |level|
+    options[:level] = level.to_sym
+  end
+
+  opts.on(
+    '--backtrace-level=debug|info|warn|error|fatal|disable',
+    'What level of output to show backtraces for',
+    /^debug|info|warn|error|fatal|disable$/
+  ) do |level|
+    options[:backtrace_level] = level.to_sym
+  end
+
+  opts.on(
+    '--colors=yes|no|auto',
+    'Colorize output',
+    /^yes|no|auto$/
+  ) do |value|
+    case value
+    when 'yes'
+      options[:colorize] = true
+    when 'no'
+      options[:colorize] = false
+    end
+  end
+end
+optparse.parse!
+
+require 'my_stuff/logger'
+require 'my_stuff/logger/reader'
+
+require 'logger' # Ruby's standard one
+
+# We set the output device of the logger to be the reader.
+# This gives us rainbows and unicorns — well, colourized output at least.
+reader = MyStuff::Logger::Reader.new(options)
+options[:device] = reader
+logger = MyStuff::Logger.new(options)
+
+def compare logger
+  puts '=== Comparison ==='
+  Logger.new(STDOUT).error "This is Ruby's standard Logger"
+  logger.error "This is MyStuff::Logger"
+end
+
+def spam logger
+  puts '=== Spamming All Log Levels ==='
+  logger.debug 'nyan nyan nyan'
+  logger.info ({:what => 'cool story bro'})
+  logger.warn "IMA CHARGIN' MAH LAZER"
+  logger.error "Somebody set us up the bomb"
+  logger.fatal "No more kitten pictures."
+end
+
+compare logger
+spam logger

data/lib/my_stuff/logger.rb

@@ -1,5 +1,6 @@
 # Copyright 2011-present Fred Emmott. See COPYING file.
 
+require 'my_stuff/logger/reader'
 require 'my_stuff/logger/writer'
 
 module MyStuff
@@ -12,7 +13,7 @@ module MyStuff
       attr_writer :device, :level, :backtrace_level, :root_path
 
       def device
-        @device ||= STDOUT
+        @device ||= STDOUT.tty? ? MyStuff::Logger::Reader.new : STDOUT
       end
 
       def level

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_stuff-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-30 00:00:00.000000000Z
+date: 2011-08-31 00:00:00.000000000Z
 dependencies: []
 description: ''
 email:
@@ -19,6 +19,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - COPYING
+- README.rdoc
+- example.rb
 - lib/my_stuff/logger/levels.rb
 - lib/my_stuff/logger/reader.rb
 - lib/my_stuff/logger/reader_filter.rb