lorekeeper 2.0.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c3b19f169215f175bd0770ab165fb68203e9aed3e8bd0cb01102d7c758bb67
-  data.tar.gz: 6f9a9302433dec14b3a501b49bfd3610ad3904ab948d0c39390af539f55b3a7e
+  metadata.gz: 614a3b1372eba2d9fe6a56964d25f9048d2b6dde65ac3e135c023cff6af42b99
+  data.tar.gz: 45a541d7ccfb5f4aae3f0912dfdb69c19eb1dbca1aef86f4d1f33457df7886ec
 SHA512:
-  metadata.gz: 62de8ba1553a553cc212bbb3d8a84e2fc8bb98902c3867dfebda2fe7e7f41a716b60d0be81cd281210fef9041972a40757ec9aed724dc468fa775471b62637dc
-  data.tar.gz: '0186d14f8511e2aa0489dba5a98794477e1c7f9f7220af7a3f884947084a0c5d60195d434ed4b406fd3bf252ee5a4a9b3aac3b3a89f6fc832f01c1ddf31fd305'
+  metadata.gz: 1712e531beb4c0d47853c9128ee732bca5a7c21a016418ead6f812923c33207ec3d86543f7e9e69355344d3cdc4f5720f40be17e0563da798cacd8472fdf7725
+  data.tar.gz: 87ab1d4ae3df8fb09fa148f2d64cf2d87ebf7ab9423dcee06480a0a620f5ce2ec66d483d7a8f42243b0a41fed9c7c1d70670a490f632fc52d0c9fb65cc962fdb

data/.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1']
+        ruby-version: ['2.7', '3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,2 +1,6 @@
 Metrics/LineLength:
   Max: 120
+# https://github.com/rubocop/rubocop/blob/20990ed3831589c0d9f202107b1b580ead8ef2c5/lib/rubocop/cop/style/single_line_methods.rb#L11
+# TODO: add "EnforcedStyle: allow_single_line" once all rubys are > 3.0 to autocorrect all single-line methods to endless
+Style/SingleLineMethods:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 2.2.1
+* Fix MultiLogger to not raise NoMethodError
+
+# 2.2.0
+* Remove metaprogramming from MultiLogger
+* Drop support for Ruby < 2.7.0
+
+# 2.1.0
+* Modify SimpleLogger to properly log exceptions with named parameters
+
 # 2.0.0
 * Set `mode: :compat` in Oj.dump to stringify keys
 * Support Ruby 3.1

data/lib/lorekeeper/fast_logger.rb

@@ -56,7 +56,7 @@ module Lorekeeper
     # This is part of the standard Logger API, we need this to be compatible
     def add(severity, message_param = nil, progname = nil, &block)
       return true if severity < @level
-      message = message_param || (block && block.call) || progname
+      message = (block && block.call) || message_param || progname
       log_data(severity, message.freeze)
     end
 

data/lib/lorekeeper/json_logger.rb

@@ -8,7 +8,7 @@ module Lorekeeper
   class JSONLogger < FastLogger
     def initialize(file)
       reset_state
-      @base_fields = { MESSAGE => '', TIMESTAMP => '', LEVEL => '' }
+      @base_fields = { TIMESTAMP => '', MESSAGE => '', LEVEL => '' }
       @backtrace_cleaner = set_backtrace_cleaner
       super(file)
     end

data/lib/lorekeeper/multi_logger.rb

@@ -16,17 +16,34 @@ module Lorekeeper
       "Lorekeeper multilogger, loggers: #{@loggers.map(&:inspect)}"
     end
 
-if RUBY_VERSION > "2.6"
-    def respond_to?(method, all_included = false)
+    # Define all common logging methods within Multilogger to avoid NoMethodError
+    def debug(*args, &block); call_loggers(:debug, *args, &block); end
+
+    def debug_with_data(*args, &block); call_loggers(:debug, *args, &block); end
+
+    def info(*args, &block); call_loggers(:info, *args, &block); end
+
+    def info_with_data(*args, &block); call_loggers(:info, *args, &block); end
+
+    def warn(*args, &block); call_loggers(:warn, *args, &block); end
+
+    def warn_with_data(*args, &block); call_loggers(:warn, *args, &block); end
+
+    def error(*args, &block); call_loggers(:error, *args, &block); end
+
+    def error_with_data(*args, &block); call_loggers(:error, *args, &block); end
+
+    def fatal(*args, &block); call_loggers(:fatal, *args, &block); end
+
+    def fatal_with_data(*args, &block); call_loggers(:fatal, *args, &block); end
+
+    def write(*args); call_loggers(:write, *args); end
+
+    def respond_to?(method, all_included: false)
       @loggers.all? { |logger| logger.respond_to?(method, all_included) }
     end
-else
-    def respond_to?(method)
-      @loggers.all? { |logger| logger.respond_to?(method) }
-    end
-end
 
-    def method_missing(method, *args, &block)
+    def call_loggers(method, *args, &block)
       result = @loggers.map do |logger|
         logger.public_send(method, *args, &block) if logger.respond_to?(method)
       end
@@ -34,5 +51,9 @@ end
       # Then hope for the best taking the first value
       result.compact.uniq.first
     end
+
+    def method_missing(method, *args, &block)
+      call_loggers(method, *args, &block)
+    end
   end
 end

data/lib/lorekeeper/simple_logger.rb

@@ -28,7 +28,7 @@ module Lorekeeper
     # \e[colorm sets a color \e[0m resets all properties
     def log_data(severity, message)
       color = SEVERITY_TO_COLOR_MAP[severity]
-      @iodevice.write("\e[#{color}m#{message}\e[0m\n")
+      @iodevice.write("\e[#{color}m#{message.gsub('\n', "\n").gsub('\t', "\t")}\e[0m\n")
     end
 
     def inspect
@@ -43,16 +43,31 @@ module Lorekeeper
       end
     end
 
-    def exception(exception, custom_message = nil, custom_data = nil, level = :error)
-      log_level = METHOD_SEVERITY_MAP[level] || ERROR
+    # To not raise NoMethodError for the methods defined in JSONLogger
+    def current_fields(*); end
+    def state(*); end
+    def add_thread_unsafe_fields(*); end
+    def remove_thread_unsafe_fields(*); end
+    def add_fields(*); end
+    def remove_fields(*); end
+
+    def exception(exception, custom_message = nil, custom_data = nil, custom_level = :error,
+                             message: nil, data: nil, level: nil)
+
+      param_level = level || custom_level
+      param_data = data || custom_data
+      param_message = message || custom_message
+
+      log_level = METHOD_SEVERITY_MAP[param_level] || ERROR
 
       if exception.is_a?(Exception)
-        backtrace = exception.backtrace || []
-        message = custom_message || exception.message
-        log_data(log_level, "#{exception.class}: #{exception.message}; #{message}, data: #{backtrace.join("\n")}")
+        message = param_message || exception.message
+        backtrace = "\n\nstack:\n#{exception.backtrace.join("\n")}" if exception.backtrace
+        data = "\n\ndata:\n#{param_data}" if param_data
+        log_data(log_level, "#{exception.class}: #{exception.message}; #{message} #{backtrace} #{data}")
       else
         log_data(METHOD_SEVERITY_MAP[:warn], 'Logger exception called without exception class.')
-        error_with_data("#{exception.class}: #{exception.inspect} #{custom_message}", custom_data)
+        error_with_data("#{exception.class}: #{exception.inspect} #{param_message}", param_data)
       end
     end
   end

data/lib/lorekeeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lorekeeper
-  VERSION = '2.0.0'
+  VERSION = '2.2.1'
 end

data/lorekeeper.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_dependency 'oj', '>= 3.12', '< 4.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Jordi Polo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -213,7 +213,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="