extended-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b144a61490df22da5ade97aedb3fae7786c1c93
+  data.tar.gz: 3d0c3919b223b08aecc6630115d2f6c8ff86eb09
+SHA512:
+  metadata.gz: 6ee0bbd9019da7244ee7a00638db0d10605a23bc3f06a22215baabcf78699f6ab0fb97e94694e31390a133692a51fe36cd7fbe340ee5b8930c703fd8c7bb9595
+  data.tar.gz: 10ca841e6bdcbe41f83ef74ad847c36d1ea42646ac794793f91cb9b01c7c5ba963fbc25b4fa6bc558c948025fb823ce9939c7da955aabf25edeae8be9029572d

data/lib/extended_logger.rb

@@ -0,0 +1,6 @@
+require 'logger'
+
+require 'extended_logger/extended_logger'
+require 'extended_logger/factory'
+require 'extended_logger/formatter'
+require 'extended_logger/colored_formatter'

data/lib/extended_logger/colored_formatter.rb

@@ -0,0 +1,51 @@
+class ExtendedLogger
+  class ColoredFormatter < Formatter
+    ANSI_COLORS = %i(black red green yellow blue magenta cyan white)
+
+    attr_writer :palette
+
+    def bg *args
+      col :bg, *args
+    end
+
+    def call *arguments
+      log_entry = delegate *arguments
+
+      severity = arguments.fetch 0
+      colorizer = palette.fetch severity do
+        -> message { message }
+      end
+
+      instance_exec log_entry, &colorizer
+    end
+
+    def col fgbg, color_code, intensity_code, str
+      color_num = ANSI_COLORS.index color_code
+      intensity_num = { :normal => 0, :bright => 1 }.fetch intensity_code
+      fgbg_num = { :fg => 3, :bg => 4 }.fetch fgbg
+      "\e[#{intensity_num};#{fgbg_num}#{color_num}m#{str}\e[0m"
+    end
+
+    def fg *args
+      col :fg, *args
+    end
+
+    def default_palette
+      @@default_palette ||= {
+        'FOCUS' => -> msg { bg(:blue, :normal, fg(:white, :bright, msg)) },
+        'ANY' => -> msg { bg(:cyan, :normal, fg(:white, :bright, msg)) },
+        'FATAL' => -> msg { bg(:red, :bright, fg(:white, :bright, msg)) },
+        'ERROR' => -> msg { fg(:red, :bright, msg) },
+        'WARN' => -> msg { fg(:yellow, :normal, msg) },
+        'INFO' => -> msg { fg(:green, :normal, msg) },
+        'DEBUG' => -> msg { fg(:blue, :normal, msg) },
+        'TRACE' => -> msg { fg(:magenta, :bright, msg) },
+        'DATA' => -> msg { fg(:cyan, :normal, msg) }
+      }
+    end
+
+    def palette
+      @palette || default_palette
+    end
+  end
+end

data/lib/extended_logger/extended_logger.rb

@@ -0,0 +1,77 @@
+class ExtendedLogger < Logger
+  def self.configure receiver, attribute_name=nil
+    attribute_name ||= 'logger'.freeze
+    setter = "#{attribute_name}=".freeze
+
+    logger = get receiver
+
+    receiver.public_send setter, logger
+  end
+
+  def self.get receiver
+    receiver_name =
+      if receiver.is_a? Module
+        receiver.name
+      else
+        receiver.class.name
+      end
+
+    logger = Factory.()
+
+    logger.progname = "(#{receiver_name})"
+    logger
+  end
+
+  def self.instance
+    @instance ||= Factory.()
+  end
+
+  def self.levels
+    (-5..6)
+  end
+
+  def data *arguments, &block
+    add -2, *arguments, &block
+  end
+
+  def format_severity severity
+    unless self.class.levels.include? severity
+      Kernel.warn "(extended-logger) Unknown log severity level #{severity.inspect}"
+    end
+
+    case severity
+    when -5 then 'OBS_DATA'.freeze
+    when -4 then 'OBS_TRACE'.freeze
+    when -3 then 'OBS_DEBUG'.freeze
+    when -2 then 'DATA'.freeze
+    when -1 then 'TRACE'.freeze
+    when 6 then 'FOCUS'.freeze
+    else super
+    end
+  end
+
+  def io
+    return unless @logdev
+    @logdev.dev
+  end
+
+  def obs_data *arguments, &block
+    add -5, *arguments, &block
+  end
+
+  def obs_debug *arguments, &block
+    add -3, *arguments, &block
+  end
+
+  def obs_trace *arguments, &block
+    add -4, *arguments, &block
+  end
+
+  def trace *arguments, &block
+    add -1, *arguments, &block
+  end
+
+  def focus *arguments, &block
+    add 6, *arguments, &block
+  end
+end

data/lib/extended_logger/factory.rb

@@ -0,0 +1,43 @@
+class ExtendedLogger
+  class Factory
+    attr_reader :env
+
+    def initialize env
+      @env = env
+    end
+
+    def self.build env=nil
+      env ||= ENV
+      new env
+    end
+
+    def self.call *arguments
+      instance = build *arguments
+      instance.()
+    end
+
+    def call
+      logger = ExtendedLogger.new device
+
+      if colors? logger.io
+        logger.formatter = ColoredFormatter.new
+      else
+        logger.formatter = Formatter.new
+      end
+
+      logger
+    end
+
+    def colors? io
+      if io.tty?
+        ENV['LOGGER_COLORS'] != 'off'
+      else
+        ENV['LOGGER_COLORS'] == 'on'
+      end
+    end
+
+    def device
+      ENV['LOGGER_DEVICE'] || $stdout
+    end
+  end
+end

data/lib/extended_logger/formatter.rb

@@ -0,0 +1,39 @@
+class ExtendedLogger
+  class Formatter
+    attr_writer :logger_formatter
+
+    def call *arguments
+      delegate *arguments
+    end
+
+    def delegate *arguments, message
+      message = format_message message, arguments
+      logger_formatter.(*arguments, message)
+    end
+
+    def format_message message, arguments
+      output = ''
+
+      message.each_line "\n".freeze do |line|
+        if line == "\n".freeze
+          line = "\\n"
+        else
+          line.gsub! "\r".freeze, "\\r".freeze
+        end
+
+        if output.empty?
+          output.concat line
+        else
+          formatted_line = logger_formatter.(*arguments, line.chomp("\n".freeze))
+          output.concat formatted_line
+        end
+      end
+
+      output.chomp "\n".freeze
+    end
+
+    def logger_formatter
+      @logger_formatter ||= Logger::Formatter.new
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: extended-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Ladd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-18 00:00:00.000000000 Z
+dependencies: []
+description: |
+  extended-logger provides a richer logger implementation than the built in ruby
+  logger, offering more log levels and colors. In addition, loggers can be
+  constructed for your classes and modules, which include the constant name in
+  output for easy filtering.
+email: nathanladd+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/extended_logger.rb
+- lib/extended_logger/colored_formatter.rb
+- lib/extended_logger/extended_logger.rb
+- lib/extended_logger/factory.rb
+- lib/extended_logger/formatter.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Provides an extended logger offering more features than the ruby logger
+test_files: []
+has_rdoc: