logging 0.9.8 → 1.0.0

data/examples/simple.rb

@@ -0,0 +1,14 @@
+#
+# Logging provides a simple, default logger configured in the same manner as
+# the default Ruby Logger class -- i.e. the output of the two will be the
+# same. All log messags at "warn" or higher are printed to STDOUT; any
+# message below the "warn" level are discarded.
+#
+
+  require 'logging'
+
+  log = Logging.logger(STDOUT)
+  log.level = :warn
+
+  log.debug "this debug message will not be output by the logger"
+  log.warn "this is your last warning"

data/lib/logging.rb

@@ -3,7 +3,24 @@
 # Used to prevent the class/module from being loaded more than once
 unless defined? Logging
 
+require 'yaml'
+require 'stringio'
 require 'thread'
+
+begin
+  require 'lockfile'
+rescue LoadError
+  retry if require 'rubygems'
+  raise
+end
+
+begin
+  require 'syslog'
+  HAVE_SYSLOG = true
+rescue LoadError
+  HAVE_SYSLOG = false
+end
+
 begin require 'fastthread'; rescue LoadError; end
 
 # TODO: Windows Log Service appender
@@ -13,7 +30,7 @@ begin require 'fastthread'; rescue LoadError; end
 module Logging
 
   # :stopdoc:
-  VERSION = '0.9.8'
+  VERSION = '1.0.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM
@@ -85,6 +102,8 @@ module Logging
     # full description of the :pattern and :date_pattern formatting strings.
     #
     def logger( *args )
+      return ::Logging::Logger if args.empty?
+
       opts = args.pop if args.last.instance_of?(Hash)
       opts ||= Hash.new
 
@@ -141,6 +160,18 @@ module Logging
       logger
     end
 
+    # Access to the layouts.
+    #
+    def layouts
+      ::Logging::Layouts
+    end
+
+    # Access to the appenders.
+    #
+    def appenders
+      ::Logging::Appenders
+    end
+
     # call-seq:
     #    Logging.init( levels )
     #
@@ -182,8 +213,8 @@ module Logging
       args = %w(debug info warn error fatal) if args.empty?
 
       args.flatten!
-      levels = ::Logging::LEVELS.clear
-      names = ::Logging::LNAMES.clear
+      levels = LEVELS.clear
+      names = LNAMES.clear
 
       id = 0
       args.each do |lvl|
@@ -274,19 +305,6 @@ module Logging
       args.empty? ? PATH : ::File.join(PATH, args.flatten)
     end
 
-    # Utility method used to rquire all files ending in .rb that lie in the
-    # directory below this file that has the same name as the filename passed
-    # in. Optionally, a specific _directory_ name can be passed in such that
-    # the _filename_ does not have to be equivalent to the directory.
-    #
-    def require_all_libs_relative_to( fname, dir = nil )
-      dir ||= ::File.basename(fname, '.*')
-      search_me = ::File.expand_path(
-          ::File.join(::File.dirname(fname), dir, '*.rb'))
-
-      Dir.glob(search_me).sort.each {|rb| require rb}
-    end
-
     # call-seq:
     #    show_configuration( io = STDOUT, logger = 'root' )
     #
@@ -386,8 +404,21 @@ module Logging
   end
 end  # module Logging
 
-Logging.require_all_libs_relative_to(__FILE__)
-Logging.require_all_libs_relative_to(__FILE__, 'logging/config')
+
+require Logging.libpath(%w[logging utils])
+require Logging.libpath(%w[logging appender])
+require Logging.libpath(%w[logging layout])
+require Logging.libpath(%w[logging log_event])
+require Logging.libpath(%w[logging logger])
+require Logging.libpath(%w[logging repository])
+require Logging.libpath(%w[logging root_logger])
+require Logging.libpath(%w[logging stats])
+require Logging.libpath(%w[logging appenders])
+require Logging.libpath(%w[logging layouts])
+
+require Logging.libpath(%w[logging config configurator])
+require Logging.libpath(%w[logging config yaml_configurator])
+
 
 # This exit handler will close all the appenders that exist in the system.
 # This is needed for closing IO streams and connections to the syslog server
@@ -395,9 +426,7 @@ Logging.require_all_libs_relative_to(__FILE__, 'logging/config')
 #
 at_exit {
   Logging.log_internal {'at_exit hook called - closing all appenders'}
-  Logging::Appender.instance_variable_get(:@appenders).values.each do |ap|
-    ap.close
-  end
+  Logging::Appenders.each {|appender| appender.close}
 }
 
 end  # unless defined?

data/lib/logging/appender.rb

@@ -16,58 +16,6 @@ module Logging
 #
 class Appender
 
-  @appenders = Hash.new
-
-  class << self
-
-    # call-seq:
-    #    Appender[name]
-    #
-    # Returns the appender instance stroed in the Appender hash under the
-    # key _name_, or +nil+ if no appender has been created using that name.
-    #
-    def []( name ) @appenders[name] end
-
-    # call-seq:
-    #    Appender[name] = appender
-    #
-    # Stores the given _appender_ instance in the Appender hash under the
-    # key _name_.
-    #
-    def []=( name, val ) @appenders[name] = val end
-
-    # call-seq:
-    #    Appenders.remove( name )
-    #
-    # Removes the appender instance stored in the Appender hash under the
-    # key _name_.
-    #
-    def remove( name ) @appenders.delete(name) end
-
-    # call-seq:
-    #    Appender.stdout
-    #
-    # Returns an instance of the Stdout Appender. Unless the user explicitly
-    # creates a new Stdout Appender, the instance returned by this method
-    # will always be the same:
-    #
-    #    Appender.stdout.object_id == Appender.stdout.object_id    #=> true
-    #
-    def stdout( ) self['stdout'] || ::Logging::Appenders::Stdout.new end
-
-    # call-seq:
-    #    Appender.stderr
-    #
-    # Returns an instance of the Stderr Appender. Unless the user explicitly
-    # creates a new Stderr Appender, the instance returned by this method
-    # will always be the same:
-    #
-    #    Appender.stderr.object_id == Appender.stderr.object_id    #=> true
-    #
-    def stderr( ) self['stderr'] || ::Logging::Appenders::Stderr.new end
-
-  end  # class << self
-
   attr_reader :name, :layout, :level
 
   # call-seq:
@@ -85,6 +33,8 @@ class Appender
   #    :level    => the level at which to log
   #
   def initialize( name, opts = {} )
+    ::Logging.init unless ::Logging.const_defined? :MAX_LEVEL_LENGTH
+
     @name = name.to_s
     @closed = false
 
@@ -102,7 +52,7 @@ class Appender
       end
     end
 
-    ::Logging::Appender[@name] = self
+    ::Logging::Appenders[@name] = self
   end
 
   # call-seq:
@@ -217,7 +167,7 @@ class Appender
   #
   def close( footer = true )
     return self if @closed
-    ::Logging::Appender.remove(@name)
+    ::Logging::Appenders.remove(@name)
     @closed = true
 
     sync {flush}
@@ -298,6 +248,4 @@ class Appender
 end  # class Appender
 end  # module Logging
 
-Logging.require_all_libs_relative_to(__FILE__, 'appenders')
-
 # EOF

data/lib/logging/appenders.rb

@@ -0,0 +1,120 @@
+
+module Logging
+  module Appenders
+
+    # Accessor / Factory for the Email appender.
+    #
+    def email( *args )
+      return ::Logging::Appenders::Email if args.empty?
+      ::Logging::Appenders::Email.new(*args)
+    end
+
+    # Accessor / Factory for the File appender.
+    #
+    def file( *args )
+      return ::Logging::Appenders::File if args.empty?
+      ::Logging::Appenders::File.new(*args)
+    end
+
+    # Accessor / Factory for the Growl appender.
+    #
+    def growl( *args )
+      return ::Logging::Appenders::Growl if args.empty?
+      ::Logging::Appenders::Growl.new(*args)
+    end
+
+    # Accessor / Factory for the IO appender.
+    #
+    def io( *args )
+      return ::Logging::Appenders::IO if args.empty?
+      ::Logging::Appenders::IO.new(*args)
+    end
+
+    # Accessor / Factory for the RollingFile appender.
+    #
+    def rolling_file( *args )
+      return ::Logging::Appenders::RollingFile if args.empty?
+      ::Logging::Appenders::RollingFile.new(*args)
+    end
+
+    # Accessor / Factory for the Stderr appender.
+    #
+    def stderr( *args )
+      if args.empty?
+        return self['stderr'] || ::Logging::Appenders::Stderr.new
+      end
+      ::Logging::Appenders::Stderr.new(*args)
+    end
+
+    # Accessor / Factory for the Stdout appender.
+    #
+    def stdout( *args )
+      if args.empty?
+        return self['stdout'] || ::Logging::Appenders::Stdout.new
+      end
+      ::Logging::Appenders::Stdout.new(*args)
+    end
+
+    # Accessor / Factory for the StringIo appender.
+    #
+    def string_io( *args )
+      return ::Logging::Appenders::StringIo if args.empty?
+      ::Logging::Appenders::StringIo.new(*args)
+    end
+
+  if HAVE_SYSLOG
+    # Accessor / Factory for the Syslog appender.
+    #
+    def syslog( *args )
+      return ::Logging::Appenders::Syslog if args.empty?
+      ::Logging::Appenders::Syslog.new(*args)
+    end
+  end
+
+    # call-seq:
+    #    Appenders[name]
+    #
+    # Returns the appender instance stroed in the appender hash under the
+    # key _name_, or +nil+ if no appender has been created using that name.
+    #
+    def []( name ) @appenders[name] end
+
+    # call-seq:
+    #    Appenders[name] = appender
+    #
+    # Stores the given _appender_ instance in the appender hash under the
+    # key _name_.
+    #
+    def []=( name, value ) @appenders[name] = value end
+
+    # call-seq:
+    #    Appenders.remove( name )
+    #
+    # Removes the appender instance stored in the appender hash under the
+    # key _name_.
+    #
+    def remove( name ) @appenders.delete(name) end
+
+    # call-seq:
+    #    each {|appender| block}
+    #
+    # Yield each appender to the _block_.
+    #
+    def each( &block )
+      @appenders.values.each(&block)
+      nil
+    end
+
+    extend self
+    @appenders = Hash.new
+
+  end  # module Appenders
+end  # module Logging
+
+
+%w[buffering io console email file growl rolling_file string_io syslog].
+each do |fn|
+  require ::Logging.libpath('logging', 'appenders', fn)
+end
+
+# EOF

data/lib/logging/appenders/buffering.rb

@@ -117,8 +117,9 @@ module Logging::Appenders
     # options.
     #
     def configure_buffering( opts )
-      @buffer = []
+      ::Logging.init unless ::Logging.const_defined? :MAX_LEVEL_LENGTH
 
+      @buffer = []
       self.immediate_at = opts.getopt(:immediate_at, '')
       self.auto_flushing = opts.getopt(:auto_flushing, true)
     end

data/lib/logging/appenders/console.rb

@@ -1,6 +1,4 @@
 
-require Logging.libpath(*%w[logging appenders io])
-
 module Logging::Appenders
 
   # This class provides an Appender that can write to STDOUT.

data/lib/logging/appenders/rolling_file.rb

@@ -1,6 +1,4 @@
 
-require 'lockfile'
-
 module Logging::Appenders
 
   # An appender that writes to a file and ensures that the file size or age

data/lib/logging/appenders/string_io.rb

@@ -1,6 +1,4 @@
 
-require 'stringio'
-
 module Logging::Appenders
 
   # This class provides an Appender that can write to a StringIO instance.
@@ -20,8 +18,8 @@ module Logging::Appenders
     def initialize( name, opts = {} )
       @sio = StringIO.new
       @sio.extend IoToS
+      @pos = 0
       super(name, @sio, opts)
-      clear
     end
 
     # Clears the internal StringIO instance. All log messages are removed

data/lib/logging/appenders/syslog.rb

@@ -1,11 +1,4 @@
 
-begin
-  require 'syslog'
-  HAVE_SYSLOG = true
-rescue LoadError
-  HAVE_SYSLOG = false
-end
-
 # only load this class if we have the syslog library
 # Windows does not have syslog
 #

data/lib/logging/config/configurator.rb

@@ -82,7 +82,7 @@ module Logging::Config
         l.additive  = config[:additive] if l.respond_to? :additive= 
         l.trace     = config[:trace]
         l.appenders = Array(config[:appenders]).
-                            map {|nm| ::Logging::Appender[nm]}
+                            map {|nm| ::Logging::Appenders[nm]}
       end
     end
 

data/lib/logging/config/yaml_configurator.rb

@@ -1,8 +1,5 @@
 
-require 'yaml'
-
-module Logging
-module Config
+module Logging::Config
 
   # The YamlConfigurator class is used to configure the Logging framework
   # using information found in a YAML file.
@@ -137,7 +134,7 @@ module Config
         l.trace = config['trace'] if l.respond_to? :trace=
 
         if config.has_key?('appenders')
-          l.appenders = config['appenders'].map {|n| ::Logging::Appender[n]}
+          l.appenders = config['appenders'].map {|n| ::Logging::Appenders[n]}
         end
       end
     end
@@ -189,7 +186,6 @@ module Config
     end
 
   end  # class YamlConfigurator
-end  # module Config
-end  # module Logging
+end  # module Logging::Config
 
 # EOF