countries 4.2.3 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d9b0ecf844c063dc4ce2deeeb02a9fb2832a0640b8ed232b8d2c40ff7061692
-  data.tar.gz: 8969a80a3834eec68f5927dc14aa8470a62c438ec833c8c5a2183e632aabce59
+  metadata.gz: 73f88c0991bcb5bf2b2d08014ae66f04adb368b856d1cd084928549b282e7b33
+  data.tar.gz: f2edba4b8014c85a4e5c263635bbb04d1f8b03d11a91814d08e009705f94e0d4
 SHA512:
-  metadata.gz: f1a25098d98189de1f4b74374871559cc78ed42aba67166043d0f9892c8d91a2a8e27c6ab410f26e80a5a02e6bfe79194c4310b3b6e5f7ae0dec61869fdd2ca2
-  data.tar.gz: 3d51bbb186fdda7cc2172d5779d4b4be107ad1295a099894ab8d7f8c6a5b0601a38a03bc8494e017a2234ab081b5b234df913ee94512a6e59d281685c12a09d4
+  metadata.gz: 9ebd72d36cd13b11979325ef5f69535c6a3665a2763ca8920570e13d93feae05fd4e319698207f44d89fecb29daf3db5f56c875705d0e65d9c7c4560a84b75ee
+  data.tar.gz: 69d70fdc81b89ffcc128931ead30b874e1d24660e2a9db59d120f6ad46cdec7a6657823abc5abe8ee107564b7cb52d49f38fc05800cdd0704ea8eebe9f12fb7a

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '19 13 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/tests.yml

@@ -15,15 +15,11 @@ jobs:
     strategy:
       matrix:
          include:
-         - ruby-version: 2.5.9
+         - ruby-version: 2.7.6
            bundler-version: default
-         - ruby-version: 2.6.9
+         - ruby-version: 3.0.4
            bundler-version: default
-         - ruby-version: 2.7.5
-           bundler-version: default
-         - ruby-version: 3.0.3
-           bundler-version: default
-         - ruby-version: 3.1.0
+         - ruby-version: 3.1.2
            bundler-version: default
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1 +1,40 @@
-inherit_from: .rubocop_todo.yml
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Exclude:
+    - countries.gemspec
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - Rakefile
+    - 'spec/**/*'
+    - 'lib/countries/tasks/*'
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/CaseEquality:
+  Exclude:
+    - 'lib/countries/country/finder_methods.rb'
+
+Style/IfUnlessModifier:
+  Exclude:
+    - 'spec/thread_safety_spec.rb'
+
+Naming/MethodName:
+  Exclude:
+    - 'lib/countries/country/class_methods.rb'
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/perf_spec.rb'
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 130

data/.rubocop_todo.yml

@@ -1,52 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-09-19 23:29:07 -0400 using RuboCop version 0.43.0.
+# on 2022-01-07 11:03:11 UTC using RuboCop version 1.24.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 101
 
-# Offense count: 64
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 483
 
-# Offense count: 1
+# Offense count: 3
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 19
+  Max: 33
 
-# Offense count: 1
-Style/CaseEquality:
-  Exclude:
-    - 'lib/countries/country/class_methods.rb'
-
-# Offense count: 7
-Style/ClassVars:
-  Exclude:
-    - 'lib/countries/data.rb'
-
-# Offense count: 9
+# Enable after the doc branch is merged
 Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/countries/configuration.rb'
-    - 'lib/countries/country.rb'
-    - 'lib/countries/country/class_methods.rb'
-    - 'lib/countries/country/emoji.rb'
-    - 'lib/countries/global.rb'
-    - 'lib/countries/kwarg_struct.rb'
-    - 'lib/countries/mongoid.rb'
-
-
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: snake_case, camelCase
-Style/MethodName:
-  Exclude:
-    - 'lib/countries/country/class_methods.rb'
+  Enabled: false
+  # Exclude:
+  #   - 'spec/**/*'

data/CHANGELOG.md

@@ -3,12 +3,45 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
-## [Future 5.0 release]
+## [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 [\#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)
 
 **Breaking Changes**
 
-- Drop support for Ruby 2.5 and 2.6 [\#708](https://github.com/countries/countries/pull/708) ([pmor](https://github.com/pmor))
+- Drop support for Ruby 2.5 and 2.6. (EOL in 2021-03-31 and 2022-03-31, respectively)
+- Remove deprecated attributes and add new `#find_by_any_name` finder, see https://github.com/countries/countries#upgrading-to-42-and-5x for details
+
+**Merged pull requests:**
 
+- Drop support for Ruby 2.5 and 2.6 [\#708](https://github.com/countries/countries/pull/708) ([pmor](https://github.com/pmor))
+- Remove deprecated attributes; Add new `#find_by_any_name` finder [\#745](https://github.com/countries/countries/pull/708) ([pmor](https://github.com/pmor))
 
 ## [4.2.3](https://github.com/countries/countries/releases/tag/v4.2.2) (2022/03/24 11:00 +00:00)
 

data/Gemfile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
-gem 'rake'
 gem 'geocoder'
+gem 'money'
+gem 'rake'
 gem 'retryable'
 gem 'tzinfo'
-gem 'money'
 
 # Specify your gem's dependencies in countries.gemspec
 gemspec
@@ -11,4 +13,4 @@ gemspec
 group :development, :test do
   gem 'pry'
   gem 'yaml'
-end
+end

data/README.markdown

@@ -3,6 +3,8 @@
 Countries is a collection of all sorts of useful information for every country in the ISO 3166 standard. It contains info for the following standards ISO3166-1 (countries), ISO3166-2 (states/subdivisions), ISO4217 (currency) and E.164 (phone numbers). I will add any country based data I can get access to. I hope this to be a repository for all country based information.
 
 [![Gem Version](https://badge.fury.io/rb/countries.svg)](https://badge.fury.io/rb/countries) [![Tests](https://github.com/countries/countries/actions/workflows/tests.yml/badge.svg)](https://github.com/countries/countries/actions/workflows/tests.yml) [![Code Climate](https://codeclimate.com/github/countries/countries.svg)](https://codeclimate.com/github/countries/countries)
+ [![CodeQL](https://github.com/countries/countries/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/countries/countries/actions/workflows/codeql-analysis.yml)
+
 
 ## Installation
 
@@ -46,53 +48,28 @@ 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.
-
-"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 will be removed in 5.0.
-
-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.
-
-## 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.
+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.
 
-You can add all the locales like this.
+The 5.0 release removed these deprecated methods and also removed support for Ruby 2.5 and 2.6
 
-```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
 
 You can lookup a country or an array of countries using any of the data attributes via the find\_country\_by_*attribute* dynamic methods:
 
 ```ruby
-c    = ISO3166::Country.find_country_by_iso_short_name('united states')
+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 are deprecated and will be removed in 5.0. See [Upgrading to 4.2 and 5.x](#upgrading-to-4-2-and-5-x) above_
-
+_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
 
@@ -122,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"
@@ -135,7 +113,16 @@ 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"], ... ]
 ```
 
 ### Location
@@ -149,7 +136,7 @@ c.region # => "Americas"
 c.subregion # => "Northern America"
 ```
 
-Please note that `latitude_dec` and `longitude_dec` was be deprecated on release 4.2 and will be deleted in 5.0. These attributes have been redundant for several years, since the `latitude` and `longitude` fields have been switched decimal coordinates.
+Please note that `latitude_dec` and `longitude_dec` were deprecated on release 4.2 and removed in 5.0. These attributes have been redundant for several years, since the `latitude` and `longitude` fields have been switched decimal coordinates.
 
 ### Timezones **(optional)**
 
@@ -198,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
@@ -242,6 +235,27 @@ 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
+```
+
 ## 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!
@@ -307,32 +321,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.
@@ -341,12 +334,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

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rake'
@@ -28,60 +30,34 @@ 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 = YAML.load_file(File.join(File.dirname(__FILE__), 'lib', 'countries', 'data', 'translation_corrections.yaml')) || {}
-
-  language_keys = I18nData.languages.keys + ['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
+  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)
 
-    # Apply any known corrections to i18n_data
-    unless corrections[locale].nil?
-      corrections[locale].each do |alpha2, localized_name|
-        local_names[alpha2] = localized_name
-      end
-    end
-
-    File.open(File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'locales', "#{locale.gsub(/_/, '-')}.json"), 'wb') { |f| f.write(local_names.to_json) }
+    out = File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'locales', "#{locale.gsub(/_/, '-')}.json")
+    File.binwrite(out, local_names.to_json)
   end
 
   codes.each do |alpha2|
-    data[alpha2] ||= YAML.load_file(File.join(File.dirname(__FILE__), 'lib', 'countries', 'data', 'countries', "#{alpha2}.yaml"))[alpha2]
+    country_file = File.join(File.dirname(__FILE__), 'lib', 'countries', 'data', 'countries', "#{alpha2}.yaml")
+    data[alpha2] ||= YAML.load_file(country_file)[alpha2]
   end
 
-  File.open(File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'countries.json'), 'wb') { |f| f.write(data.to_json) }
+  out_file = File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'countries.json')
+  File.binwrite(out_file, data.to_json)
 end
 
-# Temporary task to update YAML file structure with iso_long_name and iso_short_name attributes
-task :update_iso_names do
-  require 'csv'
-  isodata = CSV.read 'isonames.csv', headers: true
-
-  d = Dir['lib/countries/data/countries/*.yaml']
-  d.each do |file|
-    puts "checking : #{file}"
-    data = YAML.load_file(file)
-
-    country_code = data.keys.first
-    iso_country = isodata.find {|c| c['cc'] == country_code}
-
-    data.values.first['iso_long_name'] = iso_country['iso_full_name']
-    data.values.first['iso_short_name'] = data.values.first.delete('name')
-
-    data[country_code.upcase] = data[country_code.upcase].sort.to_h
-
-    File.open(file, 'w') { |f| f.write data.to_yaml }
+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
+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/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'countries'

data/countries.gemspec

@@ -1,5 +1,6 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/countries/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/countries/version', __dir__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ['Josh Robinson', 'Joe Corcoran', 'Russell Osborne', 'Pedro Moreira']
@@ -10,7 +11,8 @@ Gem::Specification.new do |gem|
   gem.metadata      = { 'bug_tracker_uri' => 'https://github.com/countries/countries/issues',
                         'changelog_uri' => 'https://github.com/countries/countries/blob/master/CHANGELOG.md',
                         'source_code_uri' => 'https://github.com/countries/countries',
-                        'wiki_uri' => 'https://github.com/countries/countries/wiki'}
+                        'wiki_uri' => 'https://github.com/countries/countries/wiki',
+                        'rubygems_mfa_required' => 'true' }
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
@@ -19,11 +21,10 @@ Gem::Specification.new do |gem|
   gem.version       = Countries::VERSION.dup
   gem.license       = 'MIT'
 
-  gem.required_ruby_version = '>= 2.5'
+  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('rspec', '>= 3')
   gem.add_development_dependency('activesupport', '>= 3')
   gem.add_development_dependency('nokogiri', '>= 1.8')
+  gem.add_development_dependency('rspec', '>= 3')
 end