logging 0.6.3 → 0.7.0

data/History.txt

@@ -1,3 +1,21 @@
+== 0.7.0 / 2008-02-12
+
+1 major enhancement
+  - Rails compatibility
+    * renamed Logger#add method to Logger#add_appenders
+    * renamed Logger#remove method to Logger#remove_appenders
+    * renamed Logger#clear method to Logger#clear_appenders
+    * added a new Logger#add method that conforms to the calling
+      semantics of the Ruby stdlib Logger 
+
+2 minor enhancements
+  - Speed improvements and test coverage
+  - Created a top-level Logging.init method that is used to
+    define the default logging levels
+
+1 bug fix
+  - Tweaked windows detection code
+
 == 0.6.3 / 2008-02-08
 
 2 minor enhancements

data/README.txt

@@ -32,7 +32,7 @@ logged.
 In this example, a single logger is crated that will append to STDOUT and to a
 file. Only log messages that are informational or higher will be logged.
 
-   reqruie 'logging'
+   require 'logging'
 
    logger = Logging::Logger['example_logger']
    logger.add  Logging::Appender.stdout

data/lib/logging.rb

@@ -1,4 +1,4 @@
-# $Id: logging.rb 90 2008-02-08 19:03:48Z tim_pease $
+# $Id: logging.rb 98 2008-02-13 00:40:28Z tim_pease $
 
 # Equivalent to a header guard in C/C++
 # Used to prevent the class/module from being loaded more than once
@@ -12,9 +12,10 @@ unless defined? Logging
 module Logging
 
   # :stopdoc:
-  VERSION = '0.6.3'
+  VERSION = '0.7.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
   LEVELS = {}
   LNAMES = {}
   # :startdoc:
@@ -75,7 +76,7 @@ module Logging
     # full description of the :pattern and :date_pattern formatting strings.
     #
     def logger( *args )
-      opts = args.pop if Hash === args.last 
+      opts = args.pop if args.last.instance_of?(Hash)
       opts ||= Hash.new
 
       dev = args.shift
@@ -100,10 +101,10 @@ module Logging
       layout = ::Logging::Layouts::Pattern.new(l_opts)
 
       a_opts = Hash.new
-      a_opts[:size] = size if Fixnum === size
-      a_opts[:age]  = age  if String === age
-      a_opts[:keep] = keep if Fixnum === keep
-      a_opts[:filename] = dev if String === dev
+      a_opts[:size] = size if size.instance_of?(Fixnum)
+      a_opts[:age]  = age  if age.instance_of?(String)
+      a_opts[:keep] = keep if keep.instance_of?(Fixnum)
+      a_opts[:filename] = dev if dev.instance_of?(String)
       a_opts[:layout] = layout
       a_opts.merge! opts
 
@@ -116,7 +117,7 @@ module Logging
           end
 
       logger = ::Logging::Logger.new(name)
-      logger.add appender
+      logger.add_appenders appender
       logger.additive = false
 
       class << logger
@@ -132,7 +133,7 @@ module Logging
     end
 
     # call-seq:
-    #    Logging.define_levels( levels )
+    #    Logging.init( levels )
     #
     # Defines the levels available to the loggers. The _levels_ is an array
     # of strings and symbols. Each element in the array is downcased and
@@ -154,7 +155,7 @@ module Logging
     #
     # Example:
     #
-    #    Logging.define_levels :debug, :info, :warn, :error, :fatal
+    #    Logging.init :debug, :info, :warn, :error, :fatal
     #    log = Logging::Logger['my logger']
     #    log.level = :warn
     #    log.warn 'Danger! Danger! Will Robinson'
@@ -162,14 +163,14 @@ module Logging
     #
     # or
     #
-    #    Logging.define_levels %w(DEBUG INFO NOTICE WARNING ERR CRIT ALERT EMERG)
+    #    Logging.init %w(DEBUG INFO NOTICE WARNING ERR CRIT ALERT EMERG)
     #    log = Logging::Logger['syslog']
     #    log.level = :notice
     #    log.warning 'This is your first warning'
     #    log.info 'Just FYI'                        # => not logged
     #
-    def define_levels( *args )
-      return nil if args.empty?
+    def init( *args )
+      args = %w(debug info warn error fatal) if args.empty?
 
       args.flatten!
       levels = ::Logging::LEVELS.clear

data/lib/logging/appenders/email.rb

@@ -1,4 +1,4 @@
-# $Id: email.rb 85 2008-02-06 17:59:00Z tim_pease $
+# $Id: email.rb 96 2008-02-10 18:18:10Z tim_pease $
 
 require 'net/smtp'
 require 'time' # get rfc822 time format
@@ -87,7 +87,7 @@ class Email < ::Logging::Appender
   #
   def write( event )
     immediate = false
-    str = if ::Logging::LogEvent === event
+    str = if event.instance_of?(::Logging::LogEvent)
         immediate = @immediate[event.level]
         @layout.format(event)
       else

data/lib/logging/appenders/growl.rb

@@ -1,4 +1,4 @@
-# $Id: growl.rb 85 2008-02-06 17:59:00Z tim_pease $
+# $Id: growl.rb 96 2008-02-10 18:18:10Z tim_pease $
 
 module Logging::Appenders
 
@@ -77,7 +77,7 @@ module Logging::Appenders
     def write( event )
       title = ''
       priority = 0
-      message = if ::Logging::LogEvent === event
+      message = if event.instance_of?(::Logging::LogEvent)
           priority = @map[event.level]
           @layout.format(event)
         else

data/lib/logging/appenders/io.rb

@@ -1,4 +1,4 @@
-# $Id: io.rb 85 2008-02-06 17:59:00Z tim_pease $
+# $Id: io.rb 96 2008-02-10 18:18:10Z tim_pease $
 
 module Logging::Appenders
 
@@ -65,7 +65,8 @@ module Logging::Appenders
     #
     def write( event )
       begin
-        str = ::Logging::LogEvent === event ? @layout.format(event) : event.to_s
+        str = event.instance_of?(::Logging::LogEvent) ?
+              @layout.format(event) : event.to_s
         return if str.empty?
         @io.print str
       rescue IOError

data/lib/logging/appenders/rolling_file.rb

@@ -1,4 +1,4 @@
-# $Id: rolling_file.rb 85 2008-02-06 17:59:00Z tim_pease $
+# $Id: rolling_file.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 begin
   require 'lockfile'
@@ -7,6 +7,14 @@ rescue LoadError
   require 'lockfile'
 end
 
+# FIXME: bug when truncating a rolling file on create
+#        If there is not log file in existence, it is created and then
+#        immediately rolld resulting in two log files
+#
+#        This appears to be because of rails -- creating the logfile and
+#        then we replace the default logger with a rolling file appender. It
+#        sees the already existing log file and happily rolls it right over.
+
 module Logging::Appenders
 
   # An appender that writes to a file and ensures that the file size or age
@@ -79,7 +87,7 @@ module Logging::Appenders
       @keep = opts.getopt(:keep, :as => Integer)
       @size = opts.getopt(:size, :as => Integer)
 
-      @lockfile = if opts.getopt(:safe, false) and !(%r/win32/ =~ RUBY_PLATFORM)
+      @lockfile = if opts.getopt(:safe, false) and !::Logging::WIN32
         Lockfile.new(
             @fn + '.lck',
             :retries => 1,
@@ -161,7 +169,8 @@ module Logging::Appenders
     # maximum age.
     #
     def write( event )
-      str = ::Logging::LogEvent === event ? @layout.format(event) : event.to_s
+      str = event.instance_of?(::Logging::LogEvent) ?
+            @layout.format(event) : event.to_s
       return if str.empty?
 
       check_logfile

data/lib/logging/appenders/syslog.rb

@@ -1,4 +1,4 @@
-# $Id: syslog.rb 85 2008-02-06 17:59:00Z tim_pease $
+# $Id: syslog.rb 96 2008-02-10 18:18:10Z tim_pease $
 
 begin
   require 'syslog'
@@ -165,7 +165,7 @@ module Logging::Appenders
     #
     def write( event )
       pri = LOG_DEBUG
-      message = if ::Logging::LogEvent === event
+      message = if event.instance_of?(::Logging::LogEvent)
           pri = @map[event.level]
           @layout.format(event)
         else

data/lib/logging/config/yaml_configurator.rb

@@ -1,4 +1,4 @@
-# $Id: yaml_configurator.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: yaml_configurator.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require 'yaml'
 
@@ -89,7 +89,7 @@ module Config
 
       # define levels
       levels = config['define_levels']
-      ::Logging.define_levels(levels) unless levels.nil?
+      ::Logging.init(levels) unless levels.nil?
 
       # format as
       format = config['format_as']

data/lib/logging/logger.rb

@@ -1,4 +1,4 @@
-# $Id: logger.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: logger.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require 'thread'
 
@@ -16,8 +16,8 @@ module Logging
   # Example:
   #
   #    log = Logging::Logger['my logger']
-  #    log.add( Logging::Appenders::Stdout.new )   # append to STDOUT
-  #    log.level = :info                           # log 'info' and above
+  #    log.add_appenders( Logging::Appender.stdout )   # append to STDOUT
+  #    log.level = :info                               # log 'info' and above
   #
   #    log.info 'starting foo operation'
   #    ...
@@ -179,6 +179,39 @@ module Logging
       @parent << msg if @additive
     end
 
+    # call-seq:
+    #    add( severity, message = nil ) {block}
+    #
+    # Log a message if the given severity is high enough.  This is the generic
+    # logging method.  Users will be more inclined to use #debug, #info, #warn,
+    # #error, and #fatal.
+    #
+    # <b>Message format</b>: +message+ can be any object, but it has to be
+    # converted to a String in order to log it. The Logging::format_as
+    # method is used to determine how objects chould be converted to
+    # strings. Generally, +inspect+ is used.
+    #
+    # A special case is an +Exception+ object, which will be printed in
+    # detail, including message, class, and backtrace.
+    #
+    # If a _message_ is not given, then the return value from the block is
+    # used as the message to log. This is useful when creating the actual
+    # message is an expensive operation. This allows the logger to check the
+    # severity against the configured level before actually constructing the
+    # message.
+    #
+    # This method returns +true+ if the message was logged, and +false+ is
+    # returned if the message was not logged.
+    #
+    def add( lvl, data = nil )
+      lvl = Integer(lvl)
+      return false if lvl < level
+
+      data = yield if block_given?
+      log_event(::Logging::LogEvent.new(@name, lvl, data, @trace))
+      true
+    end
+
     # call-seq:
     #    additive = true
     #
@@ -263,52 +296,52 @@ module Logging
     #
     def appenders=( args )
       @appenders.clear
-      add(*args) unless args.nil?
+      add_appenders(*args) unless args.nil?
     end
 
     # call-seq:
-    #    add( appenders )
+    #    add_appenders( appenders )
     #
     # Add the given _appenders_ to the list of appenders, where _appenders_
     # can be either a single appender or an array of appenders.
     #
-    def add( *args )
-      args.each do |arg|
-        unless arg.kind_of? ::Logging::Appender
-          raise TypeError,
-                "#{arg.inspect} is not a kind of 'Logging::Appender'"
-        end
-        @appenders << arg unless @appenders.include? arg
+    def add_appenders( *args )
+      args.flatten.each do |arg|
+        o = arg.kind_of?(::Logging::Appender) ? arg : ::Logging::Appender[arg]
+        raise ArgumentError, "unknown appender '#{arg}'" if o.nil?
+        @appenders << o unless @appenders.include?(o)
       end
+      self
     end
 
     # call-seq:
-    #    remove( appenders )
+    #    remove_appenders( appenders )
     #
     # Remove the given _appenders_ from the list of appenders. The appenders
     # to remove can be identified either by name using a +String+ or by
     # passing the appender instance. _appenders_ can be a single appender or
     # an array of appenders.
     #
-    def remove( *args )
-      args.each do |arg|
+    def remove_appenders( *args )
+      args.flatten.each do |arg|
         @appenders.delete_if do |a|
           case arg
           when String; arg == a.name
           when ::Logging::Appender; arg.object_id == a.object_id
           else
-            raise TypeError, "#{arg.inspect} is not a 'Logging::Appender'"
+            raise ArgumentError, "#{arg.inspect} is not a 'Logging::Appender'"
           end
         end
       end
+      self
     end
 
     # call-seq:
-    #    clear
+    #    clear_appenders
     #
     # Remove all appenders from this logger.
     #
-    def clear( ) @appenders.clear end
+    def clear_appenders( ) @appenders.clear end
 
 
     protected

data/lib/logging/root_logger.rb

@@ -1,4 +1,4 @@
-# $Id: root_logger.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: root_logger.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 module Logging
 
@@ -20,9 +20,7 @@ module Logging
     # once when the +Repository+ singleton instance is created.
     #
     def initialize( )
-      unless ::Logging.const_defined? 'MAX_LEVEL_LENGTH'
-        ::Logging.define_levels %w(debug info warn error fatal)
-      end
+      ::Logging.init unless ::Logging.const_defined? 'MAX_LEVEL_LENGTH'
 
       @name = 'root'
       @appenders = []

data/lib/logging/utils.rb

@@ -1,4 +1,4 @@
-# $Id: utils.rb 65 2007-12-23 04:48:55Z tim_pease $
+# $Id: utils.rb 96 2008-02-10 18:18:10Z tim_pease $
 
 class Hash
 
@@ -20,7 +20,7 @@ class Hash
   # If the value is +nil+, then no converstion will be performed.
   #
   def getopt( *args )
-    opts = Hash === args.last ? args.pop : {}
+    opts = args.last.instance_of?(Hash) ? args.pop : {}
     key, default = args
 
     val = if has_key?(key);                self[key]

data/test/appenders/test_email.rb

@@ -1,4 +1,4 @@
-# $Id: test_email.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_email.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[.. setup])
 require 'flexmock'
@@ -12,7 +12,7 @@ module TestAppenders
 
     def setup
       super
-      ::Logging.define_levels %w(debug info warn error fatal)
+      ::Logging.init
       @levels = ::Logging::LEVELS
 
       flexmock(Net::SMTP).new_instances do |m|

data/test/appenders/test_file.rb

@@ -1,4 +1,4 @@
-# $Id: test_file.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_file.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[.. setup])
 
@@ -12,7 +12,7 @@ module TestAppenders
 
     def setup
       super
-      ::Logging.define_levels %w(debug info warn error fatal)
+      ::Logging.init
 
       FileUtils.mkdir [File.join(TMP, 'dir'), File.join(TMP, 'uw_dir')]
       FileUtils.chmod 0555, File.join(TMP, 'uw_dir')

data/test/appenders/test_growl.rb

@@ -1,4 +1,4 @@
-# $Id: test_growl.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_growl.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[.. setup])
 require 'flexmock'
@@ -12,7 +12,7 @@ module TestAppenders
 
     def setup
       super
-      ::Logging.define_levels %w(debug info warn error fatal)
+      ::Logging.init
       @levels = ::Logging::LEVELS
 
       @appender = ::Logging::Appenders::Growl.new('growl',

data/test/appenders/test_io.rb

@@ -1,4 +1,4 @@
-# $Id: test_io.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_io.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[.. setup])
 
@@ -10,7 +10,7 @@ module TestAppenders
 
     def setup
       super
-      ::Logging.define_levels %w(debug info warn error fatal)
+      ::Logging.init
       @levels = ::Logging::LEVELS
 
       @sio = StringIO.new

data/test/appenders/test_rolling_file.rb

@@ -1,4 +1,4 @@
-# $Id: test_rolling_file.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_rolling_file.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[.. setup])
 
@@ -12,7 +12,7 @@ module TestAppenders
 
     def setup
       super
-      ::Logging.define_levels %w(debug info warn error fatal)
+      ::Logging.init
 
       @fn = File.join(TMP, 'test.log')
       @fn_fmt = File.join(TMP, 'test.%d.log')

data/test/appenders/test_syslog.rb

@@ -1,4 +1,4 @@
-# $Id: test_syslog.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_syslog.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[.. setup])
 
@@ -13,7 +13,7 @@ module TestAppenders
 
     def setup
       super
-      ::Logging.define_levels %w(debug info warn error fatal)
+      ::Logging.init
       @levels = ::Logging::LEVELS
     end
 

data/test/layouts/test_basic.rb

@@ -1,4 +1,4 @@
-# $Id: test_basic.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_basic.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[.. setup])
 
@@ -10,7 +10,7 @@ module TestLayouts
 
     def setup
       super
-      ::Logging.define_levels %w(debug info warn error fatal)
+      ::Logging.init
       @layout = ::Logging::Layouts::Basic.new
       @levels = ::Logging::LEVELS
     end

data/test/layouts/test_pattern.rb

@@ -1,4 +1,4 @@
-# $Id: test_pattern.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_pattern.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[.. setup])
 
@@ -10,7 +10,7 @@ module TestLayouts
 
     def setup
       super
-      ::Logging.define_levels %w(debug info warn error fatal)
+      ::Logging.init
       @layout = ::Logging::Layouts::Pattern.new
       @levels = ::Logging::LEVELS
       @date_fmt = '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'

data/test/test_appender.rb

@@ -1,4 +1,4 @@
-# $Id: test_appender.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_appender.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[setup])
 
@@ -10,7 +10,7 @@ module TestLogging
     def setup
       super
 
-      ::Logging.define_levels %w(debug info warn error fatal)
+      ::Logging.init
       @levels = ::Logging::LEVELS
       @event = ::Logging::LogEvent.new('logger', @levels['debug'],
                                        'message', false)
@@ -21,7 +21,8 @@ module TestLogging
       ary = []
       @appender.instance_variable_set :@ary, ary
       def @appender.write( event )
-        str = ::Logging::LogEvent === event ? @layout.format(event) : event.to_s
+        str = event.instance_of?(::Logging::LogEvent) ?
+              @layout.format(event) : event.to_s
         @ary << str
       end
 
@@ -72,7 +73,8 @@ module TestLogging
       ary = []
       @appender.instance_variable_set :@ary, ary
       def @appender.write( event )
-        str = ::Logging::LogEvent === event ? @layout.format(event) : event.to_s
+        str = event.instance_of?(::Logging::LogEvent) ?
+              @layout.format(event) : event.to_s
         @ary << str
       end
 

data/test/test_log_event.rb

@@ -1,4 +1,4 @@
-# $Id: test_log_event.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_log_event.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[setup])
 
@@ -12,7 +12,7 @@ module TestLogging
 
       @appender = EventAppender.new('test')
       @logger = ::Logging::Logger['TestLogger']
-      @logger.add @appender
+      @logger.add_appenders @appender
 
       @logger.info 'message 1'
       @event = @appender.event

data/test/test_logger.rb

@@ -1,4 +1,4 @@
-# $Id: test_logger.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_logger.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[setup])
 
@@ -17,37 +17,101 @@ module TestLogging
     end
 
     def test_add
+      root = ::Logging::Logger[:root]
+      root.level = 'info'
+
+      a1 = SioAppender.new 'a1'
+      a2 = SioAppender.new 'a2'
+      log = ::Logging::Logger.new 'A Logger'
+
+      root.add_appenders a1
+      assert_nil a1.readline
+      assert_nil a2.readline
+
+      log.add(0, 'this should NOT be logged')
+      assert_nil a1.readline
+      assert_nil a2.readline
+
+      log.add(1, 'this should be logged')
+      assert_equal " INFO  A Logger : this should be logged\n", a1.readline
+      assert_nil a1.readline
+      assert_nil a2.readline
+
+      log.add(2,[1,2,3,4])
+      assert_equal " WARN  A Logger : <Array> #{[1,2,3,4]}\n", a1.readline
+      assert_nil a1.readline
+      assert_nil a2.readline
+
+      log.add_appenders a2
+      log.add(3, 'an error has occurred')
+      assert_equal "ERROR  A Logger : an error has occurred\n", a1.readline
+      assert_equal "ERROR  A Logger : an error has occurred\n", a2.readline
+      assert_nil a1.readline
+      assert_nil a2.readline
+
+      log.additive = false
+      log.add(3, 'another error has occurred')
+      assert_equal "ERROR  A Logger : another error has occurred\n", a2.readline
+      assert_nil a1.readline
+      assert_nil a2.readline
+
+      log.add_appenders a1
+      log.add(4, 'fatal exception')
+      assert_equal "FATAL  A Logger : fatal exception\n", a1.readline
+      assert_equal "FATAL  A Logger : fatal exception\n", a2.readline
+      assert_nil a1.readline
+      assert_nil a2.readline
+
+
+      log.level = :warn
+      log.add(2) do
+        str = 'a string of data'
+        str
+      end
+      assert_equal " WARN  A Logger : a string of data\n", a1.readline
+      assert_equal " WARN  A Logger : a string of data\n", a2.readline
+      assert_nil a1.readline
+      assert_nil a2.readline
+
+      log.add(1) do
+        rb_raise(RuntimeError, "this block should not be executed")
+      end
+      assert_nil a1.readline
+      assert_nil a2.readline
+    end
+
+    def test_add_appenders
       log = ::Logging::Logger.new 'A'
 
       appenders = lambda {log.instance_variable_get :@appenders}
       assert_equal [], appenders[]
 
-      assert_raise(TypeError) {log.add Object.new}
-      assert_raise(TypeError) {log.add 'not an appender'}
+      assert_raise(ArgumentError) {log.add_appenders Object.new}
+      assert_raise(ArgumentError) {log.add_appenders 'not an appender'}
 
       a = ::Logging::Appender.new 'test_appender_1'
       b = ::Logging::Appender.new 'test_appender_2'
       c = ::Logging::Appender.new 'test_appender_3'
 
-      log.add a
+      log.add_appenders a
       assert_equal [a], appenders[]
 
-      log.add a
+      log.add_appenders a
       assert_equal [a], appenders[]
 
-      log.add b
+      log.add_appenders b
       assert_equal [a,b], appenders[]
 
-      log.add c
+      log.add_appenders c
       assert_equal [a,b,c], appenders[]
 
-      log.add a, c
+      log.add_appenders a, c
       assert_equal [a,b,c], appenders[]
 
-      log.clear
+      log.clear_appenders
       assert_equal [], appenders[]
 
-      log.add a, c
+      log.add_appenders a, c
       assert_equal [a,c], appenders[]
     end
 
@@ -90,8 +154,8 @@ module TestLogging
       appenders = lambda {log.instance_variable_get :@appenders}
       assert_equal [], appenders[]
 
-      assert_raise(TypeError) {log.appenders = Object.new}
-      assert_raise(TypeError) {log.appenders = 'not an appender'}
+      assert_raise(ArgumentError) {log.appenders = Object.new}
+      assert_raise(ArgumentError) {log.appenders = 'not an appender'}
 
       a = ::Logging::Appender.new 'test_appender_1'
       b = ::Logging::Appender.new 'test_appender_2'
@@ -108,6 +172,11 @@ module TestLogging
 
       log.appenders = nil
       assert_equal [], appenders[]
+
+      log.appenders = %w[test_appender_1 test_appender_3]
+      assert_equal [a,c], appenders[]
+
+      assert_raise(ArgumentError) {log.appenders = 'unknown'}
     end
 
     def test_class_aref
@@ -127,7 +196,7 @@ module TestLogging
       assert_same root, ::Logging::Logger.root
     end
 
-    def test_clear
+    def test_clear_appenders
       log  = ::Logging::Logger.new 'Elliott'
 
       appenders = lambda {log.instance_variable_get :@appenders}
@@ -137,10 +206,10 @@ module TestLogging
       b = ::Logging::Appender.new 'test_appender_2'
       c = ::Logging::Appender.new 'test_appender_3'
 
-      log.add a, b, c
+      log.add_appenders a, b, c
       assert_equal [a,b,c], appenders[]
 
-      log.clear
+      log.clear_appenders
       assert_equal [], appenders[]
     end
 
@@ -149,7 +218,7 @@ module TestLogging
       a2 = SioAppender.new 'a2'
       log = ::Logging::Logger.new 'A'
 
-      ::Logging::Logger[:root].add a1
+      ::Logging::Logger[:root].add_appenders a1
       assert_nil a1.readline
       assert_nil a2.readline
 
@@ -165,7 +234,7 @@ module TestLogging
       assert_nil a1.readline
       assert_nil a2.readline
 
-      log.add a2
+      log.add_appenders a2
       log << "this is line four of the log file\n"
       assert_equal "this is line four of the log file\n", a1.readline
       assert_equal "this is line four of the log file\n", a2.readline
@@ -178,7 +247,7 @@ module TestLogging
       assert_nil a1.readline
       assert_nil a2.readline
 
-      log.add a1
+      log.add_appenders a1
       log << "this is line six of the log file\n"
       assert_equal "this is line six of the log file\n", a1.readline
       assert_equal "this is line six of the log file\n", a2.readline
@@ -272,7 +341,7 @@ module TestLogging
       a2 = SioAppender.new 'a2'
       log = ::Logging::Logger.new 'A Logger'
 
-      root.add a1
+      root.add_appenders a1
       assert_nil a1.readline
       assert_nil a2.readline
 
@@ -290,7 +359,7 @@ module TestLogging
       assert_nil a1.readline
       assert_nil a2.readline
 
-      log.add a2
+      log.add_appenders a2
       log.error 'an error has occurred'
       assert_equal "ERROR  A Logger : an error has occurred\n", a1.readline
       assert_equal "ERROR  A Logger : an error has occurred\n", a2.readline
@@ -303,7 +372,7 @@ module TestLogging
       assert_nil a1.readline
       assert_nil a2.readline
 
-      log.add a1
+      log.add_appenders a1
       log.fatal 'fatal exception'
       assert_equal "FATAL  A Logger : fatal exception\n", a1.readline
       assert_equal "FATAL  A Logger : fatal exception\n", a2.readline
@@ -405,7 +474,7 @@ module TestLogging
       assert_same logger['A::B::C::E'], logger['A::B::C::E::G'].parent
     end
 
-    def test_remove
+    def test_remove_appenders
       log = ::Logging::Logger['X']
 
       appenders = lambda {log.instance_variable_get :@appenders}
@@ -415,28 +484,28 @@ module TestLogging
       b = ::Logging::Appender.new 'test_appender_2'
       c = ::Logging::Appender.new 'test_appender_3'
 
-      log.add a, b, c
+      log.add_appenders a, b, c
       assert_equal [a,b,c], appenders[]
 
-      assert_raise(TypeError) {log.remove Object.new}
-      assert_raise(TypeError) {log.remove 10}
+      assert_raise(ArgumentError) {log.remove_appenders Object.new}
+      assert_raise(ArgumentError) {log.remove_appenders 10}
 
-      log.remove b
+      log.remove_appenders b
       assert_equal [a,c], appenders[]
 
-      log.remove 'test_appender_1'
+      log.remove_appenders 'test_appender_1'
       assert_equal [c], appenders[]
 
-      log.remove c
+      log.remove_appenders c
       assert_equal [], appenders[]
 
-      log.remove a, b, c
+      log.remove_appenders a, b, c
       assert_equal [], appenders[]
 
-      log.add a, b, c
+      log.add_appenders a, b, c
       assert_equal [a,b,c], appenders[]
 
-      log.remove a, c
+      log.remove_appenders a, c
       assert_equal [b], appenders[]
     end
 

data/test/test_logging.rb

@@ -1,4 +1,4 @@
-# $Id: test_logging.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id: test_logging.rb 97 2008-02-13 00:32:18Z tim_pease $
 
 require File.join(File.dirname(__FILE__), %w[setup])
 
@@ -118,7 +118,7 @@ module TestLogging
       assert_equal 3, Dir.glob(@glob).length
     end
 
-    def test_define_levels_default
+    def test_init_default
       empty = {}
       assert_equal empty, @levels
       assert_equal empty, @lnames
@@ -143,15 +143,15 @@ module TestLogging
       assert_equal 'FATAL', @lnames[4]
     end
 
-    def test_define_levels_special
+    def test_init_special
       empty = {}
       assert_equal empty, @levels
       assert_equal empty, @lnames
       assert_same false, ::Logging.const_defined?(:MAX_LEVEL_LENGTH)
 
-      assert_raise(ArgumentError) {::Logging.define_levels(1, 2, 3, 4)}
+      assert_raise(ArgumentError) {::Logging.init(1, 2, 3, 4)}
 
-      ::Logging.define_levels :one, 'two', :THREE, 'FoUr', :sIx
+      ::Logging.init :one, 'two', :THREE, 'FoUr', :sIx
 
       assert_equal 5, @levels.length
       assert_equal 5, @lnames.length
@@ -170,13 +170,13 @@ module TestLogging
       assert_equal 'SIX',   @lnames[4]
     end
 
-    def test_define_levels_all_off
+    def test_init_all_off
       empty = {}
       assert_equal empty, @levels
       assert_equal empty, @lnames
       assert_same false, ::Logging.const_defined?(:MAX_LEVEL_LENGTH)
 
-      ::Logging.define_levels %w(a b all c off d)
+      ::Logging.init %w(a b all c off d)
 
       assert_equal 4, @levels.length
       assert_equal 4, @lnames.length
@@ -235,6 +235,15 @@ module TestLogging
       remove_const[:OBJ_FORMAT]
     end
 
+    def test_path
+      path = ::Logging.path(*%w[one two three])
+      assert_match %r/one\/two\/three$/, path
+    end
+
+    def test_version
+      assert_match %r/\d+\.\d+\.\d+/, ::Logging.version
+    end
+
   end  # class TestLogging
 end  # module TestLogging
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: logging
 version: !ruby/object:Gem::Version 
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-08 00:00:00 -07:00
+date: 2008-02-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency