gimchi 0.1.9 → 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.rdoc

@@ -0,0 +1,42 @@
+=== 0.2.0 / 2013/03/28
+* Completely backward-incompatable release :p
+
+=== 0.1.9 / 2012/02/20
+* Bug fix: Failing test on 1.8
+* `Gimchi::Korean#dissect` renamed to `Gimchi::Korean#convert`
+* `Gimchi::korean#dissect` completely dissects the given String into an Array of Korean character components in String
+
+=== 0.1.8 / 2011/12/02
+* Added `Gimchi::Korean#kchar`
+
+=== 0.1.7 / 2011/10/17
+* Bug fix: Fixed reading 0
+* Bug fix: Failing test on 1.8
+* Bug fix: Fixed 'incompatible encoding regexp' problem on 1.9
+
+=== 0.1.6 / 2011/04/13
+* More post substitution for read_number
+
+=== 0.1.5 / 2011/04/12
+* Removed possible loss of precision during read_number
+* read_number extended to read exponential notation properly.
+
+=== 0.1.4 / 2011/04/08
+* Minor improvement in romanization output. -y => y
+
+=== 0.1.3 / 2011/04/08
+* Now compatible with Ruby 1.8
+
+=== 0.1.2 / 2011/04/08
+* Bug fix in pronouncer.rb. It was undetectable on Ruby 1.9, but on 1.8
+
+=== 0.1.1 / 2011/04/07
+* Removed Gimchi::Korean::Char#org
+* Code refactoring
+* `Gimchi::Korean#romanize` no more capitalizes the output string
+* `Gimchi::Korean#romanize` does not affect non-Korean characters
+* yard documentation
+
+=== 0.1.0 / 2011/04/05
+* Prototype release.
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -1,4 +1,6 @@
-Copyright (c) 2011 Junegunn Choi
+Copyright (c) 2013 Junegunn Choi
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.ko.markdown → README.ko.md}

@@ -18,97 +18,98 @@ gem install gimchi
 
 ## 사용법
 
-### Gimchi::Korean 인스턴스의 생성
+### 초/중/종성 분해/합체
+
 ```ruby
-require 'gimchi'
+chosung, jungsung, jongsung = Gimchi.decompose "한"
 
-ko = Gimchi::Korean.new
+Gimchi.compose chosung, jungsung, jongsung    # 한
+Gimchi.compose chosung, "ㅗ", jongsung        # 혼
 ```
 
 ### 한글 캐릭터 여부 판단
 ```ruby
-ko.korean_char? 'ㄱ'           # true
-ko.complete_korean_char? 'ㄱ'  # false
+Gimchi.korean_char? 'ㄱ'           # true
+Gimchi.complete_korean_char? 'ㄱ'  # false
 
-ko.korean_char? 'ㅏ'           # true
-ko.complete_korean_char? 'ㅏ'  # false
+Gimchi.korean_char? 'ㅏ'           # true
+Gimchi.complete_korean_char? 'ㅏ'  # false
 
-ko.korean_char? '가'           # true
-ko.complete_korean_char? '가'  # true
+Gimchi.korean_char? '가'           # true
+Gimchi.complete_korean_char? '가'  # true
 
 # Alias of korean_char?
-ko.kchar? '가'                 # true
+Gimchi.kchar? '가'                 # true
+
+Gimchi.chosung?  'ㄱ'              # true
+Gimchi.jungsung? 'ㄱ'              # false
+Gimchi.jongsung? 'ㄱ'              # true
+
+Gimchi.chosung?  'ㅏ'              # false
+Gimchi.jungsung? 'ㅏ'              # true
+Gimchi.jongsung? 'ㅏ'              # false
+
+Gimchi.chosung?  'ㄺ'              # false
+Gimchi.jungsung? 'ㄺ'              # false
+Gimchi.jongsung? 'ㄺ'              # true
 ```
 
-### Gimchi::Korean::Char
+### Gimchi::Char 의 사용
+
 ```ruby
-kc = ko.kchar "한"
-kc.class                   # Gimchi::Korean::Char
+kc = Gimchi::Char("한")
+kc.class                    # Gimchi::Char
+
+kc.chosung                  # "ㅎ"
+kc.jungsung                 # "ㅏ"
+kc.jongsung                 # "ㄴ"
+kc.to_a                     # ["ㅎ", "ㅏ", "ㄴ"]
+kc.to_s                     # "한"
 
-kc.chosung                 # "ㅎ"
-kc.jungsung                # "ㅏ"
-kc.jongsung                # "ㄴ"
-kc.to_a                    # ["ㅎ", "ㅏ", "ㄴ"]
-kc.to_s                    # "한"
+kc.complete?                # true
+kc.partial?                 # false
 
-kc.complete?               # true
-kc.partial?                # false
-ko.kchar("ㅏ").partial?    # true
+Gimchi::Char("ㅏ").partial? # true
 
 # Modifying its elements
 kc.chosung = 'ㄷ'
 kc.jongsung = 'ㄹ'
-kc.to_s                    # "달"
-kc.complete?               # true
-kc.partial?                # false
+kc.to_s                     # "달"
+kc.complete?                # true
+kc.partial?                 # false
 
 kc.chosung = nil
 kc.jongsung = nil
-kc.complete?               # false
-kc.partial?                # true
-
-# Alias of kchar
-kc = ko.korean_char "한"
-
-# Array of Gimchi::Korean::Char's
-arr = ko.convert '이것은 한글입니다.'
-  # [이, 것, 은, " ", 한, 글, 입, 니, 다, "."]
-
-arr[0].class               # Gimchi::Korean::Char
-
-# Dissects given String
-arr = ko.dissect '이것은 한글입니다.'
-  # ["ㅇ", "ㅣ", "ㄱ", "ㅓ", "ㅅ", "ㅇ", "ㅡ", "ㄴ", " ", 
-  #  "H", "a", "n", "g", "u", "l", " ", "ㅇ", "ㅣ", "ㅂ",
-  #  "ㄴ", "ㅣ", "ㄷ", "ㅏ", "."]
+kc.complete?                # false
+kc.partial?                 # true
 ```
 
 ### 숫자 읽기
 ```ruby
-ko.read_number(1999)         # "천 구백 구십 구"
-ko.read_number(- 100.123)    # "마이너스 백점일이삼"
-ko.read_number("153,191,100,678.3214")
+Gimchi.read_number(1999)         # "천 구백 구십 구"
+Gimchi.read_number(- 100.123)    # "마이너스 백점일이삼"
+Gimchi.read_number("153,191,100,678.3214")
     # "천 오백 삼십 일억 구천 백 십만 육백 칠십 팔점삼이일사"
 
 # 나이, 시간 ( -살, -시 )
-ko.read_number("20살")       # "스무살"
-ko.read_number("13 살")      # "열세 살"
-ko.read_number("7시 30분")   # "일곱시 삼십분"
+Gimchi.read_number("20살")       # "스무살"
+Gimchi.read_number("13 살")      # "열세 살"
+Gimchi.read_number("7시 30분")   # "일곱시 삼십분"
 ```
 
 ### 표준 발음 (부분 구현)
 ```ruby
 str = "됐어 됐어 이제 그런 가르침은 됐어 매일 아침 7 시 30 분까지 우릴 조그만 교실로 몰아넣고"
-ko.pronounce str
+Gimchi.pronounce str
   # "돼써 돼써 이제 그런 가르치믄 돼써 매일 아침 일곱 시 삼십 분까지 우릴 조그만 교실로 모라너코"
 
-ko.pronounce str, :slur => true
+Gimchi.pronounce str, :slur => true
   # "돼써 돼써 이제 그런 가르치믄 돼써 매이 라치 밀곱 씨 삼십 뿐까지 우릴 조그만 교실로 모라너코"
 
-ko.pronounce str, :pronounce_each_char => true
+Gimchi.pronounce str, :each_char => true
   # "됃어 됃어 이제 그런 가르침은 됃어 매일 아침 일곱 시 삼십 분까지 우릴 조그만 교실로 몰아너고"
 
-ko.pronounce str, :number => false
+Gimchi.pronounce str, :number => false
   # "돼써 돼써 이제 그런 가르치믄 돼써 매일 아침 7 시 30 분까지 우릴 조그만 교실로 모라너코"
 ```
 
@@ -116,14 +117,17 @@ ko.pronounce str, :number => false
 ```ruby
 str = "됐어 됐어 이제 그런 가르침은 됐어 매일 아침 7 시 30 분까지 우릴 조그만 교실로 몰아넣고"
 
-ko.romanize str
+Gimchi.romanize str
   # "Dwaesseo dwaesseo ije geureon gareuchimeun dwaesseo mae-il achim ilgop si samsip bunkkaji uril jogeuman gyosillo moraneoko"
-ko.romanize str, :slur => true
+
+Gimchi.romanize str, :slur => true
   # "Dwaesseo dwaesseo ije geureon gareuchimeun dwaesseo mae-i rachi milgop ssi samsip ppunkkaji uril jogeuman gyosillo moraneoko"
-ko.romanize str, :as_pronounced => false
-  # "Dwaet-eo dwaet-eo ije geureon gareuchim-eun dwaet-eo mae-il achim ilgop si samsip bunkkaji uril jogeuman gyosillo mol-aneogo"
-ko.romanize str, :number => false
+
+Gimchi.romanize str, :number => false
   # "Dwaesseo dwaesseo ije geureon gareuchimeun dwaesseo mae-il achim 7 si 30 bunkkaji uril jogeuman gyosillo moraneoko"
+
+Gimchi.romanize str, :as_pronounced => false
+  # "Dwaet-eo dwaet-eo ije geureon gareuchim-eun dwaet-eo mae-il achim ilgop si samsip bunkkaji uril jogeuman gyosillo mol-aneogo"
 ```
 
 ## 구현의 한계
@@ -136,18 +140,16 @@ ko.romanize str, :number => false
 위해 Ad-hoc한 patch 등이 코드에 상당량 포함된 상태인데 이를 정제하고 체계화하는
 노력이 필요합니다.
 
-## Contributing to gimchi
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
 ## Copyright
 
-Copyright (c) 2011 Junegunn Choi. See LICENSE.txt for
+Copyright (c) 2013 Junegunn Choi. See LICENSE.txt for
 further details.
 

data/README.md

@@ -0,0 +1,162 @@
+# gimchi
+
+Gimchi is a simple Ruby gem for handling Korean characters.
+
+Features:
+- Decompose a Korean character into its 3 components, namely chosung, jungsung and optional jongsung
+- Compose elements back into the Korean character
+- Read numbers in Korean
+- Pronounce Korean characters
+- Romanize Korean characters
+
+Gimchi (partially) implements the following rules dictated by
+The National Institute of The Korean Language (http://www.korean.go.kr)
+- Korean Standard Pronunciation
+- Korean Romanization
+
+## Installation
+
+```
+gem install gimchi
+```
+
+## Usage
+
+### Composing and decomposing Korean character
+
+```ruby
+chosung, jungsung, jongsung = Gimchi.decompose "한"
+
+Gimchi.compose chosung, jungsung, jongsung    # 한
+Gimchi.compose chosung, "ㅗ", jongsung        # 혼
+```
+
+### Inspecting Korean characters
+```ruby
+Gimchi.korean_char? 'ㄱ'           # true
+Gimchi.complete_korean_char? 'ㄱ'  # false
+
+Gimchi.korean_char? 'ㅏ'           # true
+Gimchi.complete_korean_char? 'ㅏ'  # false
+
+Gimchi.korean_char? '가'           # true
+Gimchi.complete_korean_char? '가'  # true
+
+# Alias of korean_char?
+Gimchi.kchar? '가'                 # true
+
+Gimchi.chosung?  'ㄱ'              # true
+Gimchi.jungsung? 'ㄱ'              # false
+Gimchi.jongsung? 'ㄱ'              # true
+
+Gimchi.chosung?  'ㅏ'              # false
+Gimchi.jungsung? 'ㅏ'              # true
+Gimchi.jongsung? 'ㅏ'              # false
+
+Gimchi.chosung?  'ㄺ'              # false
+Gimchi.jungsung? 'ㄺ'              # false
+Gimchi.jongsung? 'ㄺ'              # true
+```
+
+### Using Gimchi::Char
+
+```ruby
+kc = Gimchi::Char("한")
+kc.class                    # Gimchi::Char
+
+kc.chosung                  # "ㅎ"
+kc.jungsung                 # "ㅏ"
+kc.jongsung                 # "ㄴ"
+kc.to_a                     # ["ㅎ", "ㅏ", "ㄴ"]
+kc.to_s                     # "한"
+
+kc.complete?                # true
+kc.partial?                 # false
+
+Gimchi::Char("ㅏ").partial? # true
+
+# Modifying its elements
+kc.chosung = 'ㄷ'
+kc.jongsung = 'ㄹ'
+kc.to_s                     # "달"
+kc.complete?                # true
+kc.partial?                 # false
+
+kc.chosung = nil
+kc.jongsung = nil
+kc.complete?                # false
+kc.partial?                 # true
+```
+
+### Reading numbers in Korean
+```ruby
+Gimchi.read_number(1999)         # "천 구백 구십 구"
+Gimchi.read_number(- 100.123)    # "마이너스 백점일이삼"
+Gimchi.read_number("153,191,100,678.3214")
+  	# "천 오백 삼십 일억 구천 백 십만 육백 칠십 팔점삼이일사"
+
+# Age, Time ( -살, -시 )
+Gimchi.read_number("20살")       # "스무살"
+Gimchi.read_number("13 살")      # "열세 살"
+Gimchi.read_number("7시 30분")   # "일곱시 삼십분"
+```
+
+### Standard pronunciation (partially implemented)
+```ruby
+str = "됐어 됐어 이제 그런 가르침은 됐어 매일 아침 7 시 30 분까지 우릴 조그만 교실로 몰아넣고"
+Gimchi.pronounce str
+  # "돼써 돼써 이제 그런 가르치믄 돼써 매일 아침 일곱 시 삼십 분까지 우릴 조그만 교실로 모라너코"
+
+Gimchi.pronounce str, :slur => true
+  # "돼써 돼써 이제 그런 가르치믄 돼써 매이 라치 밀곱 씨 삼십 뿐까지 우릴 조그만 교실로 모라너코"
+
+Gimchi.pronounce str, :number => false
+  # "돼써 돼써 이제 그런 가르치믄 돼써 매일 아침 7 시 30 분까지 우릴 조그만 교실로 모라너코"
+
+Gimchi.pronounce str, :each_char => true
+  # "됃어 됃어 이제 그런 가르침은 됃어 매일 아침 일곱 시 삼십 분까지 우릴 조그만 교실로 몰아너고"
+```
+
+### Romanization (partially implemented)
+```ruby
+str = "됐어 됐어 이제 그런 가르침은 됐어 매일 아침 7 시 30 분까지 우릴 조그만 교실로 몰아넣고"
+
+Gimchi.romanize str
+  # "Dwaesseo dwaesseo ije geureon gareuchimeun dwaesseo mae-il achim ilgop si samsip bunkkaji uril jogeuman gyosillo moraneoko"
+
+Gimchi.romanize str, :slur => true
+  # "Dwaesseo dwaesseo ije geureon gareuchimeun dwaesseo mae-i rachi milgop ssi samsip ppunkkaji uril jogeuman gyosillo moraneoko"
+
+Gimchi.romanize str, :number => false
+  # "Dwaesseo dwaesseo ije geureon gareuchimeun dwaesseo mae-il achim 7 si 30 bunkkaji uril jogeuman gyosillo moraneoko"
+
+Gimchi.romanize str, :as_pronounced => false
+  # "Dwaet-eo dwaet-eo ije geureon gareuchim-eun dwaet-eo mae-il achim ilgop si samsip bunkkaji uril jogeuman gyosillo mol-aneogo"
+```
+
+## Limitation of the implementation
+
+Unfortunately in order to implement the complete specification of Korean
+pronunciation and romanization, we need NLP, huge Korean dictionaries and even
+semantic analysis of the given string. And even with all those complex
+processing, we cannot guarantee 100% accuracy of the output. So yes, that is
+definitely not what this gem tries to achieve. Gimchi tries to achieve "some"
+level of accuracy with relatively simple code.
+
+Currently, Gimchi code contains a lot of ad-hoc (possibly invalid) patches
+that try to improve the quality of the output, which should better be
+refactored anytime soon.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2013 Junegunn Choi. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end