united_states 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7531af5d720089625de67dd1edf5b7021311b226
-  data.tar.gz: b7dc7fb19fa7609d05e8e5381d6ba005170862fe
+  metadata.gz: 7a3034a514f527ccbdfb782831ecdb9533d6fe0b
+  data.tar.gz: 5b7138644b59f2744b132d0f4d1cfc9b0b2869b5
 SHA512:
-  metadata.gz: 6ff7b6b550c343b2096f949d51fcba2c7bb5033bc2b66920d0fb043eb88d7406af0f73da6b402da2d14fcd972966d97b223d95a4a8339d7df521305f89725aa7
-  data.tar.gz: fd2f499ed1c80aeb244e1f242decc77386760b6a93ae0baa0989a2cafe5e600de4be28335052c085ec1af033f18f0db6fdb44226328d9c2c4c6059a4e4c7308c
+  metadata.gz: d55886c4f01615d253c2bea4376d7b6193aaa5f9a73d7fd7d885e707b7b684d6a8747705c515c34ad7f1ce2dc34464508aab75f5cf76e2c8aeda676a5cd3c367
+  data.tar.gz: 49982128640592902bcaad9ec2cf9901af92da149010d0c9330b90982841d65614a0ae85ba2a7b331e9cc7209a28d78e51b6c7d0f202b3c92614acb5daa5cb77

data/.rubocop.yml

@@ -6,6 +6,7 @@ require: rubocop-rspec
 AllCops:
   Exclude:
     - rubygems*/
+    - united_states.gemspec
   TargetRubyVersion: 2.1
 
 Documentation:

data/CHANGELOG.md

@@ -10,6 +10,22 @@ __Change Groups__:
 
 ## [Unreleased]
 
+## [1.2.0] - 2017-02-26
+### Added
+- `UnitedStates.config_path`
+- `UnitedStates.array_from_yaml_file(path:)`
+- `UnitedStates.array_from_yaml(yaml)`
+- `UnitedStates.array_from_hashes(*hashes)`
+- `UnitedStates::State::Designation.from_hash(**hash)`
+- Example of `UnitedStates::State::Designation#initialize(...)`
+
+### Changed
+- `UnitedStates.all` to use `UnitedStates.array_from_yaml_file(path:)`
+
+### Fixed
+- `Designation`, `Name`, and `PostalCode` yard documentation typos.
+- `"Abbrevation"` typos, now `"PostalCode"`.
+
 ## [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`.

data/lib/united_states/designations.yml

@@ -0,0 +1,101 @@
+---
+Alabama:
+  postal_code: AL
+Alaska:
+  postal_code: AK
+Arizona:
+  postal_code: AZ
+Arkansas:
+  postal_code: AR
+California:
+  postal_code: CA
+Colorado:
+  postal_code: CO
+Connecticut:
+  postal_code: CT
+Delaware:
+  postal_code: DE
+Florida:
+  postal_code: FL
+Georgia:
+  postal_code: GA
+Hawaii:
+  postal_code: HI
+Idaho:
+  postal_code: ID
+Illinois:
+  postal_code: IL
+Indiana:
+  postal_code: IN
+Iowa:
+  postal_code: IA
+Kansas:
+  postal_code: KS
+Kentucky:
+  postal_code: KY
+Louisiana:
+  postal_code: LA
+Maine:
+  postal_code: ME
+Maryland:
+  postal_code: MD
+Massachusetts:
+  postal_code: MA
+Michigan:
+  postal_code: MI
+Minnesota:
+  postal_code: MN
+Mississippi:
+  postal_code: MS
+Missouri:
+  postal_code: MO
+Montana:
+  postal_code: MT
+Nebraska:
+  postal_code: NE
+Nevada:
+  postal_code: NV
+New Hampshire:
+  postal_code: NH
+New Jersey:
+  postal_code: NJ
+New Mexico:
+  postal_code: NM
+New York:
+  postal_code: NY
+North Carolina:
+  postal_code: NC
+North Dakota:
+  postal_code: ND
+Ohio:
+  postal_code: OH
+Oklahoma:
+  postal_code: OK
+Oregon:
+  postal_code: OR
+Pennsylvania:
+  postal_code: PA
+Rhode Island:
+  postal_code: RI
+South Carolina:
+  postal_code: SC
+South Dakota:
+  postal_code: SD
+Tennessee:
+  postal_code: TN
+Texas:
+  postal_code: TX
+Utah:
+  postal_code: UT
+Vermont:
+  postal_code: VT
+Virginia:
+  postal_code: VA
+Washington:
+  postal_code: WA
+West Virginia:
+  postal_code: WV
+Wisconsin:
+  postal_code: WI
+Wyoming:
+  postal_code: WY

data/lib/united_states/state/designation.rb

@@ -6,16 +6,34 @@ module UnitedStates
   module State
     # Represents the various way to designate a state (e.g. name, postal code).
     class Designation
-      # @!attribute [r] postal_code
-      #   @return [UnitedStates::State::PostalCode]
-      #    the state's postal code
+      # @return [UnitedStates::State::PostalCode]
+      #  the state's postal code
       attr_reader :postal_code
 
-      # @!attribute [r] name
-      #   @return [UnitedStates::State::Name]
-      #    the state's name
+      # @return [UnitedStates::State::Name]
+      #  the state's name
       attr_reader :name
 
+      # @example From Named Parameters
+      #  UnitedStates::State::Designation.from_hash(
+      #    name: 'Hawaii', postal_code: 'HI')
+      #  # => #<UnitedStates::State::Designation:0x...@string="HI">>
+      # @example From Variable
+      #  hawaii_hash = { name: 'Hawaii', postal_code: 'HI' }
+      #  UnitedStates::State::Designation.from_hash(hawaii_hash)
+      #  # => #<UnitedStates::State::Designation:0x...@string="HI">>
+      # @param hash [Hash]
+      #  a hash of Designation attributes, see {#initialize} for parameters
+      # @return [UnitedStates::State::Designation]
+      #  a Designation with attributes provided via hash
+      def self.from_hash(**hash)
+        new(name: hash[:name], postal_code: hash[:postal_code])
+      end
+
+      # @example
+      #  UnitedStates::State::Designation.new(
+      #    name: 'wyoming', postal_code: 'wy')
+      #  # => #<UnitedStates::State::Designation:0x007...@string="wy">>
       # @param name [String]
       # @param postal_code [String]
       # @raise [UnitedStates::State::PostalCode::StringTooLongError]

data/lib/united_states/state/name.rb

@@ -11,7 +11,7 @@ module UnitedStates
         @string = string.to_s
       end
 
-      # @param [UnitedStates::State::Name]
+      # @param other [UnitedStates::State::Name]
       # @return [Boolean]
       #  whether or not other.to_s matches self.to_s
       def ==(other)

data/lib/united_states/state/postal_code.rb

@@ -40,7 +40,7 @@ module UnitedStates
         @string = string
       end
 
-      # @param [UnitedStates::State::PostalCode]
+      # @param other [UnitedStates::State::PostalCode]
       # @return [Boolean]
       #  whether or not other.to_s matches self.to_s
       def ==(other)
@@ -48,13 +48,13 @@ module UnitedStates
       end
 
       # @return [String]
-      #  an all lowercase version of this Abbrevation
+      #  an all lowercase version of this PostalCode
       def lowercase
         @string.downcase
       end
 
       # @return [String]
-      #  an all uppercase version of this Abbrevation
+      #  an all uppercase version of this PostalCode
       def uppercase
         @string.upcase
       end

data/lib/united_states/version.rb

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

data/lib/united_states.rb

@@ -2,8 +2,6 @@
 require 'united_states/version'
 require 'united_states/state/designation'
 
-# rubocop: disable Metrics/ModuleLength
-#
 # Top-level namespace for this gem.
 module UnitedStates
   # Thrown when someone attempts to search for a state with
@@ -32,116 +30,73 @@ module UnitedStates
     find_by_postal_code(name_or_postal_code)
   end
 
-  # rubocop: disable Metrics/AbcSize
-  # rubocop: disable Metrics/MethodLength
   # @return [Array<UnitedStates::State::Designation>]
   #  a collection of all U.S. State Designations.
   def self.all
-    [
-      UnitedStates::State::Designation.new(
-        name: 'Alabama', postal_code: 'AL'),
-      UnitedStates::State::Designation.new(
-        name: 'Alaska', postal_code: 'AK'),
-      UnitedStates::State::Designation.new(
-        name: 'Arizona', postal_code: 'AZ'),
-      UnitedStates::State::Designation.new(
-        name: 'Arkansas', postal_code: 'AR'),
-      UnitedStates::State::Designation.new(
-        name: 'California', postal_code: 'CA'),
-      UnitedStates::State::Designation.new(
-        name: 'Colorado', postal_code: 'CO'),
-      UnitedStates::State::Designation.new(
-        name: 'Connecticut', postal_code: 'CT'),
-      UnitedStates::State::Designation.new(
-        name: 'Delaware', postal_code: 'DE'),
-      UnitedStates::State::Designation.new(
-        name: 'Florida', postal_code: 'FL'),
-      UnitedStates::State::Designation.new(
-        name: 'Georgia', postal_code: 'GA'),
-      UnitedStates::State::Designation.new(
-        name: 'Hawaii', postal_code: 'HI'),
-      UnitedStates::State::Designation.new(
-        name: 'Idaho', postal_code: 'ID'),
-      UnitedStates::State::Designation.new(
-        name: 'Illinois', postal_code: 'IL'),
-      UnitedStates::State::Designation.new(
-        name: 'Indiana', postal_code: 'IN'),
-      UnitedStates::State::Designation.new(
-        name: 'Iowa', postal_code: 'IA'),
-      UnitedStates::State::Designation.new(
-        name: 'Kansas', postal_code: 'KS'),
-      UnitedStates::State::Designation.new(
-        name: 'Kentucky', postal_code: 'KY'),
-      UnitedStates::State::Designation.new(
-        name: 'Louisiana', postal_code: 'LA'),
-      UnitedStates::State::Designation.new(
-        name: 'Maine', postal_code: 'ME'),
-      UnitedStates::State::Designation.new(
-        name: 'Maryland', postal_code: 'MD'),
-      UnitedStates::State::Designation.new(
-        name: 'Massachusetts', postal_code: 'MA'),
-      UnitedStates::State::Designation.new(
-        name: 'Michigan', postal_code: 'MI'),
-      UnitedStates::State::Designation.new(
-        name: 'Minnesota', postal_code: 'MN'),
-      UnitedStates::State::Designation.new(
-        name: 'Mississippi', postal_code: 'MS'),
-      UnitedStates::State::Designation.new(
-        name: 'Missouri', postal_code: 'MO'),
-      UnitedStates::State::Designation.new(
-        name: 'Montana', postal_code: 'MT'),
-      UnitedStates::State::Designation.new(
-        name: 'Nebraska', postal_code: 'NE'),
-      UnitedStates::State::Designation.new(
-        name: 'Nevada', postal_code: 'NV'),
-      UnitedStates::State::Designation.new(
-        name: 'New Hampshire', postal_code: 'NH'),
-      UnitedStates::State::Designation.new(
-        name: 'New Jersey', postal_code: 'NJ'),
-      UnitedStates::State::Designation.new(
-        name: 'New Mexico', postal_code: 'NM'),
-      UnitedStates::State::Designation.new(
-        name: 'New York', postal_code: 'NY'),
-      UnitedStates::State::Designation.new(
-        name: 'North Carolina', postal_code: 'NC'),
-      UnitedStates::State::Designation.new(
-        name: 'North Dakota', postal_code: 'ND'),
-      UnitedStates::State::Designation.new(
-        name: 'Ohio', postal_code: 'OH'),
-      UnitedStates::State::Designation.new(
-        name: 'Oklahoma', postal_code: 'OK'),
-      UnitedStates::State::Designation.new(
-        name: 'Oregon', postal_code: 'OR'),
-      UnitedStates::State::Designation.new(
-        name: 'Pennsylvania', postal_code: 'PA'),
-      UnitedStates::State::Designation.new(
-        name: 'Rhode Island', postal_code: 'RI'),
-      UnitedStates::State::Designation.new(
-        name: 'South Carolina', postal_code: 'SC'),
-      UnitedStates::State::Designation.new(
-        name: 'South Dakota', postal_code: 'SD'),
-      UnitedStates::State::Designation.new(
-        name: 'Tennessee', postal_code: 'TN'),
-      UnitedStates::State::Designation.new(
-        name: 'Texas', postal_code: 'TX'),
-      UnitedStates::State::Designation.new(
-        name: 'Utah', postal_code: 'UT'),
-      UnitedStates::State::Designation.new(
-        name: 'Vermont', postal_code: 'VT'),
-      UnitedStates::State::Designation.new(
-        name: 'Virginia', postal_code: 'VA'),
-      UnitedStates::State::Designation.new(
-        name: 'Washington', postal_code: 'WA'),
-      UnitedStates::State::Designation.new(
-        name: 'West Virginia', postal_code: 'WV'),
-      UnitedStates::State::Designation.new(
-        name: 'Wisconsin', postal_code: 'WI'),
-      UnitedStates::State::Designation.new(
-        name: 'Wyoming', postal_code: 'WY')
-    ]
+    array_from_yaml_file(path: config_path)
+  end
+
+  # @example
+  #  UnitedStates.array_from_hashes(
+  #    { name: 'Florida', postal_code: 'FL' },
+  #    { name: 'Iowa', postal_code: 'IA'})
+  # @param hashes [Array<Hash>]
+  #  a collection of attributes as hashes
+  # @return [Array<UnitedStates::State::Designation>]
+  #  a collection of state designations made from the given hash attributes
+  def self.array_from_hashes(*hashes)
+    hashes.map do |hash|
+      UnitedStates::State::Designation.from_hash(hash)
+    end
+  end
+
+  # @example
+  #  require 'united_states'
+  #
+  #  UnitedStates.array_from_yaml(
+  #    { Washington: { postal_code: 'WA' } }.to_yaml)
+  #  # => [<UnitedStates::State::Designation...>]
+  # @param yaml [String]
+  #  a String representation of YAML.
+  # @return [Array<UnitedStates::State::Designation>]
+  #  a collection of state designations made from the given hash attributes
+  # @raise UnitedStates::State::PostalCode::StringTooLongError
+  #  if a designation has a postal code that too long
+  # @raise UnitedStates::State::PostalCode::StringTooShortError
+  #  if a designation has no postal code defined or is too short
+  def self.array_from_yaml(yaml)
+    return [] unless YAML.safe_load(yaml)
+    YAML.safe_load(yaml).map do |key, value|
+      UnitedStates::State::Designation.new(
+        name: key, postal_code: value && value.fetch('postal_code', ''))
+    end
+  end
+
+  # @example
+  #  require 'united_states'
+  #
+  #  UnitedStates.array_from_yaml_file(path: './states.yml')
+  #  # => [<UnitedStates::State::Designation...>]
+  # @param path [String]
+  #  the path to the YAML file
+  # @return [Array<UnitedStates::State::Designation>]
+  #  a collection of state designations made from the YAML file
+  # @raise UnitedStates::State::PostalCode::StringTooLongError
+  #  if a designation has a postal code that too long
+  # @raise UnitedStates::State::PostalCode::StringTooShortError
+  #  if a designation has no postal code defined or is too short
+  def self.array_from_yaml_file(path:)
+    pathname = Pathname.new(path)
+    return array_from_yaml(pathname.read) if pathname.exist?
+    raise "\"#{path}\" does not exist.\n"\
+          'Please supply a path to a YAML file.'
+  end
+
+  # @return [String]
+  #  the path to the Designations yaml file
+  def self.config_path
+    './lib/united_states/designations.yml'
   end
-  # rubocop: enable Metrics/AbcSize
-  # rubocop: enable Metrics/MethodLength
 
   # @example
   #  UnitedStates.find_by_name('louisiana') # => UnitedSt...Designation

data/united_states.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'faker'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'pry-coolline'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: united_states
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Kyle Whittington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-19 00:00:00.000000000 Z
+date: 2017-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-coolline
   requirement: !ruby/object:Gem::Requirement
@@ -174,6 +188,7 @@ files:
 - bin/test
 - circle.yml
 - lib/united_states.rb
+- lib/united_states/designations.yml
 - lib/united_states/state/designation.rb
 - lib/united_states/state/name.rb
 - lib/united_states/state/postal_code.rb