united_states 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fde551b3a662e885d43cc07d96e94a10cfa0bb30
-  data.tar.gz: 615807a3028ad3ad8efa2a1303f7da688cf8f999
+  metadata.gz: 57a8fb95992e8e31553927c4a477cb5dd2743f0a
+  data.tar.gz: a57c5c48764716a56734beda287000eb09cb239f
 SHA512:
-  metadata.gz: 08596937e74ee0d49b5fd35b27e7cfed69a648b5bbf3ff0b69cd5c510d53188264012c5ac8bcb4597a14393d7964341ee96af5b64de73fa7c8d3fc3d60e2edb7
-  data.tar.gz: 2fd47a97859d1fd024c10875a6366b7385d1740d1b4d5f9180be516b3ee36d17abfd42a05f954ef5415b071d95dfa1f156f32cbb22d730900e5a8c329fcc45b8
+  metadata.gz: 7cdb9b46ef9be6584bf11dee2d4eea8e70574c9bdbe4a8aea1b1dab8d35c02311505cb6a75fb6fb82903ce88c41a1e09e63ddbd1e04db3956eb14850e0267302
+  data.tar.gz: bdb5242d316e9800edb16975f1e2531d5dce8beb4bd0943f6f6da7ccec583366e76915f314f137b01e4d5364b41e6706d7ab5221447400b44a351607e71645e4

data/.rubocop.yml

@@ -12,6 +12,7 @@ Documentation:
 
 Metrics/BlockLength:
   Exclude:
+    - .rubocop.yml
     - spec/**/*_spec.rb
 
 Metrics/ClassLength:

data/README.md

@@ -2,7 +2,7 @@
 
 [![CircleCI](https://circleci.com/gh/kWhittington/united_states.svg?style=svg)](https://circleci.com/gh/kWhittington/united_states)
 
-The names and abbreviations of each United States of America State.
+The names and postal codes of each United States of America State.
 
 ## Installation
 
@@ -29,8 +29,14 @@ UnitedStates.all
 # => [#<UnitedStates::State::Designation...@string="WY">]
 UnitedStates.names
 #=> [#<UnitedStates::State::Name...@string="Wyoming">]
-UnitedStates.abbreviations
-#=> [#<UnitedStates::State::Abbreviation...@string="WY"]
+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

data/lib/united_states.rb

@@ -6,10 +6,30 @@ require 'united_states/state/designation'
 #
 # Top-level namespace for this gem.
 module UnitedStates
-  # @return [Array<UnitedStates::State::Abbreviation>]
-  #  a collection of all U.S. State Abbreviations.
-  def self.abbreviations
-    all.map(&:abbreviation)
+  # 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.'
+
+    def initialize(message = DEFAULT_MESSAGE)
+      super(message)
+    end
+  end
+
+  # @example
+  #  UnitedStates['louisiana'] # => UnitedSt...Designation
+  #  UnitedStates[:Ms] # => UnitedSt...Designation
+  #  UnitedStates[:marx] # => NoDesignationFoundError
+  # @param name_or_postal_code [String]
+  # @return [UnitedStates::State::Desgination]
+  #  the State Desgination matching the provided name or postal code.
+  # @raise [NoDesignationFoundError]
+  #  if no state Designation exists with the given name or postal code
+  def self.[](name_or_postal_code)
+    name_or_postal_code = name_or_postal_code.to_s
+    invalid_postal_code = name_or_postal_code.length != 2
+    return find_by_name(name_or_postal_code) if invalid_postal_code
+    find_by_postal_code(name_or_postal_code)
   end
 
   # rubocop: disable Metrics/AbcSize
@@ -19,114 +39,149 @@ module UnitedStates
   def self.all
     [
       UnitedStates::State::Designation.new(
-        name: 'Alabama', abbreviation: 'AL'),
+        name: 'Alabama', postal_code: 'AL'),
       UnitedStates::State::Designation.new(
-        name: 'Alaska', abbreviation: 'AK'),
+        name: 'Alaska', postal_code: 'AK'),
       UnitedStates::State::Designation.new(
-        name: 'Arizona', abbreviation: 'AZ'),
+        name: 'Arizona', postal_code: 'AZ'),
       UnitedStates::State::Designation.new(
-        name: 'Arkansas', abbreviation: 'AR'),
+        name: 'Arkansas', postal_code: 'AR'),
       UnitedStates::State::Designation.new(
-        name: 'California', abbreviation: 'CA'),
+        name: 'California', postal_code: 'CA'),
       UnitedStates::State::Designation.new(
-        name: 'Colorado', abbreviation: 'CO'),
+        name: 'Colorado', postal_code: 'CO'),
       UnitedStates::State::Designation.new(
-        name: 'Connecticut', abbreviation: 'CT'),
+        name: 'Connecticut', postal_code: 'CT'),
       UnitedStates::State::Designation.new(
-        name: 'Delaware', abbreviation: 'DE'),
+        name: 'Delaware', postal_code: 'DE'),
       UnitedStates::State::Designation.new(
-        name: 'Florida', abbreviation: 'FL'),
+        name: 'Florida', postal_code: 'FL'),
       UnitedStates::State::Designation.new(
-        name: 'Georgia', abbreviation: 'GA'),
+        name: 'Georgia', postal_code: 'GA'),
       UnitedStates::State::Designation.new(
-        name: 'Hawaii', abbreviation: 'HI'),
+        name: 'Hawaii', postal_code: 'HI'),
       UnitedStates::State::Designation.new(
-        name: 'Idaho', abbreviation: 'ID'),
+        name: 'Idaho', postal_code: 'ID'),
       UnitedStates::State::Designation.new(
-        name: 'Illinois', abbreviation: 'IL'),
+        name: 'Illinois', postal_code: 'IL'),
       UnitedStates::State::Designation.new(
-        name: 'Indiana', abbreviation: 'IN'),
+        name: 'Indiana', postal_code: 'IN'),
       UnitedStates::State::Designation.new(
-        name: 'Iowa', abbreviation: 'IA'),
+        name: 'Iowa', postal_code: 'IA'),
       UnitedStates::State::Designation.new(
-        name: 'Kansas', abbreviation: 'KS'),
+        name: 'Kansas', postal_code: 'KS'),
       UnitedStates::State::Designation.new(
-        name: 'Kentucky', abbreviation: 'KY'),
+        name: 'Kentucky', postal_code: 'KY'),
       UnitedStates::State::Designation.new(
-        name: 'Louisiana', abbreviation: 'LA'),
+        name: 'Louisiana', postal_code: 'LA'),
       UnitedStates::State::Designation.new(
-        name: 'Maine', abbreviation: 'ME'),
+        name: 'Maine', postal_code: 'ME'),
       UnitedStates::State::Designation.new(
-        name: 'Maryland', abbreviation: 'MD'),
+        name: 'Maryland', postal_code: 'MD'),
       UnitedStates::State::Designation.new(
-        name: 'Massachusetts', abbreviation: 'MA'),
+        name: 'Massachusetts', postal_code: 'MA'),
       UnitedStates::State::Designation.new(
-        name: 'Michigan', abbreviation: 'MI'),
+        name: 'Michigan', postal_code: 'MI'),
       UnitedStates::State::Designation.new(
-        name: 'Minnesota', abbreviation: 'MN'),
+        name: 'Minnesota', postal_code: 'MN'),
       UnitedStates::State::Designation.new(
-        name: 'Mississippi', abbreviation: 'MS'),
+        name: 'Mississippi', postal_code: 'MS'),
       UnitedStates::State::Designation.new(
-        name: 'Missouri', abbreviation: 'MO'),
+        name: 'Missouri', postal_code: 'MO'),
       UnitedStates::State::Designation.new(
-        name: 'Montana', abbreviation: 'MT'),
+        name: 'Montana', postal_code: 'MT'),
       UnitedStates::State::Designation.new(
-        name: 'Nebraska', abbreviation: 'NE'),
+        name: 'Nebraska', postal_code: 'NE'),
       UnitedStates::State::Designation.new(
-        name: 'Nevada', abbreviation: 'NV'),
+        name: 'Nevada', postal_code: 'NV'),
       UnitedStates::State::Designation.new(
-        name: 'New Hampshire', abbreviation: 'NH'),
+        name: 'New Hampshire', postal_code: 'NH'),
       UnitedStates::State::Designation.new(
-        name: 'New Jersey', abbreviation: 'NJ'),
+        name: 'New Jersey', postal_code: 'NJ'),
       UnitedStates::State::Designation.new(
-        name: 'New Mexico', abbreviation: 'NM'),
+        name: 'New Mexico', postal_code: 'NM'),
       UnitedStates::State::Designation.new(
-        name: 'New York', abbreviation: 'NY'),
+        name: 'New York', postal_code: 'NY'),
       UnitedStates::State::Designation.new(
-        name: 'North Carolina', abbreviation: 'NC'),
+        name: 'North Carolina', postal_code: 'NC'),
       UnitedStates::State::Designation.new(
-        name: 'North Dakota', abbreviation: 'ND'),
+        name: 'North Dakota', postal_code: 'ND'),
       UnitedStates::State::Designation.new(
-        name: 'Ohio', abbreviation: 'OH'),
+        name: 'Ohio', postal_code: 'OH'),
       UnitedStates::State::Designation.new(
-        name: 'Oklahoma', abbreviation: 'OK'),
+        name: 'Oklahoma', postal_code: 'OK'),
       UnitedStates::State::Designation.new(
-        name: 'Oregon', abbreviation: 'OR'),
+        name: 'Oregon', postal_code: 'OR'),
       UnitedStates::State::Designation.new(
-        name: 'Pennsylvania', abbreviation: 'PA'),
+        name: 'Pennsylvania', postal_code: 'PA'),
       UnitedStates::State::Designation.new(
-        name: 'Rhode Island', abbreviation: 'RI'),
+        name: 'Rhode Island', postal_code: 'RI'),
       UnitedStates::State::Designation.new(
-        name: 'South Carolina', abbreviation: 'SC'),
+        name: 'South Carolina', postal_code: 'SC'),
       UnitedStates::State::Designation.new(
-        name: 'South Dakota', abbreviation: 'SD'),
+        name: 'South Dakota', postal_code: 'SD'),
       UnitedStates::State::Designation.new(
-        name: 'Tennessee', abbreviation: 'TN'),
+        name: 'Tennessee', postal_code: 'TN'),
       UnitedStates::State::Designation.new(
-        name: 'Texas', abbreviation: 'TX'),
+        name: 'Texas', postal_code: 'TX'),
       UnitedStates::State::Designation.new(
-        name: 'Utah', abbreviation: 'UT'),
+        name: 'Utah', postal_code: 'UT'),
       UnitedStates::State::Designation.new(
-        name: 'Vermont', abbreviation: 'VT'),
+        name: 'Vermont', postal_code: 'VT'),
       UnitedStates::State::Designation.new(
-        name: 'Virginia', abbreviation: 'VA'),
+        name: 'Virginia', postal_code: 'VA'),
       UnitedStates::State::Designation.new(
-        name: 'Washington', abbreviation: 'WA'),
+        name: 'Washington', postal_code: 'WA'),
       UnitedStates::State::Designation.new(
-        name: 'West Virginia', abbreviation: 'WV'),
+        name: 'West Virginia', postal_code: 'WV'),
       UnitedStates::State::Designation.new(
-        name: 'Wisconsin', abbreviation: 'WI'),
+        name: 'Wisconsin', postal_code: 'WI'),
       UnitedStates::State::Designation.new(
-        name: 'Wyoming', abbreviation: 'WY')
+        name: 'Wyoming', postal_code: 'WY')
     ]
   end
   # rubocop: enable Metrics/AbcSize
   # rubocop: enable Metrics/MethodLength
 
+  # @example
+  #  UnitedStates.find_by_name('louisiana') # => UnitedSt...Designation
+  #  UnitedStates.find_by_name('marx') # => NoDesignationFoundError
+  # @param name [String]
+  # @return [UnitedStates::State::Desgination]
+  #  the State Desgination matching the provided name.
+  # @raise [NoDesignationFoundError]
+  #  if no state Designation exists with the given name
+  def self.find_by_name(name)
+    name = UnitedStates::State::Name.new(name)
+    all.find { |designation| designation.name == name } || raise(
+      NoDesignationFoundError, "No State named, \"#{name},\" was found.")
+  end
+
+  # @example
+  #  UnitedStates.find_by_postal_code('la') # => UnitedSt...Designation
+  #  UnitedStates.find_by_postal_code('xx') # => NoDesignationFoundError
+  # @param postal_code [String]
+  # @return [UnitedStates::State::Designation]
+  #  the state Designation matching the provided postal code.
+  # @raise [NoDesignationFoundError]
+  #  if no state Designation exists with the given postal code
+  def self.find_by_postal_code(postal_code)
+    postal_code = UnitedStates::State::PostalCode.new(postal_code)
+    all.find { |designation| designation.postal_code == postal_code } || raise(
+      NoDesignationFoundError,
+      "No State with postal code, \"#{postal_code},\" was found.")
+  end
+
   # @return [Array<UnitedStates::State::Name>]
   #  a collection of all U.S. State Names.
   def self.names
     all.map(&:name)
   end
+
+  # @return [Array<UnitedStates::State::PostalCode>]
+  #  a collection of all U.S. State postal codes.
+  def self.postal_codes
+    all.map(&:postal_code)
+  end
 end
 # rubocop: enable Metrics/ModuleLength

data/lib/united_states/state/designation.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-require 'united_states/state/abbreviation'
+require 'united_states/state/postal_code'
 require 'united_states/state/name'
 
 module UnitedStates
   module State
-    # Represents the various way to designate a state (e.g. name, abbreviation).
+    # Represents the various way to designate a state (e.g. name, postal code).
     class Designation
-      # @!attribute [r] abbreviation
-      #   @return [UnitedStates::State::Abbreviation]
-      #    the state's abbreviation
-      attr_reader :abbreviation
+      # @!attribute [r] postal_code
+      #   @return [UnitedStates::State::PostalCode]
+      #    the state's postal code
+      attr_reader :postal_code
 
       # @!attribute [r] name
       #   @return [UnitedStates::State::Name]
@@ -17,23 +17,23 @@ module UnitedStates
       attr_reader :name
 
       # @param name [String]
-      # @param abbreviation [String]
-      # @raise [UnitedStates::State::Abbreviation::StringTooLongError]
+      # @param postal_code [String]
+      # @raise [UnitedStates::State::PostalCode::StringTooLongError]
       #  if the string is over 2 characters in length
-      # @raise [UnitedStates::State::Abbreviation::StringTooShortError]
+      # @raise [UnitedStates::State::PostalCode::StringTooShortError]
       #  if the string is under 2 characters in length
-      def initialize(name:, abbreviation:)
+      def initialize(name:, postal_code:)
         @name = UnitedStates::State::Name.new(name)
-        @abbreviation = UnitedStates::State::Abbreviation.new(abbreviation)
+        @postal_code = UnitedStates::State::PostalCode.new(postal_code)
       end
 
       # @param other [UnitedStates::State::Designation]
       # @return [Boolean]
-      #  whether or not other's name and abbreviation is equal
-      #  to this Designation's name and abbreviation
+      #  whether or not other's name and postal code is equal
+      #  to this Designation's name and postal code
       def ==(other)
         other.name == name &&
-          other.abbreviation == abbreviation
+          other.postal_code == postal_code
       end
     end
   end

data/lib/united_states/state/name.rb

@@ -8,7 +8,7 @@ module UnitedStates
       #  the name of the State
       # @return [UnitedStates::State::Name]
       def initialize(string)
-        @string = string
+        @string = string.to_s
       end
 
       # @param [UnitedStates::State::Name]

data/lib/united_states/state/{abbreviation.rb → postal_code.rb}

@@ -2,22 +2,22 @@
 
 module UnitedStates
   module State
-    # A U.S. State abbreviation.
-    class Abbreviation
-      # Thrown when someone attempts to make an Abbreviation instance
+    # A U.S. State postal code.
+    class PostalCode
+      # Thrown when someone attempts to make a PostalCode instance
       # from a string longer than 2 characters.
       class StringTooLongError < StandardError
-        DEFAULT_MESSAGE = 'string too long, abbreviations must be 2 characters'
+        DEFAULT_MESSAGE = 'string too long, postal code must be 2 characters'
 
         def initialize(message = DEFAULT_MESSAGE)
           super(message)
         end
       end
 
-      # Thrown when someone attempts to make an Abbreviation instance
+      # Thrown when someone attempts to make a PostalCode instance
       # from a string shorter than 2 characters.
       class StringTooShortError < StandardError
-        DEFAULT_MESSAGE = 'string too short, abbreviations must be 2 characters'
+        DEFAULT_MESSAGE = 'string too short, postal codes must be 2 characters'
 
         def initialize(message = DEFAULT_MESSAGE)
           super(message)
@@ -25,19 +25,20 @@ module UnitedStates
       end
 
       # @param string [String]
-      #  the abbreviation of the State
-      # @raise [UnitedStates::State::Abbreviation::StringTooLongError]
+      #  the postal code of the State
+      # @return [UnitedStates::State::PostalCode]
+      # @raise [UnitedStates::State::PostalCode::StringTooLongError]
       #  if the string is over 2 characters in length
-      # @raise [UnitedStates::State::Abbreviation::StringTooShortError]
+      # @raise [UnitedStates::State::PostalCode::StringTooShortError]
       #  if the string is under 2 characters in length
-      # @return [UnitedStates::State::Abbreviation]
       def initialize(string)
+        string = string.to_s
         ensure_string_not_too_long(string)
         ensure_string_not_too_short(string)
         @string = string
       end
 
-      # @param [UnitedStates::State::Abbreviation]
+      # @param [UnitedStates::State::PostalCode]
       # @return [Boolean]
       #  whether or not other.to_s matches self.to_s
       def ==(other)
@@ -57,7 +58,7 @@ module UnitedStates
       end
 
       # @return [String]
-      #  an all uppercase version of this Abbreviation
+      #  an all uppercase version of this PostalCode
       def to_s
         uppercase
       end
@@ -65,25 +66,25 @@ module UnitedStates
       private
 
       # @param string [String]
-      # @raise [UnitedStates::State::Abbreviation::StringTooLongError]
-      #  if the string is over 2 characters in length
       # @return [true]
       #  if the string is under 2 characters in length
+      # @raise [UnitedStates::State::PostalCode::StringTooLongError]
+      #  if the string is over 2 characters in length
       def ensure_string_not_too_long(string)
         return true if string.length <= 2
         raise StringTooLongError,
-              "#{string} too long, abbreviations must be 2 characters"
+              "#{string} too long, postal codes must be 2 characters"
       end
 
       # @param string [String]
-      # @raise [UnitedStates::State::Abbreviation::StringTooShortError]
-      #  if the string is under 2 characters in length
       # @return [true]
       #  if the string is 2 characters or more in length
+      # @raise [UnitedStates::State::PostalCode::StringTooShortError]
+      #  if the string is under 2 characters in length
       def ensure_string_not_too_short(string)
         return true if string.length >= 2
         raise StringTooShortError,
-              "#{string} too short, abbreviations must be 2 characters"
+              "#{string} too short, postal codes must be 2 characters"
       end
     end
   end

data/lib/united_states/version.rb

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

data/united_states.gemspec

@@ -4,15 +4,14 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'united_states/version'
 
-# rubocop: disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name = 'united_states'
   spec.version = UnitedStates::VERSION
   spec.authors = ['Kyle Whittington']
   spec.email = ['kyle.thomas.whittington@gmail.com']
 
-  spec.summary = 'The United States names and abbreviations.'
-  spec.description = 'Allows for getting of state names and abbreviations '\
+  spec.summary = 'The United States names and postal codes.'
+  spec.description = 'Allows for getting of state names and postal codes '\
                      'in various formats.'
   spec.homepage = 'https://github.com/kWhittington/united_states'
   spec.license = 'MIT'
@@ -34,4 +33,3 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'yard'
 end
-# rubocop: enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: united_states
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Kyle Whittington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Allows for getting of state names and abbreviations in various formats.
+description: Allows for getting of state names and postal codes in various formats.
 email:
 - kyle.thomas.whittington@gmail.com
 executables: []
@@ -157,9 +157,9 @@ files:
 - bin/test
 - circle.yml
 - lib/united_states.rb
-- lib/united_states/state/abbreviation.rb
 - lib/united_states/state/designation.rb
 - lib/united_states/state/name.rb
+- lib/united_states/state/postal_code.rb
 - lib/united_states/version.rb
 - united_states.gemspec
 homepage: https://github.com/kWhittington/united_states
@@ -185,5 +185,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: The United States names and abbreviations.
+summary: The United States names and postal codes.
 test_files: []