state_geo_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a38cb80e205d57912a0cb0f2a0154c731613f168
+  data.tar.gz: 9e52f549e48190731110d2658fffe25396f75149
+SHA512:
+  metadata.gz: '00469303beafc0947f1cb362131ff8df968b0e4d617d53a655209c66567c003982fed0fe1a4450f53aee46216790ed282906ebf221908d31ad4caff0db3cc2df'
+  data.tar.gz: 60526aa38bbd99b4fcaa51fd89185c9f6b1b4295fbba69d7e49e9533fb13b99ddbb0d6c64c175c5d4ef50dea138921987789f589efdfa505e8b7159059f6ea2e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/test/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in state_geo_tools.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Colin Fleming
+
+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,101 @@
+# StateGeoTools
+
+[![Build Status](https://travis-ci.org/colinxfleming/state_geo_tools.svg?branch=master)](https://travis-ci.org/colinxfleming/state_geo_tools)
+
+These are tools to save me from having to copy and paste the same state
+constants across tools when I need to iterate thru or populate a list of
+states (which is basically all the time).
+
+TODOS:
+
+* option rename DC to whatever bonkers things people put down in text
+* count DC (and other states, I guess) when AKA strings show up
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem 'state_geo_tools' 
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install state_geo_tools
+
+## Usage
+
+### States and territories
+
+This provides access to an array of states (and Washington, DC, which
+is not a state because of (longstanding injustice by the U.S. Congress)[https://statehood.dc.gov/])
+and territories, as strings.
+
+```rb
+> require 'state_geo_tools'
+> StateGeoTools.states
+=> ["Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "District of Columbia", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming"]
+> StateGeoTools.territories
+=> ["American Samoa", "Federated States of Micronesia", "Guam", "Marshall Islands", "Northern Mariana Islands", "Palau", "Puerto Rico", "Virgin Islands"]
+```
+
+### State codes and territory codes
+
+Prefer a two letter code instead of the full string? You're covered:
+
+```rb
+> require 'state_geo_tools'
+> StateGeoTools.state_codes
+=> ["AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY"]
+> StateGeoTools.territory_codes
+=> ["AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI"]
+```
+
+### Count instances of states in a string
+
+There is a convenience method provided to scan a string for state or territory
+names and return a count. 
+
+Coming eventually: Handling all the aliases for Washington, DC.
+
+```rb
+> require 'state_geo_tools'
+> StateGeoTools.count_states_in('Pantera were from Texas, I saw them in Indiana')
+=> {"Texas"=>1, "Indiana"=>1}
+
+> StateGeoTools.count_territories_in('The Simpsons are going to Guam!')
+=> {"Guam"=>1}
+
+# There's some special handling for Washington/Washington DC and Virginia/West
+# Virginia. It doesn't work flawlessly yet, so heads up!
+> StateGeoTools.count_states_in('Virginia and West Virginia are for lovers')
+=> {"West Virginia"=>1, "Virginia"=>1}
+
+> StateGeoTools.count_states_in('Washington and Washington, DC are on opposite sides of the country')
+=> {"Washington"=>1}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/colinxfleming/state_geo_tools.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'state_geo_tools'
+
+# 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/lib/state_geo_tools/counters.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module StateGeoTools
+  # Methods for counting instances in a string.
+  module Counters
+    # Count appearances of const's elements in the string.
+    #
+    # Const can be any array of strings, but we generally use the list of
+    # states and territories.
+    #
+    # Returns a single hash with the const element as the keys. No zeroes.
+    def count_instances(string, const)
+      instances = const.sort.map do |geo|
+        { geo.to_s => string.scan(geo_regex(geo)).count }
+      end
+      instances.reduce { |x, y| x.merge(y) }
+               .delete_if { |_, v| v.zero? }
+    end
+
+    private
+
+    def geo_regex(geo)
+      # Need special handling for the great state of Virginia,
+      # because of West Virginia.
+      return /(?<!west )virginia/i if geo == 'Virginia'
+      return /washington(?!, D\.*C\.*)/i if geo == 'Washington'
+      /#{geo}/i
+    end
+  end
+end

data/lib/state_geo_tools/state_constants.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module StateGeoTools
+  # USA state constants (and DC).
+  module States
+    # An array of hashes of all state data that we map out from.
+    STATE_DATA = [
+      { name: 'Alabama', code: 'AL' },
+      { name: 'Alaska', code: 'AK' },
+      { name: 'Arizona', code: 'AZ' },
+      { name: 'Arkansas', code: 'AR' },
+      { name: 'California', code: 'CA' },
+      { name: 'Colorado', code: 'CO' },
+      { name: 'Connecticut', code: 'CT' },
+      { name: 'Delaware', code: 'DE' },
+      # Statehood for DC: An opinion I am expressing in code by including DC
+      { name: 'District of Columbia', code: 'DC', also_known_as: ['Washington, DC', 'Washington DC'] },
+      { name: 'Florida', code: 'FL' },
+      { name: 'Georgia', code: 'GA' },
+      { name: 'Hawaii', code: 'HI' },
+      { name: 'Idaho', code: 'ID' },
+      { name: 'Illinois', code: 'IL' },
+      { name: 'Indiana', code: 'IN' },
+      { name: 'Iowa', code: 'IA' },
+      { name: 'Kansas', code: 'KS' },
+      { name: 'Kentucky', code: 'KY' },
+      { name: 'Louisiana', code: 'LA' },
+      { name: 'Maine', code: 'ME' },
+      { name: 'Maryland', code: 'MD' },
+      { name: 'Massachusetts', code: 'MA' },
+      { name: 'Michigan', code: 'MI' },
+      { name: 'Minnesota', code: 'MN' },
+      { name: 'Mississippi', code: 'MS' },
+      { name: 'Missouri', code: 'MO' },
+      { name: 'Montana', code: 'MT' },
+      { name: 'Nebraska', code: 'NE' },
+      { name: 'Nevada', code: 'NV' },
+      { name: 'New Hampshire', code: 'NH' },
+      { name: 'New Jersey', code: 'NJ' },
+      { name: 'New Mexico', code: 'NM' },
+      { name: 'New York', code: 'NY' },
+      { name: 'North Carolina', code: 'NC' },
+      { name: 'North Dakota', code: 'ND' },
+      { name: 'Ohio', code: 'OH' },
+      { name: 'Oklahoma', code: 'OK' },
+      { name: 'Oregon', code: 'OR' },
+      { name: 'Pennsylvania', code: 'PA' },
+      { name: 'Rhode Island', code: 'RI' },
+      { name: 'South Carolina', code: 'SC' },
+      { name: 'South Dakota', code: 'SD' },
+      { name: 'Tennessee', code: 'TN' },
+      { name: 'Texas', code: 'TX' },
+      { name: 'Utah', code: 'UT' },
+      { name: 'Vermont', code: 'VT' },
+      { name: 'Virginia', code: 'VA' },
+      { name: 'Washington', code: 'WA' },
+      { name: 'West Virginia', code: 'WV' },
+      { name: 'Wisconsin', code: 'WI' },
+      { name: 'Wyoming', code: 'WY' }
+    ].freeze
+
+    # An array of all state names (and DC).
+    STATES = STATE_DATA.map { |state| state[:name] }.freeze
+
+    # An array of all two-letter state codes (and DC).
+    STATE_CODES = STATE_DATA.map { |state| state[:code] }.freeze
+  end
+end

data/lib/state_geo_tools/territory_constants.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module StateGeoTools
+  # Constants for US territories
+  module Territories
+    # An array of hashes of all territories that we map out from.
+    TERRITORY_DATA = [
+      { name: 'American Samoa', code: 'AS' },
+      { name: 'Federated States of Micronesia', code: 'FM' },
+      { name: 'Guam', code: 'GU' },
+      { name: 'Marshall Islands', code: 'MH' },
+      { name: 'Northern Mariana Islands', code: 'MP' },
+      { name: 'Palau', code: 'PW' },
+      { name: 'Puerto Rico', code: 'PR' },
+      { name: 'Virgin Islands', code: 'VI' }
+    ].freeze
+
+    # An array of all territory names.
+    TERRITORIES = TERRITORY_DATA.map { |terr| terr[:name] }.freeze
+
+    # An array of all two-letter territory codes.
+    TERRITORY_CODES = TERRITORY_DATA.map { |terr| terr[:code] }.freeze
+  end
+end

data/lib/state_geo_tools/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StateGeoTools
+  VERSION = '0.1.0'
+end

data/lib/state_geo_tools.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'state_geo_tools/version'
+require 'state_geo_tools/state_constants'
+require 'state_geo_tools/territory_constants'
+require 'state_geo_tools/counters'
+
+# Because I got sick of copying and pasting arrays of states everywhere, this
+# utility provides some convenience methods to get a full set of US states and
+# territories. It also includes a pair of convenience methods.
+#
+# The utility modules are all public, in the event that one should need to
+# use them in a slightly different way, but the common use case is in this
+#
+# See the README for examples.
+module StateGeoTools
+  extend StateGeoTools::Counters
+
+  # Return an array of states and the District of Columbia.
+  def self.states
+    States::STATES
+  end
+
+  # Return an array of two-letter state codes, and DC.
+  def self.state_codes
+    States::STATE_CODES
+  end
+
+  # Return an array of US territories.
+  def self.territories
+    Territories::TERRITORIES
+  end
+
+  # Return an array of two-letter US territory codes.
+  def self.territory_codes
+    Territories::TERRITORY_CODES
+  end
+
+  # Count instances of states in a string.
+  def self.count_states_in(string)
+    count_instances string, States::STATES
+  end
+
+  # Count instances of territories passed in a string.
+  def self.count_territories_in(string)
+    count_instances string, Territories::TERRITORIES
+  end
+end

data/state_geo_tools.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'state_geo_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'state_geo_tools'
+  spec.version       = StateGeoTools::VERSION
+  spec.authors       = ['colinxfleming']
+  spec.email         = ['c3flemin@gmail.com']
+
+  spec.summary       = 'A US geography/state utility.'
+  spec.description   = 'I got sick of copying the same US states constant.'
+  spec.homepage      = 'https://github.com/colinxfleming/state_geo_tools'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.14'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: state_geo_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- colinxfleming
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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'
+description: I got sick of copying the same US states constant.
+email:
+- c3flemin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/state_geo_tools.rb
+- lib/state_geo_tools/counters.rb
+- lib/state_geo_tools/state_constants.rb
+- lib/state_geo_tools/territory_constants.rb
+- lib/state_geo_tools/version.rb
+- state_geo_tools.gemspec
+homepage: https://github.com/colinxfleming/state_geo_tools
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A US geography/state utility.
+test_files: []