ougai 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60ba5446b81c3f2211ccdaf9d4e9e3fb4a5eccf3
-  data.tar.gz: e2ec9ab27c885466024b65920c324d4bb53cce3d
+  metadata.gz: db633bee49261c5ccbd935510e55a44128dc751c
+  data.tar.gz: 4525a5d1f6785e7a92240928eb986a17c7a1c06f
 SHA512:
-  metadata.gz: 5247253014f31ab80f35f6cba271c5ae9e9aa85050262a7e9da66c7c7c0e778c970278bfa9dd0d533ab7e9b9170a0f7e8097eb0cacbc93befe589d0bcb3bed89
-  data.tar.gz: 6b9bc32d51eaa2dd33ca74c7c851bf0cec3e594983de5896b0a515914f78e25e161fc9576d4b23b1627c5afb50e98acaa3cb8f4e59a60de8a893eb1315b7df0e
+  metadata.gz: 2c9635f9cca06b4324cf0796a62069d26f37dcba4dd00f81e897b9d1bb6d8af710221993bafbbda1cb4119ed2df977cc8bafe475c7951a207d7893b0a6cdb5a5
+  data.tar.gz: c4dd71d91605a37dcbe28c64f1086a5db346d642e2acbc23ec31d1bf07724bf016eab4a3d792f72ca6f709402ba871ce29afb6e9df7b2a0d7fa0890840370d0b

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ougai.gemspec
 gemspec
+
+group :test do
+  gem 'awesome_print'
+end

data/README.md

@@ -1,10 +1,12 @@
 Ougai
 =====
 
-[![Build Status](https://travis-ci.org/tilfin/ougai.svg?branch=master)](https://travis-ci.org/tilfin/ougai)
 [![Gem Version](https://badge.fury.io/rb/ougai.svg)](https://badge.fury.io/rb/ougai)
+[![Build Status](https://travis-ci.org/tilfin/ougai.svg?branch=master)](https://travis-ci.org/tilfin/ougai)
 
-A JSON logger is compatible with [bunyan](https://github.com/trentm/node-bunyan) for Node.js
+A JSON logger is capable of handling a message, data or an exception easily.
+It is compatible with [bunyan](https://github.com/trentm/node-bunyan) for Node.js.
+It can also output human readable format for the console.
 
 ## Installation
 
@@ -143,7 +145,7 @@ end
 ```
 
 
-## View log by node-bunyan
+### View log by node-bunyan
 
 Install [bunyan](https://github.com/trentm/node-bunyan) via NPM
 
@@ -169,6 +171,27 @@ $ bunyan output.log
       main.rb:18:in `<main>'
 ```
 
+## Use human Readable formatter for console
+
+Add awesome_print to Gemfile and `bundle`
+
+```ruby
+gem 'awesome_print'
+```
+
+Set *Ougai::Formatters::Readable* instance to `formatter` accessor
+
+```ruby
+require 'rubygems'
+require 'ougai'
+
+logger = Ougai::Logger.new(STDOUT)
+logger.formatter = Ougai::Formatters::Readable.new
+```
+
+### Screen result example
+
+![Screen Shot](https://github.com/tilfin/ougai/blob/images/ougai_readable_format.png?raw=true))
 
 ## License
 

data/lib/ougai.rb

@@ -1,120 +1,5 @@
-require "ougai/version"
-require 'logger'
-require 'socket'
-require 'time'
-require 'json'
-
-module Ougai
-  class Logger < Logger
-    attr_accessor :default_message, :app_name
-    attr_accessor :ex_key, :ex_trace_indent
-
-    def initialize(*args)
-      super(*args)
-      @default_message = 'No message'
-      @app_name = File.basename($0, ".rb")
-      @hostname = Socket.gethostname
-      @ex_key = :err
-      @ex_trace_indent = 2
-      @formatter = create_formatter
-    end
-
-    def debug(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
-    end
-
-    def info(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
-    end
-
-    def warn(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
-    end
-
-    def error(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
-    end
-
-    def fatal(message, ex = nil, data = nil)
-      super(to_item(message, ex, data))
-    end
-
-    protected
-
-    def create_formatter
-      proc do |severity, time, progname, data|
-        JSON.generate({
-          name: progname || @app_name,
-          hostname: @hostname,
-          pid: $$,
-          level: to_level(severity),
-          time: time.iso8601(3),
-          v: 0
-        }.merge(data)) + "\n"
-      end
-    end
-
-    private
-
-    def to_item(msg, ex, data)
-      item = {}
-      if ex.nil?       # 1 arg
-        if msg.is_a?(Exception)
-          item[:msg] = msg.to_s
-          item[@ex_key] = serialize_ex(msg)
-        elsif msg.is_a?(Hash)
-          item[:msg] = @default_message unless msg.key?(:msg)
-          item.merge!(msg)
-        else
-          item[:msg] = msg.to_s
-        end
-      elsif data.nil?  # 2 args
-        if ex.is_a?(Exception)
-          item[:msg] = msg.to_s
-          item[@ex_key] = serialize_ex(ex)
-        elsif ex.is_a?(Hash)
-          item.merge!(ex)
-          if msg.is_a?(Exception)
-            item[@ex_key] = serialize_ex(msg)
-          else
-            item[:msg] = msg.to_s
-          end
-        end
-      elsif msg        # 3 args
-        item[@ex_key] = serialize_ex(ex) if ex.is_a?(Exception)
-        item.merge!(data) if data.is_a?(Hash)
-        item[:msg] = msg.to_s
-      else             # No args
-        item[:msg] = @default_message
-      end
-      item
-    end
-
-    def serialize_ex(ex)
-      err = {
-        name: ex.class.name,
-        message: ex.to_s
-      }
-      if ex.backtrace
-        sp = "\n" + ' ' * @ex_trace_indent
-        err[:stack] = ex.backtrace.join(sp)
-      end
-      err
-    end
-
-    def to_level(severity)
-      case severity
-      when 'INFO'
-        30
-      when 'WARN'
-        40
-      when 'ERROR'
-        50
-      when 'FATAL'
-        60
-      else # DEBUG
-        20
-      end
-    end
-  end
-end
+require 'ougai/version'
+require 'ougai/formatters/base'
+require 'ougai/formatters/bunyan'
+require 'ougai/formatters/readable'
+require 'ougai/logger'

data/lib/ougai/formatters/base.rb

@@ -0,0 +1,34 @@
+require 'logger'
+require 'time'
+require 'socket'
+
+module Ougai
+  module Formatters
+    class Base < Logger::Formatter
+      attr_accessor :trace_indent, :trace_max_lines
+
+      def initialize(app_name = nil, hostname = nil)
+        @app_name = app_name || File.basename($0, ".rb")
+        @hostname = hostname || Socket.gethostname
+        @trace_indent = 2
+        @trace_max_lines = 100
+      end
+
+      def serialize_exc(ex)
+        err = {
+          name: ex.class.name,
+          message: ex.to_s
+        }
+        if ex.backtrace
+          err[:stack] = serialize_trace(ex.backtrace)
+        end
+        err
+      end
+
+      def serialize_trace(trace)
+        sp = "\n" + ' ' * @trace_indent
+        trace.slice(0, @trace_max_lines).join(sp)
+      end
+    end
+  end
+end

data/lib/ougai/formatters/bunyan.rb

@@ -0,0 +1,34 @@
+require 'ougai/formatters/base'
+require 'json'
+
+module Ougai
+  module Formatters
+    class Bunyan < Base
+      def call(severity, time, progname, data)
+        JSON.generate({
+          name: progname || @app_name,
+          hostname: @hostname,
+          pid: $$,
+          level: to_level(severity),
+          time: time.iso8601(3),
+          v: 0
+        }.merge(data)) + "\n"
+      end
+
+      def to_level(severity)
+        case severity
+        when 'INFO'
+          30
+        when 'WARN'
+          40
+        when 'ERROR'
+          50
+        when 'FATAL'
+          60
+        else # DEBUG
+          20
+        end
+      end
+    end
+  end
+end

data/lib/ougai/formatters/readable.rb

@@ -0,0 +1,53 @@
+require 'ougai/formatters/base'
+
+module Ougai
+  module Formatters
+    class Readable < Base
+      def initialize(app_name = nil, hostname = nil)
+        super(app_name, hostname)
+        @trace_indent = 4
+        load_dependency
+      end
+
+      def call(severity, time, progname, data)
+        msg = data.delete(:msg)
+        strs = ["[#{time.iso8601(3)}] #{colored_level(severity)}: #{msg}"]
+        if data.key?(:err)
+          err = data.delete(:err)
+          err_str = "  #{err[:name]} (#{err[:message]}):"
+          err_str += "\n    " + err[:stack] if err.key?(:stack)
+          strs.push(err_str)
+        end
+        unless data.empty?
+          strs.push(data.ai)
+        end
+        strs.join("\n") + "\n"
+      end
+
+      def colored_level(severity)
+        case severity
+        when 'INFO'
+          color = '0;36'
+        when 'WARN'
+          color = '0;33'
+        when 'ERROR'
+          color = '0;31'
+        when 'FATAL'
+          color = '0;35'
+        else # DEBUG
+          color = '0;37'
+        end
+        "\e[#{color}m#{severity}\e[0m"
+      end
+
+      private
+
+      def load_dependency
+        require 'awesome_print'
+      rescue LoadError
+        puts 'You must install the awesome_print gem to use this output.'
+        raise
+      end
+    end
+  end
+end

data/lib/ougai/logger.rb

@@ -0,0 +1,81 @@
+require 'ougai/formatters/bunyan'
+require 'logger'
+
+module Ougai
+  class Logger < ::Logger
+    attr_accessor :default_message, :exc_key
+
+    def initialize(*args)
+      super(*args)
+      @default_message = 'No message'
+      @exc_key = :err
+      @formatter = create_formatter
+    end
+
+    def debug(message, ex = nil, data = nil)
+      super(to_item(message, ex, data))
+    end
+
+    def info(message, ex = nil, data = nil)
+      super(to_item(message, ex, data))
+    end
+
+    def warn(message, ex = nil, data = nil)
+      super(to_item(message, ex, data))
+    end
+
+    def error(message, ex = nil, data = nil)
+      super(to_item(message, ex, data))
+    end
+
+    def fatal(message, ex = nil, data = nil)
+      super(to_item(message, ex, data))
+    end
+
+    protected
+
+    def create_formatter
+      Formatters::Bunyan.new
+    end
+
+    private
+
+    def to_item(msg, ex, data)
+      item = {}
+      if ex.nil?       # 1 arg
+        if msg.is_a?(Exception)
+          item[:msg] = msg.to_s
+          set_exc(item, msg)
+        elsif msg.is_a?(Hash)
+          item[:msg] = @default_message unless msg.key?(:msg)
+          item.merge!(msg)
+        else
+          item[:msg] = msg.to_s
+        end
+      elsif data.nil?  # 2 args
+        if ex.is_a?(Exception)
+          item[:msg] = msg.to_s
+          set_exc(item, ex)
+        elsif ex.is_a?(Hash)
+          item.merge!(ex)
+          if msg.is_a?(Exception)
+            set_exc(item, msg)
+          else
+            item[:msg] = msg.to_s
+          end
+        end
+      elsif msg        # 3 args
+        set_exc(item, ex) if ex.is_a?(Exception)
+        item.merge!(data) if data.is_a?(Hash)
+        item[:msg] = msg.to_s
+      else             # No args
+        item[:msg] = @default_message
+      end
+      item
+    end
+
+    def set_exc(item, exc)
+      item[@exc_key] = @formatter.serialize_exc(exc)
+    end
+  end
+end

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = "0.3.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,10 @@ files:
 - README.md
 - Rakefile
 - lib/ougai.rb
+- lib/ougai/formatters/base.rb
+- lib/ougai/formatters/bunyan.rb
+- lib/ougai/formatters/readable.rb
+- lib/ougai/logger.rb
 - lib/ougai/version.rb
 - ougai.gemspec
 homepage: https://github.com/tilfin/ougai