countries 4.1.1 → 4.2.3

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.1'.freeze
+  VERSION = '4.2.3'.freeze
 end

data/spec/country_spec.rb

@@ -43,12 +43,12 @@ describe ISO3166::Country do
     expect(country.alpha3).to eq('USA')
   end
 
-  it 'should return 3166 name' do
-    expect(country.name).to eq('United States of America')
+  it 'should return 3166 iso_short_name' do
+    expect(country.iso_short_name).to eq('United States of America')
   end
 
   it 'should return alternate names' do
-    expect(country.names).to eq(['United States', 'Murica', 'Vereinigte Staaten von Amerika', 'États-Unis', 'Estados Unidos', 'アメリカ合衆国', 'Verenigde Staten'])
+    expect(country.unofficial_names).to eq(['United States', 'USA', 'Murica', 'Vereinigte Staaten von Amerika', 'États-Unis', 'Estados Unidos', 'アメリカ合衆国', 'Verenigde Staten'])
   end
 
   it 'should return translations' do
@@ -65,15 +65,7 @@ describe ISO3166::Country do
   end
 
   it 'should return bounds' do
-    expect(country.bounds['northeast']['lat']).to eq(71.5388001)
-  end
-
-  it 'should return the decimal Latitude' do
-    expect(country.latitude_dec).to eq('39.44325637817383')
-  end
-
-  it 'should return the decimal Longitude' do
-    expect(country.longitude_dec).to eq('-98.95733642578125')
+    expect(country.bounds['northeast']['lat']).to eq(71.3577635769)
   end
 
   it 'should return continent' do
@@ -144,7 +136,7 @@ describe ISO3166::Country do
       before do
         ISO3166::Data.register(
           alpha2: 'BR2',
-          name: 'Brazil',
+          iso_short_name: 'Brazil',
           languages_official: %w(pt-BR),
           translations: {
             'pt-BR' => 'Translation for pt-BR',
@@ -168,7 +160,7 @@ describe ISO3166::Country do
       before do
         ISO3166::Data.register(
           alpha2: 'BR2',
-          name: 'Brazil',
+          iso_short_name: 'Brazil',
           languages_official: %w(pt-BR),
           translations: {
             'pt' => 'Translation for pt'
@@ -233,11 +225,11 @@ describe ISO3166::Country do
     end
 
     it 'should return a hash with all sub divisions' do
-      expect(country.subdivisions.size).to eq(60)
+      expect(country.subdivisions.size).to eq(57)
     end
 
     it 'should be available through states' do
-      expect(country.states.size).to eq(60)
+      expect(country.states.size).to eq(57)
     end
 
     it 'should be a subdivision object' do
@@ -323,7 +315,7 @@ describe ISO3166::Country do
     end
 
     it 'should allow to customize each country representation passing a block to the method' do
-      countries = ISO3166::Country.all { |country, data| [data['name'], country, data['country_code']] }
+      countries = ISO3166::Country.all { |country, data| [data['iso_short_name'], country, data['country_code']] }
       expect(countries).to be_an(Array)
       expect(countries.first).to be_an(Array)
       expect(countries.first.size).to eq(3)
@@ -354,7 +346,7 @@ describe ISO3166::Country do
       before do
         ISO3166::Data.register(
           alpha2: 'XX',
-          name: 'Custom Country',
+          iso_short_name: 'Custom Country',
           translations: { 'en' => 'Custom Country' }
         )
       end
@@ -362,7 +354,7 @@ describe ISO3166::Country do
       it 'should include custom registered countries' do
         custom_country = ISO3166::Country.find_by_alpha2('XX')[1]
         countries = ISO3166::Country.all_translated
-        expect(countries).to include(custom_country['name'])
+        expect(countries).to include(custom_country['iso_short_name'])
       end
 
       after do
@@ -549,7 +541,7 @@ describe ISO3166::Country do
     end
 
     it 'also performs searches with regexps and forces it to ignore case' do
-      spain_data = ISO3166::Country.find_all_by(:names, /Españ/)
+      spain_data = ISO3166::Country.find_all_by(:unofficial_names, /Españ/)
       expect(spain_data).to be_a Hash
       expect(spain_data.keys).to eq(['ES'])
     end
@@ -561,7 +553,7 @@ describe ISO3166::Country do
         case lookup.length
         when 2 then ISO3166::Country.find_all_by(:alpha2, lookup)
         when 3 then ISO3166::Country.find_all_by(:alpha3, lookup)
-        else ISO3166::Country.find_all_by(:name, lookup)
+        else ISO3166::Country.find_all_by(:iso_short_name, lookup)
         end
       end
       expect(Time.now - start).to be < 1
@@ -569,22 +561,22 @@ describe ISO3166::Country do
   end
 
   describe 'hash finder methods' do
-    context "when search name in 'name'" do
-      subject { ISO3166::Country.find_by_name('Poland') }
+    context "when search name in 'iso_short_name'" do
+      subject { ISO3166::Country.find_by_iso_short_name('Poland') }
       it 'should return' do
         expect(subject.first).to eq('PL')
       end
     end
 
-    context "when search lowercase name in 'name'" do
-      subject { ISO3166::Country.find_by_name('poland') }
+    context "when search lowercase name in 'iso_short_name'" do
+      subject { ISO3166::Country.find_by_iso_short_name('poland') }
       it 'should return' do
         expect(subject.first).to eq('PL')
       end
     end
 
-    context "when search name with comma in 'name'" do
-      subject { ISO3166::Country.find_by_name(country_name) }
+    context "when search name with comma in 'iso_short_name'" do
+      subject { ISO3166::Country.find_by_iso_short_name(country_name) }
 
       context 'with Republic of Korea' do
         let(:country_name) { 'Korea, Republic of' }
@@ -609,7 +601,7 @@ describe ISO3166::Country do
     end
 
     context 'when search lowercase multibyte name found' do
-      subject { ISO3166::Country.find_country_by_name('россия') }
+      subject { ISO3166::Country.find_country_by_unofficial_names('россия') }
 
       it 'should be a country instance' do
         expect(subject).to be_a(ISO3166::Country)
@@ -618,7 +610,7 @@ describe ISO3166::Country do
     end
 
     context 'when search lowercase multibyte name found' do
-      subject { ISO3166::Country.find_country_by_name(/россия/) }
+      subject { ISO3166::Country.find_country_by_unofficial_names(/россия/) }
 
       it 'should be a country instance' do
         expect(subject).to be_a(ISO3166::Country)
@@ -627,7 +619,7 @@ describe ISO3166::Country do
     end
 
     context 'when accents are not used' do
-      subject { ISO3166::Country.find_country_by_name('emirats Arabes Unis') }
+      subject { ISO3166::Country.find_country_by_unofficial_names('emirats Arabes Unis') }
 
       it 'should be a country instance' do
         expect(subject).to be_a(ISO3166::Country)
@@ -635,8 +627,20 @@ describe ISO3166::Country do
       end
     end
 
-    context "when search name in 'names'" do
-      subject { ISO3166::Country.find_by_name('Polonia') }
+    context "when search name in 'unofficial_names'" do
+      subject { ISO3166::Country.find_by_unofficial_names('Polonia') }
+      it 'should return' do
+        expect(subject.first).to eq('PL')
+      end
+    end
+
+    context "when search name in 'translated_names'" do
+      before do
+        ISO3166.configure do |config|
+          config.locales = [:bs]
+        end
+      end
+      subject { ISO3166::Country.find_by_translated_names('Poljska') }
       it 'should return' do
         expect(subject.first).to eq('PL')
       end
@@ -669,7 +673,7 @@ describe ISO3166::Country do
 
   describe 'country finder methods' do
     context 'when search name found' do
-      let(:uk) { ISO3166::Country.find_country_by_name('United Kingdom') }
+      let(:uk) { ISO3166::Country.find_country_by_unofficial_names('United Kingdom') }
 
       it 'should be a country instance' do
         expect(uk).to be_a(ISO3166::Country)
@@ -678,7 +682,7 @@ describe ISO3166::Country do
     end
 
     context 'when search lowercase name found' do
-      let(:uk) { ISO3166::Country.find_country_by_name('united kingdom') }
+      let(:uk) { ISO3166::Country.find_country_by_unofficial_names('united kingdom') }
 
       it 'should be a country instance' do
         expect(uk).to be_a(ISO3166::Country)
@@ -687,7 +691,7 @@ describe ISO3166::Country do
     end
 
     context 'when the search term contains comma' do
-      let(:korea) { ISO3166::Country.find_country_by_name('Korea, Republic of') }
+      let(:korea) { ISO3166::Country.find_country_by_unofficial_names('Korea, Republic of') }
 
       it 'should be a country instance' do
         expect(korea).to be_a(ISO3166::Country)
@@ -726,7 +730,7 @@ describe ISO3166::Country do
       end
     end
     context 'when search name not found' do
-      let(:bogus) { ISO3166::Country.find_country_by_name('Does not exist') }
+      let(:bogus) { ISO3166::Country.find_country_by_unofficial_names('Does not exist') }
 
       it 'should be a country instance' do
         expect(bogus).to eq(nil)
@@ -735,7 +739,7 @@ describe ISO3166::Country do
 
     # Spot checks #243
     context 'when search name not found' do
-      let(:belgium) { ISO3166::Country.find_country_by_name('Belgium') }
+      let(:belgium) { ISO3166::Country.find_country_by_unofficial_names('Belgium') }
 
       it 'should be a country instance' do
         expect(belgium.alpha2).to eq('BE')
@@ -744,7 +748,7 @@ describe ISO3166::Country do
 
     # Spot checks #240
     context 'when search name not found' do
-      let(:canada) { ISO3166::Country.find_country_by_name('Canada') }
+      let(:canada) { ISO3166::Country.find_country_by_unofficial_names('Canada') }
 
       it 'should be a country instance' do
         expect(canada.alpha2).to eq('CA')
@@ -753,7 +757,7 @@ describe ISO3166::Country do
 
     # Spot checks #241
     context 'when search name not found' do
-      let(:israel) { ISO3166::Country.find_country_by_name('Israel') }
+      let(:israel) { ISO3166::Country.find_country_by_unofficial_names('Israel') }
 
       it 'should be a country instance' do
         expect(israel.alpha2).to eq('IL')
@@ -762,7 +766,7 @@ describe ISO3166::Country do
 
     # Spot checks #241
     context 'when search name not found' do
-      let(:israel) { ISO3166::Country.find_by_name('Israel') }
+      let(:israel) { ISO3166::Country.find_by_iso_short_name('Israel') }
 
       it 'should be a country instance' do
         expect(israel[0]).to eq('IL')
@@ -771,7 +775,7 @@ describe ISO3166::Country do
 
     # Spot checks #241
     context 'when search name not found' do
-      let(:israel) { ISO3166::Country.find_all_by(:name, 'Israel') }
+      let(:israel) { ISO3166::Country.find_all_by(:iso_short_name, 'Israel') }
 
       it 'should be a country instance' do
         expect(israel.size).to eq(1)
@@ -820,7 +824,7 @@ describe ISO3166::Country do
 
     describe 'hash finder methods' do
       context 'find by a valid Country attribute' do
-        let(:method_name) { :find_by_name }
+        let(:method_name) { :find_by_iso_short_name }
         it { is_expected.to be true }
       end
 
@@ -846,7 +850,7 @@ describe ISO3166::Country do
   describe 'names in Data' do
     it 'should be unique (to allow .find_by_name work properly)' do
       names = ISO3166::Data.cache.map do |_k, v|
-        [v['name'], v['unofficial_names']].flatten.uniq
+        [v['iso_short_name'], v['unofficial_names']].flatten.uniq
       end.flatten
 
       expect(names.size).to eq(names.uniq.size)
@@ -929,7 +933,7 @@ describe ISO3166::Country do
   end
 
   describe 'to_s' do
-    it 'should return the country name' do
+    it 'should return the country iso_short_name' do
       expect(ISO3166::Country.new('GB').to_s).to eq('United Kingdom of Great Britain and Northern Ireland')
     end
   end
@@ -970,30 +974,30 @@ describe ISO3166::Country do
 
   describe 'Added country names to search by' do
     it 'should return country code for Democratic Republic of the Congo' do
-      expect(ISO3166::Country.find_country_by_name('Democratic Republic of the Congo').alpha2).to eq 'CD'
+      expect(ISO3166::Country.find_country_by_unofficial_names('Democratic Republic of the Congo').alpha2).to eq 'CD'
     end
     it 'should return country code for Ivory Coast' do
-      expect(ISO3166::Country.find_country_by_name('Ivory Coast').alpha2).to eq 'CI'
+      expect(ISO3166::Country.find_country_by_unofficial_names('Ivory Coast').alpha2).to eq 'CI'
     end
     it 'should return Pakistan code for Guinea Bissau' do
-      expect(ISO3166::Country.find_country_by_name('Guinea Bissau').alpha2).to eq 'GW'
+      expect(ISO3166::Country.find_country_by_unofficial_names('Guinea Bissau').alpha2).to eq 'GW'
     end
     it 'should return Pakistan code for St Kitts and Nevis' do
-      expect(ISO3166::Country.find_country_by_name('St Kitts and Nevis').alpha2).to eq 'KN'
+      expect(ISO3166::Country.find_country_by_unofficial_names('St Kitts and Nevis').alpha2).to eq 'KN'
     end
     it 'should return Pakistan code for St Lucia' do
-      expect(ISO3166::Country.find_country_by_name('St Lucia').alpha2).to eq 'LC'
-      expect(ISO3166::Country.find_country_by_name('St. Lucia').alpha2).to eq 'LC'
+      expect(ISO3166::Country.find_country_by_unofficial_names('St Lucia').alpha2).to eq 'LC'
+      expect(ISO3166::Country.find_country_by_unofficial_names('St. Lucia').alpha2).to eq 'LC'
     end
     it 'should return Pakistan code for Turks and Caicos' do
-      expect(ISO3166::Country.find_country_by_name('Turks and Caicos').alpha2).to eq 'TC'
+      expect(ISO3166::Country.find_country_by_unofficial_names('Turks and Caicos').alpha2).to eq 'TC'
     end
     it 'should return Pakistan code for St Vincent Grenadines' do
-      expect(ISO3166::Country.find_country_by_name('St Vincent Grenadines').alpha2).to eq 'VC'
-      expect(ISO3166::Country.find_country_by_name('St. Vincent Grenadines').alpha2).to eq 'VC'
+      expect(ISO3166::Country.find_country_by_unofficial_names('St Vincent Grenadines').alpha2).to eq 'VC'
+      expect(ISO3166::Country.find_country_by_unofficial_names('St. Vincent Grenadines').alpha2).to eq 'VC'
     end
     it 'should return country code for Palestinian Authority' do
-      expect(ISO3166::Country.find_country_by_name('Palestinian Authority').alpha2).to eq 'PS'
+      expect(ISO3166::Country.find_country_by_unofficial_names('Palestinian Authority').alpha2).to eq 'PS'
     end
   end
 
@@ -1022,8 +1026,8 @@ describe ISO3166::Country do
       expect(subject.last).to be_empty
     end
 
-    context "when asking for alpha2, alpha3 and name" do
-      let(:args) { [:alpha2, :alpha3, :name] }
+    context "when asking for alpha2, alpha3 and iso_short_name" do
+      let(:args) { [:alpha2, :alpha3, :iso_short_name] }
 
       it "returns the correct values" do
         expect(subject.first).to eq(["AD", "AND", "Andorra"])

data/spec/data_spec.rb

@@ -95,7 +95,7 @@ describe ISO3166::Data do
     before do
       ISO3166::Data.register(
         alpha2: 'TW',
-        name: 'NEW Taiwan',
+        iso_short_name: 'NEW Taiwan',
         subdivisions: {
           CHA: {name: 'New Changhua'},
           CYI: {name: 'New Municipality'}
@@ -112,8 +112,8 @@ describe ISO3166::Data do
     it 'can be done' do
       data = ISO3166::Data.new('TW').call
       ISO3166.configuration.locales = [:es, :de, :de]
-      expect(data['name']).to eq 'NEW Taiwan'
-      expect(subject.name).to eq 'NEW Taiwan'
+      expect(data['iso_short_name']).to eq 'NEW Taiwan'
+      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'}),
@@ -125,7 +125,7 @@ describe ISO3166::Data do
     before do
       ISO3166::Data.register(
         alpha2: 'LOL',
-        name: 'Happy Country',
+        iso_short_name: 'Happy Country',
         subdivisions: {
           LOL1: {name: 'Happy sub1'},
           LOL2: {name: 'Happy sub2'}
@@ -141,17 +141,17 @@ describe ISO3166::Data do
 
     it 'can be done' do
       data = ISO3166::Data.new('LOL').call
-      expect(data['name']).to eq 'Happy Country'
-      expect(subject.name).to eq 'Happy Country'
+      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'}))
     end
 
     it 'detect a stale cache' do
-      ISO3166::Data.register(alpha2: 'SAD', name: 'Sad Country')
+      ISO3166::Data.register(alpha2: 'SAD', iso_short_name: 'Sad Country')
       data = ISO3166::Data.new('SAD').call
-      expect(data['name']).to eq 'Sad Country'
-      expect(ISO3166::Country.new('SAD').name).to eq 'Sad Country'
+      expect(data['iso_short_name']).to eq 'Sad Country'
+      expect(ISO3166::Country.new('SAD').iso_short_name).to eq 'Sad Country'
       ISO3166::Data.unregister('SAD')
     end