logue 1.0.13 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27c5cf726353cfb91ce2c443c8cd02f5a8c0e272
-  data.tar.gz: 02125714a6032756c58acff5522fe104748bd270
+  metadata.gz: d93c0be8b98a96fa0f527a7fbf9ee887bc568152
+  data.tar.gz: e4e95e29c3e01b1a979c34abd12941508851435d
 SHA512:
-  metadata.gz: 43947a643388fa154feb99be7c02a3a33dcc701e75e256738f97911bdd982ecb23a236922e8db4bd4693b43eb46a28b56e14313221da001bbeb95b79da67d4a5
-  data.tar.gz: f3aa71bcd285189271ec1a5d48463c79c247d2b57ee58fece9ae4f483ae9f7f69621e103ef5f803d639a7678f3014179d82038067f78649d7cecc89b11799636
+  metadata.gz: 610941e8a4c13e4a770fbc67ffa470091edf44ece9143bcce8bc0dc95c13e35571a16d87673194580755e57974933194a18665b52cd844c42dbfe150854b9ea1
+  data.tar.gz: 337d2cab1cedc557e65ddc9d2c7d7110dccbf0ba32382d2ae365c945dd67f5f446558ea7b71a8fbfa46d900cef844c2bc5a25e0e5cf47f5e14980c5c8451f545

data/README.md

@@ -20,7 +20,8 @@ class MyClass
   end
 end
 
-MyClass.new.mymethod "bar"
+obj = MyClass.new
+obj.mymethod "bar"
 ```
 
 Produces:

data/lib/logue/colorlog.rb

@@ -26,9 +26,7 @@ require 'logue/level'
 module Logue
   module ColorLog
     def method_missing meth, *args, &blk
-      # validcolors = Rainbow::X11ColorNames::NAMES
-      validcolors = Rainbow::Color::Named::NAMES
-      if code = validcolors[meth]
+      if code = valid_colors[meth]
         add_color_method meth.to_s, code + 30
         send meth, *args, &blk
       else
@@ -37,18 +35,25 @@ module Logue
     end
 
     def respond_to? meth
-      # validcolors = Rainbow::X11ColorNames::NAMES
-      validcolors = Rainbow::Color::Named::NAMES
-      validcolors.include?(meth) || super
+      valid_colors.include?(meth) || super
+    end
+
+    def methods all = true
+      super + valid_colors.keys
     end
 
     def add_color_method color, code
-      instmeth = Array.new.tap do |a|
-        a << 'def ' + color.to_s + '(msg = "", lvl = Logue::Level::DEBUG, cname = nil, &blk)'
-        a << '  log("\e[' + code.to_s + 'm#{msg}\e[0m", lvl, cname, &blk)'
+      meth = Array.new.tap do |a|
+        a << 'def ' + color.to_s + '(msg = "", lvl = Logue::Level::DEBUG, classname: nil, &blk)'
+        a << '  log("\e[' + code.to_s + 'm#{msg}\e[0m", level: lvl, classname: classname, &blk)'
         a << 'end'
       end
-      instance_eval instmeth.join "\n"
+      instance_eval meth.join "\n"
+    end
+
+    def valid_colors
+      # Rainbow::X11ColorNames::NAMES
+      Rainbow::Color::Named::NAMES
     end
   end
 end

data/lib/logue/legacy_logger.rb

@@ -14,8 +14,8 @@ require 'logue/location_format'
 
 module Logue
   module LegacyLogger
+    # this is deprecated and ignored:
     def trim= what
-      $stderr.puts "Logger#trim is deprecated, and ignored"
     end
 
     def ignore_file fname

data/lib/logue/level.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/ruby -w
 # -*- ruby -*-
 #
-# = severity.rb
+# = level.rb
 #
 # Logging Module
 #
@@ -10,7 +10,7 @@
 #
 
 module Logue
-  module Level
+  class Level
     DEBUG = 0
     INFO  = 1
     WARN  = 2

data/lib/logue/line.rb

@@ -7,15 +7,32 @@ module Logue
   class Line
     attr_reader :location
     attr_reader :msg
+    attr_reader :obj
+    attr_reader :block
     
-    def initialize location, msg
+    def initialize location, msg, obj = nil, &blk
       @location = location
       @msg = msg
+      @obj = obj
+      @block = blk
+    end
+
+    def location_string locformat
+      @location.format locformat
+    end
+
+    def message_string
+      if @block
+        @block.call.to_s
+      elsif @obj
+        "#{@msg}: #{@obj}"
+      else
+        "#{@msg}"
+      end
     end
 
     def format locformat
-      logmsg = @location.format locformat
-      logmsg + " " + @msg
+      location_string(locformat) + " " + message_string
     end
   end
 end

data/lib/logue/location.rb

@@ -6,19 +6,19 @@ require 'logue/location_format'
 module Logue
   class Location
     attr_reader :path
-    attr_reader :lineno
+    attr_reader :line
     attr_reader :cls
     attr_reader :method
     
-    def initialize path, lineno, cls, method
+    def initialize path, line, cls, method
       @path   = path
-      @lineno = lineno
+      @line   = line
       @cls    = cls
       @method = method
     end
 
     def format locformat
-      locformat.format @path, @lineno, @cls, @method
+      locformat.format @path, @line, @cls, @method
     end
   end
 end

data/lib/logue/location_format.rb

@@ -14,31 +14,18 @@ module Logue
     attr_accessor :file
     attr_accessor :line
     attr_accessor :method
-    attr_accessor :trim
     
-    def initialize  file: Defaults::FILENAME, line: Defaults::LINE, method: Defaults::METHOD, trim: true
+    def initialize file: Defaults::FILENAME, line: Defaults::LINE, method: Defaults::METHOD
       @file   = file
       @line   = line
       @method = method
-      @trim   = trim
-    end
-
-    def copy args
-      values = { file: @file, line: @line, method: @method, trim: @trim }
-      self.class.new values.merge(args)
     end
     
-    def format path, line, cls, func
-      if cls
-        func = cls.to_s + "#" + func
-      end
-      
-      if trim
-        path = PathUtil.trim_right path.to_s, @file
-        func = PathUtil.trim_left  func,      @method
-      end
-      
-      sprintf format_string, path, line, func
+    def format path, line, cls, methname
+      name = cls ? cls.to_s + "#" + methname : methname
+      path = PathUtil.trim_right path.to_s, @file
+      name = PathUtil.trim_left  name,      @method
+      sprintf format_string, path, line, name
     end
 
     def format_string

data/lib/logue/log.rb

@@ -10,16 +10,12 @@
 #
 
 require 'logue/logger'
-require 'logue/level'
-require 'logue/colors'
 
 #
 # == 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.
+# Log is the logger for anywhere within a program, writing to a single logger.
+# See Loggable and Logger for more precise behavior.
 # 
 # Remember: all kids love log.
 #
@@ -52,26 +48,21 @@ require 'logue/colors'
 
 module Logue
   class Log
-    $LOGGING_LEVEL = nil
-
-    include Level
-
     # by default, class methods delegate to a single app-wide log.
 
-    @@log = Logger.new
+    @logger = Logger.new
 
-    # Returns the logger of the log. A class method delegating to an instance
-    # method ... not so good. But temporary.
+    # Returns the app-wide logger of the log.
     def self.logger
-      @@log
+      @logger
     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|
+
+    def self.logger_methods
+      @logger_delegated ||= Array.new.tap do |ary|
         acc_methods = [
           :colorize_line,
           :format,
@@ -81,7 +72,7 @@ module Logue
           :quiet,
           :verbose,
         ]
-        ary.concat acc_methods.collect { |am| accessors(am) }.flatten!
+        ary.concat acc_methods.inject(Array.new) { |a, m| a.concat accessors(m) }
         read_methods = [
           :ignore_class,
           :ignore_file,
@@ -94,84 +85,54 @@ module Logue
           :set_widths,
         ]
         ary.concat read_methods
+        logging_methods = [
+          :debug,
+          :error,
+          :fatal,
+          :info,
+          :log,
+          :stack,
+          :warn,
+          :write,
+        ]
+        ary.concat logging_methods
       end
-      @@logger_delegated.include? meth
-    end
-    
-    def self.method_missing 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
-      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, cname = nil, &blk"
-      instmeth << "  logger.#{color} (\"\\e[#{code}m\#{msg\}\\e[0m\", lvl, cname, &blk)"
-      instmeth << "end"
-      
-      # 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.debug msg = "", cname = nil, &blk
-      logger.debug msg, cname, &blk
+    def self.logger_delegated? meth
+      self.logger_methods.include? meth
     end
 
-    def self.info msg = "", cname = nil, &blk
-      logger.info msg, cname, &blk
+    def self.methods all = true
+      super + self.logger_methods + colors
     end
 
-    def self.fatal msg = "", cname = nil, &blk
-      logger.fatal msg, cname, &blk
+    def self.has_color? color
+      colors.include? color
     end
 
-    def self.log msg = "", lvl = DEBUG, cname = nil, &blk
-      logger.log msg, lvl, cname, &blk
+    def self.colors
+      logger.valid_colors.keys
     end
 
-    def self.stack msg = "", lvl = DEBUG, cname = nil, &blk
-      logger.stack msg, lvl, cname, &blk
+    def self.delegated? meth
+      logger_delegated?(meth) || has_color?(meth)
     end
-
-    def self.warn msg = "", cname = nil, &blk
-      if verbose
-        logger.log msg, WARN, cname, &blk
+    
+    def self.method_missing meth, *args, &blk
+      if delegated? meth
+        logger.send meth, *args, &blk
       else
-        $stderr.puts "WARNING: " + msg
+        super
       end
     end
 
-    def self.error msg = "", cname = nil, &blk
-      if verbose
-        logger.log msg, ERROR, cname, &blk
-      else
-        $stderr.puts "ERROR: " + msg
-      end
+    def self.respond_to? meth
+      methods.include? meth
     end
 
-    def self.write msg, cname = nil, &blk
-      if verbose
-        stack msg, Log::WARN, cname, &blk
-      elsif quiet
-        # nothing
-      else
-        $stderr.puts msg
-      end
+    def self.respond_to_missing? *args
+      methods.include? args.first
     end
   end
 end

data/lib/logue/loggable.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/ruby -w
 # -*- ruby -*-
 #
-# = log.rb
+# = loggable.rb
 #
 # Logging Module
 #
@@ -9,8 +9,8 @@
 # Documentation:: Author
 #
 
+require 'logue/logger'
 require 'logue/log'
-require 'logue/colors'
 
 #
 # == Loggable
@@ -40,63 +40,60 @@ require 'logue/colors'
 
 module Logue
   module Loggable
-    # Logs the given message, including the class whence invoked.
-    def log msg = "", lvl = Log::DEBUG, &blk
-      delegate_log_class.log msg, lvl, self.class.to_s, &blk
+    def logger
+      @@logger ||= Logger.new
     end
 
-    def debug msg = "", &blk
-      delegate_log_class.debug msg, self.class.to_s, &blk
+    def logger= logger
+      @@logger = logger
     end
 
-    def info msg = "", &blk
-      delegate_log_class.info msg, self.class.to_s, &blk
+    def respond_to_missing? *args
+      true
     end
 
-    def warn msg = "", &blk
-      delegate_log_class.warn msg, self.class.to_s, &blk
+    def methods all = true
+      methods_with_level + methods_without_level + super
     end
 
-    def error msg = "", &blk
-      delegate_log_class.error msg, self.class.to_s, &blk
+    def methods_with_level
+      [ :log, :stack ]
     end
 
-    def fatal msg = "", &blk
-      delegate_log_class.fatal msg, self.class.to_s, &blk
+    def methods_without_level
+      [ :debug, :info, :error, :fatal, :write ] + logger.valid_colors.keys
     end
 
-    def stack msg = "", lvl = Log::DEBUG, &blk
-      delegate_log_class.stack msg, lvl, self.class.to_s, &blk
+    def warn msg = "", obj = nil, &blk
+      logger.warn msg, obj, classname: self.class.to_s, &blk
     end
-
-    def write msg = "", &blk
-      delegate_log_class.write msg, self.class.to_s, &blk
-    end
-
-    def method_missing meth, *args, &blk
+    
+    def method_missing methname, *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 methods_with_level.include? methname
+        add_delegator methname, true
+        send methname, *args, &blk
+      elsif methods_without_level.include? methname
+        add_delegator methname, false
+        send methname, *args, &blk
       else
         super
       end
     end
 
-    def respond_to? meth, include_all = false
-      Colors::valid_colors.include?(meth) || super
-    end
-
-    def add_color_method color, code
-      meth = Array.new
-      meth << "def #{color}(msg = \"\", lvl = Log::DEBUG, cname = nil, &blk)"
-      meth << "  Log.#{color} msg, lvl, self.class.to_s, &blk"
-      meth << "end"
-      self.class.module_eval meth.join("\n")
-    end
-
-    def delegate_log_class
-      Log
+    def add_delegator methname, with_level
+      lines = Array.new.tap do |a|
+        if with_level
+          a << "def #{methname} msg = '', obj = nil, level = Level::DEBUG, &blk"
+          a << "  logger.send :#{methname}, msg, obj, level: level, classname: self.class.to_s, &blk"
+        else
+          a << "def #{methname} msg = '', obj = nil, &blk"
+          a << "  logger.send :#{methname}, msg, obj, classname: self.class.to_s, &blk"
+        end
+        a << "end"
+      end
+      
+      instance_eval lines.join("\n")
     end
   end
 end

data/lib/logue/logger.rb

@@ -14,7 +14,9 @@ require 'logue/colorlog'
 require 'logue/writer'
 require 'logue/filter'
 require 'logue/legacy_logger'
+require 'logue/location'
 require 'logue/stack'
+require 'logue/line'
 
 #
 # == Logger
@@ -36,26 +38,24 @@ module Logue
     attr_accessor :format
     attr_accessor :filter
     attr_accessor :writer
-    
-    include Level
 
-    def initialize format: LocationFormat.new, level: WARN, filter: Filter.new, writer: Writer.new
+    def initialize format: LocationFormat.new, level: Level::WARN, filter: Filter.new, writer: Writer.new
       reset format: format, level: level, filter: filter, writer: writer
     end
     
     def verbose= v
       @level = case v
                when TrueClass 
-                 DEBUG
+                 Level::DEBUG
                when FalseClass 
-                 FATAL
+                 Level::FATAL
                when Integer
                  v
                end
     end
 
     def verbose
-      @level <= DEBUG
+      @level <= Level::DEBUG
     end
 
     def reset format: LocationFormat.new, level: FATAL, filter: Filter.new, writer: Writer.new
@@ -66,11 +66,11 @@ module Logue
     end
     
     def quiet
-      @level >= WARN
+      @level >= Level::WARN
     end
 
     def quiet= b
-      @level = b ? WARN : DEBUG
+      @level = b ? Level::WARN : Level::DEBUG
     end
 
     # Assigns output to a file with the given name. Returns the file; the client is responsible for
@@ -86,56 +86,59 @@ module Logue
       @format = LocationFormat.new file: file, line: line, method: method
     end
 
-    def debug msg = "", cname = nil, &blk
-      log msg, DEBUG, cname, &blk
+    def debug msg = "", obj = nil, classname: nil, &blk
+      log msg, obj, level: Level::DEBUG, classname: classname, &blk
     end
 
-    def info msg = "", cname = nil, &blk
-      log msg, INFO, cname, &blk
+    def info msg = "", obj = nil, classname: nil, &blk
+      log msg, obj, level: Level::INFO, classname: classname, &blk
     end
 
-    def warn msg = "", cname = nil, &blk
-      log msg, WARN, cname, &blk
+    def warn msg = "", obj = nil, classname: nil, &blk
+      log msg, obj, level: Level::WARN, classname: classname, &blk
     end
 
-    def error msg = "", cname = nil, &blk
-      log msg, ERROR, cname, &blk
+    def error msg = "", obj = nil, classname: nil, &blk
+      log msg, obj, level: Level::ERROR, classname: classname, &blk
     end
 
-    def fatal msg = "", cname = nil, &blk
-      log msg, FATAL, cname, &blk
+    def fatal msg = "", obj = nil, classname: nil, &blk
+      log msg, obj, level: Level::FATAL, classname: classname, &blk
     end
 
     # Logs the given message.
-    def log msg = "", lvl = DEBUG, cname = nil, &blk
-      log_frames cname, msg, lvl, 0, &blk
+    def log msg = "", obj = nil, level: Level::DEBUG, classname: nil, &blk
+      log_frames msg, obj, classname: classname, level: level, nframes: 0, &blk
     end
 
     # Shows the current stack.
-    def stack msg = "", lvl = DEBUG, cname = nil, &blk
-      log_frames cname, msg, lvl, -1, &blk
+    def stack msg = "", obj = nil, level: Level::DEBUG, classname: nil, &blk
+      log_frames msg, obj, classname: classname, level: level, nframes: -1, &blk
     end
 
-    def log_frames cname, msg, lvl, num, &blk
-      if lvl >= level
+    def log_frames msg, obj = nil, classname: nil, level: nil, nframes: -1, &blk
+      if level >= @level
         stack = Stack.new
-        stack.filtered[0 .. num].each do |frame|
-          log_frame frame, cname, msg, lvl, &blk
-          cname = nil
-          msg   = ""
+        stack.filtered[0 .. nframes].each do |frame|
+          log_frame frame, msg, obj, classname: classname, level: level, &blk
+          classname = nil
+          msg = ""
+          obj = nil
         end
       end
     end    
 
-    def log_frame frame, cname, msg, lvl, &blk
-      if @filter.log? frame.path, cname, frame.method
-        print_formatted frame, cname, msg, lvl, &blk
+    def log_frame frame, msg, obj, classname: nil, level: nil, &blk
+      if @filter.log? frame.path, classname, frame.method
+        print_frame frame, msg, obj, classname: classname, level: level, &blk
       end
     end
 
-    def print_formatted frame, cname, msg, lvl, &blk
-      location = frame.formatted @format, cname
-      @writer.print location, msg, level, &blk
+    def print_frame frame, msg, obj, classname: nil, level: nil, &blk
+      loc  = Location.new frame.path, frame.line, classname, frame.method
+      line = Line.new loc, msg, obj, &blk
+      lstr = line.format @format
+      @writer.print lstr, level
     end
   end
 end

data/lib/logue/stack.rb

@@ -17,7 +17,8 @@ module Logue
     end
 
     def filtered
-      logframe = @frames.rindex { |frm| frm.path.include? "logue/lib/logue" }
+      re = Regexp.new 'logue.*/lib/logue'
+      logframe = @frames.rindex { |frm| frm.path.index re }
       @frames[logframe + 1 .. -1]
     end
   end

data/lib/logue/version.rb

@@ -2,5 +2,5 @@
 # -*- ruby -*-
 
 module Logue
-  VERSION = '1.0.13'
+  VERSION = '1.0.14'
 end

data/lib/logue/writer.rb

@@ -13,19 +13,9 @@ module Logue
       @colorize_line = colorize_line
     end
 
-    def print location, msg, lvl, &blk
-      if blk
-        x = blk.call
-        if x.kind_of? String
-          msg = x
-        else
-          return
-        end
-      end
-
-      msg = msg.to_s.chomp
-      line = line location, msg, lvl
-      @output.puts line
+    def print lstr, lvl
+      str = lvlcol = @colors[lvl] ? lstr.color(lvlcol) : lstr
+      @output.puts str
     end
 
     def line location, msg, lvl

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logue
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.0.14
 platform: ruby
 authors:
 - Jeff Pace
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,7 +98,6 @@ files:
 - bin/setup
 - lib/logue.rb
 - lib/logue/colorlog.rb
-- lib/logue/colors.rb
 - lib/logue/filter.rb
 - lib/logue/frame.rb
 - lib/logue/legacy_logger.rb
@@ -110,7 +109,6 @@ files:
 - lib/logue/loggable.rb
 - lib/logue/logger.rb
 - lib/logue/pathutil.rb
-- lib/logue/severity.rb
 - lib/logue/stack.rb
 - lib/logue/version.rb
 - lib/logue/writer.rb
@@ -136,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: A minimalist logging module.

data/lib/logue/colors.rb

@@ -1,19 +0,0 @@
-#!/usr/bin/ruby -w
-# -*- ruby -*-
-#
-# = colors.rb
-#
-# Logging Module
-#
-# Author:: Jeff Pace <jeugenepace@gmail.com>
-# Documentation:: Author
-#
-
-require 'rainbow/x11_color_names'
-require 'rainbow/color'
-
-class Colors
-  def self.valid_colors
-    Rainbow::Color::Named::NAMES
-  end
-end

data/lib/logue/severity.rb

@@ -1,21 +0,0 @@
-#!/usr/bin/ruby -w
-# -*- ruby -*-
-#
-# = level.rb
-#
-# Logging Module
-#
-# Author:: Jeff Pace <jeugenepace@gmail.com>
-# Documentation:: Author
-#
-
-require 'logue/level'
-
-module Logue
-  class Log
-    # legacy module that is replaced by Logue::Level
-    module Severity
-      include Logue::Level
-    end
-  end
-end