ltsv-logger 0.0.2

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ltsv-logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 togo
+
+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,61 @@
+# LTSV::Logger
+
+Logger for LTSV(Labeled Tab-separated Values) format.
+See http://ltsv.org/ about LTSV.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ltsv-logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ltsv-logger
+
+## Usage
+
+Use `Hash` instead of `String` message:
+
+```ruby
+# e.g.: rails
+require 'ltsv-logger'
+
+LTSV::Logger.open(File.join('log', "event_#{Rails.env}.log"))
+ltsv = { method: "GET", uri: "/foo", status: 200 }
+LTSV.logger.info ltsv # => time:2013-04-02 21:55:05 +0900 method:GET uri:/?max_id=9235&page=2 status:200
+
+```
+
+If logging `Hash` like request parameters, serialize `Hash`. e.g.:`Hash.to_json`:
+
+```ruby
+# e.g.: rails
+# params = { max_id: 9235, page: 2, controller: 'foo', action: 'bar' }
+
+ltsv = { method: "GET", uri: "/?max_id=9235&page=2", status: 200, params: params.to_json }
+LTSV.logger.info ltsv # => time:2013-04-02 21:55:05 +0900 method:GET uri:/?max_id=9235&page=2 status:200 params:{"max_id":"9235","page":"2","controller":"foo","action":"bar"}
+```
+
+Maybe, to use `Marshal` is not good, because it's difficult to deserialize with other programe launguage.
+
+Other way, you can use `String`, as usual:
+
+```ruby
+LTSV.logger.info "This is sample." # => time:2013-04-02 21:55:05 +0900 message:This is sample.
+```
+
+## 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
+
+## Copyright
+Copyright © 2013 terut. See LICENSE.txt(MIT-LICENCE) for further details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ltsv-logger.rb

@@ -0,0 +1,23 @@
+require "ltsv-logger/version"
+
+module LTSV
+  module Logger
+    require 'ltsv-logger/logger'
+    class LTSVLoggerError < StandardError; end
+
+    class << self
+      attr_accessor :logger
+
+      def open(name)
+        self.logger = Logger.new(name)
+      end
+    end
+  end
+
+  # shortcut method
+  class << self
+    def logger
+      LTSV::Logger.logger
+    end
+  end
+end

data/lib/ltsv-logger/logger.rb

@@ -0,0 +1,24 @@
+require 'logger'
+module LTSV
+  module Logger
+    class Logger < ::Logger
+      def initialize(*args)
+        super
+        @formatter = LTSVFormatter.new
+      end
+
+      class LTSVFormatter < ::Logger::Formatter
+        def call(severity, timestamp, progname, msg)
+          raws = ["time:#{timestamp}"]
+          case msg
+          when Hash
+            raws = msg.inject(raws) { |h, (key, value)| h << "#{key}:#{value}"; h }
+          when String
+            raws << "message:#{msg}"  
+          end
+          "#{raws.join("\t")}\n"
+        end
+      end
+    end
+  end
+end

data/lib/ltsv-logger/version.rb

@@ -0,0 +1,5 @@
+module LTSV
+  module Logger
+    VERSION = "0.0.2"
+  end
+end

data/ltsv-logger.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ltsv-logger/version'
+
+Gem::Specification.new do |gem|
+  gem.name                  = "ltsv-logger"
+  gem.version               = LTSV::Logger::VERSION
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.authors               = ["terut"]
+  gem.email                 = ["terut.dev+github@gmail.com"]
+  gem.description           = %q{LTSV(Labeled Tab-separated Values) logger}
+  gem.summary               = %q{LTSV(Labeled Tab-separated Values) logger}
+  gem.homepage              = "http://terut.github.com/ltsv-logger"
+
+  gem.add_development_dependency('rake', '~> 10.0.0')
+  gem.add_development_dependency('rspec', '~> 2.13.0')
+
+  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/logger_spec.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe LTSV::Logger::Logger do
+  context '#initialize' do
+    let(:logger) { LTSV::Logger::Logger.new(RSpec.configuration.test_log_path) }
+
+    it 'formatter class is LTSVFormatter' do
+      logger.formatter.should be_an_instance_of(LTSV::Logger::Logger::LTSVFormatter)
+    end
+  end
+end
+
+describe LTSV::Logger::Logger::LTSVFormatter do
+  context '#call' do
+    let(:logger) { LTSV::Logger::Logger.new(RSpec.configuration.test_log_path) }
+    let(:formatter) { LTSV::Logger::Logger::LTSVFormatter.new }
+
+    it 'return ltsv when argument is Hash' do
+      time = Time.now
+      msg = { foo: 'foo1', bar: 'bar1' }
+      formatter.call(logger.level, time, 'hoge', msg).should eq("time:#{time}\tfoo:foo1\tbar:bar1\n")
+    end
+
+    it 'return ltsv when argument is String' do
+      time = Time.now
+      msg = "foo"
+      formatter.call(logger.level, time, 'hoge', msg).should eq("time:#{time}\tmessage:foo\n")
+    end
+  end
+end

data/spec/ltsv-logger_spec.rb

@@ -0,0 +1,30 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe LTSV do
+  context 'shortcut method' do
+    context '.logger' do
+      before do
+        LTSV::Logger.open(RSpec.configuration.test_log_path)
+      end
+
+      it 'module has logger instance' do
+        LTSV.logger.should be_an_instance_of(LTSV::Logger::Logger)
+      end
+    end
+  end
+end
+
+describe LTSV::Logger do
+  context 'logger method' do
+    context '.open' do
+      before do
+        LTSV::Logger.open(RSpec.configuration.test_log_path)
+      end
+
+      it 'module has logger instance' do
+        LTSV::Logger.logger.should be_an_instance_of(LTSV::Logger::Logger)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'bundler/setup'
+Bundler.require
+require 'ltsv-logger'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.add_setting :test_log_path, default: "#{File.expand_path('../', __FILE__)}/support/test.log"
+
+  config.after do
+    File.delete(config.test_log_path) if File.exist?(config.test_log_path)
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ltsv-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- terut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: LTSV(Labeled Tab-separated Values) logger
+email:
+- terut.dev+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ltsv-logger.rb
+- lib/ltsv-logger/logger.rb
+- lib/ltsv-logger/version.rb
+- ltsv-logger.gemspec
+- spec/logger_spec.rb
+- spec/ltsv-logger_spec.rb
+- spec/spec_helper.rb
+homepage: http://terut.github.com/ltsv-logger
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3976200979359774974
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: LTSV(Labeled Tab-separated Values) logger
+test_files:
+- spec/logger_spec.rb
+- spec/ltsv-logger_spec.rb
+- spec/spec_helper.rb