lorekeeper 1.12.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db3ae6a493b8fc903122557d5144db57633e3c72a881cb4bc88ad458d438f7dc
-  data.tar.gz: 69ba8f5fd5ea48d6325f27ae777c91e857e28c5f7e6093cef71aa427cfcb8266
+  metadata.gz: 94314cd2617d7cfc5478a07242e7b006aba90b8f0736e3760c0c143b6149a867
+  data.tar.gz: 6a959aa730667a1d39b3aeddfd36f0fd666dd5e2851401af157cba7a6db5b407
 SHA512:
-  metadata.gz: 5b3b703f5182598b73f0c86411b9a627060eed1e0c59ddd1b9507dd3e9f28b5c3239e2e48a59bdf42edc017fa5df1acb4ba8aee5f502f73f21ff6fcc1876c8b4
-  data.tar.gz: 8925f11071fbccff8ddca89066a473b9286c8aedd87f9b76c3f872388e83ead883f2b78fe3645e71753009535f9e7b2e09e0e3921b4f64883a86f49c3737da72
+  metadata.gz: 381adbf920503525d566c0c51127f0826feaf20eb644c3cfae82a63b8f601d8c8c7a61f4bcb536589656908fe08758ba2e0e21cfcf643b7bb3896b62dd5d6a01
+  data.tar.gz: c293f3b312e22b49632a3494f70e7593eff119024826c10d78ab127b9061c04cd2caac95f5511866f7bac8f65cc0cdb2fe90210d9cec352d11aafa799b0d481e

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']
+        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,15 @@
+# 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
+* Drop support for Ruby < 2.5.0
+
 # 1.12.0
 * Remove ZipkinTracer information from stacktrace output
 * Move CI to GitHub Actions

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
@@ -148,7 +148,7 @@ module Lorekeeper
       fields_to_log[TIMESTAMP] = Time.now.utc.strftime(DATE_FORMAT)
       fields_to_log[LEVEL] = SEVERITY_NAMES_MAP[severity]
 
-      @iodevice.write(Oj.dump(fields_to_log) << "\n")
+      @iodevice.write(Oj.dump(fields_to_log, mode: :compat, cache_keys: true, cache_str: 5) << "\n")
     end
   end
 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

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 = '1.12.0'
+  VERSION = '2.2.0'
 end

data/lorekeeper.gemspec

@@ -20,9 +20,9 @@ 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.4.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
-  spec.add_dependency 'oj', '>= 3.4', '< 4.0'
+  spec.add_dependency 'oj', '>= 3.12', '< 4.0'
 
   spec.add_development_dependency 'activesupport', '>= 4.0'
   spec.add_development_dependency 'bundler', '>= 1.16', '< 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jordi Polo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-28 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -213,7 +213,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="