TwP-logging 0.9.7 → 0.9.8

data/History.txt

@@ -1,5 +1,12 @@
-== 0.9.7 / 2009-02-
+== 0.9.8 / 2009-04-11
 
+1 minor enhancement
+  - Adding a to_s method to the StringIo appender's StringIO object
+
+== 0.9.7 / 2009-03-17
+
+1 minor enhancement
+  - Added a StringIO appender
 1 bug fix
   - Handling objects that cannot be dumped via YAML [Tim Galeckas]
 

data/lib/logging.rb

@@ -8,16 +8,12 @@ begin require 'fastthread'; rescue LoadError; end
 
 # TODO: Windows Log Service appender
 
-# TODO: Option to buffer log messages at the appender level
-#       extend the concept found in the e-mail appender into the other IO
-#       appenders
-
 #
 #
 module Logging
 
   # :stopdoc:
-  VERSION = '0.9.7'
+  VERSION = '0.9.8'
   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

data/lib/logging/appenders/string_io.rb

@@ -0,0 +1,69 @@
+
+require 'stringio'
+
+module Logging::Appenders
+
+  # This class provides an Appender that can write to a StringIO instance.
+  # This is very useful for testing log message output.
+  #
+  class StringIo < ::Logging::Appenders::IO
+
+    # The StringIO instance the appender is writing to.
+    attr_reader :sio
+
+    # call-seq:
+    #    StringIo.new( name, opts = {} )
+    #
+    # Creates a new StrinIo appender that will append log messages to a
+    # StringIO instance.
+    #
+    def initialize( name, opts = {} )
+      @sio = StringIO.new
+      @sio.extend IoToS
+      super(name, @sio, opts)
+      clear
+    end
+
+    # Read a single line of text from the internal StringIO instance. +nil+
+    # is returned if the StringIO buffer is empty.
+    #
+    def readline
+      sync {
+        begin
+          @sio.seek @pos
+          line = @sio.readline
+          @pos = @sio.tell
+          line
+        rescue EOFError
+          nil
+        end
+      }
+    end
+
+    # Clears the internal StringIO instance. All log messages are removed
+    # from the buffer.
+    #
+    def clear
+      sync {
+        @pos = 0
+        @sio.seek 0
+        @sio.truncate 0
+      }
+    end
+    alias :reset :clear
+
+    # :stopdoc:
+    module IoToS
+      def to_s
+        seek 0
+        str = read
+        seek 0
+        return str
+      end
+    end
+    # :startdoc:
+
+  end  # class StringIo
+end  # module Logging::Appenders
+
+# EOF

data/logging.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{logging}
-  s.version = "0.9.7"
+  s.version = "0.9.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Pease"]
-  s.date = %q{2009-02-23}
+  s.date = %q{2009-04-11}
   s.description = %q{Logging is a flexible logging library for use in Ruby programs based on the design of Java's log4j library. It features a hierarchical logging system, custom level names, multiple output destinations per log event, custom formatting, and more.}
   s.email = %q{tim.pease@gmail.com}
   s.extra_rdoc_files = ["History.txt", "README.rdoc"]
-  s.files = ["History.txt", "README.rdoc", "Rakefile", "data/bad_logging_1.rb", "data/bad_logging_2.rb", "data/logging.rb", "data/logging.yaml", "data/simple_logging.rb", "lib/logging.rb", "lib/logging/appender.rb", "lib/logging/appenders/buffering.rb", "lib/logging/appenders/console.rb", "lib/logging/appenders/email.rb", "lib/logging/appenders/file.rb", "lib/logging/appenders/growl.rb", "lib/logging/appenders/io.rb", "lib/logging/appenders/rolling_file.rb", "lib/logging/appenders/syslog.rb", "lib/logging/config/configurator.rb", "lib/logging/config/yaml_configurator.rb", "lib/logging/layout.rb", "lib/logging/layouts/basic.rb", "lib/logging/layouts/pattern.rb", "lib/logging/log_event.rb", "lib/logging/logger.rb", "lib/logging/repository.rb", "lib/logging/root_logger.rb", "lib/logging/stats.rb", "lib/logging/utils.rb", "logging.gemspec", "test/appenders/test_buffered_io.rb", "test/appenders/test_console.rb", "test/appenders/test_email.rb", "test/appenders/test_file.rb", "test/appenders/test_growl.rb", "test/appenders/test_io.rb", "test/appenders/test_rolling_file.rb", "test/appenders/test_syslog.rb", "test/benchmark.rb", "test/config/test_configurator.rb", "test/config/test_yaml_configurator.rb", "test/layouts/test_basic.rb", "test/layouts/test_pattern.rb", "test/setup.rb", "test/test_appender.rb", "test/test_layout.rb", "test/test_log_event.rb", "test/test_logger.rb", "test/test_logging.rb", "test/test_repository.rb", "test/test_root_logger.rb", "test/test_stats.rb", "test/test_utils.rb"]
+  s.files = ["History.txt", "README.rdoc", "Rakefile", "data/bad_logging_1.rb", "data/bad_logging_2.rb", "data/logging.rb", "data/logging.yaml", "data/simple_logging.rb", "lib/logging.rb", "lib/logging/appender.rb", "lib/logging/appenders/buffering.rb", "lib/logging/appenders/console.rb", "lib/logging/appenders/email.rb", "lib/logging/appenders/file.rb", "lib/logging/appenders/growl.rb", "lib/logging/appenders/io.rb", "lib/logging/appenders/rolling_file.rb", "lib/logging/appenders/string_io.rb", "lib/logging/appenders/syslog.rb", "lib/logging/config/configurator.rb", "lib/logging/config/yaml_configurator.rb", "lib/logging/layout.rb", "lib/logging/layouts/basic.rb", "lib/logging/layouts/pattern.rb", "lib/logging/log_event.rb", "lib/logging/logger.rb", "lib/logging/repository.rb", "lib/logging/root_logger.rb", "lib/logging/stats.rb", "lib/logging/utils.rb", "logging.gemspec", "test/appenders/test_buffered_io.rb", "test/appenders/test_console.rb", "test/appenders/test_email.rb", "test/appenders/test_file.rb", "test/appenders/test_growl.rb", "test/appenders/test_io.rb", "test/appenders/test_rolling_file.rb", "test/appenders/test_syslog.rb", "test/benchmark.rb", "test/config/test_configurator.rb", "test/config/test_yaml_configurator.rb", "test/layouts/test_basic.rb", "test/layouts/test_pattern.rb", "test/setup.rb", "test/test_appender.rb", "test/test_layout.rb", "test/test_log_event.rb", "test/test_logger.rb", "test/test_logging.rb", "test/test_repository.rb", "test/test_root_logger.rb", "test/test_stats.rb", "test/test_utils.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://logging.rubyforge.org/}
   s.rdoc_options = ["--main", "README.rdoc"]
@@ -27,15 +27,15 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<flexmock>, [">= 0.8.2"])
       s.add_runtime_dependency(%q<lockfile>, [">= 1.4.3"])
-      s.add_development_dependency(%q<bones>, [">= 2.4.0"])
+      s.add_development_dependency(%q<bones>, [">= 2.5.0"])
     else
       s.add_dependency(%q<flexmock>, [">= 0.8.2"])
       s.add_dependency(%q<lockfile>, [">= 1.4.3"])
-      s.add_dependency(%q<bones>, [">= 2.4.0"])
+      s.add_dependency(%q<bones>, [">= 2.5.0"])
     end
   else
     s.add_dependency(%q<flexmock>, [">= 0.8.2"])
     s.add_dependency(%q<lockfile>, [">= 1.4.3"])
-    s.add_dependency(%q<bones>, [">= 2.4.0"])
+    s.add_dependency(%q<bones>, [">= 2.5.0"])
   end
 end

data/test/appenders/test_buffered_io.rb

@@ -12,11 +12,10 @@ module TestAppenders
       ::Logging.init
       @levels = ::Logging::LEVELS
 
-      @sio = StringIO.new
-      @appender = ::Logging::Appenders::IO.new(
-        'test_appender', @sio,
-        :auto_flushing => 3, :immediate_at => :error
+      @appender = ::Logging::Appenders::StringIo.new(
+        'test_appender', :auto_flushing => 3, :immediate_at => :error
       )
+      @sio = @appender.sio
 
       begin readline rescue EOFError end
     end
@@ -25,10 +24,10 @@ module TestAppenders
       event = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
                                       [1, 2, 3, 4], false)
       @appender.append event
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       @appender.append event
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       event.level = @levels['debug']
       event.data = 'the big log message'
@@ -37,7 +36,7 @@ module TestAppenders
       assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
       assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
       assert_equal "DEBUG  TestLogger : the big log message\n", readline
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       @appender.close
       assert_raise(RuntimeError) {@appender.append event}
@@ -46,10 +45,8 @@ module TestAppenders
     def test_append_error
       # setup an internal logger to capture error messages from the IO
       # appender
-      log = StringIO.new
-      Logging::Logger[Logging].add_appenders(
-        Logging::Appenders::IO.new('__internal_io', log)
-      )
+      log = Logging::Appenders::StringIo.new('__internal_io')
+      Logging::Logger[Logging].add_appenders(log)
       Logging::Logger[Logging].level = 'all'
 
 
@@ -58,15 +55,12 @@ module TestAppenders
       event = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
                                       [1, 2, 3, 4], false)
       @appender.append event
-      log.seek 0
-      assert_raise(EOFError) {log.readline}
+      assert_nil(log.readline)
 
       @appender.append event
-      log.seek 0
-      assert_raise(EOFError) {log.readline}
+      assert_nil(log.readline)
 
       @appender.append event
-      log.seek 0
       assert_equal "INFO  Logging : appender \"test_appender\" has been disabled", log.readline.strip
       assert_equal "ERROR  Logging : <IOError> not opened for writing", log.readline.strip
 
@@ -92,17 +86,17 @@ module TestAppenders
 
     def test_concat
       @appender << "this is a test message\n"
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       @appender << "this is another message\n"
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       @appender << "some other line\n"
 
       assert_equal "this is a test message\n", readline
       assert_equal "this is another message\n", readline
       assert_equal "some other line\n", readline
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       @appender.close
       assert_raise(RuntimeError) {@appender << 'message'}
@@ -111,24 +105,19 @@ module TestAppenders
     def test_concat_error
       # setup an internal logger to capture error messages from the IO
       # appender
-      log = StringIO.new
-      Logging::Logger[Logging].add_appenders(
-        Logging::Appenders::IO.new('__internal_io', log)
-      )
+      log = Logging::Appenders::StringIo.new('__internal_io')
+      Logging::Logger[Logging].add_appenders(log)
       Logging::Logger[Logging].level = 'all'
 
       # close the string IO object so we get an error
       @sio.close
       @appender << 'oopsy'
-      log.seek 0
-      assert_raise(EOFError) {log.readline}
+      assert_nil(log.readline)
 
       @appender << 'whoopsy'
-      log.seek 0
-      assert_raise(EOFError) {log.readline}
+      assert_nil(log.readline)
 
       @appender << 'pooh'
-      log.seek 0
       assert_equal "INFO  Logging : appender \"test_appender\" has been disabled", log.readline.strip
       assert_equal "ERROR  Logging : <IOError> not opened for writing", log.readline.strip
 
@@ -143,19 +132,19 @@ module TestAppenders
       def @sio.flush() @ary << :flush end
 
       @appender << "this is a test message\n"
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       @appender.flush
       assert_equal :flush, ary.pop
       assert_equal "this is a test message\n", readline
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
     end
 
     def test_immediate_at
       event = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
                                       [1, 2, 3, 4], false)
       @appender.append event
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       event.level = @levels['error']
       event.data = 'an error message'
@@ -163,16 +152,12 @@ module TestAppenders
 
       assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
       assert_equal "ERROR  TestLogger : an error message\n", readline
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
     end
 
     private
     def readline
-      @pos ||= 0
-      @sio.seek @pos
-      line = @sio.readline
-      @pos = @sio.tell
-      line
+      @appender.readline
     end
 
   end  # class TestBufferedIO

data/test/appenders/test_io.rb

@@ -12,9 +12,8 @@ module TestAppenders
       ::Logging.init
       @levels = ::Logging::LEVELS
 
-      @sio = StringIO.new
-      @appender = ::Logging::Appenders::IO.new 'test_appender', @sio
-      begin readline rescue EOFError end
+      @appender = ::Logging::Appenders::StringIo.new 'test_appender'
+      @sio = @appender.sio
     end
 
     def test_append
@@ -22,13 +21,13 @@ module TestAppenders
                                       [1, 2, 3, 4], false)
       @appender.append event
       assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       event.level = @levels['debug']
       event.data = 'the big log message'
       @appender.append event
       assert_equal "DEBUG  TestLogger : the big log message\n", readline
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       @appender.close
       assert_raise(RuntimeError) {@appender.append event}
@@ -37,20 +36,16 @@ module TestAppenders
     def test_append_error
       # setup an internal logger to capture error messages from the IO
       # appender
-      log = StringIO.new
-      Logging::Logger[Logging].add_appenders(
-        Logging::Appenders::IO.new('__internal_io', log)
-      )
+      log = Logging::Appenders::StringIo.new('__internal_io')
+      Logging::Logger[Logging].add_appenders(log)
       Logging::Logger[Logging].level = 'all'
 
-
       # close the string IO object so we get an error
       @sio.close
       event = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
                                       [1, 2, 3, 4], false)
       @appender.append event
 
-      log.seek 0
       assert_equal "INFO  Logging : appender \"test_appender\" has been disabled", log.readline.strip
       assert_equal "ERROR  Logging : <IOError> not opened for writing", log.readline.strip
 
@@ -77,13 +72,13 @@ module TestAppenders
     def test_concat
       @appender << "this is a test message\n"
       assert_equal "this is a test message\n", readline
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       @appender << "this is another message\n"
       @appender << "some other line\n"
       assert_equal "this is another message\n", readline
       assert_equal "some other line\n", readline
-      assert_raise(EOFError) {readline}
+      assert_nil(readline)
 
       @appender.close
       assert_raise(RuntimeError) {@appender << 'message'}
@@ -92,17 +87,14 @@ module TestAppenders
     def test_concat_error
       # setup an internal logger to capture error messages from the IO
       # appender
-      log = StringIO.new
-      Logging::Logger[Logging].add_appenders(
-        Logging::Appenders::IO.new('__internal_io', log)
-      )
+      log = Logging::Appenders::StringIo.new('__internal_io')
+      Logging::Logger[Logging].add_appenders(log)
       Logging::Logger[Logging].level = 'all'
 
       # close the string IO object so we get an error
       @sio.close
       @appender << 'oopsy'
 
-      log.seek 0
       assert_equal "INFO  Logging : appender \"test_appender\" has been disabled", log.readline.strip
       assert_equal "ERROR  Logging : <IOError> not opened for writing", log.readline.strip
 
@@ -127,11 +119,7 @@ module TestAppenders
 
     private
     def readline
-      @pos ||= 0
-      @sio.seek @pos
-      line = @sio.readline
-      @pos = @sio.tell
-      line
+      @appender.readline
     end
 
   end  # class TestIO

data/test/benchmark.rb

@@ -18,7 +18,6 @@ rescue LoadError
 end
 
 require 'benchmark'
-require 'stringio'
 require 'logger'
 
 module Logging

data/test/setup.rb

@@ -7,7 +7,6 @@ LOGGING_TEST_SETUP = true
 require 'rubygems'
 require 'test/unit'
 require 'fileutils'
-require 'stringio'
 begin
   require 'turn'
 rescue LoadError; end

data/test/test_logger.rb

@@ -20,8 +20,8 @@ module TestLogging
       root = ::Logging::Logger[:root]
       root.level = 'info'
 
-      a1 = SioAppender.new 'a1'
-      a2 = SioAppender.new 'a2'
+      a1 = ::Logging::Appenders::StringIo.new 'a1'
+      a2 = ::Logging::Appenders::StringIo.new 'a2'
       log = ::Logging::Logger.new 'A Logger'
 
       root.add_appenders a1
@@ -214,8 +214,8 @@ module TestLogging
     end
 
     def test_concat
-      a1 = SioAppender.new 'a1'
-      a2 = SioAppender.new 'a2'
+      a1 = ::Logging::Appenders::StringIo.new 'a1'
+      a2 = ::Logging::Appenders::StringIo.new 'a2'
       log = ::Logging::Logger.new 'A'
 
       ::Logging::Logger[:root].add_appenders a1
@@ -414,8 +414,8 @@ module TestLogging
       root = ::Logging::Logger[:root]
       root.level = 'info'
 
-      a1 = SioAppender.new 'a1'
-      a2 = SioAppender.new 'a2'
+      a1 = ::Logging::Appenders::StringIo.new 'a1'
+      a2 = ::Logging::Appenders::StringIo.new 'a2'
       log = ::Logging::Logger.new 'A Logger'
 
       root.add_appenders a1
@@ -645,6 +645,7 @@ module TestLogging
       log_d = ::Logging::Logger['A-logger::D-logger']
 
       sio = StringIO.new
+      sio.extend ::Logging::Appenders::StringIo::IoToS
 
       log_a._dump_configuration( sio )
       assert_equal(
@@ -697,38 +698,6 @@ module TestLogging
     end
 
   end  # class TestLogger
-
-  class SioAppender < ::Logging::Appenders::IO
-
-    def initialize( name, opts = {} )
-      @sio = StringIO.new
-      super(name, @sio, opts)
-      begin readline rescue EOFError end
-    end
-
-    def readline
-      @pos ||= 0
-      @sio.seek @pos
-      begin
-        line = @sio.readline
-        @pos = @sio.tell
-        line
-      rescue EOFError
-        nil
-      end
-    end
-
-  end  # class SioAppender
-
 end  # module TestLogging
 
-class StringIO
-  def to_s
-    seek 0
-    str = read
-    seek 0
-    return str
-  end
-end
-
 # EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: TwP-logging
 version: !ruby/object:Gem::Version 
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-23 00:00:00 -08:00
+date: 2009-04-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.4.0
+        version: 2.5.0
     version: 
 description: Logging is a flexible logging library for use in Ruby programs based on the design of Java's log4j library. It features a hierarchical logging system, custom level names, multiple output destinations per log event, custom formatting, and more.
 email: tim.pease@gmail.com
@@ -69,6 +69,7 @@ files:
 - lib/logging/appenders/growl.rb
 - lib/logging/appenders/io.rb
 - lib/logging/appenders/rolling_file.rb
+- lib/logging/appenders/string_io.rb
 - lib/logging/appenders/syslog.rb
 - lib/logging/config/configurator.rb
 - lib/logging/config/yaml_configurator.rb