A Ruby gem for Vietnamese diacritics. It solves two problems:
- Accent placement — determines which letter in a Vietnamese word should receive the accent mark (e.g., in "ngoay", the accent goes on the "a")
- IME input — transforms numeric-suffixed text into accented Vietnamese using the VNI input method
Vietnamese accent placement follows specific rules based on vowel combinations and consonant pairs. This gem encodes those rules so you don't have to.
gem install diacriti_xOr add to your Gemfile:
gem 'diacriti_x'require 'diacriti_x'
# Find which letter gets the accent
result = DiacritiX::Accentifier.call('ngoay')
result.success? # => true
result.result # => 3 (index of 'a')
# Transform VNI input into Vietnamese
vni = DiacritiX::IME::VNI.new
vni.call('Viet65 Nam') # => "Việt Nam"
vni.call('toi1') # => "tói"
vni.call('di9') # => "đi"| Key | Diacritic | Example |
|---|---|---|
| 1 | Acute (á) | a1 → á |
| 2 | Grave (à) | a2 → à |
| 3 | Hook above (ả) | a3 → ả |
| 4 | Tilde (ã) | a4 → ã |
| 5 | Dot below (ạ) | a5 → ạ |
| 6 | Circumflex (â) | a6 → â |
| 7 | Horn (ư, ơ) | u7 → ư |
| 8 | Breve (ă) | a8 → ă |
| 9 | Đ stroke | d9 → đ |
# Highlight which letter receives the accent
accentify "ngoay"
# => ngo[a]y (the 'a' is highlighted in green)
# Transform VNI input into Vietnamese
ruby bin/ime/vni "Vie6t5 Nam"
# => Việt NamThe Accentifier applies rules in priority order — first match wins:
- Special Vietnamese vowels — ơ, ư always take the accent
- Vietnamese vowels — ă, â, ê, ô take priority over plain Latin vowels
- Vowel pairs — in oa, oe, oo, uy, ươ the second vowel gets it
- Consonant pairs — after gi, qu the accent goes on the next vowel
- Fallback — first vowel found
git clone https://github.com/DiDi035/DiacritiX.git
cd DiacritiX
bundle install
bundle exec rake test
bundle exec rubocop