countries 3.0.1 → 5.0.1

data/lib/countries/data.rb

@@ -1,10 +1,12 @@
+# 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 = {}
+    @registered_data = {}
+    @mutex = Mutex.new
 
     def initialize(alpha2)
       @alpha2 = alpha2.to_s.upcase
@@ -15,36 +17,33 @@ 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 = {}
+        @registered_data = {}
         ISO3166.configuration.loaded_locales = []
       end
 
@@ -56,15 +55,20 @@ module ISO3166
       def update_cache
         load_data!
         sync_translations!
-        @@cache
+        @cache
       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]
+          @_country_codes = @cache.keys
+          @cache = @cache.merge(@registered_data)
+          @cache
+        end
       end
 
       def sync_translations!
@@ -79,19 +83,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
+        @cache.keys
       end
 
       # Codes that we have translations for in dataset
       def internal_codes
-        @@_country_codes - @@registered_data.keys
+        @_country_codes - @registered_data.keys
       end
 
       def cache_flush_required?
@@ -115,21 +132,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)
@@ -138,7 +159,16 @@ module ISO3166
       end
 
       def datafile_path(file_array)
-        File.join([@@cache_dir] + file_array)
+        File.join([@cache_dir] + file_array)
+      end
+
+      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
     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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'json'
 require 'i18n_data'
@@ -8,6 +10,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')
+        next 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 = {}

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

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module Sources
   module Local
+    # Auxiliary Subdivision class to support loading the local subdivision data to be updated with Unicode CLDR data
     class Subdivision
       attr_reader :code
+
       def initialize(code)
         @code = code
       end
@@ -15,8 +19,8 @@ module Sources
       end
 
       def save(data)
-        File.open(file_path, 'w') { |f| f.write data.to_yaml }
-      rescue
+        File.write(file_path, data.to_yaml)
+      rescue StandardError
         puts "failed to read #{file}: #{$ERROR_INFO}"
       end
 

data/lib/countries/sources.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './sources/local/cached_loader'
 require_relative './sources/local/subdivision'
 

data/lib/countries/structure.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-#
+
 module ISO3166
   DEFAULT_COUNTRY_HASH = {
     'address_format' => nil,
@@ -11,9 +11,7 @@ module ISO3166
     'gec' => nil,
     'geo' => {
       'latitude' => nil,
-      'latitude_dec' => nil,
       'longitude' => nil,
-      'longitude_dec' => nil,
       'max_latitude' => nil,
       'max_longitude' => nil,
       'min_latitude' => nil,
@@ -31,7 +29,8 @@ module ISO3166
     },
     'international_prefix' => nil,
     'ioc' => nil,
-    'name' => nil,
+    'iso_long_name' => nil,
+    'iso_short_name' => nil,
     'national_destination_code_lengths' => [],
     'national_number_lengths' => [],
     'national_prefix' => nil,
@@ -42,6 +41,7 @@ module ISO3166
     'languages_spoken' => [],
     'translations' => {},
     'postal_code' => nil,
+    'postal_code_format' => nil,
     'region' => nil,
     'unofficial_names' => [],
     'start_of_week' => 'monday',
@@ -62,9 +62,7 @@ module ISO3166
     'translations' => {},
     'geo' => {
       'latitude' => nil,
-      'latitude_dec' => nil,
       'longitude' => nil,
-      'longitude_dec' => nil,
       'max_latitude' => nil,
       'max_longitude' => nil,
       'min_latitude' => nil,

data/lib/countries/subdivision.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ISO3166
   Subdivision = KwargStruct.new(
     :name,

data/lib/countries/tasks/geocoding.rake

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 require 'geocoder'
 require 'retryable'
 
 Geocoder.configure(
-  timeout: 10
+  lookup: :google,
+  timeout: 10,
+  api_key: GOOGLE_API_KEY
 )
 
 # raise on geocoding errors such as query limit exceeded
@@ -10,11 +14,11 @@ Geocoder.configure(always_raise: :all)
 # Try to geocode a given query, on exceptions it retries up to 3 times then gives up.
 # @param [String] query string to geocode
 # @return [Hash] first valid result or nil
-def geocode(query)
+def geocode(query, params)
   Retryable.retryable(tries: 3, sleep: ->(n) { 2**n }) do
-    Geocoder.search(query).first
+    Geocoder.search(query, params: params).first
   end
-rescue => e
+rescue Geocoder::Error, Geocoder::LookupTimeout => e
   warn "Attempts exceeded for query #{query}, last error was #{e.message}"
   nil
 end
@@ -24,7 +28,7 @@ def load_country_yaml(alpha2)
 end
 
 def save_country_yaml(alpha2, data)
-  File.open(File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'countries', "#{alpha2}.yaml"), 'w+') { |f| f.write data.to_yaml }
+  File.write(File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'countries', "#{alpha2}.yaml"), data.to_yaml)
 end
 
 def country_codes
@@ -41,12 +45,11 @@ namespace :geocode do
       # Load unmutated yaml file.
       data = load_country_yaml(country.alpha2)
 
-      lookup = "#{country.alpha2} country"
-      # LU country lookup appears to match to Los Angeles
-      lookup = country.name if country.alpha2 == 'LU'
+      next unless (result = geocode(country.iso_short_name, {region: country.alpha2}))
 
-      next unless (result = geocode(lookup))
-      puts 'WARNING:: Geocoder returned something that was not a country' unless result.types.include?('country')
+      unless result.types.include?('country')
+        puts "WARNING:: Geocoder returned something that was not a country for #{country.alpha2}"
+      end
       geometry = result.geometry
 
       # Extract center point data
@@ -57,6 +60,7 @@ namespace :geocode do
 
       # Extract bounding box data
       next unless geometry['bounds']
+
       data[code]['geo']['bounds'] = geometry['bounds']
       data[code]['geo']['min_latitude'] = geometry['bounds']['southwest']['lat']
       data[code]['geo']['min_longitude'] = geometry['bounds']['southwest']['lng']
@@ -75,30 +79,28 @@ namespace :geocode do
     ISO3166::Country.all.select(&:subdivisions?).each do |c|
       # Iterate subdivisions
       state_data = c.subdivisions.dup
-      state_data.reject { |_, data| data['geo'] }.each do |code, data|
-        location = "#{data['name']}, #{c.name}"
+      state_data.reject { |_, data| data['geo'] }.each do |code, _|
+        location = "#{c.alpha2}-#{code}"
 
-        # Handle special geocoding cases where Google defaults to well known
-        # cities, instead of the states.
-        if c.alpha2 == 'US' && %w(NY WA OK).include?(code)
-          location = "#{data['name']} State, United States"
-        end
+        next unless (result = geocode(location, { region: c.alpha2 }))
 
-        next unless (result = geocode(location))
         geometry = result.geometry
         if geometry['location']
           state_data[code]['geo'] ||= {}
           state_data[code]['geo']['latitude'] = geometry['location']['lat']
           state_data[code]['geo']['longitude'] = geometry['location']['lng']
         end
+
         next unless geometry['bounds']
+
         state_data[code]['geo']['min_latitude'] = geometry['bounds']['southwest']['lat']
         state_data[code]['geo']['min_longitude'] = geometry['bounds']['southwest']['lng']
         state_data[code]['geo']['max_latitude'] = geometry['bounds']['northeast']['lat']
         state_data[code]['geo']['max_longitude'] = geometry['bounds']['northeast']['lng']
       end
       # Write updated YAML for current country
-      File.open(File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'subdivisions', "#{c.alpha2}.yaml"), 'w+') { |f| f.write state_data.to_yaml }
+      out = File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'subdivisions', "#{c.alpha2}.yaml")
+      File.write(out, state_data.to_yaml)
     end
   end
 end

data/lib/countries/tasks/postal_codes.rake

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+namespace :postal_codes do
+  desc 'Retrieve and update postal codes and their format'
+  task :update do
+    require 'json'
+    require 'open-uri'
+    require 'yaml'
+
+    country_files = Dir['lib/countries/data/countries/*.yaml'].sort
+
+    country_files.each do |country_file|
+      yaml = YAML.load_file(country_file)
+      country_code = File.basename(country_file, File.extname(country_file))
+      print "\rUpdating #{country_code}"
+
+      data = yaml[country_code].to_a
+      postal_code_index = data.find_index { |d| d[0] == 'postal_code' }
+      postal_code_format_index = data.find_index { |d| d[0] == 'postal_code_format' }
+
+      response = URI.open("https://chromium-i18n.appspot.com/ssl-address/data/#{country_code}").read
+      json = JSON.parse(response) rescue {}
+      puts ' - Returned empty data. Skipping ' and next if json.empty?
+
+      postal_code = ['postal_code', !json['zip'].nil?]
+      postal_code_format = ['postal_code_format', json['zip']]
+
+      if postal_code_index
+        data[postal_code_index] = postal_code
+      else
+        postal_code_index = (data.find_index { |d| d[0] == 'nationality' } + 1) || data.size
+        data.insert(postal_code_index, postal_code)
+      end
+
+      if json['zip']
+        if postal_code_format_index
+          data[postal_code_format_index] = postal_code_format
+        else
+          data.insert(postal_code_index + 1, postal_code_format)
+        end
+      elsif postal_code_format_index
+        data.delete_at(postal_code_format_index)
+      end
+
+      yaml[country_code] = data.to_h
+
+      File.write(country_file, yaml.to_yaml)
+    end
+  end
+end

data/lib/countries/timezones.rb

@@ -1,11 +1,16 @@
-# Extend Country class with support for timezones
+# frozen_string_literal: true
+
 module ISO3166
-  # Extend Country class with support for timezones
+  # Extend Country class with support for timezones. Requires the  {tzinfo}[https://github.com/tzinfo/tzinfo] gem
+  #
+  #   gem 'tzinfo'
+  #
   module TimezoneExtensions
+    # TODO: rename method to tz_country or something similar
     def timezones
-      @tz_country ||= TZInfo::Country.get(alpha2)
+      @timezones ||= TZInfo::Country.get(alpha2)
     end
   end
 end
 
-ISO3166::Country.send(:include, ISO3166::TimezoneExtensions)
+ISO3166::Country.include ISO3166::TimezoneExtensions

data/lib/countries/translations.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 module ISO3166
   # Extend the hash class to allow locale lookup fall back behavior
   #
-  # ex:
-  # if a country has translations for pt, and the user looks up `pt-br` fallback
-  # to `pt` to prevent from showing nil values
+  # E.g. if a country has translations for +pt+, and the user looks up +pt-br+ fallback
+  # to +pt+ to prevent from showing nil values
   class Translations < Hash
     def [](locale)
-      super(locale) || super(locale.sub(/-.*/, ''))
+      super(locale) || super(locale.to_s.sub(/-.*/, ''))
     end
   end
 end

data/lib/countries/version.rb

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