phonetic_encoder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bffd07f7683a402aee61e29fb8ac44fc5e4a4e3dc7eefdba982a83c16d313e1b
+  data.tar.gz: 768e2c485c8600e6bdc37c190effb218f7733a79c807895e27cbf9629842bfba
+SHA512:
+  metadata.gz: 3f3a201efed82057d67ba2a4852e20a6614947d5f37d7216aacdad9182ca02f99978c76c9d6908e8f6bb1c52854a879e508e216ede15e0f19c2e694ef7791cb8
+  data.tar.gz: 6f4be6b167f10e9b6d1ece2e3144a5d54dad913d91ee1fd0fbdc3634c7389cc0958599b8467f46f0c774b2bcd5c4273040c07ad5197a955eac7924ea61326189

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+Layout/IndentationWidth:
+  Width: 4
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/MethodLength: 
+  Max: 60
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Naming/FileName:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/WordArray:
+  EnforcedStyle: brackets
+

data/.travis.yml

@@ -0,0 +1,33 @@
+sudo: required
+matrix:
+  include:
+  - language: ruby
+    rvm: 2.2
+    before_install:
+      - gem install bundler -v 1.16.1
+  - language: ruby
+    rvm: 2.4.4
+    before_install:
+      - gem install bundler -v 1.17.3
+  - language: ruby
+    env: SKIP_INTERPRETER=true
+    rvm: 2.4.4
+    before_install:
+      - git clone https://github.com/TravisToolbox/rubocop-travis.git travis/rubocop
+    install:
+      - ./travis/rubocop/install.sh
+    script:
+      - ./travis/rubocop/scan.sh
+  - language: ruby
+    rvm: 2.2
+    before_install:
+      - mkdir travis
+      - git clone https://github.com/TravisToolbox/awesomebot-travis.git travis/awesomebot
+    install:
+      - ./travis/awesomebot/install.sh
+    script:
+      - ./travis/awesomebot/scan.sh
+notifications:
+  email: false
+  slack:
+    secure: AQJTKN/jwYYuFhEmFeLbTdDA8BUue1SSK9KppAFfRgDPLVeo0NhNtAWjSg+cAw6eZx4byKv3cLe2cUrNwxcPJf0XWMsEnNrja8dx+Y8e/R19rWvAMKpSnEyHhLWoTOL9+lQFbQfS4/GC0tTz/riqirr+OmhFmuUQ4rVmR/VxqAZrQjiu9ab2mgkKGG1wj9p8gUCdqqy1GB/20dRXvZ0MMoKbXORBbXFThmEc0ItWB7n+3bb+GMfT71/4roTJdlMRtPKSYF6JtDi0AfUpd8p5+J4JwfJqDwHB/j4FttiryI3aj2ixTMpenEE5cHon33Yn/L3mzj1P0YilghMbrgLI+O/FCpYUemXZi3BZ6OhosXNaIe19delXaPfu58nbqkaN9BLD1fN8cwBkKYIe6r1m8+FvIf8sF9xOxNsMx8EOepiYbsMX1LytSvRCI3I8ydgdSJxkSRbYFsnFV3hvpOg/46t9AU+TlkEq3vtX3SAUrrUEEbHfkij4puYhgZKFfry9Drnk8HEmJesVPMMuzYbYCaXRKazeHVErEtfSmWggz7DV4zEKWv9SKYuYLvRfosEzuvkA8/uUpTPTtd9uwIcB6Hued96KNOJpyKn1v55wjdKhkyOYPX6UvhsTEXkoBkgMuNiKjFYpKqCp69c4iuIG4YgqMubF5e9p33c2yAZy/FM=

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.0.0 (January 24, 2019)
+
+* Initial Release ([@TGWolf][])
+
+[@TGWolf]: https://github.com/TGWolf

data/CODEOWNERS

@@ -0,0 +1,7 @@
+# The codeowners file:
+#
+# For more information please read: https://help.github.com/articles/about-codeowners/
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+*       @wolfsoftware/reviewers

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tim.gurney@timgurney.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in phonetic_encoder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tim Gurney
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+[![Build Status](https://img.shields.io/travis/WolfSoftware/phonetic_encoder/master.svg)](https://travis-ci.org/WolfSoftware/phonetic_encoder)
+[![Software License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
+[![Release](https://img.shields.io/github/release/wolfsoftware/phonetic_encoder.svg)](https://github.com/wolfsoftware/phonetic_encoder/releases/latest)
+[![Gem Version](https://badge.fury.io/rb/phonetic_encoder.svg)](https://badge.fury.io/rb/phonetic_encoder)
+[![Github commits (since latest release)](https://img.shields.io/github/commits-since/wolfsoftware/phonetic_encoder/latest.svg)](https://github.com/wolfsoftware/phonetic_encoder/commits)
+[![GitHub repo size in bytes](https://img.shields.io/github/repo-size/wolfsoftware/phonetic_encoder.svg)](https://github.com/wolfsoftware/phonetic_encoder)
+[![GitHub contributors](https://img.shields.io/github/contributors/wolfsoftware/phonetic_encoder.svg)](https://github.com/wolfsoftware/phonetic_encoder)
+
+# 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:
+
+```ruby
+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.
+
+```ruby
+  pe = PhoneticEncoder.new
+
+  puts pe.encode('abc')
+```
+
+### Extended Usage
+
+You can also use the built-in 'sounds' dictionary.
+
+```ruby
+  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](https://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](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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](https://github.com/WolfSoftware/phonetic_encoder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "phonetic_encoder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/phonetic_encoder

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'phonetic_encoder'
+
+# -------------------------------------------------------------------------------- #
+# Encode                                                                           #
+# -------------------------------------------------------------------------------- #
+# This function will take a string and encode it.                                  #
+# -------------------------------------------------------------------------------- #
+
+def encode(options)
+    npa = PhoneticEncoder.new
+
+    if options[:dictionary]
+        puts npa.encode(options[:message], options[:dictionary])
+    else
+        puts npa.encode(options[:message])
+    end
+end
+
+# -------------------------------------------------------------------------------- #
+# Process Arguments                                                                #
+# -------------------------------------------------------------------------------- #
+# This function will process the input from the command line and work out what it  #
+# is that the user wants to see.                                                   #
+#                                                                                  #
+# This is the main processing function where all the processing logic is handled.  #
+# -------------------------------------------------------------------------------- #
+
+def process_arguments
+    options = {}
+    # Enforce the presence of
+    mandatory = %I[message]
+
+    optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($PROGRAM_NAME)}"
+
+        opts.on('-h', '--help', 'Display this screen') do
+            puts opts
+            exit(1)
+        end
+
+        opts.on('-d', '--dictionary string', 'The dictionary to us') do |dictionary|
+            options[:dictionary] = dictionary
+        end
+        opts.on('-m', '--message string', 'The message to encode') do |message|
+            options[:message] = message
+        end
+    end
+
+    begin
+        optparse.parse!
+        missing = mandatory.select { |param| options[param].nil? }
+        raise OptionParser::MissingArgument.new(missing.join(', ')) unless missing.empty?
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        puts e.to_s
+        puts optparse
+        exit(1)
+    end
+
+    encode(options)
+end
+
+# -------------------------------------------------------------------------------- #
+# Main()                                                                           #
+# -------------------------------------------------------------------------------- #
+# The main function where all of the heavy lifting and script config is done.      #
+# -------------------------------------------------------------------------------- #
+
+def main
+    process_arguments
+end
+
+main
+
+# -------------------------------------------------------------------------------- #
+# End of Script                                                                    #
+# -------------------------------------------------------------------------------- #
+# This is the end - nothing more to see here.                                      #
+# -------------------------------------------------------------------------------- #

data/lib/phonetic_encoder.rb

@@ -0,0 +1,36 @@
+require 'phonetic_encoder/version'
+require 'phonetic_encoder/dicts/nato.rb'
+require 'phonetic_encoder/dicts/sounds.rb'
+
+#
+# Docs to come
+#
+class PhoneticEncoder
+    def initialize
+        @dict = {}
+
+        @dict['nato'] = NATO
+        @dict['sounds'] = SOUNDS
+    end
+
+    def custom(name, dict)
+        @dict[name] = dict
+    end
+
+    def letter_from_dictionary(letter, dict)
+        dict.key?(letter) ? dict[letter].downcase : letter
+    end
+
+    def encode(text, dict_name = 'nato')
+        dict_name = 'nato' if dict_name.empty?
+
+        return text unless @dict.key?(dict_name)
+
+        result = ''
+
+        text.downcase.split('').each do |letter|
+            result << format('%<word>s ', word: letter_from_dictionary(letter, @dict[dict_name]))
+        end
+        result.rstrip
+    end
+end

data/lib/phonetic_encoder/dicts/nato.rb

@@ -0,0 +1,28 @@
+class PhoneticEncoder
+    NATO = { 'a' => 'alpha',
+             'b' => 'bravo',
+             'c' => 'charlie',
+             'd' => 'delta',
+             'e' => 'echo',
+             'f' => 'foxtrot',
+             'g' => 'golf',
+             'h' => 'hotel',
+             'i' => 'india',
+             'j' => 'juliett',
+             'k' => 'kilo',
+             'l' => 'lima',
+             'm' => 'mike',
+             'n' => 'november',
+             'o' => 'oscar',
+             'p' => 'papa',
+             'q' => 'quebec',
+             'r' => 'romeo',
+             's' => 'sierra',
+             't' => 'tango',
+             'u' => 'uniform',
+             'v' => 'victor',
+             'w' => 'whiskey',
+             'x' => 'x-ray',
+             'y' => 'yankee',
+             'z' => 'zulu' }.freeze
+end

data/lib/phonetic_encoder/dicts/sounds.rb

@@ -0,0 +1,28 @@
+class PhoneticEncoder
+    SOUNDS = { 'a' => 'aye',
+               'b' => 'bee',
+               'c' => 'sea',
+               'd' => 'dee',
+               'e' => 'ee',
+               'f' => 'eff',
+               'g' => 'jee',
+               'h' => 'aytch',
+               'i' => 'eye',
+               'j' => 'jay',
+               'k' => 'kay',
+               'l' => 'el',
+               'm' => 'em',
+               'n' => 'en',
+               'o' => 'oh',
+               'p' => 'pee',
+               'q' => 'cue',
+               'r' => 'are',
+               's' => 'ess',
+               't' => 'tee',
+               'u' => 'you',
+               'v' => 'vee',
+               'w' => 'doubleyou',
+               'x' => 'ex',
+               'y' => 'why',
+               'z' => 'zed' }.freeze
+end

data/lib/phonetic_encoder/version.rb

@@ -0,0 +1,3 @@
+class PhoneticEncoder
+    VERSION = '1.0.0'.freeze
+end

data/phonetic_encoder.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "phonetic_encoder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "phonetic_encoder"
+  spec.version       = PhoneticEncoder::VERSION
+  spec.authors       = ["Tim Gurney"]
+  spec.email         = ["tim.gurney@timgurney.net"]
+
+  spec.summary       = %q{Display the NATO Phonetic name for any given letter or word.}
+  spec.description   = %q{A ruby gem to display the NATO Phonetic name for any given letter or word. You can also pass custom dictionaries.}
+  spec.homepage      = "https://github.com/WolfSoftware/phonetic_encoder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: phonetic_encoder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Gurney
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A ruby gem to display the NATO Phonetic name for any given letter or
+  word. You can also pass custom dictionaries.
+email:
+- tim.gurney@timgurney.net
+executables:
+- phonetic_encoder
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/phonetic_encoder
+- lib/phonetic_encoder.rb
+- lib/phonetic_encoder/dicts/nato.rb
+- lib/phonetic_encoder/dicts/sounds.rb
+- lib/phonetic_encoder/version.rb
+- phonetic_encoder.gemspec
+homepage: https://github.com/WolfSoftware/phonetic_encoder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Display the NATO Phonetic name for any given letter or word.
+test_files: []