countries 4.1.3 → 4.2.1

data/lib/countries/data/subdivisions/SG.yaml

@@ -11,7 +11,17 @@ SG-01:
     max_latitude: 1.3948174
     max_longitude: 103.86428
   translations:
+    de: Central Singapore District
     en: Central Singapore
+    es: Consejo Central (Singapur)
+    ja: シンガポール中央地区
+    ko: 중앙싱가포르 지구 사회 발전 이사회
+    ur: مرکزی سنگاپور کمیونٹی ڈیولپمنٹ کونسل
+    ceb: Central Singapore Community Development Council
+    zh: 中区社区发展理事会
+    ccp: "\U00011125\U0001112C\U0001111A\U00011134\U00011111\U00011133\U00011122\U00011123\U00011134
+      \U00011125\U00011128\U00011101\U00011109\U0001111B\U0001112A\U00011122\U00011134"
+    fr: Singapour central
   comments:
 SG-02:
   name: North East
@@ -26,6 +36,17 @@ SG-02:
     max_longitude: 104.0884808
   translations:
     en: North East
+    es: Consejo del Noreste (Singapur)
+    it: Distretto Nordorientale
+    ja: 北東地区 (シンガポール)
+    ko: 북동부 지구 사회 발전 이사회
+    nl: North East Community Development Council
+    ceb: North East Community Development Region
+    ur: شمال مشرقی کمیونٹی ڈیولپمنٹ کونسل
+    zh: 东北社区发展理事会
+    ccp: "\U00011105\U0001112A\U00011116\U00011133\U00011126\U00011127\U00011122\U00011134
+      \U0001111B\U0001112A\U00011107\U00011134"
+    fr: District du Nord-Est
   comments:
 SG-03:
   name: North West
@@ -40,6 +61,15 @@ SG-03:
     max_longitude:
   translations:
     en: North West
+    es: Consejo del Noroeste (Singapur)
+    ja: 北西地区 (シンガポール)
+    ko: 북서부 지구 사회 발전 이사회
+    ceb: North West Community Development Council
+    ur: شمال مغربی کمیونٹی ڈیولپمنٹ کونسل
+    zh: 西北社区发展理事会
+    ccp: "\U00011105\U0001112A\U00011116\U00011133\U00011126\U00011127\U00011122\U00011134
+      \U0001111B\U00011127\U0001110F\U00011128\U0001111F\U00011134"
+    fr: District du Nord-Ouest
   comments:
 SG-04:
   name: South East
@@ -52,58 +82,6 @@ SG-04:
     min_longitude: 103.6055448
     max_latitude: 1.4707592
     max_longitude: 104.0884808
-  translations:
-    en: South East
-  comments:
-SG-05:
-  name: South West
-  code:
-  unofficial_names: South West
-  geo:
-    latitude: 1.352083
-    longitude: 103.819836
-    min_latitude: 1.1587023
-    min_longitude: 103.6055448
-    max_latitude: 1.4707592
-    max_longitude: 104.0884808
-  translations:
-    en: South West
-  comments:
-'01':
-  name:
-  code:
-  unofficial_names:
-  geo:
-    latitude:
-    longitude:
-    min_latitude:
-    min_longitude:
-    max_latitude:
-    max_longitude:
-  translations:
-    de: Central Singapore District
-    en: Central Singapore
-    es: Consejo Central (Singapur)
-    ja: シンガポール中央地区
-    ko: 중앙싱가포르 지구 사회 발전 이사회
-    ur: مرکزی سنگاپور کمیونٹی ڈیولپمنٹ کونسل
-    ceb: Central Singapore Community Development Council
-    zh: 中区社区发展理事会
-    ccp: "\U00011125\U0001112C\U0001111A\U00011134\U00011111\U00011133\U00011122\U00011123\U00011134
-      \U00011125\U00011128\U00011101\U00011109\U0001111B\U0001112A\U00011122\U00011134"
-    fr: Singapour central
-  comments:
-'04':
-  name:
-  code:
-  unofficial_names:
-  geo:
-    latitude:
-    longitude:
-    min_latitude:
-    min_longitude:
-    max_latitude:
-    max_longitude:
   translations:
     de: Südost
     en: South East
@@ -116,17 +94,17 @@ SG-05:
     ccp: "\U00011118\U00011127\U0001110A\U00011128\U0001111A\U00011134 \U0001111B\U0001112A\U00011107\U00011134"
     fr: District du Sud-Est
   comments:
-'05':
-  name:
+SG-05:
+  name: South West
   code:
-  unofficial_names:
+  unofficial_names: South West
   geo:
-    latitude:
-    longitude:
-    min_latitude:
-    min_longitude:
-    max_latitude:
-    max_longitude:
+    latitude: 1.352083
+    longitude: 103.819836
+    min_latitude: 1.1587023
+    min_longitude: 103.6055448
+    max_latitude: 1.4707592
+    max_longitude: 104.0884808
   translations:
     de: South West Singapore District
     en: South West
@@ -139,51 +117,3 @@ SG-05:
     ccp: "\U00011118\U00011127\U0001110A\U00011128\U0001111A\U00011134 \U0001111B\U00011127\U0001110F\U00011128\U0001111F\U00011134"
     fr: District du Sud-Ouest
   comments:
-'02':
-  name:
-  code:
-  unofficial_names:
-  geo:
-    latitude:
-    longitude:
-    min_latitude:
-    min_longitude:
-    max_latitude:
-    max_longitude:
-  translations:
-    en: North East
-    es: Consejo del Noreste (Singapur)
-    it: Distretto Nordorientale
-    ja: 北東地区 (シンガポール)
-    ko: 북동부 지구 사회 발전 이사회
-    nl: North East Community Development Council
-    ceb: North East Community Development Region
-    ur: شمال مشرقی کمیونٹی ڈیولپمنٹ کونسل
-    zh: 东北社区发展理事会
-    ccp: "\U00011105\U0001112A\U00011116\U00011133\U00011126\U00011127\U00011122\U00011134
-      \U0001111B\U0001112A\U00011107\U00011134"
-    fr: District du Nord-Est
-  comments:
-'03':
-  name:
-  code:
-  unofficial_names:
-  geo:
-    latitude:
-    longitude:
-    min_latitude:
-    min_longitude:
-    max_latitude:
-    max_longitude:
-  translations:
-    en: North West
-    es: Consejo del Noroeste (Singapur)
-    ja: 北西地区 (シンガポール)
-    ko: 북서부 지구 사회 발전 이사회
-    ceb: North West Community Development Council
-    ur: شمال مغربی کمیونٹی ڈیولپمنٹ کونسل
-    zh: 西北社区发展理事会
-    ccp: "\U00011105\U0001112A\U00011116\U00011133\U00011126\U00011127\U00011122\U00011134
-      \U0001111B\U00011127\U0001110F\U00011128\U0001111F\U00011134"
-    fr: District du Nord-Ouest
-  comments:

data/lib/countries/data/subdivisions/US.yaml

@@ -1,32 +1,4 @@
 ---
-AA:
-  name: Armed Forces Americas
-  code:
-  unofficial_names: Armed Forces Americas
-  geo:
-    latitude: 33.8934985
-    longitude: -117.2732567
-    min_latitude: 33.8403275
-    min_longitude: -117.2985014
-    max_latitude: 33.9460679
-    max_longitude: -117.2498013
-  translations:
-    en: Armed Forces Americas
-  comments:
-AE:
-  name: Armed Forces Europe
-  code:
-  unofficial_names: Armed Forces Europe
-  geo:
-    latitude: 59.90441850000001
-    longitude: 10.7408094
-    min_latitude:
-    min_longitude:
-    max_latitude:
-    max_longitude:
-  translations:
-    en: Armed Forces Europe
-  comments:
 AK:
   name: Alaska
   code:
@@ -223,20 +195,6 @@ AL:
     ha_NE: Alabama
     'no': Alabama
   comments:
-AP:
-  name: Armed Forces Pacific
-  code:
-  unofficial_names: Armed Forces Pacific
-  geo:
-    latitude:
-    longitude:
-    min_latitude:
-    min_longitude:
-    max_latitude:
-    max_longitude:
-  translations:
-    en: Armed Forces Pacific
-  comments:
 AR:
   name: Arkansas
   code:

data/lib/countries/data/translation_corrections.yaml

@@ -10,10 +10,6 @@
 #   alpha2: localized_name
 #
 ---
-oc:
-  US: Estats Units
-  UM: Islas perifericas Menores dels Estats Units
-  MK: Macedònia del Nòrd
 ar:
   PS: "فلسطين"
   SA: "السعودية"
@@ -23,23 +19,33 @@ ar:
   SY: "سوريا"
   BQ: "بونير، سينت أوستاتيوس وسابا"
   CW: "كوراساو"
-nn:
-  PT: Portugal
-zh:
-  KH: '柬埔寨'
-zh_cn:
-  KH: '柬埔寨'
+da:
+  CZ: 'Tjekkiet'
 fa:
   IR: "ایران"
 he:
   PS: "פלסטין, מדינת"
   VI: "איי הבתולה (ארה)"
+jp:
+  ES: スペイン
 mk:
   MK: "Северна Македонија"
+nn:
+  PT: Portugal
+oc:
+  US: Estats Units
+  UM: Islas perifericas Menores dels Estats Units
+  MK: Macedònia del Nòrd
+pt:
+  CZ: 'República Checa'
 sv:
   GB: "Storbritannien"
   RU: "Ryssland"
-pt:
-  CZ: 'República Checa'
-da:
-  CZ: 'Tjekkiet'
+zh:
+  KH: '柬埔寨'
+zh_cn:
+  KH: '柬埔寨'
+nb:
+  US: USA
+nn:
+  US: USA

data/lib/countries/data.rb

@@ -1,5 +1,4 @@
 module ISO3166
-  ##
   # Handles building the in memory store of countries data
   class Data
     @@cache_dir = [File.dirname(__FILE__), 'cache']
@@ -24,6 +23,9 @@ module ISO3166
         @@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)
@@ -32,6 +34,7 @@ module ISO3166
         @@cache = cache.merge(@@registered_data)
       end
 
+      # Removes a country from the loaded data
       def unregister(alpha2)
         alpha2 = alpha2.to_s.upcase
         @@cache.delete(alpha2)
@@ -42,6 +45,7 @@ module ISO3166
         update_cache
       end
 
+      # Resets the loaded data and cache
       def reset
         @@cache = {}
         @@registered_data = {}

data/lib/countries/global.rb

@@ -1,7 +1,17 @@
 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/mongoid.rb

@@ -5,6 +5,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 +14,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

@@ -4,8 +4,11 @@ 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
 

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

@@ -1,5 +1,6 @@
 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:)

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

@@ -5,6 +5,7 @@ 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']

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

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

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

@@ -1,5 +1,6 @@
 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)

data/lib/countries/structure.rb

@@ -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,
@@ -63,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/tasks/geocoding.rake

@@ -43,7 +43,7 @@ namespace :geocode do
       # Load unmutated yaml file.
       data = load_country_yaml(country.alpha2)
 
-      next unless (result = geocode(country.name, {region: 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')
       geometry = result.geometry
 

data/lib/countries/timezones.rb

@@ -1,6 +1,8 @@
-# Extend Country class with support for timezones
 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
     def timezones
       @tz_country ||= TZInfo::Country.get(alpha2)

data/lib/countries/translations.rb

@@ -1,9 +1,8 @@
 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.to_s.sub(/-.*/, ''))

data/lib/countries/version.rb

@@ -1,3 +1,3 @@
 module Countries
-  VERSION = '4.1.3'.freeze
+  VERSION = '4.2.1'.freeze
 end