kwhittington / united_states Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 70 KB

The names and abbreviations of each United States of America State.

License: MIT License

Ruby 98.57% Shell 1.43%

united_states's Introduction

UnitedStates

The names and postal codes of each United States of America State.

Installation

Add this line to your application's Gemfile:

gem 'united_states'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install united_states

united_states is tested against the following stable ruby versions:

MRI 2.1.10
MRI 2.2.10
MRI 2.3.8
MRI 2.4.4
MRI 2.5.3
MRI 2.6.0

Usage

require 'united_states'

UnitedStates.all
# => [#<UnitedStates::State::Designation...@string="WY">]
UnitedStates.names
#=> [#<UnitedStates::State::Name...@string="Wyoming">]
UnitedStates.postal_codes
#=> [#<UnitedStates::State::PostalCode...@string="WY"]
UnitedStates[:LA]
# => [#<UnitedStates::State::Designation...@string="LA">]
UnitedStates['mississippi']
# => [#<UnitedStates::State::Designation...@string="MS">]
UnitedStates['car']
# => UnitedStates::NoDesignationFoundError

Development

Branching

Checkout the repo. If making a hot_fix branch, branch from master. If making a bug_fix/chore/enhancement branch, branch from development. Be sure to update CHANGELOG.md (see http://keepachangelog.com/en/0.3.0/) with your changes.

Setup

Run ./bin/setup to install dependencies.

Testing

Run ./bin/test to run code quality checks and tests.

Documenting

Run ./bin/document to generate doc/ and open doc/index.html to view the documentation. See http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md for documentation syntax.

Seat-of-the-Pants Testing

Run ./bin/console for an interactive prompt that will allow you to experiment.

Manual installation

To install this gem onto your local machine, run bundle exec rake install.

Deployment

To release a new version, you must first have authorization to push to rubygems. If so, make a new chore/#ISSUE_NUMBER_update_version_to_MAJOR_MINOR_PATCH, update UnitedStates::VERSION number (per Semantic Versioning) in lib/united_states/version.rb, change the Unreleased section of CHANGELOG.md to the new version number, and then make a pull request merging to development.

After development has been updated with the new version number, make a pull request merging the new changes to master.

Once master has been updated, checkout the latest master and 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kWhittington/united_states. 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.

united_states's People

Contributors

Watchers

united_states's Issues

NameError: uninitialized constant UnitedStates::Pathname

This error is thrown whenever attempting to use the UnitedStates.names method from an irb console:

kwhittin at Kyles-MacBook-Pro in ~/D/P/R/playground (master|✔)
» gem install united_states
Fetching: united_states-1.2.0.gem (100%)
Successfully installed united_states-1.2.0
Parsing documentation for united_states-1.2.0
Installing ri documentation for united_states-1.2.0
Done installing documentation for united_states after 0 seconds
1 gem installed
kwhittin at Kyles-MacBook-Pro in ~/D/P/R/playground (master|✔)
» irb
irb(main):001:0> require 'united_states'
=> true
irb(main):002:0> UnitedStates.names
NameError: uninitialized constant UnitedStates::Pathname
        from /Users/kwhittin/.rvm/gems/ruby-2.3.1/gems/united_states-1.2.0/lib/united_states.rb:89:in `array_from_yaml_file'
        from /Users/kwhittin/.rvm/gems/ruby-2.3.1/gems/united_states-1.2.0/lib/united_states.rb:36:in `all'
        from /Users/kwhittin/.rvm/gems/ruby-2.3.1/gems/united_states-1.2.0/lib/united_states.rb:133:in `names'
        from (irb):2
        from /Users/kwhittin/.rvm/rubies/ruby-2.3.1/bin/irb:11:in `<main>'

Add UnitedStates::State::GovernmentPrintingOfficeAbbreviation

https://en.wikipedia.org/wiki/List_of_U.S._state_abbreviations

All of the formats seem to end in a . if the abbreviation is less than the full name (some are the full name: Alaska, Hawaii, Idaho, Iowa, Maine, Ohio, Utah). They all have leading capital letters for each word, too.

Issue with path to YAML file

I keep getting this error when trying to implement the collection + methods in a form: "'./lib/united_states/designations.yml' does not exist.
Please supply a path to a YAML file."
I get this error when experiment with 'UnitedStates.names' in my console and local server.

Can CircleCI test against multiple ruby versions?

Add branching instructions to `README.md`

The development branch will be taking in new chore/bug_fix/enhancement branch pull request. I should update the README.md to include these branching instructions.

Update README.md with supported versions.

Add UnitedStates::State::Designation#government_printing_office

#government_printing_office (aliased as #gpo), will be a UnitedStates::State::GovernmentPrintingOfficeAbbreviation.

Release 1.2.0

Time to release all the work done for moving state designation configuration into a YAML file.

Add UnitedStates::State::Designation#abbreviation

#abbreviation (aliased as #abbr, #abbrv, #abbrev)
will be the #government_printing_office abbreviation value.

Needs #27.

Add deployment instructions to `README.md`

README.md Deployment section needs to be updated to include the pull request workflow:
when releasing a new version, branch a chore/#N_update_version_to_MAJOR_MINOR_PATCH from development, update UnitedStates::VERSION (following SemVer protocol), make a pull request merging to development. After development has been updated, make a pull request merging development to master. After master has been updated, checkout the latest master and run bundle exec rake release.

Release UnitedStates::VERSION 1.1.1

Now I've documented branching, CHANGELOG.md, and deployment information, I'll add this to the official release as a patch.

Add `development` branch to GitHub

Push up a development branch to GitHub.
Set it as a "Protected Branch".
- Require everyone but admins to need an approved review.
- Require everyone to have a successful CircleCI build.

Make a configuration method that takes a hash

Following the advice from http://stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem, we first need a configuration method that will intake a Hash object.

Make a configuration method that takes a YAML file

A module function to load an array of UnitedState::State::Designation values from a YAML file.

require 'united_states'

UnitedStates.from_yaml_file(path: './config/states.yml')
# => [<UnitedStates::State::Designation . . . >, . . ., <UnitedStates::State::Designation . . . >]