ougai 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0235a013e7e1d174d71adb866072ce73243cb8a8
-  data.tar.gz: ffde73e617129cf7287abfd53cbd5f151e166816
+  metadata.gz: ebde39051085cb7a4b15a0d010903592a6e05bad
+  data.tar.gz: 47c033c11627e440dfc666577178593fb59666d0
 SHA512:
-  metadata.gz: be64d5eb15dca49f85a323b2c3fac463d83a42dd3f5f0bca6d318ca27cd8646e74dd3e3d658d3248469ccf4e6320c39512a390a91ca92d8a46dde3ab1f7f4c3a
-  data.tar.gz: a634e9fa73595c01748390bb6043e220c8f0b65cc052202320cf6fa31ea4b3be0984c623171afc46ea72e227d3f32bceb770b3baf07d8f0421e54067ac2326f8
+  metadata.gz: 50775ba920ffba4c4f01f2aef35c274c5c916ab9fa46d6265a878a43bcd5e492af09e552aae082d9efeec7296ce651a285d48f6acd8027c8412a50f8aec0d93c
+  data.tar.gz: 39a73244485976896f2987cee6a2c39311f50799669c3e7f9deda7b96267e18e47bc4d53e9f1b75fba047b05c45f217e1f11a2c07c97cafb7e617c8f0459f004

data/README.md

@@ -236,6 +236,47 @@ Thread.new { logger.debug('on another thread') }
 {"name":"main","hostname":"mint","pid":13975,"level":20,"time":"2017-08-06T15:35:53.435+09:00","v":0,"msg":"on another thread","thread_id":"gqe0cb14g"}
 ```
 
+### Using broadcast, log output plural targets
+
+`Ougai::Logger.broadcast` can be used to like `ActiveSupport::Logger.broadcast`.
+
+#### An example
+
+Original `logger` outputs STDOUT and `error_logger` outputs `./error.log`.
+Every calling for `logger` is propagated to `error_logger`.
+
+```ruby
+logger = Ougai::Logger.new(STDOUT)
+
+error_logger = Ougai::Logger.new('./error.log')
+logger.extend Ougai::Logger.broadcast(error_logger)
+
+logger.level = Logger::INFO
+logger.info('Hello!')
+
+error_logger.level = Logger::ERROR
+logger.error('Failed to do something.')
+
+logger.level = Logger::WARN # error_logger level is also set WARN by propagation
+logger.warn('Ignored something.')
+```
+
+##### STDOUT
+
+```json
+{"name":"main","hostname":"mint","pid":24915,"level":30,"time":"2017-08-16T17:23:42.415+09:00","v":0,"msg":"Hello!"}
+{"name":"main","hostname":"mint","pid":24915,"level":50,"time":"2017-08-16T17:23:42.416+09:00","v":0,"msg":"Failed to do something."}
+{"name":"main","hostname":"mint","pid":24915,"level":40,"time":"2017-08-16T17:23:42.416+09:00","v":0,"msg":"Ignored something."}
+```
+
+##### error.log
+
+```json
+{"name":"main","hostname":"mint","pid":24915,"level":50,"time":"2017-08-16T17:23:42.415+09:00","v":0,"msg":"Failed to do something."}
+{"name":"main","hostname":"mint","pid":24915,"level":40,"time":"2017-08-16T17:23:42.416+09:00","v":0,"msg":"Ignored something."}
+```
+
+
 ## View log by node-bunyan
 
 Install [bunyan](https://github.com/trentm/node-bunyan) via NPM

data/lib/ougai/logger.rb

@@ -22,6 +22,11 @@ module Ougai
             super(*args)
           end
         end
+
+        define_method(:level=) do |level|
+          logger.level = level
+          super(level)
+        end
       end
     end
 

data/lib/ougai/logging.rb

@@ -4,33 +4,23 @@ module Ougai
     attr_writer :before_log
 
     def debug(message = nil, ex = nil, data = nil, &block)
-      return true if level > Logger::DEBUG
-      args = block ? yield : [message, ex, data]
-      append(Logger::DEBUG, args)
+      log(Logger::DEBUG, message, ex, data, block)
     end
 
     def info(message = nil, ex = nil, data = nil, &block)
-      return true if level > Logger::INFO
-      args = block ? yield : [message, ex, data]
-      append(Logger::INFO, args)
+      log(Logger::INFO, message, ex, data, block)
     end
 
     def warn(message = nil, ex = nil, data = nil, &block)
-      return true if level > Logger::WARN
-      args = block ? yield : [message, ex, data]
-      append(Logger::WARN, args)
+      log(Logger::WARN, message, ex, data, block)
     end
 
     def error(message = nil, ex = nil, data = nil, &block)
-      return true if level > Logger::ERROR
-      args = block ? yield : [message, ex, data]
-      append(Logger::ERROR, args)
+      log(Logger::ERROR, message, ex, data, block)
     end
 
     def fatal(message = nil, ex = nil, data = nil, &block)
-      return true if level > Logger::FATAL
-      args = block ? yield : [message, ex, data]
-      append(Logger::FATAL, args)
+      log(Logger::FATAL, message, ex, data, block)
     end
 
     def unknown(message = nil, ex = nil, data = nil, &block)
@@ -61,5 +51,13 @@ 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,3 +1,3 @@
 module Ougai
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/logger_spec.rb

@@ -516,4 +516,102 @@ describe Ougai::Logger do
       end
     end
   end
+
+  describe '#broadcast' do
+    let(:log_msg) { 'broadcast test message' }
+
+    let(:another_io) { StringIO.new }
+    let(:another_logger) { described_class.new(another_io) }
+
+    let(:another_item) do
+      log_str = another_io.string
+      begin
+        JSON.parse(log_str, symbolize_names: true)
+      rescue Exception => e
+        nil
+      end 
+    end
+
+    before do
+      logger.extend Ougai::Logger.broadcast(another_logger)
+    end
+
+    context 'another logger level is the same as original one' do
+      before do
+        logger.level = Logger::INFO # propagate serverity to another one
+      end
+
+      it 'does not output debug log on both loggers' do
+        logger.debug(log_msg, foo: 1)
+        expect(item).to be_nil
+        expect(another_item).to be_nil
+      end
+
+      it 'does not output debug log with block on both loggers' do
+        logger.debug { [log_msg, foo: 1] }
+        expect(item).to be_nil
+        expect(another_item).to be_nil
+      end
+
+      it 'outputs info log on both loggers' do
+        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)
+        expect(another_item).to include_data(foo: 2)
+      end
+
+      it 'outputs info log with block on both loggers' do
+        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)
+        expect(another_item).to include_data(foo: 2)
+      end
+
+      it 'outputs warning log on both loggers' do
+        logger.warn(log_msg)
+        expect(item).to be_log_message(log_msg, 40)
+        expect(another_item).to be_log_message(log_msg, 40)
+      end
+    end
+
+    context 'another logger level is lower than original one' do
+      before do
+        logger.level = Logger::INFO
+        another_logger.level = Logger::DEBUG
+      end
+
+      it 'outputs debug log on only another logger' do
+        logger.debug(log_msg)
+        expect(item).to be_nil
+        expect(another_item).to be_log_message(log_msg, 20)
+      end
+
+      it 'outputs info log on both loggers' do
+        logger.info(log_msg)
+        expect(item).to be_log_message(log_msg, 30)
+        expect(another_item).to be_log_message(log_msg, 30)
+      end
+    end
+
+    context 'another logger level is greater than original one' do
+      before do
+        logger.level = Logger::INFO
+        another_logger.level = Logger::WARN
+      end
+
+      it 'outputs info log on only original logger' do
+        logger.info(log_msg)
+        expect(item).to be_log_message(log_msg, 30)
+        expect(another_item).to be_nil
+      end
+
+      it 'outputs warning log on both loggers' do
+        logger.warn(log_msg)
+        expect(item).to be_log_message(log_msg, 40)
+        expect(another_item).to be_log_message(log_msg, 40)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-06 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,15 +102,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: JSON logger compatible with node-bunyan is capable of handling data easily.
 test_files:
+- spec/child_logger_spec.rb
 - spec/formatters/base_spec.rb
 - spec/formatters/readable_spec.rb
-- spec/child_logger_spec.rb
-- spec/logging_spec.rb
 - spec/logger_spec.rb
+- spec/logging_spec.rb
 - spec/ougai_spec.rb
 - spec/spec_helper.rb