logging 1.4.3 → 1.5.0

data/lib/logging/log_event.rb

@@ -11,7 +11,7 @@ module Logging
     # * $1 == filename
     # * $2 == line number
     # * $3 == method name (might be nil)
-    CALLER_RGXP = %r/([\.\/\(\)\w]+):(\d+)(?::in `(\w+)')?/o
+    CALLER_RGXP = %r/([-\.\/\(\)\w]+):(\d+)(?::in `(\w+)')?/o
     CALLER_INDEX = 2
     #CALLER_INDEX = RUBY_PLATFORM[%r/^java/i] ? 1 : 2
     # :startdoc:

data/lib/logging/logger.rb

@@ -434,7 +434,7 @@ module Logging
     #
     # Configures internal variables for the logger. This method can be used
     # to avoid storing the logger in the repository.
-    # 
+    #
     def _setup( name, opts = {} )
       @name      = name
       @parent    = opts.getopt(:parent)
@@ -498,7 +498,6 @@ module Logging
     end
     # :startdoc:
 
-  end  # class Logger
-end  # module Logging
+  end  # Logger
+end  # Logging
 
-# EOF

data/lib/logging/proxy.rb

@@ -0,0 +1,57 @@
+
+module Logging
+
+  # Defines a Proxy that will log all method calls on the proxied object. This
+  # class uses +method_missing+ on a "blank slate" object to intercept all
+  # method calls. The method name being called and the arguments are all
+  # logged to the proxied object's logger instance. The log level and other
+  # settings for the proxied object are honored by the Proxy instance.
+  #
+  # If you want, you can also supply your own +method_missing+ code as a block
+  # to the constructor.
+  #
+  #   Proxy.new(object) do |name, *args, &block|
+  #     # code to be executed before the proxied method
+  #     result = @object.send(name, *args, &block)
+  #     # code to be executed after the proxied method
+  #     result   # <-- always return the result
+  #   end
+  #
+  # The proxied object is avaiable as the "@object" variable. The logger is
+  # available as the "@logger" variable.
+  #
+  class Proxy
+
+    # :stopdoc:
+    KEEPERS = %r/^__|^object_id$|^initialize$/
+    instance_methods(true).each { |m| undef_method m unless m[KEEPERS] }
+    private_instance_methods(true).each { |m| undef_method m unless m[KEEPERS] }
+    # :startdoc:
+
+    # Create a new proxy for the given _object_. If an optional _block_ is
+    # given it will be called before the proxied method. This _block_ will
+    # replace the +method_missing+ implementation 
+    #
+    def initialize( object, &block )
+      @object = object
+      @leader = @object.is_a?(Class) ? "#{@object.name}." : "#{@object.class.name}#"
+      @logger = Logging.logger[object]
+
+      if block
+        eigenclass = class << self; self; end
+        eigenclass.__send__(:define_method, :method_missing, &block)
+      end
+    end
+
+    # All hail the magic of method missing. Here is where we are going to log
+    # the method call and then forward to the proxied object. The return value
+    # from the proxied objet method call is passed back.
+    #
+    def method_missing( name, *args, &block )
+      @logger << "#@leader#{name}(#{args.inspect[1..-2]})\n"
+      @object.send(name, *args, &block)
+    end
+
+  end  # Proxy
+end  # Logging
+

data/lib/logging/utils.rb

@@ -1,4 +1,6 @@
 
+require 'thread'
+
 # --------------------------------------------------------------------------
 class Hash
 
@@ -196,6 +198,5 @@ class ReentrantMutex < Mutex
       }
     end
   end
-end  # class ReentrantMutex
+end  # ReentrantMutex
 
-# EOF

data/test/appenders/test_buffered_io.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestAppenders
@@ -135,15 +135,10 @@ module TestAppenders
     end
 
     def test_flush
-      ary = []
-      @sio.instance_variable_set :@ary, ary
-      def @sio.flush() @ary << :flush end
-
       @appender << "this is a test message\n"
       assert_nil(readline)
 
       @appender.flush
-      assert_equal :flush, ary.pop
       assert_equal "this is a test message\n", readline
       assert_nil(readline)
     end
@@ -163,7 +158,7 @@ module TestAppenders
       assert_nil(readline)
     end
 
-    private
+  private
     def readline
       @appender.readline
     end

data/test/appenders/test_console.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestAppenders

data/test/appenders/test_email.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 require 'flexmock'
 
 module TestLogging

data/test/appenders/test_file.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestAppenders

data/test/appenders/test_growl.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 require 'flexmock'
 
 module TestLogging

data/test/appenders/test_io.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestAppenders
@@ -103,12 +103,11 @@ module TestAppenders
     end
 
     def test_flush
-      ary = []
-      @sio.instance_variable_set :@ary, ary
-      def @sio.flush() @ary << :flush end
+      @appender.buffer << 'flush'
+      assert_nil @appender.readline
 
       @appender.flush
-      assert_equal :flush, ary.pop
+      assert_equal 'flush', @appender.readline
     end
 
     def test_initialize

data/test/appenders/test_rolling_file.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestAppenders

data/test/appenders/test_syslog.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 if HAVE_SYSLOG
 

data/test/benchmark.rb

@@ -1,15 +1,11 @@
 
-begin
-  require 'logging'
-rescue LoadError
-  path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
-  raise if $:.include? path
-  $: << path
-  retry
-end
+require 'rubygems'
+
+libpath = File.expand_path('../../lib', __FILE__)
+$:.unshift libpath
+require 'logging'
 
 begin
-  require 'rubygems'
   gem 'log4r'
   require 'log4r'
   $log4r = true
@@ -26,10 +22,18 @@ module Logging
     def run
       this_many = 300_000
 
-      sio = StringIO.new
+      Logging.appenders.string_io(
+        'sio',
+        :layout => Logging.layouts.pattern(
+          :pattern => '%.1l, [%d] %5l -- %c: %m\n',
+          :date_pattern => "%Y-%m-%dT%H:%M:%S.%s"
+        )
+      )
+      sio = Logging.appenders['sio'].sio
 
-      logging = ::Logging.logger sio
+      logging = ::Logging.logger('benchmark')
       logging.level = :warn
+      logging.appenders = 'sio'
 
       logger = ::Logger.new sio
       logger.level = ::Logger::WARN

data/test/config/test_configurator.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestConfig

data/test/config/test_yaml_configurator.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestConfig

data/test/layouts/test_basic.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestLayouts

data/test/layouts/test_color_pattern.rb

@@ -0,0 +1,90 @@
+
+require File.expand_path('../../setup', __FILE__)
+
+module TestLogging
+module TestLayouts
+
+  class TestColorPattern < Test::Unit::TestCase
+    include LoggingTestCase
+    CS = ::Logging::ColorScheme
+
+    def setup
+      super
+
+      ::Logging.color_scheme :levels, :levels => {
+          :debug => :blue, :info => :green, :warn => :yellow, :error => :red, :fatal => :cyan
+      }
+
+      ::Logging.color_scheme :lines, :lines => {
+          :debug => :blue, :info => :green, :warn => :yellow, :error => :red, :fatal => :cyan
+      }, :date => :blue, :logger => :cyan
+
+      ::Logging.color_scheme :tokens, :date => :blue, :logger => :green, :message => :magenta
+
+      @levels = Logging::LEVELS
+    end
+
+    def test_level_coloring
+      layout = Logging.layouts.pattern(:color_scheme => :levels)
+      event = Logging::LogEvent.new('ArrayLogger', @levels['info'], 'log message', false)
+
+      rgxp = Regexp.new(Regexp.escape("#{CS::GREEN}INFO #{CS::RESET}"))
+      assert_match rgxp, layout.format(event)
+
+      event.level = @levels['debug']
+      rgxp = Regexp.new(Regexp.escape("#{CS::BLUE}DEBUG#{CS::RESET}"))
+      assert_match rgxp, layout.format(event)
+
+      event.level = @levels['error']
+      rgxp = Regexp.new(Regexp.escape("#{CS::RED}ERROR#{CS::RESET}"))
+      assert_match rgxp, layout.format(event)
+    end
+
+    def test_multiple_level_coloring
+      layout = Logging.layouts.pattern(:pattern => '%.1l, %5l -- %c: %m\n', :color_scheme => :levels)
+      event = Logging::LogEvent.new('ArrayLogger', @levels['info'], 'log message', false)
+
+      rgxp = Regexp.new(Regexp.escape("#{CS::GREEN}I#{CS::RESET}, #{CS::GREEN} INFO#{CS::RESET}"))
+      assert_match rgxp, layout.format(event)
+
+      event.level = @levels['debug']
+      rgxp = Regexp.new(Regexp.escape("#{CS::BLUE}D#{CS::RESET}, #{CS::BLUE}DEBUG#{CS::RESET}"))
+      assert_match rgxp, layout.format(event)
+
+      event.level = @levels['error']
+      rgxp = Regexp.new(Regexp.escape("#{CS::RED}E#{CS::RESET}, #{CS::RED}ERROR#{CS::RESET}"))
+      assert_match rgxp, layout.format(event)
+    end
+
+    def test_line_coloring
+      layout = Logging.layouts.pattern(:color_scheme => :lines)
+      event = Logging::LogEvent.new('ArrayLogger', @levels['info'], 'log message', false)
+
+      rgxp = Regexp.new('^'+Regexp.escape(CS::GREEN)+'.*?'+Regexp.escape(CS::RESET)+'$', Regexp::MULTILINE)
+      assert_match rgxp, layout.format(event)
+
+      event.level = @levels['error']
+      rgxp = Regexp.new('^'+Regexp.escape(CS::RED)+'.*?'+Regexp.escape(CS::RESET)+'$', Regexp::MULTILINE)
+      assert_match rgxp, layout.format(event)
+
+      event.level = @levels['warn']
+      rgxp = Regexp.new('^'+Regexp.escape(CS::YELLOW)+'.*?'+Regexp.escape(CS::RESET)+'$', Regexp::MULTILINE)
+      assert_match rgxp, layout.format(event)
+    end
+
+    def test_token_coloring
+      layout = Logging.layouts.pattern(:color_scheme => :tokens)
+      event = Logging::LogEvent.new('ArrayLogger', @levels['info'], 'log message', false)
+
+      rgxp = Regexp.new(
+        '^\['+Regexp.escape(CS::BLUE)+'\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'+Regexp.escape(CS::RESET)+
+        '\] INFO  -- '+Regexp.escape(CS::GREEN)+'ArrayLogger'+Regexp.escape(CS::RESET)+
+        ' : '+Regexp.escape(CS::MAGENTA)+'log message'+Regexp.escape(CS::RESET)
+      )
+      assert_match rgxp, layout.format(event)
+    end
+
+  end  # TestColorPattern
+end  # TestLayouts
+end  # TestLogging
+

data/test/layouts/test_json.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestLayouts

data/test/layouts/test_pattern.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../../setup', __FILE__)
 
 module TestLogging
 module TestLayouts
@@ -191,8 +191,7 @@ module TestLayouts
       assert_equal 'message{42}', @layout.format(event)
     end
 
-  end  # class TestBasic
-end  # module TestLayouts
-end  # module TestLogging
+  end  # TestBasic
+end  # TestLayouts
+end  # TestLogging
 
-# EOF

data/test/layouts/test_yaml.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[.. setup])
+require File.expand_path('../setup', File.dirname(__FILE__))
 
 module TestLogging
 module TestLayouts

data/test/test_appender.rb

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), %w[setup])
+require File.expand_path('setup', File.dirname(__FILE__))
 
 module TestLogging
 

data/test/test_color_scheme.rb

@@ -0,0 +1,39 @@
+
+require File.expand_path('../setup', __FILE__)
+
+module TestLogging
+
+  class TestColorScheme < Test::Unit::TestCase
+    include LoggingTestCase
+
+    def setup
+      super
+      ::Logging.init
+    end
+
+    def test_default_color_scheme
+      scheme = Logging.color_scheme :default
+      assert_instance_of ::Logging::ColorScheme, scheme
+
+      assert_equal false, scheme.include?(:debug)
+      assert scheme.include?(:info)
+      assert scheme.include?(:warn)
+      assert scheme.include?(:error)
+      assert scheme.include?(:fatal)
+    end
+
+    def test_lines_levels_exclusivity
+      assert_raise(ArgumentError) { Logging.color_scheme(:error, :lines => {}, :levels => {}) }
+    end
+
+    def test_colorization
+      scheme = Logging.color_scheme :default
+
+      assert_equal "no change", scheme.color('no change', :debug)
+      assert_equal "\e[32minfo is green\e[0m", scheme.color('info is green', :info)
+      assert_equal "\e[37m\e[41mfatal has multiple color codes\e[0m", scheme.color('fatal has multiple color codes', :fatal)
+    end
+
+  end  # TestColorScheme
+end  # TestLogging
+