countries 5.0.1 → 5.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f4c18c20a21b358c31c0453a13252eb30f5b9aff3b2fc09803b83ab42bbc434
-  data.tar.gz: a7b7997ff12a290673f51e3b672dd501fb0f42e9a02c17a0c2c75c92a593be27
+  metadata.gz: b239f5f25018bc1ba87fd49d3b1b8adfad49b7e24e4e17a2793aa886d1cd4c59
+  data.tar.gz: a6fc5738ec1c281a68efd1109d6763ad08a6082e63c2d400b7216d862b7e823a
 SHA512:
-  metadata.gz: 23ffc95eb8c0584db74fc5cdebc3965020c5047784fc5e18b8a1064dc61e28a3962e4d32516fff593652ce8ae5c0fdfd05e3ac6389f975ca7777cc1f1399f978
-  data.tar.gz: 5a749c3c933871d1716102959bcbd6a96f0f5207317267a645cdbac1dddc4daff0e66701bc735c605ad0cf3a53b7c2e0f54564ae84bf504b0b1b9d45408190f9
+  metadata.gz: da2b9eeb20881a037dffc3c0280405deac1d1be3c9ed01be1fe5bbb9ff1f8ace189ee97803371080e07df93118b3dd982bb67349f745252d2e7e411c14a90517
+  data.tar.gz: 1044da2ddbf3ec28d3676d480185f7ad6d370ac81dd9d2e07e77f637110db3a9d0689128072a273785aedf7b6b33b2aa9550d6417cd567cf371d375b40bdcaf8

data/CHANGELOG.md

@@ -3,14 +3,53 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
-## [5.0.1] (https://github.com/countries/countries/releases/tag/v5.0.1') (2022/05/02 12:03 +00:00)
+## [5.1.2](https://github.com/countries/countries/releases/tag/v5.1.1') (2022/08/11 14:35 +00:00)
+
+* Missing unofficial translations, addresses the remaining translations in [\#580](https://github.com/countries/countries/issues/580) -  [\#764](https://github.com/countries/countries/pull/764) ([pmor](https://github.com/pmor))
+
+
+## [5.1.1](https://github.com/countries/countries/releases/tag/v5.1.1') (2022/07/18 09:10 +00:00)
+
+**Important changes**
+
+- Subdivision loading now respects the configured locales and will only load subdivision translations for the configured locales instead of loading all translations. This fixes [\#580](https://github.com/countries/countries/issues/580)
+
+**Merged pull requests:**
+
+* Refactor subdivision loading to respect the configured locales. [\#762](https://github.com/countries/countries/pull/762) ([pmor](https://github.com/pmor))
+* Add an alternative name for USVI lookup [\#763](https://github.com/countries/countries/pull/763) ([tadejm](https://github.com/tadejm))
+
+
+## [5.1.0](https://github.com/countries/countries/releases/tag/v5.1.0') (2022/06/27 07:50 +00:00)
+
+**Important changes**
+
+- `Subdivision` now has a `type` attribute obtained from ISO3166-2 subdivision types. `type` is a _lowercase_ and _snake_cased_ string.
+- Adds `Country#subdivision_types` and `#humanized_subdivision_types` to list a country's subdivision types
+- Adds `Country#subdivisions_of_types(types)` to allow getting subdivisions of given type(s)
+- `Country#states` is now deprecated to avoid confusion (this method was just an alias to `#subdivisions` and retuns all subdivisions, regarless of type)
+
+**Merged pull requests:**
+
+* Remove i18n_data dependency [\#755](https://github.com/countries/countries/pull/755) ([pmor](https://github.com/pmor))
+* Update subdivision YAML with codes [\#757](https://github.com/countries/countries/pull/757) ([pmor](https://github.com/pmor))
+* Add subdivision types from ISO3166-2 [\#758](https://github.com/countries/countries/pull/758) ([pmor](https://github.com/pmor))
+
+## [5.0.2](https://github.com/countries/countries/releases/tag/v5.0.2') (2022/06/02 20:01 +00:00)
+
+**Merged pull requests:**
+
+* Fix common name for IR [\#754](https://github.com/countries/countries/pull/754) ([pmor](https://github.com/pmor))
+* Update MX subdivisions: Remove DIF and update some unofficial names [\#755](https://github.com/countries/countries/pull/755) ([pmor](https://github.com/pmor))
+
+## [5.0.1](https://github.com/countries/countries/releases/tag/v5.0.1') (2022/05/02 12:03 +00:00)
 
 **Merged pull requests:**
 
 * Added subdivision_names_with_codes method in documentation [\#747](https://github.com/countries/countries/pull/747) ([arymoraes](https://github.com/arymoraes))
-* Corrected Portuguese subdivision names by @FilipaDurao in [\#748](https://github.com/countries/countries/pull/748) ([FilipaDurao](https://github.com/FilipaDurao))
+* Corrected Portuguese subdivision names [\#748](https://github.com/countries/countries/pull/748) ([FilipaDurao](https://github.com/FilipaDurao))
 
-## [5.0.0] (https://github.com/countries/countries/releases/tag/v5.0.0') (2022/04/03 17:44 +00:00)
+## [5.0.0](https://github.com/countries/countries/releases/tag/v5.0.0') (2022/04/03 17:44 +00:00)
 
 **Breaking Changes**
 

data/README.markdown

@@ -48,51 +48,11 @@ gem 'countries', require: 'countries/global'
 
 ## Upgrading to 4.2 and 5.x
 
-In release 4.2 the `#name` attribute was deprecated in favour of `#iso_short_name` and we added the `#iso_long_name` attribute, to make it clear that these attributes use the ISO3166 names, and are not the "common names" most people might expect, eg: The ISO name for "United Kingdom" is "United Kingdom of Great Britain and Northern Ireland", but if you're building a dropdown box to select a country, you're likely expecting to see "United Kingdom" instead.
+Release 4.2.0 introduced changes to name attributes and finders and deprecated several methods to resolve some existing confusion regardign official ISO country names vs. the "common names" that are commonly used.
 
-"Common names" in English have been available in the translation data, via `#translation('en')`. As of release 4.2, a shortcut method has been added for simplicity, `#common_name`, which delegates to `#translation('en')`.
+The 5.0 release removed these deprecated methods and also removed support for Ruby 2.5 and 2.6
 
-For additional clarity, the `#names` method, which was an alias to `#unofficial_names` has also been deprecated, together with the finder methods that use `name` or `names` attributes.
-
-The `#name` and `#names` attributes, and corresponding finder methods were removed in 5.0.
-
-The replacement finders added in 5.0 are:
-
-- `#find_by_name` => `#find_by_any_name` - Searches all the name attributes, same as before
-- `#find_by_names` => `#find_by_unofficial_names`
-- `#find_*_by_name` => `#find_*_by_any_name`
-- `#find_*_by_names` => `#find_*_by_unofficial_names`
-
-With the addition of the new name attributes, there are now also the following finders:
-
-- `#find_by_common_name`/`#find_*_by_common_name`
-- `#find_by_iso_short_name`/`#find_*_by_iso_short_name`
-- `#find_by_iso_long_name`/`#find_*_by_iso_long_name`
-
-For translated country names, we use data from [pkg-isocodes](https://salsa.debian.org/iso-codes-team/iso-codes), via the [i18n_data](https://github.com/grosser/i18n_data) gem, and these generally correspond to the expected "common names". These names and the corresponding methods have not been changed.
-
-The 5.0 release removed support for Ruby 2.5 (EOL 2021-03-01) and 2.6 (EOL 2022-03-31)
-
-## Selective Loading of Locales
-
-As of 2.0 you can selectively load locales to reduce memory usage in production.
-
-By default we load `I18n.available_locales` if I18n is present, otherwise only `[:en]`. This means almost any Rails environment will only bring in its supported translations.
-
-You can add all the locales like this.
-
-```ruby
-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]
-end
-```
-
-or something a bit more simple
-```ruby
-ISO3166.configure do |config|
-  config.locales = [:en, :de, :fr, :es]
-end
-```
+Plase see [UPGRADE.md](../master/UPGRADE.md) for more information
 
 ## Attribute-Based Finder Methods
 
@@ -103,13 +63,13 @@ c    = ISO3166::Country.find_country_by_iso_short_name('italy')
 c    = ISO3166::Country.find_country_by_any_name('united states')
 h    = ISO3166::Country.find_all_by(:translated_names, 'França')
 list = ISO3166::Country.find_all_countries_by_region('Americas')
-c    = ISO3166::Country.find_country_by_alpha3('can')
+c    = ISO3166::Country.find_country_by_alpha2("FR")
 ```
 
 For a list of available attributes please see `ISO3166::DEFAULT_COUNTRY_HASH`.
 Note: searches are *case insensitive and ignore accents*.
 
-_Please note that `find_by_name`, `find_by_names`, `find_*_by_name` and `find_*_by_names`  methods were removed in 5.0. See [Upgrading to 4.2 and 5.x](#upgrading-to-4-2-and-5-x) above for the new methods_
+_Please note that `find_by_name`, `find_by_names`, `find_*_by_name` and `find_*_by_names`  methods were removed in 5.0. See [UPGRADE.md](../blob/master/UPGRADE.md) for more information_
 
 ## Country Info
 
@@ -139,10 +99,11 @@ c.local_name # => "België"
 c.translation('de') # => 'Vereinigte Staaten von Amerika'
 c.translations['fr'] # => "États-Unis"
 
+# Get all translations for a locale, defaults to 'en'
 ISO3166::Country.translations         # {"DE"=>"Germany",...}
-ISO3166::Country.translations('DE')   # {"DE"=>"Deutschland",...}
+ISO3166::Country.translations('de')   # {"DE"=>"Deutschland",...}
 ISO3166::Country.all_translated       # ['Germany', ...]
-ISO3166::Country.all_translated('DE') # ['Deutschland', ...]
+ISO3166::Country.all_translated('de') # ['Deutschland', ...]
 
 # Nationality
 c.nationality # => "American"
@@ -152,8 +113,14 @@ c.nationality # => "American"
 
 ```ruby
 c.subdivisions # => {"CO" => {"name" => "Colorado", "names" => "Colorado"}, ... }
+c.subdivision_types # => ["state", "outlying_area", "district"]
+c.subdivisions_of_types(['state']) # => {"CO" => {"name" => "Colorado", "names" => "Colorado"}, ... }
+c.humanized_subdivision_types # => ["State", "Outlying area", "District"]
+
+# This is now deprecated. #states is an alias of #subdivisions and returns all subdivisions regardless of type
 c.states # => {"CO" => {"name" => "Colorado", "names" => "Colorado"}, ... }
 
+
 # Get specific translations for the country subdivisions
 c.subdivision_names_with_codes('es') #=> [ ..., ["Nuevo Hampshire", "NH"], ["Nueva Jersey", "NJ"], ... ]
 ```
@@ -218,13 +185,19 @@ c.in_eu? # => false
 c.in_eea? # => false
 ```
 
-
 ### European Single Market Membership
 
 ```ruby
 c.in_esm? # => false
 ```
 
+## Country Code in Emoji
+
+```ruby
+c = Country['MY']
+c.emoji_flag # => "🇲🇾"
+```
+
 ### Plucking multiple attributes
 
 ```ruby
@@ -262,6 +235,30 @@ A template for formatting addresses is available through the address_format meth
 c.address_format # => "{{recipient}}\n{{street}}\n{{city}} {{region}} {{postalcode}}\n{{country}}"
 ```
 
+## Selective Loading of Locales
+
+As of 2.0 you can selectively load locales to reduce memory usage in production.
+
+By default we load `I18n.available_locales` if I18n is present, otherwise only `[:en]`. This means almost any Rails environment will only bring in its supported translations.
+
+You can add all the locales like this.
+
+```ruby
+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]
+end
+```
+
+or something a bit more simple
+```ruby
+ISO3166.configure do |config|
+  config.locales = [:en, :de, :fr, :es]
+end
+```
+
+If you change the value of `ISO3166.configuration.locales` after initialization, you should call `ISO3166::Data.reset` to reset the data cache, or you may end up with inconsistently loaded locales.
+As of 5.1.1, subdivision translations also respect this and will only load the selected locales.
+
 ## Loading Custom Data
 
 As of 2.0 countries supports loading custom countries / overriding data in its data set, though if you choose to do this please contribute back to the upstream repo!
@@ -327,32 +324,11 @@ def country
 end
 ```
 
-## Country Code in Emoji
-
-```ruby
-c = Country['MY']
-c.emoji_flag # => "🇲🇾"
-```
-
 ## Note on Patches/Pull Requests
 
-### Please do not submit pull requests on `cache/**/*`
-
-Any additions should be directed upstream to [pkg-isocodes](https://salsa.debian.org/iso-codes-team/iso-codes)
-
-Localized country name data is sourced from https://github.com/grosser/i18n_data (which is based on https://salsa.debian.org/iso-codes-team/iso-codes/). Issues regarding localized country names can be reported to https://github.com/grosser/i18n_data/issues or https://salsa.debian.org/iso-codes-team/iso-codes/issues
-If you need to correct an upstream translation please add it to the lib/countries/data/translations_corrections.yaml
-
-```
-# Ex:
-#
-# locale:
-#   alpha2: localized_name
-#
-```
+**Please do not submit pull requests on `cache/**/*`**. These files generated by a rake task when preparing new releases and are not meant to be manually updated.
 
-Any corrections can be applied in translations_corrections.yaml these will be injected during
-the next `rake update_cache`.
+If you with to submit a PR to correct an translation, please edit the `lib/countries/data/translations/countries-<locale>.yaml` file. Changes to the locale YAML files will be injected during the next `rake update_cache`.
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -361,12 +337,13 @@ the next `rake update_cache`.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but
    bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* Make sure your you haven't made changes to `cache/**/*`
+* Submit a pull request. Bonus points for topic branches.
 
 ## Copyright
 
-Copyright (c) 2012-2015 hexorx
-Copyright (c) 2015-2021 hexorx, rposborne
+Copyright (c) 2012-2015 hexorx \
+Copyright (c) 2015-2021 hexorx, rposborne \
 Copyright (c) 2022 hexorx, rposborne, pmor
 
 See LICENSE for details.

data/Rakefile

@@ -30,30 +30,12 @@ end
 
 desc 'Update Cache'
 task :update_cache do
-  require 'yaml'
-  require 'i18n_data'
-
   codes = Dir['lib/countries/data/countries/*.yaml'].map { |x| File.basename(x, File.extname(x)) }.uniq.sort
   data = {}
 
-  corrections_file = File.join(File.dirname(__FILE__), 'lib', 'countries', 'data', 'translation_corrections.yaml')
-  corrections = YAML.load_file(corrections_file) || {}
-
-  language_keys = I18nData.languages.keys + %w[zh_CN zh_TW zh_HK bn_IN pt_BR]
-  # Ignore locales that have bad data in i18n_data 0.16.0
-  language_keys -= %w[AY AM BA]
-  language_keys.each do |locale|
-    locale = locale.downcase
-    begin
-      local_names = I18nData.countries(locale)
-    rescue I18nData::NoTranslationAvailable
-      next
-    end
-
-    # Apply any known corrections to i18n_data
-    corrections[locale]&.each do |alpha2, localized_name|
-      local_names[alpha2] = localized_name
-    end
+  Dir['lib/countries/data/translations/countries-*.yaml'].each do |locale_file|
+    locale = locale_file.split('-').last.split('.').first.downcase
+    local_names = YAML.load_file(locale_file)
 
     out = File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'locales', "#{locale.gsub(/_/, '-')}.json")
     File.binwrite(out, local_names.to_json)
@@ -67,3 +49,15 @@ task :update_cache do
   out_file = File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'countries.json')
   File.binwrite(out_file, data.to_json)
 end
+
+desc 'Sort subdivision YAML by code and translations by locale'
+task :cleanup_subdivision_yaml do
+  ISO3166::Country.codes.each do |c_code|
+    sd = Sources::Local::Subdivision.new(c_code)
+    data = sd.load
+    next if data.nil? || data == {}
+    data = data.sort.to_h
+    data['translations'] = data['translations'].sort.to_h unless data['translations'].nil?
+    sd.save(data)
+  end
+end

data/UPGRADE.md

@@ -0,0 +1,39 @@
+# Upgrading to 4.2 and 5.x
+
+In release 4.2 the `#name` attribute was deprecated in favour of `#iso_short_name` and we added the `#iso_long_name` attribute, to make it clear that these attributes use the ISO3166 names, and are not the "common names" most people might expect, eg: The ISO name for "United Kingdom" is "United Kingdom of Great Britain and Northern Ireland", but if you're building a dropdown box to select a country, you're likely expecting to see "United Kingdom" instead.
+
+"Common names" in English have been available in the translation data, via `#translation('en')`. As of release 4.2, a shortcut method has been added for simplicity, `#common_name`, which delegates to `#translation('en')`.
+
+For additional clarity, the `#names` method, which was an alias to `#unofficial_names` has also been deprecated, together with the finder methods that use `name` or `names` attributes.
+
+The `#name` and `#names` attributes, and corresponding finder methods were removed in 5.0.
+
+The replacement finders added in 5.0 are:
+
+- `#find_by_name` => `#find_by_any_name` - Searches all the name attributes, same as before
+- `#find_by_names` => `#find_by_unofficial_names`
+- `#find_*_by_name` => `#find_*_by_any_name`
+- `#find_*_by_names` => `#find_*_by_unofficial_names`
+
+With the addition of the new name attributes, there are now also the following finders:
+
+- `#find_by_common_name`/`#find_*_by_common_name`
+- `#find_by_iso_short_name`/`#find_*_by_iso_short_name`
+- `#find_by_iso_long_name`/`#find_*_by_iso_long_name`
+
+For translated country names, we use data originally sourced from [pkg-isocodes](https://salsa.debian.org/iso-codes-team/iso-codes), via the [i18n_data](https://github.com/grosser/i18n_data) gem, and these generally correspond to the expected "common names". Some corrections have been applied to these localized names. The methods to access translated names have not been changed.
+
+The 5.0 release removed support for Ruby 2.5 (EOL 2021-03-01) and 2.6 (EOL 2022-03-31)
+
+# Upgrading to 5.1
+
+In release 5.1 a `type` attribute was added to the subdivisions object, to allow filtering the collection of subdivisions.
+
+- `Country#subdivision_types` returns a list of subdivision types for that country (lowercase, snake_cased)
+- `#subdivisions_of_types(types)` accepts an array of subdivision types and returns the subdivisions for those types
+
+The `#states` method is deprecated to avoid confusion, as this method is an alias to `#subdivisions` and returns all subdivisions, regardless of type.
+
+To get a list of `state` subdivisions (something that was not possible before 5.1), use `subdivisions_of_types(['state'])`
+
+Please note that the subdivision types are obtained from ISO data, and each country defines its own subdivision types, eg: `state`, `district`, `region`, `municipality` and many others types exist.

data/countries.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.7'
 
-  gem.add_dependency('i18n_data', '~> 0.16.0')
   gem.add_dependency('sixarm_ruby_unaccent', '~> 1.1')
   gem.add_development_dependency('activesupport', '>= 3')
   gem.add_development_dependency('nokogiri', '>= 1.8')