Romajify

Japanese romanization library for Ruby.

http://qiita.com/emsk/items/3e24628c220c825da709 (Japanese)

Prerequisite

You have to install Ruby 2.0.0 or higher.

Installation

Add this line to your application's Gemfile:

gem 'romajify'

And then execute:

$ bundle

Or install it yourself as:

$ gem install romajify

Usage

Command Line Interface

$ romajify hepburn すし

Ruby Source Code

require 'romajify/converter'
puts Romajify::Converter.hepburn('すし')

Supported Romaji

Hepburn Romaji

Modified Hepburn:

$ romajify hepburn しんばし
shinbashi

Traditional Hepburn:

$ romajify hepburn --traditional しんばし
shimbashi

Nihon-shiki Romaji

$ romajify nihon まちづくり
matidukuri

Kunrei-shiki Romaji

$ romajify kunrei まちづくり
matizukuri

Command Options

Option	Description	Default
-u/--upcase	Whether to return upper case.	false - Lower case
-t/--traditional	Whether to convert to traditional hepburn. This is the option only for hepburn command.	false - Modified hepburn

Documentation

http://www.rubydoc.info/gems/romajify

Supported Ruby Versions

Ruby 2.0.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0

Contributing

1. Fork it ( https://github.com/emsk/romajify/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Related

• mruby-romajify - An mruby implementation of the romajify
• go-romajify - Pure Go implementation of the romajify
• romajic - Automatic romaji spelling checker for programmer

License

MIT