logging 0.4.0 → 0.5.0

data/lib/logging/config/yaml_configurator.rb

@@ -1,4 +1,4 @@
-# $Id: yaml_configurator.rb 22 2007-01-29 16:20:54Z tim_pease $
+# $Id: yaml_configurator.rb 37 2007-10-26 19:12:44Z tim_pease $
 
 require 'yaml'
 require 'logging'
@@ -6,7 +6,6 @@ require 'logging'
 module Logging
 module Config
 
-  #
   # The YamlConfigurator class is used to configure the Logging framework
   # using information found in a YAML file.
   #
@@ -15,7 +14,7 @@ module Config
     class Error < StandardError; end  # :nodoc:
 
     class << self
-      #
+
       # call-seq:
       #    YamlConfigurator.load( file )
       #
@@ -38,7 +37,6 @@ module Config
       end
     end  # class << self
 
-    #
     # call-seq:
     #    YamlConfigurator.new( io )
     #
@@ -57,7 +55,6 @@ module Config
     end
     private :initialize
 
-    #
     # call-seq:
     #    load
     #
@@ -70,7 +67,6 @@ module Config
       loggers @config['loggers']
     end
 
-    #
     # call-seq:
     #    pre_config( config )
     #
@@ -97,7 +93,6 @@ module Config
       end
     end
 
-    #
     # call-seq:
     #    appenders( ary )
     #
@@ -110,7 +105,6 @@ module Config
       ary.each {|h| appender(h)}
     end
 
-    #
     # call-seq:
     #    loggers( ary )
     #
@@ -135,7 +129,6 @@ module Config
       end
     end
 
-    #
     # call-seq:
     #    appender( config )
     #
@@ -163,7 +156,6 @@ module Config
       clazz.new(name, config)
     end
 
-    #
     # call-seq:
     #    layout( config )
     #

data/lib/logging/layout.rb

@@ -1,11 +1,10 @@
-# $Id: layout.rb 33 2007-02-28 18:29:09Z tim_pease $
+# $Id: layout.rb 37 2007-10-26 19:12:44Z tim_pease $
  
 require 'yaml'
 require 'logging'
 
 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.
@@ -16,7 +15,6 @@ module Logging
   #
   class Layout
 
-    #
     # call-seq:
     #    Layout.new( :format_as => :string )
     #
@@ -43,7 +41,6 @@ module Logging
                     else :string end
     end
 
-    #
     # call-seq:
     #    format( event )
     #
@@ -52,7 +49,6 @@ module Logging
     #
     def format( event ) nil end
 
-    #
     # call-seq:
     #    header
     #
@@ -61,7 +57,6 @@ module Logging
     #
     def header( ) '' end
 
-    #
     # call-seq:
     #    footer
     #
@@ -71,7 +66,7 @@ module Logging
 
 
     protected
-    #
+
     # call-seq:
     #    format_obj( obj )
     #

data/lib/logging/layouts/basic.rb

@@ -1,4 +1,4 @@
-# $Id: basic.rb 25 2007-01-30 20:19:12Z tim_pease $
+# $Id: basic.rb 37 2007-10-26 19:12:44Z tim_pease $
 
 require 'logging'
 require 'logging/layout'
@@ -7,7 +7,6 @@ require 'logging/layout'
 module Logging
 module Layouts
 
-  #
   # The +Basic+ layout class provides methods for simple formatting of log
   # events. The resulting string follows the format below.
   #
@@ -21,7 +20,6 @@ module Layouts
   #
   class Basic < ::Logging::Layout
 
-    #
     # call-seq:
     #    format( event )
     #

data/lib/logging/layouts/pattern.rb

@@ -1,4 +1,4 @@
-# $Id: pattern.rb 33 2007-02-28 18:29:09Z tim_pease $
+# $Id: pattern.rb 37 2007-10-26 19:12:44Z tim_pease $
 
 require 'logging'
 require 'logging/layout'
@@ -6,7 +6,6 @@ require 'logging/layout'
 module Logging
 module Layouts
 
-  #
   # A flexible layout configurable with pattern string.
   #
   # The goal of this class is to format a LogEvent and return the results as
@@ -144,7 +143,6 @@ module Layouts
     # default date format
     ISO8601 = "%Y-%m-%d %H:%M:%S"
 
-    #
     # call-seq:
     #    Pattern.create_date_format_methods( pf )
     #
@@ -173,7 +171,6 @@ module Layouts
       pf.meta_eval code
     end
 
-    #
     # call-seq:
     #    Pattern.create_format_method( pf )
     #
@@ -215,7 +212,6 @@ module Layouts
     end
     # :startdoc:
 
-    #
     # call-seq:
     #    Pattern.new( opts )
     #
@@ -244,7 +240,6 @@ module Layouts
 
     attr_reader :pattern, :date_pattern, :date_method
 
-    #
     # call-seq:
     #    appender.pattern = "[%d] %-5l -- %c : %m\n"
     #
@@ -255,7 +250,6 @@ module Layouts
       Pattern.create_format_method(self)
     end
 
-    #
     # call-seq:
     #    appender.date_pattern = "%Y-%m-%d %H:%M:%S"
     #
@@ -267,7 +261,6 @@ module Layouts
       Pattern.create_date_format_methods(self)
     end
 
-    #
     # call-seq:
     #    appender.date_method = 'to_s'
     #    appender.date_method = :usec
@@ -283,7 +276,6 @@ module Layouts
 
     # :stopdoc:
 
-    #
     # call-seq:
     #    meta_eval( code )
     #

data/lib/logging/log_event.rb

@@ -1,8 +1,7 @@
-# $Id: log_event.rb 13 2007-01-15 17:19:37Z tim_pease $
+# $Id: log_event.rb 37 2007-10-26 19:12:44Z tim_pease $
 
 module Logging
 
-  #
   # This class defines a logging event.
   #
   class LogEvent
@@ -17,7 +16,6 @@ module Logging
     CALLER_RGXP = %r/([\.\/\(\)\w]+):(\d+)(?::in `(\w+)')?/o
     # :startdoc:
 
-    #
     # call-seq:
     #    LogEvent.new( logger, level, [data], trace )
     #
@@ -49,4 +47,4 @@ module Logging
   end  # class LogEvent
 end  # module Logging
 
-#EOF
+# EOF

data/lib/logging/logger.rb

@@ -1,4 +1,4 @@
-# $Id: logger.rb 33 2007-02-28 18:29:09Z tim_pease $
+# $Id: logger.rb 37 2007-10-26 19:12:44Z tim_pease $
 
 require 'thread'
 require 'logging'
@@ -9,7 +9,6 @@ require 'logging/repository'
 
 module Logging
 
-  #
   # The +Logger+ class is the primary interface to the +Logging+ framework.
   # It provides the logging methods that will be called from user methods,
   # and it generates logging events that are sent to the appenders (the
@@ -22,7 +21,7 @@ module Logging
   # Example:
   #
   #    log = Logging::Logger['my logger']
-  #    log.add( Logging::Appenders::StdOut.new )   # append to STDOUT
+  #    log.add( Logging::Appenders::Stdout.new )   # append to STDOUT
   #    log.level = :info                           # log 'info' and above
   #
   #    log.info 'starting foo operation'
@@ -36,7 +35,7 @@ module Logging
     @mutex = Mutex.new  # :nodoc:
 
     class << self
-      #
+
       # call-seq:
       #    Logger.root
       #
@@ -48,7 +47,6 @@ module Logging
 
       # :stopdoc:
 
-      #
       # Overrides the new method such that only one Logger will be created
       # for any given logger name.
       #
@@ -69,7 +67,6 @@ module Logging
       end
       alias :[] :new
 
-      #
       # This is where the actual logging methods are defined. Two methods
       # are created for each log level. The first is a query method used to
       # determine if that perticular logging level is enabled. The second is
@@ -122,7 +119,6 @@ module Logging
 
     attr_reader :level, :name, :parent, :additive, :trace
 
-    #
     # call-seq:
     #    Logger.new( name )
     #    Logger[name]
@@ -162,7 +158,6 @@ module Logging
       repo.children(name).each {|c| c.parent = self}
     end
 
-    #
     # call-seq:
     #    log <=> other
     #
@@ -177,7 +172,6 @@ module Logging
       else raise ArgumentError, 'expecting a Logger instance' end
     end
 
-    #
     # call-seq:
     #    log << "message"
     #
@@ -190,7 +184,6 @@ module Logging
       @parent << msg if @additive
     end
 
-    #
     # call-seq:
     #    additive = true
     #
@@ -206,7 +199,6 @@ module Logging
                   else raise ArgumentError, 'expecting a boolean' end
     end
 
-    #
     # call-seq:
     #    trace = true
     #
@@ -222,7 +214,6 @@ module Logging
                else raise ArgumentError, 'expecting a boolean' end
     end
 
-    #
     # call-seq:
     #    level = :all
     #
@@ -269,7 +260,6 @@ module Logging
       @level
     end
 
-    #
     # call-seq:
     #    appenders = app
     #
@@ -281,7 +271,6 @@ module Logging
       add(*args) unless args.nil?
     end
 
-    #
     # call-seq:
     #    add( appenders )
     #
@@ -298,7 +287,6 @@ module Logging
       end
     end
 
-    #
     # call-seq:
     #    remove( appenders )
     #
@@ -320,7 +308,6 @@ module Logging
       end
     end
 
-    #
     # call-seq:
     #    clear
     #
@@ -330,7 +317,7 @@ module Logging
 
 
     protected
-    #
+
     # call-seq:
     #    parent = ParentLogger
     #
@@ -340,7 +327,6 @@ module Logging
     #
     def parent=( parent ) @parent = parent end
 
-    #
     # call-seq:
     #    log_event( event )
     #
@@ -355,7 +341,6 @@ module Logging
 
     # :stopdoc:
 
-    #
     # call-seq:
     #    meta_eval( code )
     #

data/lib/logging/repository.rb

@@ -1,4 +1,4 @@
-# $Id: repository.rb 31 2007-02-22 23:16:17Z tim_pease $
+# $Id: repository.rb 37 2007-10-26 19:12:44Z tim_pease $
 
 require 'singleton'
 require 'logging/root_logger'
@@ -6,7 +6,6 @@ require 'logging/root_logger'
 
 module Logging
 
-  #
   # The Repository is a hash that stores references to all Loggers
   # that have been created. It provides methods to determine parent/child
   # relationships between Loggers and to retrieve Loggers from the hash.
@@ -16,7 +15,6 @@ module Logging
 
     PATH_DELIMITER = '::'  # :nodoc:
 
-    #
     # nodoc:
     #
     # This is a singleton class -- use the +instance+ method to obtain the
@@ -26,7 +24,6 @@ module Logging
       @h = {:root => ::Logging::RootLogger.new}
     end
 
-    #
     # call-seq:
     #    instance[name]
     #
@@ -51,7 +48,6 @@ module Logging
     #
     def []( key ) @h[to_key(key)] end
 
-    #
     # call-seq:
     #    instance[name] = logger
     #
@@ -64,7 +60,6 @@ module Logging
     #
     def []=( key, val ) @h[to_key(key)] = val end
 
-    #
     # call-seq:
     #    fetch( name )
     #
@@ -78,7 +73,6 @@ module Logging
     #
     def fetch( key ) @h.fetch(to_key(key)) end
 
-    #
     # call-seq:
     #    has_logger?( name )
     #
@@ -92,7 +86,6 @@ module Logging
     #
     def has_logger?( key ) @h.has_key?(to_key(key)) end
 
-    #
     # call-seq:
     #    parent( key )
     #
@@ -113,7 +106,6 @@ module Logging
       p
     end
 
-    #
     # call-seq:
     #    children( key )
     #
@@ -137,7 +129,6 @@ module Logging
       a.compact.sort
     end
 
-    #
     # call-seq:
     #    to_key( key )
     #