countries 5.0.1 → 5.1.2

data/lib/countries/data/translations/countries-zu.yaml

@@ -0,0 +1,254 @@
+# Country name translations for locale zu
+#
+# alpha2: localized_name
+#
+---
+AD: I-Andora
+AE: United Arab Emirates
+AF: I-Afganistani
+AG: Antigua no Barbuda
+AI: Anguilla
+AL: I-Albaniya
+AM: Armenia
+AO: I-Angola
+AQ: Antarctica
+AR: I-Argentina
+AS: American Samoa
+AT: I-Ostriya
+AU: I-Ostreliya
+AW: Aruba
+AX: Åland Islands
+AZ: I-Azerbayijani
+BA: IBhosniya neHerzegovina
+BB: I-Barbados
+BD: Isi-Bhangladeshi
+BE: Isi-Bhelijiyamu
+BF: IBukhina Faso
+BG: IBulgariya
+BH: Bahrain
+BI: IBurundi
+BJ: IBenini
+BL: Saint Barthélemy
+BM: Bermuda
+BN: Brunei Darussalam
+BO: I Boliviya
+BQ: Bonaire, Sint Eustatius and Saba
+BR: IBrazili
+BS: Bahamas
+BT: Bhutan
+BV: Bouvet Island
+BW: IButswana
+BY: IBelarusi
+BZ: Belize
+CA: I Khanada
+CC: Cocos (Keeling) Islands
+CD: Congo, The Democratic Republic of the
+CF: Central African Republic
+CG: Congo
+CH: I-Switzerland
+CI: Côte d'Ivoire
+CK: Cook Islands
+CL: I-Chile
+CM: IKamerooni
+CN: Isi-Shayina
+CO: IKolombiya
+CR: Costa Rica
+CU: Cuba
+CV: Cabo Verde
+CW: Curaçao
+CX: Christmas Island
+CY: Cyprus
+CZ: Czechia
+DE: IJalimani
+DJ: IJibuthi
+DK: IDenimaki
+DM: Dominica
+DO: Ulawulo lokuziphatha kwe Dominikhani
+DZ: IAljiriya
+EC: Ecuador
+EE: I-Estoniya
+EG: IGibhithe
+EH: Western Sahara
+ER: I-Eritrea
+ES: ISpeyini
+ET: I-Ithiopia
+FI: IFinlandi
+FJ: IFiji
+FK: Falkland Islands (Malvinas)
+FM: Micronesia, Federated States of
+FO: Faroe Islands
+FR: IFulansi
+GA: IGaboni
+GB: Umbuso Ohlangeneyo
+GD: I-Grenada
+GE: Georgia
+GF: French Guiana
+GG: Guernsey
+GH: IGana
+GI: Gibraltar
+GL: Greenland
+GM: Gambia
+GN: IGini
+GP: Guadeloupe
+GQ: IGini Enkabazwe
+GR: IGreki
+GS: South Georgia and the South Sandwich Islands
+GT: I-Guwathemala
+GU: Guam
+GW: IGini Bisawu
+GY: Guyana
+HK: Hong Kong
+HM: Heard Island and McDonald Islands
+HN: I-Hondurasi
+HR: IKrowati
+HT: Haiti
+HU: I-Hungariya
+ID: I-Indonesia
+IE: I-Ayilendi
+IL: Isreyili
+IM: Isle of Man
+IN: India
+IO: British Indian Ocean Territory
+IQ: I-Iraki
+IR: Iran, Islamic Republic of
+IS: I-Ayisilandi
+IT: ITaliya
+JE: Jersey
+JM: Jamaica
+JO: Jordan
+JP: IJaphani
+KE: IKenya
+KG: Kyrgyzstan
+KH: Cambodia
+KI: Kiribati
+KM: IsiKhomorosi
+KN: Saint Kitts and Nevis
+KP: North Korea
+KR: South Korea
+KW: Kuwait
+KY: Cayman Islands
+KZ: Kazakhstan
+LA: Lao People's Democratic Republic
+LB: Lebanon
+LC: Saint Lucia
+LI: Liechtenstein
+LK: Sri Lanka
+LR: ILiberia
+LS: OSotho
+LT: ILithuwaniya
+LU: I-Luxembourg
+LV: ILatviya
+LY: ILibiya
+MA: IMorokho
+MC: Monaco
+MD: Moldova
+ME: IMontenegro
+MF: Saint Martin (French part)
+MG: IMadagasika
+MH: Marshall Islands
+MK: North Macedonia
+ML: IMali
+MM: Myanmar
+MN: Mongolia
+MO: Macao
+MP: Northern Mariana Islands
+MQ: Martinique
+MR: IMoritaniya
+MS: Montserrat
+MT: IMalta
+MU: IMorishisi
+MV: Maldives
+MW: IMalawi
+MX: IMekisiko
+MY: Malaysia
+MZ: IMozambiki
+NA: INamibhiya
+NC: New Caledonia
+NE: INayighe
+NF: Norfolk Island
+NG: INigeria
+NI: Nicaragua
+NL: I-Netherlands
+'NO': INoki
+NP: Nepal
+NR: Nauru
+NU: Niue
+NZ: INyuzilandi
+OM: Oman
+PA: Panama
+PE: I-Peru
+PF: French Polynesia
+PG: Papua New Guinea
+PH: Philippines
+PK: IPakistani
+PL: IPolandi
+PM: Saint Pierre and Miquelon
+PN: Pitcairn
+PR: Puerto Rico
+PS: Palestine, State of
+PT: IPhothugali
+PW: Palau
+PY: I-Paraguwayi
+QA: Qatar
+RE: IRiyunion
+RO: I-Romaniya
+RS: ISerbiya
+RU: Russian Federation
+RW: IRuwanda
+SA: Saudi Arabia
+SB: Solomon Islands
+SC: IsiSeyisheli
+SD: ISudan
+SE: ISwidi
+SG: Singapore
+SH: Saint Helena, Ascension and Tristan da Cunha
+SI: ISloveniya
+SJ: Svalbard and Jan Mayen
+SK: ISlovaki
+SL: ISiera Liyoni
+SM: USanti Marino
+SN: ISenegal
+SO: ISomalia
+SR: Suriname
+SS: ISudan yaseNingizimu
+ST: ISawu Tome noPhrinitshipeyi
+SV: El Salvador
+SX: Sint Maarten (Dutch part)
+SY: Syrian Arab Republic
+SZ: Eswatini
+TC: Turks and Caicos Islands
+TD: ITshedi
+TF: French Southern Territories
+TG: ITogo
+TH: I-Thayilandi
+TJ: Tajikistan
+TK: Tokelau
+TL: Timor-Leste
+TM: Turkmenistan
+TN: ITunisia
+TO: Tonga
+TR: ITheki
+TT: I-Trinidad ne Tobago
+TV: Tuvalu
+TW: I-Tayiwani
+TZ: ITanzania
+UA: I-Yukreyini
+UG: IYuganda
+UM: United States Minor Outlying Islands
+US: United States
+UY: I-Uruguwayi
+UZ: Uzbekistan
+VA: Holy See (Vatican City State)
+VC: Saint Vincent and the Grenadines
+VE: I-Venezuwela
+VG: Virgin Islands, British
+VI: Virgin Islands, U.S.
+VN: IViyetnami
+VU: Vanuatu
+WF: Wallis and Futuna
+WS: Samoa
+YE: IYemen
+YT: IMayotte
+ZA: IRiphabliki yaseNingizimu Afrika
+ZM: IZambiya
+ZW: IZimbabwe

data/lib/countries/data.rb

@@ -5,8 +5,10 @@ module ISO3166
   class Data
     @cache_dir = [File.dirname(__FILE__), 'cache']
     @cache = {}
+    @loaded_country_codes = []
     @registered_data = {}
     @mutex = Mutex.new
+    @subdivisions = {}
 
     def initialize(alpha2)
       @alpha2 = alpha2.to_s.upcase
@@ -43,13 +45,14 @@ module ISO3166
       # Resets the loaded data and cache
       def reset
         @cache = {}
+        @subdivisions = {}
         @registered_data = {}
         ISO3166.configuration.loaded_locales = []
       end
 
       def codes
         load_data!
-        loaded_codes
+        cached_codes
       end
 
       def update_cache
@@ -58,6 +61,35 @@ module ISO3166
         @cache
       end
 
+      def loaded_codes
+        load_data!
+        @loaded_country_codes
+      end
+
+      def datafile_path(file_array)
+        File.join([@cache_dir] + file_array)
+      end
+
+      def subdivision_data(alpha2)
+        file = subdivision_file_path(alpha2)
+        data = File.exist?(file) ? YAML.load_file(file) : {}
+        locales = ISO3166.configuration.locales.map(&:to_s)
+        data.each_value{ |v| v['translations'] = v['translations'].slice(*locales)}
+
+        return data
+      end
+
+      def subdivisions(alpha2)
+        @subdivisions ||= {}
+        @subdivisions[alpha2] ||= create_subdivisions(ISO3166::Data.subdivision_data(alpha2))
+      end
+
+      def create_subdivisions(subdivision_data)
+        subdivision_data.each_with_object({}) do |(k, v), hash|
+          hash[k] = Subdivision.new(v)
+        end
+      end
+
       private
 
       def load_data!
@@ -65,7 +97,7 @@ module ISO3166
 
         synchronized do
           @cache = load_cache %w[countries.json]
-          @_country_codes = @cache.keys
+          @loaded_country_codes = @cache.keys
           @cache = @cache.merge(@registered_data)
           @cache
         end
@@ -102,13 +134,13 @@ module ISO3166
         end
       end
 
-      def loaded_codes
+      def cached_codes
         @cache.keys
       end
 
       # Codes that we have translations for in dataset
       def internal_codes
-        @_country_codes - @registered_data.keys
+        @loaded_country_codes - @registered_data.keys
       end
 
       def cache_flush_required?
@@ -158,10 +190,6 @@ module ISO3166
         File.exist?(file_path) ? JSON.parse(File.binread(file_path)) : {}
       end
 
-      def datafile_path(file_array)
-        File.join([@cache_dir] + file_array)
-      end
-
       def deep_stringify_keys(data)
         data.transform_keys!(&:to_s)
         data.transform_values! do |v|
@@ -170,6 +198,10 @@ module ISO3166
 
         data
       end
+
+      def subdivision_file_path(alpha2)
+        File.join(File.dirname(__FILE__), 'data', 'subdivisions', "#{alpha2}.yaml")
+      end
     end
   end
 end

data/lib/countries/iso3166.rb

@@ -2,7 +2,6 @@
 
 require 'yaml'
 require 'json'
-require 'i18n_data'
 
 require 'countries/kwarg_struct'
 require 'countries/configuration'

data/lib/countries/sources/cldr/subdivision_updater.rb

@@ -19,7 +19,7 @@ module Sources
         language_data = Nokogiri::XML(File.read(file_path))
         language_code = File.basename(file_path, '.*')
         subdivisions = language_data.css('subdivision')
-        next if subdivisions.empty?
+        return if subdivisions.empty?
 
         last_country_code_seen = nil
 

data/lib/countries/subdivision.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
 module ISO3166
-  Subdivision = KwargStruct.new(
-    :name,
-    :code,
-    :unofficial_names,
-    :geo,
-    :translations,
-    :comments
-  )
+  class Subdivision
+    attr_accessor :name,
+                  :code,
+                  :unofficial_names,
+                  :geo,
+                  :translations,
+                  :comments,
+                  :type
+
+    def initialize(attrs)
+      attrs.each_pair do |k, v|
+        send "#{k}=", v
+      end
+    end
+
+    def [](attr_name)
+      send attr_name
+    end
+  end
 end

data/lib/countries/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Countries
-  VERSION = '5.0.1'.freeze
+  VERSION = '5.1.2'.freeze
 end

data/spec/country_spec.rb

@@ -221,7 +221,7 @@ describe ISO3166::Country do
   end
 
   describe 'subdivisions' do
-    let(:virginia) { country.states['VA'] }
+    let(:virginia) { country.subdivisions['VA'] }
     it 'should return an empty hash for a country with no ISO3166-2' do
       expect(ISO3166::Country.search('VA').subdivisions.size).to eq(0)
     end
@@ -230,8 +230,8 @@ describe ISO3166::Country do
       expect(country.subdivisions.size).to eq(57)
     end
 
-    it 'should be available through states' do
-      expect(country.states.size).to eq(57)
+    it '#states should be deprecated' do
+      expect {country.states}.to output.to_stderr
     end
 
     it 'should be a subdivision object' do
@@ -251,6 +251,60 @@ describe ISO3166::Country do
     end
   end
 
+  describe 'subdivision_types' do
+    it "should return an array of subdivision types" do
+      expect(country.subdivision_types).to contain_exactly('district', 'state', 'outlying_area')
+    end
+
+    it "should return an array of subdivision types even if there is only a single type" do
+      expect(ISO3166::Country['LI'].subdivision_types).to contain_exactly('commune')
+    end
+
+    it "should return an empty array if country has no subdivisions" do
+      expect(ISO3166::Country['AS'].subdivisions?).to be_falsey
+      expect(ISO3166::Country['AS'].subdivision_types).to eq([])
+    end
+  end
+
+  describe 'subdivisions_of_types' do
+    it "given a single type, should return an array of subdivisions that match the type" do
+      us_states = country.subdivisions_of_types(%w[state])
+      expect(us_states.size).to eq(50)
+      dc = country.subdivisions_of_types(%w[district])
+      expect(dc.size).to eq(1)
+    end
+
+    it "given multiple types, should return an array of subdivisions matching the types" do
+      us_states_plus_dc = country.subdivisions_of_types(%w[state district])
+      expect(us_states_plus_dc.size).to eq(51)
+    end
+
+    it "given multiple types where at least one does not exist for that country, should work without issue" do
+      us_states_plus_dc = country.subdivisions_of_types(%w[state district governorate])
+      expect(us_states_plus_dc.size).to eq(51)
+    end
+
+    it "given only types that do not exist for that country, should return an empty collection" do
+      should_be_empty = ISO3166::Country['PT'].subdivisions_of_types(%w[state county])
+      expect(should_be_empty).to be_empty
+    end
+  end
+
+  describe 'humanized_subdivision_types' do
+    it "should return an array of humanized subdivision types" do
+      expect(country.humanized_subdivision_types).to contain_exactly('District', 'State', 'Outlying area')
+    end
+
+    it "should return an array of subdivision types even if there is only a single type" do
+      expect(ISO3166::Country['LI'].humanized_subdivision_types).to contain_exactly('Commune')
+    end
+
+    it "should return an empty array if country has no subdivisions" do
+      expect(ISO3166::Country['AS'].subdivisions?).to be_falsey
+      expect(ISO3166::Country['AS'].humanized_subdivision_types).to eq([])
+    end
+  end
+
   describe 'subdivision_names_with_codes' do
     it 'should return an alphabetized list of all subdivisions names with codes' do
       subdivisions = ISO3166::Country.search('EG').subdivision_names_with_codes
@@ -330,7 +384,7 @@ describe ISO3166::Country do
       countries = ISO3166::Country.all_translated('fr')
       expect(countries).to be_an(Array)
       expect(countries.first).to be_a(String)
-      expect(countries.first).to eq('Aruba')
+      expect(countries.first).to eq('Andorre')
       # countries missing the desired locale will not be added to the list
       # so all 250 countries may not be returned, 'fr' returns 249, for example
       expect(countries.size).to eq(NUM_OF_COUNTRIES)
@@ -340,7 +394,7 @@ describe ISO3166::Country do
       countries = ISO3166::Country.all_translated
       expect(countries).to be_an(Array)
       expect(countries.first).to be_a(String)
-      expect(countries.first).to eq('Aruba')
+      expect(countries.first).to eq('Andorra')
       expect(countries.size).to eq(NUM_OF_COUNTRIES)
     end
 
@@ -448,8 +502,8 @@ describe ISO3166::Country do
     it 'should return an hash of all country names translated to the selected locale' do
       countries = ISO3166::Country.translations('fr')
       expect(countries).to be_an(Hash)
-      expect(countries.first[0]).to eq('AW')
-      expect(countries.first).to eq(%w[AW Aruba])
+      expect(countries.first[0]).to eq('AD')
+      expect(countries.first).to eq(%w[AD Andorre])
       # countries missing the desired locale will not be added to the list
       # so all 250 countries may not be returned, 'fr' returns 249, for example
       expect(countries.size).to eq(NUM_OF_COUNTRIES)
@@ -458,8 +512,8 @@ describe ISO3166::Country do
     it 'should return an hash of all country names in English if no locale is passed' do
       countries = ISO3166::Country.translations
       expect(countries).to be_an(Hash)
-      expect(countries.first[0]).to eq('AW')
-      expect(countries.first).to eq(%w[AW Aruba])
+      expect(countries.first[0]).to eq('AD')
+      expect(countries.first).to eq(%w[AD Andorra])
       expect(countries.size).to eq(NUM_OF_COUNTRIES)
     end
   end
@@ -896,16 +950,6 @@ describe ISO3166::Country do
     end
   end
 
-  describe 'names in Data' do
-    it 'should be unique (to allow .find_by_any_name work properly)' do
-      names = ISO3166::Data.cache.map do |_k, v|
-        [v['iso_short_name'], v['unofficial_names']].flatten.uniq
-      end.flatten
-
-      expect(names.size).to eq(names.uniq.size)
-    end
-  end
-
   describe 'Norway' do
     let(:norway) { ISO3166::Country.search('NO') }
 

data/spec/data_spec.rb

@@ -26,6 +26,17 @@ describe ISO3166::Data do
     expect(data['translated_names'].size).to eq 1
   end
 
+  it 'only loads subdivision translations for the configured locales' do
+    ISO3166.configuration.locales = %i[en]
+    ISO3166::Data.reset
+    subdivisions = ISO3166::Data.subdivisions('US')
+    expect(subdivisions.values.first['translations'].keys).to eq(%w[en])
+    ISO3166.configuration.locales = %i[es de en]
+    ISO3166::Data.reset
+    subdivisions = ISO3166::Data.subdivisions('US')
+    expect(subdivisions.values.first['translations'].keys).to eq(%w[es de en])
+  end
+
   describe '#codes' do
     it 'returns an array' do
       data = ISO3166::Data.codes
@@ -122,8 +133,12 @@ describe ISO3166::Data do
       expect(subject.iso_short_name).to eq 'NEW Taiwan'
       expect(subject.translations).to eq('en' => 'NEW Taiwan',
                                          'de' => 'NEW Taiwan')
-      expect(subject.subdivisions).to eq('CHA' => ISO3166::Subdivision.new({ name: 'New Changhua', code: 'CHA' }),
-                                         'CYI' => ISO3166::Subdivision.new({ name: 'New Municipality', code: 'CYI' }))
+      expect(subject.subdivisions.keys).to eq(%w[CHA CYI])
+      expect(subject.subdivisions.values.map(&:name)).to eq(['New Changhua', 'New Municipality'])
+    end
+
+    after do
+      ISO3166.reset
     end
   end
 
@@ -149,8 +164,8 @@ describe ISO3166::Data do
       data = ISO3166::Data.new('LOL').call
       expect(data['iso_short_name']).to eq 'Happy Country'
       expect(subject.iso_short_name).to eq 'Happy Country'
-      expect(subject.subdivisions).to eq('LOL1' => ISO3166::Subdivision.new({name: 'Happy sub1', code: 'LOL1'}),
-                                         'LOL2' => ISO3166::Subdivision.new({name: 'Happy sub2', code: 'LOL2'}))
+      expect(subject.subdivisions.keys).to eq(%w[LOL1 LOL2])
+      expect(subject.subdivisions.values.map(&:name)).to eq(['Happy sub1', 'Happy sub2'])
     end
 
     it 'detect a stale cache' do
@@ -181,7 +196,61 @@ describe ISO3166::Data do
     end
 
     after do
-      ISO3166::Data.unregister('lol')
+      ISO3166.reset
+    end
+  end
+
+  describe 'data checks' do
+    context 'subdivision YAML files' do
+      it 'has a non-blank code for all subdivisions' do
+        Dir['lib/countries/data/subdivisions/*.yaml'].each do |file|
+          data = YAML.load_file(file)
+          expect(data.values.none?{|s| s['code'].nil? }).to be_truthy, "empty subdivision code in #{file}"
+        end
+      end
+
+      it 'has a non-blank, lowercase and snake_case type for all subdivisions' do
+        Dir['lib/countries/data/subdivisions/*.yaml'].each do |file|
+          data = YAML.load_file(file)
+          no_type = data.select{|k,v| v['type'].nil? }
+          expect(no_type).to be_empty, "empty subdivision type in #{file} - #{no_type.keys}"
+          uppercase = data.select{|k,v| v['type'] =~ /[A-Z]/ }
+          expect(uppercase).to be_empty, "uppercase characters in subdivision type in #{file} - #{uppercase.keys}"
+          spaces = data.select{|k,v| v['type'] =~ /\s/ }
+          expect(spaces).to be_empty, "whitespace characters in subdivision type in #{file} - #{spaces.keys}"
+        end
+      end
+
+      it 'has a non-blank name for all subdivisions' do
+        Dir['lib/countries/data/subdivisions/*.yaml'].each do |file|
+          data = YAML.load_file(file)
+          expect(data.values.none?{|s| s['name'].nil? }).to be_truthy, "empty subdivision name in #{file}"
+        end
+      end
+    end
+
+    context 'cached country subdivision data' do
+      it 'has a non-blank code for all subdivisions' do
+        ISO3166::Country.all.each do |country|
+          expect(country.subdivisions.values.none?{|s| s['code'].nil? }).to be_truthy, "empty subdivision code in #{country}"
+        end
+      end
+
+      it 'has a non-blank name for all subdivisions' do
+        ISO3166::Country.all.each do |country|
+          expect(country.subdivisions.values.none?{|s| s['name'].nil? }).to be_truthy, "empty subdivision name in #{country}"
+        end
+      end
+    end
+
+    context 'names in Data' do
+      it 'should be unique (to allow .find_by_any_name work properly)' do
+        names = ISO3166::Data.cache.map do |_k, v|
+          [v['iso_short_name'], v['unofficial_names']].flatten.uniq
+        end.flatten
+
+        expect(names.size).to eq(names.uniq.size)
+      end
     end
   end
 end