logging 0.6.1 → 0.6.2

data/History.txt

@@ -1,3 +1,10 @@
+== 0.6.2 / 2008-02-06
+
+2 bugfixes
+  - An extra e-mail was being pushed out when the e-mail
+    appender was closed
+  - Created an at_exit handler to close all appenders
+
 == 0.6.1 / 2008-01-01
 
 1 bugfix

data/Manifest.txt

@@ -26,8 +26,10 @@ tasks/annotations.rake
 tasks/doc.rake
 tasks/gem.rake
 tasks/manifest.rake
+tasks/post_load.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

@@ -1,6 +1,7 @@
 # $Id$
 
 load 'tasks/setup.rb'
+
 ensure_in_path 'lib'
 require 'logging'
 
@@ -11,16 +12,15 @@ 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.description = paragraphs_of('README.txt', 3).join("\n\n")
-PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
 PROJ.rubyforge_name = 'logging'
 PROJ.rdoc_dir = 'doc/rdoc'
 #PROJ.rdoc_remote_dir = 'rdoc'
 PROJ.rdoc_remote_dir = ''
 PROJ.version = Logging::VERSION
 
-PROJ.exclude << '^tags$' << '^tasks/archive'
+PROJ.exclude << '^tags$' << '^tasks/archive' << '^coverage'
 PROJ.rdoc_exclude << '^data'
+PROJ.svn = true
 
 depend_on 'flexmock'
 depend_on 'lockfile'

data/lib/logging.rb

@@ -1,4 +1,4 @@
-# $Id: logging.rb 80 2008-01-01 22:39:52Z tim_pease $
+# $Id: logging.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 require 'logging/utils'
 require 'logging/log_event'
@@ -30,7 +30,7 @@ require 'logging/config/yaml_configurator'
 #
 module Logging
 
-  VERSION = '0.6.1'   # :nodoc:
+  VERSION = '0.6.2'   # :nodoc:
 
   LEVELS = {}  # :nodoc:
   LNAMES = {}  # :nodoc:
@@ -255,4 +255,14 @@ module Logging
 
 end  # module Logging
 
+# This exit handler will close all the appenders that exist in the system.
+# This is needed for closing IO streams and connections to the syslog server
+# or e-mail servers, etc.
+#
+at_exit {
+  Logging::Appender.instance_variable_get(:@appenders).values.each do |ap|
+    ap.close
+  end
+}
+
 # EOF

data/lib/logging/appender.rb

@@ -1,4 +1,4 @@
-# $Id: appender.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: appender.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 require 'thread'
 
@@ -39,7 +39,7 @@ module Logging
 
       @mutex = Mutex.new
       header = @layout.header
-      sync {write(header, false)} unless header.nil? || header.empty?
+      sync {write(header)} unless header.nil? || header.empty?
 
       ::Logging::Appender[@name] = self
     end
@@ -56,7 +56,7 @@ module Logging
               "appender '<#{self.class.name}: #{@name}>' is closed"
       end
 
-      sync {write(event, true)} unless @level > event.level
+      sync {write(event)} unless @level > event.level
       self
     end
 
@@ -72,7 +72,7 @@ module Logging
               "appender '<#{self.class.name}: #{@name}>' is closed"
       end
 
-      sync {write(str, false)} unless @level >= ::Logging::LEVELS.length
+      sync {write(str)} unless @level >= ::Logging::LEVELS.length
       self
     end
 
@@ -141,8 +141,12 @@ module Logging
     #
     def close( footer = true )
       return self if @closed
+      ::Logging::Appender.remove(@name)
       @closed = true
-      sync {write(@layout.footer, false)} if footer
+      if footer
+        footer = @layout.footer
+        sync {write(footer)} unless footer.nil? || footer.empty?
+      end
       self
     end
 
@@ -171,15 +175,14 @@ module Logging
     private 
 
     # call-seq:
-    #    write( event, do_layout = true )
+    #    write( event )
     #
     # 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.
+    # provide an implementation of this method. The _event_ can be either a
+    # LogEvent or a String. If a LogEvent, then it will be formatted using
+    # the layout given to the appender when it was created.
     #
-    def write( event, do_layout = true )
+    def write( event )
       nil
     end
 

data/lib/logging/appenders/email.rb

@@ -1,4 +1,4 @@
-# $Id: email.rb 68 2007-12-26 18:45:34Z tim_pease $
+# $Id: email.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 require 'net/smtp'
 require 'time' # get rfc822 time format
@@ -80,20 +80,23 @@ class Email < ::Logging::Appender
   private
 
   # call-seq:
-  #    write( event, do_layout = true )
+  #    write( event )
   #
   # 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
+  def write( event )
+    immediate = false
+    str = if ::Logging::LogEvent === event
+        immediate = @immediate[event.level]
+        @layout.format(event)
+      else
+        event.to_s
+      end
+    return if str.empty?
+
     @buff << str
-    send_mail if @buff.length >= @buffsize ||
-                 (do_layout && @immediate[event.level])
+    send_mail if @buff.length >= @buffsize || immediate
     self
   end
 

data/lib/logging/appenders/growl.rb

@@ -1,4 +1,4 @@
-# $Id: growl.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: growl.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 module Logging::Appenders
 
@@ -67,27 +67,23 @@ module Logging::Appenders
     private
 
     # call-seq:
-    #    write( event, do_layout = true )
+    #    write( event )
     #
     # 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.
+    # appender. The message will be logged at the level specified by the
+    # event.
     #
-    # 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 )
+    def write( event )
       title = ''
       priority = 0
-      message = if do_layout
+      message = if ::Logging::LogEvent === event
           priority = @map[event.level]
           @layout.format(event)
         else
           event.to_s
         end
+      return if message.empty?
 
       if @title_sep
         title, message = message.split(@title_sep)

data/lib/logging/appenders/io.rb

@@ -1,4 +1,4 @@
-# $Id: io.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: io.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 module Logging::Appenders
 
@@ -58,18 +58,15 @@ module Logging::Appenders
     private
 
     # call-seq:
-    #    write( event, do_layout = true )
+    #    write( event )
     #
     # Writes the given _event_ to the IO stream. If an +IOError+ is detected,
     # than this appender will be turned off and the error reported.
     #
-    # 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 IO stream.
-    #
-    def write( event, do_layout = true )
+    def write( event )
       begin
-        str = do_layout ? @layout.format(event) : event.to_s
+        str = ::Logging::LogEvent === event ? @layout.format(event) : event.to_s
+        return if str.empty?
         @io.print str
       rescue IOError
         self.level = :off

data/lib/logging/appenders/rolling_file.rb

@@ -1,4 +1,4 @@
-# $Id: rolling_file.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: rolling_file.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 begin
   require 'lockfile'
@@ -154,21 +154,18 @@ module Logging::Appenders
     private
 
     # call-seq:
-    #    write( event, do_layout = true )
+    #    write( event )
     #
     # Write the given _event_ to the log file. The log file will be rolled
     # if the maximum file size is exceeded or if the file is older than the
     # maximum age.
     #
-    # 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 current log file.
-    #
-    def write( event, do_layout = true )
-      check_logfile
+    def write( event )
+      str = ::Logging::LogEvent === event ? @layout.format(event) : event.to_s
+      return if str.empty?
 
-      str = do_layout ? @layout.format(event) : event.to_s
-      super(str, false)
+      check_logfile
+      super(str)
 
       if roll_required?(str)
         return roll unless @lockfile

data/lib/logging/appenders/static_appender.rb

@@ -1,4 +1,4 @@
-# $Id: static_appender.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: static_appender.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 module Logging
 class Appender
@@ -23,6 +23,14 @@ class Appender
     #
     def []=( name, val ) @appenders[name] = val end
 
+    # call-seq:
+    #    Appenders.remove( name )
+    #
+    # Removes the appender instance stored in the Appender hash under the
+    # key _name_.
+    #
+    def remove( name ) @appenders.delete(name) end
+
     # call-seq:
     #    Appender.stdout
     #

data/lib/logging/appenders/syslog.rb

@@ -1,4 +1,4 @@
-# $Id: syslog.rb 77 2007-12-30 02:21:33Z tim_pease $
+# $Id: syslog.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 begin
   require 'syslog'
@@ -157,28 +157,23 @@ module Logging::Appenders
     private
 
     # call-seq:
-    #    write( event, do_layout = true )
+    #    write( event )
     #
     # Write the given _event_ to the syslog 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.
+    # processed through the Layout assciated with this appender. The message
+    # will be logged at the level specified by the event.
     #
-    # If the _do_layout_ flag is set to +false+, the _event_ will be
-    # converted to a string and wirtten to the syslog facility "as is" -- no
-    # layout formatting will be performed. The string will be logged at the
-    # LOG_DEBUG level of the syslog facility.
-    #
-    def write( event, do_layout = true )
+    def write( event )
       pri = LOG_DEBUG
-      msg = if do_layout
+      message = if ::Logging::LogEvent === event
           pri = @map[event.level]
           @layout.format(event)
         else
           event.to_s
         end
+      return if message.empty?
 
-      @syslog.log(pri, '%s', msg)
+      @syslog.log(pri, '%s', message)
       self
     end
 

data/tasks/doc.rake

@@ -7,7 +7,6 @@ namespace :doc do
   desc 'Generate RDoc documentation'
   Rake::RDocTask.new do |rd|
     rd.main = PROJ.rdoc_main
-    rd.options << '-d' if !WIN32 and `which dot` =~ %r/\/dot/
     rd.rdoc_dir = PROJ.rdoc_dir
 
     incl = Regexp.new(PROJ.rdoc_include.join('|'))
@@ -24,6 +23,7 @@ namespace :doc do
     title = "#{PROJ.rubyforge_name}'s " + title if PROJ.rubyforge_name != title
 
     rd.options << "-t #{title}"
+    rd.options.concat(PROJ.rdoc_opts)
   end
 
   desc 'Generate ri locally for testing'

data/tasks/gem.rake

@@ -69,12 +69,12 @@ namespace :gem do
 
   desc 'Install the gem'
   task :install => [:clobber, :package] do
-    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.file_name}"
+    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.full_name}"
   end
 
   desc 'Uninstall the gem'
   task :uninstall do
-    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' #{PROJ.name}"
+    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' -x #{PROJ.name}"
   end
 
 end  # namespace :gem

data/tasks/manifest.rake

@@ -17,7 +17,18 @@ namespace :manifest do
     end
 
     File.open(fn, 'w') {|fp| fp.puts files.sort}
-    system "#{DIFF} -du Manifest.txt #{fn}"
+    lines = %x(#{DIFF} -du Manifest.txt #{fn}).split("\n")
+    if HAVE_FACETS_ANSICODE and ENV.has_key?('TERM')
+      lines.map! do |line|
+        case line
+        when %r/^(-{3}|\+{3})/; nil
+        when %r/^@/; Console::ANSICode.blue line
+        when %r/^\+/; Console::ANSICode.green line
+        when %r/^\-/; Console::ANSICode.red line
+        else line end
+      end
+    end
+    puts lines.compact
     rm fn rescue nil
   end
 
@@ -36,6 +47,9 @@ namespace :manifest do
     files << fn unless test ?f, fn
     File.open(fn, 'w') {|fp| fp.puts files.sort}
   end
-end
+end  # namespace :manifest
+
+desc 'Alias to manifest:check'
+task :manifest => 'manifest:check'
 
 # EOF

data/tasks/post_load.rake

@@ -0,0 +1,18 @@
+# $Id: post_load.rake 85 2008-02-06 17:59:00Z tim_pease $
+
+# This file does not define any rake tasks. It is used to load some project
+# settings if they are not defined by the user.
+
+unless PROJ.changes
+  PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+unless PROJ.description
+  PROJ.description = paragraphs_of('README.txt', 'description').join("\n\n")
+end
+
+unless PROJ.summary
+  PROJ.summary = PROJ.description.split('.').first
+end
+
+# EOF

data/tasks/rubyforge.rake

@@ -45,7 +45,7 @@ namespace :doc do
 
     host = "#{config['username']}@rubyforge.org"
     remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge_name}/"
-    remote_dir << PROJ.rdoc_remote_dir || PROJ.name
+    remote_dir << PROJ.rdoc_remote_dir if PROJ.rdoc_remote_dir
     local_dir = PROJ.rdoc_dir
 
     Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload

data/tasks/setup.rb

@@ -1,4 +1,4 @@
-# $Id: setup.rb 79 2008-01-01 20:29:30Z tim_pease $
+# $Id: setup.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 require 'rubygems'
 require 'rake'
@@ -16,7 +16,7 @@ PROJ.email = nil
 PROJ.url = nil
 PROJ.version = ENV['VERSION'] || '0.0.0'
 PROJ.rubyforge_name = nil
-PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn ^pkg ^doc)
+PROJ.exclude = %w(tmp$ bak$ ~$ CVS .svn/ ^pkg/ ^doc/)
 
 # Rspec
 PROJ.specs = FileList['spec/**/*_spec.rb']
@@ -32,8 +32,8 @@ PROJ.rcov_opts = ['--sort', 'coverage', '-T']
 
 # Rdoc
 PROJ.rdoc_opts = []
-PROJ.rdoc_include = %w(^lib ^bin ^ext txt$)
-PROJ.rdoc_exclude = %w(extconf\.rb$ ^Manifest\.txt$)
+PROJ.rdoc_include = %w(^lib/ ^bin/ ^ext/ .txt$)
+PROJ.rdoc_exclude = %w(extconf.rb$ ^Manifest.txt$)
 PROJ.rdoc_main = 'README.txt'
 PROJ.rdoc_dir = 'doc'
 PROJ.rdoc_remote_dir = nil
@@ -60,11 +60,20 @@ PROJ.need_zip = false
 PROJ.annotation_exclude = []
 PROJ.annotation_extensions = %w(.txt .rb .erb) << ''
 
+# Subversion Repository
+PROJ.svn = false
+PROJ.svn_root = nil
+PROJ.svn_trunk = 'trunk'
+PROJ.svn_tags = 'tags'
+PROJ.svn_branches = 'branches'
+
 # Load the other rake files in the tasks folder
-Dir.glob('tasks/*.rake').sort.each {|fn| import fn}
+rakefiles = Dir.glob('tasks/*.rake').sort
+rakefiles.unshift(rakefiles.delete('tasks/post_load.rake')).compact!
+import(*rakefiles)
 
 # Setup some constants
-WIN32 = %r/win32/ =~ RUBY_PLATFORM unless defined? WIN32
+WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
 
 DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
 
@@ -93,7 +102,7 @@ SUDO = if WIN32 then ''
 RCOV = WIN32 ? 'rcov.cmd'  : 'rcov'
 GEM  = WIN32 ? 'gem.cmd'   : 'gem'
 
-%w(rcov spec/rake/spectask rubyforge bones).each do |lib|
+%w(rcov spec/rake/spectask rubyforge bones facets/ansicode).each do |lib|
   begin
     require lib
     Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
@@ -108,8 +117,28 @@ end
 #    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
 #    summary, *description = paragraphs_of('README.txt', 3, 3..8)
 #
-def paragraphs_of(path, *paragraphs)
-  File.read(path).delete("\r").split(/\n\n+/).values_at(*paragraphs)
+def paragraphs_of( path, *paragraphs )
+  title = String === paragraphs.first ? paragraphs.shift : nil
+  ary = File.read(path).delete("\r").split(/\n\n+/)
+
+  result = if title
+    tmp, matching = [], false
+    rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
+    paragraphs << (0..-1) if paragraphs.empty?
+
+    ary.each do |val|
+      if val =~ rgxp
+        break if matching
+        matching = true
+        rgxp = %r/^=+/i
+      elsif matching
+        tmp << val
+      end
+    end
+    tmp
+  else ary end
+
+  result.values_at(*paragraphs)
 end
 
 # Adds the given gem _name_ to the current project's dependency list. An
@@ -123,11 +152,13 @@ def depend_on( name, version = nil )
   PROJ.dependencies << (version.nil? ? [name] : [name, ">= #{version}"])
 end
 
-# Adds the given _path_ to the include path if it is not already there
+# Adds the given arguments to the include path if they are not already there
 #
-def ensure_in_path( path )
-  path = File.expand_path(path)
-  $:.unshift(path) if test(?d, path) and not $:.include?(path)
+def ensure_in_path( *args )
+  args.each do |path|
+    path = File.expand_path(path)
+    $:.unshift(path) if test(?d, path) and not $:.include?(path)
+  end
 end
 
 # Find a rake task using the task name and remove any description text. This
@@ -141,4 +172,18 @@ def remove_desc_for_task( names )
   end
 end
 
+# Change working directories to _dir_, call the _block_ of code, and then
+# change back to the original working directory (the current directory when
+# this method was called).
+#
+def in_directory( dir, &block )
+  curdir = pwd
+  begin
+    cd dir
+    return block.call
+  ensure
+    cd curdir
+  end
+end
+
 # EOF

data/tasks/svn.rake

@@ -0,0 +1,44 @@
+# $Id$
+
+
+if PROJ.svn and system("svn --version 2>&1 > #{DEV_NULL}")
+
+unless PROJ.svn_root
+  info = %x/svn info ./
+  m = %r/^Repository Root:\s+(.*)$/.match(info)
+  PROJ.svn_root = (m.nil? ? '' : m[1])
+end
+PROJ.svn_root = File.join(PROJ.svn_root, PROJ.svn) if String === PROJ.svn
+
+namespace :svn do
+
+  desc 'Show tags from the SVN repository'
+  task :show_tags do |t|
+    tags = %x/svn list #{File.join(PROJ.svn_root, PROJ.svn_tags)}/
+    tags.gsub!(%r/\/$/, '')
+    puts tags
+  end
+
+  desc 'Create a new tag in the SVN repository'
+  task :create_tag do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+
+    trunk = File.join(PROJ.svn_root, PROJ.svn_trunk)
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = File.join(PROJ.svn_root, PROJ.svn_tags, tag)
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating SVN tag '#{tag}'"
+    unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
+      abort "Tag creation failed" 
+    end
+  end
+
+end  # namespace :svn
+
+task 'gem:release' => 'svn:create_tag'
+
+end  # if PROJ.svn
+
+# EOF

data/test/test_appender.rb

@@ -1,4 +1,4 @@
-# $Id: test_appender.rb 67 2007-12-26 16:27:06Z tim_pease $
+# $Id: test_appender.rb 85 2008-02-06 17:59:00Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -20,8 +20,8 @@ module TestLogging
     def test_append
       ary = []
       @appender.instance_variable_set :@ary, ary
-      def @appender.write( event, do_layout = true )
-        str = do_layout ? @layout.format(event) : event.to_s
+      def @appender.write( event )
+        str = ::Logging::LogEvent === event ? @layout.format(event) : event.to_s
         @ary << str
       end
 
@@ -71,8 +71,8 @@ module TestLogging
     def test_concat
       ary = []
       @appender.instance_variable_set :@ary, ary
-      def @appender.write( event, do_layout = true )
-        str = do_layout ? @layout.format(event) : event.to_s
+      def @appender.write( event )
+        str = ::Logging::LogEvent === event ? @layout.format(event) : event.to_s
         @ary << str
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: logging
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-01 00:00:00 -07:00
+date: 2008-02-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,8 +68,10 @@ files:
 - tasks/doc.rake
 - tasks/gem.rake
 - tasks/manifest.rake
+- tasks/post_load.rake
 - tasks/rubyforge.rake
 - tasks/setup.rb
+- tasks/svn.rake
 - tasks/test.rake
 - test/appenders/test_console.rb
 - test/appenders/test_email.rb