countries 1.2.2 → 4.2.3

data/lib/countries/country.rb

@@ -1,201 +1,257 @@
-module ISO3166; end
-
-class ISO3166::Country
-  Setup = ISO3166::Setup.new
-
-  AttrReaders = [
-    :number,
-    :alpha2,
-    :alpha3,
-    :name,
-    :names,
-    :latitude,
-    :longitude,
-    :continent,
-    :region,
-    :subregion,
-    :world_region,
-    :country_code,
-    :national_destination_code_lengths,
-    :national_number_lengths,
-    :international_prefix,
-    :national_prefix,
-    :address_format,
-    :translations,
-    :translated_names,
-    :ioc,
-    :gec,
-    :un_locode,
-    :languages,
-    :nationality,
-    :dissolved_on,
-    :eu_member,
-    :alt_currency,
-    :vat_rates,
-    :postal_code,
-    :min_longitude,
-    :min_latitude,
-    :max_longitude,
-    :max_latitude,
-    :latitude_dec,
-    :longitude_dec
-  ]
-
-  AttrReaders.each do |meth|
-    define_method meth do
-      @data[meth.to_s]
+module ISO3166
+  class Country
+    extend CountryClassMethods
+    include Emoji
+    attr_reader :data
+
+    ISO3166::DEFAULT_COUNTRY_HASH.each do |method_name, _type|
+      define_method method_name do
+        data[method_name.to_s]
+      end
     end
-  end
-
-  attr_reader :data
-
-  def initialize(country_data)
-    @data = country_data.is_a?(Hash) ? country_data : ISO3166::Data.new(country_data).call
-  end
-
-  def valid?
-    !(@data.nil? || @data.empty?)
-  end
-
-  alias_method :zip, :postal_code
-  alias_method :zip?, :postal_code
-  alias_method :postal_code?, :postal_code
-
-  def ==(other)
-    other == data
-  end
-
-  def <=>(other)
-    to_s <=> other.to_s
-  end
-
-  def currency
-    ISO4217::Currency.from_code(@data['currency'])
-  end
 
-  def currency_code
-    @data['currency']
-  end
+    ISO3166::DEFAULT_COUNTRY_HASH['geo'].each do |method_name, _type|
+      define_method method_name do
+        data['geo'][method_name.to_s]
+      end
+    end
 
-  def subdivisions
-    @subdivisions ||= subdivisions? ? YAML.load_file(File.join(File.dirname(__FILE__), 'data', 'subdivisions', "#{alpha2}.yaml")) : {}
-  end
+    def initialize(country_data)
+      @country_data_or_code = country_data
+      reload
+    end
 
-  alias_method :states, :subdivisions
+    def valid?
+      !(data.nil? || data.empty?)
+    end
 
-  def subdivisions?
-    File.exist?(File.join(File.dirname(__FILE__), 'data', 'subdivisions', "#{alpha2}.yaml"))
-  end
+    alias zip postal_code
+    alias zip? postal_code
+    alias postal_code? postal_code
+    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 in_eu?
-    @data['eu_member'].nil? ? false : @data['eu_member']
-  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 to_s
-    @data['name']
-  end
+    def ==(other)
+      other.respond_to?(:alpha2) && other.alpha2 == alpha2
+    end
 
-  def translation(locale = 'en')
-    @data['translations'][locale.downcase]
-  end
+    def eql?(other)
+      self == other
+    end
 
-  def local_names
-    @local_names ||= languages.map { |language| translations[language] }
-  end
+    def hash
+      [alpha2, alpha3].hash
+    end
 
-  def local_name
-    @local_name ||= local_names.first
-  end
+    def <=>(other)
+      to_s <=> other.to_s
+    end
 
-  class << self
-    def new(country_data)
-      super if country_data.is_a?(Hash) || codes.include?(country_data.to_s.upcase)
+    #  +true+ if this Country has any Subdivisions.
+    def subdivisions?
+      !subdivisions.empty?
     end
 
-    def codes
-      Setup.codes
+    # @return [Array<ISO3166::Subdivision>] the list of subdivisions for this Country.
+    def subdivisions
+      @subdivisions ||= if data['subdivisions']
+                          self.class.create_subdivisions(data['subdivisions'])
+                        else
+                          self.class.subdivisions(alpha2)
+                        end
     end
 
-    def all(&blk)
-      blk ||= proc { |_alpha2, d| ISO3166::Country.new(d) }
-      Setup.data.map(&blk)
+    # @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_method :countries, :all
+    alias states subdivisions
 
-    def all_translated(locale = 'en')
-      translations(locale).values
+    # +true+ if this country is a member of the European Union.
+    def in_eu?
+      data['eu_member'].nil? ? false : data['eu_member']
     end
 
-    def all_names_with_codes(locale = 'en')
-      ISO3166::Country.all.map do |c|
-        [(c.translation(locale) || c.name).html_safe, c.alpha2]
-      end.sort_by { |d| d[0] }
+    # +true+ if this country is a member of the European Economic Area.
+    def in_eea?
+      data['eea_member'].nil? ? false : data['eea_member']
     end
 
-    def translations(locale = 'en')
-      I18nData.countries(locale.upcase)
+    # +true+ if this country is a member of the European Single Market.
+    def in_esm?
+      data['esm_member'].nil? ? in_eea? : data['esm_member']
     end
 
-    def search(query)
-      country = new(query.to_s.upcase)
-      (country && country.valid?) ? country : nil
+    def to_s
+      data['iso_short_name']
     end
 
-    def [](query)
-      search(query)
+    # @return [Array<String>] the list of names for this Country in all loaded locales.
+    def translated_names
+      data['translations'].values
     end
 
-    def method_missing(*m)
-      regex = m.first.to_s.match(/^find_(all_)?(country_|countries_)?by_(.+)/)
-      super unless regex
+    # @param locale [String] The locale to use for translations.
+    # @return [String] the name of this Country in the selected locale.
+    def translation(locale = 'en')
+      data['translations'][locale.to_s.downcase]
+    end
 
-      countries = find_by(Regexp.last_match[3], m[1], Regexp.last_match[2])
-      Regexp.last_match[1] ? countries : countries.last
+    # @return [String] the “common name” of this Country in English.
+    def common_name
+      ISO3166.configuration.locales = ISO3166.configuration.locales.append(:en).uniq
+      translation('en')
     end
 
-    def find_all_by(attribute, val)
-      attributes, value = parse_attributes(attribute, val)
+    # @return [Array<String>] TThe list of names for this Country, in this Country's locales.
+    def local_names
+      ISO3166.configuration.locales = (ISO3166.configuration.locales + languages.map(&:to_sym)).uniq
+      reload
 
-      Setup.data.select do |_, v|
-        attributes.map do |attr|
-          Array(v[attr]).any? { |n| value === n.to_s.downcase }
-        end.include?(true)
-      end
+      @local_names ||= languages.map { |language| translations[language] }
     end
 
-    protected
-
-    def parse_attributes(attribute, val)
-      fail "Invalid attribute name '#{attribute}'" unless instance_methods.include?(attribute.to_sym)
+    # @return [String] The name for this Country, in this Country's locale.
+    def local_name
+      @local_name ||= local_names.first
+    end
 
-      attributes = Array(attribute.to_s)
-      if attributes == ['name']
-        attributes << 'names'
-        # TODO: Revisit when better data from i18n_data
-        # attributes << 'translated_names'
+    # @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
-
-      val = (val.is_a?(Regexp) ? Regexp.new(val.source, 'i') : val.to_s.downcase)
-
-      [attributes, val]
+      iso_short_name
     end
 
-    def find_by(attribute, value, obj = nil)
-      find_all_by(attribute.downcase, value).map do |country|
-        obj.nil? ? country : new(country.last)
+    # @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
-  end
-end
 
-def ISO3166::Country(country_data_or_country)
-  case country_data_or_country
-  when ISO3166::Country
-    country_data_or_country
-  when String, Symbol
-    ISO3166::Country.search(country_data_or_country)
-  else
-    fail TypeError, "can't convert #{country_data_or_country.class.name} into ISO3166::Country"
+    # @!attribute alpha2
+    #   @return [String] the ISO3166 alpha-2 code for this Country
+    #
+    # @!attribute alpha3
+    #   @return [String] the ISO3166 alpha-3 code for this Country
+    #
+    # @!attribute address_format
+    #   @return [String] a template for formatting addresses in this Country.
+    #
+    # @!attribute continent
+    #   @return [String] the continent for this Country
+    #
+    # @!attribute country_code
+    #   @return [String] the country calling code for this Country
+    #
+    # @!attribute currency_code
+    #   @return [String] the ISO 4217 currency code for this Country
+    #
+    # @!attribute gec
+    #   @return [String] the "Geopolitical Entities and Codes", formerly FIPS 10-4 code for this Country
+    #
+    # @!attribute geo
+    #   @return [Hash] the hash of coordinates for this Country.
+    #
+    # @!attribute international_prefix
+    #   @return [String] the phone prefix used in this Country for dialing international numbers
+    #
+    # @!attribute ioc
+    #   @return [String] The International Olympic Committee code for for this Country
+    #
+    # @!attribute national_destination_code_lengths
+    #   @return [Array<Integer>] Lengths of phone number destination codes
+    #
+    # @!attribute national_number_lengths
+    #   @return [Array<Integer>] Lengths of phone numbers
+    #
+    # @!attribute national_prefix
+    #   @return [String] the phone prefix used in this Country for dialing national numbers
+    #
+    # @!attribute nanp_prefix
+    #   @return [String] the NANP prefix code
+    #
+    # @!attribute nationality
+    #   @return [String] the nationality for this Country, in English
+    #
+    # @!attribute number
+    #   @return [String] The ISO 3166-1 numeric code for this Country
+    #
+    # @!attribute languages_official
+    #   @return [Array<String>] the list of official languages (locale codes) for this Country
+    #
+    # @!attribute languages_spoken
+    #   @return [Array<String>] the list of spoken languages (locale codes) for this Country
+    #
+    # @!attribute translations
+    #   @return [Hash] The hash of country name translations for this Country.
+    #
+    # @!attribute postal_code
+    #   @return [Boolean] Does this Country uses postal codes in addresses
+    #
+    # @!attribute postal_code_format
+    #   @return [String] The regex for valid postal codes in this Country
+    #
+    # @!attribute region
+    #   @return [String] The Region this country is in. Approximately matches the United Nations geoscheme
+    #
+    # @!attribute unofficial_names
+    #   @return [Array<String>] Array of unofficial, slang names or aliases for this Country
+    #
+    # @!attribute start_of_week
+    # @return [String] The starting day of the week ( +'monday'+ or +'sunday'+ )
+    #
+    # @!attribute subregion
+    #   @return [String] The Subegion this country is in. Approximately matches the United Nations geoscheme's Subregions
+    #
+    # @!attribute un_locode
+    #   @return [String] The UN/LOCODE prefix for this Country
+    #
+    # @!attribute vat_rates
+    #   @return [Hash] the hash of VAT Rates for this Country
+    #
+    # @!attribute world_region
+    #   @return [String] The "World Region" this country is in: +"AMER"+ , +"APAC"+ or +"EMEA"+
+
+
+
+    private
+
+    def reload
+      @data = if @country_data_or_code.is_a?(Hash)
+                @country_data_or_code
+              else
+                ISO3166::Data.new(@country_data_or_code).call
+              end
+    end
   end
 end

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

@@ -1,20 +1,33 @@
 ---
 AD:
-  continent: Europe
   alpha2: AD
   alpha3: AND
+  continent: Europe
   country_code: '376'
-  currency: EUR
+  currency_code: EUR
+  gec: AN
+  geo:
+    latitude: 42.506285
+    longitude: 1.521801
+    max_latitude: 42.655791
+    max_longitude: 1.786639
+    min_latitude: 42.4287488
+    min_longitude: 1.4087052
+    bounds:
+      northeast:
+        lat: 42.655791
+        lng: 1.786639
+      southwest:
+        lat: 42.4287488
+        lng: 1.4087052
   international_prefix: '00'
   ioc: AND
-  gec: AN
-  latitude: 42 30 N
-  longitude: 1 30 E
-  name: Andorra
-  names:
-  - Andorre
-  - Andorra
-  - "アンドラ"
+  iso_long_name: The Principality of Andorra
+  iso_short_name: Andorra
+  languages_official:
+  - ca
+  languages_spoken:
+  - ca
   national_destination_code_lengths:
   - 2
   national_number_lengths:
@@ -23,18 +36,16 @@ AD:
   - 8
   - 9
   national_prefix: None
+  nationality: Andorran
   number: '020'
+  postal_code: true
+  postal_code_format: AD[1-7]0\d
   region: Europe
+  start_of_week: monday
   subregion: Southern Europe
-  world_region: EMEA
   un_locode: AD
-  languages:
-  - ca
-  nationality: Andorran
-  postal_code: true
-  min_longitude: '1.416667'
-  min_latitude: '42.433333'
-  max_longitude: '1.783333'
-  max_latitude: '42.65'
-  latitude_dec: '42.5506591796875'
-  longitude_dec: '1.5762332677841187'
+  unofficial_names:
+  - Andorre
+  - Andorra
+  - アンドラ
+  world_region: EMEA

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

@@ -1,6 +1,5 @@
 ---
 AE:
-  continent: Asia
   address_format: |-
     {{recipient}}
     {{street}}
@@ -8,22 +7,32 @@ AE:
     {{country}}
   alpha2: AE
   alpha3: ARE
+  continent: Asia
   country_code: '971'
-  currency: AED
+  currency_code: AED
+  gec: AE
+  geo:
+    latitude: 23.424076
+    longitude: 53.847818
+    max_latitude: 26.0765
+    max_longitude: 56.4395001
+    min_latitude: 22.6315138
+    min_longitude: 51.4723
+    bounds:
+      northeast:
+        lat: 26.0765
+        lng: 56.4395001
+      southwest:
+        lat: 22.6315138
+        lng: 51.4723
   international_prefix: '00'
   ioc: UAE
-  gec: AE
-  latitude: 24 00 N
-  longitude: 54 00 E
-  name: United Arab Emirates
-  names:
-  - United Arab Emirates
-  - "الإمارات العربية المتحدة"
-  - Vereinigte Arabische Emirate
-  - "Émirats Arabes Unis"
-  - Emiratos Árabes Unidos
-  - "アラブ首長国連邦"
-  - Verenigde Arabische Emiraten
+  iso_long_name: The United Arab Emirates
+  iso_short_name: United Arab Emirates
+  languages_official:
+  - ar
+  languages_spoken:
+  - ar
   national_destination_code_lengths:
   - 2
   national_number_lengths:
@@ -31,18 +40,24 @@ AE:
   - 8
   - 9
   national_prefix: '0'
+  nationality: Emirian
   number: '784'
+  postal_code: false
   region: Asia
+  start_of_week: monday
   subregion: Western Asia
-  world_region: EMEA
   un_locode: AE
-  languages:
-  - ar
-  nationality: Emirian
-  postal_code: false
-  min_longitude: '45'
-  min_latitude: '22.166667'
-  max_longitude: '58'
-  max_latitude: '26.133333'
-  latitude_dec: '23.684776306152344'
-  longitude_dec: '54.536643981933594'
+  unofficial_names:
+  - United Arab Emirates
+  - الإمارات العربية المتحدة
+  - Vereinigte Arabische Emirate
+  - Émirats Arabes Unis
+  - Emiratos Árabes Unidos
+  - アラブ首長国連邦
+  - Verenigde Arabische Emiraten
+  vat_rates:
+    standard: 5
+    reduced: []
+    super_reduced:
+    parking:
+  world_region: EMEA

data/lib/countries/data/countries/AF.yaml

@@ -1,40 +1,53 @@
 ---
 AF:
-  continent: Asia
   alpha2: AF
   alpha3: AFG
+  continent: Asia
   country_code: '93'
-  currency: AFN
+  currency_code: AFN
+  gec: AF
+  geo:
+    latitude: 33.93911
+    longitude: 67.709953
+    max_latitude: 38.49087670000001
+    max_longitude: 74.8898619
+    min_latitude: 29.3772
+    min_longitude: 60.5170005
+    bounds:
+      northeast:
+        lat: 38.49087670000001
+        lng: 74.8898619
+      southwest:
+        lat: 29.3772
+        lng: 60.5170005
   international_prefix: '00'
   ioc: AFG
-  gec: AF
-  latitude: 33 00 N
-  longitude: 65 00 E
-  name: Afghanistan
-  names:
-  - Afghanistan
-  - Afganistán
-  - "アフガニスタン"
+  iso_long_name: The Islamic Republic of Afghanistan
+  iso_short_name: Afghanistan
+  languages_official:
+  - ps
+  - uz
+  - tk
+  languages_spoken:
+  - ps
+  - uz
+  - tk
   national_destination_code_lengths:
   - 2
   national_number_lengths:
   - 8
   - 9
   national_prefix: '0'
+  nationality: Afghan
   number: '004'
+  postal_code: true
+  postal_code_format: "\\d{4}"
   region: Asia
+  start_of_week: monday
   subregion: Southern Asia
-  world_region: APAC
   un_locode: AF
-  languages:
-  - ps
-  - uz
-  - tk
-  nationality: Afghan
-  postal_code: true
-  min_longitude: '60.566667'
-  min_latitude: '29.383333'
-  max_longitude: '74.8868713067'
-  max_latitude: '38.483611'
-  latitude_dec: '33.833248138427734'
-  longitude_dec: '66.02528381347656'
+  unofficial_names:
+  - Afghanistan
+  - Afganistán
+  - アフガニスタン
+  world_region: APAC