lorekeeper 2.2.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 614a3b1372eba2d9fe6a56964d25f9048d2b6dde65ac3e135c023cff6af42b99
-  data.tar.gz: 45a541d7ccfb5f4aae3f0912dfdb69c19eb1dbca1aef86f4d1f33457df7886ec
+  metadata.gz: 53332589726c07831fc34d3d63b7517de62fd1a75c11d1cbf772b6088d125eed
+  data.tar.gz: 797d799f0268b110fe584ead9bdb9f9c3f779bca7d1e8d0fb75c796409a340c5
 SHA512:
-  metadata.gz: 1712e531beb4c0d47853c9128ee732bca5a7c21a016418ead6f812923c33207ec3d86543f7e9e69355344d3cdc4f5720f40be17e0563da798cacd8472fdf7725
-  data.tar.gz: 87ab1d4ae3df8fb09fa148f2d64cf2d87ebf7ab9423dcee06480a0a620f5ce2ec66d483d7a8f42243b0a41fed9c7c1d70670a490f632fc52d0c9fb65cc962fdb
+  metadata.gz: c773417845d13a54058bd01b1541a64fa9564bce845fec21efcd69fa23916a323da0c679d86e8950c7c7dea1fa7c4a18e02429f21b4d896c670d4bb952ade48e
+  data.tar.gz: f95030ee5fe64f4cecd0cd9b15217897324bf2ac6aca1daed1a20a8daea233c029412a6a021dddd8bcd7d75d94aee673aa531f35bc8a214b6c07a0e666fca377

data/.github/workflows/build.yml

@@ -23,6 +23,8 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run rubocop
+      run: bundle exec rubocop
     - name: Run tests
       run: bundle exec rspec
     - name: Run benchmark

data/.rubocop.yml

@@ -1,6 +1,42 @@
-Metrics/LineLength:
-  Max: 120
-# https://github.com/rubocop/rubocop/blob/20990ed3831589c0d9f202107b1b580ead8ef2c5/lib/rubocop/cop/style/single_line_methods.rb#L11
+require:
+  - rubocop-performance
+
+inherit_gem:
+  rubocop-mdsol: rubocop.yml
+
+AllCops:
+  Exclude:
+    - '*gemspec'
+  # NOTE: Excludes vendor from linting. Needed by GitHub Actions.
+  # - https://github.com/rubocop/rubocop/issues/9832#issuecomment-873398952
+  #
+    - 'vendor/bundle/**/*'
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
 # TODO: add "EnforcedStyle: allow_single_line" once all rubys are > 3.0 to autocorrect all single-line methods to endless
+# https://github.com/rubocop/rubocop/blob/20990ed3831589c0d9f202107b1b580ead8ef2c5/lib/rubocop/cop/style/single_line_methods.rb#L11
+#
 Style/SingleLineMethods:
   Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2.3.2
+* Ensure additional fields are reset after logging
+* Let Oj fallback to :object mode for non-representable data
+* Fix SimpleLogger to handle non-String log messages
+* Run RuboCop checks on build and fix RuboCop offenses
+
+# 2.3.1
+* Fix MultiLogger to not raise ArgumentError
+
+# 2.3.0
+* Add `#write` method support to all loggers
+
 # 2.2.1
 * Fix MultiLogger to not raise NoMethodError
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in lorekeeper.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark'
 require 'tempfile'
 require 'securerandom'
@@ -5,7 +7,7 @@ require 'benchmark/ips'
 require 'byebug'
 require 'rbtrace'
 
-$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('lib', __dir__))
 $LOAD_PATH.uniq!
 
 require 'lorekeeper'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'lorekeeper'

data/lib/lorekeeper/fast_logger.rb

@@ -5,9 +5,9 @@ require 'logger'
 module Lorekeeper
   # Very simple, very fast logger
   class FastLogger
-    include ::Logger::Severity  # contains the levels constants: DEBUG, ERROR, etc.
-    attr_accessor :level        # Current level, default: DEBUG
-    attr_accessor :formatter    # Just for compatibility with Logger, not used
+    include ::Logger::Severity # contains the levels constants: DEBUG, ERROR, etc.
+    attr_accessor :level,      # Current level, default: DEBUG
+      :formatter   # Just for compatibility with Logger, not used
 
     def debug?; level <= DEBUG; end
     def info?; level <= INFO; end
@@ -21,12 +21,12 @@ module Lorekeeper
       @file = file # We only keep this so we can inspect where we are sending the logs
     end
 
-    LOGGING_METHODS = [
-      :debug,
-      :info,
-      :warn,
-      :error,
-      :fatal
+    LOGGING_METHODS = %i[
+      debug
+      info
+      warn
+      error
+      fatal
     ].freeze
 
     METHOD_SEVERITY_MAP = {
@@ -56,7 +56,8 @@ 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 = (block && block.call) || message_param || progname
+
+      message = block&.call || message_param || progname
       log_data(severity, message.freeze)
     end
 
@@ -65,20 +66,22 @@ module Lorekeeper
     # To avoid needing to monkey-patch Lorekeeper just to get this method, we are adding a simple
     # non-functional version here.
     def silence_logger(&block)
-      yield if block_given?
+      yield if block
     end
 
     # activerecord-session_store v2 is now simply calling silence instead of silence_logger
     def silence(&block)
-      yield if block_given?
+      yield if block
     end
 
     # inherited classes probably want to reimplement this
     def log_data(_severity, message)
-      @iodevice.write(message)
+      write(message)
     end
 
-    private
+    def write(message)
+      @iodevice.write(message)
+    end
 
     require 'monitor'
     # Mutex to avoid broken lines when multiple threads access the log file
@@ -106,11 +109,12 @@ module Lorekeeper
       def to_iodevice(file)
         return nil unless file
 
-        iodevice = if file.respond_to?(:write) && file.respond_to?(:close)
-          file
-        else
-          open_logfile(file)
-        end
+        iodevice =
+          if file.respond_to?(:write) && file.respond_to?(:close)
+            file
+          else
+            open_logfile(file)
+          end
 
         iodevice.sync = true if iodevice.respond_to?(:sync=)
         iodevice
@@ -128,5 +132,7 @@ module Lorekeeper
         open_logfile(filename)
       end
     end
+
+    private_constant :LogDeviceMutex, :LogDevice
   end
 end

data/lib/lorekeeper/json_logger.rb

@@ -28,13 +28,14 @@ module Lorekeeper
     # Delegates methods to the existing Logger instance
     # We are extending the logger API with methods error_with_data, etc
     LOGGING_METHODS.each do |method_name|
-      define_method "#{method_name}_with_data", ->(message_param = nil, data = {}, &block) do
+      define_method "#{method_name}_with_data", ->(message_param = nil, data = {}, &block) {
         return true if METHOD_SEVERITY_MAP[method_name] < @level
+
         extra_fields = { DATA => (data || {}) }
-        with_extra_fields(extra_fields) { # Using do/end here only valid on Ruby>= 2.3
+        with_extra_fields(extra_fields) do
           add(METHOD_SEVERITY_MAP[method_name], message_param, nil, &block)
-        }
-      end
+        end
+      }
     end
 
     def add_thread_unsafe_fields(fields)
@@ -65,7 +66,7 @@ module Lorekeeper
     # By default message comes from exception.message
     # Optional and named parameters to overwrite message, level and add data
     def exception(exception, custom_message = nil, custom_data = nil, custom_level = :error,
-                             message: nil, data: nil, level: nil) # Backwards compatible named params
+      message: nil, data: nil, level: nil) # Backwards compatible named params
 
       param_level = level || custom_level
       param_data = data || custom_data
@@ -94,8 +95,22 @@ module Lorekeeper
       "Lorekeeper JSON logger. IO: #{@file.inspect}"
     end
 
+    def write(message)
+      super(json_message(message) << "\n")
+    end
+
     private
 
+    def json_message(message)
+      Oj.dump(message, mode: :compat, cache_keys: true, cache_str: 5)
+    rescue JSON::GeneratorError
+      begin
+        Oj.dump(message)
+      rescue => e
+        Oj.dump(MESSAGE => e.message)
+      end
+    end
+
     # Some instrumentation libraries pollute the stacktrace and create a large output which may
     # cause problems with certain logging backends.
     # Hardcording newrelic, active_support/callbacks and zipkin-tracer now here.
@@ -126,12 +141,13 @@ module Lorekeeper
     def with_extra_fields(fields)
       state[:extra_fields] = fields
       yield
+    ensure
       state[:extra_fields] = {}
     end
 
     def remove_invalid_fields(fields)
       fields.delete_if do |_, v|
-        v.nil? || v.respond_to?(:empty?) && v.empty?
+        v.nil? || (v.respond_to?(:empty?) && v.empty?)
       end
     end
 
@@ -139,16 +155,16 @@ module Lorekeeper
       current_state = state # Accessing state is slow. Do it only once per call.
       # merging is slow, we do not want to merge with empty hash if possible
       fields_to_log = if current_state[:extra_fields].empty?
-        current_state[:base_fields]
-      else
-        current_state[:base_fields].merge(current_state[:extra_fields])
-      end
+                        current_state[:base_fields]
+                      else
+                        current_state[:base_fields].merge(current_state[:extra_fields])
+                      end
 
       fields_to_log[MESSAGE] = message
       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, mode: :compat, cache_keys: true, cache_str: 5) << "\n")
+      write(fields_to_log)
     end
   end
 end

data/lib/lorekeeper/multi_logger.rb

@@ -19,24 +19,14 @@ module Lorekeeper
     # 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)

data/lib/lorekeeper/simple_logger.rb

@@ -28,7 +28,8 @@ 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.gsub('\n', "\n").gsub('\t', "\t")}\e[0m\n")
+      message = message.to_s
+      write("\e[#{color}m#{message.gsub('\n', "\n").gsub('\t', "\t")}\e[0m\n")
     end
 
     def inspect
@@ -37,22 +38,28 @@ module Lorekeeper
 
     # Extending the logger API with methods error_with_data, etc
     LOGGING_METHODS.each do |method_name|
-      define_method "#{method_name}_with_data", ->(message_param = nil, data = {}, &block) do
+      define_method "#{method_name}_with_data", ->(message_param = nil, data = {}) {
         return true if METHOD_SEVERITY_MAP[method_name] < @level
+
         log_data(METHOD_SEVERITY_MAP[method_name], "#{message_param}, data: #{data}")
-      end
+      }
     end
 
     # 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)
+      message: nil, data: nil, level: nil)
 
       param_level = level || custom_level
       param_data = data || custom_data

data/lib/lorekeeper/version.rb

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

data/lorekeeper.gemspec

@@ -34,4 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rbtrace', '~> 0.4'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'mutant-rspec', '~> 0.8'
+  spec.add_development_dependency 'rubocop-mdsol', '~> 0.3'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.2
 platform: ruby
 authors:
 - Jordi Polo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -176,6 +176,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-mdsol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
 description: Opinionated logger which outputs messages in JSON format
 email:
 - mumismo@gmail.com