logging 0.3.1 → 0.4.0

data/README.txt

@@ -1,9 +1,13 @@
 --
-$Id: README.txt 12 2007-01-14 20:03:40Z tim_pease $
+$Id: README.txt 35 2007-03-21 19:32:32Z tim_pease $
 ++
 
  = Logging
 
+ A logging framework for Ruby in the spirit of Java's Log4j.
+
+ Logging provides an easy to use logging system with fine-grained control over log statements, multiple logging destinations, rolling log files, user defined log levels and much more.
+
  obtaining a logger
  where to log
  log statements

data/lib/logging/appenders/console.rb

@@ -1,4 +1,4 @@
-# $Id: console.rb 26 2007-01-31 23:19:40Z tim_pease $
+# $Id: console.rb 32 2007-02-22 23:32:17Z tim_pease $
 
 require 'logging/appenders/io'
 
@@ -15,12 +15,11 @@ module Appenders
     #    Stdout.new
     #    Stdout.new( :layout => layout )
     #
-    # Creates a new Stdout Appender. The name 'stdout' will always be used for
-    # this appender.
+    # Creates a new Stdout Appender. The name 'stdout' will always be used
+    # for this appender.
     #
     def initialize( name = nil, opts = {} )
       name ||= 'stdout'
-      STDOUT.sync = true
       super(name, STDOUT, opts)
     end
   end  # class Stdout
@@ -35,12 +34,11 @@ module Appenders
     #    Stderr.new
     #    Stderr.new( :layout => layout )
     #
-    # Creates a new Stderr Appender. The name 'stderr' will always be used for
-    # this appender.
+    # Creates a new Stderr Appender. The name 'stderr' will always be used
+    # for this appender.
     #
     def initialize( name = nil, opts = {} )
       name ||= 'stderr'
-      STDERR.sync = true
       super(name, STDERR, opts)
     end
   end  # class Stderr

data/lib/logging/appenders/io.rb

@@ -1,4 +1,4 @@
-# $Id: io.rb 21 2007-01-26 20:23:32Z tim_pease $
+# $Id: io.rb 32 2007-02-22 23:32:17Z tim_pease $
 
 require 'logging/appender'
 
@@ -25,6 +25,7 @@ module Appenders
       end
 
       @io = io
+      @io.sync = true
       super(name, opts)
     end
 

data/lib/logging/appenders/rolling_file.rb

@@ -1,4 +1,4 @@
-# $Id: rolling_file.rb 29 2007-02-06 19:06:16Z tim_pease $
+# $Id: rolling_file.rb 31 2007-02-22 23:16:17Z tim_pease $
 
 require 'logging/appenders/file'
 
@@ -48,10 +48,11 @@ module Logging::Appenders
     #               layout will be used if none is given.
     #  [:truncate]  When set to true any existing log files will be rolled
     #               immediately and a new, empty log file will be created.
-    #  [:max_size]  The maximum allowed size (in bytes) of a log file before
+    #  [:size]      The maximum allowed size (in bytes) of a log file before
     #               it is rolled.
-    #  [:max_age]   The maximum age (in seconds) of a log file before it is
-    #               rolled.
+    #  [:age]       The maximum age (in seconds) of a log file before it is
+    #               rolled. The age can also be given as 'daily', 'weekly',
+    #               or 'monthly'.
     #  [:keep]      The number of rolled log files to keep.
     #
     def initialize( name, opts = {} )
@@ -74,14 +75,65 @@ module Logging::Appenders
       roll_files if roll_now
 
       # grab out our options
-      @max_size = opts.delete(:max_size) || opts.delete('max_size')
-      @max_age = opts.delete(:max_age) || opts.delete('max_age')
+      @size = opts.delete(:size) || opts.delete('size')
+      @size = Integer(@size) unless @size.nil?
 
-      @max_size = Integer(@max_size) unless @max_size.nil?
-      unless @max_age.nil?
-        @max_age = Integer(@max_age)
+      code = 'def sufficiently_aged?() false end'
+
+      @age = opts.delete(:age) || opts.delete('age')
+      case @age
+      when 'daily'
+        @start_time = Time.now
+        code = <<-CODE
+        def sufficiently_aged?
+          now = Time.now
+          if (now.day != @start_time.day) or (now - @start_time) > 86400
+            @start_time = now
+            return true
+          end
+          false
+        end
+        CODE
+      when 'weekly'
+        @start_time = Time.now
+        code = <<-CODE
+        def sufficiently_aged?
+          now = Time.now
+          if (now - @start_time) > 604800
+            @start_time = now
+            return true
+          end
+          false
+        end
+        CODE
+      when 'monthly'
+        @start_time = Time.now
+        code = <<-CODE
+        def sufficiently_aged?
+          now = Time.now
+          if (now.month != @start_time.month) or (now - @start_time) > 2678400
+            @start_time = now
+            return true
+          end
+          false
+        end
+        CODE
+      when Integer, String
+        @age = Integer(@age)
         @start_time = Time.now
+        code = <<-CODE
+        def sufficiently_aged?
+          now = Time.now
+          if (now - @start_time) > @age
+            @start_time = now
+            return true
+          end
+          false
+        end
+        CODE
       end
+      meta = class << self; self end
+      meta.class_eval code
 
       @file_size = (::File.exist?(@fn) ? ::File.size(@fn) : 0)
       super(name, opts)
@@ -112,7 +164,7 @@ module Logging::Appenders
     def roll
       begin; @io.close; rescue; end
       roll_files
-      @io = ::File.new(@fn, 'w')
+      @io = ::File.new(@fn, 'a')
     end
 
     #
@@ -123,18 +175,13 @@ module Logging::Appenders
     #
     def roll_required?
       # check if max size has been exceeded
-      if @max_size and @file_size > @max_size
+      if @size and @file_size > @size
         @file_size = 0
         return true
       end
 
       # check if max age has been exceeded
-      if @max_age and (Time.now - @start_time) > @max_age
-        @start_time = Time.now
-        return true
-      end
-
-      false
+      return sufficiently_aged?
     end
 
     #

data/lib/logging/layout.rb

@@ -1,4 +1,4 @@
-# $Id: layout.rb 17 2007-01-20 18:47:43Z tim_pease $
+# $Id: layout.rb 33 2007-02-28 18:29:09Z tim_pease $
  
 require 'yaml'
 require 'logging'
@@ -88,6 +88,7 @@ module Logging
           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

data/lib/logging/layouts/pattern.rb

@@ -1,4 +1,4 @@
-# $Id: pattern.rb 25 2007-01-30 20:19:12Z tim_pease $
+# $Id: pattern.rb 33 2007-02-28 18:29:09Z tim_pease $
 
 require 'logging'
 require 'logging/layout'
@@ -154,9 +154,20 @@ module Layouts
     #
     def self.create_date_format_methods( pf )
       code = "undef :format_date if method_defined? :format_date\n"
-      code << "def format_date\nTime.now."
-      code << if pf.date_method.nil? then "strftime '#{pf.date_pattern}'\n"
-              else "#{pf.date_method}\n" end
+      code << "def format_date\n"
+      if pf.date_method.nil?
+        if pf.date_pattern =~ %r/%s/
+          code << <<-CODE
+            now = Time.now
+            dp = '#{pf.date_pattern}'.gsub('%s','%06d' % now.usec)
+            now.strftime dp
+          CODE
+        else
+          code << "Time.now.strftime '#{pf.date_pattern}'\n"
+        end
+      else
+        code << "Time.now.#{pf.date_method}\n"
+      end
       code << "end\n"
 
       pf.meta_eval code

data/lib/logging/logger.rb

@@ -1,4 +1,4 @@
-# $Id: logger.rb 25 2007-01-30 20:19:12Z tim_pease $
+# $Id: logger.rb 33 2007-02-28 18:29:09Z tim_pease $
 
 require 'thread'
 require 'logging'
@@ -107,7 +107,7 @@ module Logging
               def #{name}?( ) true end
               def #{name}( data = nil )
                 data = yield if block_given?
-                log_event(::Logging::LogEvent.new(@name, #{num}, data, @trace)) unless data.nil?
+                log_event(::Logging::LogEvent.new(@name, #{num}, data, @trace))
                 true
               end
             CODE

data/lib/logging/repository.rb

@@ -1,4 +1,4 @@
-# $Id: repository.rb 13 2007-01-15 17:19:37Z tim_pease $
+# $Id: repository.rb 31 2007-02-22 23:16:17Z tim_pease $
 
 require 'singleton'
 require 'logging/root_logger'
@@ -78,6 +78,20 @@ module Logging
     #
     def fetch( key ) @h.fetch(to_key(key)) end
 
+    #
+    # call-seq:
+    #    has_logger?( name )
+    #
+    # Returns +true+ if the given logger exists in the repository. Returns
+    # +false+ if this is not the case.
+    #
+    # When _name_ is a +String+ or a +Symbol+ it will be used "as is" to
+    # retrieve the logger. When _name_ is a +Class+ the class name will be
+    # used to retrieve the logger. When _name_ is an object the name of the
+    # object's class will be used to retrieve the logger.
+    #
+    def has_logger?( key ) @h.has_key?(to_key(key)) end
+
     #
     # call-seq:
     #    parent( key )

data/lib/logging.rb

@@ -1,4 +1,4 @@
-# $Id: logging.rb 22 2007-01-29 16:20:54Z tim_pease $
+# $Id: logging.rb 35 2007-03-21 19:32:32Z tim_pease $
 
 require 'logging/repository'
 
@@ -42,7 +42,104 @@ module Logging
 
     #
     # call-seq:
-    #    define_levels( levels )
+    #    Logging.logger( device, age = 7, size = 1048576 )
+    #    Logging.logger( device, age = 'weekly' )
+    #
+    # This convenience method returns a Logger instance configured to behave
+    # similarly to a core Ruby Logger instance.
+    #
+    # The _device_ is the logging destination. This can be a filename
+    # (String) or an IO object (STDERR, STDOUT, an open File, etc.). The
+    # _age_ is the number of old log files to keep or the frequency of
+    # rotation (+daily+, +weekly+, or +monthly+). The _size_ is the maximum
+    # logfile size and is only used when _age_ is a number.
+    #
+    # Using the same _device_ twice will result in the same Logger instance
+    # being returned. For example, if a Logger is created using STDOUT then
+    # the same Logger instance will be returned the next time STDOUT is
+    # used. A new Logger instance can be obtained by closing the previous
+    # logger instance.
+    #
+    #    log1 = Logging.logger(STDOUT)
+    #    log2 = Logging.logger(STDOUT)
+    #    log1.object_id == log2.object_id  #=> true
+    #
+    #    log1.close
+    #    log2 = Logging.logger(STDOUT)
+    #    log1.object_id == log2.object_id  #=> false
+    #
+    # The format of the log messages can be changed using a few optional
+    # parameters. The <tt>:pattern</tt> can be used to change the log
+    # message format. The <tt>:date_pattern</tt> can be used to change how
+    # timestamps are formatted. 
+    #
+    #    log = Logging.logger(STDOUT,
+    #              :pattern => "[%d] %-5l : %m\n",
+    #              :date_pattern => "%Y-%m-%d %H:%M:%S.%s")
+    #
+    # See the documentation for the Logging::Layouts::Pattern class for a
+    # full description of the :pattern and :date_pattern formatting strings.
+    #
+    def logger( *args )
+      opts = args.pop if Hash === args.last 
+      opts ||= Hash.new
+
+      dev = args.shift
+      keep = age = args.shift
+      size = args.shift
+
+      name = case dev
+             when String: dev
+             when File: dev.path
+             else dev.object_id.to_s end
+
+      repo = ::Logging::Repository.instance
+      return repo[name] if repo.has_logger? name
+
+      l_opts = {
+        :pattern => "%.1l, [%d #%p] %#{::Logging::MAX_LEVEL_LENGTH}l : %m\n",
+        :date_pattern => '%Y-%m-%dT%H:%M:%S.%s'
+      }
+      [:pattern, :date_pattern, :date_method].each do |o|
+        l_opts[o] = opts.delete(o) if opts.has_key? o
+      end
+      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[:layout] = layout
+      a_opts.merge! opts
+
+      appender =
+          case dev
+          when String
+            ::Logging::Appenders::RollingFile.new(name, a_opts)
+          else 
+            ::Logging::Appenders::IO.new(name, dev, a_opts)
+          end
+
+      logger = ::Logging::Logger.new(name)
+      logger.add appender
+      logger.additive = false
+
+      class << logger
+        def close
+          @appenders.each {|a| a.close}
+          h = ::Logging::Repository.instance.instance_variable_get :@h
+          h.delete(@name)
+          class << self; undef :close; end
+        end
+      end
+
+      logger
+    end
+
+    #
+    # call-seq:
+    #    Logging.define_levels( 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
@@ -103,7 +200,7 @@ module Logging
    
     #
     # call-seq:
-    #    format_as( obj_format )
+    #    Logging.format_as( obj_format )
     #
     # Defines the default _obj_format_ method to use when converting objects
     # into string representations for logging. _obj_format_ can be one of

data/test/appenders/test_rolling_file.rb

@@ -1,4 +1,4 @@
-# $Id: test_rolling_file.rb 27 2007-02-01 16:58:11Z tim_pease $
+# $Id: test_rolling_file.rb 31 2007-02-22 23:16:17Z tim_pease $
 
 require 'test/setup.rb'
 require 'fileutils'
@@ -93,12 +93,16 @@ module TestAppenders
       cleanup
     end
 
-    def test_max_age
+    def test_age
       assert_equal [], Dir.glob(@glob)
 
-      ap = ::Logging::Appenders::RollingFile.new(NAME,
-               :filename => @fn, :max_age => 1)
+      assert_raise(ArgumentError) do
+        ::Logging::Appenders::RollingFile.new(
+            NAME, :filename => @fn, :age => 'bob')
+      end
 
+      ap = ::Logging::Appenders::RollingFile.new(NAME,
+               :filename => @fn, :age => 1)
       ap << "random message\n"
       assert_equal 1, Dir.glob(@glob).length
 
@@ -107,13 +111,50 @@ module TestAppenders
       assert_equal 2, Dir.glob(@glob).length
 
       cleanup
+      ap = ::Logging::Appenders::RollingFile.new(NAME,
+               :filename => @fn, 'age' => 'daily')
+      ap << "random message\n"
+      assert_equal 2, Dir.glob(@glob).length
+
+      t = ap.instance_variable_get :@start_time
+      ap.instance_variable_set :@start_time, t - 3600 * 24
+
+      sleep 0.250
+      ap << "yet another random message\n"
+      assert_equal 3, Dir.glob(@glob).length
+
+      cleanup
+      ap = ::Logging::Appenders::RollingFile.new(NAME,
+               :filename => @fn, :age => 'weekly')
+      ap << "random message\n"
+      assert_equal 3, Dir.glob(@glob).length
+
+      t = ap.instance_variable_get :@start_time
+      ap.instance_variable_set :@start_time, t - 3600 * 24 * 7
+
+      sleep 0.250
+      ap << "yet another random message\n"
+      assert_equal 4, Dir.glob(@glob).length
+
+      cleanup
+      ap = ::Logging::Appenders::RollingFile.new(NAME,
+               :filename => @fn, :age => 'monthly')
+      ap << "random message\n"
+      assert_equal 4, Dir.glob(@glob).length
+
+      t = ap.instance_variable_get :@start_time
+      ap.instance_variable_set :@start_time, t - 3600 * 24 * 31
+
+      sleep 0.250
+      ap << "yet another random message\n"
+      assert_equal 5, Dir.glob(@glob).length
     end
 
-    def test_max_size
+    def test_size
       assert_equal [], Dir.glob(@glob)
 
       ap = ::Logging::Appenders::RollingFile.new(NAME,
-               :filename => @fn, :max_size => 100)
+               :filename => @fn, :size => 100)
 
       ap << 'X' * 100; ap.flush
       assert_equal 1, Dir.glob(@glob).length

data/test/benchmark.rb

@@ -1,4 +1,4 @@
-# $Id: benchmark.rb 2 2007-01-09 18:10:50Z tim_pease $
+# $Id: benchmark.rb 34 2007-02-28 21:42:41Z tim_pease $
 
 begin
   require 'logging'
@@ -23,13 +23,12 @@ module Logging
   class Benchmark
 
     def run
-      this_many = 100_000
+      this_many = 300_000
 
       sio = StringIO.new
 
-      ::Logging::Logger[:root].level = 'warn'
-      logging = ::Logging::Logger[self]
-      logging.add ::Logging::Appenders::IO.new('benchmark', sio)
+      logging = ::Logging.logger sio
+      logging.level = :warn
 
       logger = ::Logger.new sio
       logger.level = ::Logger::WARN

data/test/test_logger.rb

@@ -1,4 +1,4 @@
-# $Id: test_logger.rb 25 2007-01-30 20:19:12Z tim_pease $
+# $Id: test_logger.rb 33 2007-02-28 18:29:09Z tim_pease $
 
 require 'test/setup.rb'
 require 'stringio'
@@ -313,16 +313,30 @@ module TestLogging
 
       assert_equal false, log.debug
       assert_equal true, log.info
+      assert_equal " INFO  A Logger : <NilClass> nil\n", a1.readline
+      assert_equal " INFO  A Logger : <NilClass> nil\n", a2.readline
       assert_equal true, log.warn
+      assert_equal " WARN  A Logger : <NilClass> nil\n", a1.readline
+      assert_equal " WARN  A Logger : <NilClass> nil\n", a2.readline
       assert_equal true, log.error
+      assert_equal "ERROR  A Logger : <NilClass> nil\n", a1.readline
+      assert_equal "ERROR  A Logger : <NilClass> nil\n", a2.readline
       assert_equal true, log.fatal
+      assert_equal "FATAL  A Logger : <NilClass> nil\n", a1.readline
+      assert_equal "FATAL  A Logger : <NilClass> nil\n", a2.readline
 
       log.level = :warn
       assert_equal false, log.debug
       assert_equal false, log.info
       assert_equal true, log.warn
+      assert_equal " WARN  A Logger : <NilClass> nil\n", a1.readline
+      assert_equal " WARN  A Logger : <NilClass> nil\n", a2.readline
       assert_equal true, log.error
+      assert_equal "ERROR  A Logger : <NilClass> nil\n", a1.readline
+      assert_equal "ERROR  A Logger : <NilClass> nil\n", a2.readline
       assert_equal true, log.fatal
+      assert_equal "FATAL  A Logger : <NilClass> nil\n", a1.readline
+      assert_equal "FATAL  A Logger : <NilClass> nil\n", a2.readline
 
       assert_raise(NoMethodError) {log.critical 'this log level does not exist'}
 

data/test/test_logging.rb

@@ -1,16 +1,30 @@
-# $Id: test_logging.rb 22 2007-01-29 16:20:54Z tim_pease $
+# $Id: test_logging.rb 34 2007-02-28 21:42:41Z tim_pease $
 
 require 'test/setup.rb'
+require 'fileutils'
 
 module TestLogging
 
   class TestLogging < Test::Unit::TestCase
     include LoggingTestCase
 
+    TMP = 'tmp'
+
     def setup
       super
       @levels = ::Logging::LEVELS
       @lnames = ::Logging::LNAMES
+
+      FileUtils.rm_rf TMP
+      FileUtils.mkdir(TMP)
+      @fn = File.join(TMP, 'test.log')
+      @glob = File.join(TMP, '*.log')
+    end
+
+    def teardown
+      h = ::Logging::Repository.instance.instance_variable_get :@h
+      h.values.each {|l| l.close if l.respond_to? :close}
+      FileUtils.rm_rf TMP
     end
 
     def test_configure
@@ -78,6 +92,46 @@ module TestLogging
       File.delete('temp.log') if File.exist?('temp.log')
     end
 
+    def test_logger
+      assert_raise(TypeError) {::Logging.logger []}
+
+      logger = ::Logging.logger STDOUT
+      assert_match %r/\A-?\d+\z/, logger.name
+      assert_same logger, ::Logging.logger(STDOUT)
+
+      logger.close
+      assert !STDOUT.closed?
+
+      assert !File.exist?(@fn)
+      fd = File.new @fn, 'w'
+      logger = ::Logging.logger fd, 2, 100
+      assert_equal @fn, logger.name
+      logger.debug 'this is a debug message'
+      logger.warn 'this is a warning message'
+      logger.error 'and now we should have over 100 bytes of data ' +
+                   'in the log file'
+      logger.info 'but the log file should not roll since we provided ' +
+                  'a file descriptor -- not a file name'
+      logger.close
+      assert fd.closed?
+      assert File.exist?(@fn)
+      assert_equal 1, Dir.glob(@glob).length
+
+      FileUtils.rm_f @fn
+      assert !File.exist?(@fn)
+      logger = ::Logging.logger @fn, 2, 100
+      assert File.exist?(@fn)
+      assert_equal @fn, logger.name
+      logger.debug 'this is a debug message'
+      logger.warn 'this is a warning message'
+      logger.error 'and now we should have over 100 bytes of data ' +
+                   'in the log file'
+      logger.info 'but the log file should not roll since we provided ' +
+                  'a file descriptor -- not a file name'
+      logger.close
+      assert_equal 3, Dir.glob(@glob).length
+    end
+
     def test_define_levels_default
       empty = {}
       assert_equal empty, @levels

data/test/test_repository.rb

@@ -1,4 +1,4 @@
-# $Id: test_repository.rb 13 2007-01-15 17:19:37Z tim_pease $
+# $Id: test_repository.rb 31 2007-02-22 23:16:17Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -47,6 +47,18 @@ module TestLogging
       assert_same @repo[:root], @repo.fetch(:root)
     end
 
+    def test_fetch
+      assert @repo.has_logger?(:root)
+      assert !@repo.has_logger?('A')
+
+      %w(A A::B A::B::C::D A::B::C::E A::B::C::F).each do |name|
+        ::Logging::Logger.new(name)
+      end
+
+      assert @repo.has_logger?('A')
+      assert @repo.has_logger?('A::B')
+    end
+
     def test_parent
       %w(A A::B A::B::C::D A::B::C::E A::B::C::F).each do |name|
         ::Logging::Logger.new(name)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: logging
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
-date: 2007-02-08 00:00:00 -07:00
+  version: 0.4.0
+date: 2007-03-21 00:00:00 -06:00
 summary: A flexible and extendable logging library for Ruby.
 require_paths: 
 - lib