state_geo_tools 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a38cb80e205d57912a0cb0f2a0154c731613f168
-  data.tar.gz: 9e52f549e48190731110d2658fffe25396f75149
+SHA256:
+  metadata.gz: 3a797992d9fd66ce615c2ae196fe5ebea5f7f0b3e5d7ecc0d11ae9fd476cf8dc
+  data.tar.gz: c58596ab153652945353cbec8ecbea833f37a6732514329ae40523fb0f29ed93
 SHA512:
-  metadata.gz: '00469303beafc0947f1cb362131ff8df968b0e4d617d53a655209c66567c003982fed0fe1a4450f53aee46216790ed282906ebf221908d31ad4caff0db3cc2df'
-  data.tar.gz: 60526aa38bbd99b4fcaa51fd89185c9f6b1b4295fbba69d7e49e9533fb13b99ddbb0d6c64c175c5d4ef50dea138921987789f589efdfa505e8b7159059f6ea2e
+  metadata.gz: 579fd09dde7ce7b541483c92bb47fbdd8215b010e63a09d336db937a3cb36b7c23c641d1b0ac7ecc6adcbe44bcb00e9437de4098354aeceee70c62394d484ef1
+  data.tar.gz: 6a047446835b663b9b6671d2b20903932aa9acc5f9b1386e2a26d6e020e59f0da10dcdcbcc3b0ebd8b303b4ce5295ae475cebad6d977d7910e55b614cb08416a

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0

data/.travis.yml

@@ -1,5 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.14.6
+  - 2.4
+  - 2.5
+  - 2.6
+before_install: gem install bundler -v 1.17.2

data/README.md

@@ -6,10 +6,7 @@ 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
+[Docs are here.](https://www.rubydoc.info/github/colinxfleming/state_geo_tools/master)
 
 ## Installation
 
@@ -55,6 +52,18 @@ Prefer a two letter code instead of the full string? You're covered:
 => ["AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI"]
 ```
 
+### Toploading
+
+For convenience, an optional argument is provided to pull certain items up to
+the top of a list. Pass `topload: [elements]` to `states`, `territories`,
+`state_codes`, or `territory_codes` to pull a few to the front. For example:
+
+```rb
+> require 'state_geo_tools'
+> StateGeoTools.state_codes(topload: ['MI', 'DC', 'TX'])
+=> ["MI", "DC", "TX", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "UT", "VT", "VA", "WA", "WV", "WI", "AL", "WY", "AK", "AZ"]
+```
+
 ### Count instances of states in a string
 
 There is a convenience method provided to scan a string for state or territory

data/lib/state_geo_tools/toploader.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module StateGeoTools
+  # Sometimes you want to pull some entries up.
+  module Toploader
+    TOPLOAD_ERROR = 'is not in the set and not toploadable'
+
+    class NotInSetError < StandardError; end
+
+    def topload_items(set, topload)
+      topload.each do |x|
+        raise(NotInSetError, "#{x} #{TOPLOAD_ERROR}") unless set.include?(x)
+      end
+
+      # If not in the topload set, offset the ordering by a few hundred so it
+      # maintains its current order
+      set.sort_by { |item| topload.index(item) || (500 + set.index(item)) }
+    end
+  end
+end

data/lib/state_geo_tools/version.rb

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

data/lib/state_geo_tools.rb

@@ -4,35 +4,49 @@ require 'state_geo_tools/version'
 require 'state_geo_tools/state_constants'
 require 'state_geo_tools/territory_constants'
 require 'state_geo_tools/counters'
+require 'state_geo_tools/toploader'
 
 # 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
+# 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
+  extend StateGeoTools::Toploader
 
   # Return an array of states and the District of Columbia.
-  def self.states
+  # Optionally pull items up top with a topload array kwarg.
+  def self.states(topload: nil)
+    return topload_items(States::STATES, topload) if topload
+
     States::STATES
   end
 
   # Return an array of two-letter state codes, and DC.
-  def self.state_codes
+  # Optionally pull items up top with a topload array kwarg.
+  def self.state_codes(topload: nil)
+    return topload_items(States::STATE_CODES, topload) if topload
+
     States::STATE_CODES
   end
 
   # Return an array of US territories.
-  def self.territories
+  # Optionally pull items up top with a topload array kwarg.
+  def self.territories(topload: nil)
+    return topload_items(Territories::TERRITORIES, topload) if topload
+
     Territories::TERRITORIES
   end
 
   # Return an array of two-letter US territory codes.
-  def self.territory_codes
+  # Optionally pull items up top with a topload array kwarg.
+  def self.territory_codes(topload: nil)
+    return topload_items(Territories::TERRITORY_CODES, topload) if topload
+
     Territories::TERRITORY_CODES
   end
 

data/state_geo_tools.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency 'rake', '~> 12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_geo_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - colinxfleming
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2019-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
 description: I got sick of copying the same US states constant.
 email:
 - c3flemin@gmail.com
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -72,6 +73,7 @@ files:
 - lib/state_geo_tools/counters.rb
 - lib/state_geo_tools/state_constants.rb
 - lib/state_geo_tools/territory_constants.rb
+- lib/state_geo_tools/toploader.rb
 - lib/state_geo_tools/version.rb
 - state_geo_tools.gemspec
 homepage: https://github.com/colinxfleming/state_geo_tools
@@ -93,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A US geography/state utility.