ougai 1.8.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d04627a9810f76be4d299992b3a2eca66eb66d7d168083962ee3b4a554546d50
-  data.tar.gz: '089ed84f7e5c8aabd201a82a914dfb0d7d8182b88a3646bb2143060d212544b9'
+  metadata.gz: e289dc71320f34d59d1ed29ec87fe87778ac22eec628d627116264c8abdcd403
+  data.tar.gz: 3f0d074e2ad4ed429a1c2988034811e94b2ef116a1f13611f7d5949a21af56d9
 SHA512:
-  metadata.gz: cfab00111705a26b41ccdbb2888c556902a9b1acda511d191b57ed675a2a835b13b13b79cfff4fe439fefd446f2fa00da93884a36ced0cba8a2e52c3d4e1169d
-  data.tar.gz: 07edc5901a52a5764b98cb8fdbf504913d0b63a32b6d8d631b0cc73cd079f8ff1e492f0fd98e4d177e9e4fae8656bf46d0476abc167515240176bef8e7df2023
+  metadata.gz: 101691c8885df5575d64e603f2e39922a0c0078f50a0685a470de561e5d2db3b01301b8b88eb0e54b23fea86006e02baebd98d2b7c701e9c5876b8df1417c3a7
+  data.tar.gz: 3e807cafc0787b005312c527abbddd8bc4ae3834242d1adb3b1fa9b2deb0aebebd363ca1e46c7b120b31794b578c3d68c2bb292a31ce08be0a47edcc192ab5f4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ougai (1.8.5)
+    ougai (2.0.0)
       oj (~> 3.10)
 
 GEM

data/README.md

@@ -2,7 +2,7 @@ Ougai
 =====
 
 [![Gem Version](https://badge.fury.io/rb/ougai.svg)](https://badge.fury.io/rb/ougai)
-[![document](https://img.shields.io/badge/document-1.8.3-green.svg)](http://www.rubydoc.info/gems/ougai/)
+[![document](https://img.shields.io/badge/document-1.9.1-green.svg)](http://www.rubydoc.info/gems/ougai/)
 [![Build Status](https://travis-ci.org/tilfin/ougai.svg?branch=master)](https://travis-ci.org/tilfin/ougai)
 [![Code Climate](https://codeclimate.com/github/tilfin/ougai/badges/gpa.svg)](https://codeclimate.com/github/tilfin/ougai)
 [![Test Coverage](https://codeclimate.com/github/tilfin/ougai/badges/coverage.svg)](https://codeclimate.com/github/tilfin/ougai/coverage)
@@ -194,7 +194,18 @@ logger.info('Hello!', user: { name: 'Jiro' }, version: '2.3')
 ```
 
 If any field of with_fields is specified in each log, the field is overridden.
-But if the field's type is *Array*, both with_field value and logging value are merged with `concat` and `uniq`.
+If the field's type is *Array*, both with_field value and logging value are merged with `concat` and `uniq`.
+
+If the field's type is *Hash*, then values are merged recursively.
+
+```ruby
+logger.with_fields = { version: '1.1.0', user: { name: 'Taro' } }
+logger.debug(user: { age: 19 })
+```
+
+```json
+{"name":"test","hostname":"mint","pid":30182,"level":20,"time":"2017-07-22T20:52:12.332+09:00","v":0,"version":"1.1.0","msg":"No message","user":{"name":"Taro","age":19}}
+```
 
 ### Create a child logger
 
@@ -242,6 +253,8 @@ child_logger.debug('This is not outputted')
 
 If any field exists in both parent log and child log, the parent value is overridden or merged by child value.
 
+If the field's type is *Hash*, then values are merged recursively.
+
 ### Hook before logging
 
 Setting `before_log` of logger or child an *lambda* with `data` field, a process can be run before log each output.

data/lib/ougai/logger.rb

@@ -7,6 +7,7 @@ module Ougai
   # @attr [Hash] with_fields The fields appending to all logs.
   # @attr [Proc] before_log Hook before logging.
   class Logger < ::Logger
+    alias_method :super_add, :add
     include Logging
 
     attr_accessor :default_message, :exc_key
@@ -38,9 +39,9 @@ module Ougai
     # @param logger [Logger] The logger receiving broadcast logs.
     def self.broadcast(logger)
       Module.new do |mdl|
-        define_method(:log) do |*args|
-          logger.log(*args)
-          super(*args)
+        define_method(:_log) do |*args, &block|
+          logger._log(*args, &block)
+          super(*args, &block)
         end
 
         define_method(:level=) do |level|
@@ -111,7 +112,7 @@ module Ougai
       hooks.each do |hook|
         return false if hook.call(data) == false
       end
-      add(severity, data)
+      super_add(severity, data)
     end
 
     def to_item(args)

data/lib/ougai/logging.rb

@@ -28,7 +28,7 @@ module Ougai
     # @return [Boolean] true
     # @see Logging#debug
     def trace(message = nil, ex = nil, data = nil, &block)
-      log(TRACE, message, ex, data, block)
+      _log(TRACE, message, ex, data, &block)
     end
 
     # Log any one or more of a message, an exception and structured data as DEBUG.
@@ -39,43 +39,42 @@ module Ougai
     # @yieldreturn [String|Exception|Object|Array] Any one or more of former parameters
     # @return [Boolean] true
     def debug(message = nil, ex = nil, data = nil, &block)
-      log(DEBUG, message, ex, data, block)
+      _log(DEBUG, message, ex, data, &block)
     end
 
     # Log any one or more of a message, an exception and structured data as INFO.
     # @return [Boolean] true
     # @see Logging#debug
     def info(message = nil, ex = nil, data = nil, &block)
-      log(INFO, message, ex, data, block)
+      _log(INFO, message, ex, data, &block)
     end
 
     # Log any one or more of a message, an exception and structured data as WARN.
     # @return [Boolean] true
     # @see Logging#debug
     def warn(message = nil, ex = nil, data = nil, &block)
-      log(WARN, message, ex, data, block)
+      _log(WARN, message, ex, data, &block)
     end
 
     # Log any one or more of a message, an exception and structured data as ERROR.
     # @return [Boolean] true
     # @see Logging#debug
     def error(message = nil, ex = nil, data = nil, &block)
-      log(ERROR, message, ex, data, block)
+      _log(ERROR, message, ex, data, &block)
     end
 
     # Log any one or more of a message, an exception and structured data as FATAL.
     # @return [Boolean] true
     # @see Logging#debug
     def fatal(message = nil, ex = nil, data = nil, &block)
-      log(FATAL, message, ex, data, block)
+      _log(FATAL, message, ex, data, &block)
     end
 
     # Log any one or more of a message, an exception and structured data as UNKNOWN.
     # @return [Boolean] true
     # @see Logging#debug
     def unknown(message = nil, ex = nil, data = nil, &block)
-      args = block ? yield : [message, ex, data]
-      append(UNKNOWN, args)
+      _log(UNKNOWN, message, ex, data, &block)
     end
 
     # Whether the current severity level allows for logging TRACE.
@@ -84,6 +83,26 @@ module Ougai
       level <= TRACE
     end
 
+    # Log any one or more of a message, an exception and structured data as specified log level.
+    # If the block is given for delay evaluation, it returns them as an array or the one of them as a value.
+    # @param severity [Integer] The log level.
+    # @param message [String] The message to log. Use default_message if not specified.
+    # @param ex [Exception] The exception or the error
+    # @param data [Object] Any structured data
+    # @yieldreturn [String|Exception|Object|Array] Any one or more of former parameters
+    # @return [Boolean] true
+    def add(severity, message = nil, ex = nil, data = nil, &block)
+      _log(severity, message, ex, data, &block)
+    end
+
+    alias log add
+
+    def _log(severity, *args)
+      severity ||= UNKNOWN
+      return true if level > severity
+      append(severity, block_given? ? yield : args)
+    end
+
     # @private
     def chain(_severity, _args, _fields, _hooks)
       raise NotImplementedError
@@ -101,17 +120,12 @@ module Ougai
       base_data.merge!(inferior_data) do |_, base_v, inferior_v|
         if base_v.is_a?(Array) and inferior_v.is_a?(Array)
           (inferior_v + base_v).uniq
+        elsif base_v.is_a?(Hash) and inferior_v.is_a?(Hash)
+          weak_merge!(base_v, inferior_v)
         else
           base_v
         end
       end
     end
-
-    # @private
-    def log(severity, message, ex, data, block)
-      return true if level > severity
-      args = block ? block.call : [message, ex, data]
-      append(severity, args)
-    end
   end
 end

data/lib/ougai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ougai
-  VERSION = '1.8.5'
+  VERSION = '2.0.0'
 end

data/spec/child_logger_spec.rb

@@ -390,7 +390,7 @@ describe Ougai::ChildLogger do
           parent_logger.with_fields = { foo: 11 }
           logger.with_fields = { bar: '11' }
         end
- 
+
         it 'outputs with child fields' do
           logger.info(log_msg)
           parent_logger.info(parent_log_msg)
@@ -426,7 +426,7 @@ describe Ougai::ChildLogger do
         before do
           parent_logger.with_fields = { foo: 22 }
         end
- 
+
         it 'output with new parent fields' do
           logger.info(log_msg)
           parent_logger.info(parent_log_msg)
@@ -462,7 +462,7 @@ describe Ougai::ChildLogger do
         before do
           logger.with_fields = { bar: '33' }
         end
- 
+
         it 'output valid' do
           logger.info(log_msg)
           parent_logger.info(parent_log_msg)
@@ -478,35 +478,45 @@ describe Ougai::ChildLogger do
 
     context 'grandchild logger' do
       before do
-        parent_logger.with_fields = { tag: 'parent', tags: ['parent'] }
+        parent_logger.with_fields = { tag: 'parent', tags: ['parent'], event: { module: 'core' } }
       end
 
-      let(:logger) { parent_logger.child(tag: 'child', tags: ['child']) }
-      let(:grand_logger) { logger.child(tag: 'grandchild', tags: ['grandchild']) }
+      let(:logger) { parent_logger.child(tag: 'child', tags: ['child'], event: { dataset: 'core.child' }) }
+      let(:grand_logger) { logger.child(tag: 'grandchild', tags: ['grandchild'], event: { action: 'log-action' }) }
 
       it 'outputs with all merged fields' do
         grand_logger.info('Hi', foo: 3)
         logger.info(log_msg, foo: 2)
-        parent_logger.info(parent_log_msg, foo: 10)
-        parent_logger.info('Good evening!', foo: 11)
+        parent_logger.info(parent_log_msg, foo: 10, event: { module: 'service' })
+        parent_logger.info('Good evening!', foo: 11, event: { duration: 150 })
 
         expect(items[0]).to be_log_message('Hi', log_level)
-        expect(items[0]).to include(tag: 'grandchild', tags: ['parent', 'child', 'grandchild'], foo: 3)
+        expect(items[0]).to include(
+          tag: 'grandchild',
+          tags: ['parent', 'child', 'grandchild'],
+          foo: 3,
+          event: { module: 'core', dataset: 'core.child', action: 'log-action' }
+        )
 
         expect(items[1]).to be_log_message(log_msg, log_level)
-        expect(items[1]).to include(tag: 'child', tags: ['parent', 'child'], foo: 2)
+        expect(items[1]).to include(
+          tag: 'child',
+          tags: ['parent', 'child'],
+          foo: 2,
+          event: { module: 'core', dataset: 'core.child' }
+        )
 
         expect(items[2]).to be_log_message(parent_log_msg, log_level)
-        expect(items[2]).to include(tag: 'parent', tags: ['parent'], foo: 10)
+        expect(items[2]).to include(tag: 'parent', tags: ['parent'], foo: 10, event: { module: 'service' })
         expect(items[3]).to be_log_message('Good evening!', log_level)
-        expect(items[3]).to include(tag: 'parent', tags: ['parent'], foo: 11)
+        expect(items[3]).to include(tag: 'parent', tags: ['parent'], foo: 11, event: { module: 'core', duration: 150 })
       end
 
       context 'after updating child logger with_fields' do
         before do
           logger.with_fields = { bar: '33' }
         end
- 
+
         it 'outputs with child fields' do
           logger.info(log_msg)
           expect(items[0]).to be_log_message(log_msg, log_level)

data/spec/logger_spec.rb

@@ -349,6 +349,14 @@ describe Ougai::Logger do
     it_behaves_like 'log'
   end
 
+  describe '#unknown' do
+    let(:log_level) { 70 }
+    let(:log_msg) { 'unknown message' }
+    let(:method) { 'unknown' }
+
+    it_behaves_like 'log'
+  end
+
   describe '#level' do
     context 'DEBUG' do
       let(:log_msg) { 'log message' }

data/spec/logging_spec.rb

@@ -3,7 +3,14 @@ require 'spec_helper'
 describe Ougai::Logging do
   subject do
     m = described_class
-    Class.new { include m }.new
+
+    Class.new do
+      include m
+
+      def level
+        -1
+      end
+    end.new
   end
 
   describe '#weak_merge!' do
@@ -17,6 +24,15 @@ describe Ougai::Logging do
       expect(result[:bar]).to eq('base')
       expect(result[:baz]).to eq(['B', 'A'])
     end
+
+    it 'merges hashes recursively' do
+      result = nil
+      subject.instance_eval do
+        result = weak_merge!({ foo: { bar: { baz: 15 } } },
+                             { foo: { bar: { extra: 10 }, nested: 'string' } })
+      end
+      expect(result).to eq({ foo: { bar: { baz: 15, extra: 10 }, nested: 'string' } })
+    end
   end
 
   describe '#chain' do
@@ -30,4 +46,62 @@ describe Ougai::Logging do
       expect{ subject.send(:append, :arg1, :arg2) }.to raise_error(NotImplementedError)
     end
   end
+
+  describe '#add' do
+    context 'severity is specified level' do
+      it 'calls append with specified level' do
+        data = double('data')
+        expect(subject).to receive(:append).with(::Logger::Severity::DEBUG, ['debug message', data, nil])
+        subject.add(::Logger::Severity::DEBUG, 'debug message', data)
+      end
+    end
+
+    context 'severity is nil' do
+      it 'calls append with UNKNOWN level' do
+        expect(subject).to receive(:append).with(::Logger::Severity::UNKNOWN, ['message', nil, nil])
+        subject.add(nil, 'message')
+      end
+    end
+
+    context 'with block that yields message' do
+      it 'calls append with yielded message' do
+        expect(subject).to receive(:append).with(::Logger::Severity::WARN, 'block message')
+        subject.add(::Logger::Severity::WARN) { 'block message' }
+      end
+    end
+
+    context 'with block that yields array' do
+      it 'calls append with yielded array' do
+        data = double('data')
+        expect(subject).to receive(:append).with(::Logger::Severity::WARN, ['block message', data])
+        subject.add(::Logger::Severity::WARN) { ['block message', data] }
+      end
+    end
+  end
+
+  describe '#log' do
+    context 'severity is specified' do
+      it 'calls append with specified level' do
+        ex = Exception.new
+        expect(subject).to receive(:append).with(::Logger::Severity::FATAL, ['fatal message', ex, nil])
+        subject.log(::Logger::Severity::FATAL, 'fatal message', ex)
+      end
+    end
+
+    context 'severity is nil' do
+      it 'calls append with UNKNOWN level' do
+        expect(subject).to receive(:append).with(::Logger::Severity::UNKNOWN, ['message', nil, nil])
+        subject.log(nil, 'message')
+      end
+    end
+
+    context 'with block' do
+      it 'calls append with yielded arguments' do
+        ex = Exception.new
+        data = double('data')
+        expect(subject).to receive(:append).with(::Logger::Severity::INFO, ['block message', ex, data])
+        subject.log(::Logger::Severity::INFO) { ['block message', ex, data] }
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 1.8.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2021-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -114,25 +114,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: JSON logger compatible with node-bunyan or pino is capable of handling structured
   data easily.
 test_files:
-- spec/formatters/pino_spec.rb
-- spec/formatters/base_spec.rb
-- spec/formatters/bunyan_spec.rb
-- spec/formatters/readable_spec.rb
 - spec/child_logger_spec.rb
 - spec/logging_spec.rb
-- spec/logger_spec.rb
 - spec/ougai_spec.rb
 - spec/spec_helper.rb
+- spec/formatters/pino_spec.rb
+- spec/formatters/readable_spec.rb
+- spec/formatters/base_spec.rb
+- spec/formatters/bunyan_spec.rb
+- spec/logger_spec.rb