logging 0.8.0 → 0.9.0

data/History.txt

@@ -1,3 +1,12 @@
+== 0.9.0 / 2008-07-
+
+2 minor enhancement
+  - Exceptions from appenders are captured and logged
+  - Internal logger for the Logging framework (disabled by default)
+  - Added a DSL configuration format (more readable than YAML)
+1 bug fix
+  - Modules could not have their own logger instance
+
 == 0.8.0 / 2008-07-02
 
 1 minor enhancement

data/Manifest.txt

@@ -2,7 +2,11 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
+data/bad_logging_1.rb
+data/bad_logging_2.rb
+data/logging.rb
 data/logging.yaml
+data/simple_logging.rb
 lib/logging.rb
 lib/logging/appender.rb
 lib/logging/appenders/console.rb
@@ -12,6 +16,7 @@ lib/logging/appenders/growl.rb
 lib/logging/appenders/io.rb
 lib/logging/appenders/rolling_file.rb
 lib/logging/appenders/syslog.rb
+lib/logging/config/configurator.rb
 lib/logging/config/yaml_configurator.rb
 lib/logging/layout.rb
 lib/logging/layouts/basic.rb
@@ -40,6 +45,7 @@ test/appenders/test_io.rb
 test/appenders/test_rolling_file.rb
 test/appenders/test_syslog.rb
 test/benchmark.rb
+test/config/test_configurator.rb
 test/config/test_yaml_configurator.rb
 test/layouts/test_basic.rb
 test/layouts/test_pattern.rb

data/Rakefile

@@ -17,6 +17,7 @@ PROJ.rdoc.dir = 'doc/rdoc'
 #PROJ.rdoc.remote_dir = 'rdoc'
 PROJ.rdoc.remote_dir = ''
 PROJ.version = Logging::VERSION
+PROJ.release_name = 'Monkeyful Chimptacular'
 
 PROJ.exclude << %w[^tags$ ^tasks/archive ^coverage]
 PROJ.rdoc.exclude << '^data'

data/data/bad_logging_1.rb

@@ -0,0 +1,13 @@
+
+Logging.configure {
+
+  logger(:root) {
+    level      :info
+    appenders  'bad'
+  }
+
+  appender('bad') {
+    type 'FooBar'
+  }
+
+}  # logging configuration

data/data/bad_logging_2.rb

@@ -0,0 +1,21 @@
+
+Logging.configure {
+
+  logger(:root) {
+    level      :info
+    appenders  'logfile'
+  }
+
+  appender('logfile') {
+    type      'File'
+    level     'DEB'
+    filename  'tmp/temp.log'
+    truncate  true
+    layout {
+      type         'BadLayout'
+      date_method  'to_s'
+      pattern      '[%d] %l  %c : %m\n'
+    }
+  }
+
+}  # logging configuration

data/data/logging.rb

@@ -0,0 +1,42 @@
+
+Logging.configure {
+
+  pre_config {
+    levels      %w[DEB INF PRT WRN ERR FAT]
+    format_as  :inspect
+  }
+
+  logger('A::B::C') {
+    level      'DEB'
+    additive   false
+    trace      false
+    appenders  %w[stderr logfile]
+  }
+
+  logger('yourlogger') {
+    level      'INF'
+    appenders  %w[stderr logfile]
+  }
+
+  appender('stderr') {
+    type   'Stderr'
+    level  'DEB'
+    layout {
+      type       'Basic'
+      format_as  :string
+    }
+  }
+
+  appender('logfile') {
+    type      'File'
+    level     'DEB'
+    filename  'tmp/temp.log'
+    truncate  true
+    layout {
+      type         'Pattern'
+      date_method  'to_s'
+      pattern      '[%d] %l  %c : %m\n'
+    }
+  }
+
+}  # logging configuration

data/data/simple_logging.rb

@@ -0,0 +1,13 @@
+
+Logging.configure {
+
+  logger(:root) {
+    level      :info
+    appenders  'stdout'
+  }
+
+  appender('stdout') {
+    type 'Stdout'
+  }
+
+}  # logging configuration

data/lib/logging.rb

@@ -1,10 +1,8 @@
-# $Id$
 
 # 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
 
 #
@@ -12,7 +10,7 @@ unless defined? Logging
 module Logging
 
   # :stopdoc:
-  VERSION = '0.8.0'
+  VERSION = '0.9.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
@@ -24,12 +22,20 @@ module Logging
 
     # call-seq:
     #    Logging.configure( filename )
+    #    Logging.configure { block }
     #
     # Configures the Logging framework using the configuration information
     # found in the given file. The file extension should be either '.yaml'
     # or '.yml' (XML configuration is not yet supported).
     #
-    def configure( filename, *args )
+    def configure( *args, &block )
+      if block
+        return ::Logging::Config::Configurator.process(&block)
+      end
+
+      filename = args.shift
+      raise ArgumentError, 'a filename was not given' if filename.nil?
+
       case File.extname(filename)
       when '.yaml', '.yml'
         ::Logging::Config::YamlConfigurator.load(filename, *args)
@@ -187,7 +193,7 @@ module Logging
       end
 
       longest = names.values.inject {|x,y| (x.length > y.length) ? x : y}
-      module_eval "MAX_LEVEL_LENGTH = #{longest.length}"
+      module_eval "MAX_LEVEL_LENGTH = #{longest.length}", __FILE__, __LINE__
 
       levels.keys
     end
@@ -214,7 +220,7 @@ module Logging
         raise ArgumentError, "unknown object format '#{f}'"
       end
 
-      module_eval "OBJ_FORMAT = :#{f}"
+      module_eval "OBJ_FORMAT = :#{f}", __FILE__, __LINE__
     end
 
     # Returns the version string for the library.
@@ -228,7 +234,7 @@ module Logging
     # <tt>File.join</tt>.
     #
     def libpath( *args )
-      args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
+      args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
     end
 
     # Returns the lpath for the module. If any arguments are given,
@@ -236,7 +242,7 @@ module Logging
     # <tt>File.join</tt>.
     #
     def path( *args )
-      args.empty? ? PATH : ::File.join(PATH, *args)
+      args.empty? ? PATH : ::File.join(PATH, args.flatten)
     end
 
     # Utility method used to rquire all files ending in .rb that lie in the

data/lib/logging/appender.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 require 'thread'
 
@@ -71,7 +70,8 @@ class Appender
 
   end  # class << self
 
-  attr_reader :name, :layout, :level
+  attr_reader :name, :layout, :level, :log
+  private :log
 
   # call-seq:
   #    Appender.new( name )
@@ -83,6 +83,8 @@ class Appender
   # created.
   #
   def initialize( name, opts = {} )
+    @log = ::Logging::Logger[self]
+
     @name = name.to_s
     @closed = false
 
@@ -91,7 +93,14 @@ class Appender
 
     @mutex = Mutex.new
     header = @layout.header
-    sync {write(header)} unless header.nil? || header.empty?
+
+    unless header.nil? || header.empty?
+      begin 
+        sync {write(header)}
+      rescue StandardError => err
+        log.error err
+      end
+    end
 
     ::Logging::Appender[@name] = self
   end
@@ -108,7 +117,16 @@ class Appender
             "appender '<#{self.class.name}: #{@name}>' is closed"
     end
 
-    sync {write(event)} unless @level > event.level
+    # only append if the event level is less than or equal to the configured
+    # appender level
+    unless @level > event.level
+      begin
+        sync {write(event)}
+      rescue StandardError => err
+        log.error err
+      end
+    end
+
     self
   end
 
@@ -124,7 +142,13 @@ class Appender
             "appender '<#{self.class.name}: #{@name}>' is closed"
     end
 
-    sync {write(str)} unless @level >= ::Logging::LEVELS.length
+    unless @level >= ::Logging::LEVELS.length
+      begin
+        sync {write(str)}
+      rescue StandardError => err
+        log.error err
+      end
+    end
     self
   end
 
@@ -197,7 +221,13 @@ class Appender
     @closed = true
     if footer
       footer = @layout.footer
-      sync {write(footer)} unless footer.nil? || footer.empty?
+      unless footer.nil? || footer.empty?
+        begin
+          sync {write(footer)}
+        rescue StandardError => err
+          log.error err
+        end
+      end
     end
     self
   end

data/lib/logging/appenders/console.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 require Logging.libpath(*%w[logging appenders io])
 

data/lib/logging/appenders/email.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 require 'net/smtp'
 require 'time' # get rfc822 time format
@@ -116,10 +115,10 @@ class Email < ::Logging::Appender
     ### send email
     begin 
       Net::SMTP.start(*@params) {|smtp| smtp.sendmail(rfc822msg, @from, @to)}
-    rescue Exception => e
+    rescue StandardError => err
       self.level = :off
-      STDERR.puts e.message
-      # TODO - log that e-mail notification has been turned off
+      log.warn 'e-mail notifications have been disabled'
+      log.error err
     ensure
       @buff.clear
     end

data/lib/logging/appenders/file.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 module Logging::Appenders
 

data/lib/logging/appenders/growl.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 module Logging::Appenders
 
@@ -35,7 +34,7 @@ module Logging::Appenders
       # make sure the growlnotify command can be called
       unless system('growlnotify -v 2>&1 > /dev/null')
         self.level = :off
-        # TODO - log that the growl notification is turned off
+        log.warn 'growl notifications have been disabled'
       end
     end
 
@@ -118,7 +117,7 @@ module Logging::Appenders
     def growl( title, message, priority )
       message.tr!("`", "'")
       if @coalesce then coalesce(title, message, priority)
-      else system @growl % [title, message, priority] end
+      else call_growl(title, message, priority) end
     end
 
     # call-seq:
@@ -168,15 +167,27 @@ module Logging::Appenders
         loop do
           sleep 0.5
           @c_mutex.synchronize {
-            system(@growl % @c_queue.shift) until @c_queue.empty?
+            call_growl(*@c_queue.shift) until @c_queue.empty?
           }
           Thread.stop if @c_queue.empty?
         end  # loop
       end  # Thread.new
     end
 
-  end  # class Growl
+    # call-seq:
+    #    call_growl( title, message, priority )
+    #
+    # Call the growlnotify application with the given parameters. If the
+    # system call fails, the growl appender will be disabled.
+    #
+    def call_growl( *args )
+      unless system(@growl % args)
+        self.level = :off
+        log.warn 'growl notifications have been disabled'
+      end
+    end
 
+  end  # class Growl
 end  # module Logging::Appenders
 
 # EOF

data/lib/logging/appenders/io.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 module Logging::Appenders
 

data/lib/logging/appenders/rolling_file.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 require 'lockfile'
 
@@ -133,7 +132,7 @@ module Logging::Appenders
         CODE
       end
       meta = class << self; self end
-      meta.class_eval code
+      meta.class_eval code, __FILE__, __LINE__
 
       # if the truncate flag was set to true, then roll 
       roll_now = opts.getopt(:truncate, false)

data/lib/logging/appenders/syslog.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 begin
   require 'syslog'

data/lib/logging/config/configurator.rb

@@ -0,0 +1,182 @@
+
+module Logging::Config
+
+  # The Configurator class is used to configure the Logging framework
+  # using information found in a block of Ruby code. This block is evaluated
+  # in the context of the configurator's DSL.
+  #
+  class Configurator
+
+    class Error < StandardError; end  # :nodoc:
+
+    # call-seq:
+    #    Configuraotr.process( &block )
+    #
+    def self.process( &block )
+      new.load(&block)
+    end
+
+    # call-seq:
+    #    load { block }
+    #
+    # Loads the configuration from the _block_ and configures the Logging
+    # gem.
+    #
+    def load( &block )
+      raise Error, "missing configuration block" unless block
+
+      dsl = TopLevelDSL.new
+      dsl.__instance_eval(&block)
+
+      pre_config dsl.__pre_config
+      appenders  dsl.__appenders
+      loggers    dsl.__loggers
+    end
+
+    # call-seq:
+    #    pre_config( config )
+    #
+    # Configures the logging levels, object format style, and root logging
+    # level.
+    #
+    def pre_config( config )
+      if config.nil?
+        ::Logging.init unless ::Logging.const_defined? 'MAX_LEVEL_LENGTH'
+        return
+      end
+
+      # define levels
+      levels = config[:levels]
+      ::Logging.init(levels) unless levels.nil?
+
+      # format as
+      format = config[:format_as]
+      ::Logging.format_as(format) unless format.nil?
+    end
+
+    # call-seq:
+    #    appenders( ary )
+    #
+    # Given an array of Appender configurations, this method will iterate
+    # over each and create the Appender(s).
+    #
+    def appenders( ary )
+      ary.each {|name, config| appender(name, config)}
+    end
+
+    # call-seq:
+    #    loggers( ary )
+    #
+    # Given an array of Logger configurations, this method will iterate over
+    # each and create the Logger(s).
+    #
+    def loggers( ary )
+      ary.each do |name, config|
+        l = Logging::Logger[name]
+        l.level     = config[:level] if config[:level]
+        l.additive  = config[:additive] if l.respond_to? :additive= 
+        l.trace     = config[:trace]
+        l.appenders = Array(config[:appenders]).
+                            map {|name| ::Logging::Appender[name]}
+      end
+    end
+
+    # call-seq:
+    #    appender( name, config )
+    #
+    # Creates a new Appender based on the given _config_ options (a hash).
+    # The type of Appender created is determined by the 'type' option in the
+    # config. The remaining config options are passed to the Appender
+    # initializer.
+    #
+    # The config options can also contain a 'layout' option. This should be
+    # another set of options used to create a Layout for this Appender.
+    #
+    def appender( name, config )
+      type = config.delete(:type)
+      raise Error, "appender type not given for #{name.inspect}" if type.nil?
+
+      config[:layout] = layout(config[:layout]) if config.has_key? :layout
+
+      clazz = ::Logging::Appenders.const_get type
+      clazz.new(name, config)
+    rescue NameError => err
+      raise Error, "unknown appender class Logging::Appenders::#{type}"
+    end
+
+    # call-seq:
+    #    layout( config )
+    #
+    # Creates a new Layout based on the given _config_ options (a hash).
+    # The type of Layout created is determined by the 'type' option in the
+    # config. The remaining config options are passed to the Layout
+    # initializer.
+    #
+    def layout( config )
+      return ::Logging::Layouts::Basic.new if config.nil?
+
+      type = config.delete(:type)
+      raise Error, 'layout type not given' if type.nil?
+
+      clazz = ::Logging::Layouts.const_get type
+      clazz.new config
+    rescue NameError => err
+      raise Error, "unknown layout class Logging::Layouts::#{type}"
+    end
+
+    class DSL
+      alias :__instance_eval :instance_eval
+
+      instance_methods.each do |m|
+        undef_method m unless m[%r/^__/]
+      end
+
+      def self.process( &block )
+        dsl = new
+        dsl.__instance_eval(&block)
+        dsl.__hash
+      end
+
+      def __hash
+        @hash ||= Hash.new
+      end
+
+      def method_missing( method, *args, &block )
+        args << DSL.process(&block) if block
+
+        key = method.to_sym
+        value = (1 == args.length ? args.first : args)
+        __store(key, value)
+      end
+
+      def __store( key, value )
+        __hash[key] = value
+      end
+    end
+
+    class TopLevelDSL < DSL
+      undef_method :method_missing
+
+      def pre_config( &block )
+        __store(:preconfig, DSL.process(&block))
+      end
+
+      def logger( name, &block )
+        @loggers ||= []
+        @loggers << [name, DSL.process(&block)]
+      end
+
+      def appender( name, &block )
+        @appenders ||= []
+        @appenders << [name, DSL.process(&block)]
+      end
+
+      def __pre_config() __hash[:preconfig]; end
+      def __loggers() @loggers; end
+      def __appenders() @appenders; end
+    end
+
+  end  # class Configurator
+end  # module Logging::Config
+
+# EOF