ununiga 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41a97f562ee21f2e971b08d2e523f3150d4d89b1
-  data.tar.gz: 7dcabeb9592a94b6280146dd05d8ede68607b5ef
+  metadata.gz: b8ed609a7765abb9b795d537e32fb9fbbb0c311d
+  data.tar.gz: 1cb2c593186f7c6ef0f741198738e0ee88d16ab0
 SHA512:
-  metadata.gz: 2c43f16e62863f91d239c9225770c0d11dfcf7e15664f07e54d7205b26e7e9b7d4d33f7fa62f72575a2eebbed8feb73be634c9cba05312fb5e0e4ee52352b78a
-  data.tar.gz: dceba36eba34b7c0437a1268bedbbcf9bedde4caed795a11c72383d432f464c38a3eef8af3f7432c17240e0b3c64b77e5a42a46ff42d950ff29cfcf62484cd7a
+  metadata.gz: 0b006f84c3b58d5b05e82af55f1633385ec6cb97d7caca032585eb26b5dffe69e77cbf5a82f93f51442e4ba1da2b2af49bb31ba8bc94a200a87f15f21b4f45cf
+  data.tar.gz: aa05c9c954390447392d858fc7ca10104cfa7f02bc5cadde5275afca9670a0f5ba31f4d7bc766534e0b192a81b5335c4ebefa6ebfa282d2a1527ed0cceec6775

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+
+before_install:
+  - gem install i18n --no-rdoc --no-ri --no-document
+
+script: rake test

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    ununiga (1.0.1)
+
+GEM
+  remote: http://www.rubygems.org/
+  specs:
+    i18n (0.7.0)
+    minitest (5.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  i18n
+  minitest
+  ununiga!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,69 @@
+[![Build Status](https://travis-ci.org/keepcosmos/ununiga.svg?branch=master)](https://travis-ci.org/keepcosmos/ununiga)
+[![Gem Version](https://badge.fury.io/rb/ununiga.svg)](https://badge.fury.io/rb/ununiga)
+
+# ununiga[은는이가]
+
+은는이가는 한글의 자소분리를 분리하고 조사를 찾아주는 역할을 합니다.  
+I18n의 Backend 모듈도 제공합니다.
+
+## Installation
+```
+gem install ununiga
+```
+
+### 조사 찾기
+```ruby
+require 'ununiga'
+
+Ununiga::JosaPicker.takewell("레일즈와(과) 쟝고은(는) 싸우지 않습니다.")
+# => "레일즈와 쟝고는 싸우지 않습니다."
+Ununiga::JosaPicker.takewell("트위터(으)로 로그인합니다.")
+# => "페이스북로 로그인합니다."
+
+picker = Ununiga::JosaPicker.new("레일즈은(는) 루비을(를) 사용합니다.")
+picker.takewell
+# => "레일즈는 루비를 사용합니다.
+
+picker.josas
+# => [[3, ["은", "는"]], [10, ["을", "를"]]]
+``` 
+
+### I18n에 적용하기
+1. Gemfile에 ununiga를 추가합니다. 
+```
+gem 'ununiga'
+```
+
+2. Initializer나 environment config파일에 아래 코드를 추가합니다.
+```ruby
+I18n::Backend::Simple.send(:include, Ununiga::I18n::JosaTransformer)
+```
+
+3. 한글 locale yml 파일에 조사를 사용하는 부분을 찾아 '은(는)|(는)은|을(를)...'등으로 조사를 변경합니다.
+```yaml
+links:
+  sign_in_with_provider: "%{provider}(으)로 로그인"
+
+# Rails의 ActiveModel/ActiveRecord의 Validation을 사용할 경우
+errors:
+  # 디폴트는 `%{attribute} %{message}`형식으로 띄워쓰기가 되어 있으며로 format을 붙여쓰기로 변경해줍니다.
+  foramt: "%{attribute}%{message}"
+  messages:
+    accepted: 을(를) 반드시 확인해야 합니다.
+    equal_to: 은(는) %{count}와(과) 같아야 합니다
+```
+
+### 자소 분리하기
+```ruby
+splitter = Ununiga::JasoSplitter.new('흯')
+splitter.chosung       # => 'ㅎ'
+splitter.jungsung      # => 'ㅢ'
+splitter.jongsung      # => 'ㄳ'
+splitter.split         # => ['ㅎ', 'ㅢ', 'ㄳ']
+```
+
+## Test
+두가지 방식으로 테스트 할 수 있습니다.
+* `rake test` 혹은 그냥 `rake` 커맨드를 사용합니다.
+* 특정 파일을 테스트할 경우 `ruby -Ilib:test /test/{file_name}` 을 사용합니다.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/lib/ununiga/i18n/josa_transformer.rb

@@ -0,0 +1,16 @@
+require 'ununiga/josa_picker'
+
+module Ununiga::I18n
+  module JosaTransformer
+    def translate(*args)
+      transform(super)
+    end
+
+    def transform(entry)
+      if !entry.is_a?(Hash) && I18n.locale.to_s =~ /ko|ko_KR/i
+        return Ununiga::JosaPicker.new(entry).takewell
+      end
+      entry
+    end
+  end
+end

data/lib/ununiga/jaso_splitter.rb

@@ -0,0 +1,69 @@
+module Ununiga
+  # 한글 자소분리 클래스
+  # 1개의 한글 문자를 초성/중성/종성으로 분리한다.
+  #
+  # Sample:
+  # 
+  #     splitter = Ununiga::JasoSplitter.new('흯')
+  #     splitter.extract_chosung       # => 'ㅎ'
+  #     splitter.extract_jungsung      # => 'ㅢ'
+  #     splitter.extract_jongsung      # => 'ㄳ'
+  #     splitter.split                 # => ['ㅎ', 'ㅢ', 'ㄳ']
+  #
+  #     # 종성이 없는 경우는 nil
+  #     splitter2 = Ununiga::JasoSplitter.new('가')
+  #     splitter2.extract_jongsung     # => nil
+  #     splitter2.split                # => ['ㄱ', 'ㅏ', nil]
+  # 
+  class JasoSplitter
+    CHOSUNGS = %w(ㄱ ㄲ ㄴ ㄷ ㄸ ㄹ ㅁ ㅂ ㅃ ㅅ ㅆ ㅇ ㅈ ㅉ ㅊ ㅋ ㅌ ㅍ ㅎ).freeze
+    JUNGSUNGS = %w(ㅏ ㅐ ㅑ ㅒ ㅓ ㅔ ㅕ ㅖ ㅗ ㅘ ㅛ ㅙ ㅚ ㅜ ㅝ ㅞ ㅟ ㅠ ㅡ ㅢ ㅣ).freeze
+    JONGSUNGS = %w(ㄱ ㄲ ㄳ ㄴ ㄵ ㄶ ㄷ ㄹ ㄺ ㄻ ㄼ ㄽ ㄾ ㄿ ㅀ ㅁ ㅂ ㅄ ㅅ ㅆ ㅇ ㅈ ㅊ ㅋ ㅌ ㅍ ㅎ).unshift(nil).freeze
+    KR_RANGE = ('가'.unpack('U')[0]..'힣'.unpack('U')[0]).freeze
+    KR_OFFSET = KR_RANGE.first.freeze
+
+    attr_reader :kr_char
+
+    def initialize(kr_char)
+      fail ArgumentError, 'Argument must be single character' unless kr_char.size == 1
+      @kr_char = kr_char
+    end
+
+    def split
+      [extract_chosung, extract_jungsung, extract_jongsung]
+    end
+
+    def extract_chosung
+      nil unless korean?
+      CHOSUNGS[kr_relative_code / (JUNGSUNGS.size * JONGSUNGS.size)]
+    end
+
+    def extract_jungsung
+      nil unless korean?
+      JUNGSUNGS[kr_relative_code % (JUNGSUNGS.size * JONGSUNGS.size) / JONGSUNGS.size]
+    end
+
+    def extract_jongsung
+      nil unless korean?
+      JONGSUNGS[kr_relative_code % JONGSUNGS.size]
+    end
+
+    def korean?
+      KR_RANGE.cover?(kr_code)
+    end
+
+    [:chosung, :jungsung, :jongsung].each do |m|
+      alias_method m, :"extract_#{m}"
+    end
+
+    private
+
+    def kr_code
+      kr_char.unpack('U')[0]
+    end
+
+    def kr_relative_code
+      kr_code - KR_OFFSET
+    end
+  end
+end

data/lib/ununiga/josa_picker.rb

@@ -0,0 +1,65 @@
+require 'ununiga/jaso_splitter'
+
+module Ununiga
+  # 한글 초성, 중성, 종성 분리기
+  class JosaPicker
+    JOSAS = [%w(은 는),
+             %w(이 가),
+             %w(을 를),
+             %w(과 와),
+             %w(으로 로)
+            ].freeze
+
+    attr_reader :korean_str
+
+    class << self
+      def takewell(str)
+        new(str).takewell
+      end
+    end
+
+    def initialize(str)
+      @korean_str = str
+    end
+
+    def takewell
+      korean_str.gsub josa_regexp do |matched|
+        index = $~.offset(0)[0]
+        next if index == 0
+        josa = JOSAS.find { |josa| josa_convension(josa).include? matched }
+        splitter = JasoSplitter.new(korean_str[index - 1])
+        josa[(splitter.jongsung ? 0 : 1)]
+      end
+    end
+
+    def josas
+      res = []
+      korean_str.scan josa_regexp do |matched|
+        res << [$~.offset(0)[0], JOSAS.find { |josa| josa.include? matched[0] }]
+      end
+      res
+    end
+
+    private
+
+    def josa_regexp
+      @_josa_regexp ||=
+        begin
+          josa_regexp_seq = JOSAS.map do |josa|
+            conv = josa_convension(josa)
+            conv.map { |str| str.gsub!('(', '\\(').gsub!(')', '\\)') }
+          end
+          Regexp.new(josa_regexp_seq.flatten.join('|'))
+        end
+    end
+
+    # JOSAS의 element가 온다.
+    def josa_convension(josa)
+      if josa[0].size == 1
+        ["#{josa[0]}(#{josa[1]})", "#{josa[1]}(#{josa[0]})"]
+      elsif josa[0].size == 2
+        ["(#{josa[0][0]})#{josa[1]}"]
+      end
+    end
+  end
+end

data/lib/ununiga/version.rb

@@ -0,0 +1,3 @@
+module Ununiga
+  VERSION = '1.0.3'
+end

data/test/test.yml

@@ -0,0 +1,5 @@
+ko:
+  someone_pay: '%{name}이(가) 돈을 냅니다.'
+  someone_eat_something: '%{name}은(는) %{meal}을(를) 먹습니다.'
+  do_something_with_someone: '%{name1}와(과) %{name2}은(는) %{doing}을(를) 합니다.'
+  

data/test/test_jaso_splitter.rb

@@ -0,0 +1,63 @@
+require 'minitest/autorun'
+require 'ununiga/jaso_splitter'
+
+class JamoSplitterTest < Minitest::Unit::TestCase
+  def test_extract_chosung
+    testgroup = { '가' => 'ㄱ',
+                  '낳' => 'ㄴ',
+                  '짷' => 'ㅉ',
+                  '하' => 'ㅎ'
+                }
+    testgroup.each do |char, chosung|
+      splitter = Ununiga::JasoSplitter.new(char)
+      assert_equal chosung, splitter.extract_chosung
+    end
+  end
+
+  def test_extract_jungsung
+    testgroup = { '가' => 'ㅏ',
+                  '내' => 'ㅐ',
+                  '찋' => 'ㅢ',
+                  '휷' => 'ㅠ'
+                }
+    testgroup.each do |char, jungsung|
+      splitter = Ununiga::JasoSplitter.new(char)
+      assert_equal jungsung, splitter.extract_jungsung
+    end
+  end
+
+  def test_extract_jongsung
+    testgroup = { '가' => nil,
+                  '내' => nil,
+                  '찋' => 'ㅎ',
+                  '휷' => 'ㄳ'
+                }
+    testgroup.each do |char, jongsung|
+      splitter = Ununiga::JasoSplitter.new(char)
+      assert_equal jongsung, splitter.extract_jongsung
+    end
+  end
+
+  def test_split
+    testgroup = { '신' => ['ㅅ', 'ㅣ', 'ㄴ'],
+                  '재' => ['ㅈ', 'ㅐ', nil],
+                  '현' => ['ㅎ', 'ㅕ', 'ㄴ']
+                }
+    testgroup.each do |char, splitted|
+      splitter = Ununiga::JasoSplitter.new(char)
+      assert_equal splitted, splitter.split
+    end
+  end
+
+  def test_non_korean_exception
+    %w(a 中 च Қ に).each do |char|
+      assert !Ununiga::JasoSplitter.new(char).korean?
+    end
+  end
+
+  def test_non_single_character_exception
+    assert_raises ArgumentError do
+      Ununiga::JasoSplitter.new('두글자')
+    end
+  end
+end

data/test/test_josa_picker.rb

@@ -0,0 +1,32 @@
+require 'minitest/autorun'
+require 'ununiga/josa_picker'
+
+class JosaPickerTest < Minitest::Unit::TestCase
+  def test_takewell
+    assert_equal '철수가 개발을 좋아합니다.', takewell('철수이(가) 개발을(를) 좋아합니다.')
+
+    assert_equal '레일즈는 루비를 사용합니다.', takewell('레일즈은(는) 루비을(를) 사용합니다.')
+    assert_equal '레일즈는 루비를 사용합니다.', takewell('레일즈는(은) 루비를(을) 사용합니다.')
+
+    assert_equal '레일즈와 쟝고는 싸우지 않습니다.', takewell('레일즈와(과) 쟝고은(는) 싸우지 않습니다.')
+    
+    assert_equal '페이스북으로부터 인증되었습니다.', takewell('페이스북(으)로부터 인증되었습니다.')
+    assert_equal '트위터로부터 인증되었습니다.', takewell('트위터(으)로부터 인증되었습니다.')
+  end
+
+  def test_find_josas
+    str1 = '철수이(가) 개발을(를) 좋아합니다.'
+    assert_equal [[2, %w(이 가)], [9, %w(을 를)]], find_josas(str1)
+
+    str2 = '레일즈은(는) 루비을(를) 사용합니다.'
+    assert_equal [[3, %w(은 는)], [10, %w(을 를)]], find_josas(str2)
+  end
+
+  def find_josas(str)
+    Ununiga::JosaPicker.new(str).josas
+  end
+
+  def takewell(str)
+    Ununiga::JosaPicker.new(str).takewell
+  end
+end

data/test/test_josa_transformer.rb

@@ -0,0 +1,26 @@
+require 'minitest/autorun'
+require 'i18n'
+require 'ununiga/i18n/josa_transformer'
+
+class JosaTransformerTest < Minitest::Unit::TestCase
+  def setup
+    super
+    I18n::Backend::Simple.send(:include, Ununiga::I18n::JosaTransformer)
+    I18n.load_path = [File.dirname(__FILE__) + '/test.yml']
+    I18n.available_locales = [:en, :ko, :ko_KR]
+    I18n.locale = :ko
+  end
+  
+  def test_transform_korean
+    assert_equal '철수가 돈을 냅니다.', I18n.t(:someone_pay, name: '철수')
+    assert_equal '재현이 돈을 냅니다.', I18n.t(:someone_pay, name: '재현')
+
+    assert_equal '호랑이는 사과를 먹습니다.', I18n.t(:someone_eat_something, name: '호랑이', meal: '사과')
+    assert_equal '곰은 마늘을 먹습니다.', I18n.t(:someone_eat_something, name: '곰', meal: '마늘')
+
+    assert_equal '재현과 진아는 개발을 합니다.', I18n.t(:do_something_with_someone, name1: '재현', name2: '진아', doing: '개발')
+    assert_equal '정하와 민정은 디자인을 합니다.', I18n.t(:do_something_with_someone, name1: '정하', name2: '민정', doing: '디자인')
+  end
+
+  
+end

data/ununiga.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'ununiga'
+  s.version     = '1.0.3'
+  s.date        = '2016-01-25'
+  s.summary     = 'Support Jaso and Josa(Korean Language specific function)'
+  s.description = '한글 자소 분리 및 적절한 조사를 찾아주어 번역해줍니다.'
+  s.authors     = ['Jaehyun Shin']
+  s.email       = 'keepcosmos@gmail.com'
+  s.files       = ['lib/ununiga.rb']
+  s.homepage    = 'https://github.com/keepcosmos/ununiga'
+  s.files       = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.add_development_dependency 'i18n'
+  s.add_development_dependency 'minitest'
+  s.license     = 'MIT'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ununiga
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jaehyun Shin
@@ -44,7 +44,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
 - lib/ununiga.rb
+- lib/ununiga/i18n/josa_transformer.rb
+- lib/ununiga/jaso_splitter.rb
+- lib/ununiga/josa_picker.rb
+- lib/ununiga/version.rb
+- test/test.yml
+- test/test_jaso_splitter.rb
+- test/test_josa_picker.rb
+- test/test_josa_transformer.rb
+- ununiga.gemspec
 homepage: https://github.com/keepcosmos/ununiga
 licenses:
 - MIT