country_select 1.2.0 → 4.0.0

data/README.md

@@ -1,19 +1,21 @@
 # Rails – Country Select
-[![Build Status](https://travis-ci.org/stefanpenner/country_select.png?branch=master)](https://travis-ci.org/stefanpenner/country_select)
+[![Build Status](https://travis-ci.org/stefanpenner/country_select.svg)](https://travis-ci.org/stefanpenner/country_select)
 
 Provides a simple helper to get an HTML select list of countries using the
 [ISO 3166-1 standard](https://en.wikipedia.org/wiki/ISO_3166-1).
 
-It is also configurable to use countries'
-[ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
-as values and
-[ISO 3166-1 names](https://en.wikipedia.org/wiki/ISO_3166-1)
-as display strings.
-
 While the ISO 3166 standard is a relatively neutral source of country
 names, it may still offend some users. Developers are strongly advised
 to evaluate the suitability of this list given their user base.
 
+## UPGRADING
+
+[**An important message about upgrading from 1.x**](UPGRADING.md)
+
+## Reporting issues
+
+Open an issue on the [issue tracker](https://github.com/stefanpenner/country_select/issues/new). Ideally provide versions used, and code example that demonstrates the issue.
+
 ## Installation
 
 Install as a gem using
@@ -24,10 +26,24 @@ gem install country_select
 Or put the following in your Gemfile
 
 ```ruby
-gem 'country_select'
+gem 'country_select', '~> 4.0'
 ```
 
-## Example
+If you don't want to require `sort_alphabetical` (it depends on `unicode_utils` which is known to use lots of memory) you can opt out of using it as follows:
+
+```ruby
+gem 'country_select', require: 'country_select_without_sort_alphabetical'
+```
+
+## Usage
+
+Within `form_for` you can use this select like other form elements:
+
+```ruby
+<%= form_for User.new, url: root_url do |f| %>
+  <%= f.country_select :country_code %>
+<% end %>
+```
 
 Simple use supplying model and attribute as parameters:
 
@@ -38,50 +54,147 @@ country_select("user", "country")
 Supplying priority countries to be placed at the top of the list:
 
 ```ruby
-country_select("user", "country", [ "Great Britain", "France", "Germany" ])
+country_select("user", "country", priority_countries: ["GB", "FR", "DE"])
 ```
 
-### Using ISO 3166-1 alpha-2 codes as values
-You can have the `option` tags use ISO 3166-1 alpha-2 codes as values
-and the country names as display strings. For example, the United States
-would appear as `<option value="us">United States</option>`
+Supplying only certain countries:
 
-If you're starting a new project, this is the recommended way to store
-your country data since it will be more resistant to country names
-changing.
+```ruby
+country_select("user", "country", only: ["GB", "FR", "DE"])
+```
+
+Discarding certain countries:
 
 ```ruby
-country_select("user", "country_code", nil, iso_codes: true)
+country_select("user", "country", except: ["GB", "FR", "DE"])
 ```
 
+Pre-selecting a particular country:
+
 ```ruby
-country_select("user", "country_code", [ "gb", "fr", "de" ], iso_codes: true)
+country_select("user", "country", selected: "GB")
 ```
 
-#### Getting the Country from ISO codes
+Changing the divider when priority_countries is active.
+```ruby
+country_select("user", "country", priority_countries: ["AR", "US"], priority_countries_divider: "~~~~~~")
+```
+
+Using existing `select` options:
+```ruby
+country_select("user", "country", include_blank: true)
+country_select("user", "country", { include_blank: 'Select a country' }, { class: 'country-select-box' })
+```
+
+Supplying additional html options:
+
+```ruby
+country_select("user", "country", { priority_countries: ["GB", "FR"], selected: "GB" }, { class: 'form-control', data: { attribute: "value" } })
+```
+
+### Using a custom formatter
+
+You can define a custom formatter which will receive an
+[`ISO3166::Country`](https://github.com/hexorx/countries/blob/master/lib/countries/country.rb)
+```ruby
+# config/initializers/country_select.rb
+
+# Return a string to customize the text in the <option> tag, `value` attribute will remain unchanged
+CountrySelect::FORMATS[:with_alpha2] = lambda do |country|
+  "#{country.name} (#{country.alpha2})"
+end
+
+# Return an array to customize <option> text, `value` and other HTML attributes
+CountrySelect::FORMATS[:with_data_attrs] = lambda do |country|
+  [
+    country.name,
+    country.alpha2,
+    {
+      'data-country-code' => country.country_code,
+      'data-alpha3' => country.alpha3
+    }
+  ]
+end
+```
+
+```ruby
+country_select("user", "country", format: :with_alpha2)
+country_select("user", "country", format: :with_data_attrs)
+```
+
+### ISO 3166-1 alpha-2 codes
+The `option` tags use ISO 3166-1 alpha-2 codes as values and the country
+names as display strings. For example, the United States would appear as
+`<option value="US">United States of America</option>`
+
+Country names are automatically localized based on the value of
+`I18n.locale` thanks to the wonderful
+[countries gem](https://github.com/hexorx/countries/).
+
+Current translations include:
+
+  * en
+  * de
+  * es
+  * fr
+  * it
+  * ja
+  * nl
+
+In the event a translation is not available, it will revert to the
+globally assigned locale (by default, "en").
+
+This is the only way to use `country_select` as of version `2.0`. It
+is the recommended way to store your country data since it will be
+resistant to country names changing.
+
+The locale can be overridden locally:
+
+```ruby
+country_select("user", "country_code", locale: 'es')
+```
+
+#### Getting the Country Name from the countries gem
 
 ```ruby
 class User < ActiveRecord::Base
 
   # Assuming country_select is used with User attribute `country_code`
+  # This will attempt to translate the country name and use the default
+  # (usually English) name if no translation is available
   def country_name
-    ::CountrySelect::COUNTRIES[country_code]
+    country = ISO3166::Country[country_code]
+    country.translations[I18n.locale.to_s] || country.name
   end
 
 end
 ```
 
-## Tests
+## Example Application
+
+An example Rails application demonstrating the different options is
+available at [scudco/country_select_test](https://github.com/scudco/country_select_test).
+The relevant view files live [here](https://github.com/scudco/country_select_test/tree/master/app/views/welcome).
+
+## Contributing
+
+### Tests
 
 ```shell
 bundle
-bundle exec rspec
+bundle exec rake
 ```
 
-### Running with multiple versions of actionpack
+### Updating gemfiles
+The default rake task will run the tests against multiple versions of
+Rails. That means the gemfiles need occasional updating, especially when
+changing the dependencies in the gemspec.
 
 ```shell
-bundle exec appraisal
+for i in gemfiles/*.gemfile
+do
+BUNDLE_GEMFILE=$i bundle install --no-deployment
+done
 ```
 
 Copyright (c) 2008 Michael Koziarski, released under the MIT license

data/Rakefile

@@ -1,24 +1,10 @@
-require 'rubygems'
 require 'bundler/setup'
+require 'rake'
 require 'bundler/gem_tasks'
 
-require 'appraisal'
+require 'wwtd/tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
-
-namespace :appraisal do
-  desc "Run the given task for a particular integration's appraisals"
-  task :integration do
-    Appraisal::File.each do |appraisal|
-      if RUBY_VERSION < '1.9.3' and appraisal.name  == 'actionpack4.0'
-        # skip rails 4 for ruby < 1.9.3
-      else
-        appraisal.install
-        Appraisal::Command.from_args(appraisal.gemfile_path).run
-      end
-    end
-  end
-end
+task default: "wwtd:local"

data/UPGRADING.md

@@ -0,0 +1,69 @@
+# Upgrading from 1.x
+
+`country_select` 2.0 has brought a few small changes, but these changes
+can have a big impact on existing production systems. Please read these
+points carefully and consider whether upgrading to 2.0 is a good idea.
+
+Please post any implications we may have missed as a GitHub Issue
+or Pull Request.
+
+## ISO codes are always on
+
+If you upgrade to 2.0 and are currently storing countries by the names
+produced by this gem, your setup will break. It is recommended that you
+stick with 1.x until developing a data migration strategy that allows
+you to map your existing country names to country codes.
+
+## i18n country names are always on (when available)
+
+Country names will be generated using `I18n.locale` if a translation
+from the countries gem is available.
+
+## Codes are UPCASED
+
+The official ISO 3166-1 standard uses UPCASED codes. This is an easy
+data change, but may affect areas of code dependent on lowercase country
+codes.
+
+Here's a sample SQL migration that could address a `users` table with
+lowercased country codes stored in the `country_code` column:
+
+```sql
+UPDATE users SET country_code = UPPER(country_code);
+```
+
+## Priority countries are now in the options hash
+
+The priority countries syntax has changed from
+
+```ruby
+  country_select(:user, :country_code, ["GB","FR"])
+```
+
+to
+
+```ruby
+  country_select(:user, :country_code, priority_countries: ["GB","FR"])
+```
+
+### A note on 1.x Syntax
+
+In order to seamlessly support popular libraries dependent on
+`country_select`, specifically `formatstic` and `simple_form`, 1.x
+priority syntax is still supported, but will probably be removed in the
+next major release (i.e., 3.0). We'll be working with `simple_form` and
+`formtastic` maintainers to transition away from the old 1.x syntax.
+
+## You can choose to only display a chosen set of countries
+
+```ruby
+  country_select(:user, :country_code, only: ["LV","SG"])
+```
+
+```ruby
+  country_select(:user, :country_code, except: ["US","GB"])
+```
+
+## Ruby 1.9+
+
+`country_select` will no longer be tested in Ruby `< 1.9`.

data/country_select.gemspec

@@ -5,6 +5,7 @@ require 'country_select/version'
 Gem::Specification.new do |s|
   s.name        = 'country_select'
   s.version     = CountrySelect::VERSION
+  s.licenses    = ['MIT']
   s.authors     = ['Stefan Penner']
   s.email       = ['stefan.penner@gmail.com']
   s.homepage    = 'https://github.com/stefanpenner/country_select'
@@ -18,13 +19,14 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  # specify any dependencies here; for example:
-  s.add_development_dependency 'rspec'
-  if RUBY_VERSION < '1.9.3'
-    s.add_development_dependency 'actionpack', '~> 3.2.13'
-  else
-    s.add_development_dependency 'actionpack'
-  end
-  s.add_development_dependency 'appraisal'
-  s.add_development_dependency 'pry'
+  s.required_ruby_version = '>= 2'
+
+  s.add_development_dependency 'actionpack', '~> 5'
+  s.add_development_dependency 'pry', '~> 0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'wwtd'
+
+  s.add_dependency 'countries', '~> 3.0'
+  s.add_dependency 'sort_alphabetical', '~> 1.0'
 end

data/gemfiles/actionpack.edge.gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+git "https://github.com/rails/rails.git" do
+  gem "actionpack"
+  gem "actionview"
+  gem "activesupport"
+end
+
+platforms :rbx do
+  gem "racc"
+  gem "rubysl", "~> 2.0"
+  gem "psych"
+end

data/gemfiles/actionpack.edge.gemfile.lock

@@ -0,0 +1,310 @@
+GIT
+  remote: https://github.com/rails/rails.git
+  revision: 30767f980faa2d7a0531774ddf040471db74a23b
+  specs:
+    actionpack (5.2.0.alpha)
+      actionview (= 5.2.0.alpha)
+      activesupport (= 5.2.0.alpha)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0.alpha)
+      activesupport (= 5.2.0.alpha)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.0.alpha)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+
+PATH
+  remote: ..
+  specs:
+    country_select (4.0.0)
+      countries (~> 3.0)
+      sort_alphabetical (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    countries (3.0.0)
+      i18n_data (~> 0.8.0)
+      sixarm_ruby_unaccent (~> 1.1)
+      unicode_utils (~> 1.4)
+    diff-lcs (1.3)
+    erubi (1.6.1)
+    ffi2-generators (0.1.1)
+    i18n (0.8.6)
+    i18n_data (0.8.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    method_source (0.8.2)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    psych (2.2.4)
+    racc (1.4.14)
+    rack (2.0.3)
+    rack-test (0.7.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (12.1.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubysl (2.2.0)
+      rubysl-abbrev (~> 2.0)
+      rubysl-base64 (~> 2.0)
+      rubysl-benchmark (~> 2.0)
+      rubysl-bigdecimal (~> 2.0)
+      rubysl-cgi (~> 2.0)
+      rubysl-cgi-session (~> 2.0)
+      rubysl-cmath (~> 2.0)
+      rubysl-complex (~> 2.0)
+      rubysl-continuation (~> 2.0)
+      rubysl-coverage (~> 2.0)
+      rubysl-csv (~> 2.0)
+      rubysl-curses (~> 2.0)
+      rubysl-date (~> 2.0)
+      rubysl-delegate (~> 2.0)
+      rubysl-digest (~> 2.0)
+      rubysl-drb (~> 2.0)
+      rubysl-e2mmap (~> 2.0)
+      rubysl-english (~> 2.0)
+      rubysl-enumerator (~> 2.0)
+      rubysl-erb (~> 2.0)
+      rubysl-etc (~> 2.0)
+      rubysl-expect (~> 2.0)
+      rubysl-fcntl (~> 2.0)
+      rubysl-fiber (~> 2.0)
+      rubysl-fileutils (~> 2.0)
+      rubysl-find (~> 2.0)
+      rubysl-forwardable (~> 2.0)
+      rubysl-getoptlong (~> 2.0)
+      rubysl-gserver (~> 2.0)
+      rubysl-io-console (~> 2.0)
+      rubysl-io-nonblock (~> 2.0)
+      rubysl-io-wait (~> 2.0)
+      rubysl-ipaddr (~> 2.0)
+      rubysl-irb (~> 2.1)
+      rubysl-logger (~> 2.0)
+      rubysl-mathn (~> 2.0)
+      rubysl-matrix (~> 2.0)
+      rubysl-mkmf (~> 2.0)
+      rubysl-monitor (~> 2.0)
+      rubysl-mutex_m (~> 2.0)
+      rubysl-net-ftp (~> 2.0)
+      rubysl-net-http (~> 2.0)
+      rubysl-net-imap (~> 2.0)
+      rubysl-net-pop (~> 2.0)
+      rubysl-net-protocol (~> 2.0)
+      rubysl-net-smtp (~> 2.0)
+      rubysl-net-telnet (~> 2.0)
+      rubysl-nkf (~> 2.0)
+      rubysl-observer (~> 2.0)
+      rubysl-open-uri (~> 2.0)
+      rubysl-open3 (~> 2.0)
+      rubysl-openssl (~> 2.0)
+      rubysl-optparse (~> 2.0)
+      rubysl-ostruct (~> 2.0)
+      rubysl-pathname (~> 2.0)
+      rubysl-prettyprint (~> 2.0)
+      rubysl-prime (~> 2.0)
+      rubysl-profile (~> 2.0)
+      rubysl-profiler (~> 2.0)
+      rubysl-pstore (~> 2.0)
+      rubysl-pty (~> 2.0)
+      rubysl-rational (~> 2.0)
+      rubysl-resolv (~> 2.0)
+      rubysl-rexml (~> 2.0)
+      rubysl-rinda (~> 2.0)
+      rubysl-rss (~> 2.0)
+      rubysl-scanf (~> 2.0)
+      rubysl-securerandom (~> 2.0)
+      rubysl-set (~> 2.0)
+      rubysl-shellwords (~> 2.0)
+      rubysl-singleton (~> 2.0)
+      rubysl-socket (~> 2.0)
+      rubysl-stringio (~> 2.0)
+      rubysl-strscan (~> 2.0)
+      rubysl-sync (~> 2.0)
+      rubysl-syslog (~> 2.0)
+      rubysl-tempfile (~> 2.0)
+      rubysl-thread (~> 2.0)
+      rubysl-thwait (~> 2.0)
+      rubysl-time (~> 2.0)
+      rubysl-timeout (~> 2.0)
+      rubysl-tmpdir (~> 2.0)
+      rubysl-tsort (~> 2.0)
+      rubysl-un (~> 2.0)
+      rubysl-unicode_normalize (~> 2.0)
+      rubysl-uri (~> 2.0)
+      rubysl-weakref (~> 2.0)
+      rubysl-webrick (~> 2.0)
+      rubysl-xmlrpc (~> 2.0)
+      rubysl-yaml (~> 2.0)
+      rubysl-zlib (~> 2.0)
+    rubysl-abbrev (2.0.4)
+    rubysl-base64 (2.0.0)
+    rubysl-benchmark (2.0.1)
+    rubysl-bigdecimal (2.0.2)
+    rubysl-cgi (2.0.1)
+    rubysl-cgi-session (2.1.0)
+    rubysl-cmath (2.0.0)
+    rubysl-complex (2.0.0)
+    rubysl-continuation (2.0.0)
+    rubysl-coverage (2.1)
+    rubysl-csv (2.0.2)
+      rubysl-english (~> 2.0)
+    rubysl-curses (2.0.1)
+    rubysl-date (2.0.9)
+    rubysl-delegate (2.0.1)
+    rubysl-digest (2.0.8)
+    rubysl-drb (2.0.1)
+    rubysl-e2mmap (2.0.0)
+    rubysl-english (2.0.0)
+    rubysl-enumerator (2.0.0)
+    rubysl-erb (2.0.2)
+    rubysl-etc (2.0.3)
+      ffi2-generators (~> 0.1)
+    rubysl-expect (2.0.0)
+    rubysl-fcntl (2.0.4)
+      ffi2-generators (~> 0.1)
+    rubysl-fiber (2.0.0)
+    rubysl-fileutils (2.0.3)
+    rubysl-find (2.0.1)
+    rubysl-forwardable (2.0.1)
+    rubysl-getoptlong (2.0.0)
+    rubysl-gserver (2.0.0)
+      rubysl-socket (~> 2.0)
+      rubysl-thread (~> 2.0)
+    rubysl-io-console (2.0.0)
+    rubysl-io-nonblock (2.0.0)
+    rubysl-io-wait (2.0.0)
+    rubysl-ipaddr (2.0.0)
+    rubysl-irb (2.1.1)
+      rubysl-e2mmap (~> 2.0)
+      rubysl-mathn (~> 2.0)
+      rubysl-thread (~> 2.0)
+    rubysl-logger (2.1.0)
+    rubysl-mathn (2.0.0)
+    rubysl-matrix (2.1.0)
+      rubysl-e2mmap (~> 2.0)
+    rubysl-mkmf (2.1)
+      rubysl-fileutils (~> 2.0)
+      rubysl-shellwords (~> 2.0)
+    rubysl-monitor (2.0.0)
+    rubysl-mutex_m (2.0.0)
+    rubysl-net-ftp (2.0.1)
+    rubysl-net-http (2.0.4)
+      rubysl-cgi (~> 2.0)
+      rubysl-erb (~> 2.0)
+      rubysl-singleton (~> 2.0)
+    rubysl-net-imap (2.0.1)
+    rubysl-net-pop (2.0.1)
+    rubysl-net-protocol (2.0.1)
+    rubysl-net-smtp (2.0.1)
+    rubysl-net-telnet (2.0.0)
+    rubysl-nkf (2.0.1)
+    rubysl-observer (2.0.0)
+    rubysl-open-uri (2.0.0)
+    rubysl-open3 (2.0.0)
+    rubysl-openssl (2.9)
+    rubysl-optparse (2.0.1)
+      rubysl-shellwords (~> 2.0)
+    rubysl-ostruct (2.1.0)
+    rubysl-pathname (2.3)
+    rubysl-prettyprint (2.0.3)
+    rubysl-prime (2.0.1)
+    rubysl-profile (2.0.0)
+    rubysl-profiler (2.1)
+    rubysl-pstore (2.0.0)
+    rubysl-pty (2.0.3)
+    rubysl-rational (2.0.1)
+    rubysl-resolv (2.1.2)
+    rubysl-rexml (2.0.4)
+    rubysl-rinda (2.0.1)
+    rubysl-rss (2.0.0)
+    rubysl-scanf (2.0.0)
+    rubysl-securerandom (2.0.0)
+    rubysl-set (2.0.1)
+    rubysl-shellwords (2.0.0)
+    rubysl-singleton (2.0.0)
+    rubysl-socket (2.2.1)
+      rubysl-fcntl (~> 2.0)
+    rubysl-stringio (2.1.0)
+    rubysl-strscan (2.0.0)
+    rubysl-sync (2.0.0)
+    rubysl-syslog (2.1.0)
+      ffi2-generators (~> 0.1)
+    rubysl-tempfile (2.0.1)
+    rubysl-thread (2.0.3)
+    rubysl-thwait (2.0.0)
+    rubysl-time (2.0.3)
+    rubysl-timeout (2.0.0)
+    rubysl-tmpdir (2.0.1)
+    rubysl-tsort (2.0.1)
+    rubysl-un (2.0.0)
+      rubysl-fileutils (~> 2.0)
+      rubysl-optparse (~> 2.0)
+    rubysl-unicode_normalize (2.0)
+    rubysl-uri (2.0.0)
+    rubysl-weakref (2.0.0)
+    rubysl-webrick (2.0.0)
+    rubysl-xmlrpc (2.0.0)
+    rubysl-yaml (2.1.0)
+    rubysl-zlib (2.0.1)
+    sixarm_ruby_unaccent (1.2.0)
+    slop (3.6.0)
+    sort_alphabetical (1.1.0)
+      unicode_utils (>= 1.2.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode_utils (1.4.0)
+    wwtd (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack!
+  actionview!
+  activesupport!
+  country_select!
+  pry (~> 0)
+  psych
+  racc
+  rake
+  rspec (~> 3)
+  rubysl (~> 2.0)
+  wwtd
+
+BUNDLED WITH
+   1.17.1