united_states 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57a8fb95992e8e31553927c4a477cb5dd2743f0a
-  data.tar.gz: a57c5c48764716a56734beda287000eb09cb239f
+  metadata.gz: 7531af5d720089625de67dd1edf5b7021311b226
+  data.tar.gz: b7dc7fb19fa7609d05e8e5381d6ba005170862fe
 SHA512:
-  metadata.gz: 7cdb9b46ef9be6584bf11dee2d4eea8e70574c9bdbe4a8aea1b1dab8d35c02311505cb6a75fb6fb82903ce88c41a1e09e63ddbd1e04db3956eb14850e0267302
-  data.tar.gz: bdb5242d316e9800edb16975f1e2531d5dce8beb4bd0943f6f6da7ccec583366e76915f314f137b01e4d5364b41e6706d7ab5221447400b44a351607e71645e4
+  metadata.gz: 6ff7b6b550c343b2096f949d51fcba2c7bb5033bc2b66920d0fb043eb88d7406af0f73da6b402da2d14fcd972966d97b223d95a4a8339d7df521305f89725aa7
+  data.tar.gz: fd2f499ed1c80aeb244e1f242decc77386760b6a93ae0baa0989a2cafe5e600de4be28335052c085ec1af033f18f0db6fdb44226328d9c2c4c6059a4e4c7308c

data/.rubocop.yml

@@ -4,7 +4,9 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  Exclude:
+    - rubygems*/
+  TargetRubyVersion: 2.1
 
 Documentation:
   Exclude:

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+__Change Groups__:
+
+`Added`, `Changed`, `Deprecated`, `Fixed`, `Removed`, `Security`
+
+## [Unreleased]
+
+## [1.1.1] - 2017-02-18
+### Added
+- `CircleCI` now tests against `Ruby` versions `2.1.10`, `2.2.6`, `2.3.3`, `2.4.0`.
+- [`CHANGELOG.md`](CHANGELOG.md) following http://keepachangelog.com/en/0.3.0/.
+- `./bin/circle_ci` for all `CircleCI`-specific scripts.
+
+### Changed
+- `./bin/` scripts are verbose.
+- `README.md` `Development` section expanded with branching details.
+- `README.md` `Deployment` section expanded with branching details.
+
+## [1.1.0] - 2017-02-11
+### Added
+- `UnitedStates.find_by_name(name)` to find a `UnitedStates::State::Designation` with matching name.
+- `UnitedStates.find_by_postal_code(postal_code)` to find a `UnitedStates::State::Designation` with matching postal code.
+- `UnitedStates.[](name_or_postal_code)` to find a `UnitedStates::State::Designation` with matching name or postal code.
+- Support for `Symbol` values as "name" or "postal code" parameters.
+
+### Changed
+- All references of `abbreviation` to `postal code`.
+- `UnitedStates.abbreviations` -> `.postal_codes`
+- `UnitedStates::State::Abbreviation` -> `UnitedStates::State::PostalCode`.
+- `UnitedStates::State::Designation#abbreviation` -> `#postal_code`
+
+
+## [1.0.2] - 2017-02-09
+### Added
+- Usage examples to `README.md`.
+
+## [1.0.1] - 2017-02-08
+### Fixed
+- GitHub repo url in `README.md`.
+
+## [1.0.0] - 2017-02-08
+### Added
+- `UnitedStates` module.
+- `UnitedStates::State::Abbreviation` class.
+- `UnitedStates::State::Designation` class.
+- `UnitedStates::State::Name` class.
+- `./bin/document` to generate documentation.

data/README.md

@@ -20,6 +20,12 @@ Or install it yourself as:
 
     $ gem install united_states
 
+`united_states` is tested against the following [stable `ruby` versions](https://www.ruby-lang.org/en/downloads/):
+  * MRI 2.1.10
+  * MRI 2.2.6
+  * MRI 2.3.3
+  * MRI 2.4.0
+
 ## Usage
 
 ```ruby
@@ -41,19 +47,51 @@ UnitedStates['car']
 
 ## Development
 
-After checking out the repo, run `./bin/setup` to install dependencies.
-Then, run `./bin/test` to run code quality checks and tests.
-Then, run './bin/document' to generate `doc/` and open `doc/index.html`
+### Branching
+
+Checkout the repo. If making a `hot_fix` branch, branch from
+`master`. If making a `bug_fix`/`chore`/`enhancement` branch,
+branch from
+[`development`](https://github.com/kWhittington/united_states/tree/develop).
+Be sure to update [`CHANGELOG.md`](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`](doc/index.html)
 to view the documentation. See
 http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md for
 documentation syntax.
 
-You can also run `./bin/console` for an interactive prompt that will allow
+### 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`. To release a new version, update the version number in
-`version.rb`, and then run `bundle exec rake release`, which will create a
+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](http://semver.org/)) in
+[`lib/united_states/version.rb`](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](https://rubygems.org).
 

data/bin/circle_ci/setup

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler
+wget https://rubygems.org/rubygems/rubygems-2.6.10.tgz
+tar xzvf rubygems-2.6.10.tgz
+cd rubygems-2.6.10
+ruby setup.rb
+cd ..
+rm -rf rubygems-2.6.10
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/circle_ci/test

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rspec -r rspec_junit_formatter --format progress \
+            --format RspecJunitFormatter \
+            -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
+bundle exec rubocop

data/bin/document

@@ -1,2 +1,6 @@
 #!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
 bundle exec yard doc

data/bin/setup

@@ -3,6 +3,9 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
+gem install bundler
+gem install rubygems-update
+update_rubygems
 bundle install
 
 # Do any other automated setup that you need to do here

data/bin/test

@@ -1,3 +1,7 @@
 #!/usr/bin/env bash
-bundle exec rubocop
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
 bundle exec rake spec
+bundle exec rubocop

data/circle.yml

@@ -1,6 +1,6 @@
 dependencies:
   override:
-    - ./bin/setup
+    - rvm 2.1.10,2.2.6,2.3.3,2.4.0 --verbose do ./bin/circle_ci/setup
 test:
   override:
-    - ./bin/test
+    - rvm 2.1.10,2.2.6,2.3.3,2.4.0 --verbose do ./bin/circle_ci/test

data/lib/united_states.rb

@@ -9,7 +9,7 @@ module UnitedStates
   # Thrown when someone attempts to search for a state with
   # the wrong name or postal code.
   class NoDesignationFoundError < StandardError
-    DEFAULT_MESSAGE = 'No State was found.'
+    DEFAULT_MESSAGE = 'No State was found.'.freeze
 
     def initialize(message = DEFAULT_MESSAGE)
       super(message)

data/lib/united_states/state/postal_code.rb

@@ -7,7 +7,8 @@ module UnitedStates
       # Thrown when someone attempts to make a PostalCode instance
       # from a string longer than 2 characters.
       class StringTooLongError < StandardError
-        DEFAULT_MESSAGE = 'string too long, postal code must be 2 characters'
+        DEFAULT_MESSAGE = 'string too long, postal code must be '\
+                          '2 characters'.freeze
 
         def initialize(message = DEFAULT_MESSAGE)
           super(message)
@@ -17,7 +18,8 @@ module UnitedStates
       # Thrown when someone attempts to make a PostalCode instance
       # from a string shorter than 2 characters.
       class StringTooShortError < StandardError
-        DEFAULT_MESSAGE = 'string too short, postal codes must be 2 characters'
+        DEFAULT_MESSAGE = 'string too short, postal codes must be '\
+                          '2 characters'.freeze
 
         def initialize(message = DEFAULT_MESSAGE)
           super(message)

data/lib/united_states/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module UnitedStates
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'.freeze
 end

data/united_states.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-coolline'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.2'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'yard'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: united_states
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Kyle Whittington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-11 00:00:00.000000000 Z
+date: 2017-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -146,11 +160,14 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-gemset"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/circle_ci/setup
+- bin/circle_ci/test
 - bin/console
 - bin/document
 - bin/setup
@@ -182,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: The United States names and postal codes.