punctuation_name 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 684c3f5e13875e1a1d76b78ca8975d559a723728637135208c298af5882b73ad
+  data.tar.gz: f65a627fca39f82c93bd5e25a9cbd2e00c03045bd0940d3c889db1991bdb5753
+SHA512:
+  metadata.gz: bb02cfe153b846d167a62bae21d2ab49df37947f947a564b1a6ccdb4732d0066302c3285f3c2c1cb2c1f4df583730b045189e79bb4c21d6355fb3be91efdc9cc
+  data.tar.gz: c98fadd0960ac792566a9f7ff30c47a74e2942992dd1425c3d41264d04f641eb4ecd1748e539b3848b76858ea6ee0f191d23ff8004c4542265154825d58b98b8

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,30 @@
+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
+
+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: aHyur6wPDdNr+PAVuQk5UUabbTqe7IkeG61tsfqYZ0lNZ1fai293FNXZ4oi+ppLQq5snJJcqs3D2kCiHhOFjrWOeoR7wtpjPKZnsjO9kYdsRCf3O3d3auNnxUIH907X4vHLzyrQRq7/NNa5PAD3RE2i0CmDcdoQS0FaycrA0EDl4pDtUu9UQZq+KipiuakO3fJAqcve03nqzlj2JwwFnFdKkzWHEMrfqYhtnkzJ+AwS8yLGV5I6QDRHwHuW0d0Dn8dD32oXTaSJucaimy0Wj4vjWs39MdO/Ob2V9LVdxsYjg1gVmrqeShCwPm7yczhZByHpwYBmjyX2oH0k0HJ1seYzSvyAKUgorwAtCAmwLRgr459w8OJR5y3VGGtvUQ5TCKeX39laaQta++iQimnzsmchVQ+3Yto2hZ0TlvO4TluXpYBDCcQcwbo1IK4tcAvRGRJxPJd/c97POJjeOeM8WLgAP4bOAuNr2+y+0sWi8yProt9zZSDrz5vItzKC0Y5akqkVMupi/TRP/lQU7R2L1+29zNADdZAT5wJ2Ubhp4n2MVuKXwk2IPqjZuyFW3R+ryO9QQqZQITA86hYM3ypdq3iqOfDOkfLXYaow6S9cjjRsnf59vgFdjxxRF7evuxB7jRPZ4t92NSQFXSCDEeolJsWq6jMYbj/4s1aPIoRgZ/W8=

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 wolf@tgwolf.com. 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 punctuation_name.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tim Gurney aka Wolf
+
+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,85 @@
+[![Build Status](https://img.shields.io/travis/WolfSoftware/punctuation_name/master.svg)](https://travis-ci.org/WolfSoftware/punctuation_name)
+[![Software License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
+[![Release](https://img.shields.io/github/release/wolfsoftware/punctuation_name.svg)](https://github.com/wolfsoftware/punctuation_name/releases/latest)
+[![Gem Version](https://badge.fury.io/rb/punctuation_name.svg)](https://badge.fury.io/rb/punctuation_name)
+[![Github commits (since latest release)](https://img.shields.io/github/commits-since/wolfsoftware/punctuation_name/latest.svg)](https://github.com/wolfsoftware/punctuation_name/commits)
+[![GitHub repo size in bytes](https://img.shields.io/github/repo-size/wolfsoftware/punctuation_name.svg)](https://github.com/wolfsoftware/punctuation_name)
+[![GitHub contributors](https://img.shields.io/github/contributors/wolfsoftware/punctuation_name.svg)](https://github.com/wolfsoftware/punctuation_name)
+
+# Punctuation Name
+
+A ruby gem to display the name for any given punctuation. Comes with a UK and US dictionary but you can also pass custom dictionaries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'punctuation_name'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install punctuation_name
+
+## Usage
+
+### Simple Usage
+
+You can use the default built in dictionary which is UK/English.
+
+```ruby
+  p = PunctuationName.new
+
+  puts p.name('!')
+```
+
+### Extended Usage
+
+You can also use the built-in US dictionary.
+
+```ruby
+  p = PunctuationName.new
+
+  puts p.name('!', 'us')
+```
+
+### 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.
+
+```
+  p = PunctuationName.new
+  p.custom('custom', { '!' => 'shouty marker' })
+  puts p.name('!', 'custom')
+```
+
+## Return Value
+
+The gem will return the name of the punctuation if it can be found in the selected dictionary, if not the original punctuation is returned.
+
+## 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/punctuation_name. 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 PunctuationName project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/WolfSoftware/punctuation_name/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 "punctuation_name"
+
+# 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/punctuation_name

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'punctuation_name'
+
+# -------------------------------------------------------------------------------- #
+# Send Mssage to Slack                                                             #
+# -------------------------------------------------------------------------------- #
+# This function will take the input arguments and then send the message.           #
+# -------------------------------------------------------------------------------- #
+
+def punctuation_name(options)
+    pn = PunctuationName.new
+
+    if options[:dictionary]
+        puts pn.name(options[:punctuation], options[:dictionary])
+    else
+        puts pn.name(options[:punctuation])
+    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[punctuation]
+
+    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('-p', '--punctuation string', 'The punctuation to lookup') do |punctuation|
+            options[:punctuation] = punctuation
+        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
+
+    punctuation_name(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/punctuation_name/dicts/uk.rb

@@ -0,0 +1,36 @@
+class PunctuationName
+    UK_NAMES = { '!' => 'exclamation mark',
+                 '@' => 'at sign',
+                 '#' => 'hash',
+                 '£' => 'pound',
+                 '$' => 'dollar',
+                 '%' => 'percent',
+                 '^' => 'carat',
+                 '&' => 'ampersand',
+                 '*' => 'asterisk',
+                 '(' => 'open parenthesis',
+                 ')' => 'close parenthesis',
+                 '-' => 'hyphen',
+                 '_' => 'underscore',
+                 '+' => 'plus',
+                 '=' => 'equal sign',
+                 '{' => 'open brace',
+                 '}' => 'close brace',
+                 '[' => 'open bracket',
+                 ']' => 'close bracket',
+                 ';' => 'semi colon',
+                 ':' => 'colon',
+                 '"' => 'quote',
+                 '|' => 'pipe',
+                 '~' => 'tilde',
+                 '`' => 'backtick',
+                 '<' => 'less than',
+                 '>' => 'greater than',
+                 '?' => 'question mark',
+                 ',' => 'comma',
+                 '.' => 'full stop',
+                 '/' => 'forward slash',
+                 ' ' => 'space',
+                 '\'' => 'apostrophe',
+                 '\\' => 'back slash' }.freeze
+end

data/lib/punctuation_name/dicts/us.rb

@@ -0,0 +1,36 @@
+class PunctuationName
+    US_NAMES = { '!' => 'exclamation mark',
+                 '@' => 'at sign',
+                 '#' => 'hash',
+                 '£' => 'pound',
+                 '$' => 'dollar',
+                 '%' => 'percent',
+                 '^' => 'carat',
+                 '&' => 'ampersand',
+                 '*' => 'asterisk',
+                 '(' => 'open parenthesis',
+                 ')' => 'close parenthesis',
+                 '-' => 'hyphen',
+                 '_' => 'underscore',
+                 '+' => 'plus',
+                 '=' => 'equal sign',
+                 '{' => 'open brace',
+                 '}' => 'close brace',
+                 '[' => 'open bracket',
+                 ']' => 'close bracket',
+                 ';' => 'semi colon',
+                 ':' => 'colon',
+                 '"' => 'quote',
+                 '|' => 'pipe',
+                 '~' => 'tilde',
+                 '`' => 'backtick',
+                 '<' => 'less than',
+                 '>' => 'greater than',
+                 '?' => 'question mark',
+                 ',' => 'comma',
+                 '.' => 'period',
+                 '/' => 'forward slash',
+                 ' ' => 'space',
+                 '\'' => 'apostrophe',
+                 '\\' => 'back slash' }.freeze
+end

data/lib/punctuation_name/version.rb

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

data/lib/punctuation_name.rb

@@ -0,0 +1,31 @@
+require 'punctuation_name/version'
+require 'punctuation_name/dicts/uk.rb'
+require 'punctuation_name/dicts/us.rb'
+
+#
+# Add docs
+#
+class PunctuationName
+    def initialize
+        @dict = {}
+
+        @dict['uk'] = UK_NAMES
+        @dict['us'] = US_NAMES
+    end
+
+    def custom(name, dict)
+        @dict[name] = dict
+    end
+
+    def name_from_dictionary(punctuation, dict)
+        dict.key?(punctuation) ? dict[punctuation] : punctuation
+    end
+
+    def name(punctuation, dict_name = 'uk')
+        dict_name = 'uk' if dict_name.empty?
+
+        return punctuation unless @dict.key?(dict_name)
+
+        name_from_dictionary(punctuation, @dict[dict_name])
+    end
+end

data/punctuation_name.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "punctuation_name/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "punctuation_name"
+  spec.version       = PunctuationName::VERSION
+  spec.authors       = ["Tim Gurney aka Wolf"]
+  spec.email         = ["wolf@tgwolf.com"]
+
+  spec.summary       = %q{Display the name for any given punctuation.}
+  spec.description   = %q{Display the name for any given punctuation. Comes with a UK and US dictionary but you can also pass custom dictionaries.}
+  spec.homepage      = "https://github.com/WolfSoftware/punctuation_name"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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: punctuation_name
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Gurney aka Wolf
+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: Display the name for any given punctuation. Comes with a UK and US dictionary
+  but you can also pass custom dictionaries.
+email:
+- wolf@tgwolf.com
+executables:
+- punctuation_name
+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/punctuation_name
+- lib/punctuation_name.rb
+- lib/punctuation_name/dicts/uk.rb
+- lib/punctuation_name/dicts/us.rb
+- lib/punctuation_name/version.rb
+- punctuation_name.gemspec
+homepage: https://github.com/WolfSoftware/punctuation_name
+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 name for any given punctuation.
+test_files: []