= gimchi

== 개요

Gimchi는 한글 스트링을 다롭니다.
국립 국어원 어문 규정에 정의된 한글의 표준 발음법과
로마자 표기법을 (일부) 구현한 것이 주요 기능입니다.

또한 다음의 기능들을 제공합니다.
- 주어진 캐릭터가 한글인지 판단
- 한글을 초성, 중성, 종성으로 분리하고, 이를 다시 합치는 기능
- 숫자 표기를 한글 표현으로 변환

== 설치
  gem install gimchi

== 사용법

=== Gimchi::Korean 인스턴스의 생성
  require 'gimchi'
  
  ko = Gimchi::Korean.new

=== 한글 캐릭터 여부 판단
  ko.korean_char? 'ㄱ'           # true
  ko.complete_korean_char? 'ㄱ'  # false

  ko.korean_char? 'ㅏ'           # true
  ko.complete_korean_char? 'ㅏ'  # false

  ko.korean_char? '가'           # true
  ko.complete_korean_char? '가'  # true

=== Gimchi::Korean::Char
  arr = ko.dissect '이것은 한글입니다.'
    # [이, 것, 은, " ", 한, 글, 입, 니, 다, "."]

  arr[4].class                   # Gimchi::Korean::Char

  arr[4].chosung                 # "ㅎ"
  arr[4].jungsung                # "ㅏ"
  arr[4].jongsung                # "ㄴ"
  arr[4].to_a                    # ["ㅎ", "ㅏ", "ㄴ"]
  arr[4].to_s                    # "한"

  arr[4].chosung = 'ㄷ'
  arr[4].jongsung = 'ㄹ'
  arr[4].to_s                    # "달"
  arr[4].complete?               # true
  arr[4].partial?                # false

  arr[4].chosung = nil
  arr[4].jongsung = nil
  arr[4].complete?               # false
  arr[4].partial?                # true

=== 숫자 읽기
  ko.read_number(1999)         # "천 구백 구십 구"
  ko.read_number(- 100.123)    # "마이너스 백점일이삼"
  ko.read_number("153,191,100,678.3214")
    	# "천 오백 삼십 일억 구천 백 십만 육백 칠십 팔점삼이일사"

  # 나이, 시간 ( -살, -시 )
  ko.read_number("20살")       # "스무살"
  ko.read_number("13 살")      # "열세 살"
  ko.read_number("7시 30분")   # "일곱시 삼십분"

=== 표준 발음 (부분 구현)
  str = "됐어 됐어 이제 그런 가르침은 됐어 매일 아침 7 시 30 분까지 우릴 조그만 교실로 몰아넣고"
  ko.pronounce str
    # "돼써 돼써 이제 그런 가르치믄 돼써 매일 아침 일곱 시 삼십 분까지 우릴 조그만 교실로 모라너코"

  ko.pronounce str, :slur => true
    # "돼써 돼써 이제 그런 가르치믄 돼써 매이 라치 밀곱 씨 삼십 뿐까지 우릴 조그만 교실로 모라너코"

  ko.pronounce str, :pronounce_each_char => true
    # "됃어 됃어 이제 그런 가르침은 됃어 매일 아침 일곱 시 삼십 분까지 우릴 조그만 교실로 몰아너고"

  ko.pronounce str, :number => false
    # "돼써 돼써 이제 그런 가르치믄 돼써 매일 아침 7 시 30 분까지 우릴 조그만 교실로 모라너코"

=== 로마자 표기 (부분 구현)
  str = "됐어 됐어 이제 그런 가르침은 됐어 매일 아침 7 시 30 분까지 우릴 조그만 교실로 몰아넣고"

  ko.romanize str
    # "Dwaesseo dwaesseo ije geureon gareuchimeun dwaesseo mae-il achim ilgop si samsip bunkkaji uril jogeuman gyosillo moraneoko"
  ko.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
    # "Dwaesseo dwaesseo ije geureon gareuchimeun dwaesseo mae-il achim 7 si 30 bunkkaji uril jogeuman gyosillo moraneoko"

== 구현의 한계

표준 발음법과 로마어 표기법을 모두 구현하기 위해서는 형태소 분석과 충분한
사전, 그리고 문맥의 의미 분석이 필요합니다. 이 모든 것이 준비된다고 할 지라도
완벽한 결과를 얻는 것은 불가능합니다.
이는 현재 gimchi가 목표로 하는 것이 아니며 gimchi는 간단한 구현으로 어느 수준
이상의 결과를 얻는 것을 목표로 합니다. 현재 구현의 한계 내에서 정확도를 올리기
위해 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.

== Copyright

Copyright (c) 2011 Junegunn Choi. See LICENSE.txt for
further details.