country_select 2.1.1 → 8.0.1

data/lib/country_select/country_select_helper.rb

@@ -6,6 +6,11 @@ module ActionView
           html_options = options
           options = priority_or_options
         else
+          if RUBY_VERSION =~ /^3\.\d\.\d/
+            warn "DEPRECATION WARNING: Setting priority countries with the 1.x syntax is deprecated. Please use the `priority_countries:` option.", uplevel: 1, category: :deprecated
+          else
+            warn "DEPRECATION WARNING: Setting priority countries with the 1.x syntax is deprecated. Please use the `priority_countries:` option.", uplevel: 1
+          end
           options[:priority_countries] = priority_or_options
         end
 

data/lib/country_select/defaults.rb

@@ -0,0 +1,11 @@
+module CountrySelect
+  DEFAULTS = {
+    except: nil,
+    format: :default,
+    locale: nil,
+    only: nil,
+    priority_countries: nil,
+    priority_countries_divider: "-" * 15,
+    sort_provided: true
+  }
+end

data/lib/country_select/formats.rb

@@ -2,6 +2,8 @@ module CountrySelect
   FORMATS = {}
 
   FORMATS[:default] = lambda do |country|
-    country.translations[I18n.locale.to_s] || country.name
+    # Need to use :[] specifically, not :dig, because country.translations is a
+    # ISO3166::Translations object, which overrides :[] to support i18n locale fallbacks
+    country.translations&.send(:[], I18n.locale.to_s) || country.common_name || country.iso_short_name
   end
 end

data/lib/country_select/tag_helper.rb

@@ -2,20 +2,30 @@ module CountrySelect
   class CountryNotFoundError < StandardError;end
   module TagHelper
     def country_option_tags
+      # In Rails 5.2+, `value` accepts no arguments and must also be called
+      # with parens to avoid the local variable of the same name
+      # https://github.com/rails/rails/pull/29791
+      selected_option = @options.fetch(:selected) do
+        if self.method(:value).arity == 0
+          value()
+        else
+          value(@object)
+        end
+      end
+
       option_tags_options = {
-        :selected => @options.fetch(:selected) { value(@object) },
+        :selected => selected_option,
         :disabled => @options[:disabled]
       }
 
       if priority_countries.present?
-        priority_countries_options = country_options_for(priority_countries, false)
+        priority_countries_options = country_options_for(priority_countries, @options.fetch(:sort_provided, ::CountrySelect::DEFAULTS[:sort_provided]))
 
         option_tags = options_for_select(priority_countries_options, option_tags_options)
         option_tags += html_safe_newline + options_for_select([priority_countries_divider], disabled: priority_countries_divider)
 
-        if priority_countries.include?(option_tags_options[:selected])
-          option_tags_options[:selected] = nil
-        end
+        option_tags_options[:selected] = [option_tags_options[:selected]] unless option_tags_options[:selected].kind_of?(Array)
+        option_tags_options[:selected].delete_if{|selected| priority_countries_options.map(&:second).include?(selected)}
 
         option_tags += html_safe_newline + options_for_select(country_options, option_tags_options)
       else
@@ -25,43 +35,42 @@ module CountrySelect
 
     private
     def locale
-      @options[:locale]
+      @options.fetch(:locale, ::CountrySelect::DEFAULTS[:locale])
     end
 
     def priority_countries
-      @options[:priority_countries]
+      @options.fetch(:priority_countries, ::CountrySelect::DEFAULTS[:priority_countries])
     end
 
     def priority_countries_divider
-      @options[:priority_countries_divider] || "-"*15
+      @options.fetch(:priority_countries_divider, ::CountrySelect::DEFAULTS[:priority_countries_divider])
     end
 
     def only_country_codes
-      @options[:only]
+      @options.fetch(:only, ::CountrySelect::DEFAULTS[:only])
     end
 
     def except_country_codes
-      @options[:except]
+      @options.fetch(:except, ::CountrySelect::DEFAULTS[:except])
     end
 
     def format
-      @options[:format] || :default
+      @options.fetch(:format, ::CountrySelect::DEFAULTS[:format])
     end
 
     def country_options
-      country_options_for(all_country_codes, true)
-    end
-
-    def all_country_codes
-      codes = ISO3166::Country.all.map(&:last)
-
       if only_country_codes.present?
-        codes & only_country_codes
+        codes = only_country_codes & ISO3166::Country.codes
+        sort = @options.fetch(:sort_provided, ::CountrySelect::DEFAULTS[:sort_provided])
       elsif except_country_codes.present?
-        codes - except_country_codes
+        codes = ISO3166::Country.codes - except_country_codes
+        sort = true
       else
-        codes
+        codes = ISO3166::Country.codes
+        sort = true
       end
+
+      country_options_for(codes, sort)
     end
 
     def country_options_for(country_codes, sorted=true)
@@ -69,22 +78,30 @@ module CountrySelect
         country_list = country_codes.map do |code_or_name|
           if country = ISO3166::Country.new(code_or_name)
             code = country.alpha2
-          elsif country = ISO3166::Country.find_by_name(code_or_name)
-            code = country.first
+          elsif country = ISO3166::Country.find_country_by_any_name(code_or_name)
+            code = country.alpha2
           end
 
-          country = ISO3166::Country.new(code)
-
           unless country.present?
             msg = "Could not find Country with string '#{code_or_name}'"
             raise CountryNotFoundError.new(msg)
           end
 
-          name = ::CountrySelect::FORMATS[format].call(country)
+          formatted_country = ::CountrySelect::FORMATS[format].call(country)
+
+          if formatted_country.is_a?(Array)
+            formatted_country
+          else
+            [formatted_country, code]
+          end
 
-          [name,code]
         end
-        sorted ? country_list.sort : country_list
+
+        if sorted
+          country_list.sort_by { |name, code| [I18n.transliterate(name), name] }
+        else
+          country_list
+        end
       end
     end
 
@@ -93,4 +110,3 @@ module CountrySelect
     end
   end
 end
-

data/lib/country_select/version.rb

@@ -1,3 +1,3 @@
 module CountrySelect
-  VERSION = "2.1.1"
+  VERSION = '8.0.1'
 end

data/lib/country_select.rb

@@ -1,13 +1,9 @@
 # encoding: utf-8
 
-require 'iso3166'
+require 'countries'
 
 require 'country_select/version'
+require 'country_select/defaults'
 require 'country_select/formats'
 require 'country_select/tag_helper'
-
-if defined?(ActionView::Helpers::Tags::Base)
-  require 'country_select/country_select_helper'
-else
-  require 'country_select/rails3/country_select_helper'
-end
+require 'country_select/country_select_helper'

data/spec/country_select_spec.rb

@@ -9,12 +9,18 @@ describe "CountrySelect" do
   include ActionView::Helpers::TagHelper
   include ActionView::Helpers::FormOptionsHelper
 
+  before do
+    I18n.available_locales = [:en]
+    I18n.locale = :en
+    ISO3166.reset
+  end
+
   class Walrus
     attr_accessor :country_code
   end
 
   let(:walrus) { Walrus.new }
-  let!(:template) { ActionView::Base.new }
+  let!(:template) { ActionView::Base.new(ActionView::LookupContext.new([]), {}, nil) }
 
   let(:builder) do
     if defined?(ActionView::Helpers::Tags::Base)
@@ -31,7 +37,7 @@ describe "CountrySelect" do
   end
 
   it "selects the value of country_code" do
-    tag = options_for_select([['United States of America', 'US']], 'US')
+    tag = options_for_select([['United States', 'US']], 'US')
 
     walrus.country_code = 'US'
     t = builder.country_select(:country_code)
@@ -39,6 +45,9 @@ describe "CountrySelect" do
   end
 
   it "uses the locale specified by I18n.locale" do
+    I18n.available_locales = [:en, :es]
+    ISO3166.reset
+
     tag = options_for_select([['Estados Unidos', 'US']], 'US')
 
     walrus.country_code = 'US'
@@ -52,7 +61,27 @@ describe "CountrySelect" do
     end
   end
 
+  it 'falls back when given a country-specific locale' do
+    I18n.available_locales = [:en, :de, :'de-AT']
+    ISO3166.reset
+
+    tag = options_for_select([['Deutschland', 'DE']], 'DE')
+
+    walrus.country_code = 'DE'
+    original_locale = I18n.locale
+    begin
+      I18n.locale = :'de-AT'
+      t = builder.country_select(:country_code)
+      expect(t).to include(tag)
+    ensure
+      I18n.locale = original_locale
+    end
+  end
+
   it "accepts a locale option" do
+    I18n.available_locales = [:fr]
+    ISO3166.reset
+
     tag = options_for_select([['États-Unis', 'US']], 'US')
 
     walrus.country_code = 'US'
@@ -63,9 +92,26 @@ describe "CountrySelect" do
   it "accepts priority countries" do
     tag = options_for_select(
       [
+        ['Denmark', 'DK'],
         ['Latvia','LV'],
-        ['United States of America','US'],
+        ['United States','US'],
+        ['-'*15,'-'*15]
+      ],
+      selected: 'US',
+      disabled: '-'*15
+    )
+
+    walrus.country_code = 'US'
+    t = builder.country_select(:country_code, priority_countries: ['LV','US','DK'])
+    expect(t).to include(tag)
+  end
+
+  it "priority countries are sorted by name by default" do
+    tag = options_for_select(
+      [
         ['Denmark', 'DK'],
+        ['Latvia','LV'],
+        ['United States','US'],
         ['-'*15,'-'*15]
       ],
       selected: 'US',
@@ -77,11 +123,57 @@ describe "CountrySelect" do
     expect(t).to include(tag)
   end
 
-  it "selects only the first matching option" do
-    tag = options_for_select([["United States of America", "US"],["Uruguay", "UY"]], "US")
+  it "priority countries with `sort_provided: false` preserves the provided order" do
+    tag = options_for_select(
+      [
+        ['Latvia','LV'],
+        ['United States','US'],
+        ['Denmark', 'DK'],
+        ['-'*15,'-'*15]
+      ],
+      selected: 'US',
+      disabled: '-'*15
+    )
+
     walrus.country_code = 'US'
-    t = builder.country_select(:country_code, priority_countries: ['LV','US'])
-    expect(t).to_not include(tag)
+    t = builder.country_select(:country_code, priority_countries: ['LV','US','DK'], sort_provided: false)
+    expect(t).to include(tag)
+  end
+
+  it "priority countries with `sort_provided: false` still sorts the non-priority countries by name" do
+    tag = options_for_select(
+      [
+        ['Latvia','LV'],
+        ['United States','US'],
+        ['Denmark', 'DK'],
+        ['-'*15,'-'*15],
+        ['Afghanistan','AF']
+      ],
+      selected: 'AF',
+      disabled: '-'*15
+    )
+
+    walrus.country_code = 'AF'
+    t = builder.country_select(:country_code, priority_countries: ['LV','US','DK'], sort_provided: false)
+    expect(t).to include(tag)
+  end
+
+  describe "when selected options is not an array" do
+    it "selects only the first matching option" do
+      tag = options_for_select([["United States", "US"],["Uruguay", "UY"]], "US")
+      walrus.country_code = 'US'
+      t = builder.country_select(:country_code, priority_countries: ['LV','US'])
+      expect(t).to_not include(tag)
+    end
+  end
+
+  describe "when selected options is an array" do
+    it "selects all options but only once" do
+      walrus.country_code = 'US'
+      t = builder.country_select(:country_code, {priority_countries: ['LV','US','ES'], selected: ['UY', 'US']}, multiple: true)
+      expect(t.scan(options_for_select([["United States", "US"]], "US")).length).to be(1)
+      expect(t.scan(options_for_select([["Uruguay", "UY"]], "UY")).length).to be(1)
+    end
   end
 
   it "displays only the chosen countries" do
@@ -93,19 +185,48 @@ describe "CountrySelect" do
   end
 
   it "discards some countries" do
-    tag = options_for_select([["United States of America", "US"]])
+    tag = options_for_select([["United States", "US"]])
     walrus.country_code = 'DE'
     t = builder.country_select(:country_code, except: ['US'])
     expect(t).to_not include(tag)
   end
 
+  it "countries provided in `only` are sorted by name by default" do
+    t = builder.country_select(:country_code, only: ['PT','DE','AR'])
+    order = t.scan(/value="(\w{2})"/).map { |o| o[0] }
+    expect(order).to eq(['AR', 'DE', 'PT'])
+  end
+
+  it "countries provided in `only` with `sort_provided` to false keeps the order of the provided countries" do
+    t = builder.country_select(:country_code, only: ['PT','DE','AR'], sort_provided: false)
+    order = t.scan(/value="(\w{2})"/).map { |o| o[0] }
+    expect(order).to eq(['PT','DE','AR'])
+  end
+
+  context "when there is a default 'except' configured" do
+    around do |example|
+      old_value = ::CountrySelect::DEFAULTS[:except]
+      example.run
+      ::CountrySelect::DEFAULTS[:except] = old_value
+    end
+
+    it "discards countries when configured to" do
+      ::CountrySelect::DEFAULTS[:except] = ['US']
+
+      tag = options_for_select([['United States', 'US']])
+      walrus.country_code = 'DE'
+      t = builder.country_select(:country_code)
+      expect(t).to_not include(tag)
+    end
+  end
+
   context "using old 1.x syntax" do
     it "accepts priority countries" do
       tag = options_for_select(
         [
-          ['Latvia','LV'],
-          ['United States of America','US'],
           ['Denmark', 'DK'],
+          ['Latvia','LV'],
+          ['United States','US'],
           ['-'*15,'-'*15]
         ],
         selected: 'US',
@@ -118,7 +239,7 @@ describe "CountrySelect" do
     end
 
     it "selects only the first matching option" do
-      tag = options_for_select([["United States of America", "US"],["Uruguay", "UY"]], "US")
+      tag = options_for_select([["United States", "US"],["Uruguay", "UY"]], "US")
       walrus.country_code = 'US'
       t = builder.country_select(:country_code, ['LV','US'])
       expect(t).to_not include(tag)
@@ -129,7 +250,7 @@ describe "CountrySelect" do
         ["Australia", "AU"],
         ["Canada", "CA"],
         ["United Kingdom", "GB"],
-        ["United States of America", "US"]
+        ["United States", "US"]
       ])
       country_names = ["Australia", "Canada", "United Kingdom", "United States"]
       t = builder.country_select(:country_code, country_names)
@@ -143,9 +264,9 @@ describe "CountrySelect" do
         "United Kingdom",
         "Mexico",
         "Australia",
-        "South Korea"
+        "Freedonia"
       ]
-      error_msg = "Could not find Country with string 'South Korea'"
+      error_msg = "Could not find Country with string 'Freedonia'"
 
       expect do
         builder.country_select(:country_code, country_names)
@@ -159,23 +280,69 @@ describe "CountrySelect" do
     end
 
     it "supports the include_blank option" do
-      tag = '<option value=""></option>'
+      # Rails 6.1 more closely follows the HTML spec for
+      # empty option tags.
+      # https://github.com/rails/rails/pull/39808
+      tag = if ActionView::VERSION::STRING >= '6.1'
+              '<option value="" label=" "></option>'
+            else
+              '<option value=""></option>'
+            end
       t = builder.country_select(:country_code, include_blank: true)
       expect(t).to include(tag)
     end
   end
 
+  it 'sorts unicode' do
+    tag = builder.country_select(:country_code, only: ['AX', 'AL', 'AF', 'ZW'])
+    order = tag.scan(/value="(\w{2})"/).map { |o| o[0] }
+    expect(order).to eq(['AF', 'AX', 'AL', 'ZW'])
+  end
+
   describe "custom formats" do
     it "accepts a custom formatter" do
       ::CountrySelect::FORMATS[:with_alpha2] = lambda do |country|
-        "#{country.name} (#{country.alpha2})"
+        "#{country.iso_short_name} (#{country.alpha2})"
       end
 
-      tag = options_for_select([['United States (US)', 'US']], 'US')
+      tag = options_for_select([['United States of America (US)', 'US']], 'US')
 
       walrus.country_code = 'US'
       t = builder.country_select(:country_code, format: :with_alpha2)
       expect(t).to include(tag)
     end
+
+    it "accepts an array for formatter" do
+      ::CountrySelect::FORMATS[:with_alpha3] = lambda do |country|
+        [country.iso_short_name, country.alpha3]
+      end
+
+      tag = options_for_select([['United States of America', 'USA']], 'USA')
+      walrus.country_code = 'USA'
+      t = builder.country_select(:country_code, format: :with_alpha3)
+      expect(t).to include(tag)
+    end
+
+    it "accepts an array for formatter + custom formatter" do
+      ::CountrySelect::FORMATS[:with_alpha3] = lambda do |country|
+        ["#{country.iso_short_name} (#{country.alpha2})", country.alpha3]
+      end
+
+      tag = options_for_select([['United States of America (US)', 'USA']], 'USA')
+      walrus.country_code = 'USA'
+      t = builder.country_select(:country_code, format: :with_alpha3)
+      expect(t).to include(tag)
+    end
+
+    it "marks priority countries as selected only once" do
+      ::CountrySelect::FORMATS[:with_alpha3] = lambda do |country|
+        [country.iso_short_name, country.alpha3]
+      end
+
+      tag = options_for_select([['United States of America', 'USA']], 'USA')
+      walrus.country_code = 'USA'
+      t = builder.country_select(:country_code, format: :with_alpha3, priority_countries: ['US'])
+      expect(t.scan(Regexp.new(Regexp.escape(tag))).size).to eq 1
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: country_select
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 8.0.1
 platform: ruby
 authors:
 - Stefan Penner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2023-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,42 +66,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: wwtd
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: countries
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.3
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.3
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
-description: Provides a simple helper to get an HTML select list of countries.  The
-  list of countries comes from the ISO 3166 standard.  While it is a relatively neutral
+        version: '5.0'
+description: Provides a simple helper to get an HTML select list of countries. The
+  list of countries comes from the ISO 3166 standard. While it is a relatively neutral
   source of country names, it will still offend some users.
 email:
 - stefan.penner@gmail.com
@@ -109,9 +89,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
+- ".github/workflows/codeql-analysis.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -120,29 +101,30 @@ files:
 - Rakefile
 - UPGRADING.md
 - country_select.gemspec
-- gemfiles/actionpack.edge.gemfile
-- gemfiles/actionpack.edge.gemfile.lock
-- gemfiles/actionpack3.2.gemfile
-- gemfiles/actionpack3.2.gemfile.lock
-- gemfiles/actionpack4.0.gemfile
-- gemfiles/actionpack4.0.gemfile.lock
-- gemfiles/actionpack4.1.gemfile
-- gemfiles/actionpack4.1.gemfile.lock
-- gemfiles/actionpack4.2.gemfile
-- gemfiles/actionpack4.2.gemfile.lock
+- gemfiles/actionpack-5.2.gemfile
+- gemfiles/actionpack-5.2.gemfile.lock
+- gemfiles/actionpack-6.0.gemfile
+- gemfiles/actionpack-6.0.gemfile.lock
+- gemfiles/actionpack-6.1.gemfile
+- gemfiles/actionpack-6.1.gemfile.lock
+- gemfiles/actionpack-7.0.gemfile
+- gemfiles/actionpack-7.0.gemfile.lock
 - lib/country_select.rb
 - lib/country_select/country_select_helper.rb
+- lib/country_select/defaults.rb
 - lib/country_select/formats.rb
-- lib/country_select/rails3/country_select_helper.rb
 - lib/country_select/tag_helper.rb
 - lib/country_select/version.rb
 - spec/country_select_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/stefanpenner/country_select
+homepage: https://github.com/countries/country_select
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: http://github.com/countries/country_select/issues
+  changelog_uri: https://github.com/countries/country_select/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/countries/country_select
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,16 +132,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: country_select
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.4.2
+signing_key:
 specification_version: 4
 summary: Country Select Plugin
 test_files: