lenjador 1.2.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0b22b9348f98f915eaa67dec7cbbe762d09f86dc
-  data.tar.gz: 2e22ff6de0251d2e007b83e626e14c20d860b281
+SHA256:
+  metadata.gz: 5d96edbeff69ee13444e45a5924d8fedd4907725831f9ce62fd2f3280b48b244
+  data.tar.gz: b7e501d6a7dba6b7461df12e72530796900a4241700dd676c48d6e6f8341e0b2
 SHA512:
-  metadata.gz: e48ff7741f76c07e5dd00e910e32cd6013ee4ff6854ccfc29bf4dc249e54635500c4ff5fedd51ac7394a643baa4a6e1a60269b41b9c5fb2006110fefe45f13af
-  data.tar.gz: 0cd79d4f685890c86d4c0c182f256f35c0dbe48a95b77a548193cbec05f21a8df5ce551c1fd77fe5a9a751a5a9491b04c24e78392c9bb7ae7fa92ea2f272ae29
+  metadata.gz: b1142e4a26fb13f3ba2d880de8c3b58e18eacc77de055d36b10c3a9783c6c1d597a50aab94f1611a43fc17f8490f6598049da6f5d4c9ed73af77be2fa5ccb26e
+  data.tar.gz: 6f6d29354c80eae57485fc2f3fa5f6e0643aad692763957ab43c8ba3041a8f5d9cbba6fb3e9453a121c6634d5e7e776d82df0286a966b97613d03c437b602827

data/.rubocop.yml

@@ -0,0 +1,41 @@
+inherit_gem:
+  rubocop-salemove: config/default.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/FrozenStringLiteralComment:
+  Enabled: yes
+  EnforcedStyle: always
+  Include:
+    - 'lib/**/*'
+
+Metrics/MethodLength:
+  Enabled: no
+
+Style/GuardClause:
+  Enabled: no
+
+RSpec/VerifiedDoubles:
+  Enabled: no
+
+Metrics/BlockLength:
+  Enabled: no
+
+RSpec/MessageSpies:
+  Enabled: no
+
+RSpec/ExpectOutput:
+  Enabled: no
+
+RSpec/ExampleLength:
+  Enabled: no
+
+RSpec/MultipleExpectations:
+  Enabled: no
+
+Style/SafeNavigation:
+  Enabled: no
+
+Style/SingleLineMethods:
+  Enabled: no

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.1
+ruby-2.7.1

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
   - 2.4
   - 2.5
-  - jruby
+  - 2.7

data/Gemfile

@@ -1,8 +1,3 @@
-source "https://rubygems.org"
-
-group :test, :development do
-  gem 'pry'
-  gem 'rspec'
-end
+source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,7 +1,9 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
 
-require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
-task ci: :spec
-task default: :spec
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/benchmark/whitelisting.rb

@@ -21,20 +21,20 @@ pointers = %w[
     end
 
     x.report("Flat hash whitelisting (action=#{action})") do
-      preprocessor.process(flat_hash: { scalar: 'value', array: [1, 2], hash: {} })
+      preprocessor.process(flat_hash: {scalar: 'value', array: [1, 2], hash: {}})
     end
 
     x.report("Nested hash whitelisting (action=#{action})") do
       preprocessor.process(
         nested_hash: {
           next_level_hash: {
-            deep_hash: { scalar: 'value', array: [1, 2] }
+            deep_hash: {scalar: 'value', array: [1, 2]}
           },
           next_level_hash2: {
-            deep_hash: { scalar: 'value', array: [1, 2] }
+            deep_hash: {scalar: 'value', array: [1, 2]}
           },
           next_level_hash3: {
-            deep_hash: { scalar: 'value', array: [1, 2] }
+            deep_hash: {scalar: 'value', array: [1, 2]}
           }
         }
       )
@@ -43,9 +43,9 @@ pointers = %w[
     x.report("Flat array whitelisting (action=#{action})") do
       preprocessor.process(
         nested_array: [
-          { deep_array: [1, 2, 3] },
-          { deep_array: [1, 2, 3] },
-          { deep_array: [1, 2, 3] }
+          {deep_array: [1, 2, 3]},
+          {deep_array: [1, 2, 3]},
+          {deep_array: [1, 2, 3]}
         ]
       )
     end

data/lenjador.gemspec

@@ -1,36 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
-  if RUBY_PLATFORM =~ /java/
-    gem.name = 'lenjador-jruby'
-  else
-    gem.name = 'lenjador'
-  end
-
-  gem.version       = '1.2.1'
-  gem.authors       = ["Salemove"]
-  gem.email         = ["support@salemove.com"]
-  gem.description   = %q{It's lenjadoric}
-  gem.summary       = %q{What description said}
-  gem.license       = "MIT"
+  gem.name          = 'lenjador'
+  gem.version       = '2.1.0'
+  gem.authors       = ['Salemove']
+  gem.email         = ['support@salemove.com']
+  gem.description   = "It's lenjadoric"
+  gem.summary       = 'What description said'
+  gem.license       = 'MIT'
+  gem.required_ruby_version = '>= 2.4'
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
   gem.add_dependency 'lru_redux'
+  gem.add_dependency 'oj', '~> 3.6'
 
-  if RUBY_PLATFORM =~ /java/
-    gem.add_dependency 'jrjackson'
-  else
-    gem.add_dependency 'oj'
-  end
-
-  gem.add_development_dependency "bundler", "~> 1.3"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "bunny"
-  gem.add_development_dependency "benchmark-ips"
+  gem.add_development_dependency 'benchmark-ips'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rubocop-salemove'
+  gem.add_development_dependency 'ruby-prof'
 end

data/lib/lenjador.rb

@@ -1,63 +1,78 @@
+# frozen_string_literal: true
+
 require 'logger'
 require_relative 'lenjador/adapters'
 require_relative 'lenjador/utils'
 require_relative 'lenjador/null_logger'
 require_relative 'lenjador/preprocessors'
 
-LOG_LEVEL_QUERY_METHODS = [:debug?, :info?, :warn?, :error?, :fatal?]
-
 class Lenjador
-  def self.build(service_name, loggers_config, preprocessors_config = {})
-    loggers_config ||= {stdout: nil}
+  Severity = ::Logger::Severity
+  SEV_LABEL = %w[debug info warn error fatal any].freeze
+
+  def self.build(service_name, logger_config, preprocessors_config = {})
+    logger_config ||= {}
+
     preprocessors = preprocessors_config.map do |type, arguments|
       Preprocessors.get(type.to_s, arguments || {})
     end
-    adapters = loggers_config.map do |type, arguments|
-      Adapters.get(type.to_s, service_name, arguments || {})
-    end
-    new(adapters, preprocessors)
+    adapter = Adapters.get(service_name, logger_config)
+    level = SEV_LABEL.index(logger_config.fetch(:level, 'debug'))
+
+    new(adapter, level, preprocessors)
   end
 
-  def initialize(adapters, preprocessors)
-    @adapters = adapters
+  def initialize(adapter, level, preprocessors)
+    @adapter = adapter
+    @level = level
     @preprocessors = preprocessors
   end
 
   def debug(*args, &block)
-    log :debug, *args, &block
+    log(Severity::DEBUG, *args, &block)
   end
 
   def info(*args, &block)
-    log :info, *args, &block
+    log(Severity::INFO, *args, &block)
   end
 
   def warn(*args, &block)
-    log :warn, *args, &block
+    log(Severity::WARN, *args, &block)
   end
 
   def error(*args, &block)
-    log :error, *args, &block
+    log(Severity::ERROR, *args, &block)
   end
 
   def fatal(*args, &block)
-    log :fatal, *args, &block
+    log(Severity::FATAL, *args, &block)
   end
 
-  LOG_LEVEL_QUERY_METHODS.each do |method|
-    define_method(method) do
-      @adapters.any? {|adapter| adapter.public_send(method) }
-    end
+  def debug?; @level <= Severity::DEBUG; end
+
+  def info?; @level <= Severity::INFO; end
+
+  def warn?; @level <= Severity::WARN; end
+
+  def error?; @level <= Severity::ERROR; end
+
+  def fatal?; @level <= Severity::FATAL; end
+
+  def level=(new_level)
+    raise ArgumentError, "invalid log level: #{new_level}" unless new_level.is_a?(Integer)
+
+    @level = new_level
   end
 
   private
 
   def log(level, *args, &block)
+    return true if level < @level
+
     data = parse_log_data(*args, &block)
     processed_data = preprocess(data)
 
-    @adapters.each do |adapter|
-      adapter.log(level, processed_data)
-    end
+    @adapter.log(level, processed_data)
   end
 
   def preprocess(data)
@@ -69,6 +84,6 @@ class Lenjador
   def parse_log_data(message = nil, metadata = {}, &block)
     return message if message.is_a?(Hash)
 
-    (metadata || {}).merge(message: block ? block.call : message)
+    (metadata || {}).merge(message: block ? yield : message)
   end
 end

data/lib/lenjador/adapters.rb

@@ -1,22 +1,17 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Adapters
-    LOG_LEVELS = %w(debug info warn error fatal unknown).freeze
-
-    def self.get(type, service_name, arguments)
+    def self.get(service_name, config)
       adapter =
-        if type == 'stdout'
-          if arguments.fetch(:json, false)
-            require_relative 'adapters/stdout_json_adapter'
-            StdoutJsonAdapter
-          else
-            require_relative 'adapters/stdout_adapter'
-            StdoutAdapter
-          end
+        if config.fetch(:json, false)
+          require_relative 'adapters/stdout_json_adapter'
+          StdoutJsonAdapter
         else
-          raise "Unsupported logger: #{type}"
+          require_relative 'adapters/stdout_adapter'
+          StdoutAdapter
         end
-      level = LOG_LEVELS.index(arguments.fetch(:level, 'debug'))
-      adapter.new(level, service_name, arguments)
+      adapter.new(service_name)
     end
   end
 end

data/lib/lenjador/adapters/stdout_adapter.rb

@@ -1,28 +1,25 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 class Lenjador
   module Adapters
     class StdoutAdapter
-      extend Forwardable
-
       attr_reader :logger
 
-      def_delegators :@logger, :debug?, :info?, :warn?, :error?, :fatal?
-
-      def initialize(level, *)
-        @logger = Logger.new(STDOUT)
-        @logger.level = level
+      def initialize(_service_name)
+        @logger = Logger.new($stdout)
       end
 
       def log(level, metadata = {})
         message = metadata[:message]
-        data = metadata.select { |key, value| key != :message }
+        data = metadata.reject { |key, _value| key == :message }
         log_data = [
           message,
           data.empty? ? nil : Utils.generate_json(data)
         ].compact.join(' ')
 
-        @logger.public_send level, log_data
+        @logger.add(level, log_data)
       end
     end
   end

data/lib/lenjador/adapters/stdout_json_adapter.rb

@@ -1,58 +1,32 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Adapters
     class StdoutJsonAdapter
-      def initialize(level, service_name, *)
-        @level = level
-        @service_name = service_name
+      def initialize(service_name)
         @application_name = Utils.application_name(service_name)
-        @mutex = Mutex.new if RUBY_ENGINE == "jruby"
+        @mutex = Mutex.new if RUBY_ENGINE == 'jruby'
       end
 
       def log(level, metadata = {})
-        if meets_threshold?(level)
-          message = Utils.build_event(metadata, level, @application_name)
-          print_line(Utils.generate_json(message))
-        end
-      end
-
-      def debug?
-        meets_threshold?(:debug)
-      end
-
-      def info?
-        meets_threshold?(:info)
-      end
-
-      def warn?
-        meets_threshold?(:warn)
-      end
-
-      def error?
-        meets_threshold?(:error)
-      end
-
-      def fatal?
-        meets_threshold?(:fatal)
+        message = Utils.build_event(metadata, Lenjador::SEV_LABEL[level], @application_name)
+        print_line(Utils.generate_json(message))
       end
 
       private
 
-      def meets_threshold?(level)
-        LOG_LEVELS.index(level.to_s) >= @level
-      end
-
       # puts is atomic in MRI starting from 2.5.0
-      if RUBY_ENGINE == "ruby" && RUBY_VERSION >= "2.5.0"
+      if RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '2.5.0'
         def print_line(str)
           $stdout.puts(str)
         end
-      elsif RUBY_ENGINE == "jruby"
+      elsif RUBY_ENGINE == 'jruby'
         def print_line(str)
-          @mutex.synchronize { $stdout.write(str + "\n") }
+          @mutex.synchronize { $stdout.write("#{str}\n") }
         end
       else
         def print_line(str)
-          $stdout.write(str + "\n")
+          $stdout.write("#{str}\n")
         end
       end
     end

data/lib/lenjador/null_logger.rb

@@ -1,18 +1,15 @@
+# frozen_string_literal: true
+
 class Lenjador
   class NullLogger
-    def debug(*)
-    end
+    def debug(*); end
 
-    def info(*)
-    end
+    def info(*); end
 
-    def warn(*)
-    end
+    def warn(*); end
 
-    def error(*)
-    end
+    def error(*); end
 
-    def fatal(*)
-    end
+    def fatal(*); end
   end
 end