ltsv_log_formatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d4ed56403d40372bd8425a8bdd7a2eae1ef845d
+  data.tar.gz: 0f27394f33bf4263789a4b2fc8bb0a7d53d881a6
+SHA512:
+  metadata.gz: 8dc326437d262858bc90cc562696d42993fbbee4c4f779e986c006c4fd1a3ca2b12b239e9924c0fed8bdaaf0c5f3968ffda709e8b1c4a00998fa743013bc4f88
+  data.tar.gz: 53367800112c88b2a5aa46cbc27c03f89a554b68b7916cd1140b0d3e410a06b1a9bbb3fb469f560d332a87153d23b0afa9067126c9ae32fd10c0cdf4cabf1fe5

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+example/log
+

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (2015/04/23)
+
+First version

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rspec'
+gem 'timecop'
+gem 'rake'
+gem 'pry'
+gem 'pry-nav'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Naotoshi Seo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# LtsvLogFormatter
+
+A ruby logger formatter to output log in LTSV format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ltsv_log_formatter'
+
+And then execute:
+
+    $ bundle
+
+## How to use
+
+```ruby
+require 'logger'
+require 'ltsv_log_formatter'
+
+logger = Logger.new(STDOUT)
+logger.formatter = LtsvLogFormatter.new
+```
+
+## Rails
+
+Configure at `config/application.rb`
+
+```ruby
+config.logger.formatter = LtsvLogFormatter.new
+```
+
+## Example
+
+Passing a hash parameter:
+
+```
+irb> logger.info({foo: "bar"})
+time:20150423T00:00:00+09:00\tlevel:INFO\tfoo:bar
+```
+
+Passing a string parameter: `message` key is used as default
+
+```ruby
+irb> logger.info("foo")
+time:20150423T00:00:00+09:00\tlevel:INFO\tmessage:foo
+```
+
+Line feed: Notice that the line feed character `\n` is converted into `\\n`
+
+```ruby
+irb> logger.info("foo\nbar")
+time:20150423T00:00:00+09:00\tlevel:INFO\tmessage:foo\\nbar
+```
+
+## Options
+
+* time_key
+  * Change the key name of the time field. Set `nil` to remove. Default: time
+* level_key
+  * Change the kay name of the level field. Set `nil` to remove. Default: level
+* message_key
+  * Change the kay name for the string (not hash) message. Default: message
+
+Example)
+
+```ruby
+logger.formatter = LtsvLogFormatter.new(time_key: "log_time", level_key: nil)
+```
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+See [LICENSE.txt](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+
+task :test do
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:test) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+  end
+end
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+  sh 'irb -rubygems -I lib -r strftime_logger'
+end
+task :c => :console

data/lib/ltsv_log_formatter.rb

@@ -0,0 +1,37 @@
+require 'time'
+
+class LtsvLogFormatter
+  # for tests
+  attr_reader :opts
+
+  # @param [Hash] opts
+  # @option opts [String] time_key (default: time)
+  # @option opts [String] level_key (default: level)
+  # @option opts [String] message_key (default: message)
+  def initialize(opts={})
+    @opts = opts.map {|k, v| [k.to_sym, v] }.to_h # symbolize_keys
+    @opts[:time_key]      = :time    unless @opts.has_key?(:time_key)
+    @opts[:level_key]     = :level   unless @opts.has_key?(:level_key)
+    @opts[:message_key] ||= :message
+  end
+
+  def call(severity, time, progname, msg)
+    "#{format_time(time)}#{format_severity(severity)}#{format_message(msg)}\n"
+  end
+
+  private
+  def format_time(time)
+    "#{@opts[:time_key]}:#{time.iso8601}\t" if @opts[:time_key]
+  end
+
+  def format_severity(severity)
+    "#{@opts[:level_key]}:#{severity}\t" if @opts[:level_key]
+  end
+
+  def format_message(msg)
+    unless msg.is_a?(Hash)
+      msg = { @opts[:message_key] => msg }
+    end
+    msg.map {|k, v| "#{k}:#{v.to_s.gsub(/\n/, "\\n")}" }.join("\t")
+  end
+end

data/ltsv_log_formatter.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "ltsv_log_formatter"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Naotoshi Seo"]
+  gem.email         = ["sonots@gmail.com"]
+  gem.description   = %q{A logger formatter to output log in LTSV format}
+  gem.summary       = %q{A logger formatter to output log in LTSV format}
+  gem.homepage      = "https://github.com/sonots/ltsv_log_formatter"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/ltsv_log_formatter_spec.rb

@@ -0,0 +1,138 @@
+require_relative 'spec_helper'
+require 'ltsv_log_formatter'
+require 'fileutils'
+require 'logger'
+
+describe LtsvLogFormatter do
+  let(:logger) do
+    Logger.new("#{log_dir}/test.log").tap {|logger|
+      logger.formatter = LtsvLogFormatter.new(opts)
+    }
+  end
+  let(:opts)    { {} }
+  let(:log_dir) { "#{File.dirname(__FILE__)}/log" }
+  let(:now)     { Time.now.iso8601 }
+
+  before do
+    FileUtils.mkdir_p log_dir
+    Timecop.freeze(Time.now)
+  end
+
+  after do
+    FileUtils.rm_rf log_dir
+    Timecop.return
+  end
+
+  def gets
+    File.open("#{log_dir}/test.log") do |f|
+      f.gets # drop the `# Logfile created on ...` line
+      return f.gets
+    end
+  end
+
+  describe 'options' do
+    context '#initialize' do
+      it 'with default' do
+        formatter = LtsvLogFormatter.new
+        expect(formatter.opts[:time_key]).to eql(:time)
+        expect(formatter.opts[:level_key]).to eql(:level)
+        expect(formatter.opts[:message_key]).to eql(:message)
+      end
+
+      it 'with time_key' do
+        formatter = LtsvLogFormatter.new("time_key" => "foo")
+        expect(formatter.opts[:time_key]).to eql("foo")
+      end
+
+      it 'with level_key' do
+        formatter = LtsvLogFormatter.new("level_key" => "foo")
+        expect(formatter.opts[:level_key]).to eql("foo")
+      end
+
+      it 'with message_key' do
+        formatter = LtsvLogFormatter.new("message_key" => "foo")
+        expect(formatter.opts[:message_key]).to eql("foo")
+      end
+    end
+
+    context 'with time_key nil' do
+      let(:opts) { {time_key: nil} }
+
+      it 'should not output a time field' do
+        logger.info("test")
+        expect(gets).to eq "level:INFO\tmessage:test\n"
+      end
+    end
+
+    context 'with level_key nil' do
+      let(:opts) { {level_key: nil} }
+
+      it 'should not output a level field' do
+        logger.info("test")
+        expect(gets).to eq "time:#{now}\tmessage:test\n"
+      end
+    end
+
+    context 'with message_key nil' do
+      let(:opts) { {message_key: nil} }
+
+      it 'should have no effect' do
+        logger.info("test")
+        expect(gets).to eq "time:#{now}\tlevel:INFO\tmessage:test\n"
+      end
+    end
+  end
+
+  describe 'string param' do
+    context 'with default' do
+      it do
+        logger.info("test")
+        expect(gets).to eq "time:#{now}\tlevel:INFO\tmessage:test\n"
+      end
+    end
+
+    context 'with message_key' do
+      let(:opts) { {message_key: "foo"} }
+
+      it do
+        logger.info("test")
+        expect(gets).to eq "time:#{now}\tlevel:INFO\tfoo:test\n"
+      end
+    end
+
+    it 'with line feed' do
+      logger.info("foo\nbar")
+      expect(gets).to eq "time:#{now}\tlevel:INFO\tmessage:foo\\nbar\n"
+    end
+  end
+
+  describe 'hash param' do
+    context 'with default' do
+      it do
+        logger.info(foo: "bar")
+        expect(gets).to eq "time:#{now}\tlevel:INFO\tfoo:bar\n"
+      end
+    end
+
+    it 'with line feed' do
+      logger.info(foo: "foo\nbar")
+      expect(gets).to eq "time:#{now}\tlevel:INFO\tfoo:foo\\nbar\n"
+    end
+  end
+
+  describe 'block param' do
+    context 'with string' do
+      it do
+        logger.info { "test" }
+        expect(gets).to eq "time:#{now}\tlevel:INFO\tmessage:test\n"
+      end
+    end
+
+    context 'with hash' do
+      it do
+        logger.info { {foo: "bar"} }
+        expect(gets).to eq "time:#{now}\tlevel:INFO\tfoo:bar\n"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ltsv_log_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies: []
+description: A logger formatter to output log in LTSV format
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ltsv_log_formatter.rb
+- ltsv_log_formatter.gemspec
+- spec/ltsv_log_formatter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/ltsv_log_formatter
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A logger formatter to output log in LTSV format
+test_files:
+- spec/ltsv_log_formatter_spec.rb
+- spec/spec_helper.rb