logging 0.6.2 → 0.6.3

data/History.txt

@@ -1,13 +1,21 @@
+== 0.6.3 / 2008-02-08
+
+2 minor enhancements
+  - YAML configuration now supports multiple keys -- i.e. development
+    or production or whatever
+  - Reorganized a lot of files so that requiring files is cleaner and
+    more deterministic
+
 == 0.6.2 / 2008-02-06
 
-2 bugfixes
+2 bug fixes
   - An extra e-mail was being pushed out when the e-mail
     appender was closed
   - Created an at_exit handler to close all appenders
 
 == 0.6.1 / 2008-01-01
 
-1 bugfix
+1 bug fix
   - Fixed include order to avoid double loading when testing
 
 == 0.6.0 / 2007-12-26
@@ -40,8 +48,8 @@
 
 * Added a microsecond flag to the Pattern layout
 * All appenders write immediately upon receipt of a logging event
-* Added a basic logging method tha returns a logger object configured in the
-  same manner as the standard Ruby logger
+* Added a basic logging method that returns a logger object configured in
+  the same manner as the standard Ruby logger
 * Fixed a bug caused by nil log messages
 
 == 0.3.1 / 2007-02-08
@@ -55,7 +63,7 @@
 == 0.2.0 / 2007-01-29
 
 * The "once every four years" release
-* Storage and retrieveal of appenders by name
+* Storage and retrieval of appenders by name
 * YAML configuration support
 * Rolling file appender
 

data/Manifest.txt

@@ -11,7 +11,6 @@ lib/logging/appenders/file.rb
 lib/logging/appenders/growl.rb
 lib/logging/appenders/io.rb
 lib/logging/appenders/rolling_file.rb
-lib/logging/appenders/static_appender.rb
 lib/logging/appenders/syslog.rb
 lib/logging/config/yaml_configurator.rb
 lib/logging/layout.rb

data/lib/logging.rb

@@ -1,39 +1,23 @@
-# $Id: logging.rb 85 2008-02-06 17:59:00Z tim_pease $
-
-require 'logging/utils'
-require 'logging/log_event'
-require 'logging/logger'
-require 'logging/root_logger'
-require 'logging/repository'
-require 'logging/appender'
-require 'logging/layout'
-
-# require all appenders
-require 'logging/appenders/static_appender'
-require 'logging/appenders/io'
-require 'logging/appenders/console'
-require 'logging/appenders/email'
-require 'logging/appenders/file'
-require 'logging/appenders/growl'
-require 'logging/appenders/rolling_file'
-require 'logging/appenders/syslog'
-
-# require all layouts
-require 'logging/layouts/basic'
-require 'logging/layouts/pattern'
-
-# require all configurators
-require 'logging/config/yaml_configurator'
+# $Id: logging.rb 90 2008-02-08 19:03:48Z tim_pease $
 
+# Equivalent to a header guard in C/C++
+# Used to prevent the class/module from being loaded more than once
+unless defined? Logging
+
+# TODO: internal logger for debugging
+# TODO: Windows Log Service appender
 
 #
 #
 module Logging
 
-  VERSION = '0.6.2'   # :nodoc:
-
-  LEVELS = {}  # :nodoc:
-  LNAMES = {}  # :nodoc:
+  # :stopdoc:
+  VERSION = '0.6.3'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  LEVELS = {}
+  LNAMES = {}
+  # :startdoc:
 
   class << self
 
@@ -44,10 +28,10 @@ module Logging
     # found in the given file. The file extension should be either '.yaml'
     # or '.yml' (XML configuration is not yet supported).
     #
-    def configure( filename )
+    def configure( filename, *args )
       case File.extname(filename)
       when '.yaml', '.yml'
-        ::Logging::Config::YamlConfigurator.load(filename)
+        ::Logging::Config::YamlConfigurator.load(filename, *args)
       else raise ArgumentError, 'unknown configuration file format' end
     end
 
@@ -232,8 +216,42 @@ module Logging
       module_eval "OBJ_FORMAT = :#{f}"
     end
 
-    # :stopdoc:
+    # Returns the version string for the library.
+    #
+    def version
+      VERSION
+    end
 
+    # Returns the library path for the module. If any arguments are given,
+    # they will be joined to the end of the libray path using
+    # <tt>File.join</tt>.
+    #
+    def libpath( *args )
+      args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
+    end
+
+    # Returns the lpath for the module. If any arguments are given,
+    # they will be joined to the end of the path using
+    # <tt>File.join</tt>.
+    #
+    def path( *args )
+      args.empty? ? PATH : ::File.join(PATH, *args)
+    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
+
+    # :stopdoc:
     # Convert the given level into a connaconical form - a lowercase string.
     def levelify( level )
       case level
@@ -252,9 +270,11 @@ module Logging
     end
     # :startdoc:
   end
-
 end  # module Logging
 
+Logging.require_all_libs_relative_to(__FILE__)
+Logging.require_all_libs_relative_to(__FILE__, 'logging/config')
+
 # 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
 # or e-mail servers, etc.
@@ -265,4 +285,6 @@ at_exit {
   end
 }
 
+end  # unless defined?
+
 # EOF

data/lib/logging/appender.rb

@@ -1,203 +1,257 @@
-# $Id: appender.rb 85 2008-02-06 17:59:00Z tim_pease $
+# $Id: appender.rb 88 2008-02-08 18:47:36Z tim_pease $
 
 require 'thread'
 
 module Logging
 
-  # The +Appender+ class is provides methods for appending log events to a
-  # logging destination. The log events are formatted into strings using a
-  # Layout.
-  #
-  # All other Appenders inherit from this class which provides stub methods.
-  # Each subclass should provide a +write+ method that will write log
-  # messages to the logging destination.
-  #
-  # A private +sync+ method is provided for use by subclasses. It is used to
-  # synchronize writes to the logging destination, and can be used by
-  # subclasses to synchronize the closing or flushing of the logging
-  # destination.
-  #
-  class Appender
+# The +Appender+ class is provides methods for appending log events to a
+# logging destination. The log events are formatted into strings using a
+# Layout.
+#
+# All other Appenders inherit from this class which provides stub methods.
+# Each subclass should provide a +write+ method that will write log
+# messages to the logging destination.
+#
+# A private +sync+ method is provided for use by subclasses. It is used to
+# synchronize writes to the logging destination, and can be used by
+# subclasses to synchronize the closing or flushing of the logging
+# destination.
+#
+class Appender
 
-    attr_reader :name, :layout, :level
+  @appenders = Hash.new
+
+  class << self
 
     # call-seq:
-    #    Appender.new( name )
-    #    Appender.new( name, :layout => layout )
+    #    Appender[name]
     #
-    # Creates a new appender using the given name. If no Layout is specified,
-    # then a Basic layout will be used. Any logging header supplied by the
-    # layout will be written to the logging destination when the Appender is
-    # created.
+    # 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 initialize( name, opts = {} )
-      @name = name.to_s
-      @closed = false
-
-      self.layout = opts.getopt(:layout, ::Logging::Layouts::Basic.new)
-      self.level = opts.getopt(:level)
-
-      @mutex = Mutex.new
-      header = @layout.header
-      sync {write(header)} unless header.nil? || header.empty?
-
-      ::Logging::Appender[@name] = self
-    end
+    def []( name ) @appenders[name] end
 
     # call-seq:
-    #    append( event )
+    #    Appender[name] = appender
     #
-    # Write the given _event_ to the logging destination. The log event will
-    # be processed through the Layout associated with the Appender.
+    # Stores the given _appender_ instance in the Appender hash under the
+    # key _name_.
     #
-    def append( event )
-      if @closed
-        raise RuntimeError,
-              "appender '<#{self.class.name}: #{@name}>' is closed"
-      end
-
-      sync {write(event)} unless @level > event.level
-      self
-    end
+    def []=( name, val ) @appenders[name] = val end
 
     # call-seq:
-    #    appender << string
+    #    Appenders.remove( name )
     #
-    # Write the given _string_ to the logging destination "as is" -- no
-    # layout formatting will be performed.
+    # Removes the appender instance stored in the Appender hash under the
+    # key _name_.
     #
-    def <<( str )
-      if @closed
-        raise RuntimeError,
-              "appender '<#{self.class.name}: #{@name}>' is closed"
-      end
-
-      sync {write(str)} unless @level >= ::Logging::LEVELS.length
-      self
-    end
+    def remove( name ) @appenders.delete(name) end
 
     # call-seq:
-    #    level = :all
-    #
-    # Set the level for this appender; log events below this level will be
-    # ignored by this appender. The level can be either a +String+, a
-    # +Symbol+, or a +Fixnum+. An +ArgumentError+ is raised if this is not
-    # the case.
+    #    Appender.stdout
     #
-    # There are two special levels -- "all" and "off". The former will
-    # enable recording of all log events. The latter will disable the
-    # recording of all events.
+    # 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:
     #
-    # Example:
+    #    Appender.stdout.object_id == Appender.stdout.object_id    #=> true
     #
-    #    appender.level = :debug
-    #    appender.level = "INFO"
-    #    appender.level = 4
-    #    appender.level = 'off'
-    #    appender.level = :all
+    def stdout( ) self['stdout'] || ::Logging::Appenders::Stdout.new end
+
+    # call-seq:
+    #    Appender.stderr
     #
-    # These prodcue an +ArgumentError+
+    # 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.level = Object
-    #    appender.level = -1
-    #    appender.level = 1_000_000_000_000
+    #    Appender.stderr.object_id == Appender.stderr.object_id    #=> true
     #
-    def level=( level )
-      lvl = case level
-            when String, Symbol; ::Logging::level_num(level)
-            when Fixnum; level
-            when nil; 0
-            else
-              raise ArgumentError,
-                    "level must be a String, Symbol, or Integer"
-            end
-      if lvl.nil? or lvl < 0 or lvl > ::Logging::LEVELS.length
-        raise ArgumentError, "unknown level was given '#{level}'"
-      end
-
-      @level = lvl
+    def stderr( ) self['stderr'] || ::Logging::Appenders::Stderr.new end
+
+  end  # class << self
+
+  attr_reader :name, :layout, :level
+
+  # call-seq:
+  #    Appender.new( name )
+  #    Appender.new( name, :layout => layout )
+  #
+  # Creates a new appender using the given name. If no Layout is specified,
+  # then a Basic layout will be used. Any logging header supplied by the
+  # layout will be written to the logging destination when the Appender is
+  # created.
+  #
+  def initialize( name, opts = {} )
+    @name = name.to_s
+    @closed = false
+
+    self.layout = opts.getopt(:layout, ::Logging::Layouts::Basic.new)
+    self.level = opts.getopt(:level)
+
+    @mutex = Mutex.new
+    header = @layout.header
+    sync {write(header)} unless header.nil? || header.empty?
+
+    ::Logging::Appender[@name] = self
+  end
+
+  # call-seq:
+  #    append( event )
+  #
+  # Write the given _event_ to the logging destination. The log event will
+  # be processed through the Layout associated with the Appender.
+  #
+  def append( event )
+    if @closed
+      raise RuntimeError,
+            "appender '<#{self.class.name}: #{@name}>' is closed"
     end
 
-    # call-seq
-    #    appender.layout = Logging::Layouts::Basic.new
-    #
-    # Sets the layout to be used by this appender.
-    #
-    def layout=( layout )
-      unless layout.kind_of? ::Logging::Layout
-        raise TypeError,
-              "#{layout.inspect} is not a kind of 'Logging::Layout'"
-      end
-      @layout = layout
+    sync {write(event)} unless @level > event.level
+    self
+  end
+
+  # call-seq:
+  #    appender << string
+  #
+  # Write the given _string_ to the logging destination "as is" -- no
+  # layout formatting will be performed.
+  #
+  def <<( str )
+    if @closed
+      raise RuntimeError,
+            "appender '<#{self.class.name}: #{@name}>' is closed"
     end
 
-    # call-seq:
-    #    close( footer = true )
-    #
-    # Close the appender and writes the layout footer to the logging
-    # destination if the _footer_ flag is set to +true+. Log events will
-    # no longer be written to the logging destination after the appender
-    # is closed.
-    #
-    def close( footer = true )
-      return self if @closed
-      ::Logging::Appender.remove(@name)
-      @closed = true
-      if footer
-        footer = @layout.footer
-        sync {write(footer)} unless footer.nil? || footer.empty?
-      end
-      self
+    sync {write(str)} unless @level >= ::Logging::LEVELS.length
+    self
+  end
+
+  # call-seq:
+  #    level = :all
+  #
+  # Set the level for this appender; log events below this level will be
+  # ignored by this appender. The level can be either a +String+, a
+  # +Symbol+, or a +Fixnum+. An +ArgumentError+ is raised if this is not
+  # the case.
+  #
+  # There are two special levels -- "all" and "off". The former will
+  # enable recording of all log events. The latter will disable the
+  # recording of all events.
+  #
+  # Example:
+  #
+  #    appender.level = :debug
+  #    appender.level = "INFO"
+  #    appender.level = 4
+  #    appender.level = 'off'
+  #    appender.level = :all
+  #
+  # These prodcue an +ArgumentError+
+  #
+  #    appender.level = Object
+  #    appender.level = -1
+  #    appender.level = 1_000_000_000_000
+  #
+  def level=( level )
+    lvl = case level
+          when String, Symbol; ::Logging::level_num(level)
+          when Fixnum; level
+          when nil; 0
+          else
+            raise ArgumentError,
+                  "level must be a String, Symbol, or Integer"
+          end
+    if lvl.nil? or lvl < 0 or lvl > ::Logging::LEVELS.length
+      raise ArgumentError, "unknown level was given '#{level}'"
     end
 
-    # call-seq:
-    #    closed?
-    #
-    # Returns +true+ if the appender has been closed; returns +false+
-    # otherwise. When an appender is closed, no more log events can be
-    # written to the logging destination.
-    #
-    def closed?
-      @closed
+    @level = lvl
+  end
+
+  # call-seq
+  #    appender.layout = Logging::Layouts::Basic.new
+  #
+  # Sets the layout to be used by this appender.
+  #
+  def layout=( layout )
+    unless layout.kind_of? ::Logging::Layout
+      raise TypeError,
+            "#{layout.inspect} is not a kind of 'Logging::Layout'"
     end
+    @layout = layout
+  end
 
-    # call-seq:
-    #    flush
-    #
-    # Call +flush+ to force an appender to write out any buffered log events.
-    # Similar to IO#flush, so use in a similar fashion.
-    #
-    def flush
-      self
+  # call-seq:
+  #    close( footer = true )
+  #
+  # Close the appender and writes the layout footer to the logging
+  # destination if the _footer_ flag is set to +true+. Log events will
+  # no longer be written to the logging destination after the appender
+  # is closed.
+  #
+  def close( footer = true )
+    return self if @closed
+    ::Logging::Appender.remove(@name)
+    @closed = true
+    if footer
+      footer = @layout.footer
+      sync {write(footer)} unless footer.nil? || footer.empty?
     end
+    self
+  end
 
+  # call-seq:
+  #    closed?
+  #
+  # Returns +true+ if the appender has been closed; returns +false+
+  # otherwise. When an appender is closed, no more log events can be
+  # written to the logging destination.
+  #
+  def closed?
+    @closed
+  end
 
-    private 
+  # call-seq:
+  #    flush
+  #
+  # Call +flush+ to force an appender to write out any buffered log events.
+  # Similar to IO#flush, so use in a similar fashion.
+  #
+  def flush
+    self
+  end
 
-    # call-seq:
-    #    write( event )
-    #
-    # Writes the given _event_ to the logging destination. Subclasses should
-    # provide an implementation of this method. The _event_ can be either a
-    # LogEvent or a String. If a LogEvent, then it will be formatted using
-    # the layout given to the appender when it was created.
-    #
-    def write( event )
-      nil
-    end
 
-    # call-seq:
-    #    sync { block }
-    #
-    # Obtains an exclusive lock, runs the block, and releases the lock when
-    # the block completes. This method is re-entrant so that a single thread
-    # can call +sync+ multiple times without hanging the thread.
-    #
-    def sync
-      @mutex.synchronize {yield}
-    end
+  private 
+
+  # call-seq:
+  #    write( event )
+  #
+  # Writes the given _event_ to the logging destination. Subclasses should
+  # provide an implementation of this method. The _event_ can be either a
+  # LogEvent or a String. If a LogEvent, then it will be formatted using
+  # the layout given to the appender when it was created.
+  #
+  def write( event )
+    nil
+  end
 
-  end  # class Appender
+  # call-seq:
+  #    sync { block }
+  #
+  # Obtains an exclusive lock, runs the block, and releases the lock when
+  # the block completes. This method is re-entrant so that a single thread
+  # can call +sync+ multiple times without hanging the thread.
+  #
+  def sync
+    @mutex.synchronize {yield}
+  end
+
+end  # class Appender
 end  # module Logging
 
+Logging.require_all_libs_relative_to(__FILE__, 'appenders')
+
 # EOF

data/lib/logging/appenders/console.rb

@@ -1,4 +1,6 @@
-# $Id: console.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: console.rb 88 2008-02-08 18:47:36Z tim_pease $
+
+require Logging.libpath(*%w[logging appenders io])
 
 module Logging::Appenders
 

data/lib/logging/config/yaml_configurator.rb

@@ -1,4 +1,4 @@
-# $Id: yaml_configurator.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: yaml_configurator.rb 88 2008-02-08 18:47:36Z tim_pease $
 
 require 'yaml'
 
@@ -15,44 +15,54 @@ module Config
     class << self
 
       # call-seq:
-      #    YamlConfigurator.load( file )
+      #    YamlConfigurator.load( file, key = 'logging_config' )
       #
       # Load the given YAML _file_ and use it to configure the Logging
       # framework. The file can be either a filename, and open File, or an
       # IO object. If it is the latter two, the File / IO object will not be
       # closed by this method.
       #
-      def load( file )
+      # The configuration will be loaded from the given _key_ in the YAML
+      # stream.
+      #
+      def load( file, key = 'logging_config' )
         io, close = nil, false
         case file
         when String
           io = File.open(file, 'r')
           close = true
-        when IO; io = file
-        else raise Error, 'expecting a filename or a File' end
+        when IO
+          io = file
+        else
+          raise Error, 'expecting a filename or a File'
+        end
 
-        begin new(io).load; ensure; io.close if close end
+        begin
+          new(io, key).load
+        ensure
+          io.close if close
+        end
         nil
       end
     end  # class << self
 
     # call-seq:
-    #    YamlConfigurator.new( io )
+    #    YamlConfigurator.new( io, key )
     #
     # Creates a new YAML configurator that will load the Logging
-    # configuration from the given _io_ stream.
+    # configuration from the given _io_ stream. The configuration will be
+    # loaded from the given _key_ in the YAML stream.
     #
-    def initialize( io )
+    def initialize( io, key  )
       YAML.load_documents(io) do |doc|
-        @config = doc['logging_config']
+        @config = doc[key]
         break if @config.instance_of?(Hash)
       end
 
       unless @config.instance_of?(Hash)
-        raise Error, "Key 'logging_config' not defined in YAML configuration"
+        raise Error, "Key '#{key}' not defined in YAML configuration"
       end
     end
-    private :initialize
 
     # call-seq:
     #    load

data/lib/logging/layout.rb

@@ -1,101 +1,103 @@
-# $Id: layout.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: layout.rb 88 2008-02-08 18:47:36Z tim_pease $
  
 require 'yaml'
 
 module Logging
 
-  # The +Layout+ class provides methods for formatting log events into a
-  # string representation. Layouts are used by Appenders to format log
-  # events before writing them to the logging destination.
+# The +Layout+ class provides methods for formatting log events into a
+# string representation. Layouts are used by Appenders to format log
+# events before writing them to the logging destination.
+#
+# All other Layouts inherit from this class which provides stub methods.
+# Each subclass should provide a +format+ method. A layout can be used by
+# more than one +Appender+ so all the methods need to be thread safe.
+#
+class Layout
+
+  # call-seq:
+  #    Layout.new( :format_as => :string )
+  #
+  # Creates a new layout that will format objecs as strings using the
+  # given <tt>:format_as</tt> style. This can be one of <tt>:string</tt>,
+  # <tt>:inspect</tt>, or <tt>:yaml</tt>. These formatting commands map to
+  # the following object methods:
   #
-  # All other Layouts inherit from this class which provides stub methods.
-  # Each subclass should provide a +format+ method. A layout can be used by
-  # more than one +Appender+ so all the methods need to be thread safe.
+  # * :string  => to_s
+  # * :inspect => inspect
+  # * :yaml    => to_yaml
   #
-  class Layout
+  # If the format is not specified then the global object format is used
+  # (see Logging#format_as). If the global object format is not specified
+  # then <tt>:string</tt> is used.
+  #
+  def initialize( opts = {} )
+    default = ::Logging.const_defined?('OBJ_FORMAT') ?
+              ::Logging::OBJ_FORMAT : nil
 
-    # call-seq:
-    #    Layout.new( :format_as => :string )
-    #
-    # Creates a new layout that will format objecs as strings using the
-    # given <tt>:format_as</tt> style. This can be one of <tt>:string</tt>,
-    # <tt>:inspect</tt>, or <tt>:yaml</tt>. These formatting commands map to
-    # the following object methods:
-    #
-    # * :string  => to_s
-    # * :inspect => inspect
-    # * :yaml    => to_yaml
-    #
-    # If the format is not specified then the global object format is used
-    # (see Logging#format_as). If the global object format is not specified
-    # then <tt>:string</tt> is used.
-    #
-    def initialize( opts = {} )
-      default = ::Logging.const_defined?('OBJ_FORMAT') ?
-                ::Logging::OBJ_FORMAT : nil
+    f = opts.getopt(:format_as, default)
+    f = f.intern if f.instance_of? String
 
-      f = opts.getopt(:format_as, default)
-      f = f.intern if f.instance_of? String
+    @obj_format = case f
+                  when :inspect, :yaml; f
+                  else :string end
+  end
 
-      @obj_format = case f
-                    when :inspect, :yaml; f
-                    else :string end
-    end
-
-    # call-seq:
-    #    format( event )
-    #
-    # Returns a string representation of the given loggging _event_. It is
-    # up to subclasses to implement this method.
-    #
-    def format( event ) nil end
+  # call-seq:
+  #    format( event )
+  #
+  # Returns a string representation of the given loggging _event_. It is
+  # up to subclasses to implement this method.
+  #
+  def format( event ) nil end
 
-    # call-seq:
-    #    header
-    #
-    # Returns a header string to be used at the beginning of a logging
-    # appender.
-    #
-    def header( ) '' end
+  # call-seq:
+  #    header
+  #
+  # Returns a header string to be used at the beginning of a logging
+  # appender.
+  #
+  def header( ) '' end
 
-    # call-seq:
-    #    footer
-    #
-    # Returns a footer string to be used at the end of a logging appender.
-    #
-    def footer( ) '' end 
+  # call-seq:
+  #    footer
+  #
+  # Returns a footer string to be used at the end of a logging appender.
+  #
+  def footer( ) '' end 
 
 
-    protected
+  protected
 
-    # call-seq:
-    #    format_obj( obj )
-    #
-    # Return a string representation of the given object. Depending upon
-    # the configuration of the logger system the format will be an +inspect+
-    # based represenation or a +yaml+ based representation.
-    #
-    def format_obj( obj )
-      case obj
-      when String; obj
-      when Exception 
-        str = "<#{obj.class.name}> #{obj.message}"
-        unless obj.backtrace.nil?
-          str << "\n\t" << obj.backtrace.join("\n\t")
-        end
-        str
-      when nil; "<#{obj.class.name}> nil"
-      else
-        str = "<#{obj.class.name}> "
-        str << case @obj_format
-               when :inspect; obj.inspect
-               when :yaml; "\n#{obj.to_yaml}"
-               else obj.to_s end
-        str
+  # call-seq:
+  #    format_obj( obj )
+  #
+  # Return a string representation of the given object. Depending upon
+  # the configuration of the logger system the format will be an +inspect+
+  # based represenation or a +yaml+ based representation.
+  #
+  def format_obj( obj )
+    case obj
+    when String; obj
+    when Exception 
+      str = "<#{obj.class.name}> #{obj.message}"
+      unless obj.backtrace.nil?
+        str << "\n\t" << obj.backtrace.join("\n\t")
       end
+      str
+    when nil; "<#{obj.class.name}> nil"
+    else
+      str = "<#{obj.class.name}> "
+      str << case @obj_format
+             when :inspect; obj.inspect
+             when :yaml; "\n#{obj.to_yaml}"
+             else obj.to_s end
+      str
     end
+  end
 
-  end  # class Layout
+end  # class Layout
 end  # module Logging
 
+Logging.require_all_libs_relative_to(__FILE__, 'layouts')
+
 # EOF

data/tasks/annotations.rake

@@ -1,27 +1,19 @@
-# $Id$
+# $Id: annotations.rake 87 2008-02-08 17:21:07Z tim_pease $
 
 if HAVE_BONES
 
 desc "Enumerate all annotations"
 task :notes do
   Bones::AnnotationExtractor.enumerate(
-      PROJ, "OPTIMIZE|FIXME|TODO", :tag => true)
+      PROJ, PROJ.annotation_tags.join('|'), :tag => true)
 end
 
 namespace :notes do
-  desc "Enumerate all OPTIMIZE annotations"
-  task :optimize do
-    Bones::AnnotationExtractor.enumerate(PROJ, "OPTIMIZE")
-  end
-
-  desc "Enumerate all FIXME annotations"
-  task :fixme do
-    Bones::AnnotationExtractor.enumerate(PROJ, "FIXME")
-  end
-
-  desc "Enumerate all TODO annotations"
-  task :todo do
-    Bones::AnnotationExtractor.enumerate(PROJ, "TODO")
+  PROJ.annotation_tags.each do |tag|
+    desc "Enumerate all #{tag} annotations"
+    task tag.downcase.to_sym do
+      Bones::AnnotationExtractor.enumerate(PROJ, tag)
+    end
   end
 end
 

data/tasks/post_load.rake

@@ -1,4 +1,4 @@
-# $Id: post_load.rake 85 2008-02-06 17:59:00Z tim_pease $
+# $Id$
 
 # This file does not define any rake tasks. It is used to load some project
 # settings if they are not defined by the user.

data/tasks/setup.rb

@@ -1,4 +1,4 @@
-# $Id: setup.rb 85 2008-02-06 17:59:00Z tim_pease $
+# $Id: setup.rb 87 2008-02-08 17:21:07Z tim_pease $
 
 require 'rubygems'
 require 'rake'
@@ -57,8 +57,9 @@ PROJ.need_tar = true
 PROJ.need_zip = false
 
 # File Annotations
-PROJ.annotation_exclude = []
+PROJ.annotation_exclude = %w(^tasks/setup.rb$)
 PROJ.annotation_extensions = %w(.txt .rb .erb) << ''
+PROJ.annotation_tags = %w(FIXME OPTIMIZE TODO)
 
 # Subversion Repository
 PROJ.svn = false

data/test/appenders/test_console.rb

@@ -1,6 +1,6 @@
-# $Id: test_console.rb 17 2007-01-20 18:47:43Z tim_pease $
+# $Id: test_console.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 
 module TestLogging
 module TestAppenders

data/test/appenders/test_email.rb

@@ -1,6 +1,6 @@
-# $Id: test_email.rb 69 2007-12-26 20:53:33Z tim_pease $
+# $Id: test_email.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 require 'flexmock'
 
 module TestLogging

data/test/appenders/test_file.rb

@@ -1,7 +1,6 @@
-# $Id: test_file.rb 72 2007-12-26 21:59:58Z tim_pease $
+# $Id: test_file.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
-require 'fileutils'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 
 module TestLogging
 module TestAppenders

data/test/appenders/test_growl.rb

@@ -1,6 +1,6 @@
-# $Id: test_growl.rb 69 2007-12-26 20:53:33Z tim_pease $
+# $Id: test_growl.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 require 'flexmock'
 
 module TestLogging

data/test/appenders/test_io.rb

@@ -1,7 +1,6 @@
-# $Id: test_io.rb 67 2007-12-26 16:27:06Z tim_pease $
+# $Id: test_io.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
-require 'stringio'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 
 module TestLogging
 module TestAppenders

data/test/appenders/test_rolling_file.rb

@@ -1,7 +1,6 @@
-# $Id: test_rolling_file.rb 72 2007-12-26 21:59:58Z tim_pease $
+# $Id: test_rolling_file.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
-require 'fileutils'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 
 module TestLogging
 module TestAppenders

data/test/appenders/test_syslog.rb

@@ -1,6 +1,6 @@
-# $Id: test_syslog.rb 72 2007-12-26 21:59:58Z tim_pease $
+# $Id: test_syslog.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 
 if HAVE_SYSLOG
 

data/test/config/test_yaml_configurator.rb

@@ -1,8 +1,6 @@
-# $Id: test_yaml_configurator.rb 72 2007-12-26 21:59:58Z tim_pease $
+# $Id: test_yaml_configurator.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'stringio'
-require 'yaml'
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 
 module TestLogging
 module TestConfig
@@ -31,7 +29,7 @@ module TestConfig
       io.seek 0
 
       assert_raise(::Logging::Config::YamlConfigurator::Error) {
-        ::Logging::Config::YamlConfigurator.new(io)
+        ::Logging::Config::YamlConfigurator.new(io, :meh)
       }
     end
 

data/test/layouts/test_basic.rb

@@ -1,6 +1,6 @@
-# $Id: test_basic.rb 53 2007-11-28 00:21:33Z tim_pease $
+# $Id: test_basic.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 
 module TestLogging
 module TestLayouts

data/test/layouts/test_pattern.rb

@@ -1,6 +1,6 @@
-# $Id: test_pattern.rb 53 2007-11-28 00:21:33Z tim_pease $
+# $Id: test_pattern.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[.. setup])
 
 module TestLogging
 module TestLayouts

data/test/setup.rb

@@ -1,13 +1,20 @@
-# $Id: setup.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: setup.rb 88 2008-02-08 18:47:36Z tim_pease $
+
+# Equivalent to a header guard in C/C++
+# Used to prevent the class/module from being loaded more than once
+unless defined? LOGGING_TEST_SETUP
+LOGGING_TEST_SETUP = true
 
 require 'test/unit'
+require 'fileutils'
+require 'stringio'
 
 # This line is needed for Ruby 1.9 -- hashes throw a "KeyError" in 1.9
 # whereas they throw an "IndexError" in 1.8
 #
 KeyError = IndexError if not defined? KeyError
 
-require File.join(File.dirname(__FILE__), '..', 'lib', 'logging')
+require File.join(File.dirname(__FILE__), %w[.. lib logging])
 
 begin
   require 'turn'
@@ -59,4 +66,6 @@ module LoggingTestCase
 end  # module LoggingTestCase
 end  # module TestLogging
 
+end  # unless defined?
+
 # EOF

data/test/test_appender.rb

@@ -1,6 +1,6 @@
-# $Id: test_appender.rb 85 2008-02-06 17:59:00Z tim_pease $
+# $Id: test_appender.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[setup])
 
 module TestLogging
 

data/test/test_layout.rb

@@ -1,6 +1,6 @@
-# $Id: test_layout.rb 53 2007-11-28 00:21:33Z tim_pease $
+# $Id: test_layout.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[setup])
 
 module TestLogging
 

data/test/test_log_event.rb

@@ -1,6 +1,6 @@
-# $Id: test_log_event.rb 25 2007-01-30 20:19:12Z tim_pease $
+# $Id: test_log_event.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[setup])
 
 module TestLogging
 

data/test/test_logger.rb

@@ -1,7 +1,6 @@
-# $Id: test_logger.rb 53 2007-11-28 00:21:33Z tim_pease $
+# $Id: test_logger.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
-require 'stringio'
+require File.join(File.dirname(__FILE__), %w[setup])
 
 module TestLogging
 

data/test/test_logging.rb

@@ -1,7 +1,6 @@
-# $Id: test_logging.rb 72 2007-12-26 21:59:58Z tim_pease $
+# $Id: test_logging.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
-require 'fileutils'
+require File.join(File.dirname(__FILE__), %w[setup])
 
 module TestLogging
 

data/test/test_repository.rb

@@ -1,6 +1,6 @@
-# $Id: test_repository.rb 53 2007-11-28 00:21:33Z tim_pease $
+# $Id: test_repository.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
+require File.join(File.dirname(__FILE__), %w[setup])
 
 module TestLogging
 

data/test/test_root_logger.rb

@@ -1,7 +1,6 @@
-# $Id: test_root_logger.rb 22 2007-01-29 16:20:54Z tim_pease $
+# $Id: test_root_logger.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
-require 'stringio'
+require File.join(File.dirname(__FILE__), %w[setup])
 
 module TestLogging
 

data/test/test_utils.rb

@@ -1,7 +1,6 @@
-# $Id: test_utils.rb 65 2007-12-23 04:48:55Z tim_pease $
+# $Id: test_utils.rb 88 2008-02-08 18:47:36Z tim_pease $
 
-require 'test/setup.rb'
-require 'stringio'
+require File.join(File.dirname(__FILE__), %w[setup])
 
 module TestLogging
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: logging
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-06 00:00:00 -07:00
+date: 2008-02-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,7 +53,6 @@ files:
 - lib/logging/appenders/growl.rb
 - lib/logging/appenders/io.rb
 - lib/logging/appenders/rolling_file.rb
-- lib/logging/appenders/static_appender.rb
 - lib/logging/appenders/syslog.rb
 - lib/logging/config/yaml_configurator.rb
 - lib/logging/layout.rb

data/lib/logging/appenders/static_appender.rb

@@ -1,60 +0,0 @@
-# $Id: static_appender.rb 85 2008-02-06 17:59:00Z tim_pease $
-
-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
-end  # class Appender
-end  # module Logging
-
-# EOF