logue 1.0.0

data/README.md

@@ -0,0 +1,31 @@
+logue
+=====
+
+A Ruby gem for generating logging and debugging output. Logging statements
+include the file, line, class and method from which the logging method was
+called.
+
+## EXAMPLES
+
+```
+require 'logue/log'
+require 'logue/loggable'
+
+Logue::Log.level = Logue::Log::DEBUG
+
+class MyClass
+  include Logue::Loggable
+
+  def mymethod foo
+    info "foo: #{foo}"
+  end
+end
+
+MyClass.new.mymethod "bar"
+```
+
+Produces:
+
+```
+[/tmp/foo.rb              :  13] {MyClass#mymethod    } foo: bar
+```

data/lib/logue/format.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+module Logue
+  class Format
+    
+    def trim_left str, maxlen
+      str[0 ... maxlen.to_i.abs]
+    end
+
+    def trim_right str, maxlen
+      mxln = maxlen.abs
+
+      # magic number 3 for the ellipses ...
+
+      if str.length > mxln
+        path = str.split('/')
+        newstr = "..."
+        path.reverse.each do |element|
+          if newstr.length + element.length > mxln
+            while newstr.length < mxln
+              newstr.insert 0, " "
+            end
+            return newstr
+          else
+            if newstr.length > 3
+              newstr.insert 3, "/"
+            end
+            newstr.insert 3, element
+          end
+        end
+        newstr
+      else
+        str
+      end
+    end
+
+    def print_formatted file, line, func, msg, lvl, &blk
+      if trim
+        file = trim_right file, @file_width
+        line = trim_left  line, @line_width
+        func = trim_left  func, @function_width
+      end
+
+      hdr = sprintf @format, file, line, func
+      print hdr, msg, lvl, &blk
+    end
+  end
+end

data/lib/logue/log.rb

@@ -0,0 +1,244 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+#
+# = log.rb
+#
+# Logging Module
+#
+# Author:: Jeff Pace <jpace@incava.org>
+# Documentation:: Author
+#
+
+require 'logue/logger'
+require 'logue/severity'
+require 'rubygems'
+require 'rainbow'
+
+#
+# == Log
+#
+# Very minimal logging output. If verbose is set, this displays the method and
+# line number whence called. It can be a mixin to a class, which displays the
+# class and method from where it called. If not in a class, it displays only the
+# method.
+# 
+# Remember: all kids love log.
+#
+# == Examples
+#
+# See the unit tests in log_test.rb
+#
+# == Usage
+#
+# The most general usage is simply to call:
+#
+#  Log.log "some message"
+#
+#  That will simply log the given message.
+#
+#  class YourClass
+#    include Loggable
+#
+#    def some_method(...)
+#      log "my message"
+# 
+#  That will log from the given class and method, showing the line number from
+#  which the logger was called.
+#
+#    def another_method(...)
+#      stack "my message"
+# 
+#  That will produce a stack trace from the given location.
+# 
+
+module Logue
+  class Log
+    $LOGGING_LEVEL = nil
+
+    DEFAULT_FILENAME_WIDTH = -25
+    DEFAULT_LINENUM_WIDTH = 4
+    DEFAULT_FUNCTION_WIDTH = -20
+    
+    include Log::Severity
+
+    # by default, class methods delegate to a single app-wide log.
+
+    @@log = Logger.new
+
+    # Returns the logger of the log. A class method delegating to an instance
+    # method ... not so good. But temporary.
+    def self.logger
+      @@log
+    end
+
+    def self.method_missing meth, *args, &blk
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      # only handling foregrounds, not backgrounds
+      if code = validcolors[meth]
+        add_color_method meth.to_s, code + 30
+        send meth, *args, &blk
+      else
+        super
+      end
+    end
+
+    def self.respond_to? meth
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      validcolors.include?(meth) || super
+    end
+
+    def self.add_color_method color, code
+      instmeth = Array.new
+      instmeth << "def #{color} msg = \"\", lvl = Log::DEBUG, depth = 1, cname = nil, &blk"
+      instmeth << "  log(\"\\e[#{code}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
+      instmeth << "end"
+      instance_eval instmeth.join("\n")
+
+      clsmeth = Array.new
+      clsmeth << "def #{color} msg = \"\", lvl = Log::DEBUG, depth = 1, cname = nil, &blk"
+      clsmeth << "  logger.#{color}(\"\\e[#{code}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
+      clsmeth << "end"
+
+      class_eval clsmeth.join("\n")
+    end
+
+    def self.set_default_widths
+      logger.set_default_widths
+    end
+
+    def self.verbose
+      logger.verbose
+    end
+
+    def self.verbose= v
+      logger.verbose = v && v != 0 ? DEBUG : FATAL
+    end
+
+    def self.level= lvl
+      logger.level = lvl
+    end
+
+    def self.quiet
+      logger.quiet
+    end
+
+    def self.quiet= q
+      logger.quiet = q
+    end
+
+    def self.format
+      logger.format
+    end
+
+    def self.format= fmt
+      logger.format = fmt
+    end
+
+    # Assigns output to the given stream.
+    def self.output= io
+      logger.output = io
+    end
+
+    def self.output
+      logger.output
+    end
+
+    # sets whether to colorize the entire line, or just the message.
+    def self.colorize_line= col
+      logger.colorize_line = col
+    end
+
+    def self.colorize_line
+      logger.colorize_line
+    end
+
+    # Assigns output to a file with the given name. Returns the file; client
+    # is responsible for closing it.
+    def self.outfile= fname
+      logger.outfile = fname
+    end
+
+    def self.outfile
+      logger.outfile
+    end
+
+    # Creates a printf format for the given widths, for aligning output.
+    def self.set_widths file_width, line_width, func_width
+      logger.set_widths file_width, line_width, func_width
+    end
+
+    def self.ignore_file fname
+      logger.ignore_file fname
+    end
+    
+    def self.ignore_method methname
+      logger.ignored_method methname
+    end
+    
+    def self.ignore_class classname
+      logger.ignored_class classname
+    end
+
+    def self.log_file fname
+      logger.log_file fname
+    end
+    
+    def self.log_method methname
+      logger.log_method methname
+    end
+    
+    def self.log_class classname
+      logger.log_class classname
+    end
+
+    def self.debug msg = "", depth = 1, &blk
+      logger.log msg, DEBUG, depth + 1, &blk
+    end
+
+    def self.info msg = "", depth = 1, &blk
+      logger.log msg, INFO, depth + 1, &blk
+    end
+
+    def self.fatal msg = "", depth = 1, &blk
+      logger.log msg, FATAL, depth + 1, &blk
+    end
+
+    def self.log msg = "", lvl = DEBUG, depth = 1, cname = nil, &blk
+      logger.log msg, lvl, depth + 1, cname, &blk
+    end
+
+    def self.stack msg = "", lvl = DEBUG, depth = 1, cname = nil, &blk
+      logger.stack msg, lvl, depth + 1, cname, &blk
+    end
+
+    def self.warn msg = "", depth = 1, &blk
+      if verbose
+        logger.log msg, WARN, depth + 1, &blk
+      else
+        $stderr.puts "WARNING: " + msg
+      end
+    end
+
+    def self.error msg = "", depth = 1, &blk
+      if verbose
+        logger.log msg, ERROR, depth + 1, &blk
+      else
+        $stderr.puts "ERROR: " + msg
+      end
+    end
+
+    def self.write msg, depth = 1, cname = nil, &blk
+      if verbose
+        stack msg, Log::WARN, depth + 1, cname, &blk
+      elsif quiet
+        # nothing
+      else
+        $stderr.puts msg
+      end
+    end
+
+    def self.set_color lvl, color
+      logger.set_color lvl, color
+    end
+  end
+end

data/lib/logue/loggable.rb

@@ -0,0 +1,101 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+#
+# = log.rb
+#
+# Logging Module
+#
+# Author:: Jeff Pace <jpace@incava.org>
+# Documentation:: Author
+#
+
+require 'logue/log'
+require 'rubygems'
+require 'rainbow'
+
+#
+# == Loggable
+#
+# Including this module in a class gives access to the logger methods.
+# 
+# == Examples
+#
+# See the unit tests in log_test.rb
+#
+# == Usage
+#
+#  class YourClass
+#    include Loggable
+#
+#    def some_method(...)
+#      log "my message"
+# 
+#  That will log from the given class and method, showing the line number from
+#  which the logger was called.
+#
+#    def another_method(...)
+#      stack "my message"
+# 
+#  That will produce a stack trace from the given location.
+# 
+
+module Logue
+  module Loggable
+    # Logs the given message, including the class whence invoked.
+    def log msg = "", lvl = Log::DEBUG, depth = 1, &blk
+      Log.log msg, lvl, depth + 1, self.class.to_s, &blk
+    end
+
+    def debug msg = "", depth = 1, &blk
+      Log.log msg, Log::DEBUG, depth + 1, self.class.to_s, &blk
+    end
+
+    def info msg = "", depth = 1, &blk
+      Log.log msg, Log::INFO, depth + 1, self.class.to_s, &blk
+    end
+
+    def warn msg = "", depth = 1, &blk
+      Log.log msg, Log::WARN, depth + 1, self.class.to_s, &blk
+    end
+
+    def error msg = "", depth = 1, &blk
+      Log.log msg, Log::ERROR, depth + 1, self.class.to_s, &blk
+    end
+
+    def fatal msg = "", depth = 1, &blk
+      Log.log msg, Log::FATAL, depth + 1, self.class.to_s, &blk
+    end
+
+    def stack msg = "", lvl = Log::DEBUG, depth = 1, &blk
+      Log.stack msg, lvl, depth + 1, self.class.to_s, &blk
+    end
+
+    def write msg = "", depth = 1, &blk
+      Log.write msg, depth + 1, self.class.to_s, &blk
+    end
+
+    def method_missing meth, *args, &blk
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      # only handling foregrounds, not backgrounds
+      if code = validcolors[meth]
+        add_color_method meth.to_s, code + 30
+        send meth, *args, &blk
+      else
+        super
+      end
+    end
+
+    def respond_to? meth
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      validcolors.include?(meth) || super
+    end
+
+    def add_color_method color, code
+      meth = Array.new
+      meth << "def #{color}(msg = \"\", lvl = Log::DEBUG, depth = 1, cname = nil, &blk)"
+      meth << "  Log.#{color} msg, lvl, depth + 1, self.class.to_s, &blk"
+      meth << "end"
+      self.class.module_eval meth.join("\n")
+    end
+  end
+end

data/lib/logue/logger.rb

@@ -0,0 +1,267 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+#
+# = logger.rb
+#
+# Logging Module
+#
+# Author:: Jeff Pace <jpace@incava.org>
+# Documentation:: Author
+#
+
+require 'rubygems'
+require 'rainbow'
+require 'pathname'
+require 'logue/severity'
+require 'logue/format'
+
+#
+# == Logger
+#
+# This class logs messages. You probably don't want to use this directly; Log is
+# the class containing the necessary class methods.
+#
+# == Examples
+#
+# See the unit tests in log_test.rb
+# 
+
+module Logue
+  class Logger
+    $LOGGING_LEVEL = nil
+
+    attr_accessor :quiet
+    attr_accessor :output
+    attr_accessor :colorize_line
+    attr_accessor :level
+    attr_accessor :ignored_files
+    attr_accessor :ignored_methods
+    attr_accessor :ignored_classes
+    attr_accessor :trim
+
+    include Log::Severity
+
+    FRAME_RE = Regexp.new('(.*):(\d+)(?::in \`(.*)\')?')
+
+    def initialize
+      set_defaults
+    end
+    
+    def verbose= v
+      @level = case v
+               when TrueClass 
+                 DEBUG
+               when FalseClass 
+                 FATAL
+               when Integer
+                 v
+               end
+    end
+
+    def set_defaults
+      $LOGGING_LEVEL   = @level = FATAL
+      @ignored_files   = Hash.new
+      @ignored_methods = Hash.new
+      @ignored_classes = Hash.new
+      @width           = 0
+      @output          = $stdout
+      @colors          = Array.new
+      @colorize_line   = false
+      @quiet           = false
+      @trim            = true
+
+      set_default_widths
+    end
+
+    def set_default_widths
+      set_widths Log::DEFAULT_FILENAME_WIDTH, Log::DEFAULT_LINENUM_WIDTH, Log::DEFAULT_FUNCTION_WIDTH
+    end
+
+    def verbose
+      level <= DEBUG
+    end
+
+    # Assigns output to a file with the given name. Returns the file; client
+    # is responsible for closing it.
+    def outfile= f
+      @output = f.kind_of?(IO) ? f : File.new(f, "w")
+    end
+
+    # Creates a printf format for the given widths, for aligning output. To lead
+    # lines with zeros (e.g., "00317") the line_width argument must be a string,
+    # not an integer.
+    def set_widths file_width, line_width, func_width
+      @file_width = file_width
+      @line_width = line_width
+      @function_width = func_width
+      
+      @format = "[%#{file_width}s:%#{line_width}d] {%#{func_width}s}"
+    end
+
+    def ignore_file fname
+      ignored_files[fname] = true
+    end
+    
+    def ignore_method methname
+      ignored_methods[methname] = true
+    end
+    
+    def ignore_class classname
+      ignored_classes[classname] = true
+    end
+
+    def log_file fname
+      ignored_files.delete fname
+    end
+    
+    def log_method methname
+      ignored_methods.delete methname
+    end
+    
+    def log_class classname
+      ignored_classes.delete classname
+    end
+
+    def debug msg = "", depth = 1, &blk
+      log msg, DEBUG, depth + 1, &blk
+    end
+
+    def info msg = "", depth = 1, &blk
+      log msg, INFO, depth + 1, &blk
+    end
+
+    def warn msg = "", depth = 1, &blk
+      log msg, WARN, depth + 1, &blk
+    end
+
+    def error msg = "", depth = 1, &blk
+      log msg, ERROR, depth + 1, &blk
+    end
+
+    def fatal msg = "", depth = 1, &blk
+      log msg, FATAL, depth + 1, &blk
+    end
+
+    # Logs the given message.
+    def log msg = "", lvl = DEBUG, depth = 1, cname = nil, &blk
+      if lvl >= level
+        frame = nil
+
+        stk = caller 0
+        stk.reverse.each_with_index do |frm, idx|
+          if frm.index(%r{logue/log.*:\d+:in\b})
+            break
+          else
+            frame = frm
+          end
+        end
+
+        print_stack_frame frame, cname, msg, lvl, &blk
+      end
+    end
+
+    # Shows the current stack.
+    def stack msg = "", lvl = DEBUG, depth = 1, cname = nil, &blk
+      if lvl >= level
+        stk = caller depth
+        for frame in stk
+          print_stack_frame frame, cname, msg, lvl, &blk
+          cname = nil
+          msg = ""
+        end
+      end
+    end
+
+    def print_stack_frame frame, cname, msg, lvl, &blk
+      md = FRAME_RE.match frame
+      file, line, func = md[1], md[2], (md[3] || "")
+      # file.sub!(/.*\//, "")
+
+      # Ruby 1.9 expands the file name, but 1.8 doesn't:
+      pn = Pathname.new(file).expand_path
+      
+      file = pn.to_s
+
+      if cname
+        func = cname + "#" + func
+      end
+      
+      if ignored_files[file] || (cname && ignored_classes[cname]) || ignored_methods[func]
+        # skip this one.
+      else
+        print_formatted(file, line, func, msg, lvl, &blk)
+      end
+    end
+
+    def print_formatted file, line, func, msg, lvl, &blk
+      if trim
+        fmt = Format.new
+        file = fmt.trim_right file, @file_width
+        line = fmt.trim_left  line, @line_width
+        func = fmt.trim_left  func, @function_width
+      end
+
+      hdr = sprintf @format, file, line, func
+      print hdr, msg, lvl, &blk
+    end
+    
+    def print hdr, msg, lvl, &blk
+      if blk
+        x = blk.call
+        if x.kind_of? String
+          msg = x
+        else
+          return
+        end
+      end
+
+      msg = msg.to_s.chomp
+
+      if lvlcol = @colors[lvl]
+        if colorize_line
+          line = hdr + " " + msg
+          @output.puts line.color(lvlcol)
+        else
+          @output.puts hdr + " " + msg.color(lvlcol)
+        end
+      else
+        @output.puts hdr + " " + msg
+      end      
+    end
+
+    def set_color lvl, color
+      @colors[lvl] = color
+    end
+
+    def method_missing meth, *args, &blk
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      # only handling foregrounds, not backgrounds
+      if code = validcolors[meth]
+        add_color_method meth.to_s, code + 30
+        send meth, *args, &blk
+      else
+        super
+      end
+    end
+
+    def respond_to? meth
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      validcolors.include?(meth) || super
+    end
+
+    def add_color_method color, code
+      instmeth = Array.new
+      instmeth << "def #{color}(msg = \"\", lvl = DEBUG, depth = 1, cname = nil, &blk)"
+      instmeth << "  log(\"\\e[#{code}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
+      instmeth << "end"
+      instance_eval instmeth.join("\n")
+
+      clsmeth = Array.new
+      clsmeth << "def #{color}(msg = \"\", lvl = DEBUG, depth = 1, cname = nil, &blk)"
+      clsmeth << "  logger.#{color}(\"\\e[#{code}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
+      clsmeth << "end"
+
+      class_eval clsmeth.join("\n")
+    end
+  end
+end

data/lib/logue/severity.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+#
+# = severity.rb
+#
+# Logging Module
+#
+# Author:: Jeff Pace <jpace@incava.org>
+# Documentation:: Author
+#
+
+module Logue
+  class Log
+    module Severity
+      DEBUG = 0
+      INFO  = 1
+      WARN  = 2
+      ERROR = 3
+      FATAL = 4
+    end
+  end
+end

data/lib/logue.rb

@@ -0,0 +1,17 @@
+loguelibdir = File.dirname(__FILE__)
+
+$:.unshift(loguelibdir) unless
+  $:.include?(loguelibdir) || $:.include?(File.expand_path(loguelibdir))
+
+require 'pathname'
+
+rbre = Regexp.new('\.rb$')
+
+Pathname.glob(loguelibdir + '/logue/**/*.rb').each do |file|
+  fname = file.sub(Regexp.new('^' + loguelibdir + '/'), '').sub(rbre, '')
+  require fname
+end
+
+module Logue
+  VERSION = '1.0.0'
+end

data/test/logue/format_test.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pathname'
+require 'test/unit'
+require 'stringio'
+require 'logue/format'
+require 'logue/loggable'
+
+module Logue
+  class FormatTestCase < Test::Unit::TestCase
+    include Logue::Loggable
+
+    def run_trim_left_test expected, length, str = "something"
+      trimmed = Format.new.trim_left(str, length)
+      assert_equal expected, trimmed
+    end
+
+    def test_trim_left_short_positive_number
+      run_trim_left_test "some", 4
+    end
+
+    def test_trim_left_long
+      run_trim_left_test "something", 10
+    end
+
+    def test_trim_left_short_negative_number
+      run_trim_left_test "some", -4
+    end
+
+    def run_trim_right_test expected, length, str = "something"
+      trimmed = Format.new.trim_right(str, length)
+      assert_equal expected, trimmed
+    end
+
+    def test_trim_right_short_positive_number
+      run_trim_right_test "  ...", 5
+    end
+
+    def test_trim_right_long
+      run_trim_right_test "something", 10
+    end
+
+    def test_trim_right_short_negative_number
+      run_trim_right_test "  ...", -5
+    end
+  end
+end

data/test/logue/testlog/log_stack_test.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pathname'
+require 'test/unit'
+require 'stringio'
+require 'logue'
+
+include Logue
+
+class LogAbyss
+  include Loggable
+
+  def squeal
+    log "hello from the abyss"
+    stack "turtles all the way down"
+  end
+end
+
+class LogDepths
+  include Loggable
+
+  def speak
+    log "hello from the depths"
+    la = LogAbyss.new
+    la.squeal
+  end
+end
+
+class LogInner
+  include Loggable
+
+  def screech
+    ldi = LogDepths.new
+    log "hello from the innerds"
+    ldi.speak
+  end
+end
+
+class LogStackTestCase < Test::Unit::TestCase
+  include Loggable
+
+  def test_stack
+    Log.set_widths(-15, 4, -40)
+    
+    log = Proc.new { 
+      li = LogInner.new
+      li.screech
+    }
+
+    expected_output = [
+                       "[            ...:  35] {LogInner#screech                        } hello from the innerds",
+                       "[            ...:  24] {LogDepths#speak                         } hello from the depths",
+                       "[            ...:  15] {LogAbyss#squeal                         } hello from the abyss",
+                       "[            ...:  16] {LogAbyss#squeal                         } turtles all the way down",
+                       "[            ...:  26] {speak                                   } ",
+                       "[            ...:  36] {screech                                 } ",
+                      ]
+
+    run_test @verbose_setup, log, *expected_output
+  end
+
+  # the ctor is down here so the lines above are less likely to change.
+  def initialize test, name = nil
+    @nonverbose_setup = Proc.new {
+      Log.verbose = false
+      Log.output  = StringIO.new
+    }
+    
+    @verbose_setup = Proc.new {
+      Log.verbose = true
+      Log.output  = StringIO.new
+    }
+
+    super test
+  end
+
+  def run_test setup, log, *expected
+    io = setup.call
+
+    log.call
+
+    assert_not_nil io
+    str = io.string
+    assert_not_nil str
+
+    lines = str.split "\n"
+
+    (0 ... expected.size).each do |idx|
+      if expected[idx]
+        assert_equal expected[idx], lines[idx], "index: #{idx}"
+      end
+    end
+
+    Log.output = io
+  end
+end

data/test/logue/testlog/log_test.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pathname'
+require 'test/unit'
+require 'stringio'
+require 'logue/loggable'
+require 'logue/testlog/logtestee'
+
+include Logue
+
+class LogTestCase < Test::Unit::TestCase
+  include Loggable
+
+  def run_log_testee_test(methname, expected, &blk)
+    Log.verbose = true
+    io = StringIO.new
+    Log.output = io
+    Log.set_default_widths
+
+    blk.call if blk
+
+    lt = LogTestee.new
+    lt.send methname
+
+    str = io.string
+
+    lines = str.split "\n"
+
+    (0 ... expected.size).each do |idx|
+      if expected[idx]
+        assert_equal expected[idx], lines[idx], "index: #{idx}"
+      end
+    end
+    
+    Log.set_default_widths
+  end
+
+  def run_format_test(expected, &blk)
+    Log.verbose = true
+    io = StringIO.new
+    Log.output = io
+    Log.set_default_widths
+
+    blk.call
+
+    lt = LogTestee.new
+    lt.format_test
+
+    assert_equal expected.join(''), io.string
+    
+    Log.set_default_widths
+  end
+
+  def test_no_output
+    run_log_testee_test(:log_all, Array.new) do
+      Log.verbose = false
+    end
+  end
+
+  def msg lnum, methname, msg
+    sprintf("[  ...testlog/logtestee.rb:  %2d] {%-20s} %s", 16 + lnum, methname[0 .. 19], msg)
+  end
+
+  def test_output_arg
+    methname = "log_all"
+
+    expected = Array.new
+    (1 .. 6).each do |lnum|
+      msg = "hello, world?"
+      if lnum == 4 || lnum == 5
+        msg = "EXPECTED OUTPUT TO STDERR: hello, world."
+      end
+      expected << sprintf("[  ...testlog/logtestee.rb:  %2d] {%-20s} %s", 16 + lnum, methname[0 .. 19], msg)
+    end
+
+    run_log_testee_test(:log_all, expected)
+  end
+
+  def test_output_block_at_level
+    Log.level = Log::DEBUG
+    
+    methname = "log_block"
+
+    msg = "block party"
+
+    expected = Array.new
+    expected << sprintf("[  ...testlog/logtestee.rb:  %2d] {%-20s} %s", 26, methname[0 .. 19], msg)
+
+    run_log_testee_test(:log_block, expected)
+  end
+
+  def test_output_block_below_level
+    expected = Array.new
+
+    run_log_testee_test(:log_block, expected) do
+      Log.level = Log::INFO
+    end
+  end
+
+  def test_colors_foreground
+    methname = "log_foregrounds"
+    expected = Array.new
+    expected << sprintf("[  ...testlog/logtestee.rb:  %2d] {%-20s} %s", 30, methname[0 .. 19], "\e[37mwhite wedding\e[0m")
+    expected << sprintf("[  ...testlog/logtestee.rb:  %2d] {%-20s} %s", 31, methname[0 .. 19], "\e[34mblue iris\e[0m")
+    
+    run_log_testee_test(:log_foregrounds, expected)
+  end
+
+  def xxxtest_colors_background
+    expected = Array.new
+    expected << "[ ...test/logue/log_test.rb: 109] {LogTestCase#test_col} \e[46mred\e[0m"
+
+    run_log_testee_test(:log_foregrounds, expected) do
+    end
+  end
+
+  def test_format_default
+    expected = Array.new
+    expected << "[  ...testlog/logtestee.rb:  10] {format_test         } tamrof\n"
+
+    run_format_test expected do
+      Log.set_default_widths
+    end
+  end
+
+  def test_format_flush_filename_left
+    expected = Array.new
+    expected << "[ ...test/logue/testlog/logtestee.rb:  10] {format_test         } tamrof\n"
+
+    run_format_test expected do
+      Log.set_widths(-35, Log::DEFAULT_LINENUM_WIDTH, Log::DEFAULT_FUNCTION_WIDTH)
+    end
+  end
+
+  def test_format_flush_linenum_left
+    expected = Array.new
+    expected << "[  ...testlog/logtestee.rb:10        ] {format_test         } tamrof\n"
+
+    run_format_test expected do
+      Log.set_widths(Log::DEFAULT_FILENAME_WIDTH, -10, Log::DEFAULT_FUNCTION_WIDTH)
+    end
+  end
+
+  def test_format_flush_function_right
+    expected = Array.new
+    expected << "[  ...testlog/logtestee.rb:  10] {                        format_test} tamrof\n"
+
+    run_format_test expected do
+      Log.set_widths(Log::DEFAULT_FILENAME_WIDTH, Log::DEFAULT_LINENUM_WIDTH, 35)
+    end
+  end
+
+  def test_format_pad_linenum_zeros
+    expected = Array.new
+    expected << "[  ...testlog/logtestee.rb:00000010] {format_test         } tamrof\n"
+
+    run_format_test expected do
+      Log.set_widths(Log::DEFAULT_FILENAME_WIDTH, "08", Log::DEFAULT_FUNCTION_WIDTH)
+    end
+  end
+
+  def test_respond_to_color
+    assert Log.respond_to? :blue
+  end
+end

data/test/logue/testlog/loggable_test.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pathname'
+require 'test/unit'
+require 'stringio'
+require 'logue/log'
+require 'logue/loggable'
+require 'logue/testlog/lgbl_testee'
+
+class LoggableTestCase < Test::Unit::TestCase
+  include Logue::Loggable
+
+  def test_instance_colors
+    Logue::Log.verbose = true
+    io = StringIO.new
+    Logue::Log.output = io
+
+    expected = Array.new
+    expected << "[...testlog/lgbl_testee.rb:  11] {LgblTestee#crystal  } hello!\n"
+    expected << "[...testlog/lgbl_testee.rb:  12] {LgblTestee#crystal  } azul ... \n"
+    expected << "[...testlog/lgbl_testee.rb:  13] {LgblTestee#crystal  } rojo?\n"
+    
+    te = LgblTestee.new
+    te.crystal
+
+    # puts io.string
+
+    assert_equal expected.join(''), io.string
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: logue
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Pace
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+description: A module that adds logging/trace functionality.
+email: jeugenepace@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/logue.rb
+- lib/logue/format.rb
+- lib/logue/log.rb
+- lib/logue/loggable.rb
+- lib/logue/logger.rb
+- lib/logue/severity.rb
+- test/logue/format_test.rb
+- test/logue/testlog/log_stack_test.rb
+- test/logue/testlog/log_test.rb
+- test/logue/testlog/loggable_test.rb
+- README.md
+homepage: http://jeugenepace.github.com/logue
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: A minimalist logging module.
+test_files:
+- test/logue/format_test.rb
+- test/logue/testlog/log_stack_test.rb
+- test/logue/testlog/log_test.rb
+- test/logue/testlog/loggable_test.rb