logging 0.7.1 → 0.8.0

data/History.txt

@@ -1,4 +1,12 @@
-== 0.7.1 / 2008-
+== 0.8.0 / 2008-07-02
+
+1 minor enhancement
+  - Setting the log level of a parent will cause this level to
+    be propagated to the children
+1 bug fix
+  - Fixed error with the e-mail appender and missing hostname
+
+== 0.7.1 / 2008-02-25
 
 1 minor enhancement
   - Removed dependency on the Lockfile gem (brought the ruby

data/Manifest.txt

@@ -20,18 +20,17 @@ lib/logging/log_event.rb
 lib/logging/logger.rb
 lib/logging/repository.rb
 lib/logging/root_logger.rb
-lib/logging/stelan/lockfile.rb
 lib/logging/utils.rb
 tasks/ann.rake
-tasks/annotations.rake
 tasks/bones.rake
-tasks/doc.rake
 tasks/gem.rake
+tasks/git.rake
 tasks/manifest.rake
+tasks/notes.rake
 tasks/post_load.rake
+tasks/rdoc.rake
 tasks/rubyforge.rake
 tasks/setup.rb
-tasks/svn.rake
 tasks/test.rake
 test/appenders/test_console.rb
 test/appenders/test_email.rb

data/Rakefile

@@ -12,16 +12,17 @@ PROJ.summary = 'A flexible and extendable logging library for Ruby'
 PROJ.authors = 'Tim Pease'
 PROJ.email = 'tim.pease@gmail.com'
 PROJ.url = 'http://logging.rubyforge.org/'
-PROJ.rubyforge_name = 'logging'
-PROJ.rdoc_dir = 'doc/rdoc'
-#PROJ.rdoc_remote_dir = 'rdoc'
-PROJ.rdoc_remote_dir = ''
+PROJ.rubyforge.name = 'logging'
+PROJ.rdoc.dir = 'doc/rdoc'
+#PROJ.rdoc.remote_dir = 'rdoc'
+PROJ.rdoc.remote_dir = ''
 PROJ.version = Logging::VERSION
 
-PROJ.exclude += %w[^tags$ ^tasks/archive ^coverage]
-PROJ.rdoc_exclude << '^data'
-PROJ.svn = true
+PROJ.exclude << %w[^tags$ ^tasks/archive ^coverage]
+PROJ.rdoc.exclude << '^data'
+PROJ.svn.path = ''
 
 depend_on 'flexmock'
+depend_on 'lockfile'
 
 # EOF

data/lib/logging.rb

@@ -1,4 +1,4 @@
-# $Id: logging.rb 105 2008-02-26 04:43:21Z tim_pease $
+# $Id$
 
 # Equivalent to a header guard in C/C++
 # Used to prevent the class/module from being loaded more than once
@@ -12,7 +12,7 @@ unless defined? Logging
 module Logging
 
   # :stopdoc:
-  VERSION = '0.7.1'
+  VERSION = '0.8.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

data/lib/logging/appender.rb

@@ -1,4 +1,4 @@
-# $Id: appender.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id$
 
 require 'thread'
 

data/lib/logging/appenders/console.rb

@@ -1,4 +1,4 @@
-# $Id: console.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id$
 
 require Logging.libpath(*%w[logging appenders io])
 

data/lib/logging/appenders/email.rb

@@ -1,4 +1,4 @@
-# $Id: email.rb 96 2008-02-10 18:18:10Z tim_pease $
+# $Id$
 
 require 'net/smtp'
 require 'time' # get rfc822 time format
@@ -38,7 +38,7 @@ class Email < ::Logging::Appender
 
     @server   = opts.getopt :server, 'localhost'
     @port     = opts.getopt :port, 25, :as => Integer
-    @domain   = opts.getopt :domain, ENV['HOSTNAME']
+    @domain   = opts.getopt(:domain, ENV['HOSTNAME']) || 'localhost.localdomain'
     @acct     = opts.getopt :acct
     @passwd   = opts.getopt :passwd
     @authtype = opts.getopt :authtype, :cram_md5, :as => Symbol
@@ -118,6 +118,7 @@ class Email < ::Logging::Appender
       Net::SMTP.start(*@params) {|smtp| smtp.sendmail(rfc822msg, @from, @to)}
     rescue Exception => e
       self.level = :off
+      STDERR.puts e.message
       # TODO - log that e-mail notification has been turned off
     ensure
       @buff.clear

data/lib/logging/appenders/file.rb

@@ -1,4 +1,4 @@
-# $Id: file.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id$
 
 module Logging::Appenders
 

data/lib/logging/appenders/growl.rb

@@ -1,4 +1,4 @@
-# $Id: growl.rb 96 2008-02-10 18:18:10Z tim_pease $
+# $Id$
 
 module Logging::Appenders
 

data/lib/logging/appenders/io.rb

@@ -1,4 +1,4 @@
-# $Id: io.rb 96 2008-02-10 18:18:10Z tim_pease $
+# $Id$
 
 module Logging::Appenders
 

data/lib/logging/appenders/rolling_file.rb

@@ -1,6 +1,6 @@
-# $Id: rolling_file.rb 106 2008-02-26 04:52:42Z tim_pease $
+# $Id$
 
-require Logging.libpath(*%w[logging stelan lockfile])
+require 'lockfile'
 
 module Logging::Appenders
 
@@ -75,7 +75,7 @@ module Logging::Appenders
       @size = opts.getopt(:size, :as => Integer)
 
       @lockfile = if opts.getopt(:safe, false) and !::Logging::WIN32
-        ::Logging::Lockfile.new(
+        ::Lockfile.new(
             @fn + '.lck',
             :retries => 1,
             :timeout => 2

data/lib/logging/appenders/syslog.rb

@@ -1,4 +1,4 @@
-# $Id: syslog.rb 96 2008-02-10 18:18:10Z tim_pease $
+# $Id$
 
 begin
   require 'syslog'

data/lib/logging/config/yaml_configurator.rb

@@ -1,4 +1,4 @@
-# $Id: yaml_configurator.rb 97 2008-02-13 00:32:18Z tim_pease $
+# $Id$
 
 require 'yaml'
 

data/lib/logging/layout.rb

@@ -1,4 +1,4 @@
-# $Id: layout.rb 88 2008-02-08 18:47:36Z tim_pease $
+# $Id$
  
 require 'yaml'
 

data/lib/logging/layouts/basic.rb

@@ -1,4 +1,4 @@
-# $Id: basic.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id$
 
 module Logging
 module Layouts

data/lib/logging/layouts/pattern.rb

@@ -1,4 +1,4 @@
-# $Id: pattern.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id$
 
 module Logging
 module Layouts

data/lib/logging/log_event.rb

@@ -1,4 +1,4 @@
-# $Id: log_event.rb 53 2007-11-28 00:21:33Z tim_pease $
+# $Id$
 
 module Logging
 

data/lib/logging/logger.rb

@@ -1,4 +1,4 @@
-# $Id: logger.rb 97 2008-02-13 00:32:18Z tim_pease $
+# $Id$
 
 require 'thread'
 
@@ -112,7 +112,7 @@ module Logging
 
     end  # class << self
 
-    attr_reader :level, :name, :parent, :additive, :trace
+    attr_reader :name, :parent, :additive, :trace
 
     # call-seq:
     #    Logger.new( name )
@@ -148,7 +148,8 @@ module Logging
       @appenders = []
       @additive = true
       @trace = false
-      self.level = @parent.level
+      @level = nil
+      ::Logging::Logger.define_log_methods(self)
 
       repo.children(name).each {|c| c.parent = self}
     end
@@ -242,6 +243,16 @@ module Logging
                else raise ArgumentError, 'expecting a boolean' end
     end
 
+    # call-seq:
+    #    level    => integer
+    #
+    # Returns an integer which is the defined log level for this logger.
+    #
+    def level
+      return @level unless @level.nil?
+      @parent.level
+    end
+
     # call-seq:
     #    level = :all
     #
@@ -271,21 +282,24 @@ module Logging
     #    log.level = 1_000_000_000_000
     #
     def level=( level )
-      lvl = case level
-            when String, Symbol; ::Logging::level_num(level)
-            when Fixnum; level
-            when nil; @parent.level
-            else
-              raise ArgumentError,
-                    "level must be a String, Symbol, or Integer"
-            end
-      if lvl.nil? or lvl < 0 or lvl > ::Logging::LEVELS.length
-        raise ArgumentError, "unknown level was given '#{level}'"
-      end
+      @level =
+        if level.nil? then level
+        else
+          lvl = case level
+                when String, Symbol; ::Logging::level_num(level)
+                when Fixnum; level
+                else
+                  raise ArgumentError,
+                        "level must be a String, Symbol, or Integer"
+                end
+          if lvl.nil? or lvl < 0 or lvl > ::Logging::LEVELS.length
+            raise ArgumentError, "unknown level was given '#{level}'"
+          end
+          lvl
+        end
 
-      @level = lvl
-      ::Logging::Logger.define_log_methods(self)
-      @level
+      define_log_methods(true)
+      self.level
     end
 
     # call-seq:
@@ -343,6 +357,15 @@ module Logging
     #
     def clear_appenders( ) @appenders.clear end
 
+    # call-seq:
+    #     inspect    => string
+    #
+    # Returns a string representation of the logger.
+    #
+    def inspect
+      "<%s:0x%x name=\"%s\">" % [self.class.name, self.object_id, self.name]
+    end
+
 
     protected
 
@@ -367,6 +390,25 @@ module Logging
       @parent.log_event(event) if @additive
     end
 
+    # call-seq:
+    #    define_log_methods( force = false )
+    #
+    # Define the logging methods for this logger based on the configured log
+    # level. If the level is nil, then we will ask our parent for it's level
+    # and define log levels accordingly. The force flag will skip this
+    # check.
+    #
+    # Recursively call this method on all our children loggers.
+    #
+    def define_log_methods( force = false )
+      return if @level and !force
+
+      ::Logging::Logger.define_log_methods(self)
+      ::Logging::Repository.instance.children(name).each do |c|
+        c.define_log_methods
+      end
+    end
+
     # :stopdoc:
 
     # call-seq:

data/lib/logging/repository.rb

@@ -1,4 +1,4 @@
-# $Id: repository.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id$
 
 require 'singleton'
 
@@ -93,6 +93,8 @@ module Logging
     # existence of the logger referenced by _key_.
     #
     def parent( key )
+      return if 'root' == key.to_s
+
       key = to_key(key)
       a = key.split PATH_DELIMITER
 
@@ -113,6 +115,18 @@ module Logging
     # existence of the logger referenced by _key_.
     #
     def children( key )
+      # need to handle the root logger as a special case
+      if 'root' == key.to_s
+        ary = []
+        @h.each_pair do |key,logger|
+          key = key.to_s
+          next if key == 'root'
+          next if key.index(PATH_DELIMITER)
+          ary << logger
+        end
+        return ary.sort
+      end
+
       key = to_key(key)
       depth = key.split(PATH_DELIMITER).length
       rgxp = Regexp.new "^#{key}#{PATH_DELIMITER}"

data/lib/logging/root_logger.rb

@@ -1,4 +1,4 @@
-# $Id: root_logger.rb 97 2008-02-13 00:32:18Z tim_pease $
+# $Id$
 
 module Logging
 
@@ -13,6 +13,8 @@ module Logging
       undef_method m.intern
     end
 
+    attr_reader :level
+
     # call-seq:
     #    RootLogger.new
     #
@@ -26,7 +28,8 @@ module Logging
       @appenders = []
       @additive = false
       @trace = false
-      self.level = 0
+      @level = 0
+      ::Logging::Logger.define_log_methods(self)
     end
 
     # call-seq:
@@ -50,8 +53,7 @@ module Logging
     # root logger is not allowed. The level is silently set to :all.
     #
     def level=( level )
-      level ||= 0
-      super
+      super(level || 0)
     end
 
   end  # class RootLogger

data/lib/logging/utils.rb

@@ -1,4 +1,4 @@
-# $Id: utils.rb 96 2008-02-10 18:18:10Z tim_pease $
+# $Id$
 
 class Hash
 

data/tasks/ann.rake

@@ -1,4 +1,4 @@
-# $Id: ann.rake 105 2008-02-26 04:43:21Z tim_pease $
+# $Id$
 
 begin
   require 'bones/smtp_tls'
@@ -9,12 +9,16 @@ require 'time'
 
 namespace :ann do
 
-  file PROJ.ann_file do
-    puts "Generating #{PROJ.ann_file}"
-    File.open(PROJ.ann_file,'w') do |fd|
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
       fd.puts("#{PROJ.name} version #{PROJ.version}")
       fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
-      fd.puts("    #{PROJ.url}") if PROJ.url
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
       fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
       fd.puts
       fd.puts("== DESCRIPTION")
@@ -23,23 +27,24 @@ namespace :ann do
       fd.puts
       fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
       fd.puts
-      PROJ.ann_paragraphs.each do |p|
+      ann.paragraphs.each do |p|
         fd.puts "== #{p.upcase}"
         fd.puts
         fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
         fd.puts
       end
-      fd.puts PROJ.ann_text if PROJ.ann_text
+      fd.puts ann.text if ann.text
     end
   end
 
   desc "Create an announcement file"
-  task :announcement => PROJ.ann_file
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
 
   desc "Send an email announcement"
-  task :email => PROJ.ann_file do
-    from = PROJ.ann_email[:from] || PROJ.email
-    to   = Array(PROJ.ann_email[:to])
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || PROJ.email
+    to   = Array(ann.email[:to])
 
     ### build a mail header for RFC 822
     rfc822msg =  "From: #{from}\n"
@@ -49,11 +54,11 @@ namespace :ann do
     rfc822msg << "\n"
     rfc822msg << "Date: #{Time.new.rfc822}\n"
     rfc822msg << "Message-Id: "
-    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{PROJ.ann_email[:domain]}>\n\n"
-    rfc822msg << File.read(PROJ.ann_file)
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
 
     params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
-      PROJ.ann_email[key]
+      ann.email[key]
     end
 
     params[3] = PROJ.email if params[3].nil?
@@ -71,6 +76,6 @@ end  # namespace :ann
 desc 'Alias to ann:announcement'
 task :ann => 'ann:announcement'
 
-CLOBBER << PROJ.ann_file
+CLOBBER << PROJ.ann.file
 
 # EOF