countries 5.0.2 → 5.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baeec795ef76c0171afb436d9371e30837e0eef7290642e36ae9ac96a99d02aa
-  data.tar.gz: e621054ef6fa804e1116a0ac79fbaf6251a32181bd4941c9028b9fcf0a9c6b19
+  metadata.gz: b239f5f25018bc1ba87fd49d3b1b8adfad49b7e24e4e17a2793aa886d1cd4c59
+  data.tar.gz: a6fc5738ec1c281a68efd1109d6763ad08a6082e63c2d400b7216d862b7e823a
 SHA512:
-  metadata.gz: 388d84578afe4d7c8fd5e31dbfa0827e0a1ed2f63aee0f4ebd59da436200268ffa23af28952351474c47bd51ac4d6bfe1ea798353987da9ec1e6e31dce1da2af
-  data.tar.gz: a610bd578f9ceba72e04353c1edb69d4f93b23ba4ad398f1280b86959b4d19ef079c30df102b715097755136b32926d3e5ffdd48176e032fd05047303390e84d
+  metadata.gz: da2b9eeb20881a037dffc3c0280405deac1d1be3c9ed01be1fe5bbb9ff1f8ace189ee97803371080e07df93118b3dd982bb67349f745252d2e7e411c14a90517
+  data.tar.gz: 1044da2ddbf3ec28d3676d480185f7ad6d370ac81dd9d2e07e77f637110db3a9d0689128072a273785aedf7b6b33b2aa9550d6417cd567cf371d375b40bdcaf8

data/CHANGELOG.md

@@ -3,6 +3,38 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
+## [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:**

data/README.markdown

@@ -99,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"
@@ -112,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"], ... ]
 ```
@@ -249,6 +256,9 @@ ISO3166.configure do |config|
 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!
@@ -318,10 +328,7 @@ end
 
 **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.
 
-Localized country name data is sourced from the [i18n_data](https://github.com/grosser/i18n_data) gem (which is based on [pkg-isocodes](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`, and they 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.
@@ -335,6 +342,8 @@ If you need to correct an upstream translation please add it to the `lib/countri
 
 ## Copyright
 
-Copyright (c) 2012-2015 hexorx; 2015-2021 hexorx, rposborne; 2022 hexorx, rposborne, pmor
+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

@@ -21,6 +21,19 @@ With the addition of the new name attributes, there are now also the following f
 - `#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.
+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)
+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')