fluent-plugin-rename-key 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60e3765941b5e976e67523ec08d3339a331b3834
-  data.tar.gz: b28f691513dde3dd285b69067caf667a31e46beb
+  metadata.gz: 127c0dc647c54e676bf479369cb0d83fb6a4c154
+  data.tar.gz: ef08017890d3968f6e704b8dde5b823a28c34a00
 SHA512:
-  metadata.gz: fa4c5cf24eca410e42877a6d62f1f1f48fcc45ee32b49264d4c46de9cd73c540e3596eabe4b55e51e40924a36742f09167f40526cd6a5f732990b822f32c0e79
-  data.tar.gz: a3e1c48fd89a1351a5145cc55ba1b24eca6ff507992c9fcb6c397ae73aad9e4fe5de60c65d4f2f686cca9d3b5254903f516b2839faa0c4cb646919266ac26392
+  metadata.gz: c0ad6f76423d9a9b9deacfa231bcd574ddde7d4be5a684f7201e3abdd86baa53968e3a9cebd4a540d504eca11acb2bca5ce15287d6be9d50428152ceb2e98a2d
+  data.tar.gz: b9acaecddc19f2cb21095cdd12e1f7ec6fcd77072f2586e95c3910adc31b62cd7c1b0c30a897bb476cd24e8263e18edb48255652a944433aa511fa50f0749ead

data/.gitignore

@@ -10,3 +10,4 @@ tmtags
 .\#*
 *.swp
 tmp/*
+coverage/*

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - rbx-19mode
+

data/README.md

@@ -1,10 +1,15 @@
 # fluent-plugin-rename-key
 
+## Status
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-rename-key.png)](http://badge.fury.io/rb/fluent-plugin-rename-key)
+[![Build Status](https://travis-ci.org/shunwen/fluent-plugin-rename-key.png?branch=master)](https://travis-ci.org/shunwen/fluent-plugin-rename-key)
+[![Coverage Status](https://coveralls.io/repos/shunwen/fluent-plugin-rename-key/badge.png?branch=master)](https://coveralls.io/r/shunwen/fluent-plugin-rename-key?branch=master)
+
 ## Overview
 
 Fluentd Output filter plugin. It goes through each record, rename keys matching the given regular expressions, and re-emit the event with a new tag. This plugin resembles the implementation of [fluent-plugin-rewrite-tag-filter](https://github.com/y-ken/fluent-plugin-rewrite-tag-filter).
 
-This plugin is created to resolve the invalid record problem while converting to BSON document before inserting to MongoDB, see [restrictions on Field Names](http://docs.mongodb.org/manual/reference/limits/#Restrictions on Field Names) and [MongoDB Document Types](http://docs.mongodb.org/meta-driver/latest/legacy/bson/#mongodb-document-types).
+This plugin is created to resolve the invalid record problem while converting to BSON document before inserting to MongoDB, see [Restrictions on Field Names](http://docs.mongodb.org/manual/reference/limits/#Restrictions on Field Names) and [MongoDB Document Types](http://docs.mongodb.org/meta-driver/latest/legacy/bson/#mongodb-document-types).
 
 ## Installation
 
@@ -14,6 +19,9 @@ install with gem or fluent-gem command as:
 # for fluentd
 $ gem install fluent-plugin-rename-key
 
+# for td-agent OSX (Homebrew)
+$ /usr/local/Cellar/td-agent/1.1.17/bin/fluent-gem install fluent-plugin-rename-key
+
 # for td-agent
 $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-rename-key
 ```
@@ -23,6 +31,9 @@ $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-rename-key
 ### Syntax
 
 ```
+# <num> is a integer, used to sort and apply the rules
+# <key_regexp> is the regular expression used to match the keys, whitespace is not allowed, use "\s" instead
+# <new_key> is the string with MatchData placeholder for creating the new key name, whitespace is allowed
 rename_rule<num> <key_regexp> <new_key>
 
 # Optional: remove tag prefix
@@ -42,8 +53,8 @@ Take this record as example: `'$url' => 'www.google.com', 'level2' => {'$1' => '
 To successfully save it into MongoDB, we can use the following config to replace the keys starting with dollar sign.
 
 ```
-# At rename_rule1, it matches the key starting the `$`, say `$url`, 
-# and puts the following characters into match group 1. 
+# At rename_rule1, it matches the key starting the `$`, say `$url`,
+# and puts the following characters into match group 1.
 # Then uses the content in match group 1, `url`, to generate the new key name `x$url`.
 
 <match input.test>
@@ -51,17 +62,17 @@ To successfully save it into MongoDB, we can use the following config to replace
   remove_tag_prefix input.test
   append_tag renamed
   rename_rule1 ^\$(.+) x$${md[1]}
-  rename_rule2 ^l(eve)l(\d+) ${md[1]}_${md[2]}
+  rename_rule2 ^l(.{3})l(\d+) ${md[1]}_${md[2]}
 </match>
 ```
 
-The resulting record will be `'x$url' => 'www.google.com', 'eve_2' => {'x$1' => 'option1'}`
+The resulting record becomes `'x$url' => 'www.google.com', 'eve_2' => {'x$1' => 'option1'}`
 
 ### MatchData placeholder
 
 This plugin uses Ruby's `String#match` to match the key to be replaced, and it is possible to refer to the contents of the resulting `MatchData` to create the new key name. `${md[0]}` refers to the matched string and `${md[1]}` refers to match group 1, and so on.
 
-**Note** Range expression ```${md[0..2]}``` is not supported.
+**Note:** Range expression ```${md[0..2]}``` is not supported.
 
 ## TODO
 

data/Rakefile

@@ -0,0 +1,9 @@
+task :default => [:spec]
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rspec_opts = ['-cfs']
+  end
+rescue LoadError => e
+end

data/fluent-plugin-rename-key.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name        = "fluent-plugin-rename-key"
-  gem.version     = "0.1.2"
+  gem.version     = "0.1.3"
   gem.license     = "Apache 2.0"
   gem.authors     = ["Shunwen Hsiao"]
   gem.email       = "hsiaoshunwen@gmail.com"
@@ -19,5 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "fluentd", "~> 0.10.9"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'coveralls'
 
 end

data/lib/fluent/plugin/out_rename_key.rb

@@ -63,7 +63,14 @@ class Fluent::RenameKeyOutput < Fluent::Output
         break
       end
 
-      value = rename_key value if value.is_a? Hash and @deep_rename
+      if @deep_rename
+        if value.is_a? Hash
+          value = rename_key value
+        elsif value.is_a? Array
+          value = value.map { |v| v.is_a?(Hash) ? rename_key(v) : v }
+        end
+      end
+
       new_record[key] = value
     end
 

data/spec/plugin/out_rename_key_spec.rb

@@ -100,6 +100,16 @@ describe Fluent::RenameKeyOutput do
         expect(result['level2']).to have_key '$1'
       end
 
+      it "replace key of hashes in an array" do
+        d = create_driver 'rename_rule1 ^\$(.+)\s(\w+) x$${md[2]} ${md[1]}'
+        d.run do
+          d.emit 'array' => [{'$url jump' => 'www.google.com'}, {'$url run' => 'www.google.com'}], 'level2' => {'$1' => 'options1'}
+        end
+        result = d.emits[0][2]
+        expect(result['array'][0]).to have_key 'x$jump url'
+        expect(result['array'][1]).to have_key 'x$run url'
+      end
+
       it "replaces key name using match data" do
         d = create_driver 'rename_rule1 ^\$(.+)\s(\w+) x$${md[2]} ${md[1]}'
         d.run do

data/spec/spec_helper.rb

@@ -11,6 +11,10 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 require 'rspec'
+require 'coveralls'
+Coveralls.wear!
+
+ARGV = []
 require 'fluent/test'
 
 unless ENV.has_key?('VERBOSE')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-rename-key
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Shunwen Hsiao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -52,6 +52,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: 
 email: hsiaoshunwen@gmail.com
 executables: []
@@ -59,10 +87,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
+- Rakefile
 - fluent-plugin-rename-key.gemspec
 - lib/fluent/plugin/out_rename_key.rb
 - spec/plugin/out_rename_key_spec.rb