logging 0.9.3 → 0.9.4

data/History.txt

@@ -1,3 +1,15 @@
+== 0.9.4 / 2008-10-04
+
+2 minor enhancements
+  - Flag to suppress exception backtraces from being logged
+  - Cleaning up color codes on Growl output
+4 bug fixes
+  - Child loggers were not being found in some cases
+  - RollingFileAppender fails to reopen the log file if
+    the log file is deleted.
+  - Fixed a copy/paste error in the YAML configurator
+  - Bug in the configurator where a nil object was being used
+
 == 0.9.3 / 2008-09-12
 
 2 minor enhancement

data/Manifest.txt

@@ -1,6 +1,6 @@
 History.txt
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 data/bad_logging_1.rb
 data/bad_logging_2.rb

data/Rakefile

@@ -12,14 +12,17 @@ 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.version = Logging::VERSION
-PROJ.release_name = %q{Log-O-Stat}
+PROJ.readme_file = 'README.rdoc'
 
 PROJ.exclude << %w[^tags$ ^tasks/archive ^coverage]
 PROJ.rdoc.exclude << '^data'
+PROJ.rdoc.include << PROJ.readme_file
+PROJ.rdoc.main = PROJ.readme_file
+#PROJ.rdoc.dir = 'doc/rdoc'
+#PROJ.rdoc.remote_dir = 'rdoc'
+PROJ.rdoc.dir = 'doc'
+PROJ.rdoc.remote_dir = ''
 
 PROJ.ann.email[:server] = 'smtp.gmail.com'
 PROJ.ann.email[:port] = 587

data/lib/logging.rb

@@ -13,7 +13,7 @@ begin require 'fastthread'; rescue LoadError; end
 module Logging
 
   # :stopdoc:
-  VERSION = '0.9.3'
+  VERSION = '0.9.4'
   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
@@ -227,6 +227,31 @@ module Logging
       module_eval "OBJ_FORMAT = :#{f}", __FILE__, __LINE__
     end
 
+    # call-seq:
+    #    Logging.backtrace             #=> true or false
+    #    Logging.backtrace( value )    #=> true or false
+    #
+    # Without any arguments, returns the global exception backtrace logging
+    # value. When set to +true+ backtraces will be written to the logs; when
+    # set to +false+ backtraces will be suppressed.
+    #
+    # When an argument is given the global exception backtrace setting will
+    # be changed. Value values are <tt>"on"</tt>, <tt>:on<tt> and +true+ to
+    # turn on backtraces and <tt>"off"</tt>, <tt>:off</tt> and +false+ to
+    # turn off backtraces.
+    #
+    def backtrace( b = nil )
+      @backtrace = true unless defined? @backtrace
+      return @backtrace if b.nil?
+
+      @backtrace = case b
+          when :on, 'on', true;    true
+          when :off, 'off', false; false
+          else
+            raise ArgumentError, "backtrace must be true or false"
+          end
+    end
+
     # Returns the version string for the library.
     #
     def version
@@ -331,6 +356,8 @@ module Logging
       children.sort {|a,b| a.name <=> b.name}.each do |child|
         ::Logging.show_configuration(io, child, indent)
       end
+
+      nil
     end
 
     # :stopdoc:

data/lib/logging/appenders/growl.rb

@@ -9,6 +9,10 @@ module Logging::Appenders
   #
   class Growl < ::Logging::Appender
 
+    # :stopdoc:
+    ColoredRegexp = %r/\e\[([34][0-7]|[0-9])m/
+    # :startdoc:
+
     # call-seq:
     #    Growl.new( name, opts = {} )
     #
@@ -84,13 +88,13 @@ module Logging::Appenders
         end
       return if message.empty?
 
+      message = message.gsub(ColoredRegexp, '')
       if @title_sep
         title, message = message.split(@title_sep)
         title, message = '', title if message.nil?
-        title.strip!
       end
 
-      growl(title, message, priority)
+      growl(title.strip, message.strip, priority)
       self
     end
 

data/lib/logging/appenders/rolling_file.rb

@@ -270,11 +270,13 @@ module Logging::Appenders
     def check_logfile
       retry_cnt ||= 0
 
-      @stat = ::File.stat(@fn)
-      return unless @lockfile
-      return if @inode == @stat.ino
+      if ::File.exist?(@fn) then
+        @stat = ::File.stat(@fn)
+        return unless @lockfile
+        return if @inode == @stat.ino
 
-      @io.close rescue nil
+        @io.close rescue nil
+      end
       open_logfile
     rescue SystemCallError
       raise if retry_cnt > 3

data/lib/logging/config/configurator.rb

@@ -29,6 +29,7 @@ module Logging::Config
       dsl.__instance_eval(&block)
 
       pre_config dsl.__pre_config
+      ::Logging::Logger[:root]  # ensures the log levels are defined
       appenders  dsl.__appenders
       loggers    dsl.__loggers
     end
@@ -52,6 +53,10 @@ module Logging::Config
       # format as
       format = config[:format_as]
       ::Logging.format_as(format) unless format.nil?
+
+      # backtrace
+      value = config[:backtrace]
+      ::Logging.backtrace(value) unless value.nil?
     end
 
     # call-seq:
@@ -157,17 +162,20 @@ module Logging::Config
     class TopLevelDSL < DSL
       undef_method :method_missing
 
+      def initialize
+        @loggers = []
+        @appenders = []
+      end
+
       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
 

data/lib/logging/config/yaml_configurator.rb

@@ -71,6 +71,7 @@ module Config
     #
     def load
       pre_config @config['pre_config']
+      ::Logging::Logger[:root]  # ensures the log levels are defined
       appenders @config['appenders']
       loggers @config['loggers']
     end
@@ -94,6 +95,10 @@ module Config
       format = config['format_as']
       ::Logging.format_as(format) unless format.nil?
 
+      # backtrace
+      value = config['backtrace']
+      ::Logging.backtrace(value) unless value.nil?
+
       # grab the root logger and set the logging level
       root = ::Logging::Logger.root
       if config.has_key?('root')
@@ -156,7 +161,7 @@ module Config
       raise Error, 'Appender type not given' if type.nil?
 
       name = config.delete('name')
-      raise Error, 'Appender name not given' if type.nil?
+      raise Error, 'Appender name not given' if name.nil?
 
       config['layout'] = layout(config.delete('layout'))
 

data/lib/logging/layout.rb

@@ -39,6 +39,14 @@ class Layout
     @obj_format = case f
                   when :inspect, :yaml; f
                   else :string end
+
+    b = opts.getopt(:backtrace, ::Logging.backtrace)
+    @backtrace = case b
+        when :on, 'on', true;    true
+        when :off, 'off', false; false
+        else
+          raise ArgumentError, "backtrace must be true or false"
+        end
   end
 
   # call-seq:
@@ -79,7 +87,7 @@ class Layout
     when String; obj
     when Exception 
       str = "<#{obj.class.name}> #{obj.message}"
-      unless obj.backtrace.nil?
+      if @backtrace && !obj.backtrace.nil?
         str << "\n\t" << obj.backtrace.join("\n\t")
       end
       str

data/lib/logging/logger.rb

@@ -53,6 +53,7 @@ module Logging
           if logger.nil?
             logger = super(name, *args)
             repo[name] = logger
+            repo.children(name).each {|c| c.__send__(:parent=, logger)}
           end
           logger
         end
@@ -142,7 +143,6 @@ module Logging
 
       repo = ::Logging::Repository.instance
       _setup(name, :parent => repo.parent(name))
-      repo.children(name).each {|c| c.parent = self}
     end
 
     # call-seq:

data/lib/logging/repository.rb

@@ -107,17 +107,9 @@ module Logging
     # of B is A. Parents are determined by namespace.
     #
     def parent( key )
-      return if 'root' == key.to_s
-
-      key = to_key(key)
-      a = key.split PATH_DELIMITER
-
-      p = @h[:root]
-      while a.slice!(-1) and !a.empty?
-        k = a.join PATH_DELIMITER
-        if @h.has_key? k then p = @h[k]; break end
-      end
-      p
+      name = _parent_name(to_key(key))
+      return if name.nil?
+      @h[name]
     end
 
     # call-seq:
@@ -128,31 +120,15 @@ module Logging
     # +Repository#[]+. Children are returned regardless of the
     # 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
+    def children( parent )
+      ary = []
+      parent = to_key(parent)
 
-      key = to_key(key)
-      depth = key.split(PATH_DELIMITER).length
-      rgxp = Regexp.new "^#{key}#{PATH_DELIMITER}"
-
-      a = @h.keys.map do |k|
-            if k =~ rgxp
-              l = @h[k]
-              d = l.parent.name.split(PATH_DELIMITER).length
-              if d <= depth then l else nil end
-            end
-          end
-      a.compact.sort
+      @h.each_pair do |child,logger|
+        next if :root == child
+        ary << logger if parent == _parent_name(child)
+      end
+      return ary.sort
     end
 
     # call-seq:
@@ -175,6 +151,21 @@ module Logging
       end
     end
 
+    # Returns the name of the parent for the logger identified by the given
+    # _key_. If the _key_ is for the root logger, then +nil+ is returned.
+    #
+    def _parent_name( key )
+      return if :root == key
+
+      a = key.split PATH_DELIMITER
+      p = :root
+      while a.slice!(-1) and !a.empty?
+        k = a.join PATH_DELIMITER
+        if @h.has_key? k then p = k; break end
+      end
+      p
+    end
+
   end  # class Repository
 end  # module Logging
 

data/test/appenders/test_rolling_file.rb

@@ -171,6 +171,27 @@ module TestAppenders
       cleanup
     end
 
+    def test_file_removed
+      assert_equal [], Dir.glob(@glob)
+
+      ap = ::Logging::Appenders::RollingFile.new(NAME,
+               :filename => @fn, :size => 100)
+
+      ap << 'X' * 100; ap.flush
+      assert_equal 1, Dir.glob(@glob).length
+      assert_equal 100, File.size(@fn)
+
+      # Now remove @fn and make sure that the log file is written to
+      # again
+      File.unlink(@fn)
+      assert_equal 0, Dir.glob(@glob).length
+
+      ap << 'X' * 50; ap.flush
+      assert_equal 1, Dir.glob(@glob).length
+      assert_equal 50, File.size(@fn)
+
+    end
+
     private
     def cleanup
       unless ::Logging::Appender[NAME].nil?

data/test/setup.rb

@@ -53,6 +53,8 @@ module LoggingTestCase
     
   def teardown
     super
+    ::Logging.backtrace
+    ::Logging.__send__(:remove_instance_variable, :@backtrace)
     h = ::Logging::Appender.instance_variable_get(:@appenders)
     h.each_value {|a| a.close(false) unless a.nil? || a.closed?}
     h.clear

data/test/test_layout.rb

@@ -78,6 +78,29 @@ module TestLogging
       assert_equal "<Array> \n--- \n- one\n- two\n- three\n- four\n", r
     end
 
+    def test_format_obj_without_backtrace
+      @layout = ::Logging::Layout.new :backtrace => 'off'
+
+      obj = Exception.new 'some exception'
+      obj.set_backtrace %w( this is the backtrace )
+      r = @layout.send :format_obj, obj
+      obj = "<Exception> some exception"
+      assert_equal obj, r
+
+      ::Logging.backtrace :off
+      @layout = ::Logging::Layout.new
+
+      obj = ArgumentError.new 'wrong type of argument'
+      obj.set_backtrace %w( this is the backtrace )
+      r = @layout.send :format_obj, obj
+      obj = "<ArgumentError> wrong type of argument"
+      assert_equal obj, r
+    end
+
+    def test_initializer
+      assert_raise(ArgumentError) {::Logging::Layout.new :backtrace => 'foo'}
+    end
+
   end  # class TestLayout
 end  # module TestLogging
 

data/test/test_logging.rb

@@ -15,6 +15,30 @@ module TestLogging
       @glob = File.join(TMP, '*.log')
     end
 
+    def test_backtrace
+      assert_equal true, ::Logging.backtrace
+
+      assert_equal false, ::Logging.backtrace('off')
+      assert_equal false, ::Logging.backtrace
+
+      assert_equal true, ::Logging.backtrace('on')
+      assert_equal true, ::Logging.backtrace
+
+      assert_equal false, ::Logging.backtrace(:off)
+      assert_equal false, ::Logging.backtrace
+
+      assert_equal true, ::Logging.backtrace(:on)
+      assert_equal true, ::Logging.backtrace
+
+      assert_equal false, ::Logging.backtrace(false)
+      assert_equal false, ::Logging.backtrace
+
+      assert_equal true, ::Logging.backtrace(true)
+      assert_equal true, ::Logging.backtrace
+
+      assert_raise(ArgumentError) {::Logging.backtrace 'foo'}
+    end
+
     def test_configure
       assert_raise(ArgumentError) {::Logging.configure 'blah.txt'}
 

data/test/test_repository.rb

@@ -92,7 +92,7 @@ module TestLogging
 
       assert_equal [@repo['A::B']], @repo.children('A')
       assert_equal a, @repo.children('A::B')
-      assert_equal a, @repo.children('A::B::C')
+      assert_equal [], @repo.children('A::B::C')
 
       ::Logging::Logger.new('A::B::C')
 

data/test/test_stats.rb

@@ -220,7 +220,7 @@ module TestStats
 
       sampler = @stats['foo']
       assert_equal 1, sampler.num
-      assert_in_delta 0.05, sampler.sum, 1e-3
+      assert_in_delta 0.05, sampler.sum, 1e-2
 
       @tracker.time('foo') {sleep 0.05}
       assert_equal 2, sampler.num

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: logging
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-13 00:00:00 -06:00
+date: 2008-10-07 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,11 +40,11 @@ extensions: []
 
 extra_rdoc_files: 
 - History.txt
-- README.txt
+- README.rdoc
 files: 
 - History.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - data/bad_logging_1.rb
 - data/bad_logging_2.rb
@@ -109,7 +109,7 @@ homepage: http://logging.rubyforge.org/
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement