logging_library 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f72e7d15d7d2da84c698f410c97268c48917f709
+  data.tar.gz: 2c7fd595e3ba4b99d41b8c810e699480050f3c9b
+SHA512:
+  metadata.gz: 5808dc5f7f9883cd23c506cc70ca3ef97991a381c3179b865b22dafc933e4cf2cc9efb1674af041dbd97455fd9cb1502de62fff645c5183d540f1d8e8fe61e2d
+  data.tar.gz: '018d3c1b6cc34c98e2e20372cb12f2ca7ac451f75bc75b2a55e557eccaea207502c3867ada1aa37c64368ec10af90b25e83315977b63de8f82ec2466e4c511d4'

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,4 @@
+-I.
+--format documentation
+--color
+-rspec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+Lint/EndAlignment:
+  AlignWith: variable
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+Metrics/LineLength:
+  Max: 132
+Metrics/MethodLength:
+  Severity: warning
+
+# Rationale: allow Weirich-style blocks
+Style/BlockDelimiters:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+Style/FileName:
+  Enabled: false
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-03-17 11:15:17 +0200 using RuboCop version 0.46.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/BlockLength:
+  Max: 86

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install:
+  - gem update --system
+  - gem install bundler -v 1.13.6

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --no-private

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at per.lundberg@ecraft.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ecraft-logging_library.gemspec
+gemspec
+
+group :development do
+  gem 'yard'
+end

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) eCraft Oy Ab and Contributors
+
+All rights reserved.
+
+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/README.md

@@ -0,0 +1,88 @@
+[![Build Status](https://travis-ci.org/ecraft/logging_library.svg?branch=master)](https://travis-ci.org/ecraft/logging_library)
+
+# LoggingLibrary
+
+This library provides logging support for your application or framework, with an opinionated default configuration in terms of log
+format, etc.
+
+It is compatible with both JRuby and MRI.
+
+Wraps the functionality of [mixlog-log](https://github.com/chef/mixlib-log).
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'logging_library'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+```ruby
+require 'logging_library'
+
+class MyClass
+  include LoggingLibrary::Loggable
+
+  def load_data_from_database
+    logger.info('Starting to load data from database')
+
+    # DEBUG-level messages are not printed by default; see logger#level= if you
+    # want to customize the log level.
+    logger.debug("Running as user #{current_user}")
+
+    # If you use blocks to wrap log messages, they'll only execute if needed
+    logger.debug { "Score for all participants: #{expensive_operation}" }
+  end
+
+  def current_user
+    'john_doe'
+  end
+
+  def expensive_operation
+    sleep 5
+    9_000
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/ecraft/logging_library. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+### Documentation
+
+We strive to write API documentation inline in [YARD](http://yardoc.org) format.
+
+Generate API documentation using `yardoc` or `rake yard`.
+
+Preview API documentation locally with
+
+```
+bundle exec yard server -r
+```
+
+### License
+
+MIT

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  task :spec
+end
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ecraft/logging_library'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'ecraft/logging_library'
+
+Rainbow.enabled = true
+
+class SomeClass
+  include Ecraft::LoggingLibrary::Loggable
+
+  def initialize
+    logger.level = :debug
+  end
+
+  def colortest
+    logger.fatal('This is a fatal error')
+    logger.error('This is a non-fatal error')
+    logger.warn('This is a warning. No need to panic.')
+    logger.info('This is just regular info.')
+    logger.debug('This is a debug message that most applications will have disabled.')
+  end
+end
+
+SomeClass.new.colortest

data/lib/ecraft/logging_library.rb

@@ -0,0 +1,4 @@
+module Ecraft
+  # For backwards compatibility, since this library used to be called ecraft-logging_library before it was released as FOSS.
+  LoggingLibrary = ::LoggingLibrary
+end

data/lib/logging_library.rb

@@ -0,0 +1,9 @@
+require 'logging_library/custom_formatter'
+require 'logging_library/logger_factory'
+require 'logging_library/logger'
+require 'logging_library/mixins/loggable'
+require 'logging_library/version'
+
+module LoggingLibrary
+  Loggable = Mixins::Loggable
+end

data/lib/logging_library/custom_formatter.rb

@@ -0,0 +1,127 @@
+require 'logger'
+require 'rainbow'
+
+module LoggingLibrary
+  #
+  # Handles log formatting. Not intended to be used from user code.
+  #
+  class CustomFormatter < ::Logger::Formatter
+    DATE_PATTERN = '%Y-%m-%d %H:%M:%S.%L'.freeze
+
+    LogMessage = Struct.new(:severity, :time, :logger_name, :message) do
+      LINE_PREPEND = ' ' * 8
+
+      def to_formatted_string
+        if show_time?
+          format("%s %s %s %s\n", formatted_colored_severity, formatted_colored_time,
+                  formatted_colored_logger_name, colored_message)
+        else
+          format("%-5s %s %s\n", formatted_colored_severity, formatted_colored_logger_name, colored_message)
+        end
+      end
+
+      def colored_message
+        return formatted_message unless Rainbow.enabled
+        Rainbow(formatted_message).color(text_color_for_severity)
+      end
+
+      # Converts some argument to a Logger.severity() call to a string.  Regular strings pass through like
+      # normal, Exceptions get formatted as "message (class)\nbacktrace", and other random stuff gets
+      # put through "object.inspect"
+      def formatted_message
+        case message
+        when ::String
+          message
+        when ::Exception
+          "#{message.message} (#{message.class})\n" +
+            LINE_PREPEND +
+            (message.backtrace || []).join("\n#{LINE_PREPEND}")
+        else
+          message.inspect
+        end
+      end
+
+      def formatted_colored_severity
+        if Rainbow.enabled
+          Rainbow(formatted_severity).color(color_for_severity)
+        else
+          formatted_severity
+        end
+      end
+
+      def formatted_colored_time
+        if Rainbow.enabled
+          Rainbow(formatted_time).color(time_color_for_severity)
+        else
+          formatted_severity
+        end
+      end
+
+      def formatted_colored_logger_name
+        return formatted_logger_name unless Rainbow.enabled
+
+        Rainbow(formatted_logger_name).color(text_color_for_severity)
+      end
+
+      def formatted_severity
+        format('%-5s', severity)
+      end
+
+      def formatted_time
+        '[' + time.strftime(DATE_PATTERN) + ']'
+      end
+
+      def formatted_logger_name
+        logger_name + ':'
+      end
+
+      def color_for_severity
+        if show_time?
+          text_color_for_severity
+        else
+          color_for_severity_lighter
+        end
+      end
+
+      def text_color_for_severity
+        case severity.downcase.to_sym
+        when :fatal then :magenta
+        when :error then :red
+        when :warn  then :yellow
+        when :info  then :gray
+        when :debug then '#606060'
+        else :gray
+        end
+      end
+
+      # Returns a somewhat lighter color for the time, to make it stand out in the presentation.
+      def time_color_for_severity
+        case severity.downcase.to_sym
+        when :fatal then '#FF00FF'
+        when :error then '#FF0000'
+        when :warn  then '#FFFF00'
+        when :info  then '#FFFFFF'
+        when :debug then '#808080'
+        else :gray
+        end
+      end
+
+      # We want "something" to stand out. If time isn't being shown, we utilize its color for displaying the severity.
+      alias_method :color_for_severity_lighter, :time_color_for_severity
+
+      def show_time?
+        # When STDERR is redirected, we are likely running as a service with a syslog daemon already appending a timestamp to the
+        # line (and two timestamps is redundant).
+        tty?
+      end
+
+      def tty?
+        $stderr.tty?
+      end
+    end
+
+    def call(severity, time, progname, message)
+      LogMessage.new(severity, time, progname, message).to_formatted_string
+    end
+  end
+end

data/lib/logging_library/logger.rb

@@ -0,0 +1,23 @@
+require 'forwardable'
+require 'mixlib/log'
+
+module LoggingLibrary
+  #
+  # Responsible for printing out log messages. Not intended to be used directly from user code; use the Loggable mixin
+  # (preferred) or LoggerFactory (secondary choice) to create a logger.
+  #
+  class Logger
+    include Mixlib::Log
+    extend Forwardable
+
+    def_delegator :logger, :progname, :name
+
+    def initialize(name)
+      init($stderr)
+
+      logger.level = :info
+      logger.progname = name
+      logger.formatter = CustomFormatter.new
+    end
+  end
+end

data/lib/logging_library/logger_factory.rb

@@ -0,0 +1,17 @@
+module LoggingLibrary
+  #
+  # Module responsible for instantiating logger objects.
+  #
+  module LoggerFactory
+    module_function
+
+    # Creates a new `Logger` object.
+    #
+    # @param name [String] An optional parameter for overriding the name of the logger. If not provided, a default will be
+    #   determined automatically.
+    def create(name = nil)
+      logger_name = name || caller[0][/`.*'/][1..-2]
+      Logger.new(logger_name)
+    end
+  end
+end

data/lib/logging_library/mixins/loggable.rb

@@ -0,0 +1,29 @@
+module LoggingLibrary
+  module Mixins
+    #
+    # Mixin for adding a lazily-instantiated `logger` attribute to your class, with reasonable defaults based on the class name.
+    #
+    module Loggable
+      def logger
+        @logger ||= LoggerFactory.create(_logger_name)
+      end
+
+      private
+
+      def _logger_name
+        # Handle both `extend` and `include` use cases.
+        if self.class == Class
+          _short_class_name(to_s)
+        else
+          _short_class_name(self.class.name)
+        end
+      end
+
+      def _short_class_name(full_name)
+        # ClassThatIncludesLoggable vs Ecraft::LoggingLibrary::ClassThatIncludesLoggable. The latter feels overly detailed;
+        # there are hopefully not that many classes with the same name in an application...
+        full_name.split('::').last
+      end
+    end
+  end
+end

data/lib/logging_library/version.rb

@@ -0,0 +1,3 @@
+module LoggingLibrary
+  VERSION = '1.0.4'.freeze
+end

data/logging_library.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logging_library/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'logging_library'
+  spec.version       = LoggingLibrary::VERSION
+  spec.authors       = ['Tre Kronor']
+  spec.email         = ['team.trekronor@ecraft.com']
+
+  spec.summary       = 'Logging library'
+  spec.description   = 'Library with support for logging in applications.'
+  spec.homepage      = 'https://github.com/ecraft/logging_library'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'mixlib-log', '~> 1.7'
+  spec.add_runtime_dependency 'rainbow', '~> 2.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.5'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.46'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: logging_library
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- Tre Kronor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-log
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Library with support for logging in applications.
+email:
+- team.trekronor@ecraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/test.rb
+- lib/ecraft/logging_library.rb
+- lib/logging_library.rb
+- lib/logging_library/custom_formatter.rb
+- lib/logging_library/logger.rb
+- lib/logging_library/logger_factory.rb
+- lib/logging_library/mixins/loggable.rb
+- lib/logging_library/version.rb
+- logging_library.gemspec
+homepage: https://github.com/ecraft/logging_library
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Logging library
+test_files: []