logging 0.5.1 → 0.5.2

data/History.txt

@@ -1,3 +1,8 @@
+== 0.5.2 / 2007-11-28
+
+* Updated the library to work with Ruby 1.9
+* Fixed coalescing with the growl appender
+
 == 0.5.1 / 2007-11-18
 
 * Fixed a bug on Windows when attempting to load the syslog library

data/lib/logging.rb

@@ -1,4 +1,4 @@
-# $Id: logging.rb 50 2007-11-19 00:38:50Z tim_pease $
+# $Id: logging.rb 56 2007-11-29 04:44:28Z tim_pease $
 
 require 'logging/repository'
 
@@ -22,7 +22,7 @@ require 'logging/config/yaml_configurator'
 #
 module Logging
 
-  VERSION = '0.5.1'   # :nodoc:
+  VERSION = '0.5.2'   # :nodoc:
 
   LEVELS = {}  # :nodoc:
   LNAMES = {}  # :nodoc:
@@ -38,7 +38,7 @@ module Logging
     #
     def configure( filename )
       case File.extname(filename)
-      when '.yaml', '.yml':
+      when '.yaml', '.yml'
         ::Logging::Config::YamlConfigurator.load(filename)
       else raise ArgumentError, 'unknown configuration file format' end
     end
@@ -91,8 +91,8 @@ module Logging
       size = args.shift
 
       name = case dev
-             when String: dev
-             when File: dev.path
+             when String; dev
+             when File; dev.path
              else dev.object_id.to_s end
 
       repo = ::Logging::Repository.instance
@@ -229,8 +229,8 @@ module Logging
     # Convert the given level into a connaconical form - a lowercase string.
     def levelify( level )
       case level
-      when String: level.downcase
-      when Symbol: level.to_s.downcase
+      when String; level.downcase
+      when Symbol; level.to_s.downcase
       else raise ArgumentError, "levels must be a String or Symbol" end
     end
 
@@ -238,8 +238,8 @@ module Logging
     def level_num( level )
       l = levelify level
       case l
-      when 'all': 0
-      when 'off': LEVELS.length
+      when 'all'; 0
+      when 'off'; LEVELS.length
       else begin; Integer(l); rescue ArgumentError; LEVELS[l] end end
     end
 
@@ -247,10 +247,10 @@ module Logging
     def options( opts = {} )
       lambda do |*args|
         keys, default, ignored = args
-        catch('opt') do
+        catch(:opt) do
           Array(keys).each do |key|
-            [key, key.to_s, key.to_s.intern].each do |key|
-              throw 'opt', opts[key] if opts.has_key?(key)
+            [key, key.to_s, key.to_s.intern].each do |k|
+              throw :opt, opts[k] if opts.has_key?(k)
             end
           end
           default

data/lib/logging/appender.rb

@@ -1,4 +1,4 @@
-# $Id: appender.rb 37 2007-10-26 19:12:44Z tim_pease $
+# $Id: appender.rb 52 2007-11-27 23:53:23Z tim_pease $
 
 require 'thread'
 require 'logging'
@@ -110,9 +110,9 @@ module Logging
     #
     def level=( level )
       lvl = case level
-            when String, Symbol: ::Logging::level_num(level)
-            when Fixnum: level
-            when nil: 0
+            when String, Symbol; ::Logging::level_num(level)
+            when Fixnum; level
+            when nil; 0
             else
               raise ArgumentError,
                     "level must be a String, Symbol, or Integer"

data/lib/logging/appenders/growl.rb

@@ -1,4 +1,4 @@
-# $Id: growl.rb 48 2007-11-18 21:47:29Z tim_pease $
+# $Id: growl.rb 56 2007-11-29 04:44:28Z tim_pease $
 
 require 'logging/appender'
 
@@ -22,7 +22,7 @@ module Appenders
     def initialize( name, opts = {} )
       super
 
-      @growl = "growlnotify -n '#{@name}' -t '%s' -m '%s' -p %d"
+      @growl = "growlnotify -w -n '#{@name}' -t '%s' -m '%s' -p %d &"
 
       getopt = ::Logging.options(opts)
       @coalesce = getopt[:coalesce, false]
@@ -82,7 +82,8 @@ module Appenders
 
         if @title_sep
           title, message = message.split(@title_sep)
-          title, message = message, title if message.nil?
+          title, message = '', title if message.nil?
+          title.strip!
         end
 
         growl(title, message, priority)
@@ -108,7 +109,8 @@ module Appenders
 
       if @title_sep
         title, message = message.split(@title_sep)
-        title, message = message, title if message.nil?
+        title, message = '', title if message.nil?
+        title.strip!
       end
 
       sync {growl(title, message, 0)}
@@ -126,8 +128,8 @@ module Appenders
     #
     def growl_level_num( level )
       level = case level
-              when Integer: level
-              when String: Integer(level)
+              when Integer; level
+              when String; Integer(level)
               else raise ArgumentError, "unkonwn level '#{level}'" end
       if level < -2 or level > 2
         raise ArgumentError, "level '#{level}' is not in range -2..2"
@@ -159,17 +161,20 @@ module Appenders
     #
     def coalesce( *msg )
       @c_mutex.synchronize do
-        if @c_message.nil? or @c_message.first != msg.first or @c_message.last  != msg.last
-          @c_message, msg = msg, @c_message
+        if @c_queue.empty?
+          @c_queue << msg
           @c_thread.run
 
         else
-          @c_message[1] << "\n" << msg[1]
-          msg = nil
+          qmsg = @c_queue.last
+          if qmsg.first != msg.first or qmsg.last != msg.last
+            @c_queue << msg
+          else 
+            qmsg[1] << "\n" << msg[1]
+          end
         end
       end
 
-      system @growl % msg unless msg.nil?
       Thread.pass
     end
 
@@ -183,19 +188,18 @@ module Appenders
     #
     def setup_coalescing
       @c_mutex = Mutex.new
-      @c_message = nil
+      @c_queue = []
 
       @c_thread = Thread.new do
+        Thread.stop
         loop do
-          Thread.stop
           sleep 0.5
-          @c_mutex.synchronize do
-            break if @c_message.nil?
-            system @growl % @c_message
-            @c_message = nil
-          end
-        end   # loop
-      end   # Thread.new
+          @c_mutex.synchronize {
+            system(@growl % @c_queue.shift) until @c_queue.empty?
+          }
+          Thread.stop if @c_queue.empty?
+        end  # loop
+      end  # Thread.new
     end
 
   end  # class Growl

data/lib/logging/appenders/syslog.rb

@@ -1,4 +1,4 @@
-# $Id: syslog.rb 50 2007-11-19 00:38:50Z tim_pease $
+# $Id: syslog.rb 52 2007-11-27 23:53:23Z tim_pease $
 
 begin
   require 'logging/appender'
@@ -203,8 +203,8 @@ module Appenders
     #
     def syslog_level_num( level )
       case level
-      when Integer: level
-      when String, Symbol:
+      when Integer; level
+      when String, Symbol
         level = level.to_s.upcase
         self.class.const_get level
       else

data/lib/logging/config/yaml_configurator.rb

@@ -1,4 +1,4 @@
-# $Id: yaml_configurator.rb 37 2007-10-26 19:12:44Z tim_pease $
+# $Id: yaml_configurator.rb 52 2007-11-27 23:53:23Z tim_pease $
 
 require 'yaml'
 require 'logging'
@@ -29,7 +29,7 @@ module Config
         when String
           io = File.open(file, 'r')
           close = true
-        when IO: io = file
+        when IO; io = file
         else raise Error, 'expecting a filename or a File' end
 
         begin new(io).load; ensure; io.close if close end

data/lib/logging/layout.rb

@@ -1,4 +1,4 @@
-# $Id: layout.rb 37 2007-10-26 19:12:44Z tim_pease $
+# $Id: layout.rb 52 2007-11-27 23:53:23Z tim_pease $
  
 require 'yaml'
 require 'logging'
@@ -37,7 +37,7 @@ module Logging
       f = f.intern if f.instance_of? String
 
       @obj_format = case f
-                    when :inspect, :yaml: f
+                    when :inspect, :yaml; f
                     else :string end
     end
 
@@ -76,19 +76,19 @@ module Logging
     #
     def format_obj( obj )
       case obj
-      when String: obj
-      when Exception: 
+      when String; obj
+      when Exception 
         str = "<#{obj.class.name}> #{obj.message}"
         unless obj.backtrace.nil?
           str << "\n\t" << obj.backtrace.join("\n\t")
         end
         str
-      when nil: "<#{obj.class.name}> nil"
+      when nil; "<#{obj.class.name}> nil"
       else
         str = "<#{obj.class.name}> "
         str << case @obj_format
-               when :inspect: obj.inspect
-               when :yaml: "\n#{obj.to_yaml}"
+               when :inspect; obj.inspect
+               when :yaml; "\n#{obj.to_yaml}"
                else obj.to_s end
         str
       end

data/lib/logging/layouts/pattern.rb

@@ -1,4 +1,4 @@
-# $Id: pattern.rb 37 2007-10-26 19:12:44Z tim_pease $
+# $Id: pattern.rb 52 2007-11-27 23:53:23Z tim_pease $
 
 require 'logging'
 require 'logging/layout'
@@ -190,11 +190,11 @@ module Layouts
         code << m[1] unless m[1].empty?
 
         case m[3]
-        when '%': code << '%%'
+        when '%'; code << '%%'
         when *DIRECTIVE_TABLE.keys
           code << m[2] + 's'
           args << DIRECTIVE_TABLE[m[3]]
-        when nil: break
+        when nil; break
         else
           raise ArgumentError, "illegal format character - '#{m[3]}'"
         end

data/lib/logging/log_event.rb

@@ -1,4 +1,4 @@
-# $Id: log_event.rb 37 2007-10-26 19:12:44Z tim_pease $
+# $Id: log_event.rb 53 2007-11-28 00:21:33Z tim_pease $
 
 module Logging
 
@@ -31,8 +31,8 @@ module Logging
       @file = @line = @method = ''
 
       if trace
-        t = Kernel.caller(3)[0]
-        break if t.nil?
+        t = Kernel.caller[2]
+        return if t.nil?
 
         m = CALLER_RGXP.match(t)
         @file = m[1]

data/lib/logging/logger.rb

@@ -1,4 +1,4 @@
-# $Id: logger.rb 37 2007-10-26 19:12:44Z tim_pease $
+# $Id: logger.rb 52 2007-11-27 23:53:23Z tim_pease $
 
 require 'thread'
 require 'logging'
@@ -143,7 +143,7 @@ module Logging
     #
     def initialize( name )
       case name
-      when String:
+      when String
         raise(ArgumentError, "logger must have a name") if name.empty?
       else raise(ArgumentError, "logger name must be a String") end
 
@@ -166,9 +166,9 @@ module Logging
     #
     def <=>( other )
       case other
-      when self: 0
-      when ::Logging::RootLogger: 1
-      when ::Logging::Logger: @name <=> other.name
+      when self; 0
+      when ::Logging::RootLogger; 1
+      when ::Logging::Logger; @name <=> other.name
       else raise ArgumentError, 'expecting a Logger instance' end
     end
 
@@ -193,9 +193,9 @@ module Logging
     #
     def additive=( val )
       @additive = case val
-                  when true, 'true': true
-                  when false, 'false': false
-                  when nil: @additive
+                  when true, 'true'; true
+                  when false, 'false'; false
+                  when nil; @additive
                   else raise ArgumentError, 'expecting a boolean' end
     end
 
@@ -208,9 +208,9 @@ module Logging
     #
     def trace=( val )
       @trace = case val
-               when true, 'true': true
-               when false, 'false': false
-               when nil: @trace
+               when true, 'true'; true
+               when false, 'false'; false
+               when nil; @trace
                else raise ArgumentError, 'expecting a boolean' end
     end
 
@@ -244,9 +244,9 @@ module Logging
     #
     def level=( level )
       lvl = case level
-            when String, Symbol: ::Logging::level_num(level)
-            when Fixnum: level
-            when nil: @parent.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"
@@ -299,8 +299,8 @@ module Logging
       args.each do |arg|
         @appenders.delete_if do |a|
           case arg
-          when String: arg == a.name
-          when ::Logging::Appender: arg.object_id == a.object_id
+          when String; arg == a.name
+          when ::Logging::Appender; arg.object_id == a.object_id
           else
             raise TypeError, "#{arg.inspect} is not a 'Logging::Appender'"
           end

data/lib/logging/repository.rb

@@ -1,4 +1,4 @@
-# $Id: repository.rb 37 2007-10-26 19:12:44Z tim_pease $
+# $Id: repository.rb 52 2007-11-27 23:53:23Z tim_pease $
 
 require 'singleton'
 require 'logging/root_logger'
@@ -141,9 +141,9 @@ module Logging
     #
     def to_key( key )
       case key
-      when Symbol, String: key
-      when Class: key.name
-      when Object: key.class.name
+      when Symbol, String; key
+      when Class; key.name
+      when Object; key.class.name
       end
     end
 

data/lib/logging/root_logger.rb

@@ -1,4 +1,4 @@
-# $Id: root_logger.rb 37 2007-10-26 19:12:44Z tim_pease $
+# $Id: root_logger.rb 52 2007-11-27 23:53:23Z tim_pease $
 
 require 'logging'
 require 'logging/logger'
@@ -42,8 +42,8 @@ module Logging
     #
     def <=>( other )
       case other
-      when self: 0
-      when ::Logging::Logger: -1
+      when self; 0
+      when ::Logging::Logger; -1
       else raise ArgumentError, 'expecting a Logger instance' end
     end
 

data/test/appenders/test_io.rb

@@ -1,4 +1,4 @@
-# $Id: test_io.rb 25 2007-01-30 20:19:12Z tim_pease $
+# $Id: test_io.rb 53 2007-11-28 00:21:33Z tim_pease $
 
 require 'test/setup.rb'
 require 'stringio'
@@ -23,7 +23,7 @@ module TestAppenders
       event = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
                                       [1, 2, 3, 4], false)
       @appender.append event
-      assert_equal " WARN  TestLogger : <Array> 1234\n", readline
+      assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
       assert_raise(EOFError) {readline}
 
       event.level = @levels['debug']

data/test/appenders/test_syslog.rb

@@ -1,4 +1,4 @@
-# $Id: test_syslog.rb 51 2007-11-19 00:40:03Z tim_pease $
+# $Id: test_syslog.rb 53 2007-11-28 00:21:33Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -53,7 +53,7 @@ module TestAppenders
       stderr[1].close
       Process.waitpid(pid)
 
-      assert_equal("syslog_test:  INFO  TestLogger : <Array> 1234\n",
+      assert_equal("syslog_test:  INFO  TestLogger : <Array> #{[1,2,3,4]}\n",
                    stderr[0].gets)
       assert_equal("syslog_test: DEBUG  TestLogger : the big log message\n",
                    stderr[0].gets)

data/test/layouts/test_basic.rb

@@ -1,4 +1,4 @@
-# $Id: test_basic.rb 25 2007-01-30 20:19:12Z tim_pease $
+# $Id: test_basic.rb 53 2007-11-28 00:21:33Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -21,7 +21,8 @@ module TestLayouts
       assert_equal " INFO  ArrayLogger : log message\n", @layout.format(event)
 
       event.data = [1, 2, 3, 4]
-      assert_equal " INFO  ArrayLogger : <Array> 1234\n", @layout.format(event)
+      assert_equal(" INFO  ArrayLogger : <Array> #{[1,2,3,4]}\n",
+                   @layout.format(event))
 
       event.level = @levels['debug']
       event.data = 'and another message'

data/test/layouts/test_pattern.rb

@@ -1,4 +1,4 @@
-# $Id: test_pattern.rb 25 2007-01-30 20:19:12Z tim_pease $
+# $Id: test_pattern.rb 53 2007-11-28 00:21:33Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -65,7 +65,8 @@ module TestLayouts
       assert_match rgxp, @layout.format(event)
 
       event.data = [1, 2, 3, 4]
-      rgxp  = Regexp.new(sprintf(fmt, 'INFO ', 'ArrayLogger', '<Array> 1234'))
+      rgxp  = Regexp.new(sprintf(fmt, 'INFO ', 'ArrayLogger',
+                                 Regexp.escape("<Array> #{[1,2,3,4]}")))
       assert_match rgxp, @layout.format(event)
 
       event.level = @levels['debug']

data/test/setup.rb

@@ -1,7 +1,12 @@
-# $Id: setup.rb 39 2007-10-26 20:22:01Z tim_pease $
+# $Id: setup.rb 53 2007-11-28 00:21:33Z tim_pease $
 
 require 'test/unit'
 
+# This line is needed for Ruby 1.9 -- hashes throw a "KeyError" in 1.9
+# whereas they throw an "IndexError" in 1.8
+#
+KeyError = IndexError if not defined? KeyError
+
 begin
   require 'logging'
 rescue LoadError
@@ -33,10 +38,14 @@ module LoggingTestCase
     end
 
     ::Logging::Repository.class_eval do
-      @__instance__ = nil
-      class << self
-        nonce = class << Singleton; self; end
-        define_method(:instance, nonce::FirstInstanceCall)
+      if defined?(@singleton__instance__)
+        @singleton__instance__ = nil
+      else
+        @__instance__ = nil
+        class << self
+          nonce = class << Singleton; self; end
+          define_method(:instance, nonce::FirstInstanceCall)
+        end
       end
     end
     

data/test/test_layout.rb

@@ -1,4 +1,4 @@
-# $Id: test_layout.rb 17 2007-01-20 18:47:43Z tim_pease $
+# $Id: test_layout.rb 53 2007-11-28 00:21:33Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -67,7 +67,7 @@ module TestLogging
 
       obj = [1, 2, 3, 4]
       r = @layout.send :format_obj, obj
-      assert_equal '<Array> 1234', r
+      assert_equal "<Array> #{[1,2,3,4]}", r
 
       obj = %w( one two three four )
       @layout = ::Logging::Layout.new :format_as => :inspect

data/test/test_logger.rb

@@ -1,4 +1,4 @@
-# $Id: test_logger.rb 33 2007-02-28 18:29:09Z tim_pease $
+# $Id: test_logger.rb 53 2007-11-28 00:21:33Z tim_pease $
 
 require 'test/setup.rb'
 require 'stringio'
@@ -287,7 +287,7 @@ module TestLogging
       assert_nil a2.readline
 
       log.warn [1,2,3,4]
-      assert_equal " WARN  A Logger : <Array> 1234\n", a1.readline
+      assert_equal " WARN  A Logger : <Array> #{[1,2,3,4]}\n", a1.readline
       assert_nil a1.readline
       assert_nil a2.readline
 

data/test/test_repository.rb

@@ -1,4 +1,4 @@
-# $Id: test_repository.rb 43 2007-10-27 22:22:33Z tim_pease $
+# $Id: test_repository.rb 53 2007-11-28 00:21:33Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -47,7 +47,7 @@ module TestLogging
       assert_same @repo[:root], @repo.fetch(:root)
 
       assert !@repo.has_logger?('A')
-      assert_raise(IndexError) {@repo.fetch 'A'}
+      assert_raise(KeyError) {@repo.fetch 'A'}
 
       %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.4
 specification_version: 1
 name: logging
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
-date: 2007-11-18 00:00:00 -07:00
+  version: 0.5.2
+date: 2007-11-28 00:00:00 -07:00
 summary: A flexible and extendable logging library for Ruby
 require_paths: 
 - lib