logging 1.6.0 → 1.6.1

data/History.txt

@@ -1,4 +1,10 @@
-== 1.6.0 / 2011-08-
+== 1.6.1 / 2011-09-09
+
+Bug Fixes
+- Rails compatibility methods [issue #11]
+- Blocked rolling file appender [issue #12]
+
+== 1.6.0 / 2011-08-22
 
 Enhancements
 - Adding periodic flushing of buffered messages [issue #10]

data/lib/logging.rb

@@ -529,6 +529,8 @@ Logging.libpath {
 
   require 'logging/config/configurator'
   require 'logging/config/yaml_configurator'
+
+  require 'logging/rails_compat'
 }
 
 
@@ -536,7 +538,7 @@ Logging.libpath {
 # This is needed for closing IO streams and connections to the syslog server
 # or e-mail servers, etc.
 #
-at_exit {Logging.shutdown}
+at_exit { Logging.shutdown }
 
 end  # unless defined?
 

data/lib/logging/appenders/rolling_file.rb

@@ -205,7 +205,7 @@ module Logging::Appenders
     # Returns +true+ if the log file needs to be rolled.
     #
     def roll_required?
-      return false if ::File.exist? @fn_copy
+      return false if ::File.exist?(@fn_copy) and (Time.now - ::File.mtime(@fn_copy)) < 180
 
       # check if max size has been exceeded
       s = @size ? ::File.size(@fn) > @size : false
@@ -222,7 +222,7 @@ module Logging::Appenders
     #
     def copy_truncate
       return unless ::File.exist?(@fn)
-      FileUtils.copy @fn, @fn_copy
+      FileUtils.concat @fn, @fn_copy
       @io.truncate 0
 
       # touch the age file if needed

data/lib/logging/rails_compat.rb

@@ -0,0 +1,33 @@
+
+if defined? ActiveSupport
+
+module Logging
+
+  # Rails compatibility module.
+  #
+  # The ActiveSupport gem adds a few methods to the default Ruby logger, and
+  # some Rails extensions expect these methods to exist. Those methods are
+  # implemented in this module and included in the Logging::Logger class when
+  # the ActiveSupport gem is present.
+  #
+  module RailsCompat
+
+    # A no-op implementation of the +silence+ method. Setting of log levels
+    # should be done during the Logging configuration. It is the author's
+    # opinion that overriding the log level programmaticaly is a logical
+    # error.
+    #
+    # Please see https://github.com/TwP/logging/issues/11 for a more detail
+    # discussion of the issue.
+    #
+    def silence( *args )
+      yield self
+    end
+
+  end  # RailsCompat
+
+  Logger.send :include, RailsCompat
+
+end  # Logging
+end  # if defined?
+

data/lib/logging/utils.rb

@@ -174,6 +174,32 @@ class File
 
 end
 
+# --------------------------------------------------------------------------
+module FileUtils
+
+  # Concatenate the contents of the _src_ file to the end of the _dest_ file.
+  # If the _dest_ file does not exist, then the _src_ file is copied to the
+  # _dest_ file using +copy_file+.
+  #
+  def concat( src, dest )
+    if File.exist?(dest)
+      bufsize = File.stat(dest).blksize || 8192
+      buffer = String.new
+
+      File.open(dest, 'a') { |d|
+        File.open(src, 'r') { |r|
+          while bytes = r.read(bufsize, buffer)
+            d.syswrite bytes
+          end
+        }
+      }
+    else
+      copy_file(src, dest)
+    end
+  end
+  module_function :concat
+end
+
 # --------------------------------------------------------------------------
 class ReentrantMutex < Mutex
 

data/test/appenders/test_rolling_file.rb

@@ -211,6 +211,37 @@ module TestAppenders
       end
     end
 
+    def test_stale_copy_file
+      ap = Logging.appenders.rolling_file(NAME, :filename => @fn, :size => 100)
+
+      fn_copy = @fn + '._copy_'
+      File.open(fn_copy, 'w') { |copy| copy.puts 'stale copy file' }
+
+      ap << 'X' * 100; ap.flush
+      assert_equal 1, Dir.glob(@glob).length
+      assert_equal 100, File.size(@fn)
+
+      # this character is appended to the log file (bringing its size to 101)
+      # but the file is NOT ROLLED because the _copy_ file is in the way
+      ap << 'X'
+      assert_equal 1, Dir.glob(@glob).length
+      assert_equal 101, File.size(@fn)
+      assert_equal 16, File.size(fn_copy)
+
+      # if the _copy_ file is older than three minutes, it will be
+      # concatenated to and moved out of the way
+      time = Time.now - 200
+      ::File.utime(time, time, fn_copy)
+
+      ap << 'X'
+      assert_equal 2, Dir.glob(@glob).length
+      assert_equal 0, File.size(@fn)
+      assert_equal 118, File.size(Dir.glob(@glob).sort.first)
+      assert !File.exist?(fn_copy), '_copy_ file should not exist'
+
+      cleanup
+    end
+
   private
     def cleanup
       unless Logging.appenders[NAME].nil?

data/version.txt

@@ -1 +1 @@
-1.6.0
+1.6.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logging
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-22 00:00:00.000000000Z
+date: 2011-09-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: little-plugger
-  requirement: &2161856200 !ruby/object:Gem::Requirement
+  requirement: &2162102160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2161856200
+  version_requirements: *2162102160
 - !ruby/object:Gem::Dependency
   name: flexmock
-  requirement: &2161855660 !ruby/object:Gem::Requirement
+  requirement: &2162101340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *2161855660
+  version_requirements: *2162101340
 - !ruby/object:Gem::Dependency
   name: bones-git
-  requirement: &2161855040 !ruby/object:Gem::Requirement
+  requirement: &2162100820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.4
   type: :development
   prerelease: false
-  version_requirements: *2161855040
+  version_requirements: *2162100820
 - !ruby/object:Gem::Dependency
   name: bones-rcov
-  requirement: &2161854480 !ruby/object:Gem::Requirement
+  requirement: &2162100100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *2161854480
+  version_requirements: *2162100100
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2161853900 !ruby/object:Gem::Requirement
+  requirement: &2162099500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: 3.7.0
   type: :development
   prerelease: false
-  version_requirements: *2161853900
+  version_requirements: *2162099500
 description: ! 'Logging is a flexible logging library for use in Ruby programs based
   on the
 
@@ -123,6 +123,7 @@ files:
 - lib/logging/log_event.rb
 - lib/logging/logger.rb
 - lib/logging/proxy.rb
+- lib/logging/rails_compat.rb
 - lib/logging/repository.rb
 - lib/logging/root_logger.rb
 - lib/logging/stats.rb