countries 5.4.0 → 5.5.0

data/lib/countries/country/class_methods.rb

@@ -40,9 +40,7 @@ module ISO3166
     end
 
     def pluck(*attributes)
-      all.map do |country|
-        attributes.map { |attribute| country.data.fetch(attribute.to_s) }
-      end
+      all.map { |country| country.data.fetch_values(*attributes.map(&:to_s)) }
     end
 
     def all_translated(locale = 'en')
@@ -64,6 +62,27 @@ module ISO3166
       translations.merge(custom_countries)
     end
 
+    # @param query_val [String] A value to query using `query_method`
+    # @param query_method [Symbol] An optional query method, defaults to Country#alpha2
+    # @param result_method [Symbol] An optional method of `Country` to apply to the result set.
+    # @return [Array] An array of countries matching the provided query, or the result of applying `result_method` to the array of `Country` objects
+    def collect_countries_with(query_val, query_method = :alpha2, result_method = :itself)
+      return nil unless [query_method, result_method].map { |e| method_defined? e }.all?
+
+      all.select { |country| country.send(query_method).include? query_val }
+         .map { |country| country.send(result_method) }
+    end
+
+    # @param subdivision_str [String] A subdivision name or code to search for. Search includes translated subdivision names.
+    # @param result_method [Symbol] An optional method of `Country` to apply to the result set.
+    # @return [Array] An array of countries with subdivisions matching the provided name, or the result of applying `result_method` to the array of `Country` objects
+    def collect_likely_countries_by_subdivision_name(subdivision_str, result_method = :itself)
+      return nil unless method_defined? result_method
+
+      all.select { |country| country.subdivision_for_string?(subdivision_str) }
+         .map { |country| country.send(result_method) }
+    end
+
     protected
 
     def strip_accents(string)

data/lib/countries/country/country_subdivision_methods.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module ISO3166
+  module CountrySubdivisionMethods
+    # @param subdivision_str [String] A subdivision name or code to search for. Search includes translated subdivision names.
+    # @return [Subdivision] The first subdivision matching the provided string
+    def find_subdivision_by_name(subdivision_str)
+      subdivisions.select do |k, v|
+        subdivision_str == k || v.name == subdivision_str || v.translations.values.include?(subdivision_str)
+      end.values.first
+    end
+
+    def subdivision_for_string?(subdivision_str)
+      !subdivisions.transform_values(&:translations)
+                   .select { |k, v| subdivision_str == k || v.values.include?(subdivision_str) }.empty?
+    end
+
+    #  +true+ if this Country has any Subdivisions.
+    def subdivisions?
+      !subdivisions.empty?
+    end
+
+    # @return [Array<ISO3166::Subdivision>] the list of subdivisions for this Country.
+    def subdivisions
+      @subdivisions ||= if data['subdivisions']
+                          ISO3166::Data.create_subdivisions(data['subdivisions'])
+                        else
+                          ISO3166::Data.subdivisions(alpha2)
+                        end
+    end
+
+    # @param types [Array<String>] The locale to use for translations.
+    # @return [Array<ISO3166::Subdivision>] the list of subdivisions of the given type(s) for this Country.
+    def subdivisions_of_types(types)
+      subdivisions.select { |_k, v| types.include?(v.type) }
+    end
+
+    # @return [Array<String>] the list of subdivision types for this country
+    def subdivision_types
+      subdivisions.map { |_k, v| v['type'] }.uniq
+    end
+
+    # @return [Array<String>] the list of humanized subdivision types for this country. Uses ActiveSupport's `#humanize` if available
+    def humanized_subdivision_types
+      if String.instance_methods.include?(:humanize)
+        subdivisions.map { |_k, v| v['type'].humanize }.uniq
+      else
+        subdivisions.map { |_k, v| humanize_string(v['type']) }.uniq
+      end
+    end
+
+    # @param locale [String] The locale to use for translations.
+    # @return [Array<Array>] This Country's subdivision pairs of names and codes.
+    def subdivision_names_with_codes(locale = 'en')
+      subdivisions.map { |k, v| [v.translations[locale] || v.name, k] }
+    end
+
+    # @param locale [String] The locale to use for translations.
+    # @return [Array<String>] A list of subdivision names for this country.
+    def subdivision_names(locale = 'en')
+      subdivisions.map { |_k, v| v.translations[locale] || v.name }
+    end
+
+    def states
+      if RUBY_VERSION =~ /^3\.\d\.\d/
+        warn 'DEPRECATION WARNING: The Country#states method has been deprecated and will be removed in 6.0. Please use Country#subdivisions instead.',
+             uplevel: 1, category: :deprecated
+      else
+        warn 'DEPRECATION WARNING: The Country#states method has been deprecated and will be removed in 6.0. Please use Country#subdivisions instead.',
+             uplevel: 1
+      end
+
+      subdivisions
+    end
+
+    private
+
+    def humanize_string(str)
+      str[0].upcase + str.tr('_', ' ')[1..]
+    end
+  end
+end

data/lib/countries/country/currency_methods.rb

@@ -6,7 +6,6 @@ module ISO3166
   # Optional extension which allows you to get back a +Money::Currency+ object with all the currency info.
   # This requires enabling the integration with the {Money}[https://github.com/RubyMoney/money] gem (See {ISO3166::Configuration#enable_currency_extension!})
   module CountryCurrencyMethods
-
     # @return [Money::Currency] The currency data for this Country's +currency_code+
     def currency
       Money::Currency.find(data['currency_code'])

data/lib/countries/country/finder_methods.rb

@@ -57,9 +57,7 @@ module ISO3166
       raise "Invalid attribute name '#{attribute}'" unless searchable_attribute?(attribute.to_sym)
 
       attributes = Array(attribute.to_s)
-      if attribute.to_s == 'any_name'
-        attributes = %w[iso_long_name iso_short_name unofficial_names translated_names]
-      end
+      attributes = %w[iso_long_name iso_short_name unofficial_names translated_names] if attribute.to_s == 'any_name'
 
       [attributes, parse_value(val)]
     end
@@ -75,7 +73,7 @@ module ISO3166
 
     def searchable_attributes
       # Add name and names until we complete the deprecation of the finders
-      instance_methods - UNSEARCHABLE_METHODS + [:name, :names, :any_name]
+      instance_methods - UNSEARCHABLE_METHODS + %i[name names any_name]
     end
   end
 end

data/lib/countries/country.rb

@@ -5,6 +5,7 @@ module ISO3166
     extend CountryClassMethods
     extend CountryFinderMethods
     include Emoji
+    include CountrySubdivisionMethods
     attr_reader :data
 
     ISO3166::DEFAULT_COUNTRY_HASH.each do |method_name, _type|
@@ -50,65 +51,24 @@ module ISO3166
       to_s <=> other.to_s
     end
 
-    #  +true+ if this Country has any Subdivisions.
-    def subdivisions?
-      !subdivisions.empty?
-    end
-
-    # @return [Array<ISO3166::Subdivision>] the list of subdivisions for this Country.
-    def subdivisions
-      @subdivisions ||= if data['subdivisions']
-                          ISO3166::Data.create_subdivisions(data['subdivisions'])
-                        else
-                          ISO3166::Data.subdivisions(alpha2)
-                        end
-    end
-
-    # @param types [Array<String>] The locale to use for translations.
-    # @return [Array<ISO3166::Subdivision>] the list of subdivisions of the given type(s) for this Country.
-    def subdivisions_of_types(types)
-      subdivisions.select{|k,v| types.include?(v.type)}
-    end
-
-    # @return [Array<String>] the list of subdivision types for this country
-    def subdivision_types
-      subdivisions.map{|k,v| v['type']}.uniq
-    end
-
-    # @return [Array<String>] the list of humanized subdivision types for this country. Uses ActiveSupport's `#humanize` if available
-    def humanized_subdivision_types
-      if String.instance_methods.include?(:humanize)
-        subdivisions.map{|k,v| v['type'].humanize}.uniq
-      else
-        subdivisions.map{|k,v| v['type'][0].upcase + v['type'].tr('_', ' ')[1..-1]}.uniq
-      end
-    end
-
-    # @param locale [String] The locale to use for translations.
-    # @return [Array<Array>] This Country's subdivision pairs of names and codes.
-    def subdivision_names_with_codes(locale = 'en')
-      subdivisions.map { |k, v| [v.translations[locale] || v.name, k] }
+    # +true+ if this country is a member of the European Union.
+    def in_eu?
+      data['eu_member'].nil? ? false : data['eu_member']
     end
 
-    # @param locale [String] The locale to use for translations.
-    # @return [Array<String>] A list of subdivision names for this country.
-    def subdivision_names(locale = 'en')
-      subdivisions.map { |k, v| v.translations[locale] || v.name }
+    # +true+ if this country is a member of the G7.
+    def in_g7?
+      data['g7_member'].nil? ? false : data['g7_member']
     end
 
-    def states
-      if RUBY_VERSION =~ /^3\.\d\.\d/
-        warn "DEPRECATION WARNING: The Country#states method has been deprecated and will be removed in 6.0. Please use Country#subdivisions instead.", uplevel: 1, category: :deprecated
-      else
-        warn "DEPRECATION WARNING: The Country#states method has been deprecated and will be removed in 6.0. Please use Country#subdivisions instead.", uplevel: 1
-      end
-
-      subdivisions
+    # +true+ if this country is a member of the G20.
+    def in_g20?
+      data['g20_member'].nil? ? false : data['g20_member']
     end
 
-    # +true+ if this country is a member of the European Union.
-    def in_eu?
-      data['eu_member'].nil? ? false : data['eu_member']
+    # +true+ if this country is a member of the European Economic Area or it is UK
+    def gdpr_compliant?
+      data['eea_member'] || alpha2 == 'GB'
     end
 
     # +true+ if this country is a member of the European Economic Area.

data/lib/countries/data/countries/AR.yaml

@@ -11,6 +11,7 @@ AR:
   continent: South America
   country_code: '54'
   currency_code: ARS
+  g20_member: true
   gec: AR
   geo:
     latitude: -38.416097

data/lib/countries/data/countries/AU.yaml

@@ -10,6 +10,7 @@ AU:
   continent: Australia
   country_code: '61'
   currency_code: AUD
+  g20_member: true
   gec: AS
   geo:
     latitude: -25.274398

data/lib/countries/data/countries/BR.yaml

@@ -10,6 +10,7 @@ BR:
   continent: South America
   country_code: '55'
   currency_code: BRL
+  g20_member: true
   gec: BR
   geo:
     latitude: -14.235004

data/lib/countries/data/countries/CA.yaml

@@ -10,6 +10,8 @@ CA:
   continent: North America
   country_code: '1'
   currency_code: CAD
+  g7_member: true
+  g20_member: true
   gec: CA
   geo:
     latitude: 56.130366

data/lib/countries/data/countries/CN.yaml

@@ -10,6 +10,7 @@ CN:
   continent: Asia
   country_code: '86'
   currency_code: CNY
+  g20_member: true
   gec: CH
   geo:
     latitude: 35.86166

data/lib/countries/data/countries/DE.yaml

@@ -12,6 +12,8 @@ DE:
   currency_code: EUR
   eea_member: true
   eu_member: true
+  g7_member: true
+  g20_member: true
   gec: GM
   geo:
     latitude: 51.165691

data/lib/countries/data/countries/FR.yaml

@@ -12,6 +12,8 @@ FR:
   currency_code: EUR
   eea_member: true
   eu_member: true
+  g7_member: true
+  g20_member: true
   gec: FR
   geo:
     latitude: 46.227638

data/lib/countries/data/countries/GB.yaml

@@ -14,6 +14,8 @@ GB:
   currency_code: GBP
   eea_member: false
   eu_member: false
+  g7_member: true
+  g20_member: true
   gec: UK
   geo:
     latitude: 55.378051

data/lib/countries/data/countries/ID.yaml

@@ -11,6 +11,7 @@ ID:
   continent: Asia
   country_code: '62'
   currency_code: IDR
+  g20_member: true
   gec: ID
   geo:
     latitude: -0.789275

data/lib/countries/data/countries/IN.yaml

@@ -11,6 +11,7 @@ IN:
   continent: Asia
   country_code: '91'
   currency_code: INR
+  g20_member: true
   gec: IN
   geo:
     latitude: 20.593684

data/lib/countries/data/countries/IT.yaml

@@ -12,6 +12,8 @@ IT:
   currency_code: EUR
   eea_member: true
   eu_member: true
+  g7_member: true
+  g20_member: true
   gec: IT
   geo:
     latitude: 41.87194

data/lib/countries/data/countries/JP.yaml

@@ -10,6 +10,8 @@ JP:
   continent: Asia
   country_code: '81'
   currency_code: JPY
+  g7_member: true
+  g20_member: true
   gec: JA
   geo:
     latitude: 36.204824

data/lib/countries/data/countries/KR.yaml

@@ -11,6 +11,7 @@ KR:
   continent: Asia
   country_code: '82'
   currency_code: KRW
+  g20_member: true
   gec: KS
   geo:
     latitude: 35.907757

data/lib/countries/data/countries/MX.yaml

@@ -10,6 +10,7 @@ MX:
   continent: North America
   country_code: '52'
   currency_code: MXN
+  g20_member: true
   gec: MX
   geo:
     latitude: 23.634501

data/lib/countries/data/countries/RU.yaml

@@ -10,6 +10,7 @@ RU:
   continent: Europe
   country_code: '7'
   currency_code: RUB
+  g20_member: true
   gec: RS
   geo:
     latitude: 61.52401

data/lib/countries/data/countries/SA.yaml

@@ -10,6 +10,7 @@ SA:
   continent: Asia
   country_code: '966'
   currency_code: SAR
+  g20_member: true
   gec: SA
   geo:
     latitude: 23.885942

data/lib/countries/data/countries/TR.yaml

@@ -10,6 +10,7 @@ TR:
   continent: Europe
   country_code: '90'
   currency_code: TRY
+  g20_member: true
   gec: TU
   geo:
     latitude: 38.963745

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

@@ -10,6 +10,8 @@ US:
   continent: North America
   country_code: '1'
   currency_code: USD
+  g7_member: true
+  g20_member: true
   gec: US
   geo:
     latitude: 37.09024

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

@@ -12,6 +12,7 @@ ZA:
   continent: Africa
   country_code: '27'
   currency_code: ZAR
+  g20_member: true
   gec: SF
   geo:
     latitude: -30.559482

data/lib/countries/data/locales_methods.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ISO3166
+  module LocalesMethods
+    private
+
+    def locales_to_load
+      requested_locales - loaded_locales
+    end
+
+    def locales_to_remove
+      loaded_locales - requested_locales
+    end
+
+    def requested_locales
+      ISO3166.configuration.locales.map { |locale| locale.to_s.downcase }
+    end
+
+    def loaded_locales
+      ISO3166.configuration.loaded_locales.map { |locale| locale.to_s.downcase }
+    end
+  end
+end

data/lib/countries/data/subdivision_methods.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ISO3166
+  module SubdivisionMethods
+    def subdivision_data(alpha2)
+      data = load_data_for_alpha2(alpha2)
+      locales = ISO3166.configuration.locales.map(&:to_s)
+
+      data.each_value { |subdivision| subdivision['translations'] = subdivision['translations'].slice(*locales) }
+
+      data
+    end
+
+    def load_data_for_alpha2(alpha2)
+      file = subdivision_file_path(alpha2)
+      File.exist?(file) ? YAML.load_file(file) : {}
+    end
+
+    def subdivisions(alpha2)
+      @subdivisions ||= {}
+      @subdivisions[alpha2] ||= create_subdivisions(subdivision_data(alpha2))
+    end
+
+    def create_subdivisions(subdivision_data)
+      subdivision_data.transform_values do |subdivision|
+        Subdivision.new(subdivision)
+      end
+    end
+  end
+end

data/lib/countries/data/subdivisions/AD.yaml

@@ -12,6 +12,7 @@
     max_longitude: 1.6037142
   translations:
     en: Canillo
+    ja: カニーリョ教区
   comments:
   type: parish
 '03':
@@ -27,6 +28,7 @@
     max_longitude: 1.5901645
   translations:
     en: Encamp
+    ja: アンカム教区
   comments:
   type: parish
 '04':
@@ -42,6 +44,7 @@
     max_longitude: 1.5204314
   translations:
     en: La Massana
+    ja: ラ・マサナ教区
   comments:
   type: parish
 '05':
@@ -57,6 +60,7 @@
     max_longitude: 1.5374774
   translations:
     en: Ordino
+    ja: オルディノ教区
   comments:
   type: parish
 '06':
@@ -73,6 +77,7 @@
     max_longitude: 1.4963642
   translations:
     en: Sant Julià de Lòria
+    ja: サン・ジュリア・デ・ロリア教区
   comments:
   type: parish
 '07':
@@ -90,6 +95,7 @@
     max_longitude: 1.5353385
   translations:
     en: Andorra la Vella
+    ja: アンドラ・ラ・ベリャ教区
   comments:
   type: parish
 '08':
@@ -106,5 +112,6 @@
     max_longitude: 1.5532685
   translations:
     en: Escaldes-Engordany
+    ja: エスカルデス＝エンゴルダニ教区
   comments:
   type: parish

data/lib/countries/data/subdivisions/AE.yaml

@@ -74,6 +74,7 @@ AJ:
     yo: Ajman
     'no': Emiratet Ajman
     yo_BJ: Ajman
+    bs: Ajman (emirat)
   comments:
   type: emirate
 AZ:
@@ -159,6 +160,9 @@ AZ:
     yue: 阿布扎比酋長國
     mk: Абу Даби
     'no': Emiratet Abu Dhabi
+    bs: Abu Dhabi (emirat)
+    ha: Abu Dhabi (Masarauta)
+    ha_NE: Abu Dhabi (Masarauta)
   comments:
   type: emirate
 DU:
@@ -235,6 +239,10 @@ DU:
     uz: Dubay
     bs: Dubai
     'no': Emiratet Dubai
+    ga: Dubai
+    ha: Dubai
+    ha_NE: Dubai
+    ms: Amiriah Dubai
   comments:
   type: emirate
 FU:
@@ -314,6 +322,9 @@ FU:
     yo: Fujairah
     'no': Emiratet Fujairah
     yo_BJ: Fujairah
+    bs: Fujairah (emirat)
+    is: Fúdsaíra
+    ka: ალ-ფუჯაირას საამირო
   comments:
   type: emirate
 RK:
@@ -354,6 +365,7 @@ RK:
     hy: Ռաս-ալ-Խայմայի էմիրություն
     id: Ras al-Khaimah
     it: Ras al-Khaima
+    ja: ラアス・アル＝ハイマ
     kn: ರಾಸ್ ಅಲ್ ಖೈಮಾ
     ko: 라스알카이마 토후국
     lt: Ras al Chaima
@@ -392,6 +404,9 @@ RK:
     mk: Рас ел-Хајма
     'no': Emiratet Ras al-Khaimah
     yo_BJ: Ras al Khaimah
+    bs: Ras al-Khaimah (emirat)
+    gl: Ras al-Jaimah
+    is: Ras al-Kaíma
   comments:
   type: emirate
 SH:
@@ -471,6 +486,7 @@ SH:
     yo: Sharjah
     'no': Emiratet Sharjah
     yo_BJ: Sharjah
+    bs: Sharjah (emirat)
   comments:
   type: emirate
 UQ:
@@ -511,6 +527,7 @@ UQ:
     hy: Ումմ ալ-Քուվեյնի Էմիրություն
     id: Umm al-Qaiwain
     it: Umm al-Qaywayn
+    ja: ウンム・アル＝カイワイン
     ka: უმ-ელ-კაივაინის საამირო
     kn: ಉಮ್ ಅಲ್ ಕ್ವೈನ್
     ko: 움알쿠와인 토후국
@@ -548,5 +565,6 @@ UQ:
     yo: Um Al Quwain
     'no': Emiratet Umm al-Qaiwain
     yo_BJ: Um Al Quwain
+    bs: Umm al-Quwain (emirat)
   comments:
   type: emirate