Add iso_short_name_lower_case attribute as an alternative to #907

pmor · pmor · commit 0df0e0079a18 · 2025-09-29T16:42:47.000+01:00
diff --git a/README.md b/README.md
@@ -96,6 +96,7 @@ c.gec    # => "US"
 ```ruby
 c.iso_long_name # => "The United States of America"
 c.iso_short_name # => "United States of America"
+c.iso_short_name_lower_case # => "United States of America (the)"
 c.common_name # => "United States" (This is a shortcut for c.translations('en'))
 c.unofficial_names # => ["United States of America", "Vereinigte Staaten von Amerika", "États-Unis", "Estados Unidos"]
 
diff --git a/lib/countries/cache/countries.json b/lib/countries/cache/countries.json
diff --git a/lib/countries/country.rb b/lib/countries/country.rb
@@ -103,6 +103,11 @@ def in_un?
       data['un_member'].nil? ? false : data['un_member']
     end
 
+    # @return [String] The ISO 3166-1 "Short name lower case" value for this Country.
+    def iso_short_name_lower_case
+      data['iso_short_name_lower_case'].nil? ? data['iso_short_name'] : data['iso_short_name_lower_case']
+    end
+
     # @return [String] The regex for valid postal codes in this Country
     def postal_code_format
       "\\A#{data['postal_code_format']}\\Z" if postal_code
diff --git a/lib/countries/data/countries/AE.yaml b/lib/countries/data/countries/AE.yaml
@@ -29,7 +29,8 @@ AE:
   international_prefix: '00'
   ioc: UAE
   iso_long_name: The United Arab Emirates
-  iso_short_name: United Arab Emirates (the)
+  iso_short_name: United Arab Emirates
+  iso_short_name_lower_case: United Arab Emirates (the)
   languages_official:
   - ar
   languages_spoken:
diff --git a/lib/countries/data/countries/BS.yaml b/lib/countries/data/countries/BS.yaml
@@ -24,7 +24,8 @@ BS:
   international_prefix: '011'
   ioc: BAH
   iso_long_name: The Commonwealth of The Bahamas
-  iso_short_name: Bahamas (the)
+  iso_short_name: Bahamas
+  iso_short_name_lower_case: Bahamas (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/CC.yaml b/lib/countries/data/countries/CC.yaml
@@ -24,7 +24,8 @@ CC:
   international_prefix: '0011'
   ioc:
   iso_long_name: The Territory of Cocos (Keeling) Islands
-  iso_short_name: Cocos (Keeling) Islands (the)
+  iso_short_name: Cocos (Keeling) Islands
+  iso_short_name_lower_case: Cocos (Keeling) Islands (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/CD.yaml b/lib/countries/data/countries/CD.yaml
@@ -24,7 +24,8 @@ CD:
   international_prefix: '00'
   ioc: COD
   iso_long_name: The Democratic Republic of the Congo
-  iso_short_name: Congo (the Democratic Republic of the)
+  iso_short_name: Congo (Democratic Republic of the)
+  iso_short_name_lower_case: Congo (the Democratic Republic of the)
   languages_official:
   - fr
   - ln
diff --git a/lib/countries/data/countries/CF.yaml b/lib/countries/data/countries/CF.yaml
@@ -24,7 +24,8 @@ CF:
   international_prefix: '00'
   ioc: CAF
   iso_long_name: The Central African Republic
-  iso_short_name: Central African Republic (the)
+  iso_short_name: Central African Republic
+  iso_short_name_lower_case: Central African Republic (the)
   languages_official:
   - fr
   - sg
diff --git a/lib/countries/data/countries/CG.yaml b/lib/countries/data/countries/CG.yaml
@@ -24,7 +24,8 @@ CG:
   international_prefix: '00'
   ioc: CGO
   iso_long_name: The Republic of the Congo
-  iso_short_name: Congo (the)
+  iso_short_name: Congo
+  iso_short_name_lower_case: Congo (the)
   languages_official:
   - fr
   - ln
diff --git a/lib/countries/data/countries/CK.yaml b/lib/countries/data/countries/CK.yaml
@@ -24,7 +24,8 @@ CK:
   international_prefix: '00'
   ioc: COK
   iso_long_name: The Cook Islands
-  iso_short_name: Cook Islands (the)
+  iso_short_name: Cook Islands
+  iso_short_name_lower_case: Cook Islands (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/DO.yaml b/lib/countries/data/countries/DO.yaml
@@ -24,7 +24,8 @@ DO:
   international_prefix: '011'
   ioc: DOM
   iso_long_name: The Dominican Republic
-  iso_short_name: Dominican Republic (the)
+  iso_short_name: Dominican Republic
+  iso_short_name_lower_case: Dominican Republic (the)
   languages_official:
   - es
   languages_spoken:
diff --git a/lib/countries/data/countries/FK.yaml b/lib/countries/data/countries/FK.yaml
@@ -24,7 +24,8 @@ FK:
   international_prefix: '00'
   ioc:
   iso_long_name: The Falkland Islands
-  iso_short_name: Falkland Islands (the) [Malvinas]
+  iso_short_name: Falkland Islands (Malvinas)
+  iso_short_name_lower_case: Falkland Islands (the) [Malvinas]
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/FO.yaml b/lib/countries/data/countries/FO.yaml
@@ -24,7 +24,8 @@ FO:
   international_prefix: '00'
   ioc: FRO
   iso_long_name: The Faroe Islands
-  iso_short_name: Faroe Islands (the)
+  iso_short_name: Faroe Islands
+  iso_short_name_lower_case: Faroe Islands (the)
   languages_official:
   - fo
   languages_spoken:
diff --git a/lib/countries/data/countries/GB.yaml b/lib/countries/data/countries/GB.yaml
@@ -35,7 +35,8 @@ GB:
   international_prefix: '00'
   ioc: GBR
   iso_long_name: The United Kingdom of Great Britain and Northern Ireland
-  iso_short_name: United Kingdom of Great Britain and Northern Ireland (the)
+  iso_short_name: United Kingdom of Great Britain and Northern Ireland
+  iso_short_name_lower_case: United Kingdom of Great Britain and Northern Ireland (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/GM.yaml b/lib/countries/data/countries/GM.yaml
@@ -24,7 +24,8 @@ GM:
   international_prefix: '00'
   ioc: GAM
   iso_long_name: The Republic of The Gambia
-  iso_short_name: Gambia (the)
+  iso_short_name: Gambia
+  iso_short_name_lower_case: Gambia (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/IO.yaml b/lib/countries/data/countries/IO.yaml
@@ -24,7 +24,8 @@ IO:
   international_prefix: ''
   ioc:
   iso_long_name: The British Indian Ocean Territory
-  iso_short_name: British Indian Ocean Territory (the)
+  iso_short_name: British Indian Ocean Territory
+  iso_short_name_lower_case: British Indian Ocean Territory (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/KM.yaml b/lib/countries/data/countries/KM.yaml
@@ -24,7 +24,8 @@ KM:
   international_prefix: '00'
   ioc: COM
   iso_long_name: The Union of the Comoros
-  iso_short_name: Comoros (the)
+  iso_short_name: Comoros
+  iso_short_name_lower_case: Comoros (the)
   languages_official:
   - ar
   - fr
diff --git a/lib/countries/data/countries/KP.yaml b/lib/countries/data/countries/KP.yaml
@@ -24,7 +24,8 @@ KP:
   international_prefix: '00'
   ioc: PRK
   iso_long_name: The Democratic People's Republic of Korea
-  iso_short_name: Korea (the Democratic People's Republic of)
+  iso_short_name: Korea (Democratic People's Republic of)
+  iso_short_name_lower_case: Korea (the Democratic People's Republic of)
   languages_official:
   - ko
   languages_spoken:
diff --git a/lib/countries/data/countries/KR.yaml b/lib/countries/data/countries/KR.yaml
@@ -31,7 +31,8 @@ KR:
   international_prefix: '001'
   ioc: KOR
   iso_long_name: The Republic of Korea
-  iso_short_name: Korea (the Republic of)
+  iso_short_name: Korea (Republic of)
+  iso_short_name_lower_case: Korea (the Republic of)
   languages_official:
   - ko
   languages_spoken:
diff --git a/lib/countries/data/countries/KY.yaml b/lib/countries/data/countries/KY.yaml
@@ -24,7 +24,8 @@ KY:
   international_prefix: '011'
   ioc: CAY
   iso_long_name: The Cayman Islands
-  iso_short_name: Cayman Islands (the)
+  iso_short_name: Cayman Islands
+  iso_short_name_lower_case: Cayman Islands (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/LA.yaml b/lib/countries/data/countries/LA.yaml
@@ -24,7 +24,8 @@ LA:
   international_prefix: '00'
   ioc: LAO
   iso_long_name: The Lao People's Democratic Republic
-  iso_short_name: Lao People's Democratic Republic (the)
+  iso_short_name: Lao People's Democratic Republic
+  iso_short_name_lower_case: Lao People's Democratic Republic (the)
   languages_official:
   - lo
   languages_spoken:
diff --git a/lib/countries/data/countries/MD.yaml b/lib/countries/data/countries/MD.yaml
@@ -24,7 +24,8 @@ MD:
   international_prefix: '00'
   ioc: MDA
   iso_long_name: The Republic of Moldova
-  iso_short_name: Moldova (the Republic of)
+  iso_short_name: Moldova (Republic of)
+  iso_short_name_lower_case: Moldova (the Republic of)
   languages_official:
   - ro
   languages_spoken:
diff --git a/lib/countries/data/countries/MH.yaml b/lib/countries/data/countries/MH.yaml
@@ -24,7 +24,8 @@ MH:
   international_prefix: '00'
   ioc: MHL
   iso_long_name: The Republic of the Marshall Islands
-  iso_short_name: Marshall Islands (the)
+  iso_short_name: Marshall Islands
+  iso_short_name_lower_case: Marshall Islands (the)
   languages_official:
   - en
   - mh
diff --git a/lib/countries/data/countries/MP.yaml b/lib/countries/data/countries/MP.yaml
@@ -24,7 +24,8 @@ MP:
   international_prefix: '011'
   ioc:
   iso_long_name: The Commonwealth of the Northern Mariana Islands
-  iso_short_name: Northern Mariana Islands (the)
+  iso_short_name: Northern Mariana Islands
+  iso_short_name_lower_case: Northern Mariana Islands (the)
   languages_official:
   - en
   - ch
diff --git a/lib/countries/data/countries/NE.yaml b/lib/countries/data/countries/NE.yaml
@@ -24,7 +24,8 @@ NE:
   international_prefix: '00'
   ioc: NIG
   iso_long_name: The Republic of the Niger
-  iso_short_name: Niger (the)
+  iso_short_name: Niger
+  iso_short_name_lower_case: Niger (the)
   languages_official:
   - fr
   languages_spoken:
diff --git a/lib/countries/data/countries/NL.yaml b/lib/countries/data/countries/NL.yaml
@@ -31,7 +31,8 @@ NL:
   international_prefix: '00'
   ioc: NED
   iso_long_name: The Kingdom of the Netherlands
-  iso_short_name: Netherlands (the)
+  iso_short_name: Netherlands
+  iso_short_name_lower_case: Netherlands (the)
   languages_official:
   - nl
   languages_spoken:
diff --git a/lib/countries/data/countries/PH.yaml b/lib/countries/data/countries/PH.yaml
@@ -29,7 +29,8 @@ PH:
   international_prefix: '00'
   ioc: PHI
   iso_long_name: The Republic of the Philippines
-  iso_short_name: Philippines (the)
+  iso_short_name: Philippines
+  iso_short_name_lower_case: Philippines (the)
   languages_official:
   - tl
   - en
diff --git a/lib/countries/data/countries/RU.yaml b/lib/countries/data/countries/RU.yaml
@@ -30,7 +30,8 @@ RU:
   international_prefix: '810'
   ioc: RUS
   iso_long_name: The Russian Federation
-  iso_short_name: Russian Federation (the)
+  iso_short_name: Russian Federation
+  iso_short_name_lower_case: Russian Federation (the)
   languages_official:
   - ru
   languages_spoken:
diff --git a/lib/countries/data/countries/SD.yaml b/lib/countries/data/countries/SD.yaml
@@ -24,7 +24,8 @@ SD:
   international_prefix: '00'
   ioc: SUD
   iso_long_name: The Republic of the Sudan
-  iso_short_name: Sudan (the)
+  iso_short_name: Sudan
+  iso_short_name_lower_case: Sudan (the)
   languages_official:
   - ar
   - en
diff --git a/lib/countries/data/countries/TC.yaml b/lib/countries/data/countries/TC.yaml
@@ -24,7 +24,8 @@ TC:
   international_prefix: '011'
   ioc:
   iso_long_name: The Turks and Caicos Islands
-  iso_short_name: Turks and Caicos Islands (the)
+  iso_short_name: Turks and Caicos Islands
+  iso_short_name_lower_case: Turks and Caicos Islands (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/TF.yaml b/lib/countries/data/countries/TF.yaml
@@ -24,7 +24,8 @@ TF:
   international_prefix: ''
   ioc:
   iso_long_name: The French Southern and Antarctic Lands
-  iso_short_name: French Southern Territories (the)
+  iso_short_name: French Southern Territories
+  iso_short_name_lower_case: French Southern Territories (the)
   languages_official:
   - fr
   languages_spoken:
diff --git a/lib/countries/data/countries/TW.yaml b/lib/countries/data/countries/TW.yaml
@@ -29,7 +29,8 @@ TW:
   international_prefix: '002'
   ioc: TPE
   iso_long_name: Taiwan, Province of China
-  iso_short_name: Taiwan (Province of China)
+  iso_short_name: Taiwan, Province of China
+  iso_short_name_lower_case: Taiwan (Province of China)
   languages_official:
   - zh
   languages_spoken:
diff --git a/lib/countries/data/countries/UM.yaml b/lib/countries/data/countries/UM.yaml
@@ -24,7 +24,8 @@ UM:
   international_prefix: ''
   ioc:
   iso_long_name: United States Minor Outlying Islands
-  iso_short_name: United States Minor Outlying Islands (the)
+  iso_short_name: United States Minor Outlying Islands
+  iso_short_name_lower_case: United States Minor Outlying Islands (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/US.yaml b/lib/countries/data/countries/US.yaml
@@ -31,7 +31,8 @@ US:
   international_prefix: '011'
   ioc: USA
   iso_long_name: The United States of America
-  iso_short_name: United States of America (the)
+  iso_short_name: United States of America
+  iso_short_name_lower_case: United States of America (the)
   languages_official:
   - en
   languages_spoken:
diff --git a/lib/countries/data/countries/VA.yaml b/lib/countries/data/countries/VA.yaml
@@ -24,7 +24,8 @@ VA:
   international_prefix: '00'
   ioc:
   iso_long_name: The Holy See
-  iso_short_name: Holy See (the)
+  iso_short_name: Holy See
+  iso_short_name_lower_case: Holy See (the)
   languages_official:
   - it
   - la
diff --git a/spec/country_spec.rb b/spec/country_spec.rb
@@ -56,6 +56,12 @@
     expect(country.iso_short_name).to eq('United States of America (the)')
   end
 
+  it 'should return 3166 iso_short_name_lower_case if available' do
+    expect(country.iso_short_name_lower_case).to eq('United States of America (the)')
+    portugal = ISO3166::Country.new('PT')
+    expect(portugal.iso_short_name_lower_case).to eq('Portugal')
+  end
+
   it 'should return alternate names' do
     expect(country.unofficial_names).to eq(['United States',
                                             'United States of America', 'USA',
