log4jruby 3.0.0.rc1-java → 3.0.0.rc2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63ae3e7cb5a390af7767e58ce30270c32cc3c770ba877ce0932627e3efab1607
-  data.tar.gz: d80186abc03df7b0a2b10befcdda3084eef5cffeb4e1960ce957930d6be1e850
+  metadata.gz: a1668efce6b23c33b459992956795614d50f3178ed3c2787e7651f1715b60235
+  data.tar.gz: ba8e28cc7b8dbc9531ccec0cb34b7642ab8beacc37eee8be0cd7df2abb5f661e
 SHA512:
-  metadata.gz: bbc3e978c3d27fe325b135ff988b063f928daadec1a3608d8cfd891766ab2eefa3e0dc08c60ae3dae9835760236fbcb6e84152bcc2cef8faebfb7d8f2b407bf9
-  data.tar.gz: 61d52687aa0b3d1658fb29c0c543e0e7ba45789799ebaabc640fa4f2570ea1d395972c856118bfb2e34e45d3c4780dd3e1e45285c609ae7c8c26455a4a9595ad
+  metadata.gz: 36c6cbd7bae1b08f33156a3ef73b3e93f00a174bc0e32b2949b5cfff6424a81c3ac12a766a889f618f308fc55fd4f942b3778f4129b3739c4140a4170c4e23a4
+  data.tar.gz: 1763996d46b5e5836c911c6061068245464a952c59ba94f890549ea56bf19b97b322a1112471ecb00e21bffc410c78b0e34e2073c0cbbec2ba53ec629ade2310

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # log4jruby Changelog
 
+## v3.0.0.rc2
+
+* Restored support for JRuby 9.1.x/Ruby 2.3
+
 ## v3.0.0.rc1
 
 * JRuby 9.3.x/Ruby 2.6 support - Ruby >= 2.6.8 now required

data/README.md

@@ -151,6 +151,10 @@ The default Log4jruby formatter outputs `progname` and `msg` only (as opposed to
 Severity, timestamp, and backtraces are handed according to your `Log4j` configuration. 
 E.g. [PatternLayout](https://logging.apache.org/log4j/2.x/manual/layouts.html).
 
+* For JRuby versions < 9.3, Ruby exceptions are not passed directly to the `Throwable` arg of log4j. Instead,
+  backtraces are included in the log message by the default formatter. This means that `%throwable` in
+  the log4j config will not affect ruby exceptions for Jruby < 9.3.
+
 The output of the `formatter` is passed as the `message` parameter of the [Log4j log methods](https://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Category.html#log(org.apache.log4j.Priority,%20java.lang.Object).
 
 ## Development

data/lib/log4jruby/logger.rb

@@ -4,6 +4,10 @@ require 'log4jruby/support/log4j_args'
 require 'log4jruby/support/levels'
 require 'log4jruby/support/location'
 require 'log4jruby/support/log_manager'
+require 'log4jruby/support/formatter'
+require 'log4jruby/support/legacy_shim_formatter'
+require 'log4jruby/support/jruby_version'
+
 require 'logger'
 
 module Log4jruby
@@ -121,7 +125,7 @@ module Log4jruby
       return @formatter if defined?(@formatter)
 
       @formatter = if self == Logger.root
-                     ->(_severity, _datetime, progname, msg) { "-- #{progname}: #{msg}" }
+                     new_default_formatter
                    else
                      parent.formatter
                    end
@@ -167,5 +171,13 @@ module Log4jruby
         @log4j_logger.send(level, msg, throwable)
       end
     end
+
+    def new_default_formatter
+      if Support::JrubyVersion.native_ruby_stacktraces_supported?
+        Support::Formatter.new
+      else
+        Support::LegacyShimFormatter.new
+      end
+    end
   end
 end

data/lib/log4jruby/support/formatter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Log4jruby
+  module Support
+    # Default ruby Logger formatter
+    # This formatter mimics
+    # [Logger::Formatter](https://ruby-doc.org/stdlib-2.6.4/libdoc/logger/rdoc/Logger/Formatter.html)
+    # but excludes log level and timestamp to leave it for the Log4j config
+    class Formatter
+      def call(_severity, _time, progname, msg)
+        "-- #{progname}: #{msg}"
+      end
+    end
+  end
+end

data/lib/log4jruby/support/jruby_version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Log4jruby
+  module Support
+    # Class for explicitly marking JRuby version specific code.
+    # Find consumers and remove this and references when no longer needed.
+    class JrubyVersion
+      class << self
+        def native_ruby_stacktraces_supported?
+          Gem::Version.new(JRUBY_VERSION) >= Gem::Version.new('9.3')
+        end
+      end
+    end
+  end
+end

data/lib/log4jruby/support/legacy_shim_formatter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Log4jruby
+  module Support
+    # Default ruby Logger formatter for Jruby < 9.3.x
+    # This formatter mimics
+    # [Logger::Formatter](https://ruby-doc.org/stdlib-2.6.4/libdoc/logger/rdoc/Logger/Formatter.html)
+    # but excludes log level and timestamp (delegated to Log4j).
+    # It also appends full backtraces with nested causes.
+    class LegacyShimFormatter
+      def call(_severity, _time, progname, msg)
+        "-- #{msg2str(progname)}: #{msg2str(msg)}"
+      end
+
+      private
+
+      def msg2str(msg)
+        case msg
+        when ::String
+          msg
+        when ::Exception
+          exception2str(msg)
+        else
+          msg.inspect
+        end
+      end
+
+      def exception2str(exception)
+        "#{exception.message} (#{exception.class})\n\t#{exception.backtrace&.join("\n\t")}" \
+          "#{"\nCaused by: #{exception2str(exception.cause)}" if exception.cause}"
+      end
+    end
+  end
+end

data/lib/log4jruby/support/log4j_args.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'log4jruby/support/jruby_version'
+
 module Log4jruby
   module Support
     # Translate logger args for use by Ruby Logger formatter and log4j.
@@ -37,7 +39,10 @@ module Log4jruby
         end
 
         def exception(obj)
-          obj.is_a?(::Exception) || obj.is_a?(Java::java.lang.Throwable) ? obj : nil
+          if (JrubyVersion.native_ruby_stacktraces_supported? && obj.is_a?(::Exception)) ||
+             obj.is_a?(Java::java.lang.Throwable)
+            obj
+          end
         end
       end
     end

data/lib/log4jruby/support/log_manager.rb

@@ -17,7 +17,7 @@ module Log4jruby
         end
 
         def get_or_create(name)
-          raise 'name required' if name.to_s.match?(/^\s+$/)
+          raise 'name required' if name.to_s.match(/^\s+$/)
 
           @mutex.synchronize do
             @loggers[name] ||= new_logger(name)

data/lib/log4jruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Log4jruby
-  VERSION = '3.0.0.rc1'
+  VERSION = '3.0.0.rc2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log4jruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc1
+  version: 3.0.0.rc2
 platform: java
 authors:
 - Lenny Marks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies: []
 description: Ruby Logger using Log4j, geared toward those who use JRuby to write Ruby
   code using/extending Java code. Ruby and Java are configured together using traditional
@@ -24,6 +24,9 @@ files:
 - lib/log4jruby.rb
 - lib/log4jruby/logger.rb
 - lib/log4jruby/logger_for_class.rb
+- lib/log4jruby/support/formatter.rb
+- lib/log4jruby/support/jruby_version.rb
+- lib/log4jruby/support/legacy_shim_formatter.rb
 - lib/log4jruby/support/levels.rb
 - lib/log4jruby/support/location.rb
 - lib/log4jruby/support/log4j_args.rb
@@ -40,9 +43,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.8
+      version: 2.3.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"