logging 1.5.0 → 1.5.1

data/History.txt

@@ -1,3 +1,10 @@
+== 1.5.1 / 2011-06-03
+
+Bug Fixes
+- IO streams cannot be buffered when using syswrite
+- JRuby does not allow shared locks on write only file descriptors
+- Fixing tests for JRuby 1.6.X
+
 == 1.5.0 / 2011-03-22
 
 Minor Enhancements

data/README.rdoc

@@ -1,8 +1,8 @@
 Logging
     by Tim Pease
 
-* {Homepage}[http://logging.rubyforge.org/]
-* {Rubyforge Project}[http://rubyforge.org/projects/logging]
+* {Homepage}[http://rubygems.org/gems/logging]
+* {Github Project}[http://github.com/TwP/logging]
 * email tim dot pease at gmail dot com
 
 == DESCRIPTION
@@ -14,7 +14,7 @@ formatting, and more.
 
 == INSTALL
 
-  sudo gem install logging
+  gem install logging
 
 == EXAMPLE
 
@@ -57,36 +57,38 @@ the recommended way of accomplishing this.
 
   class FirstClass
     def initialize
-      @log = Logging.logger[self]
+      @logger = Logging.logger[self]
     end
 
     def some_method
-      @log.debug "some method was called on #{self.inspect}"
+      @logger.debug "some method was called on #{self.inspect}"
     end
   end
 
   class SecondClass
     def initialize
-      @log = Logging.logger[self]
+      @logger = Logging.logger[self]
     end
 
     def another_method
-      @log.debug "another method was called on #{self.inspect}"
+      @logger.debug "another method was called on #{self.inspect}"
     end
   end
 
 There are many more examples in the "examples" folder of the logging
 package. The recommended reading order is the following:
 
-  simple.rb
-  loggers.rb
-  classes.rb
-  hierarchies.rb
-  names.rb
-  appenders.rb
-  layouts.rb
-  formatting.rb
-  consolidation.rb
+* {simple.rb}[http://github.com/TwP/logging/blob/master/examples/simple.rb]
+* {loggers.rb}[http://github.com/TwP/logging/blob/master/examples/loggers.rb]
+* {classes.rb}[http://github.com/TwP/logging/blob/master/examples/classes.rb]
+* {hierarchies.rb}[http://github.com/TwP/logging/blob/master/examples/hierarchies.rb]
+* {names.rb}[http://github.com/TwP/logging/blob/master/examples/names.rb]
+* {appenders.rb}[http://github.com/TwP/logging/blob/master/examples/appenders.rb]
+* {layouts.rb}[http://github.com/TwP/logging/blob/master/examples/layouts.rb]
+* {formatting.rb}[http://github.com/TwP/logging/blob/master/examples/formatting.rb]
+* {colorization.rb}[http://github.com/TwP/logging/blob/master/examples/colorization.rb]
+* {consolidation.rb}[http://github.com/TwP/logging/blob/master/examples/consolidation.rb]
+* {fork.rb}[http://github.com/TwP/logging/blob/master/examples/fork.rb]
 
 == NOTES
 
@@ -99,17 +101,19 @@ class names.
 
 == REQUIREMENTS
 
-Logging requires the "lockfile" gem to run and the "flexmock" gem to run the
-tests"
-
-== DEVELOPMENT REQUIREMENTS
-
 The Logging source code relies on the Mr Bones project for default rake tasks.
 You will need to install the Mr Bones gem if you want to build or test the
 logging gem.
 
    gem install bones
 
+After Mr Bones is installed you can install all the depdencies via the rake
+task.
+
+   rake gem:install_dependencies
+
+Always remember that "rake -T" is your friend!
+
 == LICENSE
 
 Ruby

data/lib/logging/appenders/io.rb

@@ -20,6 +20,8 @@ module Logging::Appenders
       end
 
       @io = io
+      @io.sync = true if io.respond_to? :sync=    # syswrite complains if the IO stream is buffered
+
       configure_buffering(opts)
       super(name, opts)
     end

data/lib/logging/appenders/rolling_file.rb

@@ -131,7 +131,9 @@ module Logging::Appenders
       meta = class << self; self end
       meta.class_eval code, __FILE__, __LINE__
 
-      super(name, ::File.new(@fn, 'a'), opts)
+      # we are opening the file in read/write mode so that a shared lock can
+      # be used on the file descriptor => http://pubs.opengroup.org/onlinepubs/009695399/functions/fcntl.html
+      super(name, ::File.new(@fn, 'a+'), opts)
 
       # setup the file roller
       @roller =
@@ -167,7 +169,7 @@ module Logging::Appenders
           @io.close rescue nil
         end
         @closed = false
-        @io = ::File.new(@fn, 'a')
+        @io = ::File.new(@fn, 'a+')
       }
       self
     end

data/lib/logging/log_event.rb

@@ -12,8 +12,8 @@ module Logging
     # * $2 == line number
     # * $3 == method name (might be nil)
     CALLER_RGXP = %r/([-\.\/\(\)\w]+):(\d+)(?::in `(\w+)')?/o
-    CALLER_INDEX = 2
-    #CALLER_INDEX = RUBY_PLATFORM[%r/^java/i] ? 1 : 2
+    #CALLER_INDEX = 2
+    CALLER_INDEX = (defined? JRUBY_VERSION and JRUBY_VERSION[%r/^1.6/]) ? 1 : 2
     # :startdoc:
 
     # call-seq:
@@ -42,4 +42,3 @@ module Logging
   }
 end  # module Logging
 
-# EOF

data/lib/logging/utils.rb

@@ -141,11 +141,11 @@ class File
   # return immediately (and the block will not be executed) if an exclusive
   # lock cannot be obtained.
   #
-  def flock?( &block )
+  def flock?
     status = flock(LOCK_EX|LOCK_NB)
     case status
     when false; true
-    when 0; block ? block.call : false
+    when 0; block_given? ? yield : false
     else
       raise SystemCallError, "flock failed with status: #{status}"
     end
@@ -153,13 +153,13 @@ class File
     flock LOCK_UN
   end
 
-  # Execute the <tt>block</tt> in the context of a shared lock on this file. A
+  # Execute a <tt>block</tt> in the context of a shared lock on this file. A
   # shared lock will be obtained on the file, the block executed, and the lock
   # released.
   #
-  def flock_sh( &block )
+  def flock_sh
     flock LOCK_SH
-    block.call
+    yield
   ensure
     flock LOCK_UN
   end

data/test/appenders/test_syslog.rb

@@ -20,7 +20,7 @@ module TestAppenders
     end
 
     def test_append
-      return if RUBY_PLATFORM =~ %r/cygwin/
+      return if RUBY_PLATFORM =~ %r/cygwin|java/i
 
       stderr = IO::pipe
 
@@ -78,7 +78,7 @@ module TestAppenders
     end
 
     def test_concat
-      return if RUBY_PLATFORM =~ %r/cygwin/
+      return if RUBY_PLATFORM =~ %r/cygwin|java/i
 
       stderr = IO::pipe
 

data/version.txt

@@ -1 +1 @@
-1.5.0
+1.5.1

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: logging
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 1
   - 5
-  - 0
-  version: 1.5.0
+  - 1
+  version: 1.5.1
 platform: ruby
 authors: 
 - Tim Pease
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-22 00:00:00 -06:00
+date: 2011-06-03 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,12 +90,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 27
         segments: 
         - 3
-        - 6
-        - 5
-        version: 3.6.5
+        - 7
+        - 0
+        version: 3.7.0
   type: :development
   version_requirements: *id005
 description: |-