fips_lookup 0.2.0

data/lib/fips_lookup.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative "fips_lookup/version"
+require "csv"
+
+# worker for county, state, fips lookups
+module FipsLookup
+  STATE_CODES = { "AL" => "01", "AK" => "02", "AZ" => "04", "AR" => "05", "CA" => "06", "CO" => "08",
+                  "CT" => "09", "DE" => "10", "DC" => "11", "FL" => "12", "GA" => "13", "HI" => "15",
+                  "ID" => "16", "IL" => "17", "IN" => "18", "IA" => "19", "KS" => "20", "KY" => "21",
+                  "LA" => "22", "ME" => "23", "MD" => "24", "MA" => "25", "MI" => "26", "MN" => "27",
+                  "MS" => "28", "MO" => "29", "MT" => "30", "NE" => "31", "NV" => "32", "NH" => "33",
+                  "NJ" => "34", "NM" => "35", "NY" => "36", "NC" => "37", "ND" => "38", "OH" => "39",
+                  "OK" => "40", "OR" => "41", "PA" => "42", "RI" => "44", "SC" => "45", "SD" => "46",
+                  "TN" => "47", "TX" => "48", "UT" => "49", "VT" => "50", "VA" => "51", "WA" => "53",
+                  "WV" => "54", "WI" => "55", "WY" => "56", "AS" => "60", "GU" => "66", "MP" => "69",
+                  "PR" => "72", "UM" => "74", "VI" => "78"
+                }.freeze
+
+  class << self
+    attr_accessor :county_fips, :state_fips
+
+    def county(state_param:, county_name:, return_nil: false)
+      state_code = find_state_code(state_param: state_param, return_nil: return_nil)
+      return {} if state_code.nil?
+
+      lookup = [state_code, county_name.upcase]
+      @county_fips ||= {}
+      @county_fips[lookup] ||= county_lookup(state_code, county_name, return_nil)
+    end
+
+    def state(state_param:, return_nil: false)
+      @state_fips ||= {}
+      @state_fips[state_param] ||= state_lookup(state_param, return_nil)
+    end
+
+    def fips_county(fips:, return_nil: false)
+      unless fips.is_a?(String) && fips.length == 5
+        return_nil ? (return nil) : (raise StandardError, "FIPS input must be 5 digit string")
+      end
+
+      state_code = find_state_code(state_param: fips[0..1], return_nil: return_nil)
+      return nil if state_code.nil?
+
+      CSV.foreach(county_file(state_code: state_code)) do |county_row|
+        return [county_row[3], state_code] if county_row[2] == fips[2..4]
+      end
+
+      raise StandardError, "Could not find county with fips: #{fips[2..4]}, in: #{state_code}" unless return_nil
+    end
+
+    def find_state_code(state_param:, return_nil: false)
+      return state_param.upcase if STATE_CODES.key?(state_param.upcase)
+      return STATE_CODES.key(state_param) if STATE_CODES.value?(state_param)
+
+      state(state_param: state_param, return_nil: return_nil)[:code]
+    end
+
+    def county_file(state_code:)
+      file_path = "#{File.expand_path(__dir__)}/data/county/#{state_code}.csv"
+      file_path if File.exist?(file_path)
+    end
+
+    def state_file
+      "#{File.expand_path(__dir__)}/data/state.csv"
+    end
+
+    private
+
+    def county_lookup(state_code, county_name_param, return_nil)
+      CSV.foreach(county_file(state_code: state_code)) do |county_row|
+        # county_row => state_code (AL), state fips (01), county fips (001), name (Augtauga County), class code (H1)
+        if county_row[3].upcase == county_name_param.upcase
+          return {state_code: county_row[0], fips: (county_row[1] + county_row[2]), name: county_row[3], class_code: county_row[4] }
+        end
+      end
+      return_nil ? (return {}) : (raise StandardError, "No county found matching: #{county_name_param}" unless return_nil)
+    end
+
+    def state_lookup(state_param, return_nil = false)
+      CSV.foreach(state_file) do |state_row|
+        # state_row => state fips (01), state code (AL), state name (Alabama), ansi (01779775)
+        if state_row[0] == state_param || state_row[1] == state_param.upcase ||
+           state_row[2].upcase == state_param.upcase || state_row[3] == state_param
+          return { fips: state_row[0], code: state_row[1], name: state_row[2], ansi: state_row[3] }
+        end
+      end
+      return_nil ? (return {}) : (raise StandardError, "No state found matching: #{state_param}")
+    end
+  end
+end

data/sig/fips_lookup.rbs

@@ -0,0 +1,4 @@
+module FipsLookup
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: fips_lookup
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Erik Barroso
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description:
+email:
+- erikbarroso22@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/data/county/AK.csv
+- lib/data/county/AL.csv
+- lib/data/county/AR.csv
+- lib/data/county/AS.csv
+- lib/data/county/AZ.csv
+- lib/data/county/CA.csv
+- lib/data/county/CO.csv
+- lib/data/county/CT.csv
+- lib/data/county/DC.csv
+- lib/data/county/DE.csv
+- lib/data/county/FL.csv
+- lib/data/county/GA.csv
+- lib/data/county/GU.csv
+- lib/data/county/HI.csv
+- lib/data/county/IA.csv
+- lib/data/county/ID.csv
+- lib/data/county/IL.csv
+- lib/data/county/IN.csv
+- lib/data/county/KS.csv
+- lib/data/county/KY.csv
+- lib/data/county/LA.csv
+- lib/data/county/MA.csv
+- lib/data/county/MD.csv
+- lib/data/county/ME.csv
+- lib/data/county/MI.csv
+- lib/data/county/MN.csv
+- lib/data/county/MO.csv
+- lib/data/county/MP.csv
+- lib/data/county/MS.csv
+- lib/data/county/MT.csv
+- lib/data/county/NC.csv
+- lib/data/county/ND.csv
+- lib/data/county/NE.csv
+- lib/data/county/NH.csv
+- lib/data/county/NJ.csv
+- lib/data/county/NM.csv
+- lib/data/county/NV.csv
+- lib/data/county/NY.csv
+- lib/data/county/OH.csv
+- lib/data/county/OK.csv
+- lib/data/county/OR.csv
+- lib/data/county/PA.csv
+- lib/data/county/PR.csv
+- lib/data/county/RI.csv
+- lib/data/county/SC.csv
+- lib/data/county/SD.csv
+- lib/data/county/TN.csv
+- lib/data/county/TX.csv
+- lib/data/county/UM.csv
+- lib/data/county/UT.csv
+- lib/data/county/VA.csv
+- lib/data/county/VI.csv
+- lib/data/county/VT.csv
+- lib/data/county/WA.csv
+- lib/data/county/WI.csv
+- lib/data/county/WV.csv
+- lib/data/county/WY.csv
+- lib/data/state.csv
+- lib/fips_lookup.rb
+- lib/fips_lookup/version.rb
+- sig/fips_lookup.rbs
+homepage: https://github.com/3barroso/fips_lookup
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Stores FIPS codes for US States and Counties
+test_files: []