chrono_logger 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fd8e8db4d085af832c0cb76c093aebcaa8b916a
-  data.tar.gz: d65ffb9adebb0df5ebd7fc10c06e1b029f74b13d
+  metadata.gz: 08bc980d1aec36c6dd84be8aa0964a89f026357a
+  data.tar.gz: 36c8767249f645a1cf6a491dd03a29e0e47a95bd
 SHA512:
-  metadata.gz: c08cee180eae5b406613b6de088de54cc606fc1d675d5fc1fc001b13cd9f7d27710f694e108ece6f22c489c42071fc582961781eeb76f936368969636a352108
-  data.tar.gz: 6e75c498bb9e989415f826b85ac901810199e3d6126151d1ae84a8f90395e3f9f4bb8ca94e6b6503915441bc47c9b58d6315ed10471fe9b88fb6e982cbc6d28b
+  metadata.gz: 364f9de5b3a3694e4e54d4dfa2a27511c6a0d18bbcb5186f69bf538503cd950fdd46ef35681f950ec8b158977103b3fa2f4496851f1b3939e75846d0a5a40ba9
+  data.tar.gz: db43d8701920d88b5fa46e1b9ed3aeae4b6fa97f5b82aace8fc99431c0f64decb645a4a2953029d16ec146bab507c358423971c73acca6d2c232bc6407eb2495

data/README.md

@@ -4,10 +4,38 @@
 [![Build Status](https://travis-ci.org/ma2gedev/chrono_logger.svg)](https://travis-ci.org/ma2gedev/chrono_logger)
 [![Code Climate](https://codeclimate.com/github/ma2gedev/chrono_logger/badges/gpa.svg)](https://codeclimate.com/github/ma2gedev/chrono_logger)
 [![Coverage Status](https://coveralls.io/repos/ma2gedev/chrono_logger/badge.svg)](https://coveralls.io/r/ma2gedev/chrono_logger)
+[![Inline docs](http://inch-ci.org/github/ma2gedev/chrono_logger.svg?branch=master)](http://inch-ci.org/github/ma2gedev/chrono_logger)
 [![endorse](https://api.coderwall.com/ma2gedev/endorsecount.png)](https://coderwall.com/ma2gedev)
 
 A lock-free logger with timebased file rotation.
 
+Ruby's stdlib `Logger` wraps `IO#write` in mutexes. `ChronoLogger` removes these mutexes.
+
+`ChronoLogger` provides time based file rotation such as:
+
+```
+logger = ChronoLogger.new('/log/production.log.%Y%m%d')
+Time.now.strftime('%F')
+# => "2015-01-26"
+File.exist?('/log/production.log.20150126')
+# => true
+
+# one day later
+Time.now.strftime('%F')
+# => "2015-01-27"
+logger.write('hi next day')
+File.exist?('/log/production.log.20150127')
+# => true
+```
+
+## Motivation
+
+Current my projects uses `::Logger` with cronolog. So
+
+- Reduce dependency such as cronolog
+- Remove mutexes in ruby world because os already does
+- Support time based rotation without renaming file because file renaming is complex
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -31,6 +59,7 @@ Same interfaces ruby's stdlib `Logger` except for `new` method.
 ```
 require 'chrono_logger'
 
+# specify path with `Time#strftime` format
 logger = ChronoLogger.new('development.%Y%m%d')
 
 logger.error("Enjoy")
@@ -39,6 +68,10 @@ logger.info("Enjoy")
 logger.debug("programming!")
 ```
 
+## Limitation
+
+- High performance only daily based time formatting path for example `'%Y%m%d'`. You can create pull request if you need other time period.
+
 ## Contributing
 
 1. Fork it ( https://github.com/ma2gedev/chrono_logger/fork )
@@ -46,3 +79,7 @@ logger.debug("programming!")
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## License
+
+MIT. See [LICENSE.txt](LICENSE.txt) for more details.

data/lib/chrono_logger.rb

@@ -1,11 +1,20 @@
 require "chrono_logger/version"
 require 'logger'
 
+# A lock-free logger with timebased file rotation.
 class ChronoLogger < Logger
+
+  # @param logdev [String, IO] `Time#strftime` formatted filename (String) or IO object (typically STDOUT, STDERR, or an open file).
+  # @example
+  #
+  #   ChronoLogger.new('/log/production.log.%Y%m%d')
+  #   Time.now.strftime('%F')                       => "2015-01-29"
+  #   File.exist?('/log/production.log.20150129')   => true
+  #
   def initialize(logdev)
     @progname = nil
     @level = DEBUG
-    @default_formatter = Formatter.new
+    @default_formatter = ::Logger::Formatter.new
     @formatter = nil
     @logdev = nil
     if logdev
@@ -126,4 +135,18 @@ class ChronoLogger < Logger
       end
     end
   end
+
+  # EXPERIMENTAL: this formatter faster than default `Logger::Formatter`
+  class Formatter < ::Logger::Formatter
+    DATETIME_SPRINTF_FORMAT = "%04d-%02d-%02dT%02d:%02d:%02d.%06d ".freeze
+
+    # same as `Logger::Formatter#format_datetime`'s default behaviour
+    def format_datetime(t)
+      DATETIME_SPRINTF_FORMAT % [t.year, t.month, t.day, t.hour, t.min, t.sec, t.tv_usec]
+    end
+
+    def datetime_format=(datetime_format)
+      raise 'do not support'
+    end
+  end
 end

data/lib/chrono_logger/version.rb

@@ -1,5 +1,5 @@
 require 'logger'
 
 class ChronoLogger < Logger
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chrono_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Takayuki Matsubara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler