pinyin 0.0.1

data/lib/data/valid_pinyin.yaml

@@ -0,0 +1,455 @@
+# Valid pinyin syllables by final and initial
+# Hpricoted from http://en.wikipedia.org/wiki/Pinyin_table
+# Hand-edited for Ueng/weng which is under Ong in the table
+#
+# Note that, in order to only use 7-bit ASCII characters, 
+# the u with two dots (umlaut) is written v, and the e with
+# a little hat on top (circumflex) is written E.
+---
+V:
+  Ne: nü
+  Qi: qu
+  Empty: yu
+  Le: lü
+  Xi: xu
+  Ji: ju
+Ian:
+  Ne: nian
+  De: dian
+  Qi: qian
+  Mo: mian
+  Bo: bian
+  Empty: yan
+  Le: lian
+  Xi: xian
+  Te: tian
+  Ji: jian
+  Po: pian
+Ee:
+  Empty: ê
+Ua:
+  Empty: wa
+  Chi: chua
+  Ke: kua
+  Zhi: zhua
+  He: hua
+  Ge: gua
+  Shi: shua
+Iu:
+  Ne: niu
+  De: diu
+  Qi: qiu
+  Mo: miu
+  Empty: you
+  Le: liu
+  Xi: xiu
+  Ji: jiu
+Iao:
+  Ne: niao
+  De: diao
+  Qi: qiao
+  Mo: miao
+  Bo: biao
+  Empty: yao
+  Le: liao
+  Xi: xiao
+  Te: tiao
+  Ji: jiao
+  Po: piao
+A:
+  Si: sa
+  Ne: na
+  De: da
+  Mo: ma
+  Bo: ba
+  Empty: a
+  Le: la
+  Zi: za
+  Chi: cha
+  Ke: ka
+  Zhi: zha
+  Ci: ca
+  Te: ta
+  He: ha
+  Ge: ga
+  Shi: sha
+  Fo: fa
+  Po: pa
+Vn:
+  Qi: qun
+  Empty: yun
+  Xi: xun
+  Ji: jun
+Uan:
+  Si: suan
+  Ri: ruan
+  Ne: nuan
+  De: duan
+  Empty: wan
+  Le: luan
+  Zi: zuan
+  Chi: chuan
+  Ke: kuan
+  Zhi: zhuan
+  Ci: cuan
+  Te: tuan
+  He: huan
+  Ge: guan
+  Shi: shuan
+Ing:
+  Ne: ning
+  De: ding
+  Qi: qing
+  Mo: ming
+  Bo: bing
+  Empty: ying
+  Le: ling
+  Xi: xing
+  Te: ting
+  Ji: jing
+  Po: ping
+Ia:
+  Qi: qia
+  Empty: ya
+  Le: lia
+  Xi: xia
+  Ji: jia
+Er:
+  Empty: er
+An:
+  Si: san
+  Ri: ran
+  Ne: nan
+  De: dan
+  Mo: man
+  Bo: ban
+  Empty: an
+  Le: lan
+  Zi: zan
+  Chi: chan
+  Ke: kan
+  Zhi: zhan
+  Ci: can
+  Te: tan
+  He: han
+  Ge: gan
+  Shi: shan
+  Fo: fan
+  Po: pan
+Empty:
+  Si: si
+  Ri: ri
+  Zi: zi
+  Chi: chi
+  Zhi: zhi
+  Ci: ci
+  Shi: shi
+Van:
+  Qi: quan
+  Empty: yuan
+  Xi: xuan
+  Ji: juan
+Un:
+  Si: sun
+  Ri: run
+  De: dun
+  Empty: wen
+  Le: lun
+  Zi: zun
+  Chi: chun
+  Ke: kun
+  Zhi: zhun
+  Ci: cun
+  Te: tun
+  He: hun
+  Ge: gun
+  Shi: shun
+Ao:
+  Si: sao
+  Ri: rao
+  Ne: nao
+  De: dao
+  Mo: mao
+  Bo: bao
+  Empty: ao
+  Le: lao
+  Zi: zao
+  Chi: chao
+  Ke: kao
+  Zhi: zhao
+  Ci: cao
+  Te: tao
+  He: hao
+  Ge: gao
+  Shi: shao
+  Po: pao
+Uo:
+  Si: suo
+  Ri: ruo
+  Ne: nuo
+  De: duo
+  Empty: wo
+  Le: luo
+  Zi: zuo
+  Chi: chuo
+  Ke: kuo
+  Zhi: zhuo
+  Ci: cuo
+  Te: tuo
+  He: huo
+  Ge: guo
+  Shi: shuo
+Ang:
+  Si: sang
+  Ri: rang
+  Ne: nang
+  De: dang
+  Mo: mang
+  Bo: bang
+  Empty: ang
+  Le: lang
+  Zi: zang
+  Chi: chang
+  Ke: kang
+  Zhi: zhang
+  Ci: cang
+  Te: tang
+  He: hang
+  Ge: gang
+  Shi: shang
+  Fo: fang
+  Po: pang
+Ei:
+  Ne: nei
+  De: dei
+  Mo: mei
+  Bo: bei
+  Empty: ei
+  Le: lei
+  Zi: zei
+  Zhi: zhei
+  He: hei
+  Ge: gei
+  Shi: shei
+  Fo: fei
+  Po: pei
+O:
+  Mo: mo
+  Bo: bo
+  Empty: o
+  Fo: fo
+  Po: po
+Ue:
+  Ne: nüe
+  Qi: que
+  Empty: yue
+  Le: lüe
+  Xi: xue
+  Ji: jue
+In:
+  Ne: nin
+  Qi: qin
+  Mo: min
+  Bo: bin
+  Empty: yin
+  Le: lin
+  Xi: xin
+  Ji: jin
+  Po: pin
+E:
+  Si: se
+  Ri: re
+  Ne: ne
+  De: de
+  Mo: me
+  Empty: e
+  Le: le
+  Zi: ze
+  Chi: che
+  Ke: ke
+  Zhi: zhe
+  Ci: ce
+  Te: te
+  He: he
+  Ge: ge
+  Shi: she
+Iang:
+  Ne: niang
+  Qi: qiang
+  Empty: yang
+  Le: liang
+  Xi: xiang
+  Ji: jiang
+Iai:
+  Empty: yai
+Ie:
+  Ne: nie
+  De: die
+  Qi: qie
+  Mo: mie
+  Bo: bie
+  Empty: ye
+  Le: lie
+  Xi: xie
+  Te: tie
+  Ji: jie
+  Po: pie
+Io:
+  Empty: yo
+Ou:
+  Si: sou
+  Ri: rou
+  Ne: nou
+  De: dou
+  Mo: mou
+  Empty: ou
+  Le: lou
+  Zi: zou
+  Chi: chou
+  Ke: kou
+  Zhi: zhou
+  Ci: cou
+  Te: tou
+  He: hou
+  Ge: gou
+  Shi: shou
+  Fo: fou
+  Po: pou
+Uai:
+  Empty: wai
+  Chi: chuai
+  Ke: kuai
+  Zhi: zhuai
+  He: huai
+  Ge: guai
+  Shi: shuai
+Ueng:
+  Empty: weng
+Ong:
+  Si: song
+  Ri: rong
+  Ne: nong
+  De: dong
+  Le: long
+  Zi: zong
+  Chi: chong
+  Ke: kong
+  Zhi: zhong
+  Ci: cong
+  Te: tong
+  He: hong
+  Ge: gong
+Eng:
+  Si: seng
+  Ri: reng
+  Ne: neng
+  De: deng
+  Mo: meng
+  Bo: beng
+  Empty: eng
+  Le: leng
+  Zi: zeng
+  Chi: cheng
+  Ke: keng
+  Zhi: zheng
+  Ci: ceng
+  Te: teng
+  He: heng
+  Ge: geng
+  Shi: sheng
+  Fo: feng
+  Po: peng
+Ai:
+  Si: sai
+  Ne: nai
+  De: dai
+  Mo: mai
+  Bo: bai
+  Empty: ai
+  Le: lai
+  Zi: zai
+  Chi: chai
+  Ke: kai
+  Zhi: zhai
+  Ci: cai
+  Te: tai
+  He: hai
+  Ge: gai
+  Shi: shai
+  Po: pai
+Iong:
+  Qi: qiong
+  Empty: yong
+  Xi: xiong
+  Ji: jiong
+Uang:
+  Empty: wang
+  Chi: chuang
+  Ke: kuang
+  Zhi: zhuang
+  He: huang
+  Ge: guang
+  Shi: shuang
+Ui:
+  Si: sui
+  Ri: rui
+  De: dui
+  Empty: wei
+  Zi: zui
+  Chi: chui
+  Ke: kui
+  Zhi: zhui
+  Ci: cui
+  Te: tui
+  He: hui
+  Ge: gui
+  Shi: shui
+I:
+  Ne: ni
+  De: di
+  Qi: qi
+  Mo: mi
+  Bo: bi
+  Empty: yi
+  Le: li
+  Xi: xi
+  Te: ti
+  Ji: ji
+  Po: pi
+En:
+  Si: sen
+  Ri: ren
+  Ne: nen
+  Mo: men
+  Bo: ben
+  Empty: en
+  Zi: zen
+  Chi: chen
+  Ke: ken
+  Zhi: zhen
+  Ci: cen
+  He: hen
+  Ge: gen
+  Shi: shen
+  Fo: fen
+  Po: pen
+U:
+  Si: su
+  Ri: ru
+  Ne: nu
+  De: du
+  Mo: mu
+  Bo: bu
+  Empty: wu
+  Le: lu
+  Zi: zu
+  Chi: chu
+  Ke: ku
+  Zhi: zhu
+  Ci: cu
+  Te: tu
+  He: hu
+  Ge: gu
+  Shi: shu
+  Fo: fu
+  Po: pu

data/lib/exception.rb

@@ -0,0 +1,14 @@
+module Pinyin
+  # All exceptions arising from this module inherit from Pinyin::Error
+  Error = Class.new StandardError
+
+  class ParseError < Error
+    attr_reader :input, :position
+
+    def initialize(input, position)
+      @input=input
+      @position=position
+    end
+  end
+end
+  

data/lib/groundwork.rb

@@ -0,0 +1,148 @@
+# Classes and constants used throughout the module
+#  * Initial
+#  * Final
+#  * TonelessSyllable
+#  * Syllable
+#  * ILLEGAL_COMBINATIONS
+
+module Pinyin
+  # A Chinese initial (start of a syllable)
+  class Initial
+    attr :name
+    def initialize(n)
+      @name=n
+    end
+
+    All = %w(
+      Empty Bo Po Mo Fo De Te Ne Le Ge Ke He
+      Ji Qi Xi Zhi Chi Shi Ri Zi Ci Si
+      ).map{|c| const_set c, Initial.new(c)}
+
+    class <<self
+      private :new
+    end
+
+    Groups=[
+            Group_0=[ Empty ],
+            Group_1=[ Bo,Po,Mo,Fo],     #Bilabial and Labio-dental
+            Group_2=[ De,Te,Ne,Le ],    #Plosive, nasal and lateral approximant alveolar
+            Group_3=[ Ge,Ke,He ],       #Velar
+            Group_4=[ Ji,Qi,Xi ],       #Alveolo-palatal
+            Group_5=[ Zhi,Chi,Shi,Ri ], #Retroflex
+            Group_6=[ Zi,Ci,Si ],       #Fricative and affricate alveolar
+           ]
+    
+    def +(f)
+      TonelessSyllable.new(self,f)
+    end
+
+    def inspect()
+      "<#{self.class.name}::#{@name}>"
+    end
+  end
+
+
+  # A Chinese final (end of a syllable)
+  class Final
+    attr :name
+    def initialize(n)
+      @name=n
+    end
+
+    All=%w(
+      Empty A O E Ee Ai Ei Ao Ou An En Ang Eng Ong Er 
+      I Ia Io Ie Iai Iao Iu Ian In Iang Ing 
+      U Ua Uo Uai Ui Uan Un Uang Ueng V Ue Van Vn Iong
+    ).map{|c| const_set c, Final.new(c)}
+    
+    class <<self
+      private :new
+    end
+    
+    Groups=[
+            Group_0=[ Empty ],
+            Group_A=[ A,O,E,Ee,Ai,Ei,Ao,Ou,An,En,Ang,Eng,Ong,Er ],
+            Group_I=[ I,Ia,Io,Ie,Iai,Iao,Iu,Ian,In,Iang,Ing ],
+            Group_U=[ U,Ua,Uo,Uai,Ui,Uan,Un,Uang,Ueng ],
+            Group_V=[ V,Ue,Van,Vn,Iong]
+           ]
+    def inspect()
+      "<#{self.class.name}::#{name}>"
+    end
+  end
+
+
+  # Combination of an initial and a final
+  # Not to be confused with a syllable that has the neutral tone
+  class TonelessSyllable
+    attr_accessor :initial, :final
+
+    def initialize(initial, final)
+      self.initial = initial
+      self.final   = final
+    end
+
+    def +(tone)
+      Syllable.new(initial, final, tone)
+    end
+
+    def inspect
+      "<#{self.class.name} <initial=#{initial.name}, final=#{final.name}>>"
+    end
+
+    def self.illegal?(i,f)
+      ILLEGAL_COMBINATIONS.any? {|in_gr, fin_gr| in_gr.include?(i) && fin_gr.include?(f)}
+    end
+
+    alias :to_s :inspect
+  end
+
+
+  # Syllable : initial, final and tone
+  class Syllable < TonelessSyllable
+    attr_accessor :tone
+
+    def initialize(initial, final, tone)
+      super(initial, final)
+      self.tone = tone
+    end
+
+    def inspect
+      "<#{self.class.name} <initial=#{initial.name}, final=#{final.name}, tone=#{tone}>>"
+    end
+
+    alias :to_s :inspect
+  end
+
+
+  # Some groups of initials and finals may not be combined
+  # This list is not exhaustive but is sufficient to resolve ambiguity
+  ILLEGAL_COMBINATIONS=
+    [               
+     [Initial::Group_0, Final::Group_0],
+     [Initial::Group_1, Final::Group_0],
+     [Initial::Group_2, Final::Group_0],
+     [Initial::Group_3, Final::Group_0],
+     [Initial::Group_4, Final::Group_0],
+
+     [Initial::Group_4, Final::Group_U],
+     [Initial::Group_4, Final::Group_A],
+
+     [Initial::Group_3, Final::Group_I],
+     [Initial::Group_5, Final::Group_I],
+     [Initial::Group_6, Final::Group_I],
+
+     [Initial::Group_1, Final::Group_V],
+     [Initial::Group_3, Final::Group_V],
+
+     [Initial::Group_2, [Final::O]],  #Only bo, po, mo and fo are valid -o combinations
+     [Initial::Group_3, [Final::O]],
+     [Initial::Group_4, [Final::O]],
+     [Initial::Group_5, [Final::O]],
+     [Initial::Group_6, [Final::O]],
+
+     [[Initial::Empty], [Final::Ong]] # Some say ong and ueng is actually the same final, zhuyin uses the same representation, but ueng only has standalone form weng
+
+    ]
+
+end

data/lib/pinyin.rb

@@ -0,0 +1,71 @@
+# Handle several romanization systems for Mandarin Chinese
+#
+# Author::     Arne Brasseur (pinyin@arnebrasseur.net)
+# Copyright::  Copyright (c) 2007, Arne Brasseur
+# Licence::    GNU General Public License, latest version
+
+$: << File.dirname(__FILE__)
+
+require 'support'
+require 'groundwork'
+require 'exception'
+
+require 'tones'
+Pinyin::Tones::All.each{|m| require 'tones/'+m}
+
+require 'conversions'
+
+
+module Pinyin
+  class Reader
+    def initialize(conv, tone)
+      @conv = conv.to_s #Conversions.const_get conv.to_s.camelize
+      @tone = Tones.const_get tone.to_s.camelize
+    end
+
+    def parse(str)
+      Conversions.tokenize(str).map do |s, pos|
+        tone,syll = @tone.pop_tone(s)
+        tsyll = Conversions.parse(@conv,syll)
+        ini, fin = tsyll.initial, tsyll.final
+        raise ParseError.new(s,pos),"Illegal syllable <#{s}> in input <#{str}> at position #{pos}." unless tone && fin && ini
+        Syllable.new(ini, fin, tone)
+      end
+    end
+
+    alias :<< :parse
+  end
+
+  class Writer
+    def initialize(conv, tone)
+      @conv = conv.to_s #Conversions.const_get conv.to_s.camelize
+      @tone = Tones.const_get tone.to_s.camelize
+    end
+
+    def unparse(py)
+      conv=lambda {|syll| @tone.add_tone(Conversions.unparse(@conv,syll),syll.tone)}
+      if py.respond_to? :map
+        py.map(&conv).join(' ')
+      else
+        conv.call(py)
+      end
+    end
+
+    alias :<< :unparse
+  end
+
+  class Converter
+    def initialize(from, from_tone, to, to_tone)
+      @reader = Reader.new(from, from_tone)
+      @writer = Writer.new(to, to_tone)
+    end
+
+    def convert(str)
+      @writer.unparse @reader.parse(str)
+    end
+
+    alias :<< :convert
+  end
+end
+
+

data/lib/support.rb

@@ -0,0 +1,16 @@
+class String
+  def camelize
+    self.split(/_/).map{|p|p.capitalize}.join
+  end
+
+  def chars
+    self.unpack('U*').map{|c| [c].pack('U')}
+  end
+end
+
+class Object
+  def returning(s)
+    yield(s)
+    s
+  end
+end