countries 4.2.1 → 5.0.0

data/lib/countries/data/subdivisions/YE.yaml

@@ -1140,7 +1140,7 @@ TA:
     'no': Ta’izz
   comments:
 SA:
-  name:
+  name: صنعاء
   code:
   unofficial_names:
   geo:
@@ -1233,7 +1233,7 @@ SA:
     yo_BJ: Sana’a
   comments:
 RA:
-  name:
+  name: محافظة ريمة
   code:
   unofficial_names:
   geo:
@@ -1293,7 +1293,7 @@ RA:
     'no': Raymah
   comments:
 SU:
-  name:
+  name: محافظة أرخبيل سقطرى
   code:
   unofficial_names:
   geo:

data/lib/countries/data/subdivisions/ZA.yaml

@@ -714,7 +714,7 @@ WC:
     yo_BJ: Western Cape
   comments:
 GP:
-  name:
+  name: Gauteng
   code:
   unofficial_names:
   geo:
@@ -722,7 +722,7 @@ GP:
     en: Gauteng
   comments:
 KZN:
-  name:
+  name: KwaZulu-Natal
   code:
   unofficial_names:
   geo:

data/lib/countries/data/subdivisions/ZM.yaml

@@ -532,7 +532,7 @@
     'no': Lusaka
   comments:
 '10':
-  name:
+  name: Muchinga
   code:
   unofficial_names:
   geo:

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 = {}
-    @@mutex = Mutex.new
+    @cache_dir = [File.dirname(__FILE__), 'cache']
+    @cache = {}
+    @registered_data = {}
+    @mutex = Mutex.new
 
     def initialize(alpha2)
       @alpha2 = alpha2.to_s.upcase
@@ -15,30 +17,23 @@ 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] = deep_stringify_keys(data)
-        @@registered_data[alpha2]['translations'] = \
+        @registered_data[alpha2] = deep_stringify_keys(data)
+        @registered_data[alpha2]['translations'] = \
           Translations.new.merge(data['translations'] || {})
-        @@cache = cache.merge(@@registered_data)
+        @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
@@ -47,8 +42,8 @@ module ISO3166
 
       # Resets the loaded data and cache
       def reset
-        @@cache = {}
-        @@registered_data = {}
+        @cache = {}
+        @registered_data = {}
         ISO3166.configuration.loaded_locales = []
       end
 
@@ -60,16 +55,19 @@ module ISO3166
       def update_cache
         load_data!
         sync_translations!
-        @@cache
+        @cache
       end
 
+      private
+
       def load_data!
-        return @@cache unless load_required?
+        return @cache unless load_required?
+
         synchronized do
-          @@cache = load_cache %w(countries.json)
-          @@_country_codes = @@cache.keys
-          @@cache = @@cache.merge(@@registered_data)
-          @@cache
+          @cache = load_cache %w[countries.json]
+          @_country_codes = @cache.keys
+          @cache = @cache.merge(@registered_data)
+          @cache
         end
       end
 
@@ -85,11 +83,9 @@ module ISO3166
         end
       end
 
-      private
-
       def synchronized(&block)
         if use_mutex?
-          @@mutex.synchronize(&block)
+          @mutex.synchronize(&block)
         else
           block.call
         end
@@ -102,17 +98,17 @@ module ISO3166
 
       def load_required?
         synchronized do
-          @@cache.empty?
+          @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?
@@ -139,9 +135,9 @@ module ISO3166
         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
+            @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
@@ -150,8 +146,8 @@ module ISO3166
       def unload_translations(locale)
         synchronized do
           internal_codes.each do |alpha2|
-            @@cache[alpha2]['translations'].delete(locale)
-            @@cache[alpha2]['translated_names'] = @@cache[alpha2]['translations'].values.freeze
+            @cache[alpha2]['translations'].delete(locale)
+            @cache[alpha2]['translated_names'] = @cache[alpha2]['translations'].values.freeze
           end
           ISO3166.configuration.loaded_locales.delete(locale)
         end
@@ -163,7 +159,7 @@ 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)
@@ -171,7 +167,8 @@ module ISO3166
         data.transform_values! do |v|
           v.is_a?(Hash) ? deep_stringify_keys(v) : v
         end
-        return data
+
+        data
       end
     end
   end

data/lib/countries/global.rb

@@ -1,3 +1,5 @@
+# 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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'net/http'
 require 'nokogiri'
@@ -19,19 +21,17 @@ module Sources
       def download_folder(type)
         folder = File.join(ISO3166_ROOT_PATH, 'tmp', 'cldr', 'trunk', 'common', type)
         FileUtils.mkdir_p(folder)
-        url = URI.parse("https://api.github.com/repos/unicode-org/cldr/contents/common/" + type)
+        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|
-          if path['name'] =~ /\.xml$/
-            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
+          next unless path['name'] =~ /\.xml$/
+
+          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
 end
-

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

@@ -1,8 +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'
@@ -9,25 +11,29 @@ module Sources
     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,9 +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,8 +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
@@ -16,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,

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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'geocoder'
 require 'retryable'
 
@@ -16,7 +18,7 @@ def geocode(query, params)
   Retryable.retryable(tries: 3, sleep: ->(n) { 2**n }) do
     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
@@ -26,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
@@ -44,7 +46,10 @@ namespace :geocode do
       data = load_country_yaml(country.alpha2)
 
       next unless (result = geocode(country.iso_short_name, {region: country.alpha2}))
-      puts "WARNING:: Geocoder returned something that was not a country for #{country.alpha2}" 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
@@ -55,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']
@@ -73,10 +79,10 @@ 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|
+      state_data.reject { |_, data| data['geo'] }.each do |code, _|
         location = "#{c.alpha2}-#{code}"
 
-        next unless (result = geocode(location, {region: c.alpha2}))
+        next unless (result = geocode(location, { region: c.alpha2 }))
 
         geometry = result.geometry
         if geometry['location']
@@ -84,14 +90,17 @@ namespace :geocode do
           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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :postal_codes do
   desc 'Retrieve and update postal codes and their format'
   task :update do
@@ -20,13 +22,13 @@ namespace :postal_codes do
       json = JSON.parse(response) rescue {}
       puts ' - Returned empty data. Skipping ' and next if json.empty?
 
-      postal_code = ['postal_code', !!json['zip']]
+      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
+        postal_code_index = (data.find_index { |d| d[0] == 'nationality' } + 1) || data.size
         data.insert(postal_code_index, postal_code)
       end
 
@@ -42,7 +44,7 @@ namespace :postal_codes do
 
       yaml[country_code] = data.to_h
 
-      File.open(country_file, 'w') { |file| file.write(yaml.to_yaml) }
+      File.write(country_file, yaml.to_yaml)
     end
   end
 end

data/lib/countries/timezones.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 module ISO3166
   # 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module ISO3166
   # Extend the hash class to allow locale lookup fall back behavior
   #

data/lib/countries/version.rb

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

data/lib/countries.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sixarm_ruby_unaccent'
 
 require 'countries/version'

data/spec/00_global_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'global Country class', order: :defined do
   context "when loaded via 'iso3166' existence" do
     subject { defined?(Country) }

data/spec/configuration_spec.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'i18n'
 
@@ -16,14 +17,14 @@ describe 'ISO3166.configuration' do
   end
 
   it 'locales are assumed from I18n.available_locales' do
-    I18n.available_locales = [:de, :en]
+    I18n.available_locales = %i[de en]
     ISO3166.reset
     expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
     expect(ISO3166::Country.new('DE').translation(:es)).to eq nil
   end
 
   it 'unsupported locales do not affect supported locales' do
-    I18n.available_locales = [:de, :en, :unsupported]
+    I18n.available_locales = %i[de en unsupported]
     ISO3166.reset
     expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
     expect(ISO3166::Country.new('DE').translation(:es)).to eq nil
@@ -36,7 +37,7 @@ describe 'ISO3166.configuration' do
   end
 
   it 'locales can be changed' do
-    ISO3166.configuration.locales = [:es, :de, :en]
+    ISO3166.configuration.locales = %i[es de en]
     expect(ISO3166::Country.new('DE').translation(:es)).to eq 'Alemania'
     expect(ISO3166::Country.new('DE').translation(:en)).to eq 'Germany'
     expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
@@ -44,7 +45,12 @@ describe 'ISO3166.configuration' do
 
   it 'locales can be changed with a block' do
     ISO3166.configure do |config|
-      config.locales = [:af, :am, :ar, :as, :az, :be, :bg, :bn, :br, :bs, :ca, :cs, :cy, :da, :de, :dz, :el, :en, :eo, :es, :et, :eu, :fa, :fi, :fo, :fr, :ga, :gl, :gu, :he, :hi, :hr, :hu, :hy, :ia, :id, :is, :it, :ja, :ka, :kk, :km, :kn, :ko, :ku, :lt, :lv, :mi, :mk, :ml, :mn, :mr, :ms, :mt, :nb, :ne, :nl, :nn, :oc, :or, :pa, :pl, :ps, :pt, :ro, :ru, :rw, :si, :sk, :sl, :so, :sq, :sr, :sv, :sw, :ta, :te, :th, :ti, :tk, :tl, :tr, :tt, :ug, :uk, :ve, :vi, :wa, :wo, :xh, :zh, :zu]
+      config.locales = %i[af am ar as az be bg bn br bs ca cs cy da de dz el en
+                          eo es et eu fa fi fo fr ga gl gu he hi hr hu hy ia id
+                          is it ja ka kk km kn ko ku lt lv mi mk ml mn mr ms mt
+                          nb ne nl nn oc or pa pl ps pt ro ru rw si sk sl so sq
+                          sr sv sw ta te th ti tk tl tr tt ug uk ve vi wa wo xh
+                          zh zu]
     end
 
     expect(ISO3166::Country.new('DE').translations.size).to eq 92