countries 3.0.0 → 5.2.0

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

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module ISO3166
-  ##
   # Handles building the in memory store of countries data
   class Data
-    @@cache_dir = [File.dirname(__FILE__), 'cache']
-    @@cache = {}
-    @@registered_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
@@ -15,56 +19,88 @@ module ISO3166
     end
 
     class << self
-      def cache_dir
-        @@cache_dir
-      end
-
-      def cache_dir=(value)
-        @@cache_dir = value
-      end
 
+      # Registers a new Country with custom data.
+      # If you are overriding an existing country, this does not perform a deep merge so you will need to __bring in all data you wish to be available__.
+      # Overriding an existing country will also remove it from the internal management of translations.
       def register(data)
         alpha2 = data[:alpha2].upcase
-        @@registered_data[alpha2] = \
-          data.each_with_object({}) { |(k, v), a| a[k.to_s] = v }
-        @@registered_data[alpha2]['translations'] = \
-          Translations.new.merge(data[:translations] || {})
-        @@cache = cache.merge(@@registered_data)
+        @registered_data[alpha2] = deep_stringify_keys(data)
+        @registered_data[alpha2]['translations'] = \
+          Translations.new.merge(data['translations'] || {})
+        @cache = cache.merge(@registered_data)
       end
 
+      # Removes a country from the loaded data
       def unregister(alpha2)
         alpha2 = alpha2.to_s.upcase
-        @@cache.delete(alpha2)
-        @@registered_data.delete(alpha2)
+        @cache.delete(alpha2)
+        @registered_data.delete(alpha2)
       end
 
       def cache
         update_cache
       end
 
+      # Resets the loaded data and cache
       def reset
-        @@cache = {}
-        @@registered_data = {}
+        @cache = {}
+        @subdivisions = {}
+        @registered_data = {}
         ISO3166.configuration.loaded_locales = []
       end
 
       def codes
         load_data!
-        loaded_codes
+        cached_codes
       end
 
       def update_cache
         load_data!
         sync_translations!
-        @@cache
+        @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!
-        return @@cache unless load_required?
-        @@cache = load_cache %w(countries.json)
-        @@_country_codes = @@cache.keys
-        @@cache = @@cache.merge(@@registered_data)
-        @@cache
+        return @cache unless load_required?
+
+        synchronized do
+          @cache = load_cache %w[countries.json]
+          @loaded_country_codes = @cache.keys
+          @cache = @cache.merge(@registered_data)
+          @cache
+        end
       end
 
       def sync_translations!
@@ -79,19 +115,32 @@ module ISO3166
         end
       end
 
-      private
+      def synchronized(&block)
+        if use_mutex?
+          @mutex.synchronize(&block)
+        else
+          block.call
+        end
+      end
+
+      def use_mutex?
+        # Stubbed in testing
+        true
+      end
 
       def load_required?
-        @@cache.empty?
+        synchronized do
+          @cache.empty?
+        end
       end
 
-      def loaded_codes
-        @@cache.keys
+      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?
@@ -115,21 +164,25 @@ module ISO3166
       end
 
       def load_translations(locale)
-        locale_names = load_cache(['locales', "#{locale}.json"])
-        internal_codes.each do |alpha2|
-          @@cache[alpha2]['translations'] ||= Translations.new
-          @@cache[alpha2]['translations'][locale] = locale_names[alpha2].freeze
-          @@cache[alpha2]['translated_names'] = @@cache[alpha2]['translations'].values.freeze
+        synchronized do
+          locale_names = load_cache(['locales', "#{locale}.json"])
+          internal_codes.each do |alpha2|
+            @cache[alpha2]['translations'] ||= Translations.new
+            @cache[alpha2]['translations'][locale] = locale_names[alpha2].freeze
+            @cache[alpha2]['translated_names'] = @cache[alpha2]['translations'].values.freeze
+          end
+          ISO3166.configuration.loaded_locales << locale
         end
-        ISO3166.configuration.loaded_locales << locale
       end
 
       def unload_translations(locale)
-        internal_codes.each do |alpha2|
-          @@cache[alpha2]['translations'].delete(locale)
-          @@cache[alpha2]['translated_names'] = @@cache[alpha2]['translations'].values.freeze
+        synchronized do
+          internal_codes.each do |alpha2|
+            @cache[alpha2]['translations'].delete(locale)
+            @cache[alpha2]['translated_names'] = @cache[alpha2]['translations'].values.freeze
+          end
+          ISO3166.configuration.loaded_locales.delete(locale)
         end
-        ISO3166.configuration.loaded_locales.delete(locale)
       end
 
       def load_cache(file_array)
@@ -137,8 +190,17 @@ module ISO3166
         File.exist?(file_path) ? JSON.parse(File.binread(file_path)) : {}
       end
 
-      def datafile_path(file_array)
-        File.join([@@cache_dir] + file_array)
+      def deep_stringify_keys(data)
+        data.transform_keys!(&:to_s)
+        data.transform_values! do |v|
+          v.is_a?(Hash) ? deep_stringify_keys(v) : v
+        end
+
+        data
+      end
+
+      def subdivision_file_path(alpha2)
+        File.join(File.dirname(__FILE__), 'data', 'subdivisions', "#{alpha2}.yaml")
       end
     end
   end

data/lib/countries/global.rb

@@ -1,7 +1,19 @@
+# frozen_string_literal: true
+
 require 'countries'
 
+# Some apps might not want to constantly call +ISO3166::Country+. This gem has a helper that can provide a Country class
+#
+# With global Country Helper enabled
+#
+#   c = Country['US']
+#
+# This will conflict with any existing Country constant
+#
+# To Use
+#
+#   gem 'countries', require: 'countries/global'
+#
 class Country < ISO3166::Country
-  def to_s
-    name
-  end
+
 end

data/lib/countries/iso3166.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'json'
-require 'i18n_data'
 
 require 'countries/kwarg_struct'
 require 'countries/configuration'
@@ -8,6 +9,7 @@ require 'countries/data'
 require 'countries/structure'
 require 'countries/translations'
 require 'countries/country/class_methods'
+require 'countries/country/finder_methods'
 require 'countries/country/emoji'
 require 'countries/country'
 require 'countries/subdivision'

data/lib/countries/kwarg_struct.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ISO3166
   class KwargStruct < Struct
     # Override the initialize to handle hashes of named parameters

data/lib/countries/mongoid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ISO3166
   class Country
     def mongoize
@@ -5,6 +7,7 @@ module ISO3166
     end
 
     class << self
+      # Convert an +ISO3166::Country+ to the data that is stored by Mongoid.
       def mongoize(country)
         if country.is_a?(self) && !country.data.nil?
           country.alpha2
@@ -13,10 +16,12 @@ module ISO3166
         end
       end
 
+      # Get the object as it was stored with Mongoid, and instantiate an +ISO3166::Country+.
       def demongoize(alpha2)
         new(alpha2)
       end
 
+      # Convert an +ISO3166::Country+ to the data that is stored by Mongoid.
       def evolve(country)
         mongoize(country)
       end

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

@@ -1,9 +1,16 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'net/http'
 require 'nokogiri'
 require 'fileutils'
+require 'json'
+
+# Support code to allow updating subdivision data from the Unicode CLDR repository
 module Sources
+  # Support code to allow updating subdivision data from the Unicode CLDR repository
   module CLDR
+    # Downloads data from the Unicode CLDR repository
     module Downloader
       module_function
 
@@ -14,21 +21,16 @@ module Sources
       def download_folder(type)
         folder = File.join(ISO3166_ROOT_PATH, 'tmp', 'cldr', 'trunk', 'common', type)
         FileUtils.mkdir_p(folder)
-        doc = Nokogiri::HTML get(type + '/')
-        doc.css('a[href]').map { |e| e.attributes['href'].value }.each do |href|
-          next if href == '../'
-          File.write(File.join(folder, href), get([type, href].join('/')))
-        end
-      end
+        url = URI.parse("https://api.github.com/repos/unicode-org/cldr/contents/common/#{type}")
+        path_listing = JSON.parse(Net::HTTP.get_response(url).body)
+        path_listing.each do |path|
+          next unless path['name'] =~ /\.xml$/
 
-      def get(path)
-        url = URI("http://www.unicode.org/repos/cldr/trunk/common/#{path}")
-
-        http = Net::HTTP.new(url.host, url.port)
-
-        request = Net::HTTP::Get.new(url)
-        response = http.request(request)
-        response.read_body
+          File.open(File.join(folder, path['name']), 'w') do |f|
+            raw_url = URI.parse(path['download_url'])
+            f.write(Net::HTTP.get_response(raw_url).body)
+          end
+        end
       end
     end
   end

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

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module Sources
   module CLDR
+    # Auxiliary Subdivision class to support loading Unicode CLDR data to update local files
     class Subdivision
       attr_reader :xml, :language_code
+
       def initialize(language_code:, xml:)
         @language_code = language_code
         @xml = xml

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/core_ext/hash/deep_merge'
 require 'nokogiri'
@@ -5,28 +7,33 @@ require 'pry'
 
 module Sources
   module CLDR
+    # Updates local subdivision files with data from the Unicode CLDR repository
     class SubdivisionUpdater
       def call
         d = Dir['./tmp/cldr/trunk/common/subdivisions/*.xml']
-        loader = Sources::Local::CachedLoader.new(Sources::Local::Subdivision)
-        d.each do |file_path|
-          language_data = Nokogiri::XML(File.read(file_path))
-          language_code = File.basename(file_path, '.*')
-          subdivisions = language_data.css('subdivision')
-          next if subdivisions.empty?
-          last_country_code_seen = nil
+        @loader = Sources::Local::CachedLoader.new(Sources::Local::Subdivision)
+        d.each { |file_path| update_locale(file_path) }
+      end
+
+      def update_locale(file_path)
+        language_data = Nokogiri::XML(File.read(file_path))
+        language_code = File.basename(file_path, '.*')
+        subdivisions = language_data.css('subdivision')
+        return if subdivisions.empty?
+
+        last_country_code_seen = nil
 
-          subdivisions.each_with_index do |subdivision, index|
-            subdivision = Sources::CLDR::Subdivision.new(language_code: language_code, xml: subdivision)
-            data = loader.load(subdivision.country_code)
-            data[subdivision.code] ||= {}
-            data[subdivision.code] = data[subdivision.code].deep_merge(subdivision.to_h)
-            if (last_country_code_seen && last_country_code_seen != subdivision.country_code) || index == subdivisions.size - 1
-              puts "Updated #{subdivision.country_code} with language_code #{language_code}"
-              loader.save(subdivision.country_code, data)
-            end
-            last_country_code_seen = subdivision.country_code
+        subdivisions.each_with_index do |subdivision, index|
+          subdivision = Sources::CLDR::Subdivision.new(language_code: language_code, xml: subdivision)
+          data = @loader.load(subdivision.country_code)
+          data[subdivision.code] ||= {}
+          data[subdivision.code] = data[subdivision.code].deep_merge(subdivision.to_h)
+          if (last_country_code_seen && last_country_code_seen != subdivision.country_code) ||
+             index == subdivisions.size - 1
+            puts "Updated #{subdivision.country_code} with language_code #{language_code}"
+            @loader.save(subdivision.country_code, data)
           end
+          last_country_code_seen = subdivision.country_code
         end
       end
     end

data/lib/countries/sources/local/cached_loader.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 module Sources
+  # Support code to allow updating subdivision data from the Unicode CLDR repository
   module Local
+    # Loader for locally-cached data, to allow merging Unicode CLDR data with existing local data
     class CachedLoader
       attr_reader :klass
+
       def initialize(klass)
         @klass = klass
         @loaded_countries = {}