logging 0.9.8 → 1.0.0

data/test/appenders/test_syslog.rb

@@ -12,8 +12,8 @@ module TestAppenders
 
     def setup
       super
-      ::Logging.init
-      @levels = ::Logging::LEVELS
+      Logging.init
+      @levels = Logging::LEVELS
       @logopt = defined?(::Syslog::LOG_NDELAY) ?
                     (::Syslog::LOG_PERROR | ::Syslog::LOG_NDELAY) :
                     (::Syslog::LOG_PERROR)
@@ -30,8 +30,8 @@ module TestAppenders
         stderr[1].close
 
         appender = create_syslog
-        event = ::Logging::LogEvent.new('TestLogger', @levels['info'],
-                                        [1, 2, 3, 4], false)
+        event = Logging::LogEvent.new('TestLogger', @levels['info'],
+                                      [1, 2, 3, 4], false)
         appender.append event
         event.level = @levels['debug']
         event.data = 'the big log message'
@@ -63,8 +63,8 @@ module TestAppenders
       appender = create_syslog
       appender.close false
 
-      event = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
-                                      [1, 2, 3, 4], false)
+      event = Logging::LogEvent.new('TestLogger', @levels['warn'],
+                                    [1, 2, 3, 4], false)
       assert_raise(RuntimeError) {appender.append event}
       assert_equal true, appender.closed?
     end
@@ -149,7 +149,7 @@ module TestAppenders
     end
 
     def test_initialize_map
-      appender = ::Logging::Appenders::Syslog.new(
+      appender = Logging.appenders.syslog(
         'syslog_test',
         :logopt => @logopt,
         :map => {
@@ -171,8 +171,8 @@ module TestAppenders
     private
 
     def create_syslog
-      layout = ::Logging::Layouts::Pattern.new(:pattern => '%5l  %c : %m')
-      ::Logging::Appenders::Syslog.new(
+      layout = Logging.layouts.pattern(:pattern => '%5l  %c : %m')
+      Logging.appenders.syslog(
           'syslog_test',
           :logopt => @logopt,
           :facility => ::Syslog::LOG_USER,
@@ -184,7 +184,7 @@ module TestAppenders
       syslog.instance_variable_get :@map
     end
 
-  end  # class TestIO
+  end  # class TestSyslog
 
 end  # module TestAppenders
 end  # module TestLogging

data/test/layouts/test_basic.rb

@@ -9,14 +9,13 @@ module TestLayouts
 
     def setup
       super
-      ::Logging.init
-      @layout = ::Logging::Layouts::Basic.new
-      @levels = ::Logging::LEVELS
+      @layout = Logging.layouts.basic({})
+      @levels = Logging::LEVELS
     end
 
     def test_format
-      event = ::Logging::LogEvent.new( 'ArrayLogger', @levels['info'],
-                                       'log message', false)
+      event = Logging::LogEvent.new( 'ArrayLogger', @levels['info'],
+                                     'log message', false)
       assert_equal " INFO  ArrayLogger : log message\n", @layout.format(event)
 
       event.data = [1, 2, 3, 4]

data/test/layouts/test_json.rb

@@ -0,0 +1,112 @@
+
+require File.join(File.dirname(__FILE__), %w[.. setup])
+
+module TestLogging
+module TestLayouts
+
+  class TestJson < Test::Unit::TestCase
+    include LoggingTestCase
+
+    def setup
+      super
+      @layout = Logging.layouts.json({})
+      @levels = Logging::LEVELS
+      @date_fmt = '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
+      Thread.current[:name] = nil
+    end
+
+    def test_initializer
+      assert_raise(ArgumentError) {
+        Logging.layouts.parseable.new :style => :foo
+      }
+    end
+
+    def test_format
+      fmt = %Q[\\{"timestamp":"#@date_fmt","level":"%s","logger":"%s","message":"%s"\\}\\n]
+
+      event = Logging::LogEvent.new('ArrayLogger', @levels['info'],
+                                    'log message', false)
+      rgxp  = Regexp.new(sprintf(fmt, 'INFO', 'ArrayLogger', 'log message'))
+      assert_match rgxp, @layout.format(event)
+
+      event.data = [1, 2, 3, 4]
+      rgxp  = Regexp.new(sprintf(fmt, 'INFO', 'ArrayLogger',
+                                 Regexp.escape("<Array> #{[1,2,3,4]}")))
+      assert_match rgxp, @layout.format(event)
+
+      event.level = @levels['debug']
+      event.data = 'and another message'
+      rgxp  = Regexp.new(sprintf(fmt, 'DEBUG', 'ArrayLogger',
+                         'and another message'))
+      assert_match rgxp, @layout.format(event)
+
+      event.logger = 'Test'
+      event.level = @levels['fatal']
+      event.data = Exception.new
+      rgxp  = Regexp.new(sprintf(fmt, 'FATAL', 'Test', '<Exception> Exception'))
+      assert_match rgxp, @layout.format(event)
+    end
+
+    def test_items
+      assert_equal %w[timestamp level logger message], @layout.items
+    end
+
+    def test_items_eq
+      event = Logging::LogEvent.new('TestLogger', @levels['info'],
+                                    ['log message'], false)
+
+      @layout.items = %w[timestamp]
+      assert_equal %w[timestamp], @layout.items
+      assert_match %r/\{"timestamp":"#@date_fmt"\}\n/, @layout.format(event)
+
+      # 'foo' is not a recognized item
+      assert_raise(ArgumentError) {
+        @layout.items = %w[timestamp logger foo]
+      }
+    end
+
+    def test_items_all
+      event = Logging::LogEvent.new('TestLogger', @levels['info'],
+                                    'log message', false)
+      event.instance_variable_set :@file, 'test_file.rb'
+      event.instance_variable_set :@line, 123
+      event.instance_variable_set :@method, 'method_name'
+
+      @layout.items = %w[logger]
+      assert_equal %Q[{"logger":"TestLogger"}\n], @layout.format(event)
+
+      @layout.items = %w[file]
+      assert_equal %Q[{"file":"test_file.rb"}\n], @layout.format(event)
+
+      @layout.items = %w[level]
+      assert_equal %Q[{"level":"INFO"}\n], @layout.format(event)
+
+      @layout.items = %w[line]
+      assert_equal %Q[{"line":123}\n], @layout.format(event)
+
+      @layout.items = %w[message]
+      assert_equal %Q[{"message":"log message"}\n], @layout.format(event)
+
+      @layout.items = %w[method]
+      assert_equal %Q[{"method":"method_name"}\n], @layout.format(event)
+
+      @layout.items = %w[pid]
+      assert_match %r/\A\{"pid":\d+\}\n\z/, @layout.format(event)
+
+      @layout.items = %w[millis]
+      assert_match %r/\A\{"millis":\d+\}\n\z/, @layout.format(event)
+
+      @layout.items = %w[thread_id]
+      assert_match %r/\A\{"thread_id":-?\d+\}\n\z/, @layout.format(event)
+
+      @layout.items = %w[thread]
+      assert_equal %Q[{"thread":null}\n], @layout.format(event)
+      Thread.current[:name] = "Main"
+      assert_equal %Q[{"thread":"Main"}\n], @layout.format(event)
+    end
+
+  end  # class TestJson
+end  # module TestLayouts
+end  # module TestLogging
+
+# EOF

data/test/layouts/test_pattern.rb

@@ -9,10 +9,10 @@ module TestLayouts
 
     def setup
       super
-      ::Logging.init
-      @layout = ::Logging::Layouts::Pattern.new
-      @levels = ::Logging::LEVELS
+      @layout = Logging.layouts.pattern({})
+      @levels = Logging::LEVELS
       @date_fmt = '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
+      Thread.current[:name] = nil
     end
 
     def test_date_method
@@ -58,8 +58,8 @@ module TestLayouts
     def test_format
       fmt = '\[' + @date_fmt + '\] %s -- %s : %s\n'
 
-      event = ::Logging::LogEvent.new('ArrayLogger', @levels['info'],
-                                      'log message', false)
+      event = Logging::LogEvent.new('ArrayLogger', @levels['info'],
+                                    'log message', false)
       rgxp  = Regexp.new(sprintf(fmt, 'INFO ', 'ArrayLogger', 'log message'))
       assert_match rgxp, @layout.format(event)
 
@@ -92,8 +92,8 @@ module TestLayouts
     end
 
     def test_pattern_eq
-      event = ::Logging::LogEvent.new('TestLogger', @levels['info'],
-                                      ['log message'], false)
+      event = Logging::LogEvent.new('TestLogger', @levels['info'],
+                                    ['log message'], false)
 
       @layout.pattern = '%d'
       assert_equal '%d', @layout.pattern
@@ -101,8 +101,8 @@ module TestLayouts
     end
 
     def test_pattern_all
-      event = ::Logging::LogEvent.new('TestLogger', @levels['info'],
-                                      'log message', false)
+      event = Logging::LogEvent.new('TestLogger', @levels['info'],
+                                    'log message', false)
       event.instance_variable_set :@file, 'test_file.rb'
       event.instance_variable_set :@line, '123'
       event.instance_variable_set :@method, 'method_name'

data/test/layouts/test_yaml.rb

@@ -0,0 +1,121 @@
+
+require File.join(File.dirname(__FILE__), %w[.. setup])
+
+module TestLogging
+module TestLayouts
+
+  class TestYaml < Test::Unit::TestCase
+    include LoggingTestCase
+
+    def setup
+      super
+      @layout = Logging.layouts.yaml({})
+      @levels = Logging::LEVELS
+      @date_fmt = '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
+      Thread.current[:name] = nil
+    end
+
+    def test_format
+      h = {
+        'level' => 'INFO',
+        'logger' => 'ArrayLogger',
+        'message' => 'log message'
+      }
+
+      event = Logging::LogEvent.new('ArrayLogger', @levels['info'],
+                                    'log message', false)
+      assert_yaml_match h, @layout.format(event)
+
+      event.data = [1, 2, 3, 4]
+      h['message'] = "<Array> #{[1,2,3,4]}"
+      assert_yaml_match h, @layout.format(event)
+
+      event.level = @levels['debug']
+      event.data = 'and another message'
+      h['level'] = 'DEBUG'
+      h['message'] = 'and another message'
+      assert_yaml_match h, @layout.format(event)
+
+      event.logger = 'Test'
+      event.level = @levels['fatal']
+      event.data = Exception.new
+      h['level'] = 'FATAL'
+      h['logger'] = 'Test'
+      h['message'] = '<Exception> Exception'
+      assert_yaml_match h, @layout.format(event)
+    end
+
+    def test_items
+      assert_equal %w[timestamp level logger message], @layout.items
+    end
+
+    def test_items_eq
+      event = Logging::LogEvent.new('TestLogger', @levels['info'],
+                                    ['log message'], false)
+
+      @layout.items = %w[timestamp]
+      assert_equal %w[timestamp], @layout.items
+      assert_match %r/--- \ntimestamp: #@date_fmt\n/, @layout.format(event)
+
+      # 'foo' is not a recognized item
+      assert_raise(ArgumentError) {
+        @layout.items = %w[timestamp logger foo]
+      }
+    end
+
+    def test_items_all
+      event = Logging::LogEvent.new('TestLogger', @levels['info'],
+                                    'log message', false)
+      event.instance_variable_set :@file, 'test_file.rb'
+      event.instance_variable_set :@line, 123
+      event.instance_variable_set :@method, 'method_name'
+
+      @layout.items = %w[logger]
+      assert_equal %Q[--- \nlogger: TestLogger\n], @layout.format(event)
+
+      @layout.items = %w[file]
+      assert_equal %Q[--- \nfile: test_file.rb\n], @layout.format(event)
+
+      @layout.items = %w[level]
+      assert_equal %Q[--- \nlevel: INFO\n], @layout.format(event)
+
+      @layout.items = %w[line]
+      assert_equal %Q[--- \nline: 123\n], @layout.format(event)
+
+      @layout.items = %w[message]
+      assert_equal %Q[--- \nmessage: log message\n], @layout.format(event)
+
+      @layout.items = %w[method]
+      assert_equal %Q[--- \nmethod: method_name\n], @layout.format(event)
+
+      @layout.items = %w[pid]
+      assert_match %r/\A--- \npid: \d+\n\z/, @layout.format(event)
+
+      @layout.items = %w[millis]
+      assert_match %r/\A--- \nmillis: \d+\n\z/, @layout.format(event)
+
+      @layout.items = %w[thread_id]
+      assert_match %r/\A--- \nthread_id: -?\d+\n\z/, @layout.format(event)
+
+      @layout.items = %w[thread]
+      assert_equal %Q[--- \nthread: \n], @layout.format(event)
+      Thread.current[:name] = "Main"
+      assert_equal %Q[--- \nthread: Main\n], @layout.format(event)
+    end
+
+    private
+
+    def assert_yaml_match( expected, actual )
+      actual = YAML.load(actual)
+
+      assert_match %r/#@date_fmt/o, actual['timestamp']
+      assert_equal expected['level'], actual['level']
+      assert_equal expected['logger'], actual['logger']
+      assert_equal expected['message'], actual['message']
+    end
+
+  end  # class TestYaml
+end  # module TestLayouts
+end  # module TestLogging
+
+# EOF

data/test/setup.rb

@@ -59,7 +59,7 @@ module LoggingTestCase
     super
     ::Logging.backtrace
     ::Logging.__send__(:remove_instance_variable, :@backtrace)
-    h = ::Logging::Appender.instance_variable_get(:@appenders)
+    h = ::Logging::Appenders.instance_variable_get(:@appenders)
     h.each_value {|a| a.close(false) unless a.nil? || a.closed?}
     h.clear
     FileUtils.rm_rf TMP

data/test/test_appender.rb

@@ -40,20 +40,6 @@ module TestLogging
       assert_raise(RuntimeError) {@appender.append @event}
     end
 
-    def test_class_stderr
-      stderr = ::Logging::Appender.stderr
-      assert_instance_of ::Logging::Appenders::Stderr, stderr
-      assert_equal 'stderr', stderr.name
-      assert_same stderr, ::Logging::Appender.stderr
-    end
-
-    def test_class_stdout
-      stdout = ::Logging::Appender.stdout
-      assert_instance_of ::Logging::Appenders::Stdout, stdout
-      assert_equal 'stdout', stdout.name
-      assert_same stdout, ::Logging::Appender.stdout
-    end
-
     def test_close
       assert_equal false, @appender.closed?
 

data/test/test_log_event.rb

@@ -48,7 +48,7 @@ module TestLogging
 
       @logger.trace = true
       @logger.error 'error message'
-      assert_match %r/\d+/, @appender.event.line
+      assert_equal 50, @appender.event.line
     end
 
     def test_logger

data/test/test_logging.rb

@@ -50,11 +50,11 @@ module TestLogging
       assert_equal 3, ::Logging::Logger.root.level
 
       # verify the appenders
-      h = ::Logging::Appender.instance_variable_get :@appenders
+      h = ::Logging::Appenders.instance_variable_get :@appenders
       assert_equal ['logfile', 'stderr'], h.keys.sort
 
       # start with the File appender
-      logfile = ::Logging::Appender['logfile']
+      logfile = ::Logging::Appenders['logfile']
       assert_instance_of ::Logging::Appenders::File, logfile
       assert_equal 0, logfile.level
       assert_equal 'tmp/temp.log', logfile.instance_variable_get(:@fn)
@@ -66,7 +66,7 @@ module TestLogging
       assert_nil layout.date_pattern
 
       # and now the Stderr appender
-      stderr = ::Logging::Appender['stderr']
+      stderr = ::Logging::Appenders['stderr']
       assert_instance_of ::Logging::Appenders::Stderr, stderr
       assert_equal 0, stderr.level
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: logging
 version: !ruby/object:Gem::Version 
-  version: 0.9.8
+  version: 1.0.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-15 00:00:00 -06:00
+date: 2009-04-17 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,8 +60,17 @@ files:
 - data/logging.rb
 - data/logging.yaml
 - data/simple_logging.rb
+- examples/appenders.rb
+- examples/classes.rb
+- examples/formatting.rb
+- examples/hierarchies.rb
+- examples/layouts.rb
+- examples/loggers.rb
+- examples/names.rb
+- examples/simple.rb
 - lib/logging.rb
 - lib/logging/appender.rb
+- lib/logging/appenders.rb
 - lib/logging/appenders/buffering.rb
 - lib/logging/appenders/console.rb
 - lib/logging/appenders/email.rb
@@ -74,7 +83,9 @@ files:
 - lib/logging/config/configurator.rb
 - lib/logging/config/yaml_configurator.rb
 - lib/logging/layout.rb
+- lib/logging/layouts.rb
 - lib/logging/layouts/basic.rb
+- lib/logging/layouts/parseable.rb
 - lib/logging/layouts/pattern.rb
 - lib/logging/log_event.rb
 - lib/logging/logger.rb
@@ -108,7 +119,9 @@ files:
 - test/config/test_configurator.rb
 - test/config/test_yaml_configurator.rb
 - test/layouts/test_basic.rb
+- test/layouts/test_json.rb
 - test/layouts/test_pattern.rb
+- test/layouts/test_yaml.rb
 - test/setup.rb
 - test/test_appender.rb
 - test/test_layout.rb
@@ -158,7 +171,9 @@ test_files:
 - test/config/test_configurator.rb
 - test/config/test_yaml_configurator.rb
 - test/layouts/test_basic.rb
+- test/layouts/test_json.rb
 - test/layouts/test_pattern.rb
+- test/layouts/test_yaml.rb
 - test/test_appender.rb
 - test/test_layout.rb
 - test/test_log_event.rb