logging 2.0.0 → 2.3.0

data/test/setup.rb

@@ -1,42 +1,38 @@
-
 # Equivalent to a header guard in C/C++
 # Used to prevent the class/module from being loaded more than once
 unless defined? LOGGING_TEST_SETUP
 LOGGING_TEST_SETUP = true
 
-require 'rubygems'
-require 'test/unit'
-begin
-  require 'turn'
-rescue LoadError; end
+require "rubygems"
+require "test/unit"
+require "tmpdir"
 
-# 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
+LOGGING_TEST_TMPDIR = Dir.mktmpdir("logging")
+Test::Unit.at_exit do
+  FileUtils.remove_entry(LOGGING_TEST_TMPDIR)
+end
 
-require File.join(File.dirname(__FILE__), %w[.. lib logging])
+if Test::Unit::TestCase.respond_to? :test_order=
+  Test::Unit::TestCase.test_order = :random
+end
 
+require File.expand_path("../../lib/logging", __FILE__)
 
 module TestLogging
-module LoggingTestCase
-
-  TMP = 'tmp'
-
-  def setup
-    super
-    Logging.reset
-    FileUtils.rm_rf TMP
-    FileUtils.mkdir TMP
+  module LoggingTestCase
+
+    def setup
+      super
+      Logging.reset
+      @tmpdir = LOGGING_TEST_TMPDIR
+      FileUtils.rm_rf(Dir.glob(File.join(@tmpdir, "*")))
+    end
+
+    def teardown
+      super
+      FileUtils.rm_rf(Dir.glob(File.join(@tmpdir, "*")))
+    end
   end
+end
 
-  def teardown
-    super
-    FileUtils.rm_rf TMP
-  end
-
-end  # LoggingTestCase
-end  # TestLogging
-
-end  # defined?
-
+end

data/test/test_appender.rb

@@ -189,11 +189,9 @@ module TestLogging
       assert_equal 'test_appender', @appender.name
     end
 
-    def test_inspect
-      expected = "<Appender:0x%x name=\"test_appender\">" % @appender.object_id
-      assert_equal expected, @appender.inspect
+    def test_to_s
+      assert_equal "<Appender name=\"test_appender\">", @appender.to_s
     end
-
   end  # class TestAppender
 end  # module TestLogging
 

data/test/test_layout.rb

@@ -111,6 +111,55 @@ module TestLogging
       assert_raise(ArgumentError) {::Logging::Layout.new :backtrace => 'foo'}
     end
 
+    def test_backtrace_accessors
+      assert @layout.backtrace?
+
+      @layout.backtrace = :off
+      refute @layout.backtrace?
+
+      @layout.backtrace = 'on'
+      assert_equal true, @layout.backtrace
+    end
+
+    def test_utc_offset
+      assert_nil @layout.utc_offset
+
+      @layout.utc_offset = 0
+      assert_equal 0, @layout.utc_offset
+
+      @layout.utc_offset = "UTC"
+      assert_equal 0, @layout.utc_offset
+
+      @layout.utc_offset = "+01:00"
+      assert_equal "+01:00", @layout.utc_offset
+
+      assert_raise(ArgumentError) {@layout.utc_offset = "06:00"}
+
+      @layout.utc_offset   = nil
+      ::Logging.utc_offset = "UTC"
+      assert_nil @layout.utc_offset
+
+      layout = ::Logging::Layout.new
+      assert_equal 0, layout.utc_offset
+    end
+
+    def test_apply_utc_offset
+      time = Time.now.freeze
+
+      offset_time = @layout.apply_utc_offset(time)
+      assert_same time, offset_time
+
+      @layout.utc_offset = "UTC"
+      offset_time = @layout.apply_utc_offset(time)
+      assert_not_same time, offset_time
+      assert offset_time.utc?
+
+      @layout.utc_offset = "+01:00"
+      offset_time = @layout.apply_utc_offset(time)
+      assert_not_same time, offset_time
+      assert !offset_time.utc?
+      assert_equal 3600, offset_time.utc_offset
+    end
   end  # class TestLayout
 end  # module TestLogging
 

data/test/test_log_event.rb

@@ -34,6 +34,14 @@ module TestLogging
       assert_match %r/test_log_event.rb\z/, @appender.event.file
     end
 
+    def test_file_with_basepath
+      ::Logging.basepath = File.expand_path("../../", __FILE__)
+
+      @logger.caller_tracing = true
+      @logger.warn "warning message"
+      assert_equal "test/test_log_event.rb", @appender.event.file
+    end
+
     def test_level
       assert_equal 1, @event.level
     end
@@ -60,12 +68,12 @@ module TestLogging
       assert_equal 'MyLogger', @event.logger
     end
 
-    def test_method
+    def test_method_name
       assert_equal '', @event.file
 
       @logger.caller_tracing = true
       @logger.debug 'debug message'
-      assert_equal 'test_method', @appender.event.method
+      assert_equal 'test_method_name', @appender.event.method_name
     end
 
   end  # class TestLogEvent

data/test/test_logger.rb

@@ -33,6 +33,16 @@ module TestLogging
       assert_nil a1.readline
       assert_nil a2.readline
 
+      log.add(1) { "block style message" }
+      assert_equal " INFO  A Logger : block style message\n", a1.readline
+      assert_nil a1.readline
+      assert_nil a2.readline
+
+      log.add(1, nil, 'this should be logged (when used by Rails.logger.extend(ActiveSupport::Logger.broadcast())')
+      assert_equal " INFO  A Logger : this should be logged (when used by Rails.logger.extend(ActiveSupport::Logger.broadcast())\n", a1.readline
+      assert_nil a1.readline
+      assert_nil a2.readline
+
       log.add(2,[1,2,3,4])
       assert_equal " WARN  A Logger : <Array> #{[1,2,3,4]}\n", a1.readline
       assert_nil a1.readline
@@ -76,6 +86,10 @@ module TestLogging
       assert_nil a2.readline
     end
 
+    def test_add_block
+
+    end
+
     def test_add_appenders
       log = ::Logging::Logger.new 'A'
 
@@ -251,11 +265,14 @@ module TestLogging
       assert_nil a2.readline
     end
 
-    def test_inspect
+    def test_inspect_matches_default
       root = ::Logging::Logger.new :root
 
-      str = "<#{root.class.name}:0x%x name=\"#{root.name}\">" % root.object_id
-      assert_equal str, root.inspect
+      # `to_s` triggers the default inspect behavior
+      expected = root.to_s.match(/0x[a-f\d]+/)[0]
+      actual = root.inspect.match(/0x[a-f\d]+/)[0]
+
+      assert_equal expected, actual
     end
 
     def test_level

data/test/test_logging.rb

@@ -11,8 +11,8 @@ module TestLogging
       @levels = ::Logging::LEVELS
       @lnames = ::Logging::LNAMES
 
-      @fn = File.join(TMP, 'test.log')
-      @glob = File.join(TMP, '*.log')
+      @fn = File.join(@tmpdir, 'test.log')
+      @glob = File.join(@tmpdir, '*.log')
     end
 
     def test_backtrace
@@ -39,6 +39,52 @@ module TestLogging
       assert_raise(ArgumentError) {::Logging.backtrace 'foo'}
     end
 
+    def test_utc_offset
+      assert_nil ::Logging.utc_offset
+
+      ::Logging.utc_offset = 0
+      assert_equal 0, ::Logging.utc_offset
+
+      ::Logging.utc_offset = "UTC"
+      assert_equal 0, ::Logging.utc_offset
+
+      ::Logging.utc_offset = "+01:00"
+      assert_equal "+01:00", ::Logging.utc_offset
+
+      assert_raise(ArgumentError) {::Logging.utc_offset = "06:00"}
+    end
+
+    def test_cause_depth
+      assert_equal ::Logging::DEFAULT_CAUSE_DEPTH, ::Logging.cause_depth
+
+      ::Logging.cause_depth = 0
+      assert_equal 0, ::Logging.cause_depth
+
+      ::Logging.cause_depth = nil
+      assert_equal ::Logging::DEFAULT_CAUSE_DEPTH, ::Logging.cause_depth
+
+      ::Logging.cause_depth = "1024"
+      assert_equal 1024, ::Logging.cause_depth
+
+      ::Logging.cause_depth = -1
+      assert_equal ::Logging::DEFAULT_CAUSE_DEPTH, ::Logging.cause_depth
+
+      assert_raise(ArgumentError) {::Logging.cause_depth = "foo"}
+    end
+
+    def test_basepath
+      assert_nil ::Logging.basepath
+
+      ::Logging.basepath = ""
+      assert_nil ::Logging.basepath
+
+      ::Logging.basepath = "./"
+      assert_equal File.expand_path("../../", __FILE__), ::Logging.basepath
+
+      ::Logging.reset
+      assert_nil ::Logging.basepath
+    end
+
     def test_logger
       assert_raise(TypeError) {::Logging.logger []}
 
@@ -207,6 +253,31 @@ module TestLogging
       assert_match %r/\d+\.\d+\.\d+/, ::Logging.version
     end
 
-  end  # class TestLogging
-end  # module TestLogging
+    class Failer
+      class WriteError < StandardError ; end
+      def self.write(*args)
+        raise WriteError.new("Oh noooooo")
+      end
+    end
 
+    def test_error_handling
+      logger = ::Logging.logger Failer, 2, 100
+      logger.appenders.first.level = :debug
+
+      # No errors are raised by default
+      logger.fatal 'this is a debug message'
+      # Always reset the level; we disable appenders that raise by setting them
+      # to :off
+      logger.appenders.first.level = :debug
+
+      begin
+        Logging.raise_errors = true
+        assert_raises Failer::WriteError do
+          logger.fatal 'this fails because the file descriptor is closed'
+        end
+      ensure
+        Logging.raise_errors = false
+      end
+    end
+  end
+end

data/test/test_mapped_diagnostic_context.rb

@@ -105,12 +105,21 @@ module TestLogging
 
         assert_not_equal context.object_id, Logging.mdc.context.object_id
 
-        assert_equal 1, Logging.mdc['foo']
-        assert_equal 'buz', Logging.mdc['baz']
-        assert_equal 'something else', Logging.mdc['foobar']
-        assert_nil Logging.mdc['unique']
-
-        assert_equal 1, Logging.mdc.stack.length
+        if Logging::INHERIT_CONTEXT
+          assert_equal 1, Logging.mdc['foo']
+          assert_equal 'buz', Logging.mdc['baz']
+          assert_equal 'something else', Logging.mdc['foobar']
+          assert_nil Logging.mdc['unique']
+
+          assert_equal 1, Logging.mdc.stack.length
+        else
+          assert_nil Logging.mdc['foo']
+          assert_nil Logging.mdc['baz']
+          assert_nil Logging.mdc['foobar']
+          assert_nil Logging.mdc['unique']
+
+          assert_equal 1, Logging.mdc.stack.length
+        end
       }
 
       Thread.pass until t.status == 'sleep'

data/test/test_nested_diagnostic_context.rb

@@ -85,7 +85,12 @@ module TestLogging
         sleep
 
         assert_not_equal ary.object_id, Logging.ndc.context.object_id
-        assert_equal %w[first second], Logging.ndc.context
+
+        if Logging::INHERIT_CONTEXT
+          assert_equal %w[first second], Logging.ndc.context
+        else
+          assert_empty Logging.ndc.context
+        end
       }
 
       Thread.pass until t.status == 'sleep'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logging
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Tim Pease
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-29 00:00:00.000000000 Z
+date: 2020-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: little-plugger
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: flexmock
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: bones-git
   requirement: !ruby/object:Gem::Requirement
@@ -72,16 +72,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: 3.8.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: 3.8.4
 description: |-
-  Logging is a flexible logging library for use in Ruby programs based on the
+  **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.
@@ -94,6 +94,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - History.txt
+- LICENSE
 - README.md
 - Rakefile
 - examples/appenders.rb
@@ -108,6 +109,8 @@ files:
 - examples/loggers.rb
 - examples/mdc.rb
 - examples/names.rb
+- examples/rails4.rb
+- examples/reusing_layouts.rb
 - examples/rspec_integration.rb
 - examples/simple.rb
 - lib/logging.rb
@@ -142,11 +145,12 @@ files:
 - lib/spec/logging_helper.rb
 - logging.gemspec
 - script/bootstrap
+- script/console
+- test/appenders/test_async_flushing.rb
 - test/appenders/test_buffered_io.rb
 - test/appenders/test_console.rb
 - test/appenders/test_file.rb
 - test/appenders/test_io.rb
-- test/appenders/test_periodic_flushing.rb
 - test/appenders/test_rolling_file.rb
 - test/appenders/test_string_io.rb
 - test/appenders/test_syslog.rb
@@ -154,8 +158,10 @@ files:
 - test/layouts/test_basic.rb
 - test/layouts/test_color_pattern.rb
 - test/layouts/test_json.rb
+- test/layouts/test_nested_exceptions.rb
 - test/layouts/test_pattern.rb
 - test/layouts/test_yaml.rb
+- test/performance.rb
 - test/setup.rb
 - test/test_appender.rb
 - test/test_color_scheme.rb
@@ -173,7 +179,7 @@ files:
 homepage: http://rubygems.org/gems/logging
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -190,23 +196,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: logging
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.1
+signing_key:
 specification_version: 4
 summary: A flexible and extendable logging library for Ruby
 test_files:
+- test/appenders/test_async_flushing.rb
 - test/appenders/test_buffered_io.rb
 - test/appenders/test_console.rb
 - test/appenders/test_file.rb
 - test/appenders/test_io.rb
-- test/appenders/test_periodic_flushing.rb
 - test/appenders/test_rolling_file.rb
 - test/appenders/test_string_io.rb
 - test/appenders/test_syslog.rb
 - test/layouts/test_basic.rb
 - test/layouts/test_color_pattern.rb
 - test/layouts/test_json.rb
+- test/layouts/test_nested_exceptions.rb
 - test/layouts/test_pattern.rb
 - test/layouts/test_yaml.rb
 - test/test_appender.rb