yeti_logger 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e5e9a8554d3123f83bd27c2cefe1663025fa9b9
+  data.tar.gz: 8f79e414571cbc0c5815eb5ce888892be8114231
+SHA512:
+  metadata.gz: 3fa2b8fedb91ee5f6cb0d0dcf41b4219cc16a5c98092c574ee55576d2c1ad9e0ce702c2d6e05c87af6445fbf80016e8f4e9134afc0d210a7554728fc8e99432a
+  data.tar.gz: 61e988b8d18bc89954b49cbd49a6d4d288280bc53312f9507f15e7404ac3e828f0fd433548599005ca49f8136c41caf02c47db2bdafb12f230dc65ae0823ebf4

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+.idea/
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby-19mode
+
+script:
+  - bundle exec rake ci
+
+sudo: false
+
+env:
+  global:
+    # To allow JRUBY to install c-extension gems
+    - "JRUBY_OPTS=-Xcext.enabled=true"

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# yeti_logger changelog
+
+## v3.0.0
+- First public release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yeti_logger.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2015 Yesware, Inc
+
+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 SaALL 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,193 @@
+# yeti_logger
+
+Provides standardized logging across Yesware apps.
+
+[![Build Status](https://travis-ci.org/Yesware/yeti_logger.svg?branch=master)](https://travis-ci.org/Yesware/yeti_logger)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yeti_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yeti_logger
+
+## Usage
+
+### Initialization
+
+To use YetiLogger within an app it must be configured with a logger. For example
+in a Rails application, create an initializer such as
+`config/initializers/yeti_logger.rb`:
+
+    require 'yeti_logger'
+
+    YetiLogger.configure do |config|
+      config.logger = Rails.logger
+    end
+
+### Logging for Classes
+
+In classes where you want to use YetiLogger you must include the module:
+
+    include YetiLogger
+
+This will define `log_error`, `log_warn`, `log_info`, and `log_debug` methods
+at both the class and instance level.
+
+Each method has a similar signature:
+
+    log_info(obj = nil, exception = nil, &block)
+
+Each of these arguments is optional. Passing no args results in a blank log
+message.
+
+All log messages are automatically prefixed with the name of the class.
+
+Exceptions will always be logged as their message and a backtrace. If you
+would like a message along with the exception, use this form:
+
+    log_info("My messsage", exception)
+
+If you only need the exception, then use the block form above:
+
+    log_info { exception }
+
+In situations where a logger object is required, the `#as_logger` instance
+method can be used to return an object that responds to `error`, `warn`, `info`,
+and `debug`, and forwards to the instance to format log messages using
+`YetiLogger`:
+
+    logger = instance.as_logger
+
+    # The following result in equivalent log messages
+    logger.info('this message')
+    instance.log_info('this message')
+
+### Preferred use
+
+The preferred way to use `YetiLogger` is via the block as it defers evaluation
+of the string until we've decided whether or not to log the message. Along with
+blocks, passing data in as a hash is also preferred.
+
+    log_debug { { system: "dagobah", jedi: expensive_to_compute() } }
+
+    log_debug({ system: "dagobah", jedi: expensive_to_compute() })
+
+Both of these will result in a log message formatted with `key=value` pairs
+separated by whitespace. The latter will call the `expensive_to_compute()`
+method prior to entry into the `log_debug` function meaning it will be computed
+whether or not the log statement is actually written out.
+
+The block format does not support separate arguments for exception and
+non-exception data. If you need both, either use the block format and use the
+functions in `YetiLogger::MessageFormatters` to format the exception, or use the
+`(obj, exception)` arguments taking note of any performance implications in
+building the log message.
+
+### Message formatting
+
+The value passed in for obj or returned by the block will be formatted
+depending on the content of it. If it is a hash, it will be formatted into
+"key=value" pairs separated by whitespace. Any value that needs to be quoted
+(embedded quotes, or has whitespace), will be quoted and embedded quotes
+escaped.
+
+Formatting of exceptions is dependent on the data type of the obj argument. If
+it is a string, then a string form of the exception details is included. If obj
+is a hash, then the exception in injected into the hash and printed as
+additional `key=value` pairs. Classname, message and backtrace are included in
+the message.
+
+### Nested Hashes
+
+For hash logging, each key and value are converted to strings which means
+nested hashes might not serialize like you would think. Additionally, no
+quotes are provided around keys or values, meaning for hashes that contain
+data that may include whitespace, it might make sense to pass in a serialized
+form of the hash instead of the hash itself. If you would like to override
+this behavior, pass in the serialized format for the hash, such as:
+
+    log_info { hash.to_json }
+    log_info { hash.to_s }
+    log_info { hash.to_my_log_format }
+
+## Test Support
+
+There are a couple helpers provided to support testing of YetiLogger calls. All
+helpers are available by requiring the relevant file and importing the module:
+
+    require 'yeti_logger/test_helper'
+
+    describe MyClass do
+      include YetiLogger::TestHelper
+
+      # tests here
+    end
+
+The simpler form sets up an expectation that the log level method in YetiLogger
+will be called. It returns that expectation and you can extend it with your
+preferred matcher:
+
+    ...
+    should_log(:info).with("exact message here")
+    ...
+    should_log(:warn).with(/a pattern/)
+    ...
+
+If you have an application that produces many lines of log messages at any one
+level, this can be cumbersome so `YetiLogger::TestHelper` provides methods for
+you to set up expectation to see specific log messages amongst all of the
+messages it may receive:
+
+    messages = [
+                'YourClass: one',
+                /match a regex!/,
+                'YourOtherClass: three'
+               ]
+
+    expect_to_see_log_messages(messages, :info) do
+      trigger_code_that_results_in_logging
+    end
+
+There is also a singular form of this `expect_to_see_log_message` that takes a
+single message to match.
+
+If you have code that logs at a level below your threshold set during testing
+you may have hidden bugs. Consider the following:
+
+    def my_method
+      ...
+      log_debug do
+        compute_log_message(arg1, arg2)
+      end
+      ...
+    end
+
+If in test you set your log level to be warn, then this block will never
+execute. Now, if this method were recently renamed, or another argument was
+added, you would have a runtime error just waiting for someone to set the log
+level down to debug. If you want to temporarily raise the log level for a given
+test, you can do so:
+
+    with_log_level(:debug) do
+      should_log(:debug).with("expected message")
+      my_method()
+    end
+
+Once the block is finished, the log level will be returned to whatever level you
+had it previously.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+# All-in-one target for CI servers to run.
+task :ci => ['spec']

data/lib/yeti_logger.rb

@@ -0,0 +1,164 @@
+require 'logger'
+require 'yeti_logger/version'
+require 'yeti_logger/constants'
+require 'yeti_logger/configuration'
+require 'yeti_logger/wrapped_logger'
+require 'yeti_logger/message_formatters'
+require 'active_support/core_ext/benchmark'
+require 'active_support/concern'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/try'
+
+# Mixin module providing Yesware logging functionality including formatting of
+# log message data (exceptions, hashes, etc). Refer to the Readme for further
+# information and examples.
+#
+# Module you can include in your class to get logging with class name prefixing.
+# This will also log hashes as key=value pairs and exception backtraces. These
+# methods are added via metaprogramming. When it's done, you'll have methods to
+# log at each level:
+# - debug
+# - info
+# - warn
+# - error
+#
+# Each method will have a signature that looks like:
+#   log_info(obj = nil, exception = nil, &block)
+#
+# Each of these arguments is optional. Pass no arguments results in a blank line
+# being logged (with a classname prefix).
+#
+# The ideal usage for YetiLogger is to pass in blocks:
+#
+#   log_info { "Here is my message with #{some} class #{values}" }
+#
+# This will defer evaluation of the string until the logger has determined if
+# the current log level is high enough to warrant evaluating the string and
+# logging it.
+#
+# Exceptions will be logged as a combination of the message, the class and some
+# number of lines of the backtrace. If you pass in a value for obj that is a
+# Hash, then the exception will be injected into the hash.
+#
+#   log_info("My message", exception)
+#
+# If you only need the exception, then use the block form above:
+#
+#   log_info { exception }
+#
+# The value passed in for obj or returned by the block will be formatted
+# depending on the content of it. If it is a hash, we will format into
+# "key=value" pairs separated by whitespace. If the value is an exception, the
+# message will be logged along with the backtrace. All other objects are
+# converted to string via the to_s method.
+#
+# For hash logging, each key and value are converted to strings which means
+# nested hashes might not serialize like you would think. Additionally, no
+# quotes are provided around keys or values, meaning for hashes that contain
+# data that may include whitespace, it might make sense to pass in a serialized
+# form of the hash instead of the hash itself. If you would like to override
+# this behavior, pass in the serialized format for the hash, such as:
+#
+#   log_info { hash.to_json }
+#   log_info { hash.to_s }
+#   log_info { hash.to_my_log_format }
+#
+#
+module YetiLogger
+  extend ActiveSupport::Concern
+
+  # This module contains log method definitions that are used at both the
+  # class and the instance level.
+  # Each log method is defined explicitly, despite the obvious repetition,
+  # to avoid the cost of creating a Proc for any, possibly unused, block
+  # passed to the log method.
+  # Define these methods explicitly allows the use of yield.
+  module LogMethods
+    def log_debug(obj = nil, ex = nil)
+      if YetiLogger.logger.level <= Logger::DEBUG
+        msg = if block_given?
+                MessageFormatters.build_log_message(log_class_name, yield)
+              else
+                MessageFormatters.build_log_message(log_class_name, obj, ex)
+              end
+        YetiLogger.logger.send(:debug, msg)
+      end
+    end
+
+    def log_info(obj = nil, ex = nil)
+      if YetiLogger.logger.level <= Logger::INFO
+        msg = if block_given?
+                MessageFormatters.build_log_message(log_class_name, yield)
+              else
+                MessageFormatters.build_log_message(log_class_name, obj, ex)
+              end
+        YetiLogger.logger.send(:info, msg)
+      end
+    end
+
+    def log_warn(obj = nil, ex = nil)
+      if YetiLogger.logger.level <= Logger::WARN
+        msg = if block_given?
+                MessageFormatters.build_log_message(log_class_name, yield)
+              else
+                MessageFormatters.build_log_message(log_class_name, obj, ex)
+              end
+        YetiLogger.logger.send(:warn, msg)
+      end
+    end
+
+    def log_error(obj = nil, ex = nil)
+      if YetiLogger.logger.level <= Logger::ERROR
+        msg = if block_given?
+                MessageFormatters.build_log_message(log_class_name, yield)
+              else
+                MessageFormatters.build_log_message(log_class_name, obj, ex)
+              end
+        YetiLogger.logger.send(:error, msg)
+      end
+    end
+
+    def log_fatal(obj = nil, ex = nil)
+      if YetiLogger.logger.level <= Logger::FATAL
+        msg = if block_given?
+                MessageFormatters.build_log_message(log_class_name, yield)
+              else
+                MessageFormatters.build_log_message(log_class_name, obj, ex)
+              end
+        YetiLogger.logger.send(:fatal, msg)
+      end
+    end
+  end
+
+  # Class-level methods.
+  module ClassMethods
+    include LogMethods
+
+    def log_class_name
+      self.name
+    end
+  end
+
+  # Instance-level log methods
+  include LogMethods
+
+  def log_class_name
+    self.class.name
+  end
+
+  def log_time(action, level = :info)
+    ms = Benchmark.ms do
+      yield
+    end
+    YetiLogger.logger.send(level,
+                           MessageFormatters.build_log_message(self.class.name,
+                                                               { action: action,
+                                                                 time_ms: ms.to_i }))
+  end
+
+  # Wrap self in an object that responds to :info, :warn, :error, :debug, etc.
+  # @return [YetiLogger::WrapperLogger]
+  def as_logger
+    YetiLogger::WrappedLogger.new(self)
+  end
+end