ltsv_log_formatter 0.0.1 → 0.0.2

checksums.yaml

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

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.0.2 (2017/01/07)
+
+Enhancements:
+
+* Escape "\t" character to "\\t"
+
 # 0.0.1 (2015/04/23)
 
 First version
+

data/README.md

@@ -35,8 +35,8 @@ config.logger.formatter = LtsvLogFormatter.new
 Passing a hash parameter:
 
 ```
-irb> logger.info({foo: "bar"})
-time:20150423T00:00:00+09:00\tlevel:INFO\tfoo:bar
+irb> logger.info({foo: "foo", bar: "bar"})
+time:20150423T00:00:00+09:00\tlevel:INFO\tfoo:foo\tbar:bar
 ```
 
 Passing a string parameter: `message` key is used as default
@@ -46,13 +46,20 @@ 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`
+NOTE1: Notice that the line feed character `\n` is converted into `\\n` because LTSV format does not allow to break lines
 
 ```ruby
 irb> logger.info("foo\nbar")
 time:20150423T00:00:00+09:00\tlevel:INFO\tmessage:foo\\nbar
 ```
 
+NOTE2: Notice that the tab character `\t` is converted into `\\t` because message might have a string as "\t<string>:<string>"
+
+```ruby
+irb> logger.info("foo\tbar:baz")
+time:20150423T00:00:00+09:00\tlevel:INFO\tmessage:foo\\tbar:baz
+```
+
 ## Options
 
 * time_key

data/lib/ltsv_log_formatter.rb

@@ -28,10 +28,16 @@ class LtsvLogFormatter
     "#{@opts[:level_key]}:#{severity}\t" if @opts[:level_key]
   end
 
+  LF = "\n".freeze
+  TAB = "\t".freeze
+  ESCAPED_LF = "\\n".freeze
+  ESCAPED_TAB = "\\t".freeze
+  ESCAPE_TARGET = /[#{LF}#{TAB}]/
+
   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")
+    msg.map {|k, v| "#{k}:#{v.to_s.gsub(ESCAPE_TARGET, LF => ESCAPED_LF, TAB => ESCAPED_TAB)}" }.join(TAB)
   end
 end

data/ltsv_log_formatter.gemspec

@@ -4,7 +4,7 @@ $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.version       = "0.0.2"
   gem.authors       = ["Naotoshi Seo"]
   gem.email         = ["sonots@gmail.com"]
   gem.description   = %q{A logger formatter to output log in LTSV format}

data/spec/ltsv_log_formatter_spec.rb

@@ -135,4 +135,20 @@ describe LtsvLogFormatter do
       end
     end
   end
+
+  describe 'escape LF and TAB' do
+    context 'with LF' do
+      it do
+        logger.info(foo: "bar\nbar")
+        expect(gets).to eq "time:#{now}\tlevel:INFO\tfoo:bar\\nbar\n"
+      end
+    end
+
+    context 'with TAB' do
+      it do
+        logger.info(foo: "bar\tbar")
+        expect(gets).to eq "time:#{now}\tlevel:INFO\tfoo:bar\\tbar\n"
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ltsv_log_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies: []
 description: A logger formatter to output log in LTSV format
 email:
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A logger formatter to output log in LTSV format