Phonetic Encoder

A ruby gem to display the NATO Phonetic name for any given letter. You can also pass custom dictionaries.

Installation

Add this line to your application's Gemfile:

gem 'phonetic_encoder'

And then execute:

$ bundle

Or install it yourself as:

$ gem install phonetic_encoder

Usage

Simple Usage

You can use the default built in dictionary which is NATO.

  pe = PhoneticEncoder.new

  puts pe.encode('abc')

Extended Usage

You can also use the built-in 'sounds' dictionary.

  pe = PhoneticEncoder.new

  puts pe.encode('abc', 'sounds')

Advanced Usage

You can define your own dictionary, the below example just does a single item, but you can make the set as large as you need.

  pe = PhoneticEncoder.new

  pe.custom('custom', 'a' => 'apple', 'b' => 'ballon', 'c' => 'cat')

  puts pe.encode('abc', 'custom')

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Testing

For local testing make sure that you run bundle exec rspec spec and then rake install to install the gem locally.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/WolfSoftware/phonetic_encoder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the phonetic_encoder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.