countries 5.4.0 → 5.7.0

data/spec/country_spec.rb

@@ -3,7 +3,11 @@
 require 'spec_helper'
 NUM_OF_COUNTRIES = 249
 describe ISO3166::Country do
-  before { ISO3166.configuration.enable_currency_extension! }
+  before do
+    ISO3166::Data.reset
+    ISO3166.configuration.enable_currency_extension!
+  end
+
   let(:country) { ISO3166::Country.search('US') }
 
   it 'allows to create a country object from a symbol representation of the alpha2 code' do
@@ -48,11 +52,11 @@ describe ISO3166::Country do
   end
 
   it 'should return alternate names' do
-    expect(country.unofficial_names).to eq(["United States", "USA",
-                                            "Vereinigte Staaten von Amerika",
-                                            "États-Unis", "Estados Unidos",
-                                            "アメリカ合衆国", "Verenigde Staten",
-                                            "Соединенные Штаты Америки"])
+    expect(country.unofficial_names).to eq(['United States', 'USA',
+                                            'Vereinigte Staaten von Amerika',
+                                            'États-Unis', 'Estados Unidos',
+                                            'アメリカ合衆国', 'Verenigde Staten',
+                                            'Соединенные Штаты Америки'])
   end
 
   it 'should return translations' do
@@ -76,6 +80,10 @@ describe ISO3166::Country do
     expect(country.continent).to eq('North America')
   end
 
+  it 'should return distance unit' do
+    expect(country.distance_unit).to eq('MI')
+  end
+
   it 'knows about whether or not the country uses postal codes' do
     expect(country.zip).to be_truthy
   end
@@ -90,6 +98,7 @@ describe ISO3166::Country do
 
     regex = Regexp.new(country.postal_code_format)
     expect(regex).to match('12345-6789')
+    expect(regex).not_to match('12345-67890')
 
     antarctica = ISO3166::Country.search('AQ')
     expect(antarctica.postal_code_format).to be_nil
@@ -149,7 +158,7 @@ describe ISO3166::Country do
         ISO3166::Data.register(
           alpha2: 'BR2',
           iso_short_name: 'Brazil',
-          languages_official: %w(pt-BR),
+          languages_official: %w[pt-BR],
           translations: {
             'pt-BR' => 'Translation for pt-BR',
             'pt' => 'Translation for pt'
@@ -173,7 +182,7 @@ describe ISO3166::Country do
         ISO3166::Data.register(
           alpha2: 'BR2',
           iso_short_name: 'Brazil',
-          languages_official: %w(pt-BR),
+          languages_official: %w[pt-BR],
           translations: {
             'pt' => 'Translation for pt'
           }
@@ -241,7 +250,7 @@ describe ISO3166::Country do
     end
 
     it '#states should be deprecated' do
-      expect {country.states}.to output.to_stderr
+      expect { country.states }.to output.to_stderr
     end
 
     it 'should be a subdivision object' do
@@ -262,54 +271,54 @@ describe ISO3166::Country do
   end
 
   describe 'subdivision_types' do
-    it "should return an array of subdivision types" do
+    it 'should return an array of subdivision types' do
       expect(country.subdivision_types).to contain_exactly('district', 'state', 'outlying_area')
     end
 
-    it "should return an array of subdivision types even if there is only a single type" do
+    it 'should return an array of subdivision types even if there is only a single type' do
       expect(ISO3166::Country['LI'].subdivision_types).to contain_exactly('commune')
     end
 
-    it "should return an empty array if country has no subdivisions" do
+    it 'should return an empty array if country has no subdivisions' do
       expect(ISO3166::Country['AS'].subdivisions?).to be_falsey
       expect(ISO3166::Country['AS'].subdivision_types).to eq([])
     end
   end
 
   describe 'subdivisions_of_types' do
-    it "given a single type, should return an array of subdivisions that match the type" do
+    it 'given a single type, should return an array of subdivisions that match the type' do
       us_states = country.subdivisions_of_types(%w[state])
       expect(us_states.size).to eq(50)
       dc = country.subdivisions_of_types(%w[district])
       expect(dc.size).to eq(1)
     end
 
-    it "given multiple types, should return an array of subdivisions matching the types" do
+    it 'given multiple types, should return an array of subdivisions matching the types' do
       us_states_plus_dc = country.subdivisions_of_types(%w[state district])
       expect(us_states_plus_dc.size).to eq(51)
     end
 
-    it "given multiple types where at least one does not exist for that country, should work without issue" do
+    it 'given multiple types where at least one does not exist for that country, should work without issue' do
       us_states_plus_dc = country.subdivisions_of_types(%w[state district governorate])
       expect(us_states_plus_dc.size).to eq(51)
     end
 
-    it "given only types that do not exist for that country, should return an empty collection" do
+    it 'given only types that do not exist for that country, should return an empty collection' do
       should_be_empty = ISO3166::Country['PT'].subdivisions_of_types(%w[state county])
       expect(should_be_empty).to be_empty
     end
   end
 
   describe 'humanized_subdivision_types' do
-    it "should return an array of humanized subdivision types" do
+    it 'should return an array of humanized subdivision types' do
       expect(country.humanized_subdivision_types).to contain_exactly('District', 'State', 'Outlying area')
     end
 
-    it "should return an array of subdivision types even if there is only a single type" do
+    it 'should return an array of subdivision types even if there is only a single type' do
       expect(ISO3166::Country['LI'].humanized_subdivision_types).to contain_exactly('Commune')
     end
 
-    it "should return an empty array if country has no subdivisions" do
+    it 'should return an empty array if country has no subdivisions' do
       expect(ISO3166::Country['AS'].subdivisions?).to be_falsey
       expect(ISO3166::Country['AS'].humanized_subdivision_types).to eq([])
     end
@@ -878,7 +887,12 @@ describe ISO3166::Country do
     context 'regression test for #388/#746/#776' do
       before 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
       end
 
@@ -1071,6 +1085,24 @@ describe ISO3166::Country do
     end
   end
 
+  describe 'gdpr_compliant?' do
+    let(:united_kigndom) { ISO3166::Country.search('GB') }
+    let(:france) { ISO3166::Country.search('FR') }
+    let(:mexico) { ISO3166::Country.search('MX') }
+
+    it 'should return false for countries without eea_member flag' do
+      expect(mexico.gdpr_compliant?).to be_falsey
+    end
+
+    it 'should return true for countries with eea_member flag set to true' do
+      expect(france.gdpr_compliant?).to be_truthy
+    end
+
+    it 'should return true for UK' do
+      expect(united_kigndom.gdpr_compliant?).to be_truthy
+    end
+  end
+
   describe 'in_esm?' do
     let(:netherlands) { ISO3166::Country.search('NL') }
     let(:switzerland) { ISO3166::Country.search('CH') }
@@ -1214,13 +1246,82 @@ describe ISO3166::Country do
       expect(subject.last).to be_empty
     end
 
-    context "when asking for alpha2, alpha3 and iso_short_name" do
-      let(:args) { [:alpha2, :alpha3, :iso_short_name] }
+    context 'when asking for alpha2, alpha3 and iso_short_name' do
+      let(:args) { %i[alpha2 alpha3 iso_short_name] }
 
       it 'returns the correct values' do
         expect(subject.first).to eq(%w[AD AND Andorra])
         expect(subject.last).to eq(%w[ZW ZWE Zimbabwe])
       end
     end
+
+    context 'with invalid attributes' do
+      let(:args) { %i[alpha2 bad_attribute] }
+
+      it 'should raise an error' do
+        expect { subject }.to(
+          raise_error(KeyError, 'key not found: "bad_attribute"')
+        )
+      end
+    end
+  end
+
+  describe 'find_subdivision_by_name' do
+    let(:italy) { ISO3166::Country.new('IT') }
+    let(:napoli) { italy.subdivisions['NA'] }
+
+    before do
+      ISO3166.configuration.locales = %i[pt]
+    end
+
+    it 'should find a subdivision using the official name' do
+      expect(ISO3166::Country.new('IT').find_subdivision_by_name('Napoli')).to eq napoli
+    end
+
+    it 'should find a subdivision using the code' do
+      expect(ISO3166::Country.new('IT').find_subdivision_by_name('NA')).to eq napoli
+    end
+
+    it 'should find a subdivision using a translated name' do
+      expect(ISO3166::Country.new('IT').find_subdivision_by_name('Nápoles')).to eq napoli
+    end
+  end
+
+  describe 'collect_countries_with' do
+    let(:italy) { ISO3166::Country.new('IT') }
+    let(:vatican) { ISO3166::Country.new('VA') }
+    let(:san_marino) { ISO3166::Country.new('SM') }
+    let(:switzerland) { ISO3166::Country.new('CH') }
+    let(:seychelles) { ISO3166::Country.new('SC') }
+
+    it 'defaults to querying alpha2 and returning the countries' do
+      expect(ISO3166::Country.collect_countries_with('IT')).to eq [italy]
+    end
+
+    it 'allows querying by other attributes' do
+      expect(ISO3166::Country.collect_countries_with('🇸🇨', :emoji_flag)).to eq [seychelles]
+      expect(ISO3166::Country.collect_countries_with('it',
+                                                     :languages_spoken)).to eq [switzerland, italy, san_marino, vatican]
+    end
+
+    it 'allows applying a method to the result set' do
+      expect(ISO3166::Country.collect_countries_with('Caribbean', :subregion,
+                                                     :languages_spoken).flatten.uniq).to eq %w[en nl fr es ht]
+    end
+  end
+
+  describe 'collect_likely_countries_by_subdivision_name' do
+    let(:costa_rica) { ISO3166::Country.new('CR') }
+    let(:uruguay) { ISO3166::Country.new('UY') }
+
+    it 'defaults to returning the countries' do
+      expect(ISO3166::Country.collect_likely_countries_by_subdivision_name('San José')).to eq [costa_rica, uruguay]
+    end
+
+    it 'allows applying a method to the result set' do
+      expect(ISO3166::Country.collect_likely_countries_by_subdivision_name('San José',
+                                                                           :iso_short_name)).to eq ['Costa Rica',
+                                                                                                    'Uruguay']
+    end
   end
 end

data/spec/data_spec.rb

@@ -128,7 +128,7 @@ describe ISO3166::Data do
 
     it 'can be done' do
       data = ISO3166::Data.new('TW').call
-      ISO3166.configuration.locales = [:es, :de, :de]
+      ISO3166.configuration.locales = %i[es de de]
       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',
@@ -205,18 +205,18 @@ describe ISO3166::Data do
       it 'has a non-blank code for all subdivisions' do
         Dir['lib/countries/data/subdivisions/*.yaml'].each do |file|
           data = YAML.load_file(file)
-          expect(data.values.none?{|s| s['code'].nil? }).to be_truthy, "empty subdivision code in #{file}"
+          expect(data.values.none? { |s| s['code'].nil? }).to be_truthy, "empty subdivision code in #{file}"
         end
       end
 
       it 'has a non-blank, lowercase and snake_case type for all subdivisions' do
         Dir['lib/countries/data/subdivisions/*.yaml'].each do |file|
           data = YAML.load_file(file)
-          no_type = data.select{|k,v| v['type'].nil? }
+          no_type = data.select { |_k, v| v['type'].nil? }
           expect(no_type).to be_empty, "empty subdivision type in #{file} - #{no_type.keys}"
-          uppercase = data.select{|k,v| v['type'] =~ /[A-Z]/ }
+          uppercase = data.select { |_k, v| v['type'] =~ /[A-Z]/ }
           expect(uppercase).to be_empty, "uppercase characters in subdivision type in #{file} - #{uppercase.keys}"
-          spaces = data.select{|k,v| v['type'] =~ /\s/ }
+          spaces = data.select { |_k, v| v['type'] =~ /\s/ }
           expect(spaces).to be_empty, "whitespace characters in subdivision type in #{file} - #{spaces.keys}"
         end
       end
@@ -224,7 +224,7 @@ describe ISO3166::Data do
       it 'has a non-blank name for all subdivisions' do
         Dir['lib/countries/data/subdivisions/*.yaml'].each do |file|
           data = YAML.load_file(file)
-          expect(data.values.none?{|s| s['name'].nil? }).to be_truthy, "empty subdivision name in #{file}"
+          expect(data.values.none? { |s| s['name'].nil? }).to be_truthy, "empty subdivision name in #{file}"
         end
       end
     end
@@ -232,13 +232,17 @@ describe ISO3166::Data do
     context 'cached country subdivision data' do
       it 'has a non-blank code for all subdivisions' do
         ISO3166::Country.all.each do |country|
-          expect(country.subdivisions.values.none?{|s| s['code'].nil? }).to be_truthy, "empty subdivision code in #{country}"
+          expect(country.subdivisions.values.none? do |s|
+                   s['code'].nil?
+                 end).to be_truthy, "empty subdivision code in #{country}"
         end
       end
 
       it 'has a non-blank name for all subdivisions' do
         ISO3166::Country.all.each do |country|
-          expect(country.subdivisions.values.none?{|s| s['name'].nil? }).to be_truthy, "empty subdivision name in #{country}"
+          expect(country.subdivisions.values.none? do |s|
+                   s['name'].nil?
+                 end).to be_truthy, "empty subdivision name in #{country}"
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require 'countries'
+require 'debug'
+require 'simplecov'
+SimpleCov.start
+
 RSpec.configure do |config|
   config.filter_run :focus
   config.run_all_when_everything_filtered = true

data/spec/subdivision_spec.rb

@@ -31,4 +31,12 @@ describe ISO3166::Subdivision do
       end
     end
   end
+
+  describe 'code_with_translations' do
+    before { ISO3166.configuration.locales = %i[en pt] }
+    it 'returns a hash' do
+      expect(ISO3166::Country.new('IT').subdivisions['NA'].code_with_translations).to eq({ 'NA' => { 'en' => 'Naples',
+                                                                                                     'pt' => 'Nápoles' } })
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: countries
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.7.0
 platform: ruby
 authors:
 - Josh Robinson
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unaccent
@@ -69,6 +69,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 description: All sorts of useful information about every country packaged as pretty
   little country objects. It includes data from ISO 3166
 email:
@@ -79,15 +93,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".github/FUNDING.yml"
 - ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -230,6 +245,7 @@ files:
 - lib/countries/configuration.rb
 - lib/countries/country.rb
 - lib/countries/country/class_methods.rb
+- lib/countries/country/country_subdivision_methods.rb
 - lib/countries/country/currency_methods.rb
 - lib/countries/country/emoji.rb
 - lib/countries/country/finder_methods.rb
@@ -483,6 +499,8 @@ files:
 - lib/countries/data/countries/ZA.yaml
 - lib/countries/data/countries/ZM.yaml
 - lib/countries/data/countries/ZW.yaml
+- lib/countries/data/locales_methods.rb
+- lib/countries/data/subdivision_methods.rb
 - lib/countries/data/subdivisions/AD.yaml
 - lib/countries/data/subdivisions/AE.yaml
 - lib/countries/data/subdivisions/AF.yaml
@@ -825,7 +843,6 @@ files:
 - lib/countries/sources/local/subdivision.rb
 - lib/countries/structure.rb
 - lib/countries/subdivision.rb
-- lib/countries/tasks/geocoding.rake
 - lib/countries/tasks/postal_codes.rake
 - lib/countries/timezones.rb
 - lib/countries/translations.rb
@@ -864,18 +881,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Gives you a country object full of all sorts of useful information.
-test_files:
-- spec/00_global_spec.rb
-- spec/configuration_spec.rb
-- spec/country_spec.rb
-- spec/data_spec.rb
-- spec/mongoid_spec.rb
-- spec/perf_spec.rb
-- spec/spec_helper.rb
-- spec/subdivision_spec.rb
-- spec/thread_safety_spec.rb
-- spec/timezone_spec.rb
+test_files: []

data/.rubocop_todo.yml

@@ -1,19 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-01-07 11:03:11 UTC using RuboCop version 1.24.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-
-# Offense count: 3
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 33
-
-# Enable after the doc branch is merged
-Style/Documentation:
-  Enabled: false
-  # Exclude:
-  #   - 'spec/**/*'

data/lib/countries/tasks/geocoding.rake

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-require 'geocoder'
-require 'retryable'
-
-Geocoder.configure(
-  lookup: :google,
-  timeout: 10,
-  api_key: GOOGLE_API_KEY
-)
-
-# raise on geocoding errors such as query limit exceeded
-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, params)
-  Retryable.retryable(tries: 3, sleep: ->(n) { 2**n }) do
-    Geocoder.search(query, params: params).first
-  end
-rescue Geocoder::Error, Geocoder::LookupTimeout => e
-  warn "Attempts exceeded for query #{query}, last error was #{e.message}"
-  nil
-end
-
-def load_country_yaml(alpha2)
-  YAML.load_file(File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'countries', "#{alpha2}.yaml"))
-end
-
-def save_country_yaml(alpha2, data)
-  File.write(File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'countries', "#{alpha2}.yaml"), data.to_yaml)
-end
-
-def country_codes
-  @country_codes ||= Dir['lib/countries/data/countries/*.yaml'].map { |x| File.basename(x, File.extname(x)) }.uniq
-end
-
-namespace :geocode do
-  desc 'Retrieve and store countries coordinates'
-  task :fetch_countries do
-    require 'countries'
-    # Iterate over countries
-    ISO3166::Country.all.each do |country|
-      code = country.alpha2
-      # Load unmutated yaml file.
-      data = load_country_yaml(country.alpha2)
-
-      next unless (result = geocode(country.iso_short_name, {region: country.alpha2}))
-
-      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
-      if geometry['location']
-        data[code]['geo']['latitude'] = geometry['location']['lat']
-        data[code]['geo']['longitude'] = geometry['location']['lng']
-      end
-
-      # 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']
-      data[code]['geo']['max_latitude'] = geometry['bounds']['northeast']['lat']
-      data[code]['geo']['max_longitude'] = geometry['bounds']['northeast']['lng']
-
-      # Persist
-      save_country_yaml(code, data)
-    end
-  end
-
-  desc 'Retrieve and store subdivisions coordinates'
-  task :fetch_subdivisions do
-    require_relative '../../countries'
-    # Iterate all countries with subdivisions
-    ISO3166::Country.all.select(&:subdivisions?).each do |c|
-      # Iterate subdivisions
-      state_data = c.subdivisions.dup
-      state_data.reject { |_, data| data['geo'] }.each do |code, _|
-        location = "#{c.alpha2}-#{code}"
-
-        next unless (result = geocode(location, { region: c.alpha2 }))
-
-        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
-      out = File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'subdivisions', "#{c.alpha2}.yaml")
-      File.write(out, state_data.to_yaml)
-    end
-  end
-end