tidy_logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16454c5ba23f0c8f1092e362781dbb6d7b291d5e
+  data.tar.gz: f0a20d306e31b0e22154b953d4caabaaf7922d80
+SHA512:
+  metadata.gz: 1062ea6dc380d9fbe8f69400ef2ccb6d531f15346d73b96af9bedf03ecf40d2aeed74c7fdfa6f4405b454477510e33cda791610773a4c6be95d9b63ec730b412
+  data.tar.gz: 7cf680f589e5e8a6c903d91a1d2c7573332174ba2aac9b4246aadab4ef810160fe127a46363f9386374da610dcea4ac6def5f1ffa9c3d0771e1f6a07d3c2039d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+before_install: gem install bundler

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kenn Ejima
+
+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,29 @@
+# TidyLogger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tidy_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tidy_logger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/test*.rb'
+end
+task :default => :test

data/lib/tidy_logger.rb

@@ -0,0 +1,59 @@
+require 'logger'
+
+class TidyLogger < ::Logger
+  def initialize(*args)
+    super
+    @formatter = Formatter.new
+  end
+
+  def config(options = :time_and_level)
+    case options
+    when Symbol
+      options = { type: options }
+    when Hash
+      options[:type] = :time_and_level  if options[:type].nil?
+      options[:type] = :title           if options[:title]
+    when Proc
+      options = { type: options }
+    else
+      raise Error, "invalid options: #{options.inspect}"
+    end
+
+    self.formatter.type             = options[:type]
+    self.level                      = options[:level] || Logger::INFO
+    self.formatter.datetime_format  = options[:datetime_format] || '%Y-%m-%dT%H:%M:%S'
+    self.formatter.title            = options[:title]
+    self
+  end
+
+  class Formatter < ::Logger::Formatter
+    attr_accessor :type, :title
+
+    def call(severity, time, progname, msg)
+      case @type
+      when Proc
+        instance_exec(severity, time, progname, msg, &@type)
+      when :plain
+        "#{stringify(msg)}\n"
+      when :title
+        "[#{@title}] #{stringify(msg)}\n"
+      when :time
+        "[#{format_datetime(time)}] #{stringify(msg)}\n"
+      when :time_and_level
+        "[%s] %5s : %s\n" % [format_datetime(time), severity, stringify(msg)]
+      when :ltsv
+        raise Error, "ltsv logger only takes Hash" unless msg.is_a?(Hash)
+        msg.map{|k,v| "#{k}:#{v}" }.join("\t") << "\n"
+      else
+        # default stdlib logger format
+        "%s, [%s#%d] %5s -- %s: %s\n" % [severity[0..0], format_datetime(time), $$, severity, progname, msg2str(msg)]
+      end
+    end
+
+    def stringify(msg)
+      String === msg ? msg : msg.inspect
+    end
+  end
+
+  Error = Class.new(StandardError)
+end

data/lib/tidy_logger/version.rb

@@ -0,0 +1,3 @@
+class TidyLogger
+  VERSION = '1.0.0'
+end

data/test/test_tidy_logger.rb

@@ -0,0 +1,62 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'tidy_logger'
+require 'stringio'
+require 'time'
+
+class TestTidyLogger < MiniTest::Unit::TestCase
+  def setup
+    @io = StringIO.new
+    @logger = TidyLogger.new(@io)
+  end
+
+  def test_default_format
+    @logger.info 'buzz'
+    assert @io.string =~ /^I, \[(\S+) #\d+\]  INFO -- : buzz$/, 'format mismatch'
+    assert_instance_of Time, Time.iso8601($1)
+  end
+
+  def test_skip_debug_by_default
+    @logger.config
+    @logger.debug 'buzz'
+    assert_equal '', @io.string
+  end
+
+  def test_time_and_level
+    @logger.config
+    @logger.info 'buzz'
+    assert @io.string =~ /^\[(\S+)\]  INFO : buzz$/, 'format mismatch'
+    assert_instance_of Time, Time.iso8601($1)
+  end
+
+  def test_plain
+    @logger.config(:plain)
+    @logger.info 'buzz'
+    assert_equal "buzz\n", @io.string
+  end
+
+  def test_title
+    @logger.config(:title => 'fizz')
+    @logger.info 'buzz'
+    assert_equal "[fizz] buzz\n", @io.string
+  end
+
+  def test_time
+    @logger.config(:time)
+    @logger.info 'buzz'
+    assert @io.string =~ /^\[(\S+)\] buzz$/, 'format mismatch'
+    assert_instance_of Time, Time.iso8601($1)
+  end
+
+  def test_ltsv
+    @logger.config(:ltsv)
+    @logger.info :fizz => 1, :buzz => 2
+    assert_equal "fizz:1\tbuzz:2\n", @io.string
+  end
+
+  def test_lambda
+    @logger.config(lambda{|_,_,_,msg| "||do crazy stuff|| #{msg2str(msg)}\n" })
+    @logger.info 'buzz'
+    assert_equal "||do crazy stuff|| buzz\n", @io.string
+  end
+end

data/tidy_logger.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tidy_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tidy_logger'
+  spec.version       = TidyLogger::VERSION
+  spec.authors       = ['Kenn Ejima']
+  spec.email         = ['kenn.ejima@gmail.com']
+  spec.description   = %q{TidyLogger: Logger on Steroids}
+  spec.summary       = %q{TidyLogger: Logger on Steroids}
+  spec.homepage      = 'https://github.com/kenn/tidy_logger'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: tidy_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kenn Ejima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'TidyLogger: Logger on Steroids'
+email:
+- kenn.ejima@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tidy_logger.rb
+- lib/tidy_logger/version.rb
+- test/test_tidy_logger.rb
+- tidy_logger.gemspec
+homepage: https://github.com/kenn/tidy_logger
+licenses:
+- MIT
+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.0.3
+signing_key: 
+specification_version: 4
+summary: 'TidyLogger: Logger on Steroids'
+test_files:
+- test/test_tidy_logger.rb
+has_rdoc: