lorekeeper 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b074c9039eb5fbdba6a406afbf3ebf823b94033e
-  data.tar.gz: 8284b1c7aa0550b516b7175118904dd689db3b99
+  metadata.gz: 28082939a78a1f7c53df3d13057eb6708d33106b
+  data.tar.gz: f2228468c82b48c7d7b485bf3d5571fc81150a17
 SHA512:
-  metadata.gz: 4967f583dc58d077f368a272be3d29c006ef2ab3f85275f9b9e0efda4a1c4622fe18b19f80433015be54cdeac06f8c043dfa2ac604c217d880c062583222e36e
-  data.tar.gz: b6b0f9f97554fb7a094677192032b4e302c73978a1f863eaf96f393c27355f50f67c0d2bca5e57a2c67b46564c9ff158b62794b5784223d57d7d5eb47311566f
+  metadata.gz: f8d4490eb690b7713d25c154bc558fd10c7b299607e4c2b3e9be3610bebe2eb0a7a3288d0b4c02335b93ea750aa3289402c00b97f766ab4c964a1166a9beeb51
+  data.tar.gz: c394db8116c39d18f6c1c867bba80133ef7bc2f4835ddf7f4526ccd1598809c08408555fc1ab9e68a7ca5211ae700904ca2d9887adf85eb9281edf0b6f67d8b6

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.1
-  - 2.2.2
+  - 2.1.8
+  - 2.2.4
   - 2.3.0
-bundler_args: --without development
+
+script: 'bundle exec rspec'

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.2
+Added a silence_logger method to the logger. For compatibility with
+activerecord-session and maybe other gems.
 # 1.1.1
 Avoid syntax errors in rubies < 2.3
 

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem "mutant-rspec", '~> 0.8'
+  gem 'mutant-rspec', '~> 0.8'
 end
 
 # Specify your gem's dependencies in lorekeeper.gemspec

data/README.md

@@ -1,5 +1,7 @@
 # Lorekeeper
 
+[![Build Status](https://travis-ci.org/JordiPolo/lorekeeper.svg?branch=master)](https://travis-ci.org/JordiPolo/lorekeeper)
+
 LoreKeeper contains a highly optimized JSON logger. It outputs messages as JSON and let the users to add their own customized fields.
 When used without extra fields it outputs 20% faster than the standard Logger for messages not longer than one line of text.
 

data/Rakefile

@@ -5,7 +5,7 @@ require 'benchmark/ips'
 require 'byebug'
 require 'rbtrace'
 
-$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
 $LOAD_PATH.uniq!
 
 require 'lorekeeper'
@@ -14,8 +14,10 @@ require 'logger'
 def create_logger
   logfile = Tempfile.new('my_test_log.log')
   extra_fields = {
-    machine:"Verylongmachinenametobe-Pro.local",
-    component: 'Gilean', version: '0.1.1', trace_id: SecureRandom.hex(16), span_id: SecureRandom.hex(16), parent_span_id: SecureRandom.hex(16)
+    machine: 'Verylongmachinenametobe-Pro.local', component: 'Gilean', version: '0.1.1',
+    trace_id: SecureRandom.hex(16),
+    span_id: SecureRandom.hex(16),
+    parent_span_id: SecureRandom.hex(16)
   }
   log = Lorekeeper::JSONLogger.new(logfile)
   log.add_fields(extra_fields)
@@ -28,7 +30,7 @@ def create_simple_logger
 end
 
 # This task is used to help development of Lorekeeper. Use together with rbtrace
-desc "Runs the code once, sleeping to allow you to attach to it with rbtrace"
+desc 'Runs the code once, sleeping to allow you to attach to it with rbtrace'
 task :run_once do
   contents = 'This is a test, this is only a test. Do not worry about these contents.'
   long_contents = contents * 100
@@ -38,11 +40,9 @@ task :run_once do
   log.error(long_contents)
 end
 
-
 # This task is used to help development of Lorekeeer. Make sure it is fast enough for your app.
-desc "Runs benchmarks for the library."
+desc 'Runs benchmarks for the library.'
 task :benchmark do
-
   contents = 'This is a test, this is only a test. Do not worry about these contents.'
   long_contents = contents * 100
 
@@ -50,14 +50,12 @@ task :benchmark do
   simple_log = create_simple_logger
 
   Benchmark.ips do |bm|
-    bm.report("short content") { log.error(contents) }
-    bm.report("Logger short content")  { simple_log.info(contents) }
-    bm.report("long content")  { log.info(long_contents) }
-    bm.report("Logger long content")   { simple_log.info(long_contents) }
+    bm.report('short content') { log.error(contents) }
+    bm.report('Logger short content') { simple_log.info(contents) }
+    bm.report('long content') { log.info(long_contents) }
+    bm.report('Logger long content') { simple_log.info(long_contents) }
     bm.compare!
   end
 
-  puts "i/s means the number of log messages written into a file per second"
-
+  puts 'i/s means the number of log messages written into a file per second'
 end
-

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "lorekeeper"
+require 'bundler/setup'
+require 'lorekeeper'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "lorekeeper"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/lorekeeper/fast_logger.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 # The comment above will make all strings in a current file frozen
-
 require 'logger'
 
 module Lorekeeper
-
   # Very simple, very fast logger
   class FastLogger
     include ::Logger::Severity  # contains the levels constants: DEBUG, ERROR, etc.
@@ -23,7 +21,7 @@ module Lorekeeper
     end
 
     LOGGING_METHODS = %i(debug info warn error fatal)
-    METHOD_SEVERITY_MAP = {debug: DEBUG, info: INFO, warn: WARN, error: ERROR, fatal: FATAL}
+    METHOD_SEVERITY_MAP = { debug: DEBUG, info: INFO, warn: WARN, error: ERROR, fatal: FATAL }
 
     # We define the behaviour of all the usual logging methods
     # We support a string as a parameter and also a block
@@ -34,12 +32,20 @@ module Lorekeeper
     end
 
     # This is part of the standard Logger API, we need this to be compatible
-    def add(severity, message_param = nil, progname = nil, &block)
+    def add(severity, message_param = nil, _ = nil, &block)
       return true if severity < @level
       message = message_param || (block && block.call)
       log_data(severity, message.freeze)
     end
 
+    # Some gems like to add this method. For instance:
+    # https://github.com/rails/activerecord-session_store
+    # 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?
+    end
+
     # inherited classes probably want to reimplement this
     def log_data(_severity, message)
       @iodevice.write(message)
@@ -48,12 +54,13 @@ module Lorekeeper
     private
 
     require 'monitor'
+    # Mutex to avoid broken lines when multiple threads access the log file
     class LogDeviceMutex
       include MonitorMixin
     end
 
+    # Very fast class to write to a log file.
     class LogDevice
-
       def initialize(file)
         @iodevice = to_iodevice(file)
         @iomutex = LogDeviceMutex.new
@@ -85,6 +92,5 @@ module Lorekeeper
         puts "File #{filename} can't be open for logging. #{e.message}"
       end
     end
-
   end
 end

data/lib/lorekeeper/json_logger.rb

@@ -30,7 +30,7 @@ module Lorekeeper
     LOGGING_METHODS.each do |method_name|
       define_method "#{method_name}_with_data", ->(message_param = nil, data = {}, &block) do
         return true if METHOD_SEVERITY_MAP[method_name] < @level
-        extra_fields = {'data' => (data || {}) }
+        extra_fields = { 'data' => (data || {}) }
         with_extra_fields(extra_fields) { # Using do/end here only valid on Ruby>= 2.3
           add(METHOD_SEVERITY_MAP[method_name], message_param, nil, &block)
         }
@@ -81,9 +81,9 @@ module Lorekeeper
       end
     end
 
-   private
+    private
 
-    THREAD_KEY = 'lorekeeper_jsonlogger_key'.freeze #Shared by all threads but unique by thread
+    THREAD_KEY = 'lorekeeper_jsonlogger_key'.freeze # Shared by all threads but unique by thread
     MESSAGE = 'message'.freeze
     TIMESTAMP = 'timestamp'.freeze
     DATE_FORMAT = '%FT%T.%L%z'.freeze

data/lib/lorekeeper/multi_logger.rb

@@ -1,4 +1,4 @@
-
+# frozen_string_literal: true
 module Lorekeeper
   # Allows to create a logger that will pass information to any logger registered
   # It is useful so send the same message thought different loggers to different sinks
@@ -6,6 +6,7 @@ module Lorekeeper
     def initialize
       @loggers = []
     end
+
     def add_logger(logger)
       @loggers << logger
     end

data/lib/lorekeeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # The comment above will make all strings in a current file frozen
 module Lorekeeper
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lorekeeper.gemspec

@@ -5,29 +5,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lorekeeper/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "lorekeeper"
+  spec.name          = 'lorekeeper'
   spec.version       = Lorekeeper::VERSION
-  spec.authors       = ["Jordi Polo"]
-  spec.email         = ["mumismo@gmail.com"]
+  spec.authors       = ['Jordi Polo']
+  spec.email         = ['mumismo@gmail.com']
 
-  spec.summary       = %q{ Very fast JSON logger }
-  spec.description   = %q{ Opinionated logger which outputs messages in JSON format }
-  spec.homepage      = "http://www.gihub.com/jordipolo/lorekeeper"
-  spec.license       = "MIT"
+  spec.summary       = ' Very fast JSON logger '
+  spec.description   = ' Opinionated logger which outputs messages in JSON format '
+  spec.homepage      = 'http://www.gihub.com/jordipolo/lorekeeper'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'oj', '~> 2.14'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", '~> 3.4'
-  spec.add_development_dependency "benchmark-ips", '~> 2.3'
-  spec.add_development_dependency "timecop", '~> 0.8'
-  spec.add_development_dependency "byebug", '~> 8.0'
-  spec.add_development_dependency "rbtrace", '~> 0.4'
-
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'benchmark-ips', '~> 2.3'
+  spec.add_development_dependency 'timecop', '~> 0.8'
+  spec.add_development_dependency 'byebug', '~> 8.0'
+  spec.add_development_dependency 'rbtrace', '~> 0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jordi Polo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile