extended_logger 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e17adf2ff984b9032f24ae1c8253fa753c600beb
+  data.tar.gz: 2dbdeac01270bd403e35782cec74e12a63ad3bc0
+SHA512:
+  metadata.gz: 93dcd7c69d32947290d0e24c7d0d737cca08d09190c25fda35fac973a0e8dc88eb35bd32310fa600943a0e36c3879efe08c8ecd9f9cd58d79737adec12a540c4
+  data.tar.gz: 1e5e1ffedbf2e93942250d19eab316efdd303d23f87536f402c741610a8d83b266aff747bf5cccd30306f9320efc25cb02e4c37ff99d9256cf8bbd6e5090b69d

data/lib/extended_logger/extended_logger.rb

@@ -0,0 +1,74 @@
+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
+    @levels ||= {
+      -7 => 'OBSOLETE'.freeze,
+      -6 => 'OPT_DATA'.freeze,
+      -5 => 'OPT_TRACE'.freeze,
+      -4 => 'OPT_DEBUG'.freeze,
+      -3 => 'DATA'.freeze,
+      -2 => 'TRACE'.freeze,
+      -1 => 'DEBUG'.freeze,
+      0 => 'INFO'.freeze,
+      1 => 'PASS'.freeze,
+      2 => 'FAIL'.freeze,
+      3 => 'FOCUS'.freeze,
+      4 => 'WARN'.freeze,
+      5 => 'ERROR'.freeze,
+      6 => 'FATAL'.freeze,
+    }
+  end
+
+  def self.level? level
+    levels.key? level
+  end
+
+  def format_severity severity
+    unless self.class.level? severity
+      Kernel.warn "(extended-logger) Unknown log severity level #{severity.inspect}"
+    end
+
+    self.class.levels.fetch severity, 'ANY'.freeze
+  end
+
+  def io
+    return unless @logdev
+    @logdev.dev
+  end
+
+  def unknown *arguments, &block
+    add 7, *arguments, &block
+  end
+
+  levels.each do |level, name|
+    define_method name.downcase do |*arguments, &block|
+      add level, *arguments, &block
+    end
+  end
+end

data/lib/extended_logger/factory.rb

@@ -0,0 +1,51 @@
+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
+
+      formatter = Formatter.new
+      formatter.palette = Formatter.default_palette if colors? logger.io
+      logger.formatter = formatter
+
+      level = self.level
+      logger.level = level if level
+
+      logger
+    end
+
+    def colors? io
+      if io.tty?
+        ENV['LOG_COLOR'] != 'off'
+      else
+        ENV['LOG_COLOR'] == 'on'
+      end
+    end
+
+    def device
+      ENV['LOG_DEVICE'] || $stderr
+    end
+
+    def level
+      if ENV.key? 'LOG_LEVEL'
+        level , _ = ExtendedLogger.levels.rassoc ENV['LOG_LEVEL'].upcase
+        level
+      end
+    end
+  end
+end

data/lib/extended_logger/formatter.rb

@@ -0,0 +1,89 @@
+class ExtendedLogger
+  class Formatter
+    attr_writer :logger_formatter
+    attr_writer :palette
+
+    def call severity, *arguments
+      log_entry = delegate severity, *arguments
+      color log_entry, severity
+    end
+
+    def color log_entry, severity
+      colorizer = palette[severity]
+
+      if colorizer
+        log_entry = "#{colorizer}#{log_entry}\e[0m"
+      end
+
+      log_entry
+    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
+
+    def palette
+      @palette ||= {}
+    end
+
+    def self.ansi_colors
+      @ansi_colors ||= %i(black red green yellow blue magenta cyan white)
+    end
+
+    def self.col fg, brightness, bg=nil
+      brightness = { :bright => 1, :normal => 0 }.fetch brightness
+      escape = "\e[#{brightness};3#{ansi_colors.index fg}m"
+
+      if bg
+        escape << "\e[4#{ansi_colors.index bg}m"
+      end
+
+      escape
+    end
+
+    def self.default_palette
+      @default_palette ||= {
+        'OBSOLETE' => col(:black, :normal),
+        'DATA' => col(:green, :normal),
+        'TRACE' => col(:cyan, :normal),
+        'DEBUG' => col(:blue, :normal),
+        'OPT_DATA' => col(:green, :normal, :white),
+        'OPT_TRACE' => col(:cyan, :normal, :white),
+        'OPT_DEBUG' => col(:blue, :normal, :white),
+        'PASS' => col(:white, :bright, :green),
+        'FAIL' => col(:white, :bright, :red),
+        'FOCUS' => col(:white, :bright, :blue),
+        'WARN' => col(:yellow, :normal),
+        'ERROR' => col(:red, :normal),
+        'FATAL' => col(:black, :bright, :red),
+        'ANY' => col(:white, :bright, :magenta),
+      }
+    end
+  end
+end

data/lib/extended_logger.rb

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

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: extended_logger
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nathan Ladd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-19 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/extended_logger.rb
+- lib/extended_logger/factory.rb
+- lib/extended_logger/formatter.rb
+homepage: https://github.com/ntl/extended-logger
+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: