lenjador 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b22b9348f98f915eaa67dec7cbbe762d09f86dc
-  data.tar.gz: 2e22ff6de0251d2e007b83e626e14c20d860b281
+  metadata.gz: 10e0eaa5dd3548c6bfc7ff8c980e7e500ee4d297
+  data.tar.gz: c2dd081c02374b3144f3a7c77494c3f19b7ef464
 SHA512:
-  metadata.gz: e48ff7741f76c07e5dd00e910e32cd6013ee4ff6854ccfc29bf4dc249e54635500c4ff5fedd51ac7394a643baa4a6e1a60269b41b9c5fb2006110fefe45f13af
-  data.tar.gz: 0cd79d4f685890c86d4c0c182f256f35c0dbe48a95b77a548193cbec05f21a8df5ce551c1fd77fe5a9a751a5a9491b04c24e78392c9bb7ae7fa92ea2f272ae29
+  metadata.gz: d3766944053913a9345b4a8415f9de802c93de119affebd85fe43fe8696047ee656e586d84c6e0bf45cacdbcb376fafd443bea60c92728265f53c5bfa457daaa
+  data.tar.gz: e87536d2ccc0abf5176f474f782458877832b47335c30ae0d6f714bae688b10e934627446dc9d1a879a488c5e023585db1ba928575502ce2c962e9d19832c8cb

data/.rubocop.yml

@@ -0,0 +1,38 @@
+inherit_gem:
+  rubocop-salemove: config/default.yml
+
+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
+
+Performance/RegexpMatch:
+  Enabled: no

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5

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,25 +1,21 @@
-# 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          = RUBY_PLATFORM =~ /java/ ? 'lenjador-jruby' : 'lenjador'
+  gem.version       = '1.3.0'
+  gem.authors       = ['Salemove']
+  gem.email         = ['support@salemove.com']
+  gem.description   = "It's lenjadoric"
+  gem.summary       = 'What description said'
+  gem.license       = 'MIT'
 
-  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'
 
@@ -27,10 +23,13 @@ Gem::Specification.new do |gem|
     gem.add_dependency 'jrjackson'
   else
     gem.add_dependency 'oj'
+    gem.add_development_dependency 'ruby-prof'
   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', '~> 1.3'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rubocop-salemove'
 end

data/lib/lenjador.rb

@@ -1,10 +1,12 @@
+# 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?]
+LOG_LEVEL_QUERY_METHODS = %i[debug? info? warn? error? fatal?].freeze
 
 class Lenjador
   def self.build(service_name, loggers_config, preprocessors_config = {})
@@ -45,7 +47,7 @@ class Lenjador
 
   LOG_LEVEL_QUERY_METHODS.each do |method|
     define_method(method) do
-      @adapters.any? {|adapter| adapter.public_send(method) }
+      @adapters.any? { |adapter| adapter.public_send(method) }
     end
   end
 
@@ -69,6 +71,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,21 +1,21 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Adapters
-    LOG_LEVELS = %w(debug info warn error fatal unknown).freeze
+    LOG_LEVELS = %i[debug info warn error fatal unknown].freeze
 
     def self.get(type, service_name, arguments)
+      raise "Unsupported logger: #{type}" if type != 'stdout'
+
       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 arguments.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'))
+      level = LOG_LEVELS.index(arguments.fetch(:level, :debug).to_sym)
       adapter.new(level, service_name, arguments)
     end
   end

data/lib/lenjador/adapters/stdout_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 class Lenjador
@@ -16,7 +18,7 @@ class Lenjador
 
       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)

data/lib/lenjador/adapters/stdout_json_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Adapters
     class StdoutJsonAdapter
@@ -5,14 +7,14 @@ class Lenjador
         @level = level
         @service_name = 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
+        return unless meets_threshold?(level)
+
+        message = Utils.build_event(metadata, level, @application_name)
+        print_line(Utils.generate_json(message))
       end
 
       def debug?
@@ -38,15 +40,15 @@ class Lenjador
       private
 
       def meets_threshold?(level)
-        LOG_LEVELS.index(level.to_s) >= @level
+        LOG_LEVELS.index(level) >= @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") }
         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

data/lib/lenjador/preprocessors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Preprocessors
     def self.get(type, arguments)

data/lib/lenjador/preprocessors/blacklist.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Preprocessors
     class Blacklist
-
       DEFAULT_ACTION = 'prune'
       MASK_SYMBOL = '*'
       MASKED_VALUE = MASK_SYMBOL * 5
 
-      class UnsupportedActionException < Exception
+      class UnsupportedActionException < RuntimeError
       end
 
       def initialize(config = {})
@@ -22,7 +23,7 @@ class Lenjador
         if data.is_a? Hash
           data.inject({}) do |mem, (key, val)|
             if (field = @fields_to_process[key.to_s])
-              self.send(action_method(field[:action]), mem, key, val)
+              send(action_method(field[:action]), mem, key, val)
             else
               mem.merge(key => process(val))
             end
@@ -43,19 +44,19 @@ class Lenjador
       end
 
       def validate_action_supported(action)
-        unless self.respond_to?(action_method(action).to_sym, true)
-          raise UnsupportedActionException.new("Action: #{action} is not supported")
+        unless respond_to?(action_method(action).to_sym, true)
+          raise UnsupportedActionException, "Action: #{action} is not supported"
         end
       end
 
-      def mask_field(data, key, val)
+      def mask_field(data, key, _val)
         data.merge(key => MASKED_VALUE)
       end
 
       def prune_field(data, *)
         data
       end
-      alias_method :exclude_field, :prune_field
+      alias exclude_field prune_field
     end
   end
 end

data/lib/lenjador/preprocessors/json_pointer_trie.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'lru_redux'
 
 class Lenjador
   module Preprocessors
     class JSONPointerTrie
-      SEPARATOR = '/'.freeze
-      WILDCARD = '~'.freeze
+      SEPARATOR = '/'
+      WILDCARD = '~'
       DEFAULT_CACHE_SIZE = 100
 
       def initialize(cache_size: DEFAULT_CACHE_SIZE, **)

data/lib/lenjador/preprocessors/strategies/mask.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Preprocessors
     module Strategies
       class Mask
-        MASK_SYMBOL = '*'.freeze
+        MASK_SYMBOL = '*'
         MASKED_VALUE = MASK_SYMBOL * 5
 
         def initialize(trie)

data/lib/lenjador/preprocessors/strategies/prune.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Preprocessors
     module Strategies

data/lib/lenjador/preprocessors/whitelist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lenjador/preprocessors/json_pointer_trie'
 require 'lenjador/preprocessors/strategies/mask'
 require 'lenjador/preprocessors/strategies/prune'
@@ -6,12 +8,12 @@ class Lenjador
   module Preprocessors
     class Whitelist
       DEFAULT_WHITELIST = %w[/id /message /correlation_id /queue].freeze
-      MASK_SYMBOL = '*'.freeze
+      MASK_SYMBOL = '*'
       MASKED_VALUE = MASK_SYMBOL * 5
 
       PRUNE_ACTION_NAMES = %w[prune exclude].freeze
 
-      class InvalidPointerFormatException < Exception
+      class InvalidPointerFormatException < RuntimeError
       end
 
       def initialize(config = {})
@@ -31,9 +33,7 @@ class Lenjador
       private
 
       def validate_pointer(pointer)
-        if pointer.slice(-1) == '/'
-          raise InvalidPointerFormatException, 'Pointer should not contain trailing slash'
-        end
+        raise InvalidPointerFormatException, 'Pointer should not contain trailing slash' if pointer.slice(-1) == '/'
       end
 
       def decode(pointer)