tidy_logger 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16454c5ba23f0c8f1092e362781dbb6d7b291d5e
-  data.tar.gz: f0a20d306e31b0e22154b953d4caabaaf7922d80
+  metadata.gz: 399ecb4e4d159ae849ab5611ef91e746b85c83c0
+  data.tar.gz: 14e72421915437b24f4da99f3a849a53dcff6ff5
 SHA512:
-  metadata.gz: 1062ea6dc380d9fbe8f69400ef2ccb6d531f15346d73b96af9bedf03ecf40d2aeed74c7fdfa6f4405b454477510e33cda791610773a4c6be95d9b63ec730b412
-  data.tar.gz: 7cf680f589e5e8a6c903d91a1d2c7573332174ba2aac9b4246aadab4ef810160fe127a46363f9386374da610dcea4ac6def5f1ffa9c3d0771e1f6a07d3c2039d
+  metadata.gz: e59419c2d465714f6bc773c483033caec66f26918b94633aedf65226e2355008961748af8ef18916d3c6c0abfb4cdfdd062f4398e50613ecb71bcac9ea8010c3
+  data.tar.gz: 9f617a380f676eba25c979690e5440d900b4b279ef92b739e6943f6a6e8143dff5a7c943312e7886b1efa18362a126124986e50650377d9e289875b789f065fe

data/README.md

@@ -1,29 +1,69 @@
 # TidyLogger
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/kenn/tidy_logger.png)](https://travis-ci.org/kenn/tidy_logger)
+
+Better API for Ruby’s stdlib Logger
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'tidy_logger'
+```ruby
+gem 'tidy_logger'
+```
+
+## Usage
 
-And then execute:
+Ruby's stdlib `Logger` is great. It gives you so many features that you don't want to reinvent.
 
-    $ bundle
+```ruby
+require 'logger'
 
-Or install it yourself as:
+logger = Logger.new(STDOUT)
+logger.info 'hello world!'      # => "I, [2013-03-21T19:46:31.703381 #27585]  INFO -- : hello world!\n"
+```
 
-    $ gem install tidy_logger
+But, don't you think the default format is ugly? I do!
 
-## Usage
+Here comes TidyLogger. It is a subclass of and 100% compatible with the stdlib Logger. You can use it and Logger interchangeably.
+
+```ruby
+require 'tidy_logger'
+
+logger = TidyLogger.new(STDOUT)
+logger.info 'hello world!'      # => "I, [2013-03-21T19:46:31.703381 #27585]  INFO -- : hello world!\n"
+```
+
+The only method that's added to Logger is `config` - when you call it, all the shapeshifting happens.
+
+Supported options are `plain`, `time`, `title`, `time_and_level` (chosen when no argument is given), `ltsv` ([Labeled Tab-Separated Values](http://ltsv.org)) and lambdas.
+
+```ruby
+logger = TidyLogger.new(STDOUT)
+
+logger.config
+logger.info 'hello'             # => "[2013-03-21T21:19:54]  INFO : hello"
+
+logger.config(:plain)
+logger.info 'hello'             # => "hello"
+
+logger.config(:time)
+logger.info 'hello'             # => "[2013-03-21T21:19:10] hello"
+
+logger.config(title: 'note')
+logger.info 'hello'             # => "[note] hello"
+
+logger.config(:ltsv)
+logger.info fizz: 1, buzz: 2    # => "fizz:1\tbuzz:2"
+
+logger.config lambda{|_,_,_,msg| "///do crazy stuff/// #{msg}\n" }
+logger.info 'hello'             # => "///do crazy stuff/// hello"
+```
 
-TODO: Write usage instructions here
+The `config` method returns self, so that you can tidy up in method chain.
 
-## Contributing
+```ruby
+logger = TidyLogger.new(STDOUT).config(:plain)
 
-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
+logger.config(:plain).info 'foo'
+```

data/tidy_logger.gemspec

@@ -1,15 +1,12 @@
 # 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.version       = '1.0.1' # retrieve this value by: Gem.loaded_specs['redis-mutex'].version.to_s
   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.description   = %q{TidyLogger: Better API for Ruby’s stdlib Logger}
+  spec.summary       = %q{TidyLogger: Better API for Ruby’s stdlib Logger}
   spec.homepage      = 'https://github.com/kenn/tidy_logger'
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tidy_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kenn Ejima
@@ -38,7 +38,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 'TidyLogger: Logger on Steroids'
+description: 'TidyLogger: Better API for Ruby’s stdlib Logger'
 email:
 - kenn.ejima@gmail.com
 executables: []
@@ -52,7 +52,6 @@ files:
 - 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
@@ -78,7 +77,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: 'TidyLogger: Logger on Steroids'
+summary: 'TidyLogger: Better API for Ruby’s stdlib Logger'
 test_files:
 - test/test_tidy_logger.rb
 has_rdoc: 

data/lib/tidy_logger/version.rb

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