logging 0.5.3 → 0.6.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.6.0 / 2007-12-26
+
+* Using the new 'getopt' method for handling option hashes
+* Rolling file appender is safe for multiple processes
+* Added an e-mail appender from Jeremy Hinegardner
+* Updated tests for the appenders
+
 == 0.5.3 / 2007-12-08
 
 * Fixed the quoting for messages sent to the growl appender

data/Manifest.txt

@@ -6,6 +6,7 @@ data/logging.yaml
 lib/logging.rb
 lib/logging/appender.rb
 lib/logging/appenders/console.rb
+lib/logging/appenders/email.rb
 lib/logging/appenders/file.rb
 lib/logging/appenders/growl.rb
 lib/logging/appenders/io.rb
@@ -20,15 +21,18 @@ lib/logging/log_event.rb
 lib/logging/logger.rb
 lib/logging/repository.rb
 lib/logging/root_logger.rb
-tasks/doc.rake
-tasks/gem.rake
-tasks/manifest.rake
-tasks/rubyforge.rake
-tasks/setup.rb
-tasks/test.rake
-tasks/website.rake
+lib/logging/utils.rb
+rakelib/doc.rake
+rakelib/gem.rake
+rakelib/manifest.rake
+rakelib/rubyforge.rake
+rakelib/setup.rb
+rakelib/test.rake
+rakelib/website.rake
 test/appenders/test_console.rb
+test/appenders/test_email.rb
 test/appenders/test_file.rb
+test/appenders/test_growl.rb
 test/appenders/test_io.rb
 test/appenders/test_rolling_file.rb
 test/appenders/test_syslog.rb
@@ -44,3 +48,4 @@ test/test_logger.rb
 test/test_logging.rb
 test/test_repository.rb
 test/test_root_logger.rb
+test/test_utils.rb

data/Rakefile

@@ -1,6 +1,6 @@
 # $Id$
 
-load './tasks/setup.rb'
+load 'rakelib/setup.rb'
 ensure_in_path 'lib'
 
 require 'logging'
@@ -26,4 +26,7 @@ PROJ.exclude << '^(\.\/|\/)?tags$'
 PROJ.rdoc_exclude << '^(\.\/|\/)?data'
 PROJ.rdoc_exclude << '^(\.\/|\/)?website'
 
+depend_on 'flexmock'
+depend_on 'lockfile'
+
 # EOF

data/data/logging.yaml

@@ -47,7 +47,7 @@ logging_config:
     - type          : File
       name          : logfile
       level         : DEB
-      filename      : 'temp.log'
+      filename      : 'tmp/temp.log'
       truncate      : true
       layout:
         type        : Pattern

data/lib/logging.rb

@@ -1,9 +1,11 @@
-# $Id: logging.rb 58 2007-12-05 20:32:54Z tim_pease $
+# $Id: logging.rb 65 2007-12-23 04:48:55Z tim_pease $
 
+require 'logging/utils'
 require 'logging/repository'
 
 # require all appenders
 require 'logging/appenders/console'
+require 'logging/appenders/email'
 require 'logging/appenders/file'
 require 'logging/appenders/growl'
 require 'logging/appenders/rolling_file'
@@ -22,7 +24,7 @@ require 'logging/config/yaml_configurator'
 #
 module Logging
 
-  VERSION = '0.5.3'   # :nodoc:
+  VERSION = '0.6.0'   # :nodoc:
 
   LEVELS = {}  # :nodoc:
   LNAMES = {}  # :nodoc:
@@ -242,21 +244,6 @@ module Logging
       when 'off'; LEVELS.length
       else begin; Integer(l); rescue ArgumentError; LEVELS[l] end end
     end
-
-    # Helper method for retrieving options from a hash.
-    def options( opts = {} )
-      lambda do |*args|
-        keys, default, ignored = args
-        catch(:opt) do
-          Array(keys).each do |key|
-            [key, key.to_s, key.to_s.intern].each do |k|
-              throw :opt, opts[k] if opts.has_key?(k)
-            end
-          end
-          default
-        end
-      end
-    end
     # :startdoc:
   end
 

data/lib/logging/appender.rb

@@ -1,4 +1,4 @@
-# $Id: appender.rb 52 2007-11-27 23:53:23Z tim_pease $
+# $Id: appender.rb 67 2007-12-26 16:27:06Z tim_pease $
 
 require 'thread'
 require 'logging'
@@ -38,14 +38,12 @@ module Logging
       @name = name.to_s
       @closed = false
 
-      layout = opts[:layout] || opts['layout']
-      self.layout = layout unless layout.nil?
-      @layout ||= ::Logging::Layouts::Basic.new
-
-      self.level = opts[:level] || opts['level']
+      self.layout = opts.getopt(:layout, ::Logging::Layouts::Basic.new)
+      self.level = opts.getopt(:level)
 
       @mutex = Mutex.new
-      sync {write(@layout.header)}
+      header = @layout.header
+      sync {write(header, false)} unless header.nil? || header.empty?
 
       ::Logging::Appender[@name] = self
     end
@@ -62,7 +60,7 @@ module Logging
               "appender '<#{self.class.name}: #{@name}>' is closed"
       end
 
-      sync {write(@layout.format(event))} unless @level > event.level
+      sync {write(event, true)} unless @level > event.level
       self
     end
 
@@ -78,7 +76,7 @@ module Logging
               "appender '<#{self.class.name}: #{@name}>' is closed"
       end
 
-      sync {write(str)}
+      sync {write(str, false)} unless @level >= ::Logging::LEVELS.length
       self
     end
 
@@ -148,7 +146,7 @@ module Logging
     def close( footer = true )
       return self if @closed
       @closed = true
-      sync {write(@layout.footer)} if footer
+      sync {write(@layout.footer, false)} if footer
       self
     end
 
@@ -159,7 +157,9 @@ module Logging
     # otherwise. When an appender is closed, no more log events can be
     # written to the logging destination.
     #
-    def closed?( ) @closed end
+    def closed?
+      @closed
+    end
 
     # call-seq:
     #    flush
@@ -167,18 +167,25 @@ module Logging
     # 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
+    def flush
+      self
+    end
 
 
     private 
 
     # call-seq:
-    #    write( str )
+    #    write( event, do_layout = true )
     #
-    # Writes the given string to the logging destination. Subclasses should
-    # provide an implementation of this method.
+    # Writes the given _event_ to the logging destination. Subclasses should
+    # provide an implementation of this method. If the _do_layout_ flag is
+    # set to +true+, then the event will be formatted using the configured
+    # layout object. If set to false, then the event will be stringiied and
+    # appended to the logging destination.
     #
-    def write( str ) nil end
+    def write( event, do_layout = true )
+      nil
+    end
 
     # call-seq:
     #    sync { block }

data/lib/logging/appenders/console.rb

@@ -1,9 +1,8 @@
-# $Id: console.rb 37 2007-10-26 19:12:44Z tim_pease $
+# $Id: console.rb 65 2007-12-23 04:48:55Z tim_pease $
 
 require 'logging/appenders/io'
 
-module Logging
-module Appenders
+module Logging::Appenders
 
   # This class provides an Appender that can write to STDOUT.
   #
@@ -39,7 +38,6 @@ module Appenders
     end
   end  # class Stderr
 
-end  # module Appenders
-end  # module Logging
+end  # module Logging::Appenders
 
 # EOF

data/lib/logging/appenders/email.rb

@@ -0,0 +1,127 @@
+# $Id: email.rb 68 2007-12-26 18:45:34Z tim_pease $
+
+require 'net/smtp'
+require 'time' # get rfc822 time format
+
+# a replacement EmailOutputter.  This is essentially the default EmailOutptter from Log4r but with the following
+# changes:
+#   1) if there is data to send in an email, then do not send anything
+#   2) connect to the smtp server at the last minute, do not connect at startup and then send later on.
+#   3) Fix the To: field so that it looks alright.
+module Logging::Appenders
+
+class Email < ::Logging::Appender
+
+  attr_reader :server, :port, :domain, :acct, :authtype, :subject
+
+  def initialize( name, opts = {} )
+    super(name, opts)
+
+    @buff = []
+    @buffsize = opts.getopt :buffsize, 100, :as => Integer
+
+    # get the immediate levels -- no buffering occurs at these levels, and
+    # an e-mail is sent as soon as possible
+    @immediate = []
+    opts.getopt(:immediate_at, '').split(',').each do |lvl|
+      num = ::Logging.level_num(lvl.strip)
+      next if num.nil?
+      @immediate[num] = true
+    end
+
+    # get the SMTP parameters
+    @from = opts.getopt(:from)
+    raise ArgumentError, 'Must specify from address' if @from.nil?
+
+    @to = opts.getopt(:to, '').split(',')
+    raise ArgumentError, 'Must specify recipients' if @to.empty?
+
+    @server   = opts.getopt :server, 'localhost'
+    @port     = opts.getopt :port, 25, :as => Integer
+    @domain   = opts.getopt :domain, ENV['HOSTNAME']
+    @acct     = opts.getopt :acct
+    @passwd   = opts.getopt :passwd
+    @authtype = opts.getopt :authtype, :cram_md5, :as => Symbol
+    @subject  = opts.getopt :subject, "Message of #{$0}"
+    @params   = [@server, @port, @domain, @acct, @passwd, @authtype]
+  end
+  
+  # call-seq:
+  #    flush
+  #
+  # Create and send an email containing the current message buffer.
+  #
+  def flush
+    sync { send_mail }
+    self
+  end
+
+  # call-seq:
+  #    close( footer = true )
+  #
+  # Close the e-mail appender and then flush the message buffer. This will
+  # ensure that a final e-mail is sent with any remaining messages.
+  #
+  def close( footer = true )
+    super
+    flush
+  end
+
+  # cal-seq:
+  #    queued_messages    => integer
+  #
+  # Returns the number of messages in the buffer.
+  #
+  def queued_messages
+    @buff.length
+  end
+
+
+  private
+
+  # call-seq:
+  #    write( event, do_layout = true )
+  #
+  # Write the given _event_ to the e-mail message buffer. The log event will
+  # be processed through the Layout associated with this appender.
+  #
+  # If the _do_layout_ flag is set to false, the _event_ will be converted
+  # to a string and then written to the e-mail message buffer "as is" -- no
+  # layout formatting will be performed.
+  #
+  def write( event, do_layout = true )
+    str = do_layout ? @layout.format(event) : event.to_s
+    @buff << str
+    send_mail if @buff.length >= @buffsize ||
+                 (do_layout && @immediate[event.level])
+    self
+  end
+
+  # Connect to the mail server and send out any buffered messages.
+  #
+  def send_mail
+    return if @buff.empty?
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{@from}\n"
+    rfc822msg << "To: #{@to.join(",")}\n"
+    rfc822msg << "Subject: #{@subject}\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: <#{"%.8f" % Time.now.to_f}@#{@domain}>\n\n"
+    rfc822msg << @buff.join
+
+    ### send email
+    begin 
+      Net::SMTP.start(*@params) {|smtp| smtp.sendmail(rfc822msg, @from, @to)}
+    rescue Exception => e
+      self.level = :off
+      # TODO - log that e-mail notification has been turned off
+    ensure
+      @buff.clear
+    end
+  end
+
+end   # class Email
+end   # module Logging::Appenders
+
+# EOF

data/lib/logging/appenders/file.rb

@@ -1,4 +1,4 @@
-# $Id: file.rb 46 2007-10-31 14:39:01Z tim_pease $
+# $Id: file.rb 62 2007-12-22 20:37:05Z tim_pease $
 
 require 'logging/appenders/io'
 
@@ -8,6 +8,29 @@ module Logging::Appenders
   #
   class File < ::Logging::Appenders::IO
 
+    # call-seq:
+    #    File.assert_valid_logfile( filename )    => true
+    #
+    # Asserts that the given _filename_ can be used as a log file by ensuring
+    # that if the file exists it is a regular file and it is writable. If
+    # the file does not exist, then the directory is checked to see if it is
+    # writable.
+    #
+    # An +ArgumentError+ is raised if any of these assertions fail.
+    #
+    def self.assert_valid_logfile( fn )
+      if ::File.exist?(fn)
+        if not ::File.file?(fn)
+          raise ArgumentError, "#{fn} is not a regular file"
+        elsif not ::File.writable?(fn)
+          raise ArgumentError, "#{fn} is not writeable"
+        end
+      elsif not ::File.writable?(::File.dirname(fn))
+        raise ArgumentError, "#{::File.dirname(fn)} is not writable"
+      end
+      true
+    end
+
     # call-seq:
     #    File.new( name, :filename => 'file' )
     #    File.new( name, :filename => 'file', :truncate => true )
@@ -20,21 +43,10 @@ module Logging::Appenders
     # appened to the file.
     #
     def initialize( name, opts = {} )
-      @fn = opts.delete(:filename) || opts.delete('filename') || name
+      @fn = opts.getopt(:filename, name)
       raise ArgumentError, 'no filename was given' if @fn.nil?
-
-      mode = opts.delete(:truncate) || opts.delete('truncate')
-      mode = mode ? 'w' : 'a'
-
-      if ::File.exist?(@fn)
-        if not ::File.file?(@fn)
-          raise ArgumentError, "#{@fn} is not a regular file"
-        elsif not ::File.writable?(@fn)
-          raise ArgumentError, "#{@fn} is not writeable"
-        end
-      elsif not ::File.writable?(::File.dirname(@fn))
-        raise ArgumentError, "#{::File.dirname(@fn)} is not writable"
-      end
+      self.class.assert_valid_logfile(@fn)
+      mode = opts.getopt(:truncate) ? 'w' : 'a'
 
       super(name, ::File.new(@fn, mode), opts)
     end

data/lib/logging/appenders/growl.rb

@@ -1,9 +1,8 @@
-# $Id: growl.rb 59 2007-12-08 23:35:14Z tim_pease $
+# $Id: growl.rb 69 2007-12-26 20:53:33Z tim_pease $
 
 require 'logging/appender'
 
-module Logging
-module Appenders
+module Logging::Appenders
 
   # This class provides an Appender that can send notifications to the Growl
   # notification system on Mac OS X.
@@ -24,18 +23,22 @@ module Appenders
 
       @growl = "growlnotify -w -n \"#{@name}\" -t \"%s\" -m \"%s\" -p %d &"
 
-      getopt = ::Logging.options(opts)
-      @coalesce = getopt[:coalesce, false]
-      @title_sep = getopt[:separator]
+      @coalesce = opts.getopt(:coalesce, false)
+      @title_sep = opts.getopt(:separator)
 
       # provides a mapping from the default Logging levels
       # to the Growl notification levels
       @map = [-2, -1, 0, 1, 2]
 
-      map = getopt[:map]
+      map = opts.getopt(:map)
       self.map = map unless map.nil?
-
       setup_coalescing if @coalesce
+
+      # 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
+      end
     end
 
     # call-seq:
@@ -62,50 +65,31 @@ module Appenders
       @map = map
     end
 
-    # call-seq:
-    #    append( event )
-    #
-    # Send the given _event_ to the Growl framework. The log event will be
-    # processed through the Layout assciated with this appender. The message
-    # will be logged at the level specified by the event.
-    #
-    def append( event )
-      if closed?
-        raise RuntimeError,
-              "appender '<#{self.class.name}: #{@name}>' is closed"
-      end
-
-      sync do
-        title = ''
-        message = @layout.format(event)
-        priority = @map[event.level]
 
-        if @title_sep
-          title, message = message.split(@title_sep)
-          title, message = '', title if message.nil?
-          title.strip!
-        end
-
-        growl(title, message, priority)
-      end unless @level > event.level
-      self
-    end
+    private
 
     # call-seq:
-    #    syslog << string
+    #    write( event, do_layout = true )
     #
-    # Write the given _string_ to the Growl framework "as is" -- no
-    # layout formatting will be performed. The string will be logged at the
-    # 0 notification level of the Growl framework.
+    # Write the given _event_ to the growl notification facility. The log
+    # event will be processed through the Layout assciated with this
+    # appender if the _do_layout_ flag is set to +true+. The message will be
+    # logged at the level specified by the event.
     #
-    def <<( str )
-      if closed?
-        raise RuntimeError,
-              "appender '<#{self.class.name}: #{@name}>' is closed"
-      end
-
+    # If the _do_layout_ flag is set to +false+, the _event_ will be
+    # converted to a string and wirtten to the growl notification facility
+    # "as is" -- no layout formatting will be performed. The string will be
+    # logged at the 0 notification level of the Growl framework.
+    #
+    def write( event, do_layout = true )
       title = ''
-      message = str
+      priority = 0
+      message = if do_layout
+          priority = @map[event.level]
+          @layout.format(event)
+        else
+          event.to_s
+        end
 
       if @title_sep
         title, message = message.split(@title_sep)
@@ -113,13 +97,10 @@ module Appenders
         title.strip!
       end
 
-      sync {growl(title, message, 0)}
+      growl(title, message, priority)
       self
     end
 
-
-    private
-
     # call-seq:
     #    growl_level_num( level )    => integer
     #
@@ -127,10 +108,7 @@ module Appenders
     # corresponding Growl notification level number.
     #
     def growl_level_num( level )
-      level = case level
-              when Integer; level
-              when String; Integer(level)
-              else raise ArgumentError, "unkonwn level '#{level}'" end
+      level = Integer(level)
       if level < -2 or level > 2
         raise ArgumentError, "level '#{level}' is not in range -2..2"
       end
@@ -205,7 +183,6 @@ module Appenders
 
   end  # class Growl
 
-end  # module Appenders
-end  # module Logging
+end  # module Logging::Appenders
 
 # EOF