countries 4.2.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d9b0ecf844c063dc4ce2deeeb02a9fb2832a0640b8ed232b8d2c40ff7061692
-  data.tar.gz: 8969a80a3834eec68f5927dc14aa8470a62c438ec833c8c5a2183e632aabce59
+  metadata.gz: a8a95786ec6321b9d8d1f9b11854cd37d693554a2052a270187a7ee82f8d629b
+  data.tar.gz: 9c360efbd86c1f91526ec28474041255c54d81585c689c8dd1b492c33e7db060
 SHA512:
-  metadata.gz: f1a25098d98189de1f4b74374871559cc78ed42aba67166043d0f9892c8d91a2a8e27c6ab410f26e80a5a02e6bfe79194c4310b3b6e5f7ae0dec61869fdd2ca2
-  data.tar.gz: 3d51bbb186fdda7cc2172d5779d4b4be107ad1295a099894ab8d7f8c6a5b0601a38a03bc8494e017a2234ab081b5b234df913ee94512a6e59d281685c12a09d4
+  metadata.gz: 077e94f77953b21e4d3e59e7830429f9effa3633e310ce682d554f3eeefdf976fc0290a6d1ae9e1ee5f379f3f7abbb8043a1484822ea82473f833f3369b8f9f0
+  data.tar.gz: 7fcdbfc5e27c1eb44e684694da9974000f7d076da9770138c9402ec46866cdd7e52c90141c815559149b7a5fe6e00ee16a2578c6b6f966c5d7bcc5c819840255

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
-           bundler-version: default
-         - ruby-version: 2.6.9
-           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.1
            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,17 @@
 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.0.0] (https://github.com/countries/countries/releases/tag/v5.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
 
@@ -52,10 +54,25 @@ In release 4.2 the `#name` attribute was deprecated in favour of `#iso_short_nam
 
 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.
+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.
@@ -82,7 +99,8 @@ end
 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')
@@ -91,8 +109,7 @@ c    = ISO3166::Country.find_country_by_alpha3('can')
 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 [Upgrading to 4.2 and 5.x](#upgrading-to-4-2-and-5-x) above for the new methods_
 
 ## Country Info
 
@@ -149,7 +166,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)**
 

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rake'
@@ -34,9 +36,10 @@ task :update_cache do
   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')) || {}
+  corrections_file = File.join(File.dirname(__FILE__), 'lib', 'countries', 'data', 'translation_corrections.yaml')
+  corrections = YAML.load_file(corrections_file) || {}
 
-  language_keys = I18nData.languages.keys + ['zh_CN', 'zh_TW', 'zh_HK','bn_IN','pt_BR']
+  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|
@@ -48,40 +51,19 @@ task :update_cache do
     end
 
     # Apply any known corrections to i18n_data
-    unless corrections[locale].nil?
-      corrections[locale].each do |alpha2, localized_name|
-        local_names[alpha2] = localized_name
-      end
+    corrections[locale]&.each do |alpha2, localized_name|
+      local_names[alpha2] = localized_name
     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 }
-  end
-end

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,11 @@ 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