model_un 0.1 → 0.2

data/README.md

@@ -3,7 +3,7 @@ ModelUN - Quick and easy country and US State abbreviations
 
 ModelUN is a tiny little Ruby library for abbreviating and, er, de-abbreviating Countries and US State names. 
 
-Brought to you by [Uh Huh Yeah](http://uhhuhyeah.com/) and [Climber](http://www.climber.com/)
+Brought to you by [Uh Huh Yeah](http://uhhuhyeah.com/) with help and encouragement from [Climber.com](http://www.climber.com/)
 
 Installation
 -------------
@@ -11,8 +11,8 @@ Installation
     gem install model_un
 
 
-ModelUN API
-===========
+ModelUN API - US States
+=======================
 
 Convert a US State to it's abbreviated name
 -------------------------------------------
@@ -33,14 +33,44 @@ Or, a shortcut for either method
 		my_state_abbr = ModelUN.convert(my_state) # returns 'CA'	
 
 		my_state_abbr = 'CA'
-		my_state_name = ModelUN.convert(my_state_abbr) # returns 'California'	
+		my_state_name = ModelUN.convert(my_state_abbr) # returns 'California'
+		
 
+ModelUN API - Countries
+=======================
 
-Current version: v0.1 (February 2011)
+Convert a Country to it's (NATO) abbreviated name
+-------------------------------------------
+
+		my_country = 'Sweden'
+		my_country_abbr = ModelUN.convert_country_name(my_country) # returns 'SWE'
+
+Convert a NATO Country abbreviation to it's full name
+-------------------------------------------------
+
+		my_country_abbr = 'SWE'
+		my_country_name = ModelUN.convert_country_abbr(my_country_abbr) # returns 'Sweden'
+
+Or, a shortcut for either method
+--------------------------------
+
+		my_country = 'Sweden'
+		my_country_abbr = ModelUN.convert(my_country) # returns 'SWE'	
+
+		my_country_abbr = 'SWE'
+		my_country_name = ModelUN.convert(my_country_abbr) # returns 'Sweden'
+
+
+Current version: v0.2 (February 2011)
 =====================================
 
 *	Supports conversion of US State names (including Guam, Marshal and Virgin Islands)
-* [Country conversions to be added in next release] 
+*	Supports conversion of Countries against NATO Country names and codes
+
+Upcoming features:
+=====================================
+
+* Support converting countries by their common "nick names". E.g. Accepting "United Kingdom" for "United Kingdom of Great Britain and Northern Ireland"
 
 Known issues
 ------------

data/lib/model_un/data.rb

@@ -186,4 +186,487 @@ module ModelUN
     {'full' => 'WYOMING',                         'abbr' => 'WY'}
   ]
   
+  
+  NATO_COUNTRY_NAMES = [
+    "AFGHANISTAN",
+    "ALAND ISLANDS",
+    "ALBANIA",
+    "ALGERIA",
+    "AMERICAN SAMOA",
+    "ANDORRA",
+    "ANGOLA",
+    "ANGUILLA",
+    "ANTIGUA AND BARBUDA",
+    "ARGENTINA",
+    "ARMENIA",
+    "ARUBA",
+    "AUSTRALIA",
+    "AUSTRIA",
+    "AZERBAIJAN",
+    "BAHAMAS",
+    "BAHRAIN",
+    "BANGLADESH",
+    "BARBADOS",
+    "BELARUS",
+    "BELGIUM",
+    "BELIZE",
+    "BENIN",
+    "BERMUDA",
+    "BHUTAN",
+    "BOLIVIA (PLURINATIONAL STATE OF)",
+    "BONAIRE, SAINT EUSTATIUS AND SABA",
+    "BOSNIA AND HERZEGOVINA",
+    "BOTSWANA",
+    "BRAZIL",
+    "BRITISH VIRGIN ISLANDS",
+    "BRUNEI DARUSSALAM",
+    "BULGARIA",
+    "BURKINA FASO",
+    "BURUNDI",
+    "CAMBODIA",
+    "CAMEROON",
+    "CANADA",
+    "CAPE VERDE",
+    "CAYMAN ISLANDS",
+    "CENTRAL AFRICAN REPUBLIC",
+    "CHAD",
+    "CHILE",
+    "CHINA",
+    "CHINA, HONG KONG SPECIAL ADMINISTRATIVE REGION",
+    "CHINA, MACAO SPECIAL ADMINISTRATIVE REGION",
+    "COLOMBIA",
+    "COMOROS",
+    "CONGO",
+    "COOK ISLANDS",
+    "COSTA RICA",
+    "COTE D'IVOIRE",
+    "CROATIA",
+    "CUBA",
+    "CURAÇAO",
+    "CYPRUS",
+    "CZECH REPUBLIC",
+    "DEMOCRATIC PEOPLE'S REPUBLIC OF KOREA",
+    "DEMOCRATIC REPUBLIC OF THE CONGO",
+    "DENMARK",
+    "DJIBOUTI",
+    "DOMINICA",
+    "DOMINICAN REPUBLIC",
+    "ECUADOR",
+    "EGYPT",
+    "EL SALVADOR",
+    "EQUATORIAL GUINEA",
+    "ERITREA",
+    "ESTONIA",
+    "ETHIOPIA",
+    "FAEROE ISLANDS",
+    "FALKLAND ISLANDS (MALVINAS)",
+    "FIJI",
+    "FINLAND",
+    "FRANCE",
+    "FRENCH GUIANA",
+    "FRENCH POLYNESIA",
+    "GABON",
+    "GAMBIA",
+    "GEORGIA",
+    "GERMANY",
+    "GHANA",
+    "GIBRALTAR",
+    "GREECE",
+    "GREENLAND",
+    "GRENADA",
+    "GUADELOUPE",
+    "GUAM",
+    "GUATEMALA",
+    "GUERNSEY",
+    "GUINEA",
+    "GUINEA-BISSAU",
+    "GUYANA",
+    "HAITI",
+    "HOLY SEE",
+    "HONDURAS",
+    "HUNGARY",
+    "ICELAND",
+    "INDIA",
+    "INDONESIA",
+    "IRAN (ISLAMIC REPUBLIC OF)",
+    "IRAQ",
+    "IRELAND",
+    "ISLE OF MAN",
+    "ISRAEL",
+    "ITALY",
+    "JAMAICA",
+    "JAPAN",
+    "JERSEY	",
+    "JORDAN",
+    "KAZAKHSTAN",
+    "KENYA",
+    "KIRIBATI",
+    "KUWAIT",
+    "KYRGYZSTAN",
+    "LAO PEOPLE'S DEMOCRATIC REPUBLIC",
+    "LATVIA",
+    "LEBANON",
+    "LESOTHO",
+    "LIBERIA",
+    "LIBYAN ARAB JAMAHIRIYA",
+    "LIECHTENSTEIN",
+    "LITHUANIA",
+    "LUXEMBOURG",
+    "MADAGASCAR",
+    "MALAWI",
+    "MALAYSIA",
+    "MALDIVES",
+    "MALI",
+    "MALTA",
+    "MARSHALL ISLANDS",
+    "MARTINIQUE",
+    "MAURITANIA",
+    "MAURITIUS",
+    "MAYOTTE	",
+    "MEXICO",
+    "MICRONESIA (FEDERATED STATES OF)",
+    "MONACO",
+    "MONGOLIA",
+    "MONTENEGRO",
+    "MONTSERRAT",
+    "MOROCCO",
+    "MOZAMBIQUE",
+    "MYANMAR",
+    "NAMIBIA",
+    "NAURU",
+    "NEPAL",
+    "NETHERLANDS",
+    "NEW CALEDONIA",
+    "NEW ZEALAND",
+    "NICARAGUA",
+    "NIGER",
+    "NIGERIA",
+    "NIUE",
+    "NORFOLK ISLAND",
+    "NORTHERN MARIANA ISLANDS",
+    "NORWAY",
+    "OCCUPIED PALESTINIAN TERRITORY",
+    "OMAN",
+    "PAKISTAN",
+    "PALAU",
+    "PANAMA",
+    "PAPUA NEW GUINEA",
+    "PARAGUAY",
+    "PERU",
+    "PHILIPPINES",
+    "PITCAIRN",
+    "POLAND",
+    "PORTUGAL",
+    "PUERTO RICO",
+    "QATAR",
+    "REPUBLIC OF KOREA",
+    "REPUBLIC OF MOLDOVA",
+    "REUNION",
+    "ROMANIA",
+    "RUSSIAN FEDERATION",
+    "RWANDA",
+    "SAINT-BARTHELEMY",
+    "SAINT HELENA",
+    "SAINT KITTS AND NEVIS",
+    "SAINT LUCIA",
+    "SAINT-MARTIN (FRENCH PART)",
+    "SAINT PIERRE AND MIQUELON",
+    "SAINT VINCENT AND THE GRENADINES",
+    "SAMOA",
+    "SAN MARINO",
+    "SAO TOME AND PRINCIPE",
+    "SAUDI ARABIA",
+    "SENEGAL",
+    "SERBIA",
+    "SEYCHELLES",
+    "SIERRA LEONE",
+    "SINGAPORE",
+    "SINT MAARTEN (DUTCH PART)",
+    "SLOVAKIA",
+    "SLOVENIA",
+    "SOLOMON ISLANDS",
+    "SOMALIA",
+    "SOUTH AFRICA",
+    "SPAIN",
+    "SRI LANKA",
+    "SUDAN",
+    "SURINAME",
+    "SVALBARD AND JAN MAYEN ISLANDS",
+    "SWAZILAND",
+    "SWEDEN",
+    "SWITZERLAND",
+    "SYRIAN ARAB REPUBLIC",
+    "TAJIKISTAN",
+    "THAILAND",
+    "THE FORMER YUGOSLAV REPUBLIC OF MACEDONIA",
+    "TIMOR-LESTE",
+    "TOGO",
+    "TOKELAU",
+    "TONGA",
+    "TRINIDAD AND TOBAGO",
+    "TUNISIA",
+    "TURKEY",
+    "TURKMENISTAN",
+    "TURKS AND CAICOS ISLANDS",
+    "TUVALU",
+    "UGANDA",
+    "UKRAINE",
+    "UNITED ARAB EMIRATES",
+    "UNITED KINGDOM OF GREAT BRITAIN AND NORTHERN IRELAND",
+    "UNITED REPUBLIC OF TANZANIA",
+    "UNITED STATES OF AMERICA",
+    "UNITED STATES VIRGIN ISLANDS",
+    "URUGUAY",
+    "UZBEKISTAN",
+    "VANUATU",
+    "VENEZUELA (BOLIVARIAN REPUBLIC OF)",
+    "VIET NAM",
+    "WALLIS AND FUTUNA ISLANDS",
+    "WESTERN SAHARA",
+    "YEMEN",
+    "ZAMBIA",
+    "ZIMBABWE"
+  ]
+  
+  NATO_ABBR = [
+    'AFG',
+    'ALA',
+    'ALB',
+    'DZA',
+    'ASM',
+    'AND',
+    'AGO',
+    'AIA',
+    'ATG',
+    'ARG',
+    'ARM',
+    'ABW',
+    'AUS',
+    'AUT',
+    'AZE',
+    'BHS',
+    'BHR',
+    'BGD',
+    'BRB',
+    'BLR',
+    'BEL',
+    'BLZ',
+    'BEN',
+    'BMU',
+    'BTN',
+    'BOL',
+    'BES',
+    'BIH',
+    'BWA',
+    'BRA',
+    'VGB',
+    'BRN',
+    'BGR',
+    'BFA',
+    'BDI',
+    'KHM',
+    'CMR',
+    'CAN',
+    'CPV',
+    'CYM',
+    'CAF',
+    'TCD',
+    'CHL',
+    'CHN',
+    'HKG',
+    'MAC',
+    'COL',
+    'COM',
+    'COG',
+    'COK',
+    'CRI',
+    'CIV',
+    'HRV',
+    'CUB',
+    'CUW',
+    'CYP',
+    'CZE',
+    'PRK',
+    'COD',
+    'DNK',
+    'DJI',
+    'DMA',
+    'DOM',
+    'ECU',
+    'EGY',
+    'SLV',
+    'GNQ',
+    'ERI',
+    'EST',
+    'ETH',
+    'FRO',
+    'FLK',
+    'FJI',
+    'FIN',
+    'FRA',
+    'GUF',
+    'PYF',
+    'GAB',
+    'GMB',
+    'GEO',
+    'DEU',
+    'GHA',
+    'GIB',
+    'GRC',
+    'GRL',
+    'GRD',
+    'GLP',
+    'GUM',
+    'GTM',
+    'GGY',
+    'GIN',
+    'GNB',
+    'GUY',
+    'HTI',
+    'VAT',
+    'HND',
+    'HUN',
+    'ISL',
+    'IND',
+    'IDN',
+    'IRN',
+    'IRQ',
+    'IRL',
+    'IMN',
+    'ISR',
+    'ITA',
+    'JAM',
+    'JPN',
+    'JEY',
+    'JOR',
+    'KAZ',
+    'KEN',
+    'KIR',
+    'KWT',
+    'KGZ',
+    'LAO',
+    'LVA',
+    'LBN',
+    'LSO',
+    'LBR',
+    'LBY',
+    'LIE',
+    'LTU',
+    'LUX',
+    'MDG',
+    'MWI',
+    'MYS',
+    'MDV',
+    'MLI',
+    'MLT',
+    'MHL',
+    'MTQ',
+    'MRT',
+    'MUS',
+    'MYT',
+    'MEX',
+    'FSM',
+    'MCO',
+    'MNG',
+    'MNE',
+    'MSR',
+    'MAR',
+    'MOZ',
+    'MMR',
+    'NAM',
+    'NRU',
+    'NPL',
+    'NLD',
+    'NCL',
+    'NZL',
+    'NIC',
+    'NER',
+    'NGA',
+    'NIU',
+    'NFK',
+    'MNP',
+    'NOR',
+    'PSE',
+    'OMN',
+    'PAK',
+    'PLW',
+    'PAN',
+    'PNG',
+    'PRY',
+    'PER',
+    'PHL',
+    'PCN',
+    'POL',
+    'PRT',
+    'PRI',
+    'QAT',
+    'KOR',
+    'MDA',
+    'REU',
+    'ROU',
+    'RUS',
+    'RWA',
+    'BLM',
+    'SHN',
+    'KNA',
+    'LCA',
+    'MAF',
+    'SPM',
+    'VCT',
+    'WSM',
+    'SMR',
+    'STP',
+    'SAU',
+    'SEN',
+    'SRB',
+    'SYC',
+    'SLE',
+    'SGP',
+    'SXM',
+    'SVK',
+    'SVN',
+    'SLB',
+    'SOM',
+    'ZAF',
+    'ESP',
+    'LKA',
+    'SDN',
+    'SUR',
+    'SJM',
+    'SWZ',
+    'SWE',
+    'CHE',
+    'SYR',
+    'TJK',
+    'THA',
+    'MKD',
+    'TLS',
+    'TGO',
+    'TKL',
+    'TON',
+    'TTO',
+    'TUN',
+    'TUR',
+    'TKM',
+    'TCA',
+    'TUV',
+    'UGA',
+    'UKR',
+    'ARE',
+    'GBR',
+    'TZA',
+    'USA',
+    'VIR',
+    'URY',
+    'UZB',
+    'VUT',
+    'VEN',
+    'VNM',
+    'WLF',
+    'ESH',
+    'YEM',
+    'ZMB',
+    'ZWE'
+  ]
+  
 end

data/lib/model_un/version.rb

@@ -1,3 +1,3 @@
 module ModelUN
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/lib/model_un.rb

@@ -7,11 +7,14 @@ module ModelUN
     def convert(string)
       if string.length == 2
         self.convert_state_abbr(string.upcase)
+      elsif string.length == 3
+        self.convert_nato_country_abbr(string.upcase)
       else
-        self.convert_state_name(string.upcase)
+        self.convert_state_or_country_name(string.upcase)
       end
     end
     
+    # US STATES
     def convert_state_abbr(state_abbr)
       self.convert_state_abbreviation(state_abbr)
     end
@@ -26,12 +29,46 @@ module ModelUN
     
     def convert_state_name(state_name)
       begin
-        return US_STATE_ABBR[US_STATE_NAMES.index(state_name)]
+        return US_STATE_ABBR[US_STATE_NAMES.index(state_name.upcase)]
       rescue Exception
         return state_name.downcase.gsub(/\b\w/){$&.upcase}
       end
     end
     
+    # COUNTRIES (NATO CODES)
+    def convert_country_abbr(country_abbr)
+      self.convert_country_abbr(country_abbr)
+    end
+    
+    def convert_nato_country_abbr(country_abbr)
+      begin
+        return NATO_COUNTRY_NAMES[NATO_ABBR.index(country_abbr)].downcase.gsub(/\b\w/){$&.upcase}
+      rescue Exception
+        return country_abbr
+      end
+    end
+    
+    def convert_country_name(country_name)
+      self.convert_nato_country_name(country_name)
+    end
+    
+    def convert_nato_country_name(country_name)
+      begin
+        return NATO_ABBR[NATO_COUNTRY_NAMES.index(country_name.upcase)]
+      rescue Exception
+        return country_name.downcase.gsub(/\b\w/){$&.upcase}
+      end
+    end
+    
+    def convert_state_or_country_name(name)
+      state_abbr = self.convert_state_name(name)
+      if state_abbr.upcase == name
+        return self.convert_nato_country_name(name)
+      else
+        return state_abbr
+      end
+    end
+    
     def export_states_list
       {'US States' => US_STATES}.to_yaml.gsub(/\n/,'').gsub(/-/, '').strip
     end

data/spec/model_un_spec.rb

@@ -7,24 +7,69 @@ describe ModelUN do
     ModelUN::US_STATE_ABBR.should_not == nil
   end
   
-  it "should return an abbreviation for a full state" do
-    state = 'California'
-    ModelUN.convert(state).should == 'CA'
-  end
-  
-  it "should return a full state for an abbreviation" do
-    abbr = 'CA'
-    ModelUN.convert(abbr).should == 'California'
-  end
-  
-  it "should return the input if no match on abbreviation" do
-    abbr = 'XX'
-    ModelUN.convert(abbr).should == 'XX'
+  describe "states" do
+    it "should return the input if no match on abbreviation" do
+      abbr = 'XX'
+      ModelUN.convert(abbr).should == 'XX'
+      ModelUN.convert_state_abbr(abbr).should == 'XX'
+    end
+
+    it "should return the input if no match on full name" do
+      state = 'Foobar'
+      ModelUN.convert(state).should == state
+      
+    end
+    
+    it "should return a full state for an abbreviation" do
+      abbr = 'CA'
+      ModelUN.convert(abbr).should == 'California'
+      ModelUN.convert_state_abbr(abbr).should == 'California'
+    end
+    
+    it "should return an abbreviation for a full state name" do
+      state = 'California'
+      ModelUN.convert(state).should == 'CA'
+      ModelUN.convert_state_name(state).should == 'CA'
+    end
+    
+    it "should return an abbreviation for a full state name for a state name with two words" do
+      state = 'New Hampshire'
+      ModelUN.convert(state).should == 'NH'
+      ModelUN.convert_state_name(state).should == 'NH'
+    end
   end
-  
-  it "should return the input if no match on full name" do
-    state = 'Foobar'
-    ModelUN.convert(state).should == state
+
+
+  describe "countries" do
+    it "should return the input if no match on country abbreviation" do
+      abbr = 'XX'
+      ModelUN.convert(abbr).should == 'XX'
+      ModelUN.convert_nato_country_abbr(abbr).should == 'XX'
+    end
+
+    it "should return the input if no match on country full name" do
+      country = 'Foobar'
+      ModelUN.convert(country).should == 'Foobar'
+      ModelUN.convert_nato_country_name(country).should == 'Foobar'
+    end
+    
+    it "should return a full country name for an abbreviation" do
+      abbr = 'SWE'
+      ModelUN.convert(abbr).should == 'Sweden'
+      ModelUN.convert_nato_country_abbr(abbr).should == 'Sweden'
+    end
+    
+    it "should return an abbreviation for a full country name" do
+      country = 'Sweden'
+      ModelUN.convert(country).should == 'SWE'
+      ModelUN.convert_nato_country_name(country).should == 'SWE'
+    end
+    
+    it "should return an abbreviation full country name for a country name with two words" do
+      country = 'Czech Republic'
+      ModelUN.convert(country).should == 'CZE'
+      ModelUN.convert_nato_country_name(country).should == 'CZE'
+    end
   end
 
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: model_un
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Uh Huh Yeah