logue 1.0.5 → 1.0.8

data/lib/logue/logger.rb

@@ -9,10 +9,11 @@
 # Documentation:: Author
 #
 
-require 'rainbow'
+require 'rainbow/x11_color_names'
 require 'pathname'
 require 'logue/severity'
 require 'logue/format'
+require 'logue/pathutil'
 
 #
 # == Logger
@@ -26,241 +27,233 @@ require 'logue/format'
 # 
 
 module Logue
-  class Logger
-    $LOGGING_LEVEL = nil
+end
 
-    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
+class Logue::Logger
+  $LOGGING_LEVEL = nil
 
-    include Log::Severity
+  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_reader :trim
 
-    FRAME_RE = Regexp.new('(.*):(\d+)(?::in \`(.*)\')?')
+  include Logue::Log::Severity
 
-    def initialize
-      set_defaults
-    end
-    
-    def verbose= v
-      @level = case v
-               when TrueClass 
-                 DEBUG
-               when FalseClass 
-                 FATAL
-               when Integer
-                 v
-               end
-    end
+  FRAME_RE = Regexp.new('(.*):(\d+)(?::in \`(.*)\')?')
 
-    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 initialize
+    set_defaults
+  end
+  
+  def verbose= v
+    @level = case v
+             when TrueClass 
+               DEBUG
+             when FalseClass 
+               FATAL
+             when Integer
+               v
+             end
+  end
 
-    def set_default_widths
-      set_widths Log::DEFAULT_FILENAME_WIDTH, Log::DEFAULT_LINENUM_WIDTH, Log::DEFAULT_FUNCTION_WIDTH
-    end
+  def set_defaults
+    $LOGGING_LEVEL   = @level = FATAL
+    @ignored_files   = Hash.new
+    @ignored_methods = Hash.new
+    @ignored_classes = Hash.new
+    @output          = $stdout
+    @colors          = Array.new
+    @colorize_line   = false
+    @quiet           = false
+    @trim            = true
 
-    def verbose
-      level <= DEBUG
-    end
+    @format = Logue::Format.new
 
-    # 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
+    set_default_widths
+  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 trim= what
+  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 set_default_widths
+    set_widths Logue::FormatWidths::DEFAULT_FILENAME, Logue::FormatWidths::DEFAULT_LINENUM, Logue::FormatWidths::DEFAULT_FUNCTION
+  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 verbose
+    level <= DEBUG
+  end
 
-    def debug msg = "", depth = 1, &blk
-      log msg, DEBUG, depth + 1, &blk
-    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
 
-    def info msg = "", depth = 1, &blk
-      log msg, INFO, depth + 1, &blk
-    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
+  end
 
-    def warn msg = "", depth = 1, &blk
-      log msg, WARN, depth + 1, &blk
-    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 error msg = "", depth = 1, &blk
-      log msg, ERROR, depth + 1, &blk
-    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 fatal msg = "", depth = 1, &blk
-      log msg, FATAL, depth + 1, &blk
-    end
+  def debug msg = "", depth = 1, cname = nil, &blk
+    log msg, DEBUG, depth + 1, cname, &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
+  def info msg = "", depth = 1, cname = nil, &blk
+    log msg, INFO, depth + 1, cname, &blk
+  end
 
-        print_stack_frame frame, cname, msg, lvl, &blk
-      end
-    end
+  def warn msg = "", depth = 1, cname = nil, &blk
+    log msg, WARN, depth + 1, cname, &blk
+  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 error msg = "", depth = 1, cname = nil, &blk
+    log msg, ERROR, depth + 1, cname, &blk
+  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!(/.*\//, "")
+  def fatal msg = "", depth = 1, cname = nil, &blk
+    log msg, FATAL, depth + 1, cname, &blk
+  end
 
-      # Ruby 1.9 expands the file name, but 1.8 doesn't:
-      pn = Pathname.new(file).expand_path
-      
-      file = pn.to_s
+  # Logs the given message.
+  def log msg = "", lvl = DEBUG, depth = 1, cname = nil, &blk
+    if lvl >= level
+      frame = nil
 
-      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)
+      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
 
-    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
+  # Shows the current stack.
+  def stack msg = "", lvl = DEBUG, depth = 1, cname = nil, &blk
+    if lvl >= level
+      stk = caller depth
+      stk.each do |frame|
+        print_stack_frame frame, cname, msg, lvl, &blk
+        cname = nil
+        msg = ""
       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
+  end
 
-      msg = msg.to_s.chomp
+  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!(/.*\//, "")
 
-      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
+    # Ruby 1.9 expands the file name, but 1.8 doesn't:
+    pn = Pathname.new(file).expand_path
+    
+    file = pn.to_s
 
-    def set_color lvl, color
-      @colors[lvl] = color
+    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 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
+  def print_formatted file, line, func, msg, lvl, &blk
+    fmt = Logue::Format.new file_width: @file_width, line_width: @line_width, method_width: @function_width, trim: @trim
+    location = fmt.format file, line, nil, func
+    print location, msg, lvl, &blk
+  end
+  
+  def print hdr, msg, lvl, &blk
+    if blk
+      x = blk.call
+      if x.kind_of? String
+        msg = x
       else
-        super
+        return
       end
     end
 
-    def respond_to? meth
-      validcolors = Sickill::Rainbow::TERM_COLORS
-      validcolors.include?(meth) || super
-    end
+    msg = msg.to_s.chomp
 
-    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")
+    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
 
-      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"
+  def set_color lvl, color
+    @colors[lvl] = color
+  end
 
-      class_eval clsmeth.join("\n")
+  def method_missing meth, *args, &blk
+    # validcolors = Rainbow::X11ColorNames::NAMES
+    validcolors = Rainbow::Color::Named::NAMES
+    # 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 = Rainbow::X11ColorNames::NAMES
+    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")
+  end
 end

data/lib/logue/pathutil.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+module Logue
+end
+
+class Logue::PathUtil
+  class << self
+    def trim_left str, maxlen
+      str[0 ... maxlen.to_i.abs]
+    end
+
+    def trim_right str, maxlen
+      mxln = maxlen.abs
+
+      if str.length > mxln
+        trim_path_right str, maxlen
+      else
+        str
+      end
+    end
+
+    def trim_path_right path, maxlen
+      mxln = maxlen.abs
+      
+      comps = path.split "/"
+      str = comps.pop
+      comps.reverse.each do |comp|
+        newstr = comp + "/" + str
+        if newstr.length + 4 <= mxln
+          str = newstr
+        else
+          newstr = "..." + "/" + str
+          if newstr.length <= mxln
+            str = newstr
+          end
+          break
+        end
+      end
+      str
+    end    
+  end
+end

data/lib/logue/writer.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'logue/format'
+
+module Logue
+end
+
+class Logue::Writer
+  attr_accessor :out
+  
+  def initialize out = $stdout
+    @out = out
+  end
+
+  def write fmt, stack, nframes, cls = nil
+    stack[0 ... nframes].each do |frame|
+      path = frame.absolute_path
+      lineno = frame.lineno
+      func = frame.label
+      @out.puts fmt.format path, lineno, cls, func
+    end
+  end
+end

data/lib/logue.rb

@@ -13,5 +13,5 @@ Pathname.glob(loguelibdir + '/logue/**/*.rb').each do |file|
 end
 
 module Logue
-  VERSION = '1.0.5'
+  VERSION = '1.0.8'
 end

data/test/logue/colors_test.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'logue/colors'
+require 'test/unit'
+
+class ColorsTest < Test::Unit::TestCase
+  def test_valid_colors
+    result = Colors.valid_colors
+    assert_equal [ :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white, :default ], result.keys
+  end
+end

data/test/logue/format_test.rb

@@ -1,80 +1,59 @@
 #!/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
-
-    # trim_left
-
-    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
-
-    # trim_right
-
-    def assert_trim_right expected, length, str
-      trimmed = Format.new.trim_right str, length
-      assert_equal expected, trimmed, "length: #{length}"
-    end
-
-    def test_trim_right_path_excess
-      assert_trim_right "ab/cd/ef.t", 11, "ab/cd/ef.t"
-    end
-
-    def test_trim_right_path_at_length
-      assert_trim_right "ab/cd/ef.t", 10, "ab/cd/ef.t"
-    end
-
-    def test_trim_right_path_one_less
-      assert_trim_right ".../ef.t", 9, "ab/cd/ef.t"
-    end
-
-    def test_trim_right_path_two_less
-      assert_trim_right ".../ef.t", 8, "ab/cd/ef.t"
-    end
-
-    def test_trim_right_path_three_less
-      assert_trim_right "ef.t", 7, "ab/cd/ef.t"
-    end
+class Logue::FormatTestCase < Test::Unit::TestCase
+  # use as:
+  # msg "path", path, "lineno", lineno, "cls", cls, "func", func
+  def message(*fields)
+    fields.each_slice(2).collect do |field, value|
+      "#{field}: #{value}"
+    end.join "; "
+  end
 
-    def test_trim_right_path_four_less
-      assert_trim_right "ef.t", 6, "ab/cd/ef.t"
-    end
+  def assert_instance_variable expected, obj, name
+    val = obj.instance_eval name
+    assert_equal expected, val, "name: #{name}; expected: #{expected}; result: #{val}"
+    val
+  end
 
-    def test_trim_right_path_five_less
-      assert_trim_right "ef.t", 5, "ab/cd/ef.t"
-    end
+  def test_default_values
+    fmt = Logue::Format.new
+    assert_instance_variable Logue::FormatWidths::DEFAULT_FILENAME, fmt, "@file_width"
+    assert_instance_variable Logue::FormatWidths::DEFAULT_LINENUM, fmt, "@line_width"
+    assert_instance_variable Logue::FormatWidths::DEFAULT_FUNCTION, fmt, "@method_width"
+    assert_instance_variable true, fmt, "@trim"
+  end
 
-    def test_trim_right_path_six_less
-      assert_trim_right "ef.t", 4, "ab/cd/ef.t"
-    end
+  def assert_format expected, path, lineno, cls, func
+    msg = message "path", path, "lineno", lineno, "cls", cls, "func", func
+    fmt = Logue::Format.new
+    fmt.format path, lineno, cls, func
+    result = fmt.format path, lineno, cls, func
+    assert_equal expected, result, msg
+  end
 
-    def test_trim_right_path_seven_less
-      assert_trim_right "ef.t", 3, "ab/cd/ef.t"
-    end
+  def test_write
+    path = "/a/long/path/to/the/directory/abc.t"
+    lineno = 1    
+    func = "block (2 levels) in one"
+    cls = nil
+    expected = "[.../the/directory/abc.t  :   1] {block (2 levels) in }"
+    assert_format expected, path, lineno, cls, func
+  end
 
-    def test_trim_right_path_eight_less
-      assert_trim_right "ef.t", 2, "ab/cd/ef.t"
-    end
+  def test_copy
+    fmt = Logue::Format.new line_width: 77
+    val = fmt.instance_eval "@line_width"
+    assert_equal 77, val
+    
+    copy = fmt.copy method_width: 123
+    val = copy.instance_eval "@line_width"
+    assert_equal 77, val
+    
+    val = copy.instance_eval "@method_width"
+    assert_equal 123, val
   end
 end