ougai 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 207074987e412815fd6fbb4acb718da9b4451c95
-  data.tar.gz: 1e0d8320ba60fcd41c87c0dfb575cabc6cd77683
+  metadata.gz: 19d87c28c425031fb5819e07593210f5078ef857
+  data.tar.gz: 4dce59c9d66c03394b471e72715dfbf131cb6720
 SHA512:
-  metadata.gz: 5ebf1a15410b890788c3ff9ea531d05286ec447c479bd348491a08a1735fa46d64783f805c84eedb31e73c074fa02b449c5deb2eb7a78321f493cb181696b092
-  data.tar.gz: 2c3e322ba81f980a55572b31aebbdc753636db5cd394fadbf1a107e160e8c9e6c74a228c64aa3d5820455744f2d37bdbccb1e4decda40daa2e9bb46c44e0b8c9
+  metadata.gz: aefa5448b0a64c2332ee30f7432fa6c941c929da5393a94ce664b0248723f1c4c7fb5a70e47c0e49864863b8cddba5ef1d5a41ae50032ec304db753fce831d85
+  data.tar.gz: 603ec53229871b4ea8df521a35873a37842a96b3fd8bc7a3a8542a26a8737f5b10f21f22f44eea77bc45031bdcf7b5db74d6a2759d949ab870731f11155f5ab5

data/lib/ougai/formatters/base.rb

@@ -1,4 +1,3 @@
-require 'logger'
 require 'time'
 require 'socket'
 
@@ -13,6 +12,11 @@ module Ougai
         @hostname = hostname || Socket.gethostname.force_encoding('UTF-8')
         @trace_indent = 2
         @trace_max_lines = 100
+        self.datetime_format = nil
+      end
+
+      def datetime_format=(value)
+        @datetime_format = value || default_datetime_format
       end
 
       def serialize_exc(ex)
@@ -30,6 +34,19 @@ module Ougai
         sp = "\n" + ' ' * @trace_indent
         trace.slice(0, @trace_max_lines).join(sp)
       end
+
+      private
+
+      def format_datetime(time)
+        time.strftime(@datetime_format)
+      end
+
+      def default_datetime_format
+        t = Time.new
+        f = '%FT%T.%3N'
+        f << (t.utc? ? 'Z' : '%:z')
+        f.freeze
+      end
     end
   end
 end

data/lib/ougai/formatters/bunyan.rb

@@ -49,7 +49,7 @@ module Ougai
 
       def dump(data)
         return data unless @jsonize
-        data[:time] = data[:time].iso8601(3)
+        data[:time] = format_datetime(data[:time])
         str = JSON.generate(data)
         str << "\n" if @with_newline
         str

data/lib/ougai/formatters/readable.rb

@@ -20,7 +20,7 @@ module Ougai
       def call(severity, time, progname, data)
         msg = data.delete(:msg)
         level = @plain ? severity : colored_level(severity)
-        strs = ["[#{time.iso8601(3)}] #{level}: #{msg}"]
+        strs = ["[#{format_datetime(time)}] #{level}: #{msg}"]
         if err_str = create_err_str(data)
           strs.push(err_str)
         end

data/lib/ougai/logger.rb

@@ -21,7 +21,7 @@ module Ougai
     # @param logger [Logger] The logger receiving broadcast logs.
     def self.broadcast(logger)
       Module.new do |mdl|
-        ::Logger::Severity.constants.each do |severity|
+        Logger::Severity.constants.each do |severity|
           method_name = severity.downcase.to_sym
 
           mdl.send(:define_method, method_name) do |*args|

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = "1.5.0"
+  VERSION = "1.5.2"
 end

data/spec/formatters/base_spec.rb

@@ -3,6 +3,24 @@ require 'spec_helper'
 describe Ougai::Formatters::Base do
   subject { described_class.new(app_name, hostname) }
 
+  context 'default' do
+    let (:app_name) { nil }
+    let (:hostname) { nil }
+
+    it 'has datetime format default ISO8601' do
+      expect(subject.datetime_format).to match(/^\%FT\%T\.\%3N(Z|\%\:z)$/)
+    end
+
+    it 'has datetime_format accessor' do
+      subject.datetime_format = '%I:%M:%S %p'
+      expect(subject.datetime_format).to eq('%I:%M:%S %p')
+
+      # revert default format by to set nil
+      subject.datetime_format = nil
+      expect(subject.datetime_format).to match(/^\%FT\%T\.\%3N(Z|\%\:z)$/)
+    end
+  end
+
   context 'without arguments and hostname contains a UTF-8 char' do
     let (:app_name) { nil }
     let (:hostname) { nil }

data/spec/formatters/bunyan_spec.rb

@@ -114,4 +114,20 @@ describe Ougai::Formatters::Bunyan do
     end
   end
 
+  describe '#datetime_format' do
+    subject do
+      formatter.call('DEBUG', Time.now, nil, data)
+    end
+
+    context 'is time AM/PM format' do
+      before do
+        formatter.datetime_format = '%I:%M:%S %p'
+      end
+
+      it 'applys output' do
+        result = JSON.parse(subject, symbolize_names: true)
+        expect(result[:time]).to match(/^\d{2}:\d{2}:\d{2} [AP]M$/)
+      end
+    end
+  end
 end

data/spec/formatters/readable_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe Ougai::Formatters::Readable do
+  let!(:re_start_with_datetime) { /^\[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}(Z|[\+\-\:0-9]{4,6})]/ }
+
   let(:data) do
     {
       msg: 'Log Message!',
@@ -18,62 +20,73 @@ describe Ougai::Formatters::Readable do
     }
   end
 
+  let(:formatter) { described_class.new }
+
   context 'when severity is TRACE' do
-    subject { described_class.new.call('TRACE', Time.now, nil, data) }
+    subject { formatter.call('TRACE', Time.now, nil, data) }
 
     it 'includes valid strings' do
+      expect(subject).to match(re_start_with_datetime)
       expect(subject).to include("\e[0;34mTRACE\e[0m: Log Message!")
       expect(subject.gsub(/\e\[([;\d]+)?m/, '')).to include(':status => 200')
     end
   end
 
   context 'when severity is DEBUG' do
-    subject { described_class.new.call('DEBUG', Time.now, nil, data) }
+    subject { formatter.call('DEBUG', Time.now, nil, data) }
 
     it 'includes valid strings' do
+      expect(subject).to match(re_start_with_datetime)
       expect(subject).to include("\e[0;37mDEBUG\e[0m: Log Message!")
       expect(subject.gsub(/\e\[([;\d]+)?m/, '')).to include(':status => 200')
     end
   end
 
   context 'when severity is INFO' do
-    subject { described_class.new.call('INFO', Time.now, nil, data) }
+    subject { formatter.call('INFO', Time.now, nil, data) }
 
     it 'includes valid strings' do
+      expect(subject).to match(re_start_with_datetime)
       expect(subject).to include("\e[0;36mINFO\e[0m: Log Message!")
       expect(subject.gsub(/\e\[([;\d]+)?m/, '')).to include(':method => "GET"')
     end
   end
 
   context 'when severity is WARN' do
-    subject { described_class.new.call('WARN', Time.now, nil, data) }
+    subject { formatter.call('WARN', Time.now, nil, data) }
 
     it 'includes valid strings' do
+      expect(subject).to match(re_start_with_datetime)
       expect(subject).to include("\e[0;33mWARN\e[0m: Log Message!")
       expect(subject.gsub(/\e\[([;\d]+)?m/, '')).to include(':path => "/"')
     end
   end
 
   context 'when severity is ERROR' do
-    subject { described_class.new.call('ERROR', Time.now, nil, data.merge({ err: err })) }
+    subject { formatter.call('ERROR', Time.now, nil, data.merge({ err: err })) }
 
     it 'includes valid strings' do
+      expect(subject).to match(re_start_with_datetime)
       expect(subject).to include("\e[0;31mERROR\e[0m: Log Message!")
       expect(subject.gsub(/\e\[([;\d]+)?m/, '')).to include('DummyError (it is dummy.):')
     end
   end
 
   context 'when severity is FATAL' do
-    subject { described_class.new.call('FATAL', Time.now, nil, { msg: 'TheEnd', err: err }) }
+    subject { formatter.call('FATAL', Time.now, nil, { msg: 'TheEnd', err: err }) }
+
     it 'includes valid strings' do
+      expect(subject).to match(re_start_with_datetime)
       expect(subject).to include("\e[0;35mFATAL\e[0m: TheEnd")
       expect(subject.gsub(/\e\[([;\d]+)?m/, '')).to include("error1.rb\n  error2.rb")
     end
   end
 
   context 'when severity is UNKNOWN' do
-    subject { described_class.new.call('ANY', Time.now, nil, { msg: 'unknown msg' }) }
+    subject { formatter.call('ANY', Time.now, nil, { msg: 'unknown msg' }) }
+
     it 'includes valid strings' do
+      expect(subject).to match(re_start_with_datetime)
       expect(subject).to include("\e[0;32mANY\e[0m: unknown msg")
     end
   end
@@ -91,4 +104,20 @@ describe Ougai::Formatters::Readable do
       expect(plain_subject).not_to include(':method => "GET"')
     end
   end
+
+  describe '#datetime_format' do
+    subject do
+      formatter.call('DEBUG', Time.now, nil, data)
+    end
+
+    context 'is time AM/PM format' do
+      before do
+        formatter.datetime_format = '%I:%M:%S %p'
+      end
+
+      it 'applys output' do
+        expect(subject).to match(/^\[\d{2}:\d{2}:\d{2} [AP]M\]/)
+      end
+    end
+  end
 end

data/spec/logger_spec.rb

@@ -565,6 +565,12 @@ describe Ougai::Logger do
         logger.level = Logger::INFO # propagate severity to another one
       end
 
+      it 'does not output trace log on both loggers' do
+        logger.trace(log_msg, foo: 0)
+        expect(item).to be_nil
+        expect(another_item).to be_nil
+      end
+
       it 'does not output debug log on both loggers' do
         logger.debug(log_msg, foo: 1)
         expect(item).to be_nil
@@ -602,20 +608,20 @@ describe Ougai::Logger do
 
     context 'another logger level is lower than original one' do
       before do
-        logger.level = Logger::INFO
-        another_logger.level = Logger::DEBUG
+        logger.level = Logger::DEBUG
+        another_logger.level = :trace
       end
 
-      it 'outputs debug log on only another logger' do
-        logger.debug(log_msg)
+      it 'does not output trace log on both loggers' do
+        logger.trace(log_msg)
         expect(item).to be_nil
-        expect(another_item).to be_log_message(log_msg, 20)
+        expect(another_item).to be_log_message(log_msg, 10)
       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)
+      it 'outputs debug log on both loggers' do
+        logger.debug(log_msg)
+        expect(item).to be_log_message(log_msg, 20)
+        expect(another_item).to be_log_message(log_msg, 20)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-03 00:00:00.000000000 Z
+date: 2017-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler