twitter-korean-text-ruby 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66a39cfe7f6759aa6bc9412a49e069817201d08b
+  data.tar.gz: d2d0ffd199077dd5f7d0463764e2d1b2c6bb1f27
+SHA512:
+  metadata.gz: 5522edf916fb34042b99333b141146d450634e7d3503e0716204e4dcf2a74a2361fd3ad77dce961142b077f998e6dff627a0fb0603ad7e446b7c0fce1c64ac8e
+  data.tar.gz: d812c9d805a0957631a7845cde29ec9bbead25a610ef42d19834cd518e9b12648a210d5a071f837fd5669b93dcbb2aff284b200148dd1b425f04514397df8946

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.byebug_history
+coverage
+/*.gem

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+
+before_install:
+  - gem install bundler -v 1.11.2
+
+script: rake test

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in twitter-korean-text-ruby.gemspec
+gemspec

data/README.md

@@ -0,0 +1,68 @@
+## twitter-korean-text-ruby
+[![Build Status](https://travis-ci.org/keepcosmos/twitter-korean-text-ruby.svg?branch=master)](https://travis-ci.org/keepcosmos/twitter-korean-text-ruby)
+[![Code Climate](https://codeclimate.com/repos/56d562f8e4ecf4707f00309b/badges/7673319c6a92ab7ace9f/gpa.svg)](https://codeclimate.com/repos/56d562f8e4ecf4707f00309b/feed)
+
+Ruby interface to [twitter-korean-text](https://github.com/twitter/twitter-korean-text) by Twitter
+
+트위터에서 제공하는 한글 형태소 분석기인 [twitter-korean-text](https://github.com/twitter/twitter-korean-text)(Scala)를 Ruby에서 사용가능하도록 Wrapping 하였습니다.
+
+### install
+```{ruby}
+$ gem install twitter-korean-text-ruby
+```
+Gemfile을 사용할 경우
+```{ruby}
+# Gemfile
+gem 'twitter-korean-text-ruby'
+```
+
+### Useage
+```ruby
+require 'twitter-korean-text-ruby'
+
+processor = TwitterKorean::Processor.new
+# OR with JVM arguments
+processor = TwitterKorean::Processor.new('-Xms126M', '-Xms512M', ...)
+
+# Normalize
+processor.normalize("형태소 분석을 합니닼ㅋㅋㅋㅋㅋㅋ")
+# => "형태소 분석을 합니다ㅋㅋㅋㅋㅋㅋ"
+
+# Tokenize
+tokens = proccessor.tokenize("한국어를 처리하는 예시입니다 ㅋㅋ")
+puts tokens
+# => ["한국어", "를", " ", "처리", "하는", " ", "예시", "입니", "다", " ", "ㅋㅋ"]
+
+# metadata of token, 토큰에 대한 정보
+metadata = tokens.first.metadata
+matadata #=> "noun, 0, 3"
+metadata.pos #=> :noun
+metadata.offset #=> 0
+metadata.length #=> 3
+
+# Stemming
+tokens = proccessor.stem("한국어를 처리하는 예시입니다 ㅋㅋ")
+puts tokens
+# => ["한국어", "를", " ", "처리", "하다", " ", "예시", "이다", " ", "ㅋㅋ"]
+
+# extract phrases
+tokens = proccessor.stem("한국어를 처리하는 예시입니다 ㅋㅋ")
+puts tokens
+# => ["한국어", "처리", "처리하는 예시", "예시"]
+
+```
+
+### Test
+```{ruby}
+rake test
+```
+
+### Issue
+JAVA Path를 찾지 못했을 경우, 
+```{bash}
+export JAVA_HOME=$(java_home_path)
+
+### Contribute
+이 프로젝트는 [twitter-korean-text](https://github.com/twitter/twitter-korean-text) 프로젝트의 Scala 코드를 Ruby로 Wrapping하는 프로젝트입니다.
+관련된 범주에 대한 Issue와 Pull Request(테스트 코드가 포함된)는 언제나 환영입니다.
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twitter/korean/text/ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/twitter-korean-text-ruby.rb

@@ -0,0 +1,7 @@
+require 'twitter_korean/version'
+
+module TwitterKorean
+  autoload :JvmBridge, 'twitter_korean/jvm_bridge'
+  autoload :Processor, 'twitter_korean/processor'
+  autoload :KoreanToken, 'twitter_korean/korean_token'
+end

data/lib/twitter_korean/jvm_bridge.rb

@@ -0,0 +1,15 @@
+require 'rjb'
+
+module TwitterKorean
+  class JvmBridge
+    CLASS_PATH = Dir.glob(File.dirname(__FILE__) + '/jars/*.jar').join(File::PATH_SEPARATOR).freeze
+
+    def initialize(jvmargs = [])
+      Rjb.load CLASS_PATH, jvmargs
+    end
+
+    def scala_twitter_korean_processor
+      Rjb.import('com.twitter.penguin.korean.TwitterKoreanProcessor')
+    end
+  end
+end

data/lib/twitter_korean/korean_token.rb

@@ -0,0 +1,53 @@
+module TwitterKorean
+  class KoreanToken < String
+    attr_accessor :metadata
+
+    class << self
+      # by form like `한국어(Noun: 0, 3)`
+      def build_by_formed_str(str)
+        token = new(str[0...str.rindex('(')])
+
+        infos = str[(str.rindex('(') + 1)...str.rindex(')')]
+        attrs = {
+          pos: infos.match(/\w+/).to_s,
+          offset: infos.match(/\d+/).to_s.to_i,
+          length: infos.match(/\d+$/).to_s.to_i
+        }
+
+        token.metadata = TwitterKorean::KoreanToken::Metadata.new(attrs)
+        token
+      end
+    end
+
+    class Metadata
+      attr_accessor :pos, :offset, :length, :unkown
+
+      def initialize(attrs = {})
+        attrs.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+        symbolize_pos!
+      end
+
+      def inspect
+        "#{pos}, #{offset}, #{length}"
+      end
+
+      def ==(other)
+        [:pos, :offset, :length, :unkown].inject(true) { |res, attr| res && (send(attr) == other.send(attr)) }
+      end
+
+      private
+
+      def symbolize_pos!
+        return if pos.nil?
+        @pos = to_underscore(pos).to_sym
+      end
+
+      def to_underscore(txt)
+        txt.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+      end
+    end
+  end
+end

data/lib/twitter_korean/processor.rb

@@ -0,0 +1,55 @@
+require 'rjb'
+
+module TwitterKorean
+  # Ruby interface to Scala TwitterKoreanProcessor
+  class Processor
+    attr_reader :jvm_processor, :java_convertor
+
+    def initialize(*jvmargs)
+      bridge = TwitterKorean::JvmBridge.new(jvmargs)
+      @jvm_processor = bridge.scala_twitter_korean_processor
+    end
+
+    def normalize(text)
+      return unless text
+      jvm_processor.normalize(text).toString
+    end
+
+    def tokenize(text)
+      return unless text
+      converto_to_korean_tokens do
+        jvm_processor.tokenize(text)
+      end
+    end
+
+    def stem(text)
+      return unless text
+      converto_to_korean_tokens do
+        jvm_processor.stem(jvm_processor.tokenize(text))
+      end
+    end
+
+    def extract_phrases(text, options = {})
+      return unless text
+      filter_spam = options[:filter_spam] || false
+      including_hashtags = options[:including_hashtags] || true      
+      converto_to_korean_tokens do
+        jvm_processor.extractPhrases(jvm_processor.tokenize(text), filter_spam, including_hashtags)
+      end
+    end
+
+    private
+
+    def converto_to_korean_tokens &block
+      scala_list = block.call.toString
+      token_strs = scala_list_to_array(scala_list)
+      token_strs.map do |formed_token_str|
+        TwitterKorean::KoreanToken.build_by_formed_str(formed_token_str.first)
+      end
+    end
+
+    def scala_list_to_array(result)
+      result.scan(/(?<=List\(|\,\s)(.*?\([a-zA-Z]+\:\s[0-9]+,\s[0-9]\))/).to_a
+    end
+  end
+end

data/lib/twitter_korean/version.rb

@@ -0,0 +1,3 @@
+module TwitterKorean
+  VERSION = '0.9.1'
+end

data/twitter-korean-text-ruby.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twitter_korean/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "twitter-korean-text-ruby"
+  spec.version       = TwitterKorean::VERSION
+  spec.authors       = ["Jaehyun Shin"]
+  spec.email         = ["keepcosmos@gmail.com"]
+
+  spec.summary       = "Ruby interface to Twitter Korean Text(written in Scala)"
+  spec.description   = "Ruby interface to Twitter Korean Text written in Scala(https://github.com/twitter/twitter-korean-text) "
+  spec.homepage      = 'https://github.com/keepcosmos/twitter-korean-text-ruby'
+  spec.license       = "Apache License 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rjb", "~> 1.5"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug", "~> 8.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov", "~> 0.11.0"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: twitter-korean-text-ruby
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Jaehyun Shin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rjb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: 'Ruby interface to Twitter Korean Text written in Scala(https://github.com/twitter/twitter-korean-text) '
+email:
+- keepcosmos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twitter-korean-text-ruby.rb
+- lib/twitter_korean/jars/korean-text-4.4.jar
+- lib/twitter_korean/jars/scala-library-2.11.7.jar
+- lib/twitter_korean/jars/twitter-text-1.13.3.jar
+- lib/twitter_korean/jvm_bridge.rb
+- lib/twitter_korean/korean_token.rb
+- lib/twitter_korean/processor.rb
+- lib/twitter_korean/version.rb
+- twitter-korean-text-ruby.gemspec
+homepage: https://github.com/keepcosmos/twitter-korean-text-ruby
+licenses:
+- Apache License 2.0
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby interface to Twitter Korean Text(written in Scala)
+test_files: []
+has_rdoc: