ougai 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 607cde7c3045e9fcbd0ca91cf1a6ad91bade32cb
-  data.tar.gz: ddbc3d91e07a00c197ef231ef47e3544effc47b4
+  metadata.gz: 234c84c3f7a6eaf7d2dd0ab32c55d4ffa8afda98
+  data.tar.gz: 98776af529bf24129daa4826d19d490946fea410
 SHA512:
-  metadata.gz: 8da96a24f57a2ce240292a51d19e63d1595d294ca9139fd6846e413c0d08ef60167d43952dc6987e6544aaedbdbae5d0a1951a1a35948fc5c2d8f419dd680ba5
-  data.tar.gz: dc281f50f0543c07a843dce4064510b153fc60c4823dbcc227b4deaa5f60869333de102abeab10176e169f3ec755daf53b20236bac7fc96bc8e37a1cb0a8c857
+  metadata.gz: 370dfb4b6d00241c264f29832347ec9184ce453f2287cc62392cbd8338d0110e0676da2b42ae48fe4c97e1a0f4ed8ee4433b13eb056e566354d41b9766e71925
+  data.tar.gz: 637d1b0e58e79d4531b2981728cd8f4109f64b7a8e28ee188fa34f31b11f51e3d86e7abbff3c66d38900752801addde63a0b3f0d07891bfaf9c9befe1d8c43f7

data/.travis.yml

@@ -2,4 +2,6 @@ language: ruby
 rvm:
   - 2.1.0
   - 2.2.3
+  - 2.3.4
+  - 2.4.1
 before_install: gem install bundler -v 1.11.2

data/README.md

@@ -144,6 +144,28 @@ end
 {"name":"main","hostname":"mint","pid":14607,"level":50,"time":"2016-10-16T22:26:48.836+09:00","v":0,"msg":"Caught error","err":{"name":"ZeroDivisionError","message":"divided by 0","stack":"main.rb:18:in `/'\n ...'"},"reason":"zero spec"}
 ```
 
+### logs with blocks
+
+```ruby
+logger.info { 'Hello!' }
+
+logger.debug do
+  ['User dump', { name: 'Taro', age: 15 }]
+end
+
+logger.error do
+  ['Failed to fetch info', ex, { id: 10 }]
+end
+
+loggger.fatal { ex }
+
+loggger.fatal do
+  ['Unexpected', ex]
+end
+```
+
+To specify more than one of a message, an exception and custom data, the block returns them as an array.
+
 
 ## View log by node-bunyan
 
@@ -197,6 +219,33 @@ logger.formatter = Ougai::Formatters::Readable.new
 
 ## Use on Rails
 
+### Define a custom logger
+
+Add following code to `lib/your_app/logger.rb`
+A custom logger includes LoggerSilence because Rails logger must support `silence` feature.
+
+```ruby
+module YourApp
+  class Logger < Ougai::Logger
+    include ActiveSupport::LoggerThreadSafeLevel
+    include LoggerSilence
+
+    def initialize(*args)
+      super
+      after_initialize if respond_to? :after_initialize
+    end
+
+    def create_formatter
+      if Rails.env.development? || Rails.env.test?
+        Ougai::Formatters::Readable.new
+      else
+        Ougai::Formatters::Bunyan.new
+      end
+    end
+  end
+end
+```
+
 ### for Development
 
 Add following code to `config/environments/development.rb`
@@ -205,9 +254,7 @@ Add following code to `config/environments/development.rb`
 Rails.application.configure do
   ...
 
-  logger = Ougai::Logger.new(STDOUT)
-  logger.formatter = Ougai::Formatters::Readable.new
-  config.logger = logger
+  config.logger = YourApp::Logger.new(STDOUT)
 end
 ```
 
@@ -220,9 +267,9 @@ Rails.application.configure do
   ...
 
   if ENV["RAILS_LOG_TO_STDOUT"].present?
-    config.logger = Ougai::Logger.new(STDOUT)
+    config.logger = YourApp::Logger.new(STDOUT)
   else
-    config.logger = Ougai::Logger.new(config.paths['log'].first)
+    config.logger = YourApp::Logger.new(config.paths['log'].first)
   end
 end
 ```

data/lib/ougai/logger.rb

@@ -12,24 +12,53 @@ module Ougai
       @formatter = create_formatter
     end
 
-    def debug(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
+    def debug(message = nil, ex = nil, data = nil, &block)
+      return true if level > DEBUG
+      if block_given?
+        args = yield
+      else
+        args = [message, ex, data]
+      end
+      super(to_item(args), &nil)
     end
 
-    def info(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
+    def info(message = nil, ex = nil, data = nil)
+      return true if level > INFO
+      if block_given?
+        args = yield
+      else
+        args = [message, ex, data]
+      end
+      super(to_item(args), &nil)
     end
 
-    def warn(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
+    def warn(message = nil, ex = nil, data = nil)
+      return true if level > WARN
+      if block_given?
+        args = yield
+      else
+        args = [message, ex, data]
+      end
+      super(to_item(args), &nil)
     end
 
-    def error(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
+    def error(message = nil, ex = nil, data = nil)
+      return true if level > ERROR
+      if block_given?
+        args = yield
+      else
+        args = [message, ex, data]
+      end
+      super(to_item(args), &nil)
     end
 
-    def fatal(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
+    def fatal(message = nil, ex = nil, data = nil)
+      if block_given?
+        args = yield
+      else
+        args = [message, ex, data]
+      end
+      super(to_item(args), &nil)
     end
 
     def self.broadcast(logger)
@@ -53,7 +82,9 @@ module Ougai
 
     private
 
-    def to_item(msg, ex, data)
+    def to_item(args)
+      msg, ex, data = args
+
       item = {}
       if ex.nil?       # 1 arg
         if msg.is_a?(Exception)

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = "0.7.4"
+  VERSION = "0.8.0"
 end

metadata

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