logging 1.1.4 → 1.2.0

data/History.txt

@@ -1,3 +1,9 @@
+== 1.2.0 / 2009-08-14
+
+2 minor enhancements
+  - Added a gem based plugin system
+  - LogEvent is now a struct (slightly faster)
+
 == 1.1.4 / 2009-05-28
 
 1 minor enhancement

data/Rakefile

@@ -39,5 +39,6 @@ PROJ.ann.email[:from] = 'Tim Pease'
 
 depend_on 'flexmock'
 depend_on 'lockfile'
+depend_on 'little-plugger'
 
 # EOF

data/lib/logging.rb

@@ -9,24 +9,25 @@ require File.expand_path(
 require 'yaml'
 require 'stringio'
 require 'thread'
+require 'little-plugger'
 
 HAVE_LOCKFILE = require? 'lockfile'
 HAVE_SYSLOG   = require? 'syslog'
 require? 'fastthread'
 
 
-# TODO: Windows Log Service appender
-
 #
 #
 module Logging
+  extend LittlePlugger
 
   # :stopdoc:
-  VERSION = '1.1.4'
+  VERSION = '1.2.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   LEVELS = {}
   LNAMES = []
+  module Plugins; end
   # :startdoc:
 
   class << self
@@ -282,6 +283,8 @@ module Logging
       longest = 'off' if longest.length < 3
       module_eval "MAX_LEVEL_LENGTH = #{longest.length}", __FILE__, __LINE__
 
+      initialize_plugins
+
       levels.keys
     end
    

data/lib/logging/layouts/parseable.rb

@@ -78,14 +78,14 @@ module Logging::Layouts
     # Arguments to sprintf keyed to directive letters
     DIRECTIVE_TABLE = {
       'logger'    => 'event.logger',
-      'timestamp' => 'Time.now.strftime(Pattern::ISO8601)',
+      'timestamp' => 'event.time.strftime(Pattern::ISO8601)',
       'level'     => '::Logging::LNAMES[event.level]',
       'message'   => 'format_obj(event.data)',
       'file'      => 'event.file',
       'line'      => 'event.line',
       'method'    => 'event.method',
       'pid'       => 'Process.pid',
-      'millis'    => 'Integer((Time.now-@created_at)*1000)',
+      'millis'    => 'Integer((event.time-@created_at)*1000)',
       'thread_id' => 'Thread.current.object_id',
       'thread'    => 'Thread.current[:name]'
     }

data/lib/logging/layouts/pattern.rb

@@ -124,14 +124,14 @@ module Logging::Layouts
     # Arguments to sprintf keyed to directive letters
     DIRECTIVE_TABLE = {
       'c' => 'event.logger'.freeze,
-      'd' => 'format_date'.freeze,
+      'd' => 'format_date(event.time)'.freeze,
       'F' => 'event.file'.freeze,
       'l' => '::Logging::LNAMES[event.level]'.freeze,
       'L' => 'event.line'.freeze,
       'm' => 'format_obj(event.data)'.freeze,
       'M' => 'event.method'.freeze,
       'p' => 'Process.pid'.freeze,
-      'r' => 'Integer((Time.now-@created_at)*1000).to_s'.freeze,
+      'r' => 'Integer((event.time-@created_at)*1000).to_s'.freeze,
       't' => 'Thread.current.object_id.to_s'.freeze,
       'T' => 'Thread.current[:name]'.freeze,
       '%' => :placeholder
@@ -158,19 +158,18 @@ module Logging::Layouts
     #
     def self.create_date_format_methods( pf )
       code = "undef :format_date if method_defined? :format_date\n"
-      code << "def format_date\n"
+      code << "def format_date( time )\n"
       if pf.date_method.nil?
         if pf.date_pattern =~ %r/%s/
           code << <<-CODE
-            now = Time.now
-            dp = '#{pf.date_pattern}'.gsub('%s','%06d' % now.usec)
-            now.strftime dp
+            dp = '#{pf.date_pattern}'.gsub('%s','%06d' % time.usec)
+            time.strftime dp
           CODE
         else
-          code << "Time.now.strftime '#{pf.date_pattern}'\n"
+          code << "time.strftime '#{pf.date_pattern}'\n"
         end
       else
-        code << "Time.now.#{pf.date_method}\n"
+        code << "time.#{pf.date_method}\n"
       end
       code << "end\n"
       ::Logging.log_internal(0) {code}

data/lib/logging/log_event.rb

@@ -3,8 +3,7 @@ module Logging
 
   # This class defines a logging event.
   #
-  class LogEvent
-
+  LogEvent = Struct.new( :logger, :level, :data, :time, :file, :line, :method ) {
     # :stopdoc:
 
     # Regular expression used to parse out caller information
@@ -13,8 +12,8 @@ module Logging
     # * $2 == line number
     # * $3 == method name (might be nil)
     CALLER_RGXP = %r/([\.\/\(\)\w]+):(\d+)(?::in `(\w+)')?/o
-
-    CALLER_INDEX = RUBY_PLATFORM[%r/^java/i] ? 1 : 2
+    CALLER_INDEX = 2
+    #CALLER_INDEX = RUBY_PLATFORM[%r/^java/i] ? 1 : 2
     # :startdoc:
 
     # call-seq:
@@ -26,26 +25,21 @@ module Logging
     # invoked to get the execution trace of the logging method.
     #
     def initialize( logger, level, data, trace )
-      @logger = logger
-      @level = level
-      @data = data
-      @file = @line = @method = ''
+      f = l = m = ''
 
       if trace
-        t = Kernel.caller[CALLER_INDEX]
-        return if t.nil?
+        stack = Kernel.caller[CALLER_INDEX]
+        return if stack.nil?
 
-        m = CALLER_RGXP.match(t)
-        @file = m[1]
-        @line = Integer(m[2])
-        @method = m[3] unless m[3].nil?
+        match = CALLER_RGXP.match(stack)
+        f = match[1]
+        l = Integer(match[2])
+        m = match[3] unless match[3].nil?
       end
-    end
 
-    attr_accessor :logger, :level, :data
-    attr_reader :file, :line, :method
-
-  end  # class LogEvent
+      super(logger, level, data, Time.now, f, l, m)
+    end
+  }
 end  # module Logging
 
 # EOF

data/lib/logging/utils.rb

@@ -1,4 +1,6 @@
 
+require 'thread'
+
 # --------------------------------------------------------------------------
 class Hash
 

data/test/layouts/test_json.rb

@@ -68,9 +68,9 @@ module TestLayouts
     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'
+      event.file = 'test_file.rb'
+      event.line = 123
+      event.method = 'method_name'
 
       @layout.items = %w[logger]
       assert_equal %Q[{"logger":"TestLogger"}\n], @layout.format(event)

data/test/layouts/test_pattern.rb

@@ -22,15 +22,15 @@ module TestLayouts
     def test_date_method_eq
       @layout.date_method = :to_f
       assert_equal :to_f, @layout.date_method
-      assert_instance_of Float, @layout.format_date
+      assert_instance_of Float, @layout.format_date(Time.now)
 
       @layout.date_method = 'usec'
       assert_equal 'usec', @layout.date_method
-      assert_instance_of Fixnum, @layout.format_date
+      assert_instance_of Fixnum, @layout.format_date(Time.now)
 
       @layout.date_method = :to_s
       assert_equal :to_s, @layout.date_method
-      assert_instance_of String, @layout.format_date
+      assert_instance_of String, @layout.format_date(Time.now)
 
       # now, even if we have defined a date_pattern, the date_method should
       # supersede the date_pattern
@@ -38,7 +38,7 @@ module TestLayouts
 
       @layout.date_method = 'usec'
       assert_equal 'usec', @layout.date_method
-      assert_instance_of Fixnum, @layout.format_date
+      assert_instance_of Fixnum, @layout.format_date(Time.now)
     end
 
     def test_date_pattern
@@ -48,11 +48,11 @@ module TestLayouts
     def test_date_pattern_eq
       @layout.date_pattern = '%Y'
       assert_equal '%Y', @layout.date_pattern
-      assert_match %r/\A\d{4}\z/, @layout.format_date
+      assert_match %r/\A\d{4}\z/, @layout.format_date(Time.now)
 
       @layout.date_pattern = '%H:%M'
       assert_equal '%H:%M', @layout.date_pattern
-      assert_match %r/\A\d{2}:\d{2}\z/, @layout.format_date
+      assert_match %r/\A\d{2}:\d{2}\z/, @layout.format_date(Time.now)
     end
 
     def test_format
@@ -84,7 +84,7 @@ module TestLayouts
 
     def test_format_date
       rgxp = Regexp.new @date_fmt
-      assert_match rgxp, @layout.format_date
+      assert_match rgxp, @layout.format_date(Time.now)
     end
 
     def test_pattern
@@ -103,9 +103,9 @@ module TestLayouts
     def test_pattern_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'
+      event.file = 'test_file.rb'
+      event.line = '123'
+      event.method = 'method_name'
 
       @layout.pattern = '%c'
       assert_equal 'TestLogger', @layout.format(event)

data/test/layouts/test_yaml.rb

@@ -66,9 +66,9 @@ module TestLayouts
     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'
+      event.file = 'test_file.rb'
+      event.line = 123
+      event.method = 'method_name'
 
       @layout.items = %w[logger]
       assert_equal %Q[--- \nlogger: TestLogger\n], @layout.format(event)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: logging
 version: !ruby/object:Gem::Version 
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-28 00:00:00 -06:00
+date: 2009-08-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.4.3
     version: 
+- !ruby/object:Gem::Dependency 
+  name: little-plugger
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: bones
   type: :development
@@ -42,7 +52,11 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.5.0
     version: 
-description: Logging is a flexible logging library for use in Ruby programs based on the design of Java's log4j library. It features a hierarchical logging system, custom level names, multiple output destinations per log event, custom formatting, and more.
+description: |-
+  Logging is a flexible logging library for use in Ruby programs based on the
+  design of Java's log4j library. It features a hierarchical logging system,
+  custom level names, multiple output destinations per log event, custom
+  formatting, and more.
 email: tim.pease@gmail.com
 executables: []
 
@@ -136,6 +150,8 @@ files:
 - test/test_utils.rb
 has_rdoc: true
 homepage: http://logging.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -157,9 +173,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: logging
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A flexible and extendable logging library for Ruby
 test_files: 
 - test/appenders/test_buffered_io.rb