logging 1.6.2 → 1.7.0

data/lib/logging/appenders/file.rb

@@ -1,6 +1,13 @@
 
 module Logging::Appenders
 
+  # Accessor / Factory for the File appender.
+  #
+  def self.file( *args )
+    return ::Logging::Appenders::File if args.empty?
+    ::Logging::Appenders::File.new(*args)
+  end
+
   # This class provides an Appender that can write to a File.
   #
   class File < ::Logging::Appenders::IO
@@ -70,6 +77,6 @@ module Logging::Appenders
       self
     end
 
-  end  # class FileAppender
-end  # module Logging::Appenders
+  end  # FileAppender
+end  # Logging::Appenders
 

data/lib/logging/appenders/growl.rb

@@ -1,6 +1,13 @@
 
 module Logging::Appenders
 
+  # Accessor / Factory for the Growl appender.
+  #
+  def self.growl( *args )
+    return ::Logging::Appenders::Growl if args.empty?
+    ::Logging::Appenders::Growl.new(*args)
+  end
+
   # This class provides an Appender that can send notifications to the Growl
   # notification system on Mac OS X.
   #
@@ -67,7 +74,7 @@ module Logging::Appenders
     end
 
 
-    private
+  private
 
     # call-seq:
     #    write( event )
@@ -150,8 +157,6 @@ module Logging::Appenders
           end
         end
       end
-
-      Thread.pass
     end
 
     # call-seq:
@@ -167,13 +172,12 @@ module Logging::Appenders
       @c_queue = []
 
       @c_thread = Thread.new do
-        Thread.stop
         loop do
-          sleep 0.5
+          Thread.stop if @c_queue.empty?
+          sleep 1
           @c_mutex.synchronize {
             call_growl(*@c_queue.shift) until @c_queue.empty?
           }
-          Thread.stop if @c_queue.empty?
         end  # loop
       end  # Thread.new
     end
@@ -191,6 +195,6 @@ module Logging::Appenders
       end
     end
 
-  end  # class Growl
-end  # module Logging::Appenders
+  end  # Growl
+end  # Logging::Appenders
 

data/lib/logging/appenders/io.rb

@@ -1,6 +1,13 @@
 
 module Logging::Appenders
 
+  # Accessor / Factory for the IO appender.
+  #
+  def self.io( *args )
+    return ::Logging::Appenders::IO if args.empty?
+    ::Logging::Appenders::IO.new(*args)
+  end
+
   # This class provides an Appender that can write to any IO stream
   # configured for writing.
   #
@@ -70,6 +77,6 @@ module Logging::Appenders
       ::Logging.log_internal(-2) {err}
     end
 
-  end  # class IO
-end  # module Logging::Appenders
+  end  # IO
+end  # Logging::Appenders
 

data/lib/logging/appenders/rolling_file.rb

@@ -1,6 +1,13 @@
 
 module Logging::Appenders
 
+  # Accessor / Factory for the RollingFile appender.
+  #
+  def self.rolling_file( *args )
+    return ::Logging::Appenders::RollingFile if args.empty?
+    ::Logging::Appenders::RollingFile.new(*args)
+  end
+
   # An appender that writes to a file and ensures that the file size or age
   # never exceeds some user specified level.
   #
@@ -324,6 +331,6 @@ module Logging::Appenders
     end
     # :startdoc:
 
-  end  # class RollingFile
-end  # module Logging::Appenders
+  end  # RollingFile
+end  # Logging::Appenders
 

data/lib/logging/appenders/string_io.rb

@@ -1,6 +1,13 @@
 
 module Logging::Appenders
 
+  # Accessor / Factory for the StringIo appender.
+  #
+  def self.string_io( *args )
+    return ::Logging::Appenders::StringIo if args.empty?
+    ::Logging::Appenders::StringIo.new(*args)
+  end
+
   # This class provides an Appender that can write to a StringIO instance.
   # This is very useful for testing log message output.
   #
@@ -80,6 +87,6 @@ module Logging::Appenders
     end
     # :startdoc:
 
-  end  # class StringIo
-end  # module Logging::Appenders
+  end  # StringIo
+end  # Logging::Appenders
 

data/lib/logging/appenders/syslog.rb

@@ -6,6 +6,13 @@ if HAVE_SYSLOG
 
 module Logging::Appenders
 
+  # Accessor / Factory for the Syslog appender.
+  #
+  def self.syslog( *args )
+    return ::Logging::Appenders::Syslog if args.empty?
+    ::Logging::Appenders::Syslog.new(*args)
+  end
+
   # This class provides an Appender that can write to the UNIX syslog
   # daemon.
   #
@@ -202,8 +209,7 @@ module Logging::Appenders
       end
     end
 
-  end  # class Syslog
-
-end  # module Logging::Appenders
+  end  # Syslog
+end  # Logging::Appenders
 end  # HAVE_SYSLOG
 

data/lib/logging/layouts.rb

@@ -1,46 +1,9 @@
 
 module Logging
-  module Layouts
+  module Layouts; end
 
-    # Accessor / Factory for the Basic layout.
-    #
-    def basic( *args )
-      return ::Logging::Layouts::Basic if args.empty?
-      ::Logging::Layouts::Basic.new(*args)
-    end
-
-    # Accessor / Factory for the Pattern layout.
-    #
-    def pattern( *args )
-      return ::Logging::Layouts::Pattern if args.empty?
-      ::Logging::Layouts::Pattern.new(*args)
-    end
-
-    # Accessor for the Parseable layout.
-    #
-    def parseable
-      ::Logging::Layouts::Parseable
-    end
-
-    # Factory for the Parseable layout using JSON formatting.
-    #
-    def json( *args )
-      ::Logging::Layouts::Parseable.json(*args)
-    end
-
-    # Factory for the Parseable layout using YAML formatting.
-    #
-    def yaml( *args )
-      ::Logging::Layouts::Parseable.yaml(*args)
-    end
-
-    extend self
-  end  # module Layouts
-end  # module Logging
-
-Logging.libpath {
-  require 'logging/layouts/basic'
-  require 'logging/layouts/parseable'
-  require 'logging/layouts/pattern'
-}
+  require libpath('logging/layouts/basic')
+  require libpath('logging/layouts/parseable')
+  require libpath('logging/layouts/pattern')
+end  # Logging
 

data/lib/logging/layouts/basic.rb

@@ -1,6 +1,13 @@
 
 module Logging::Layouts
 
+  # Accessor / Factory for the Basic layout.
+  #
+  def self.basic( *args )
+    return ::Logging::Layouts::Basic if args.empty?
+    ::Logging::Layouts::Basic.new(*args)
+  end
+
   # The +Basic+ layout class provides methods for simple formatting of log
   # events. The resulting string follows the format below.
   #

data/lib/logging/layouts/parseable.rb

@@ -1,6 +1,24 @@
 
 module Logging::Layouts
 
+  # Accessor for the Parseable layout.
+  #
+  def self.parseable
+    ::Logging::Layouts::Parseable
+  end
+
+  # Factory for the Parseable layout using JSON formatting.
+  #
+  def self.json( *args )
+    ::Logging::Layouts::Parseable.json(*args)
+  end
+
+  # Factory for the Parseable layout using YAML formatting.
+  #
+  def self.yaml( *args )
+    ::Logging::Layouts::Parseable.yaml(*args)
+  end
+
   # This layout will produce parseable log output in either JSON or YAML
   # format. This makes it much easier for machines to parse log files and
   # perform analysis on those logs.

data/lib/logging/layouts/pattern.rb

@@ -1,6 +1,13 @@
 
 module Logging::Layouts
 
+  # Accessor / Factory for the Pattern layout.
+  #
+  def self.pattern( *args )
+    return ::Logging::Layouts::Pattern if args.empty?
+    ::Logging::Layouts::Pattern.new(*args)
+  end
+
   # A flexible layout configurable with pattern string.
   #
   # The goal of this class is to format a LogEvent and return the results as

data/lib/logging/proxy.rb

@@ -33,6 +33,8 @@ module Logging
     # replace the +method_missing+ implementation
     #
     def initialize( object, &block )
+      Kernel.raise ArgumentError, "Cannot proxy nil" if nil.equal? object
+
       @object = object
       @leader = @object.is_a?(Class) ? "#{@object.name}." : "#{@object.class.name}#"
       @logger = Logging.logger[object]

data/lib/logging/utils.rb

@@ -1,5 +1,6 @@
 
 require 'thread'
+require 'rbconfig'
 
 # --------------------------------------------------------------------------
 class Hash
@@ -165,7 +166,8 @@ class File
   end
 
   # :stopdoc:
-  if %r/mswin|mingw/ =~ RUBY_PLATFORM
+  if Config::CONFIG['host_os'] =~ /mswin|windows|cygwin/i
+    # don't lock files on windows
     undef :flock?, :flock_sh
     def flock?() yield; end
     def flock_sh() yield; end

data/test/appenders/test_buffered_io.rb

@@ -171,4 +171,3 @@ module TestAppenders
 end  # module TestAppenders
 end  # module TestLogging
 
-# EOF

data/test/appenders/test_console.rb

@@ -63,4 +63,3 @@ module TestAppenders
 end  # module TestAppenders
 end  # module TestLogging
 
-# EOF

data/test/appenders/test_email.rb

@@ -14,14 +14,14 @@ module TestAppenders
 
       flexmock(Net::SMTP).new_instances do |m|
         m.should_receive(:start).at_least.once.with(
-            'test.logging', 'test', 'test', :cram_md5, Proc).and_yield(m)
+            'test.logging', 'test', 'test', :plain, Proc).and_yield(m)
         m.should_receive(:sendmail).at_least.once.with(String, 'me', ['you'])
       end
 
       @appender = Logging.appenders.email('email',
           'from' => 'me', 'to' => 'you',
           :buffer_size => '3', :immediate_at => 'error, fatal',
-          :domain => 'test.logging', :acct => 'test', :passwd => 'test'
+          :domain => 'test.logging', :user_name => 'test', :password => 'test'
       )
       @levels = Logging::LEVELS
     end
@@ -43,35 +43,36 @@ module TestAppenders
 
       assert_equal(100, appender.auto_flushing)
       assert_equal([], appender.instance_variable_get(:@immediate))
-      assert_equal('localhost', appender.server)
+      assert_equal('localhost', appender.address)
       assert_equal(25, appender.port)
 
       domain = ENV['HOSTNAME'] || 'localhost.localdomain'
       assert_equal(domain, appender.domain)
-      assert_equal(nil, appender.acct)
-      assert_equal(:cram_md5, appender.authtype)
-      assert_equal("Message of #{$0}", appender.subject)
+      assert_equal(nil, appender.user_name)
+      assert_equal(:plain, appender.authentication)
+      assert_equal("Message from #{$0}", appender.subject)
 
       appender = Logging.appenders.email('email',
           'from' => 'lbrinn@gmail.com', 'to' => 'everyone',
           :buffsize => '1000', :immediate_at => 'error, fatal',
-          :server => 'smtp.google.com', :port => '443',
-          :domain => 'google.com', :acct => 'lbrinn',
-          :passwd => '1234', :authtype => 'tls',
+          :address => 'smtp.google.com', :port => '443',
+          :domain => 'google.com', :user_name => 'lbrinn',
+          :password => '1234', :authentication => 'plain', :enable_starttls_auto => true,
           :subject => "I'm rich and you're not"
       )
 
       assert_equal('lbrinn@gmail.com', appender.instance_variable_get(:@from))
       assert_equal(['everyone'], appender.instance_variable_get(:@to))
       assert_equal(1000, appender.auto_flushing)
-      assert_equal('1234', appender.instance_variable_get(:@passwd))
+      assert_equal('1234', appender.password)
       assert_equal([nil, nil, nil, true, true],
                    appender.instance_variable_get(:@immediate))
-      assert_equal('smtp.google.com', appender.server)
+      assert_equal('smtp.google.com', appender.address)
       assert_equal(443, appender.port)
       assert_equal('google.com', appender.domain)
-      assert_equal('lbrinn', appender.acct)
-      assert_equal(:tls, appender.authtype)
+      assert_equal('lbrinn', appender.user_name)
+      assert_equal(:plain, appender.authentication)
+      assert(appender.enable_starttls_auto)
       assert_equal("I'm rich and you're not", appender.subject)
 
       appender = Logging.appenders.email('email',
@@ -167,4 +168,3 @@ module TestAppenders
 end  # module TestLogging
 end  # module TestAppenders
 
-# EOF

data/test/appenders/test_growl.rb

@@ -48,7 +48,7 @@ module TestAppenders
       @appender.append info
       @appender.append info
       @appender.append warn
-      sleep 0.7  # give the coalescing thread time to run
+      ensure_queue_is_empty
     end
 
     def test_append_without_coalescing
@@ -70,7 +70,7 @@ module TestAppenders
       @appender << 'first message'
       @appender << 'second message'
       @appender << 'third message'
-      sleep 0.7  # give the coalescing thread time to run
+      ensure_queue_is_empty
     end
 
     def test_concat_without_coalescing
@@ -120,8 +120,19 @@ module TestAppenders
       @appender.append event
     end
 
+  private
+
+    def ensure_queue_is_empty
+      start = Time.now
+
+      queue = @appender.instance_variable_get :@c_queue
+      sleep 0.2 until queue.empty? or (Time.now - start > 10)
+
+      thread = @appender.instance_variable_get :@c_thread
+      sleep 0.2 until thread.status == 'sleep' or (Time.now - start > 10)
+    end
+
   end  # class TestGrowl
 end  # module TestLogging
 end  # module TestAppenders
 
-# EOF

data/test/appenders/test_io.rb

@@ -125,4 +125,3 @@ module TestAppenders
 end  # module TestAppenders
 end  # module TestLogging
 
-# EOF

data/test/appenders/test_periodic_flushing.rb

@@ -44,8 +44,9 @@ module TestAppenders
 
     def test_periodic_flusher_running
       flusher = @appender.instance_variable_get(:@periodic_flusher)
-
       assert_instance_of Logging::Appenders::Buffering::PeriodicFlusher, flusher
+
+      sleep 0.250  # give the flusher thread another moment to start
       assert flusher.waiting?, 'the periodic flusher should be waiting for a signal'
     end