logging 1.7.2 → 1.8.0

data/test/layouts/test_pattern.rb

@@ -191,6 +191,41 @@ module TestLayouts
       assert_equal 'message{42}', @layout.format(event)
     end
 
+    def test_pattern_mdc
+      @layout.pattern = 'S:%X{X-Session} C:%X{Cookie}'
+      event = Logging::LogEvent.new('TestLogger', @levels['info'], 'log message', false)
+
+      Logging.mdc['X-Session'] = '123abc'
+      Logging.mdc['Cookie'] = 'monster'
+      assert_equal 'S:123abc C:monster', @layout.format(event)
+
+      Logging.mdc.delete 'Cookie'
+      assert_equal 'S:123abc C:', @layout.format(event)
+
+      Logging.mdc.delete 'X-Session'
+      assert_equal 'S: C:', @layout.format(event)
+    end
+
+    def test_pattern_mdc_requires_key_name
+      assert_raise(ArgumentError) { @layout.pattern = '%X' }
+      assert_raise(ArgumentError) { @layout.pattern = '%X{}' }
+    end
+
+    def test_pattern_ndc
+      @layout.pattern = '%x'
+      event = Logging::LogEvent.new('TestLogger', @levels['info'], 'log message', false)
+
+      Logging.ndc << 'context a'
+      Logging.ndc << 'context b'
+      assert_equal 'context a context b', @layout.format(event)
+
+      @layout.pattern = '%x{, }'
+      assert_equal 'context a, context b', @layout.format(event)
+
+      Logging.ndc.pop
+      assert_equal 'context a', @layout.format(event)
+    end
+
   end  # TestBasic
 end  # TestLayouts
 end  # TestLogging

data/test/layouts/test_yaml.rb

@@ -11,7 +11,7 @@ module TestLayouts
       super
       @layout = Logging.layouts.yaml({})
       @levels = Logging::LEVELS
-      @date_fmt = '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{6,9} (Z|[+-]\d{2}:\d{2})'
+      @date_fmt = '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{6}(Z|[+-]\d{2}:\d{2})'
       Thread.current[:name] = nil
     end
 
@@ -27,7 +27,7 @@ module TestLayouts
       assert_yaml_match h, @layout.format(event)
 
       event.data = [1, 2, 3, 4]
-      h['message'] = "<Array> #{[1,2,3,4]}"
+      h['message'] = [1,2,3,4]
       assert_yaml_match h, @layout.format(event)
 
       event.level = @levels['debug']
@@ -41,7 +41,7 @@ module TestLayouts
       event.data = Exception.new
       h['level'] = 'FATAL'
       h['logger'] = 'Test'
-      h['message'] = '<Exception> Exception'
+      h['message'] = {:class => 'Exception', :message => 'Exception'}
       assert_yaml_match h, @layout.format(event)
     end
 
@@ -55,7 +55,7 @@ module TestLayouts
 
       @layout.items = %w[timestamp]
       assert_equal %w[timestamp], @layout.items
-      assert_match %r/\A--- ?\ntimestamp: '?#@date_fmt'?\n/, @layout.format(event)
+      assert_match %r/\A--- ?\ntimestamp: ["']#@date_fmt["']\n/, @layout.format(event)
 
       # 'foo' is not a recognized item
       assert_raise(ArgumentError) {
@@ -101,14 +101,57 @@ module TestLayouts
       assert_match %r/\A--- ?\nthread: \n/, @layout.format(event)
       Thread.current[:name] = "Main"
       assert_match %r/\A--- ?\nthread: Main\n/, @layout.format(event)
+
+      @layout.items = %w[mdc]
+      assert_match %r/\A--- ?\nmdc: \{\}\n/, @layout.format(event)
+
+      @layout.items = %w[ndc]
+      assert_match %r/\A--- ?\nndc: \[\]\n/, @layout.format(event)
+    end
+
+    def test_mdc_output
+      event = Logging::LogEvent.new('TestLogger', @levels['info'],
+                                    'log message', false)
+      Logging.mdc['X-Session'] = '123abc'
+      Logging.mdc['Cookie'] = 'monster'
+
+      @layout.items = %w[timestamp level logger message mdc]
+
+      format = @layout.format(event)
+      assert_match %r/\nmdc: ?(?:\n  (?:X-Session: 123abc|Cookie: monster)\n?){2}/, format
+
+      Logging.mdc.delete 'Cookie'
+      format = @layout.format(event)
+      assert_match %r/\nmdc: ?\n  X-Session: 123abc\n/, format
+    end
+
+    def test_ndc_output
+      event = Logging::LogEvent.new('TestLogger', @levels['info'],
+                                    'log message', false)
+      Logging.ndc << 'context a'
+      Logging.ndc << 'context b'
+
+      @layout.items = %w[timestamp level logger message ndc]
+
+      format = @layout.format(event)
+      assert_match %r/\nndc: ?\n\s*- context a\n\s*- context b\n/, format
+
+      Logging.ndc.pop
+      format = @layout.format(event)
+      assert_match %r/\nndc: ?\n\s*- context a\n/, format
+
+      Logging.ndc.pop
+      format = @layout.format(event)
+      assert_match %r/\nndc: \[\]\n/, format
     end
 
-    private
+  private
 
     def assert_yaml_match( expected, actual )
       actual = YAML.load(actual)
 
-      assert_instance_of Time, actual['timestamp']
+      assert_instance_of String, actual['timestamp']
+      assert_instance_of Time, Time.parse(actual['timestamp'])
       assert_equal expected['level'], actual['level']
       assert_equal expected['logger'], actual['logger']
       assert_equal expected['message'], actual['message']

data/test/test_layout.rb

@@ -26,6 +26,9 @@ module TestLogging
       @layout = ::Logging::Layout.new :format_as => :inspect
       assert_equal :inspect, obj_format[@layout]
 
+      @layout = ::Logging::Layout.new 'format_as' => :json
+      assert_equal :json, obj_format[@layout]
+
       @layout = ::Logging::Layout.new 'format_as' => :yaml
       assert_equal :yaml, obj_format[@layout]
 
@@ -73,6 +76,10 @@ module TestLogging
       r = @layout.format_obj obj
       assert_equal '<Array> ["one", "two", "three", "four"]', r
 
+      @layout = ::Logging::Layout.new :format_as => :json
+      r = @layout.format_obj obj
+      assert_equal '<Array> ["one","two","three","four"]', r
+
       @layout = ::Logging::Layout.new :format_as => :yaml
       r = @layout.format_obj obj
       assert_match %r/\A<Array> \n--- ?\n- one\n- two\n- three\n- four\n/, r

data/test/test_logging.rb

@@ -1,5 +1,5 @@
 
-require File.expand_path('setup', File.dirname(__FILE__))
+require File.expand_path('../setup', __FILE__)
 
 module TestLogging
 
@@ -231,6 +231,11 @@ module TestLogging
       assert_equal :inspect, ::Logging::OBJ_FORMAT
       remove_const[:OBJ_FORMAT]
 
+      ::Logging.format_as :json
+      assert ::Logging.const_defined?('OBJ_FORMAT')
+      assert_equal :json, ::Logging::OBJ_FORMAT
+      remove_const[:OBJ_FORMAT]
+
       ::Logging.format_as :yaml
       assert ::Logging.const_defined?('OBJ_FORMAT')
       assert_equal :yaml, ::Logging::OBJ_FORMAT

data/test/test_mapped_diagnostic_context.rb

@@ -0,0 +1,78 @@
+
+require File.expand_path('../setup', __FILE__)
+
+module TestLogging
+
+  class TestMappedDiagnosticContext < Test::Unit::TestCase
+    include LoggingTestCase
+
+    def test_key_value_access
+      assert_nil Logging.mdc['foo']
+
+      Logging.mdc['foo'] = 'bar'
+      assert_equal 'bar', Logging.mdc[:foo]
+      assert_same Logging.mdc['foo'], Logging.mdc[:foo]
+
+      Logging.mdc.delete(:foo)
+      assert_nil Logging.mdc['foo']
+    end
+
+    def test_clear
+      Logging.mdc['foo'] = 'bar'
+      Logging.mdc['baz'] = 'buz'
+
+      assert_equal 'bar', Logging.mdc[:foo]
+      assert_equal 'buz', Logging.mdc[:baz]
+
+      Logging.mdc.clear
+
+      assert_nil Logging.mdc['foo']
+      assert_nil Logging.mdc['baz']
+    end
+
+    def test_thread_uniqueness
+      Logging.mdc['foo'] = 'bar'
+      Logging.mdc['baz'] = 'buz'
+
+      t = Thread.new {
+        sleep
+
+        Logging.mdc.clear
+        assert_nil Logging.mdc['foo']
+        assert_nil Logging.mdc['baz']
+
+        Logging.mdc['foo'] = 42
+        assert_equal 42, Logging.mdc['foo']
+      }
+
+      Thread.pass until t.status == 'sleep'
+      t.run
+      t.join
+
+      assert_equal 'bar', Logging.mdc['foo']
+      assert_equal 'buz', Logging.mdc['baz']
+    end
+
+    def test_thread_inheritance
+      Logging.mdc['foo'] = 'bar'
+      Logging.mdc['baz'] = 'buz'
+
+      t = Thread.new(Logging.mdc.context) { |context|
+        sleep
+
+        assert_not_equal context.object_id, Logging.mdc.context.object_id
+
+        assert_equal 'bar', Logging.mdc['foo']
+        assert_equal 'buz', Logging.mdc['baz']
+        assert_nil Logging.mdc['unique']
+      }
+
+      Thread.pass until t.status == 'sleep'
+      Logging.mdc['unique'] = 'value'
+
+      t.run
+      t.join
+    end
+
+  end  # class TestMappedDiagnosticContext
+end  # module TestLogging

data/test/test_nested_diagnostic_context.rb

@@ -0,0 +1,83 @@
+
+require File.expand_path('../setup', __FILE__)
+
+module TestLogging
+
+  class TestNestedDiagnosticContext < Test::Unit::TestCase
+    include LoggingTestCase
+
+    def test_push_pop
+      ary = Logging.ndc.context
+      assert ary.empty?
+
+      assert_nil Logging.ndc.peek
+
+      Logging.ndc.push 'first context'
+      assert_equal 'first context', Logging.ndc.peek
+
+      Logging.ndc << 'second'
+      Logging.ndc << 'third'
+      assert_equal 'third', Logging.ndc.peek
+      assert_equal 3, ary.length
+
+      assert_equal 'third', Logging.ndc.pop
+      assert_equal 2, ary.length
+
+      assert_equal 'second', Logging.ndc.pop
+      assert_equal 1, ary.length
+
+      assert_equal 'first context', Logging.ndc.pop
+      assert ary.empty?
+    end
+
+    def test_clear
+      ary = Logging.ndc.context
+      assert ary.empty?
+
+      Logging.ndc << 'a' << 'b' << 'c' << 'd'
+      assert_equal 'd', Logging.ndc.peek
+      assert_equal 4, ary.length
+
+      Logging.ndc.clear
+      assert_nil Logging.ndc.peek
+      assert ary.empty?
+    end
+
+    def test_thread_uniqueness
+      Logging.ndc << 'first' << 'second'
+
+      t = Thread.new {
+        sleep
+
+        Logging.ndc.clear
+        assert_nil Logging.ndc.peek
+
+        Logging.ndc << 42
+        assert_equal 42, Logging.ndc.peek
+      }
+
+      Thread.pass until t.status == 'sleep'
+      t.run
+      t.join
+
+      assert_equal 'second', Logging.ndc.peek
+    end
+
+    def test_thread_inheritance
+      Logging.ndc << 'first' << 'second'
+
+      t = Thread.new(Logging.ndc.context) { |ary|
+        sleep
+
+        assert_not_equal ary.object_id, Logging.ndc.context.object_id
+        assert_equal %w[first second], Logging.ndc.context
+      }
+
+      Thread.pass until t.status == 'sleep'
+      Logging.ndc << 'third'
+
+      t.run
+      t.join
+    end
+  end  # class TestNestedDiagnosticContext
+end  # module TestLogging

data/version.txt

@@ -1 +1 @@
-1.7.2
+1.8.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logging
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-04 00:00:00.000000000Z
+date: 2012-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: little-plugger
-  requirement: &2155744060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,40 +21,76 @@ dependencies:
         version: 1.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *2155744060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
-  name: flexmock
-  requirement: &2155743520 !ruby/object:Gem::Requirement
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2155743520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bones-git
-  requirement: &2155743060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *2155743060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2155742640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.7.2
+        version: 3.8.0
   type: :development
   prerelease: false
-  version_requirements: *2155742640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 description: ! 'Logging is a flexible logging library for use in Ruby programs based
   on the
 
@@ -69,15 +105,12 @@ extensions: []
 extra_rdoc_files:
 - History.txt
 - README.rdoc
-- tmp.txt
 files:
 - .gitignore
-- .rvmrc
 - .travis.yml
 - History.txt
 - README.rdoc
 - Rakefile
-- a.rb
 - data/bad_logging_1.rb
 - data/bad_logging_2.rb
 - data/logging.rb
@@ -92,6 +125,7 @@ files:
 - examples/hierarchies.rb
 - examples/layouts.rb
 - examples/loggers.rb
+- examples/mdc.rb
 - examples/names.rb
 - examples/simple.rb
 - lib/logging.rb
@@ -109,6 +143,7 @@ files:
 - lib/logging/color_scheme.rb
 - lib/logging/config/configurator.rb
 - lib/logging/config/yaml_configurator.rb
+- lib/logging/diagnostic_context.rb
 - lib/logging/layout.rb
 - lib/logging/layouts.rb
 - lib/logging/layouts/basic.rb
@@ -150,12 +185,13 @@ files:
 - test/test_log_event.rb
 - test/test_logger.rb
 - test/test_logging.rb
+- test/test_mapped_diagnostic_context.rb
+- test/test_nested_diagnostic_context.rb
 - test/test_proxy.rb
 - test/test_repository.rb
 - test/test_root_logger.rb
 - test/test_stats.rb
 - test/test_utils.rb
-- tmp.txt
 - version.txt
 homepage: http://rubygems.org/gems/logging
 licenses: []
@@ -179,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: logging
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A flexible and extendable logging library for Ruby
@@ -208,6 +244,8 @@ test_files:
 - test/test_log_event.rb
 - test/test_logger.rb
 - test/test_logging.rb
+- test/test_mapped_diagnostic_context.rb
+- test/test_nested_diagnostic_context.rb
 - test/test_proxy.rb
 - test/test_repository.rb
 - test/test_root_logger.rb