logue 1.0.5 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 385cb8613ee04140fab6eacde15fa7ed4cb67ba1
-  data.tar.gz: e1e1649d69e92e3440dd02e43605debf063c72be
+  metadata.gz: a3d4405454050091913dfa971aeb278078d431b1
+  data.tar.gz: 8a07f226220c9829f09f62da75a3fad08ac12f0f
 SHA512:
-  metadata.gz: 2c8ba5bd3f9f039a49eba59cb4d41cb929adfa6aa886d93044039abc8824bc03d73e4be0cbc053432dfe915d867ce19eebbc8474bc0dc11aa61984984450c853
-  data.tar.gz: 07d5016f53177fe85a744bc6c588d10da300856bdc43db0d2c1183a41ee01fa0b7a058e25a5fbcddace3565d948aff3c14fe0c55f6247e5d728dde429e3633d4
+  metadata.gz: db149d129f19bc569a6dce1cb945741821bdcc7ab5c89511463cd4f7f3cfcd8e55b135aa3f8c71a28341bd8af6f4fa319ce83c8970e35fb0f2287ea2848a0794
+  data.tar.gz: 50aeb6028db277427a7ae453205df31d61148bfcd0e5478cf126d65ab0d64f5e065294005fc196bf45f035df3702b6fadb5d59477cd5e34b4cb3e3306d7fdf28

data/lib/logue/format.rb

@@ -1,52 +1,38 @@
 #!/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
-
-      if str.length > mxln
-        trim_path_right str, maxlen
-      else
-        str
-      end
-    end
+require 'logue/pathutil'
 
-    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    
+class Logue::FormatWidths
+  DEFAULT_FILENAME = -25
+  DEFAULT_LINENUM = 4
+  DEFAULT_FUNCTION = -20
+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
+class Logue::Format
+  def initialize args = Hash.new
+    @file_width = args.fetch :file_width, Logue::FormatWidths::DEFAULT_FILENAME
+    @line_width = args.fetch :line_width, Logue::FormatWidths::DEFAULT_LINENUM
+    @method_width = args.fetch :method_width, Logue::FormatWidths::DEFAULT_FUNCTION
+    @trim = args.fetch :trim, true
+  end
 
-      hdr = sprintf @format, file, line, func
-      print hdr, msg, lvl, &blk
+  def copy args
+    values = { file_width: @file_width, line_width: @line_width, method_width: @method_width, trim: @trim }
+    self.class.new values.merge(args)
+  end
+  
+  def format path, lineno, cls, func
+    if cls
+      func = cls.to_s + "#" + func
     end
+    
+    if @trim
+      path = Logue::PathUtil.trim_right path, @file_width
+      func = Logue::PathUtil.trim_left  func, @method_width
+    end
+    
+    format = "[%#{@file_width}s:%#{@line_width}d] {%#{@method_width}s}"
+    sprintf format, path, lineno, func
   end
 end

data/lib/logue/log.rb

@@ -5,14 +5,13 @@
 #
 # Logging Module
 #
-# Author:: Jeff Pace <jeugenepace@gmail.com>
+# Author:: Jeff Pace
 # Documentation:: Author
 #
 
 require 'logue/logger'
 require 'logue/severity'
 require 'logue/colors'
-require 'rainbow'
 
 #
 # == Log
@@ -37,7 +36,7 @@ require 'rainbow'
 #  That will simply log the given message.
 #
 #  class YourClass
-#    include Loggable
+#    include Logue::Loggable
 #
 #    def some_method(...)
 #      log "my message"
@@ -55,10 +54,6 @@ 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.
@@ -71,134 +66,78 @@ module Logue
       @@log
     end
 
+    def self.accessors methname
+      [ methname.to_sym, (methname.to_s + "=").to_sym ]
+    end
+    
+    def self.logger_delegated? meth
+      @@logger_delegated ||= Array.new.tap do |ary|
+        acc_methods = [
+          :colorize_line,
+          :format,
+          :level,
+          :outfile,
+          :output,
+          :quiet,
+          :verbose,
+        ]
+        ary.concat acc_methods.collect { |am| accessors(am) }.flatten!
+        read_methods = [
+          :ignore_class,
+          :ignore_file,
+          :ignore_method,
+          :log_class,
+          :log_file,
+          :log_method,
+          :set_color,
+          :set_default_widths,
+          :set_widths,
+        ]
+        ary.concat read_methods
+      end
+      @@logger_delegated.include? meth
+    end
+    
     def self.method_missing meth, *args, &blk
-      # only handling foregrounds, not backgrounds
-      if code = Colors::valid_colors[meth]
-        add_color_method meth.to_s, code + 30
-        send meth, *args, &blk
+      if logger_delegated? meth
+        logger.send meth, *args, &blk
+      elsif Colors::valid_colors[meth]
+        # only handling foregrounds, not backgrounds
+        logger.send meth, *args, &blk
       else
         super
       end
     end
 
     def self.respond_to? meth
-      Colors::valid_colors.include?(meth) || super
+      logger_delegated?(meth) || Colors::valid_colors.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 << "  logger.#{color} (\"\\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
+      
+      # an instance, but on the class object, not the log instance:
+      self.instance_eval instmeth.join("\n")
     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
+    def self.debug msg = "", depth = 1, cname = nil, &blk
+      logger.debug msg, depth + 1, cname, &blk
     end
 
-    def self.info msg = "", depth = 1, &blk
-      logger.log msg, INFO, depth + 1, &blk
+    def self.info msg = "", depth = 1, cname = nil, &blk
+      logger.info msg, depth + 1, cname, &blk
     end
 
-    def self.fatal msg = "", depth = 1, &blk
-      logger.log msg, FATAL, depth + 1, &blk
+    def self.fatal msg = "", depth = 1, cname = nil, &blk
+      logger.fatal msg, depth + 1, cname, &blk
     end
 
     def self.log msg = "", lvl = DEBUG, depth = 1, cname = nil, &blk
@@ -209,17 +148,17 @@ module Logue
       logger.stack msg, lvl, depth + 1, cname, &blk
     end
 
-    def self.warn msg = "", depth = 1, &blk
+    def self.warn msg = "", depth = 1, cname = nil, &blk
       if verbose
-        logger.log msg, WARN, depth + 1, &blk
+        logger.log msg, WARN, depth + 1, cname, &blk
       else
         $stderr.puts "WARNING: " + msg
       end
     end
 
-    def self.error msg = "", depth = 1, &blk
+    def self.error msg = "", depth = 1, cname = nil, &blk
       if verbose
-        logger.log msg, ERROR, depth + 1, &blk
+        logger.log msg, ERROR, depth + 1, cname, &blk
       else
         $stderr.puts "ERROR: " + msg
       end
@@ -234,9 +173,5 @@ module Logue
         $stderr.puts msg
       end
     end
-
-    def self.set_color lvl, color
-      logger.set_color lvl, color
-    end
   end
 end

data/lib/logue/loggable.rb

@@ -24,7 +24,7 @@ require 'logue/colors'
 # == Usage
 #
 #  class YourClass
-#    include Loggable
+#    include Logue::Loggable
 #
 #    def some_method(...)
 #      log "my message"
@@ -42,35 +42,35 @@ 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
+      delegate_log_class.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
+      delegate_log_class.debug msg, 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
+      delegate_log_class.info msg, 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
+      delegate_log_class.warn msg, 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
+      delegate_log_class.error msg, 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
+      delegate_log_class.fatal msg, 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
+      delegate_log_class.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
+      delegate_log_class.write msg, depth + 1, self.class.to_s, &blk
     end
 
     def method_missing meth, *args, &blk
@@ -94,5 +94,9 @@ module Logue
       meth << "end"
       self.class.module_eval meth.join("\n")
     end
+
+    def delegate_log_class
+      Log
+    end
   end
 end