countries 4.2.3 → 5.1.0

data/lib/countries/country/class_methods.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'sixarm_ruby_unaccent'
 
 module ISO3166
   UNSEARCHABLE_METHODS = [:translations].freeze
 
-  def self::Country(country_data_or_country)
+  def self.Country(country_data_or_country)
     case country_data_or_country
     when ISO3166::Country
       country_data_or_country
@@ -15,9 +17,6 @@ module ISO3166
   end
 
   module CountryClassMethods
-    FIND_BY_REGEX = /^find_(all_)?(country_|countries_)?by_(.+)/
-    SEARCH_TERM_FILTER_REGEX = /\(|\)|\[\]|,/
-
     def new(country_data)
       super if country_data.is_a?(Hash) || codes.include?(country_data.to_s.upcase)
     end
@@ -33,10 +32,6 @@ module ISO3166
 
     alias countries all
 
-    def all_translated(locale = 'en')
-      translations(locale).values
-    end
-
     def all_names_with_codes(locale = 'en')
       Country.all.map do |c|
         lc = (c.translation(locale) || c.iso_short_name)
@@ -50,64 +45,23 @@ module ISO3166
       end
     end
 
+    def all_translated(locale = 'en')
+      translations(locale).values
+    end
+
     def translations(locale = 'en')
-      i18n_data_countries = I18nData.countries(locale.upcase)
+      locale = locale.downcase
+      file_path = ISO3166::Data.datafile_path(%W[locales #{locale}.json])
+      translations = JSON.parse(File.read(file_path))
 
-      custom_countries = (ISO3166::Data.codes - i18n_data_countries.keys).map do |code|
+      custom_countries = {}
+      (ISO3166::Data.codes - ISO3166::Data.loaded_codes).each do |code|
         country = ISO3166::Country[code]
         translation = country.translations[locale] || country.iso_short_name
-        [code, translation]
-      end.to_h
-
-      i18n_data_countries.merge(custom_countries)
-    end
-
-    def search(query)
-      country = new(query.to_s.upcase)
-      country && country.valid? ? country : nil
-    end
-
-    def [](query)
-      search(query)
-    end
-
-    def method_missing(method_name, *arguments)
-      matches = method_name.to_s.match(FIND_BY_REGEX)
-      return_all = matches[1]
-      super unless matches
-
-      if matches[3] == 'names'
-        if RUBY_VERSION =~ /^3\.\d\.\d/
-          warn "DEPRECATION WARNING: 'find_by_name' and 'find_*_by_name' methods are deprecated, please refer to the README file for more information on this change.", uplevel: 1, category: :deprecated
-        else
-          warn "DEPRECATION WARNING: 'find_by_name' and 'find_*_by_name' methods are deprecated, please refer to the README file for more information on this change.", uplevel: 1
-        end
+        custom_countries[code] = translation
       end
 
-      countries = find_by(matches[3], arguments[0], matches[2])
-      return_all ? countries : countries.last
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      matches = method_name.to_s.match(FIND_BY_REGEX)
-      if matches && matches[3]
-        instance_methods.include?(matches[3].to_sym)
-      else
-        super
-      end
-    end
-
-    def find_all_by(attribute, val)
-      attributes, lookup_value = parse_attributes(attribute, val)
-
-      ISO3166::Data.cache.select do |_, v|
-        country = Country.new(v)
-        attributes.any? do |attr|
-          Array(country.send(attr)).any? do |n|
-            lookup_value === cached(n) { parse_value(n) }
-          end
-        end
-      end
+      translations.merge(custom_countries)
     end
 
     def subdivisions(alpha2)
@@ -117,58 +71,20 @@ module ISO3166
 
     def create_subdivisions(subdivision_data)
       subdivision_data.each_with_object({}) do |(k, v), hash|
-        data = v.merge('code' => k.to_s)
-        hash[k] = Subdivision.new(data)
+        hash[k] = Subdivision.new(v)
       end
     end
 
     protected
 
-    def strip_accents(v)
-      if v.is_a?(Regexp)
-        Regexp.new(v.source.unaccent, 'i')
+    def strip_accents(string)
+      if string.is_a?(Regexp)
+        Regexp.new(string.source.unaccent, 'i')
       else
-        v.to_s.unaccent.downcase
+        string.to_s.unaccent.downcase
       end
     end
 
-    def parse_attributes(attribute, val)
-      raise "Invalid attribute name '#{attribute}'" unless searchable_attribute?(attribute.to_sym)
-
-      attributes = Array(attribute.to_s)
-      if attribute.to_s == 'name'
-        if RUBY_VERSION =~ /^3\.\d\.\d/
-          warn "DEPRECATION WARNING: 'find_by_name' and 'find_*_by_name' methods are deprecated, please refer to the README file for more information on this change.", uplevel: 1, category: :deprecated
-        else
-          warn "DEPRECATION WARNING: 'find_by_name' and 'find_*_by_name' methods are deprecated, please refer to the README file for more information on this change.", uplevel: 1
-        end
-        # 'find_by_name' and 'find_*_by_name' will be changed for 5.0
-        # The addition of 'iso_short_name' here ensures the behaviour of 4.1 is kept for 4.2
-        attributes = %w[iso_short_name unofficial_names translated_names]
-      end
-
-      [attributes, parse_value(val)]
-    end
-
-    def searchable_attribute?(attribute)
-      searchable_attributes.include?(attribute.to_sym)
-    end
-
-    def searchable_attributes
-      instance_methods - UNSEARCHABLE_METHODS
-    end
-
-    def find_by(attribute, value, obj = nil)
-      find_all_by(attribute.downcase, value).map do |country|
-        obj.nil? ? country : new(country.last)
-      end
-    end
-
-    def parse_value(value)
-      value = value.gsub(SEARCH_TERM_FILTER_REGEX, '') if value.respond_to?(:gsub)
-      strip_accents(value)
-    end
-
     def subdivision_data(alpha2)
       file = subdivision_file_path(alpha2)
       File.exist?(file) ? YAML.load_file(file) : {}
@@ -190,6 +106,7 @@ module ISO3166
     def cached(value)
       @_parsed_values_cache ||= {}
       return @_parsed_values_cache[value] if @_parsed_values_cache[value]
+
       @_parsed_values_cache[value] = yield
     end
   end

data/lib/countries/country/currency_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'money'
 
 module ISO3166

data/lib/countries/country/emoji.rb

@@ -1,5 +1,4 @@
-#!/bin/env ruby
-# encoding: utf-8
+# frozen_string_literal: true
 
 module ISO3166
   module Emoji
@@ -36,7 +35,7 @@ module ISO3166
     #
     # The emoji flag for this country, using Unicode Regional Indicator characters. e.g: "U+1F1FA U+1F1F8" for 🇺🇸
     def emoji_flag
-      alpha2.downcase.chars.map { |c| CODE_POINTS[c] }.join('')
+      alpha2.downcase.chars.map { |c| CODE_POINTS[c] }.join
     end
   end
 end

data/lib/countries/country/finder_methods.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module ISO3166
+  module CountryFinderMethods
+    FIND_BY_REGEX = /^find_(all_)?(country_|countries_)?by_(.+)/.freeze
+    SEARCH_TERM_FILTER_REGEX = /\(|\)|\[\]|,/.freeze
+
+    def search(query)
+      country = new(query.to_s.upcase)
+      country&.valid? ? country : nil
+    end
+
+    def [](query)
+      search(query)
+    end
+
+    def find_all_by(attribute, val)
+      attributes, lookup_value = parse_attributes(attribute, val)
+
+      ISO3166::Data.cache.select do |_, v|
+        country = Country.new(v)
+        attributes.any? do |attr|
+          Array(country.send(attr)).any? do |n|
+            lookup_value === cached(n) { parse_value(n) }
+          end
+        end
+      end
+    end
+
+    def method_missing(method_name, *arguments)
+      matches = method_name.to_s.match(FIND_BY_REGEX)
+      return_all = matches[1]
+      super unless matches
+
+      countries = find_by(matches[3], arguments[0], matches[2])
+      return_all ? countries : countries.last
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      matches = method_name.to_s.match(FIND_BY_REGEX)
+      if matches && matches[3]
+        instance_methods.include?(matches[3].to_sym)
+      else
+        super
+      end
+    end
+
+    protected
+
+    def find_by(attribute, value, obj = nil)
+      find_all_by(attribute.downcase, value).map do |country|
+        obj.nil? ? country : new(country.last)
+      end
+    end
+
+    def parse_attributes(attribute, val)
+      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, parse_value(val)]
+    end
+
+    def parse_value(value)
+      value = value.gsub(SEARCH_TERM_FILTER_REGEX, '') if value.respond_to?(:gsub)
+      strip_accents(value)
+    end
+
+    def searchable_attribute?(attribute)
+      searchable_attributes.include?(attribute.to_sym)
+    end
+
+    def searchable_attributes
+      # Add name and names until we complete the deprecation of the finders
+      instance_methods - UNSEARCHABLE_METHODS + [:name, :names, :any_name]
+    end
+  end
+end

data/lib/countries/country.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module ISO3166
   class Country
     extend CountryClassMethods
+    extend CountryFinderMethods
     include Emoji
     attr_reader :data
 
@@ -31,24 +34,6 @@ module ISO3166
     alias zip_format postal_code_format
     alias languages languages_official
 
-    def latitude_dec
-      if RUBY_VERSION =~ /^3\.\d\.\d/
-        warn "DEPRECATION WARNING: The Country#latitude_dec method has been deprecated and will be removed in 5.0. Please use Country#latitude instead.", uplevel: 1, category: :deprecated
-      else
-        warn "DEPRECATION WARNING: The Country#latitude_dec method has been deprecated and will be removed in 5.0. Please use Country#latitude instead.", uplevel: 1
-      end
-      latitude
-    end
-
-    def longitude_dec
-      if RUBY_VERSION =~ /^3\.\d\.\d/
-        warn "DEPRECATION WARNING: The Country#longitude_dec method has been deprecated and will be removed in 5.0. Please use Country#longitude instead.", uplevel: 1, category: :deprecated
-      else
-        warn "DEPRECATION WARNING: The Country#longitude_dec method has been deprecated and will be removed in 5.0. Please use Country#longitude instead.", uplevel: 1
-      end
-      longitude
-    end
-
     def ==(other)
       other.respond_to?(:alpha2) && other.alpha2 == alpha2
     end
@@ -79,13 +64,41 @@ module ISO3166
                         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] }
     end
 
-    alias states subdivisions
+    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
 
     # +true+ if this country is a member of the European Union.
     def in_eu?
@@ -136,28 +149,6 @@ module ISO3166
       @local_name ||= local_names.first
     end
 
-    # @return [String] This Country's ISO Short Name
-    # @deprecated Use {#iso_short_name} instead.
-    def name
-      if RUBY_VERSION =~ /^3\.\d\.\d/
-        warn "DEPRECATION WARNING: The Country#name method has been deprecated. Please use Country#iso_short_name instead or refer to the README file for more information on this change.", uplevel: 1, category: :deprecated
-      else
-        warn "DEPRECATION WARNING: The Country#name method has been deprecated. Please use Country#iso_short_name instead or refer to the README file for more information on this change.", uplevel: 1
-      end
-      iso_short_name
-    end
-
-    # @return [Array<String>] Array of unofficial, slang names or aliases for this Country
-    # @deprecated Use {#unofficial_names} instead.
-    def names
-      if RUBY_VERSION =~ /^3\.\d\.\d/
-        warn "DEPRECATION WARNING: The Country#names method has been deprecated. Please use Country#unofficial_names instead or refer to the README file for more information on this change.", uplevel: 1, category: :deprecated
-      else
-        warn "DEPRECATION WARNING: The Country#names method has been deprecated. Please use Country#unofficial_names instead or refer to the README file for more information on this change.", uplevel: 1
-      end
-      unofficial_names
-    end
-
     # @!attribute alpha2
     #   @return [String] the ISO3166 alpha-2 code for this Country
     #
@@ -242,8 +233,6 @@ module ISO3166
     # @!attribute world_region
     #   @return [String] The "World Region" this country is in: +"AMER"+ , +"APAC"+ or +"EMEA"+
 
-
-
     private
 
     def reload

data/lib/countries/data/countries/KN.yaml

@@ -9,7 +9,6 @@ KN:
   geo:
     latitude: 17.357822
     longitude: -62.782998
-    longitude_dec: "-62.643184661865234"
     max_latitude: 17.4205891
     max_longitude: -62.52369989999999
     min_latitude: 17.07861

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

@@ -1,7 +1,7 @@
 ---
 '02':
   name: Canillo
-  code:
+  code: '02'
   unofficial_names: Canillo
   geo:
     latitude: 42.5666535
@@ -13,9 +13,10 @@
   translations:
     en: Canillo
   comments:
+  type: parish
 '03':
   name: Encamp
-  code:
+  code: '03'
   unofficial_names: Encamp
   geo:
     latitude: 42.5362652
@@ -27,9 +28,10 @@
   translations:
     en: Encamp
   comments:
+  type: parish
 '04':
   name: La Massana
-  code:
+  code: '04'
   unofficial_names: La Massana
   geo:
     latitude: 42.545625
@@ -41,9 +43,10 @@
   translations:
     en: La Massana
   comments:
+  type: parish
 '05':
   name: Ordino
-  code:
+  code: '05'
   unofficial_names: Ordino
   geo:
     latitude: 42.5556547
@@ -55,9 +58,10 @@
   translations:
     en: Ordino
   comments:
+  type: parish
 '06':
   name: Sant Julià de Lòria
-  code:
+  code: '06'
   unofficial_names:
   - Saint Julia de Loria
   geo:
@@ -70,9 +74,10 @@
   translations:
     en: Sant Julià de Lòria
   comments:
+  type: parish
 '07':
   name: Andorra la Vella
-  code:
+  code: '07'
   unofficial_names:
   - Andorra la Vieja
   - Andorre-la-Vieille
@@ -86,9 +91,10 @@
   translations:
     en: Andorra la Vella
   comments:
+  type: parish
 '08':
   name: Escaldes-Engordany
-  code:
+  code: '08'
   unofficial_names:
   - Les Escaldes
   geo:
@@ -101,3 +107,4 @@
   translations:
     en: Escaldes-Engordany
   comments:
+  type: parish

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

@@ -1,7 +1,7 @@
 ---
 AJ:
   name: "'Ajmān"
-  code:
+  code: AJ
   unofficial_names: "-إمارة عجمانّ - Ujman"
   geo:
     latitude: 25.3995
@@ -74,9 +74,10 @@ AJ:
     'no': Emiratet Ajman
     yo_BJ: Ajman
   comments:
+  type: emirate
 AZ:
   name: Abū Z̧aby [Abu Dhabi]
-  code:
+  code: AZ
   unofficial_names:
   - أبو ظبي
   - Abu Zabi
@@ -157,9 +158,10 @@ AZ:
     mk: Абу Даби
     'no': Emiratet Abu Dhabi
   comments:
+  type: emirate
 DU:
   name: Dubayy
-  code:
+  code: DU
   unofficial_names:
   - دبي
   - Dubai
@@ -232,9 +234,10 @@ DU:
     bs: Dubai
     'no': Emiratet Dubai
   comments:
+  type: emirate
 FU:
   name: Al Fujayrah
-  code:
+  code: FU
   unofficial_names:
   - الفجيرة
   - Al Fujayrah
@@ -309,9 +312,10 @@ FU:
     'no': Emiratet Fujairah
     yo_BJ: Fujairah
   comments:
+  type: emirate
 RK:
   name: Ra's al Khaymah
-  code:
+  code: RK
   unofficial_names:
   - إمارة رأس الخيمة
   - Ras al-Khaimah
@@ -385,9 +389,10 @@ RK:
     'no': Emiratet Ras al-Khaimah
     yo_BJ: Ras al Khaimah
   comments:
+  type: emirate
 SH:
   name: Ash Shariqah [Sharjah]
-  code:
+  code: SH
   unofficial_names:
   - إمارة الشارقةّ
   - Ash Shariqah
@@ -462,9 +467,10 @@ SH:
     'no': Emiratet Sharjah
     yo_BJ: Sharjah
   comments:
+  type: emirate
 UQ:
   name: Umm al Qaywayn
-  code:
+  code: UQ
   unofficial_names:
   - أمّ القيوين
   - Umm al-Quwain
@@ -537,3 +543,4 @@ UQ:
     'no': Emiratet Umm al-Qaiwain
     yo_BJ: Um Al Quwain
   comments:
+  type: emirate