yarl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8667a010c10f84b711d176e9fa7c905fd0b935c1
+  data.tar.gz: 9c9538e32bd3bd85c1ab7792058345951d8dfb4a
+SHA512:
+  metadata.gz: aeca54c95ceff332b61058cfb5b28350517fbdb73a1e90285cb75090b752c5701fc92780228f9b33a48801dc3455b038fbd8fc488a3668203502a8d77f418f38
+  data.tar.gz: ce028eeef43c42e65ce26ba2fa0379398be65a609adaac460c6ac7d6c25016e28fd3d32d097ed6d37cc4a4707713d9b44dda369680029a72c684544c3eefc72f

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+test/tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 David Massey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/yarl/version.rb

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

data/lib/yarl.rb

@@ -0,0 +1,133 @@
+require 'logger'
+
+class YARL < Logger # Yet Another Ruby Logger
+  module Severity
+    include Logger::Severity
+
+    # For that time you need more messages that annoy the hell out of everyone else.
+    # These should rarely -- if ever -- be displayed.
+    SPAM = -1
+  end
+
+  include Severity
+
+  def initialize(progname = nil, **kwargs)
+    destination = kwargs[:destination] || STDOUT
+    super destination
+
+    @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)
+
+    # 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)
+
+    # Log formatting
+    @datetime_format = kwargs[:datetime_format] || '%Y-%m-%dT%H:%M:%S.%3NZ'
+
+    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"
+      }
+    end
+  end
+
+  # A basic rewrite of Logger.add to support message body colors.
+  def add(severity, message = nil, progname = nil)
+    severity ||= UNKNOWN
+    return true if @logdev.nil? or severity < @level
+
+    progname  ||= @progname
+    message   ||= block_given? ? yield : progname
+
+    progname = @progname if message == progname
+
+    case severity
+    when FATAL
+      message = "\e[#{@fatal_color}m#{message}\e[0m"
+    when ERROR
+      message = "\e[#{@error_color}m#{message}\e[0m"
+    when SPAM
+      message = "\e[#{@spam_color}m#{message}\e[0m"
+    end
+
+    @logdev.write(
+      format_message(
+        format_severity(severity),
+        Time.now.utc,
+        progname,
+        message
+      )
+    )
+
+    true
+  end
+
+  # SPAM support
+  # Add SPAM to level setter
+  def level=(severity)
+    severity = severity.to_s if severity.is_a?(Symbol)
+
+    case severity
+    when 'spam'
+      @level = SPAM
+    else
+      super
+    end
+  end
+
+  # Returns +true+ iff the current severity level allows for the printing of SPAM
+  def spam?; @level <= SPAM; end
+
+  # Sets the severity to SPAM.
+  def spam!; self.level = SPAM; end
+
+  # Log a +DEBUG+ message.
+  def spam(progname = nil, &block)
+    add(SPAM, nil, progname, &block)
+  end
+
+  private
+
+  SEV_LABEL = {
+    SPAM    => 'SPAM',
+    DEBUG   => 'DEBUG',
+    INFO    => 'INFO',
+    WARN    => 'WARN',
+    ERROR   => 'ERROR',
+    FATAL   => 'FATAL',
+    UNKNOWN => 'UNKWN'
+  }
+
+  def format_severity(severity)
+    SEV_LABEL[severity] || 'ANY'
+  end
+
+  # Color Methods
+  def text_color(color)
+    (COLOR_CODES[color] || 67) + 30
+  end
+
+  def background_color(color)
+    (COLOR_CODES[color] ||  0) + 40
+  end
+
+  COLOR_CODES = {
+    :black    => 0, :bright_black   => 60,
+    :red      => 1, :bright_red     => 61,
+    :green    => 2, :bright_green   => 62,
+    :yellow   => 3, :bright_yellow  => 63,
+    :blue     => 4, :bright_blue    => 64,
+    :magenta  => 5, :bright_magenta => 65,
+    :cyan     => 6, :bright_cyan    => 66,
+    :white    => 7, :bright_gray    => 67,
+  }
+end

data/tests/benchmarks.rb

@@ -0,0 +1,58 @@
+require 'logger'
+require_relative '../lib/yarl'
+
+times = 1_000_000
+
+def benchmark(method, times = 1000)
+  destination = STDOUT
+
+  start_time = Time.now
+
+  case method
+  when :puts
+    (1..times).each do |message_number|
+      puts "puts Message #{message_number}"
+    end
+  when :logger
+    logger = Logger.new(destination)
+
+    (1..times).each do |message_number|
+      logger.info "logger Message #{message_number}"
+    end
+  when :yarl
+    yarl = YARL.new "YARL"
+
+    (1..times).each do |message_number|
+      yarl.info "yarl Message #{message_number}"
+    end
+  when :yarl_color
+    yarl = YARL.new "YARL", color: :blue
+
+    (1..times).each do |message_number|
+      yarl.info "yarl Message #{message_number}"
+    end
+  when :destination
+    (1..times).each do |message_number|
+      destination << "#{destination} << Message #{message_number}\n"
+    end
+  end
+
+  end_time = Time.now
+
+  return end_time - start_time
+end
+
+elapsed = {}
+elapsed[:puts]        = benchmark(:puts, times)
+elapsed[:logger]      = benchmark(:logger, times)
+elapsed[:yarl]        = benchmark(:yarl, times)
+elapsed[:yarl_color]  = benchmark(:yarl_color, times)
+elapsed[:stdout]      = benchmark(:destination, times)
+
+shortest = elapsed.values.min
+puts "#{times} messages. #{elapsed.key shortest} took the least time (#{shortest}s)."
+puts "puts        => #{elapsed[:puts]}s"        # =>  4.348134s
+puts "logger      => #{elapsed[:logger]}s"      # => 11.266948s
+puts "yarl        => #{elapsed[:yarl]}s"        # => 10.685384s
+puts "yarl_color  => #{elapsed[:yarl_color]}s"  # => 10.699868s
+puts "`STDOUT <<` => #{elapsed[:stdout]}s"      # =>  5.835941s

data/tests/colors.rb

@@ -0,0 +1,72 @@
+require '../lib/yarl'
+
+module Mocks
+  class Klass
+    def initialize(**kwargs)
+      if kwargs.empty?
+        klass_color = self.class.to_s.split('::')[1]
+        color = klass_color.downcase.sub(/\Abright/, 'bright_').to_sym
+      end
+
+      color ||= kwargs[:color] || :invalid
+      background = kwargs[:background] || :invalid
+
+      @logger = YARL.new self.class, color: color, background: background
+      @logger.info "Initialized"
+    end
+  end
+
+  class Black         < Klass ; end
+  class BrightBlack   < Klass ; end
+  class White         < Klass ; end
+  class BrightWhite   < Klass ; end
+  class Red           < Klass ; end
+  class BrightRed     < Klass ; end
+  class Green         < Klass ; end
+  class BrightGreen   < Klass ; end
+  class Yellow        < Klass ; end
+  class BrightYellow  < Klass ; end
+  class Blue          < Klass ; end
+  class BrightBlue    < Klass ; end
+  class Magenta       < Klass ; end
+  class BrightMagenta < Klass ; end
+  class Cyan          < Klass ; end
+  class BrightCyan    < Klass ; end
+end
+
+# Text Colors
+Mocks::Klass.new
+Mocks::Black.new
+Mocks::BrightBlack.new
+Mocks::White.new
+Mocks::BrightWhite.new
+Mocks::Red.new
+Mocks::BrightRed.new
+Mocks::Green.new
+Mocks::BrightGreen.new
+Mocks::Yellow.new
+Mocks::BrightYellow.new
+Mocks::Blue.new
+Mocks::BrightBlue.new
+Mocks::Magenta.new
+Mocks::BrightMagenta.new
+Mocks::Cyan.new
+Mocks::BrightCyan.new
+
+# Background Colors
+Mocks::Black.new          background: :black
+Mocks::BrightBlack.new    background: :bright_black
+Mocks::White.new          background: :white
+Mocks::BrightWhite.new    background: :bright_white
+Mocks::Red.new            background: :red
+Mocks::BrightRed.new      background: :bright_red
+Mocks::Green.new          background: :green
+Mocks::BrightGreen.new    background: :bright_green
+Mocks::Yellow.new         background: :yellow
+Mocks::BrightYellow.new   background: :bright_yellow
+Mocks::Blue.new           background: :blue
+Mocks::BrightBlue.new     background: :bright_blue
+Mocks::Magenta.new        background: :magenta
+Mocks::BrightMagenta.new  background: :bright_magenta
+Mocks::Cyan.new           background: :cyan
+Mocks::BrightCyan.new     background: :bright_cyan

data/tests/levels.rb

@@ -0,0 +1,23 @@
+require '../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.info   'The more you know'
+  logger.debug  'Better call Terminex'
+  logger.spam   'Nobody likes spam'
+end
+
+puts "YARL logger level defaults to INFO"
+test_levels logger
+
+puts "\nAfter level changes to debug"
+logger.level = :debug
+test_levels logger
+
+puts "\nAfter level changes to spam"
+logger.level = :spam
+test_levels logger

data/yarl.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yarl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yarl'
+  spec.version       = YARL::VERSION
+  spec.authors       = ['David Massey']
+  spec.email         = ['ominousskitter@protonmail.com']
+  spec.summary       = %q{Logger extension that provides colors and clean, default formatting.}
+  spec.description   = %q{Yet Another Ruby Logger (YARL) extends ruby/logger to provide header colors and a severity level below DEBUG. The default formatting has been changed to provide a cleaner (subjective) look.}
+  spec.homepage      = "https://github.com/david-massey/yarl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_dependency "logger", "~> 1.3"
+
+  spec.add_development_dependency "bundler"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: yarl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Massey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Yet Another Ruby Logger (YARL) extends ruby/logger to provide header
+  colors and a severity level below DEBUG. The default formatting has been changed
+  to provide a cleaner (subjective) look.
+email:
+- ominousskitter@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- lib/yarl.rb
+- lib/yarl/version.rb
+- tests/benchmarks.rb
+- tests/colors.rb
+- tests/levels.rb
+- yarl.gemspec
+homepage: https://github.com/david-massey/yarl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Logger extension that provides colors and clean, default formatting.
+test_files: []