ougai 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdfdff5fa693d4f9cc99ebcf23f98d469efd554bc305ef235808a08d614492f5
-  data.tar.gz: a62f7b67bb08ce159c18ce11055556d9363ab828d6d4c18c033c9a77e3275158
+  metadata.gz: 4b9254ac3650ca12026fbd3d3c6b474a8de478fb81ea82f19fecdff6b62c8b17
+  data.tar.gz: 95c71a88355673d0821596503057ad46761c3b508ab7a0b72b806462f8a3af7f
 SHA512:
-  metadata.gz: 82e5cb16d19270f57b2b398419a5f75c0feb459fa93925870662e7763722d718f0b2c8528f42c8b7ce97570310b55185235fa62e3a04a373c410484f76e5fd60
-  data.tar.gz: 00ba0a0e24b2dda62a19e31774c24bd6178f89f5edb1856528ed5411b2f07a03a8e0eca888eadb3c4e5ac32dbdfcf0fc5afdb03961311534f1721de9b7a538f2
+  metadata.gz: 9c7cdf6d3ad6cfbaae66438cc40971a5cbd978ad9585c2ed4538cea3530184f53a3e0f2a87c22cfcfc581ecbb596eb7b7d2468edc26e7c1b05d27832d856bbcf
+  data.tar.gz: bed8c16d8e851d7b64d52b86084c13f333a0cee873ab4c1bd8670083c700597a587cb6edf39cead61711af747d30b0723d6bf63ac6eadd1c4de0fb7611d8f16c

data/Gemfile

@@ -4,8 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'awesome_print'
-  gem 'simplecov', require: false
+  gem 'amazing_print'
+  gem 'simplecov', '< 0.18', require: false
   gem 'timecop'
   gem 'yard'
 end

data/Gemfile.lock

@@ -1,53 +1,53 @@
 PATH
   remote: .
   specs:
-    ougai (1.8.1)
-      oj (~> 3.4)
+    ougai (1.9.0)
+      oj (~> 3.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    awesome_print (1.8.0)
+    amazing_print (1.0.0)
     diff-lcs (1.3)
     docile (1.3.2)
-    json (2.2.0)
-    json (2.2.0-java)
-    oj (3.9.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    json (2.3.0)
+    json (2.3.0-java)
+    oj (3.10.6)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    simplecov (0.17.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     timecop (0.9.1)
-    yard (0.9.20)
+    yard (0.9.24)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
-  awesome_print
-  bundler (>= 1.11.0)
+  amazing_print
+  bundler (>= 2.1.4)
   ougai!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  simplecov
+  rake (>= 13.0.1)
+  rspec (>= 3.9.0)
+  simplecov (< 0.18)
   timecop
   yard
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2019 Toshimitsu Takahashi
+Copyright (c) 2016-2020 Toshimitsu Takahashi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,14 +2,14 @@ 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.1-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)
 
 A structured logging system is capable of handling a message, structured data or an exception easily.
 It has JSON formatters compatible with [Bunyan](https://github.com/trentm/node-bunyan) or [pino](https://github.com/pinojs/pino) for Node.js and
-human readable formatter with [Awesome Print](https://github.com/awesome-print/awesome_print) for console.
+human readable formatter with [Amazing Print](https://github.com/amazing-print/amazing_print) for console.
 
 ## Installation
 
@@ -335,10 +335,10 @@ If you use *Ougai::Formatters::Pino*, you can use command [pino](https://github.
 
 ## Use human Readable formatter for console
 
-Add awesome_print to Gemfile and `bundle`
+Add amazing_print to Gemfile and `bundle`
 
 ```ruby
-gem 'awesome_print'
+gem 'amazing_print'
 ```
 
 Set *Ougai::Formatters::Readable* instance to `formatter` accessor

data/lib/ougai/formatters/readable.rb

@@ -4,7 +4,7 @@ require 'ougai/formatters/base'
 
 module Ougai
   module Formatters
-    # A human readble formatter with awesome_print
+    # A human readble formatter with amazing_print
     # @attr [Boolean] plain Whether log should be plain not colorized.
     # @attr [Array<String, Symbol>] excluded_fields The fields excluded from all logs
     class Readable < Base
@@ -28,7 +28,8 @@ module Ougai
         load_dependent
       end
 
-      def _call(severity, time, progname, data)
+      def _call(severity, time, progname, _data)
+        data = _data.dup
         msg = data.delete(:msg)
         level = @plain ? severity : colored_level(severity)
         dt = format_datetime(time)
@@ -86,9 +87,9 @@ module Ougai
       end
 
       def load_dependent
-        require 'awesome_print'
+        require 'amazing_print'
       rescue LoadError
-        puts 'You must install the awesome_print gem to use this output.'
+        puts 'You must install the amazing_print gem to use this output.'
         raise
       end
     end

data/lib/ougai/logger.rb

@@ -7,12 +7,13 @@ 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
 
-    def initialize(*args)
-      super(*args)
+    def initialize(*, **)
+      super
       @before_log = nil
       @default_message = 'No message'
       @exc_key = :err
@@ -38,13 +39,9 @@ module Ougai
     # @param logger [Logger] The logger receiving broadcast logs.
     def self.broadcast(logger)
       Module.new do |mdl|
-        Logger::Severity.constants.each do |severity|
-          method_name = severity.downcase.to_sym
-
-          mdl.send(:define_method, method_name) do |*args|
-            logger.send(method_name, *args)
-            super(*args)
-          end
+        define_method(:add) do |*args, &block|
+          logger.add(*args, &block)
+          super(*args, &block)
         end
 
         define_method(:level=) do |level|
@@ -115,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,13 +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.1'
+  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' }
@@ -645,7 +653,7 @@ describe Ougai::Logger do
       end
 
       it 'outputs info log with block on both loggers' do
-        logger.info(log_msg, foo: 2)
+        logger.info { [log_msg, { foo: 2 }] }
         expect(item).to be_log_message(log_msg, 30)
         expect(item).to include_data(foo: 2)
         expect(another_item).to be_log_message(log_msg, 30)

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.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2021-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -16,59 +16,59 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.9.0
 description: |2
       A structured logging system is capable of handling a message, custom data or an exception easily.
-      It has JSON formatters compatible with Bunyan or pino for Node.js and human readable formatter with Awesome Print for console.
+      It has JSON formatters compatible with Bunyan or pino for Node.js and human readable formatter with Amazing Print for console.
 email:
 - toshi@tilfin.com
 executables: []
@@ -114,25 +114,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.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