ougai 1.8.5 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d04627a9810f76be4d299992b3a2eca66eb66d7d168083962ee3b4a554546d50
-  data.tar.gz: '089ed84f7e5c8aabd201a82a914dfb0d7d8182b88a3646bb2143060d212544b9'
+  metadata.gz: 4b9254ac3650ca12026fbd3d3c6b474a8de478fb81ea82f19fecdff6b62c8b17
+  data.tar.gz: 95c71a88355673d0821596503057ad46761c3b508ab7a0b72b806462f8a3af7f
 SHA512:
-  metadata.gz: cfab00111705a26b41ccdbb2888c556902a9b1acda511d191b57ed675a2a835b13b13b79cfff4fe439fefd446f2fa00da93884a36ced0cba8a2e52c3d4e1169d
-  data.tar.gz: 07edc5901a52a5764b98cb8fdbf504913d0b63a32b6d8d631b0cc73cd079f8ff1e492f0fd98e4d177e9e4fae8656bf46d0476abc167515240176bef8e7df2023
+  metadata.gz: 9c7cdf6d3ad6cfbaae66438cc40971a5cbd978ad9585c2ed4538cea3530184f53a3e0f2a87c22cfcfc581ecbb596eb7b7d2468edc26e7c1b05d27832d856bbcf
+  data.tar.gz: bed8c16d8e851d7b64d52b86084c13f333a0cee873ab4c1bd8670083c700597a587cb6edf39cead61711af747d30b0723d6bf63ac6eadd1c4de0fb7611d8f16c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ougai (1.8.5)
+    ougai (1.9.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.0-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)

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(:add) do |*args, &block|
+          logger.add(*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)
+      add(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)
+      add(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)
+      add(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)
+      add(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)
+      add(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)
+      add(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)
+      add(UNKNOWN, message, ex, data, &block)
     end
 
     # Whether the current severity level allows for logging TRACE.
@@ -84,6 +83,22 @@ 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, *args)
+      severity ||= UNKNOWN
+      return true if level > severity
+      append(severity, block_given? ? yield : args)
+    end
+
+    alias log add
+
     # @private
     def chain(_severity, _args, _fields, _hooks)
       raise NotImplementedError
@@ -106,12 +121,5 @@ module Ougai
         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 = '1.9.0'
 end

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
@@ -30,4 +37,54 @@ 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])
+        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'])
+        subject.add(nil, 'message')
+      end
+    end
+
+    context 'block given' do
+      it 'calls append with yielded arguments' do
+        expect(subject).to receive(:append).with(::Logger::Severity::WARN, ['block message'])
+        subject.log(::Logger::Severity::WARN) { ['block message'] }
+      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])
+        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'])
+        subject.log(nil, 'message')
+      end
+    end
+
+    context 'block given' 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: 1.9.0
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2021-01-10 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