Gov Codes

Understand and process information used by the US government.

Installation

Add this line to your application's Gemfile:

gem 'gov_codes'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install gov_codes

Usage

Basic Usage

require 'gov_codes/afsc'

# Find an enlisted AFSC code
code = GovCodes::AFSC.find("1A1X2")
puts code.name # => "Mobility force aviator"
puts code.career_field # => "1A"
puts code.career_field_subdivision # => "1A1"
puts code.skill_level # => "X"
puts code.specific_afsc # => "1A1X2"
puts code.shredout # => nil

# Find an officer AFSC code
code = GovCodes::AFSC.find("11MX")
puts code.name # => "Mobility pilot"
puts code.career_group # => "11"
puts code.functional_area # => "M"
puts code.qualification_level # => "X"
puts code.shredout # => nil

# Find a Reporting Identifier (RI) or Special Duty Identifier (SDI)
code = GovCodes::AFSC.find("8A400")
puts code.name # => "Talent management consultant"
puts code.career_field # => "8A"
puts code.identifier # => "400"
puts code.suffix # => nil

# Find a code with a shredout/suffix
code = GovCodes::AFSC.find("11BXA")
puts code.name # => "B-1"
puts code.specific_afsc # => "11BX"
puts code.shredout # => "A"

Searching for Codes

You can search for all codes matching a prefix:

# Search for all Special Warfare codes
results = GovCodes::AFSC.search("1Z")
results.each do |code|
  puts "#{code.specific_afsc}: #{code.name}"
end
# Output:
# 1Z1X1: Pararescue
# 1Z2X1: Combat control
# 1Z3X1: Tactical air control party (TACP)
# 1Z4X1: Special reconnaissance

# Search for Bomber Pilot shredouts
results = GovCodes::AFSC.search("11BX")
results.each do |code|
  shredout = code.shredout ? code.shredout.to_s : ""
  puts "#{code.specific_afsc}#{shredout}: #{code.name}"
end
# Output:
# 11BX: Bomber pilot
# 11BXA: B-1
# 11BXB: B-2
# 11BXC: B-52
# ...

# Search is case-insensitive
GovCodes::AFSC.search("1z1") # Same as search("1Z1")

Extending with Custom AFSC Codes

You can extend the default AFSC codes with your own custom codes by placing a YAML file in your application's load path:

# In your application's lib/gov_codes/afsc/enlisted.yml
9Z:
  name: Custom AFSC
  subcategories:
    0X1:
      name: Custom Subcategory
      subcategories:
        A:
          name: Custom Shredout

The gem will automatically merge your custom codes with the default codes, overriding any existing codes.

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.

This project is managed with Reissue.

To release a new version, make your changes and be sure to update the CHANGELOG.md.

To release a new version:

1. bundle exec rake build:checksum
2. bundle exec rake release

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/SOFware/gov_codes.

License

The gem is available as open source under the terms of the MIT License.