gem_logger 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cac9834fee2a3e0b443c0385601b22831093517f
-  data.tar.gz: 312e92da1a677e310c80b02b42ccb94cce8cfa52
+  metadata.gz: f73265de272376624ed589aab1173d5f0bfa042f
+  data.tar.gz: fb9fe431795c83e4ee312c817916d1c8b734d973
 SHA512:
-  metadata.gz: 31460132ab3adec8fa05f3457cdf1b39629b7870aa86a5f3a619e43661afeb66f11b0f94cb55e7a13a50089e8e0c51637c3112456b64201ea6ef4f652eb5db53
-  data.tar.gz: 09e7ed4a79a2ee5ab9e5cb45e8781b021cfd249148a21f6d99883a1dd98fe453b41f83275058de4f6092596850b5107613070b28e805cfdd352c890a250c85bb
+  metadata.gz: 2d62371c1f40cee4688ea2933b8274a68e9935a4bed324537018f695960d1de004a5cfb83f563670df6dcb26cf4a0c808a3b890246be8821fef421329e346c1c
+  data.tar.gz: af39d1bcea345d28ce9fe564efe344381bdbbcf67bd7b0462503d200a77577908bafacd99ec4d2eb29612dbdb1ea1eff9b50bc292ee912c3605c2fca0ec441e3

data/CHANGELOG

@@ -0,0 +1,14 @@
+0.3.0 (10/29/2014)
+------------------
+
+Log4r handler. <2496da6> [Kenneth Hoffmann]
+Merge pull request #2 from KenBackupify/context_update <fe65c3c> [Matt Conway]
+Merge pull request #3 from ANorwell/universal_context_logging <b69aa83> [Matt Conway]
+README fix. <3cd4c03> [Kenneth Hoffmann]
+allow the context handler to be set after LoggerSupport is defined <f0b1dbe> [Arron Norwell]
+make LogContext methods available for all logger concerns, not just the basic logger <608d61e> [Arron Norwell]
+
+0.2.0 (10/08/2014)
+------------------
+
+Add context logging. <55283fa> [Kenneth Hoffmann]

data/README.md

@@ -37,7 +37,7 @@ By default, log_exception uses the ERROR level, but also accepts a level as an o
     
 Unless otherwise specified, the context is added to the beginning of the log message in a basic key = value format. You can, however, define your own context handler, and pass it in on initialization:
 
-    GemLogger.configure do |config| do
+    GemLogger.configure do |config|
       config.context_handler = MyHandler
     end
 

data/gem_logger.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "factory_girl"
   spec.add_development_dependency "faker"
+  spec.add_development_dependency "log4r"
 
   spec.add_dependency "activesupport"
 end

data/lib/gem_logger.rb

@@ -9,3 +9,4 @@ require "gem_logger/basic_logger"
 require "gem_logger/context_handler"
 require "gem_logger/gem_logger"
 require "gem_logger/logger_support"
+require "gem_logger/log4r_handler/context_handler"

data/lib/gem_logger/gem_logger.rb

@@ -29,7 +29,7 @@ module GemLogger
 
   # The default_logger to use with GemLogger::BasicLogger
   def self.default_logger
-    @default_logger ||= ::Logger.new(STDOUT).extend(LoggerSupport::LogContext)
+    @default_logger ||= ::Logger.new(STDOUT)
   end
 
   # Set the default_logger to use with GemLogger::BasicLogger

data/lib/gem_logger/log4r_handler/context_handler.rb

@@ -0,0 +1,30 @@
+module GemLogger
+  module Log4rHandler
+    module ContextHandler
+      extend ActiveSupport::Concern
+
+      included do
+        require 'log4r'
+      end
+
+      # Log4r::MDC.get_context returns a copy of the log context that is not
+      # modified when we remove the context variables added
+      def get_context
+        Log4r::MDC.get_context
+      end
+
+      def add_to_context(key, value)
+        Log4r::MDC.put(key.to_s, value.to_s)
+      end
+
+      def remove_from_context(key)
+        Log4r::MDC.remove(key.to_s)
+      end
+
+      # No formatting needed, Log4r will handle it.
+      def format_msg_with_context(msg)
+        msg
+      end
+    end
+  end
+end

data/lib/gem_logger/logger_support.rb

@@ -12,6 +12,14 @@ module GemLogger
       include GemLogger.logger_concern
 
       delegate :logger, :log_exception, :log_warning, :log_message, :to => "self.class"
+
+      class << self
+        alias_method :_original_logger, :logger
+
+        def logger
+          self._original_logger.extend(LogContext)
+        end
+      end
     end
 
     module ClassMethods
@@ -47,13 +55,12 @@ module GemLogger
 
     end
 
-
     module ContextLoggerCommon
       # @param [Hash] added_context - A hash containing context that will be added to the log messages produced by the
       # returned logger
       # @returns [LogContextLogger] - logger with the added context
       def context(added_context)
-        LogContextLogger.new(self.logger, self.log_context.merge(added_context))
+        LogContextLogger.new(self.logger, self.log_context.merge(added_context)).extend(GemLogger.context_handler)
       end
 
       # Adds an event_type to the context
@@ -94,7 +101,6 @@ module GemLogger
 
     LogContextLogger = Struct.new(:logger, :log_context) do
       include ContextLoggerCommon
-      include GemLogger.context_handler
 
       [:debug, :info, :warn, :error, :fatal].each do |method|
         define_method(method) { |msg| self.log(method, msg) }

data/lib/gem_logger/version.rb

@@ -1,3 +1,3 @@
 module GemLogger
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/unit/gem_logger/log4r_handler/context_handler_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../../test_helper'
+
+module GemLogger
+  class GemLogger::Log4rHandler::ContextHandlerTest < Minitest::Should::TestCase
+
+    setup do
+      class MyClass
+        include GemLogger::Log4rHandler::ContextHandler
+      end
+    end
+
+    should "pass add_to_context to Log4r put" do
+      Log4r::MDC.expects(:put).with('key', 'value')
+      MyClass.new.add_to_context('key', 'value')
+    end
+
+    should "convert add_to_context args to strings" do
+      Log4r::MDC.expects(:put).with('key', 'value')
+      MyClass.new.add_to_context(:key, :value)
+    end
+
+    should 'get existing Log4r context' do
+      Log4r::MDC.put('some', 'thing')
+      context = MyClass.new.get_context
+      assert_equal 'thing', context['some']
+      # Clean up.
+      Log4r::MDC.remove('some')
+    end
+
+    should "pass remove_from_context to Log4r remove" do
+      Log4r::MDC.expects(:remove).with('key')
+      MyClass.new.remove_from_context('key')
+    end
+
+    should "convert remove_from_context args to strings" do
+      Log4r::MDC.expects(:remove).with('key')
+      MyClass.new.remove_from_context(:key)
+    end
+  end
+end

data/test/unit/gem_logger/logger_support_test.rb

@@ -1,4 +1,5 @@
 require_relative '../../test_helper'
+require 'active_support/core_ext/module/delegation'
 
 module GemLogger
   class LoggerSupportTest < Minitest::Should::TestCase
@@ -35,7 +36,13 @@ module GemLogger
 
       setup do
         @old_default_logger = GemLogger.default_logger
-        GemLogger.default_logger = Minitest::Mock.new
+
+        mock = Minitest::Mock.new
+        def mock.extend(mod)
+          self
+        end
+
+        GemLogger.default_logger = mock
       end
 
       teardown do
@@ -118,56 +125,85 @@ module GemLogger
 
     context "logger with added context" do
 
+      class Context
+        class << self
+          attr_accessor :values
+        end
+
+        def self.get_context
+          self.values ||= {}
+        end
+
+        def self.add_to_context(key, value)
+          get_context[key] = value
+        end
+
+        def self.remove_from_context(key)
+          get_context.delete(key)
+        end
+      end
+
+      module TestContextHandler
+        extend ActiveSupport::Concern
+
+        delegate :get_context, :add_to_context, :remove_from_context, :to => Context
+
+        def format_msg_with_context(msg)
+          msg
+        end
+
+      end
+
       setup do
         class Foo; include GemLogger::LoggerSupport; end
+        GemLogger.context_handler = TestContextHandler
       end
 
       should "add the context to generated messages" do
 
-        GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with("ctx", "1")
-        GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with('ctx')
+        Context.expects(:add_to_context).with("ctx", "1")
+        Context.expects(:remove_from_context).with('ctx')
         Foo.logger.expects(:info).with("msg")
-
         Foo.logger.context("ctx" => "1").info("msg")
       end
 
       should "allow symbols as contexts" do
-        GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with(:ctx, "1")
-        GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with(:ctx)
+        Context.expects(:add_to_context).with(:ctx, "1")
+        Context.expects(:remove_from_context).with(:ctx)
 
         Foo.logger.context(:ctx => "1").info("msg")
       end
 
       should "implement debug" do
-        Foo.logger.expects(:debug).with("[ctx=1 ] msg")
+        Foo.logger.expects(:debug).with("msg")
         Foo.logger.context(:ctx => "1").debug("msg")
       end
 
       should "implement info" do
-        Foo.logger.expects(:info).with("[ctx=1 ] msg")
+        Foo.logger.expects(:info).with("msg")
         Foo.logger.context(:ctx => "1").info("msg")
       end
 
       should "implement warn" do
-        Foo.logger.expects(:warn).with("[ctx=1 ] msg")
+        Foo.logger.expects(:warn).with("msg")
         Foo.logger.context(:ctx => "1").warn("msg")
       end
 
       should "implement error" do
-        Foo.logger.expects(:error).with("[ctx=1 ] msg")
+        Foo.logger.expects(:error).with("msg")
         Foo.logger.context(:ctx => "1").error("msg")
       end
 
       should "implement fatal" do
-        Foo.logger.expects(:fatal).with("[ctx=1 ] msg")
+        Foo.logger.expects(:fatal).with("msg")
         Foo.logger.context(:ctx => "1").fatal("msg")
       end
 
       should 'allow context to be chained' do
-        GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with('ctx', '1')
-        GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with('ctx')
-        GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with('ctx2', '2')
-        GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with('ctx2')
+        Context.expects(:add_to_context).with('ctx', '1')
+        Context.expects(:remove_from_context).with('ctx')
+        Context.expects(:add_to_context).with('ctx2', '2')
+        Context.expects(:remove_from_context).with('ctx2')
         Foo.logger.expects(:info).with("msg")
 
         Foo.logger.context("ctx" => "1").context("ctx2" => "2").info("msg")
@@ -175,29 +211,28 @@ module GemLogger
 
       context "event_context" do
         should "add the event_type as context" do
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with(:event_type, :test_event)
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with(:event_type)
+          Context.expects(:add_to_context).with(:event_type, :test_event)
+          Context.expects(:remove_from_context).with(:event_type)
 
           Foo.logger.expects(:info).with("msg")
           Foo.logger.event_context(:test_event).info("msg")
         end
 
         should "include the context of the logger used" do
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with(:event_type, :test_event)
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with(:event_type)
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with(:ctx, '1')
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with(:ctx)
+          Context.expects(:add_to_context).with(:event_type, :test_event)
+          Context.expects(:remove_from_context).with(:event_type)
+          Context.expects(:add_to_context).with(:ctx, '1')
+          Context.expects(:remove_from_context).with(:ctx)
 
           Foo.logger.expects(:error).with("msg")
           Foo.logger.context(:ctx => "1").event_context(:test_event).error("msg")
         end
 
         should 'restore previous log context after logging' do
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.stubs(:get_context).returns({'foo' => 'bar'})
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with(:event_type, {'foo' => 'baz'})
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with(:event_type)
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:format_msg_with_context).with('msg')
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with('foo', 'bar')
+          Context.stubs(:get_context).returns({'foo' => 'bar'})
+          Context.expects(:add_to_context).with(:event_type, {'foo' => 'baz'})
+          Context.expects(:remove_from_context).with(:event_type)
+          Context.expects(:add_to_context).with('foo', 'bar')
 
           Foo.logger.event_context('foo' => 'baz').info("msg")
         end
@@ -205,8 +240,8 @@ module GemLogger
 
       context "exception_context" do
         should "add the exception class as context" do
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with(:exception, 'StandardError')
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with(:exception)
+          Context.expects(:add_to_context).with(:exception, 'StandardError')
+          Context.expects(:remove_from_context).with(:exception)
 
           Foo.logger.expects(:info).with("msg")
           Foo.logger.exception_context(StandardError.new).info("msg")
@@ -215,20 +250,20 @@ module GemLogger
 
       context "log_exception" do
         should "add the exception class as context" do
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:add_to_context).with(:exception, 'StandardError')
-          GemLogger::LoggerSupport::LogContextLogger.any_instance.expects(:remove_from_context).with(:exception)
+          Context.expects(:add_to_context).with(:exception, 'StandardError')
+          Context.expects(:remove_from_context).with(:exception)
 
           Foo.logger.expects(:error)
           Foo.logger.log_exception(StandardError.new, "msg")
         end
 
         should "log the backtrace" do
-          Foo.logger.expects(:error).with("[exception=StandardError ] msg: err (no backtrace)")
+          Foo.logger.expects(:error).with("msg: err (no backtrace)")
           Foo.logger.log_exception(StandardError.new("err"), "msg")
         end
 
         should 'allow the level to be changed as an option' do
-          Foo.logger.expects(:warn).with("[exception=StandardError ] msg: err (no backtrace)")
+          Foo.logger.expects(:warn).with("msg: err (no backtrace)")
           Foo.logger.log_exception(StandardError.new("err"), "msg", :level => :warn)
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_logger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Conway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  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'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +147,7 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -142,11 +157,13 @@ files:
 - lib/gem_logger/basic_logger.rb
 - lib/gem_logger/context_handler.rb
 - lib/gem_logger/gem_logger.rb
+- lib/gem_logger/log4r_handler/context_handler.rb
 - lib/gem_logger/logger_support.rb
 - lib/gem_logger/version.rb
 - test/test_helper.rb
 - test/unit/gem_logger/basic_logger_test.rb
 - test/unit/gem_logger/context_handler_test.rb
+- test/unit/gem_logger/log4r_handler/context_handler_test.rb
 - test/unit/gem_logger/logger_support_test.rb
 - test/unit/gem_logger_test.rb
 homepage: ''
@@ -178,6 +195,7 @@ test_files:
 - test/test_helper.rb
 - test/unit/gem_logger/basic_logger_test.rb
 - test/unit/gem_logger/context_handler_test.rb
+- test/unit/gem_logger/log4r_handler/context_handler_test.rb
 - test/unit/gem_logger/logger_support_test.rb
 - test/unit/gem_logger_test.rb
 has_rdoc: