logger-better 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff288b763a26f53f6a1d762c4cafa28541d48865
-  data.tar.gz: 9a278ad87bf71421485b3fa2acb76d24123042a6
+  metadata.gz: b6d88295a70c17338039ffd8e70b35019aff3d61
+  data.tar.gz: dfe4d323fd414fc884bb00389a14e073a30990bb
 SHA512:
-  metadata.gz: ec084359da6bec5f41efec43f1ac6aa91de086cd4c97d61cee861eb0dc481cfdba90a3de34dbd1c8ce5abb065ca48f1d8861a4a3bd8b6177958b868ebd86b1a1
-  data.tar.gz: 25d8c7756ae7b57200ed9a54773a02603bb88c8789a4dcdd5072af2462e796c1d30284fc071b30b151add3a75e5e41ca0b4b78aec2d9a6c9c1f85802fdc205b5
+  metadata.gz: 03407ced98200a6e2cb6439f25cfbf923cee0604a93d3935804a6492dc9d4d54c252f9f3c22d938b9603ac23ef61c7c2e16e7c19e8d2b2fc97caab6cd4688a05
+  data.tar.gz: 58df092fccffee92e549a9e5d18f36215ae9c62c931a3ccac53fb73591ef78f0e92f25eab6753b43bfb8c11cffa1cbdfdb5957a28de77c42c6d3751231ce8f97

data/README.md

@@ -1,6 +1,9 @@
 # logger-better
 
-Simple monkey patch to stdlib's `Logger` to make it easier to use.
+Simple `Logger` subclasses to make it easier to use and print more
+compact log messages. It also contains modules you can monkey patch
+into `Logger` if you don't want to use the subclasses, or don't have
+control over objects instantiating `Logger` instances.
 
 I wrote this gem because I've done this same basic thing in many
 projects and got tired of it.
@@ -22,10 +25,52 @@ Or install it yourself as:
 ## Enhancements
 
 * Default log format is more readable: `2013-08-10T15:19:21Z [app#68530]  INFO: hi`
-* Set `logger.level` with symbols. `logger.level = :info`
+* Includes a formatter without timestamps. Useful when your logging
+  solution automatically inserts them.
+* Set `logger.level` with symbols. `logger.level = :info` (Works
+  nicely with `ENV['LOG_LEVEL']`)
 * Provide a `NullLogger` object to be used in cases where you need to
   tell some code to shut up.
 
+## Usage
+
+logger-better has two modes: subclasses and monkey patches to the
+`Logger` class. Monkey patching is **OPT IN**. This library includes a
+`Logger::Better` subclass. It just a subclass with the appropriate
+modules included. `Logger::Better` instances will use bundled
+formatter by default. `Logger::Better` also provides a factory for
+creating timestampless loggers (using one of the bundled formatters).
+
+### Sublcass Usage
+
+```ruby
+require 'logger-better'
+
+logger = Logger::Better.new $stdout
+logger.info('testing') { 'Hello World' } # => 2013-08-10T15:19:21Z [app#68530]  INFO: Hello World
+
+# Notimestamp factory method behaves the same as new, just sets the
+# default formatter
+logger = Logger::Better.no_timestamp $stdout
+logger.info('testing') { 'Hello World' } # => [app#68530]  INFO: Hello World
+```
+
+### Monkey Patching Logger
+
+```ruby
+require 'logger/better'
+
+logger = Logger.new $stdout
+logger.info('testing') { 'Hello World' } # => 2013-08-10T15:19:21Z [app#68530]  INFO: Hello World
+
+require 'logger/no_timestamp'
+
+# Notimestamp factory method behaves the same as new, just sets the
+# default formatter
+logger = Logger.new $stdout
+logger.info('testing') { 'Hello World' } # => [app#68530]  INFO: Hello World
+```
+
 ## Contributing
 
 1. Fork it

data/RELEASE_NOTES.md

@@ -0,0 +1,26 @@
+# Version 0.2.0
+
+This version significantly reworks the internals and provides new
+public facing features. This came out of real world experience using
+the library in other projects. This release changes two things:
+
+1. `Logger` is **NO LONGER** monkey patched by default
+2. Add a formatter that does not include timestamps.
+
+The first point was done to make this library a better citizen in the
+ruby community by following this principle: global non-opt-in monkey
+patching is bad and should be avoided. Monkey patching in itself is
+fine, as long as the developers knows it's happening and has control
+over it.
+
+The second point is a minor enhancement but goes a long way in keeping
+down the noise. Most distributed logging systems will insert their own
+timestamp on all messages. This becomes annoying when your log
+messages contain timestamps. This creates a bunch of noise and
+pointless duplication. This functionality is available either via
+monkey patch or subclass.
+
+## Upgrading from 0.1.x
+
+0.2.x is backward compatible with 0.1.0 depending on how the library
+is required. `require 'logger/better'` will keep the 0.1.x behavior.

data/Rakefile

@@ -1,8 +1,20 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
-Rake::TestTask.new :test do |t|
-  t.test_files = Dir['test/**/*_test.rb']
+namespace :test do
+  Rake::TestTask.new :lib do |t|
+    t.test_files = Dir['test/**/*_test.rb']
+  end
+
+  task :require do
+    require 'bundler/setup'
+    require 'logger/better'
+    require 'logger/no_timestamp'
+  end
+
+  task ci: [ :lib, :require ]
 end
 
+task test: 'test:ci'
+
 task default: :test

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.1.0

data/lib/logger-better.rb

@@ -1,4 +1,101 @@
-require "logger-better/version"
-
-require_relative 'logger/better'
 require_relative 'logger/null_logger'
+
+require 'logger'
+require 'time'
+
+class Logger
+  class Better < Logger
+    module LevelPatch
+      def level=(value)
+        if value.is_a? Symbol
+          @level = mapping.fetch(value, Logger::UNKNOWN)
+        else
+          @level = value
+        end
+      end
+
+      def mapping
+        {
+          debug: Logger::DEBUG,
+          info: Logger::INFO,
+          warn: Logger::WARN,
+          error: Logger::ERROR,
+          fatal: Logger::FATAL,
+          unknown: Logger::UNKNOWN
+        }
+      end
+    end
+
+    include LevelPatch
+
+    class << self
+      def no_timestamp(*args, &block)
+        new(*args, &block).tap do |logger|
+          logger.formatter = NoTimestampFormatter.new
+        end
+      end
+    end
+
+    def initialize(*)
+      super
+      @formatter = TimestampFormatter.new
+    end
+
+    class TimestampFormatter < Formatter
+      def call(severity, time, progname, msg)
+        format % [
+          time.utc.iso8601,
+          progname,
+          $$,
+          severity,
+          msg2str(msg).strip
+        ]
+      end
+
+      def format
+        "%s [%s#%d] %5s: %s\n"
+      end
+    end
+
+    class NoTimestampFormatter < Formatter
+      def call(severity, time, progname, msg)
+        format % [
+          progname,
+          $$,
+          severity,
+          msg2str(msg).strip
+        ]
+      end
+
+      def format
+        "[%s#%d] %5s: %s\n"
+      end
+    end
+  end
+
+  module BetterPatch
+    def initialize(*)
+      super
+      @formatter = Better::TimestampFormatter.new
+    end
+
+    class << self
+      def included(base)
+        base.include Better::LevelPatch
+      end
+    end
+  end
+
+  module NoTimestampPatch
+    def initialize(*)
+      super
+      @formatter = Better::NoTimestampFormatter.new
+    end
+
+    class << self
+      def included(base)
+        base.include Better::LevelPatch
+      end
+    end
+  end
+end

data/lib/logger/better.rb

@@ -1,39 +1,5 @@
-require 'logger'
-require 'time'
+require 'logger-better'
 
 class Logger
-  def level=(value)
-    if value.is_a? Symbol
-      @level = mapping.fetch(value, UNKNOWN)
-    else
-      @level = value
-    end
-  end
-
-  def mapping
-    {
-      debug: DEBUG,
-      info: INFO,
-      warn: WARN,
-      error: ERROR,
-      fatal: FATAL,
-      unknown: UNKNOWN
-    }
-  end
-
-  class Formatter
-    def call(severity, time, progname, msg)
-      format % [
-        time.utc.iso8601,
-        progname,
-        $$,
-        severity,
-        msg2str(msg).strip
-      ]
-    end
-
-    def format
-      "%s [%s#%d] %5s: %s\n"
-    end
-  end
+  include BetterPatch
 end

data/lib/logger/no_timestamp.rb

@@ -0,0 +1,5 @@
+require 'logger-better'
+
+class Logger
+  include NoTimestampPatch
+end

data/logger-better.gemspec

@@ -1,11 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'logger-better/version'
-
 Gem::Specification.new do |spec|
   spec.name          = "logger-better"
-  spec.version       = Logger::Better::VERSION
+  spec.version       = "0.2.0"
   spec.authors       = ["ahawkins"]
   spec.email         = ["adam@hawkins.io"]
   spec.description   = %q{Simple monkey patch to stdlib's Logger to make it easier to use.}

data/test/better_patch_test.rb

@@ -0,0 +1,23 @@
+require_relative 'test_helper'
+
+class BetterPatchTest < MiniTest::Unit::TestCase
+  def test_patching_sets_correct_formatter_on_new_instances
+    patched_logger = Class.new(Logger) do
+      include Logger::BetterPatch
+    end
+
+    logger = patched_logger.new $stdout
+    assert_instance_of Logger::Better::TimestampFormatter, logger.formatter
+  end
+
+  def test_patching_allows_setting_level_by_symbol
+    patched_logger = Class.new(Logger) do
+      include Logger::BetterPatch
+    end
+
+    logger = patched_logger.new $stdout
+
+    logger.level = :debug
+    assert_equal Logger::DEBUG, logger.level
+  end
+end

data/test/better_test.rb

@@ -1,12 +1,15 @@
 require_relative 'test_helper'
-require 'logger/better'
-require 'stringio'
 
 class BetterTest < MiniTest::Unit::TestCase
   attr_reader :formatter
 
   def setup
-    @formatter = Logger::Formatter.new
+    @formatter = Logger::Better::TimestampFormatter.new
+  end
+
+  def test_uses_the_correct_formatter
+    logger = Logger::Better.new $stdout
+    assert_instance_of Logger::Better::TimestampFormatter, logger.formatter
   end
 
   def test_uses_utc_iso_8601_times
@@ -51,7 +54,7 @@ class BetterTest < MiniTest::Unit::TestCase
   end
 
   def test_can_set_level_with_symbol
-    logger = Logger.new StringIO.new
+    logger = Logger::Better.new StringIO.new
 
     logger.level = :debug
     assert_equal Logger::DEBUG, logger.level
@@ -68,7 +71,7 @@ class BetterTest < MiniTest::Unit::TestCase
   end
 
   def tests_sets_level_unkown_when_passing_an_unkown_symol
-    logger = Logger.new StringIO.new
+    logger = Logger::Better.new StringIO.new
 
     logger.level = :foo
     assert_equal Logger::UNKNOWN, logger.level

data/test/no_timestamp_patch_test.rb

@@ -0,0 +1,23 @@
+require_relative 'test_helper'
+
+class NoTimestampPatchTest < MiniTest::Unit::TestCase
+  def test_patching_sets_correct_formatter_on_new_instances
+    patched_logger = Class.new(Logger) do
+      include Logger::NoTimestampPatch
+    end
+
+    logger = patched_logger.new $stdout
+    assert_instance_of Logger::Better::NoTimestampFormatter, logger.formatter
+  end
+
+  def test_patching_allows_setting_level_by_symbol
+    patched_logger = Class.new(Logger) do
+      include Logger::BetterPatch
+    end
+
+    logger = patched_logger.new $stdout
+
+    logger.level = :debug
+    assert_equal Logger::DEBUG, logger.level
+  end
+end

data/test/no_timestamp_test.rb

@@ -0,0 +1,57 @@
+require_relative 'test_helper'
+
+class NoTimestampTest < MiniTest::Unit::TestCase
+  attr_reader :formatter
+
+  def setup
+    @formatter = Logger::Better::NoTimestampFormatter.new
+  end
+
+  def test_building_loggers_without_timestamp
+    logger = Logger::Better.no_timestamp $stdout
+    assert_instance_of Logger::Better::NoTimestampFormatter, logger.formatter
+  end
+
+  def test_does_not_include_the_time
+    time = Time.now
+    log = formatter.call 'info', time, 'app', 'hi'
+    refute_includes log, time.utc.iso8601
+  end
+
+  def test_progname_is_first
+    log = formatter.call 'info', Time.now, 'app', 'hi'
+    # NOTE: format includes [ ] around progrname & PID, so this test
+    # really asserts that it's the first "text" in the output
+    assert_equal 1, log.index('app')
+  end
+
+  def test_pid_comes_after_progname
+    log = formatter.call 'info', Time.now, 'app', 'hi'
+    assert_before log, $$.to_s, 'app'
+  end
+
+  def test_level_comes_after_progname
+    log = formatter.call 'info', Time.now, 'app', 'hi'
+    assert_before log, 'info',  $$.to_s
+  end
+
+  def test_message_comes_last
+    log = formatter.call 'info', Time.now, 'app', 'hi'
+    assert_before log, 'hi', 'info'
+  end
+
+  def test_removes_extra_new_lines_from_end_of_message
+    message = "!\n\n"
+
+    log = formatter.call 'info', Time.now, 'app', message
+    # strip here because all lines will have a new line.
+    assert_equal '!', log.strip[-1]
+  end
+
+  private
+  def assert_before(string, second, first)
+    assert_includes string, first
+    assert_includes string, second
+    assert string.index(first) < string.index(second)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logger-better
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - ahawkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-07 00:00:00.000000000 Z
+date: 2015-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,13 +49,18 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASE_NOTES.md
 - Rakefile
+- circle.yml
 - lib/logger-better.rb
-- lib/logger-better/version.rb
 - lib/logger/better.rb
+- lib/logger/no_timestamp.rb
 - lib/logger/null_logger.rb
 - logger-better.gemspec
+- test/better_patch_test.rb
 - test/better_test.rb
+- test/no_timestamp_patch_test.rb
+- test/no_timestamp_test.rb
 - test/null_logger_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ahawkins/logger-better
@@ -83,6 +88,9 @@ signing_key:
 specification_version: 4
 summary: Simple monkey patch to stdlib's Logger to make it easier to use.
 test_files:
+- test/better_patch_test.rb
 - test/better_test.rb
+- test/no_timestamp_patch_test.rb
+- test/no_timestamp_test.rb
 - test/null_logger_test.rb
 - test/test_helper.rb

data/lib/logger-better/version.rb

@@ -1,5 +0,0 @@
-class Logger
-  module Better
-    VERSION = "0.1.3"
-  end
-end