File Coverage

blib/lib/Geography/USStates.pm

Criterion	Covered	Total	%
statement	32	41	78.0
branch	9	12	75.0
condition	8	10	80.0
subroutine	10	17	58.8
pod	0	16	0.0
total	59	96	61.4

# -------------------------------------------------------------------------
# Name: Geography::USStates.pm
# Auth: Dion Almaer (dion)
# Desc: Get info on US States / Dependant Areas
# Date Created: Sun Nov 15 17:50:29 1998
# Version: 0.12
# $Modified: Wed May 26 02:15:53 1999 by dion $
# -------------------------------------------------------------------------
package Geography::USStates;

use     strict;
require 5.002;
require Exporter;

$Geography::USStates::VERSION = '0.12';
@Geography::USStates::ISA     = qw(Exporter);
@Geography::USStates::EXPORT  = qw(getState getStates getStateNames getStateAbbrevs);
@Geography::USStates::EXPORT_OK   = qw(getArea getAreas getAreaNames getAreaAbbrevs getStateOrArea getStatesAndAreas
									   getStatesAndAreasNames getStatesAndAreasAbbrevs);
%Geography::USStates::EXPORT_TAGS =(states=> [qw|getState getStates getStateNames getStateAbbrevs|],
                                    areas => [qw|getArea getAreas getAreaNames getAreaAbbrevs|],
                                    both  => [qw|getStateOrArea getStatesAndAreas getStatesAndAreasNames getStatesAndAreasAbbrevs|],
                                    all   => [qw|getStateOrArea getStatesAndAreas getStatesAndAreasNames getStatesAndAreasAbbrevs
											     getState getStates getStateNames getStateAbbrevs
                                                 getArea getAreas getAreaNames getAreaAbbrevs|]);

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

%Geography::USStates::AREAS = (AS => 'American Samoa', DC => 'District Of Columbia', GU => 'Guam',
                               MD => 'Midway Islands', NI => 'Northern Mariana Islands',
							   PR => 'Puerto Rico', VI => 'Virgin Islands');

%Geography::USStates::BOTH = (%Geography::USStates::STATES, %Geography::USStates::AREAS);

# ----------------------------------------------------------------------------
# CORE FUNCTIONS: These functions do the real work
# ----------------------------------------------------------------------------

# ----------------------------------------------------------------------------
# Subroutine: getKey - Given a hashref and (abbrev get full name, name get abbrev)
# ----------------------------------------------------------------------------
sub getKey {
	my $hashref = shift;
   	my $value = shift;
	if (length $value > 2) {
		my %states = getKeys($hashref, 'case' => 'lower', 'hashkey' => 'name');
        return $states{lc $value};
    } else {
        return $hashref->{uc $value};
    }
}

# ----------------------------------------------------------------------------
# Subroutine: getKeys - return a hash: $hash{'MN'} = 'Minnesota'
# ----------------------------------------------------------------------------
sub getKeys {
	my $hashref = shift;
    my %hash = (ref $_[0] eq 'HASH') ? %{ $_[0] } : @_;

    # -- do something to the states
    $hash{hashkey} ||= ''; # -- for -w
    $hash{case}    ||= ''; # -- for -w

    return %{ $hashref }
          unless @_ || $hash{case} || $hash{hashkey} eq 'name';

    my %states;
    while ( my ($abbrev, $name) = each %{ $hashref } ) {
            if ($hash{case} =~ /^[lu]/i) {
                $name = ($hash{case} =~ /^u/i) ? uc $name : lc $name;
            }
            if ($hash{hashkey} eq 'name') {
                $states{$name}   = $abbrev;
            } else {
                $states{$abbrev} = $name;
            }
    }
    return %states;
}

sub getNames   { return sort values %{ $_[0] }; }
sub getAbbrevs { return sort keys   %{ $_[0] }; }

# ----------------------------------------------------------------------------
# US STATE FUNCTIONS
# ----------------------------------------------------------------------------

# ----------------------------------------------------------------------------
# Subroutine: getState - given abbrev get full name, given name get abbrev
# ----------------------------------------------------------------------------
sub getState { getKey(\%Geography::USStates::STATES, @_); }

# ----------------------------------------------------------------------------
# Subroutine: getStates - return a states hash: $hash{'MN'} = 'Minnesota'
# ----------------------------------------------------------------------------
sub getStates {	getKeys(\%Geography::USStates::STATES, @_); }

# ----------------------------------------------------------------------------
# Subroutine: getStateNames - return an array of states by name
# ----------------------------------------------------------------------------
sub getStateNames   { getNames(\%Geography::USStates::STATES); }

# ----------------------------------------------------------------------------
# Subroutine: getStateAbbrevs - return an array of states by 2 letter abbrev
# ----------------------------------------------------------------------------
sub getStateAbbrevs { getAbbrevs(\%Geography::USStates::STATES); }

# ----------------------------------------------------------------------------
# DEPENDANT AREAS: These are areas that aren't states, but are part of the US
# ----------------------------------------------------------------------------

# ----------------------------------------------------------------------------
# Subroutine: getArea - given abbrev get full name, given name get abbrev
# ----------------------------------------------------------------------------
sub getArea { getKey(\%Geography::USStates::AREAS, @_); }

# ----------------------------------------------------------------------------
# Subroutine: getAreas - return an areas hash: $hash{'GU'} = 'Guam'
# ----------------------------------------------------------------------------
sub getAreas { getKeys(\%Geography::USStates::AREAS, @_); }

# ----------------------------------------------------------------------------
# Subroutine: getAreaNames - return an array of areas by name
# ----------------------------------------------------------------------------
sub getAreaNames { getNames(\%Geography::USStates::AREAS); }

# ----------------------------------------------------------------------------
# Subroutine: getAreaAbbrevs - return an array of areas by 2 letter abbrev
# ----------------------------------------------------------------------------
sub getAreaAbbrevs { getAbbrevs(\%Geography::USStates::AREAS); }

# ----------------------------------------------------------------------------
# BOTH: Look up both states and dependant areas
# ----------------------------------------------------------------------------

# ----------------------------------------------------------------------------
# Subroutine: getStateOrArea - given abbrev get full name, given name get abbrev
# ----------------------------------------------------------------------------
sub getStateOrArea { getKey(\%Geography::USStates::BOTH, @_); }

# ----------------------------------------------------------------------------
# Subroutine: getStatesAndAreas - return a state or areas hash
# ----------------------------------------------------------------------------
sub getStatesAndAreas { getKeys(\%Geography::USStates::BOTH, @_); }

# ----------------------------------------------------------------------------
# Subroutine: getStatesAndAreasNames - return an array of both by name
# ----------------------------------------------------------------------------
sub getStatesAndAreasNames { getNames(\%Geography::USStates::BOTH); }

# ----------------------------------------------------------------------------
# Subroutine: getStatesAndAreasAbbrevs - return an array of both by 2 letter abbrev
# ----------------------------------------------------------------------------
sub getStatesAndAreasAbbrevs { getAbbrevs(\%Geography::USStates::BOTH); }

# ----------------------------------------------------------------------------
1; # End of Geography::USStates.pm
# ----------------------------------------------------------------------------

__END__