yarl 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8667a010c10f84b711d176e9fa7c905fd0b935c1
-  data.tar.gz: 9c9538e32bd3bd85c1ab7792058345951d8dfb4a
+SHA256:
+  metadata.gz: 765b0c1c815784ba8772409a9387a7597942594e011b41c25862abb6b0953ee7
+  data.tar.gz: 8a6f8e5d7ca40784d7fb5e87c5928986c094f7820e8cbd8fdea212283febe6ba
 SHA512:
-  metadata.gz: aeca54c95ceff332b61058cfb5b28350517fbdb73a1e90285cb75090b752c5701fc92780228f9b33a48801dc3455b038fbd8fc488a3668203502a8d77f418f38
-  data.tar.gz: ce028eeef43c42e65ce26ba2fa0379398be65a609adaac460c6ac7d6c25016e28fd3d32d097ed6d37cc4a4707713d9b44dda369680029a72c684544c3eefc72f
+  metadata.gz: e4a981724da9ecf40bfe3071f27778f9130c3fe281f9ae1a117ef1f891eb53fa417cd7df2233494ebbafb22c554ba516eb363a044aeb0f943399d0531da69fa1
+  data.tar.gz: 35398ee9f6228e3161faf65e7fabaef1ab9cf6dac45cee8a3613c70d5eab41d0982c7a56ae59c84e883833647f05bcc5ffd7a23119820d31d21cf5c31a9f8bfe

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.ruby-version
 .bundle
 .config
 Gemfile.lock

data/README.md

@@ -0,0 +1,61 @@
+# YARL - Yet Another Ruby Logger
+YARL is a [ruby/logger](https://github.com/ruby/logger) extension that provides:
+- Full [ANSI 4-bit color](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors) support
+- SPAM -- a severity level lower than DEBUG
+- Clean, low-clutter formatting
+- Common defaults, like writing to STDOUT
+
+As an extension, `logger` is fully implemented.
+
+## Color Support
+YARL supports 4-bit ANSI colors -- both text and background -- in the logger header.
+
+![[citation needed]](../master/media/tests_colors.png?raw=true)
+
+Additionally, the following severity levels have message colors:
+- `FATAL` has a background color -- defaults to red
+- `ERROR` has a text color -- defaults to red
+- `SPAM` has a text color -- defaults to bright black
+
+![Levels and their colors](../master/media/tests_levels.png?raw=true)
+
+## Installation
+Add this line to your application's Gemfile:
+
+`gem 'yarl'`
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install yarl`
+
+## Usage
+
+### Simple Example
+
+```ruby
+require 'yarl'
+
+logger = YARL.new "Simple Example", color: :green
+logger.info "Hello, World!"
+```
+
+will produce
+![A simple example](../master/media/examples_simple.png?raw=true)
+
+### Complex Example
+
+Please see [examples/complex.rb](../master/examples/complex.rb) for the source code.
+
+This example will produce
+![A complex example](../master/media/examples_complex.png?raw=true)
+
+## Contributing
+
+Feel free to [make an issue](https://github.com/david-massey/yarl/issues/new), and I will do my best to respond quickly.
+
+Or, fork it, edit it, and pull request.
+

data/examples/complex.rb

@@ -0,0 +1,24 @@
+require 'yarl'
+
+module Some
+  class Klass
+    attr_accessor :logger
+
+    def initialize
+      @logger = YARL.new\
+        self.class,
+        destination: STDERR,
+        color: :bright_magenta,
+        datetime_format: '%H:%M:%S.%6NZ',
+        spam_color: :black # I *never* want to see SPAM
+    end
+
+    def add(x, y)
+      @logger.spam { x + y }
+      x + y
+    end
+  end
+end
+
+complex = Some::Klass.new
+complex.logger.info complex.add('Hello, ', 'World!')

data/examples/simple.rb

@@ -0,0 +1,4 @@
+require 'yarl'
+
+logger = YARL.new "Simple Example", color: :green
+logger.info "Hello, World!"

data/lib/yarl/version.rb

@@ -1,3 +1,3 @@
 class YARL
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/yarl.rb

@@ -4,6 +4,10 @@ class YARL < Logger # Yet Another Ruby Logger
   module Severity
     include Logger::Severity
 
+    # Normal but significant conditions
+    # Conditions that are not error/warning conditions, but that may require special handling.
+    NOTICE = 1.5
+
     # For that time you need more messages that annoy the hell out of everyone else.
     # These should rarely -- if ever -- be displayed.
     SPAM = -1
@@ -11,37 +15,47 @@ class YARL < Logger # Yet Another Ruby Logger
 
   include Severity
 
-  def initialize(progname = nil, **kwargs)
+  def initialize progname = nil, **kwargs
     destination = kwargs[:destination] || STDOUT
     super destination
 
-    @progname  = progname.nil? ? self.class : progname
-    @level = kwargs[:level] || INFO
+    @progname = progname.nil? ? self.class : progname
+    @level    = kwargs[:level] || INFO
 
     # Header colors
-    @color      =       text_color(kwargs[:color] || :light_white)
-    @background = background_color(kwargs[:background] || :black)
+    color       =       text_color(kwargs[:color] || kwargs[:header])
+    background  = background_color(kwargs[:background])
+    @header     = format_code color, background
+
+    # Default body colors
+    @body       =       text_color(kwargs[:body])
 
-    # Body colors
-    @fatal_color = background_color(kwargs[:fatal_color] || :red)
-    @error_color =       text_color(kwargs[:error_color] || :red)
-    @spam_color  =       text_color(kwargs[:spam_color]  || :bright_black)
+    # Automatic body colors
+    @fatal_body = background_color(kwargs[:fatal] || kwargs[:fatal_color] || :red)
+    @error_body =       text_color(kwargs[:error] || kwargs[:error_color] || :red)
+    @warn_body  =       text_face (kwargs[:warn]  || kwargs[:warn_face]   || :bold)
+    @spam_body  =       text_color(kwargs[:spam]  || kwargs[:spam_color]  || :bright_black)
 
     # Log formatting
     @datetime_format = kwargs[:datetime_format] || '%Y-%m-%dT%H:%M:%S.%3NZ'
+    if kwargs[:ascii8bit]
+      @to_hex_regex = /([^ -~])/no
+    elsif !(kwargs[:printable] === false)
+      @to_hex_regex = /([\x00-\x19])/o
+    end
 
     if kwargs[:formatter].is_a?(Proc)
       @formatter = kwargs[:formatter]
     else
       @formatter ||= proc { |severity, datetime, progname, message|
         datetime = datetime.strftime(@datetime_format)
-        "\e[#{@color};#{@background}m#{datetime} #{severity[0]} #{progname}\e[0m #{message}\n"
+        "\e[#{@header}m#{datetime} #{severity[0]} #{progname}\e[#{@body}m #{message}\e[0m\n"
       }
     end
   end
 
   # A basic rewrite of Logger.add to support message body colors.
-  def add(severity, message = nil, progname = nil)
+  def add severity, message = nil, progname = nil
     severity ||= UNKNOWN
     return true if @logdev.nil? or severity < @level
 
@@ -50,13 +64,17 @@ class YARL < Logger # Yet Another Ruby Logger
 
     progname = @progname if message == progname
 
+    message.gsub!(@to_hex_regex) {|c| "[%02X]" % c.ord} if @to_hex_regex
+
     case severity
     when FATAL
-      message = "\e[#{@fatal_color}m#{message}\e[0m"
+      message = "\e[#{@fatal_body}m#{message}"
     when ERROR
-      message = "\e[#{@error_color}m#{message}\e[0m"
+      message = "\e[#{@error_body}m#{message}"
+    when WARN
+      message = "\e[#{@warn_body}m#{message}"
     when SPAM
-      message = "\e[#{@spam_color}m#{message}\e[0m"
+      message = "\e[#{@spam_body}m#{message}"
     end
 
     @logdev.write(
@@ -71,12 +89,14 @@ class YARL < Logger # Yet Another Ruby Logger
     true
   end
 
-  # SPAM support
-  # Add SPAM to level setter
-  def level=(severity)
+  # SPAM and NOTICE support
+  # Add to level setter
+  def level= severity
     severity = severity.to_s if severity.is_a?(Symbol)
 
     case severity
+    when 'notice'
+      @level = NOTICE
     when 'spam'
       @level = SPAM
     else
@@ -84,14 +104,20 @@ class YARL < Logger # Yet Another Ruby Logger
     end
   end
 
-  # Returns +true+ iff the current severity level allows for the printing of SPAM
+  # Returns +true+ iff the current severity level allows
+  def notice?; @level <= NOTICE; end
   def spam?; @level <= SPAM; end
 
   # Sets the severity to SPAM.
+  def notice!; self.level = NOTICE; end
   def spam!; self.level = SPAM; end
 
-  # Log a +DEBUG+ message.
-  def spam(progname = nil, &block)
+  # Log a +NOTICE+ message.
+  def notice progname = nil, &block
+    add(NOTICE, nil, progname, &block)
+  end
+  # Log a +SPAM+ message.
+  def spam progname = nil, &block
     add(SPAM, nil, progname, &block)
   end
 
@@ -101,23 +127,50 @@ class YARL < Logger # Yet Another Ruby Logger
     SPAM    => 'SPAM',
     DEBUG   => 'DEBUG',
     INFO    => 'INFO',
+    NOTICE  => 'NOTICE',
     WARN    => 'WARN',
     ERROR   => 'ERROR',
     FATAL   => 'FATAL',
     UNKNOWN => 'UNKWN'
   }
 
-  def format_severity(severity)
+  def format_severity severity
     SEV_LABEL[severity] || 'ANY'
   end
 
+  def format_code color, background = 0
+    if color > 0 && background > 0
+      "#{color};#{background}"
+    elsif color > 0
+      "#{color}"
+    elsif background > 0
+      "#{background}"
+    else
+      '0'
+    end
+  end
+
+  # Font Face Methods
+  def text_face mode
+    return FACE_MODES[mode]
+  end
+
+  FACE_MODES = {
+    :reset      => 0,
+    :bold       => 1,
+    :underscore => 4,
+    :blink      => 5 # Please don't...
+  }
+
   # Color Methods
-  def text_color(color)
-    (COLOR_CODES[color] || 67) + 30
+  def text_color color
+    return (COLOR_CODES[color] || 67) + 30 if color
+    return 0
   end
 
-  def background_color(color)
-    (COLOR_CODES[color] ||  0) + 40
+  def background_color color
+    return (COLOR_CODES[color] ||  0) + 40 if color
+    return 0
   end
 
   COLOR_CODES = {

data/tests/benchmarks.rb

@@ -1,5 +1,5 @@
 require 'logger'
-require_relative '../lib/yarl'
+require 'yarl'
 
 times = 1_000_000
 

data/tests/colors.rb

@@ -1,4 +1,4 @@
-require '../lib/yarl'
+require 'yarl'
 
 module Mocks
   class Klass

data/tests/levels.rb

@@ -1,14 +1,15 @@
-require '../lib/yarl'
+require_relative '../lib/yarl'
 
 logger = YARL.new color: :green
 
 def test_levels(logger)
   logger.fatal  "It's just a flesh wound!"
   logger.error  'PC LOAD LETTER'
-  logger.warn   'Danger Will Robinson!'
+  logger.warn   'Here there be dragons!'
+  logger.notice 'In order to build a hyperspatial express route, Earth will be destroyed.'
   logger.info   'The more you know'
-  logger.debug  'Better call Terminex'
-  logger.spam   'Nobody likes spam'
+  logger.debug  'Better call Terminix'
+  logger.spam   "Nobody likes spam\r\n"
 end
 
 puts "YARL logger level defaults to INFO"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Massey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-23 00:00:00.000000000 Z
+date: 2019-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -50,8 +50,15 @@ files:
 - ".gitignore"
 - Gemfile
 - LICENSE
+- README.md
+- examples/complex.rb
+- examples/simple.rb
 - lib/yarl.rb
 - lib/yarl/version.rb
+- media/examples_complex.png
+- media/examples_simple.png
+- media/tests_colors.png
+- media/tests_levels.png
 - tests/benchmarks.rb
 - tests/colors.rb
 - tests/levels.rb
@@ -75,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Logger extension that provides colors and clean, default formatting.