fluent-plugin-kuromoji 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02f4aa94cb85ca45457cdb3f263dc5a0ea8504d6
+  data.tar.gz: 24f2acecfa81b4e2a73194d42ba3f7e90ad1d9eb
+SHA512:
+  metadata.gz: 55347f310d7f2467072864bbd1e7aef4feaf9cb08f785d5c912b58675611575619c42f9da91cb3402c39f8ee27b2f4a4527569a0aa3ba5d946b2f38b405f3dc8
+  data.tar.gz: 1481afbb3dd6e2d2219bc4b794112fb63c28ea31226c1cfb7727bf581d342188f0725f27b469174ac458e80f73486d8f7f63eeb6a2cd0a55238ec976bed6c585

data/.gitignore

@@ -0,0 +1,14 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+pkg/
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+gemfile:
+  - Gemfile
+script: "rake spec"

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1  (2014/06/21)
+
+First release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hiroshi Toyama
+
+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,100 @@
+
+# fluent-plugin-kuromoji
+
+Output kuromoji analysis Plugin for fluentd
+
+required java!
+
+## Installation
+
+### td-agent(Linux)
+
+    /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-kuromoji
+
+### td-agent(Mac)
+
+    sudo /usr/local/Cellar/td-agent/X.X.XX/bin/fluent-gem install fluent-plugin-kuromoji
+
+### fluentd only(bundler)
+
+```ruby:Gemfile
+gem 'fluent-plugin-kuromoji'
+```
+
+## quick start
+
+```bash
+$ git clone https://github.com/toyama0919/fluent-plugin-kuromoji
+$ cd fluent-plugin-kuromoji
+$ bundle install
+$ bundle exec fluentd -c sample/fluent.conf -p lib/fluent/plugin/
+$ echo '{ "message":"私はサッカーが大好きです" }' | fluent-cat kuromoji.input
+```
+
+## parameter
+
+param    |   value
+--------|------
+target_key|analyze target key(require)
+add_tag_prefix|output tag prefix(require)
+dictionary_path|kuromoji dictionaly path
+
+## setting
+```
+<match kuromoji.input>
+  type kuromoji
+  target_key message
+  add_tag_prefix analyzed
+  dictionary_path sample/userdict.txt
+</match>
+
+<match analyzed.kuromoji.input>
+  type stdout
+</match>
+```
+
+## usage
+
+```bash
+echo '{ "message":"私は朝青龍が大好きです" }' | fluent-cat kuromoji.input
+
+# 2014-06-21 19:20:00 +0900 analyzed.kuromoji.input: {"parts_of_speech":"名詞,代名詞,一般,*","reading":"ワタシ","base_form":"私","surface_form":"私","position":0,"is_known":true,"is_user":false}
+# 2014-06-21 19:20:00 +0900 analyzed.kuromoji.input: {"parts_of_speech":"助詞,係助詞,*,*","reading":"ハ","base_form":"は","surface_form":"は","position":1,"is_known":true,"is_user":false}
+# 2014-06-21 19:20:00 +0900 analyzed.kuromoji.input: {"parts_of_speech":"カスタム名詞","reading":"アサショウリュウ","base_form":null,"surface_form":"朝青龍","position":2,"is_known":false,"is_user":true}
+# 2014-06-21 19:20:00 +0900 analyzed.kuromoji.input: {"parts_of_speech":"助詞,格助詞,一般,*","reading":"ガ","base_form":"が","surface_form":"が","position":5,"is_known":true,"is_user":false}
+# 2014-06-21 19:20:00 +0900 analyzed.kuromoji.input: {"parts_of_speech":"名詞,形容動詞語幹,*,*","reading":"ダイスキ","base_form":"大好き","surface_form":"大好き","position":6,"is_known":true,"is_user":false}
+# 2014-06-21 19:20:00 +0900 analyzed.kuromoji.input: {"parts_of_speech":"助動詞,*,*,*","reading":"デス","base_form":"です","surface_form":"です","position":9,"is_known":true,"is_user":false}
+```
+
+## dictionaly exsample
+```csv
+##
+## This file should use UTF-8 encoding
+##
+## User dictionary format:
+##   <text>,<token1> <token2> ... <tokenn>,<reading1> <reading2> ... <readingn>,<part-of-speech>
+##
+
+# Custom segmentation for long entries
+日本経済新聞,日本 経済 新聞,ニホン ケイザイ シンブン,カスタム名詞
+関西国際空港,関西 国際 空港,カンサイ コクサイ クウコウ,テスト名詞
+
+# Custom reading for former sumo wrestler Asashoryu
+朝青龍,朝青龍,アサショウリュウ,カスタム名詞
+```
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## 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](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2014 Hiroshi Toyama. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/fluent-plugin-kuromoji.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-kuromoji"
+  gem.version     = "0.0.1"
+  gem.authors     = ["Hiroshi Toyama"]
+  gem.email       = "toyama0919@gmail.com"
+  gem.homepage    = "https://github.com/toyama0919/fluent-plugin-kuromoji"
+  gem.description = "Output kuromoji analysis Plugin for fluentd"
+  gem.summary     = "Output kuromoji analysis Plugin for fluentd"
+  gem.licenses    = ["MIT"]
+  gem.has_rdoc    = false
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "kuromoji-ruby"
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "spork"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "fluent-plugin-twitter"
+
+end

data/lib/fluent/plugin/out_kuromoji.rb

@@ -0,0 +1,30 @@
+# coding: UTF-8
+module Fluent
+  class KuromojiOutput < Output
+    Fluent::Plugin.register_output('kuromoji', self)
+
+    config_param :target_key, :string
+    config_param :add_tag_prefix, :string
+    config_param :dictionary_path, :string
+
+    def initialize
+      super
+      require 'kuromoji'
+    end
+
+    def configure(conf)
+      super
+      @core = Kuromoji::Core.new(@dictionary_path)
+    end
+
+    def emit(tag, es, chain)
+      es.each do |time, record|
+        tokens = @core.tokenize_with_hash(record[@target_key])
+        tokens.each do |token|
+          Fluent::Engine.emit(@add_tag_prefix + '.' + tag, time, token)
+        end
+      end
+      chain.next
+    end
+  end
+end

data/sample/fluent.conf

@@ -0,0 +1,26 @@
+<source>
+  type forward
+  port 24224
+</source>
+
+#<source>
+#  type twitter
+#  consumer_key        "#{ENV['TWITTER_CONSUMER_KEY']}"       # Required
+#  consumer_secret     "#{ENV['TWITTER_CONSUMER_SECRET']}"    # Required
+#  oauth_token         "#{ENV['OAUTH_TOKEN']}"        # Required
+#  oauth_token_secret  "#{ENV['OAUTH_TOKEN_SECRET']}" # Required
+#  tag                 kuromoji.input           # Required
+#  timeline            userstream        # Required (sampling or userstream)
+#  output_format       nest
+#</source>
+
+<match kuromoji.input>
+  type kuromoji
+  target_key message
+  add_tag_prefix analyzed
+  dictionary_path sample/userdict.txt
+</match>
+
+<match analyzed.kuromoji.input>
+  type stdout
+</match>

data/sample/userdict.txt

@@ -0,0 +1,13 @@
+##
+## This file should use UTF-8 encoding
+##
+## User dictionary format:
+##   <text>,<token1> <token2> ... <tokenn>,<reading1> <reading2> ... <readingn>,<part-of-speech>
+##
+
+# Custom segmentation for long entries
+日本経済新聞,日本 経済 新聞,ニホン ケイザイ シンブン,カスタム名詞
+関西国際空港,関西 国際 空港,カンサイ コクサイ クウコウ,テスト名詞
+
+# Custom reading for former sumo wrestler Asashoryu
+朝青龍,朝青龍,アサショウリュウ,カスタム名詞

data/spec/out_kuromoji_spec.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+class KuromojiOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf = CONFIG, tag = 'test')
+    d = Fluent::Test::BufferedOutputTestDriver.new(Fluent::KuromojiOutput, tag).configure(conf)
+    d
+  end
+
+  def test_configure_error
+    assert_raise(Fluent::ConfigError) do
+      d = create_driver %[
+        target_key message
+      ]
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval do|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  end
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_kuromoji'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kuromoji
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hiroshi Toyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kuromoji-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: spork
+  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: pry
+  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: fluent-plugin-twitter
+  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: Output kuromoji analysis Plugin for fluentd
+email: toyama0919@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-kuromoji.gemspec
+- lib/fluent/plugin/out_kuromoji.rb
+- sample/fluent.conf
+- sample/userdict.txt
+- spec/out_kuromoji_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/toyama0919/fluent-plugin-kuromoji
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Output kuromoji analysis Plugin for fluentd
+test_files:
+- spec/out_kuromoji_spec.rb
+- spec/spec_helper.rb