countries 2.0.0.pre.2 → 2.0.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37219d090737e0e00f5982e5655fa06622205589
-  data.tar.gz: 07ee78ed6cb32591e38db8d459bd014f5b5ca24c
+  metadata.gz: 0b689d67277b1896cc6810ad8782f6f1584965ca
+  data.tar.gz: 49813c4c5797c0449c3adbeeef9b872288d3a387
 SHA512:
-  metadata.gz: fd08605ecead0f13f013d6158a80e8290d6f9012aa38b7c97eaa3718769aaa344897fe5bfd6cd585d07f838c2722fdd9db6cbaa5c3a437eb7042b82056653277
-  data.tar.gz: 1f0a831b563b757f17e547e3f5f3b3ed125b479fad07d2dae412e033bbce731d3520c8678e25c1e0d9e2139ad4091a06bc25350e8a8519736e8c8411c66c8a79
+  metadata.gz: 989a54adf89519d22899fec6d74fc0ba7296fee1c8797676a88095aee3fd6132f2edd9355e23733d5127f9fbf9320033950d4e6706e13f9e02b32d17a3c3bef7
+  data.tar.gz: 33fe7849f6b2d03e358a56e1228d1b43282d3e87cd6bfc273526f4dd308bdb8b3acb7c35aef115930551c5f619243e894ad6ce0917a2ef53d5eb2ec7fea21499

data/.travis.yml

@@ -6,6 +6,9 @@ rvm:
  - 2.0.0
  - 2.2.3
  - ruby-head
+before_install:
+  - gem update --system
+  - gem install bundler --pre
 matrix:
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -11,6 +11,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Add Configuration methods to force locales to load
 - Dropped currencies gem in favor of money
 - Add Time Zone Support
+- DATA STRUCTURE CHANGES
+  -COUNTRY
+    - BREAKING CHANGES
+      - names: => unofficial_names
+      - languages: => official_languages
+      - lat/lng fields are nested under a "geo" key
+    - + spoken_languages
+    - +
+
 
 ## 1.2.5 @ 2016-01-22
 - Rebuilding cache

data/README.markdown

@@ -4,16 +4,19 @@ Countries
 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)
-[![Build Status](https://travis-ci.org/hexorx/countries.svg)](https://travis-ci.org/hexorx/countries) [![Dependency Status](https://gemnasium.com/hexorx/countries.svg)](https://gemnasium.com/hexorx/countries) [![Code Climate](https://codeclimate.com/github/hexorx/countries.svg)](https://codeclimate.com/github/hexorx/countries)
-
+[![Build Status](https://travis-ci.org/hexorx/countries.svg)](https://travis-ci.org/hexorx/countries) [![Dependency Status](https://gemnasium.com/hexorx/countries.svg)](https://gemnasium.com/hexorx/countries) [![Code Climate](https://codeclimate.com/github/hexorx/countries.svg)](https://codeclimate.com/github/hexorx/countries)[![Test Coverage](https://codeclimate.com/github/hexorx/countries/badges/coverage.svg)](https://codeclimate.com/github/hexorx/countries/coverage)
 Installation
 ------------
 
+``` bash
     gem install countries
+```
 
 If you’re in Rails 2.3 or earlier, place this in your environment.rb:
 
+``` ruby
     config.gem 'countries'
+```
 
 Or you can install via bundler Gemfile if you are using Rails 3:
 
@@ -38,10 +41,12 @@ Basic Usage
 
 Simply load a new country object using Country.new(*alpha2*) or the shortcut Country[*alpha2*]. An example works best.
 
-    c = ISO3166::Country.new('US')
+``` ruby
+c = ISO3166::Country.new('US')
 
-    # with global Country Helper
-    c = Country['US']
+# with global Country Helper
+c = Country['US']
+```
 
 Configuration
 
@@ -51,27 +56,32 @@ By default we load I18n.available_locales if I18n is present, otherwise only [:e
 
 You can add all the locales like this.
 
-    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
+``` 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
-
-    ISO3166.configure do |config|
-      config.locales = [:en, :de, :fr, :es]
-    end
+``` ruby
+ISO3166.configure do |config|
+  config.locales = [:en, :de, :fr, :es]
+end
+```    
 
 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:
 
-    c = ISO3166::Country.find_country_by_name('united states')
-    list = ISO3166::Country.find_all_countries_by_region('Americas')
-    c = ISO3166::Country.find_country_by_alpha3('can')
+``` ruby
+c = ISO3166::Country.find_country_by_name('united states')
+list = ISO3166::Country.find_all_countries_by_region('Americas')
+c = ISO3166::Country.find_country_by_alpha3('can')
+```
 
-For a list of available attributes please see ISO3166::Country::AttrReaders.
-Note: searches are *case insensitive*.
+For a list of available attributes please see ISO3166::DEFAULT_COUNTRY_HASH.
+Note: searches are *case insensitive and ignore accents*.
 
 Country Info
 ------------
@@ -86,7 +96,7 @@ Country Info
   Names & Translations
 
     c.name #=> "United States"
-    c.names #=> ["United States of America", "Vereinigte Staaten von Amerika", "États-Unis", "Estados Unidos"]
+    c.unofficial_names #=> ["United States of America", "Vereinigte Staaten von Amerika", "États-Unis", "Estados Unidos"]
 
     # Get the names for a country translated to its local languages
     c = Country[:BE]
@@ -104,64 +114,97 @@ Country Info
 
   Subdivisions & States
 
-    c.subdivisions #=> {"CO" => {"name" => "Colorado", "names" => "Colorado"}, ... }
-    c.states #=> {"CO" => {"name" => "Colorado", "names" => "Colorado"}, ... }
-
+``` ruby
+c.subdivisions #=> {"CO" => {"name" => "Colorado", "names" => "Colorado"}, ... }
+c.states #=> {"CO" => {"name" => "Colorado", "names" => "Colorado"}, ... }
+```
   Location
 
-    c.latitude #=> "38 00 N"
-    c.longitude #=> "97 00 W"
-    c.latitude_dec #=> 39.44325637817383
-    c.longitude_dec #=> -98.95733642578125
+``` ruby
+c.latitude #=> "38 00 N"
+c.longitude #=> "97 00 W"
+c.latitude_dec #=> 39.44325637817383
+c.longitude_dec #=> -98.95733642578125
 
-    c.region #=> "Americas"
-    c.subregion #=> "Northern America"
+c.region #=> "Americas"
+c.subregion #=> "Northern America"
+```
 
-  Timezones **(optional)**
+Timezones **(optional)**
 
-  Add tzinfo to your gemfile, ensure it's required, Countries will not do this for you.
+Add tzinfo to your gemfile, ensure it's required, Countries will not do this for you.
 
     gem 'tzinfo', '~> 1.2', '>= 1.2.2'
 
-    c.timezones.zone_identifiers #=> ["America/New_York", "America/Detroit", "America/Kentucky/Louisville", ...]
-  ```c.timezones.zone_info```  # see [tzinfo docs]( http://www.rubydoc.info/gems/tzinfo/TZInfo/CountryInfo)
+``` ruby
+c.timezones.zone_identifiers #=> ["America/New_York", "America/Detroit", "America/Kentucky/Louisville", ...]
+c.timezones.zone_info  # see [tzinfo docs]( http://www.rubydoc.info/gems/tzinfo/TZInfo/CountryInfo)
+c.timezones # see [tzinfo docs]( http://www.rubydoc.info/gems/tzinfo/TZInfo/Country)
+```
 
-  ```c.timezones``` # see [tzinfo docs]( http://www.rubydoc.info/gems/tzinfo/TZInfo/Country)
+Telephone Routing (E164)
 
-  Telephone Routing (E164)
+``` ruby
+c.country_code #=> "1"
+c.national_destination_code_lengths #=> 3
+c.national_number_lengths #=> 10
+c.international_prefix #=> "011"
+c.national_prefix #=> "1"
+```
 
-    c.country_code #=> "1"
-    c.national_destination_code_lengths #=> 3
-    c.national_number_lengths #=> 10
-    c.international_prefix #=> "011"
-    c.national_prefix #=> "1"
+Boundry Boxes
 
-  Boundry Boxes
-
-    c.min_longitude #=> '45'
-    c.min_latitude #=> '22.166667'
-    c.max_longitude #=> '58'
-    c.max_latitude #=> '26.133333'
+``` ruby
+c.min_longitude #=> '45'
+c.min_latitude #=> '22.166667'
+c.max_longitude #=> '58'
+c.max_latitude #=> '26.133333'
+```
 
   European Union Membership
 
-    c.in_eu? #=> false
+``` ruby
+c.in_eu? #=> false
+```
 
 Currencies
 ----------
 
 Countries now uses the [Money](https://github.com/RubyMoney/money) gem. What this means is you now get back a Money::Currency object that gives you access to all the currency information.
 
-    c.currency.iso_code #=> 'USD'
-    c.currency.name #=> 'Dollars'
-    c.currency.symbol #=> '$'
+``` ruby
+c.currency.iso_code #=> 'USD'
+c.currency.name #=> 'Dollars'
+c.currency.symbol #=> '$'
+```
 
 Address Formatting
 ------------------
 
 A template for formatting addresses is available through the address_format method. These templates are compatible with the [Liquid][] template system.
 
-    c.address_format #=> "{{recipient}}\n{{street}}\n{{city}} {{region}} {{postalcode}}\n{{country}}"
+``` ruby
+c.address_format #=> "{{recipient}}\n{{street}}\n{{city}} {{region}} {{postalcode}}\n{{country}}"
+```
+
+Loading Custom Data
+-------
+As of 2.0 countries supports loading custom countries / overriding data in it's data set, though if you choose to do this please contribute back to the upstream repo!
+
+Any country registered this way will have it's data available for searching etc... If you are overriding an existing country, for cultural reasons, our code uses a simple merge, not a deep merge so you will need to __bring in all data you wish to be available__.  Bringing in an existing country will also remove it from the internal management of translations, __all registered countries will remain in memory__.
+
+``` ruby
+ISO3166::Data.register(
+  alpha2: "LOL",
+  name: 'Happy Country'
+  translations: {
+    'EN' => "Happy Country",
+    'DE' => "glückliches Land"
+  }
+)
+
+ISO3166::Country.new('LOL').name = 'Happy Country'
+```
 
 Mongoid
 -------
@@ -176,41 +219,36 @@ Adds native support for searching/saving by a country object or alpha2 code.
 
 Searching:
 
-    # By alpha2
-    british_things = Things.where(country: 'GB')
-    british_things.first.country.name    # => "United Kingdom"
-
-    # By object
-    british_things = Things.where(country: Country.find_by_name('United Kingdom')[1])
-    british_things.first.country.name    # => "United Kingdom"
+```ruby
+# By alpha2
+british_things = Things.where(country: 'GB')
+british_things.first.country.name    # => "United Kingdom"
 
+# By object
+british_things = Things.where(country: Country.find_by_name('United Kingdom')[1])
+british_things.first.country.name    # => "United Kingdom"
+```
 Saving:
 
-    # By alpha2
-    british_thing = Thing.new(country: 'GB')
-    british_thing.save!
-    british_thing.country.name    # => "United Kingdom"
+```ruby
+# By alpha2
+british_thing = Thing.new(country: 'GB')
+british_thing.save!
+british_thing.country.name    # => "United Kingdom"
 
-    # By object
-    british_thing = Thing.new(country: Country.find_by_name('United Kingdom')[1])
-    british_thing.save!
-    british_thing.country.name    # => "United Kingdom"
+# By object
+british_thing = Thing.new(country: Country.find_by_name('United Kingdom')[1])
+british_thing.save!
+british_thing.country.name    # => "United Kingdom"
+```
 
 Note that the database stores only the alpha2 code and rebuilds the object when queried. To return the country name by default you can override the reader method in your model:
 
-    def country
-        super.name
-    end
-
-ToDo
-----
-
-* State select
-* Class methods for looking up information
-* Default country
-* Exclude countries
-* Preferred countries
-* Whitelist countries
+``` ruby
+def country
+    super.name
+end
+```
 
 Note on Patches/Pull Requests
 -----------------------------
@@ -235,7 +273,7 @@ the next ```rake update_cache```
 Copyright
 ---------
 
-Copyright (c) 2015 hexorx. See LICENSE for details.
+Copyright (c) 2016 hexorx. See LICENSE for details.
 
 
 [Teliax]: http://teliax.com

data/Rakefile

@@ -11,16 +11,37 @@ end
 
 task default: [:spec]
 
-desc 'Test and Clean YAML files'
-task :clean_yaml do
+task :update_yaml_structure do
   require 'yaml'
 
-  d = Dir['**/*.yaml']
+  require 'pry'
+
+  d = Dir['lib/countries/data/subdivisions/*.yaml']
   d.each do |file|
-    begin
-      puts "checking : #{file}"
-      data = YAML.load_file(file)
+
+    puts "checking : #{file}"
+    data = YAML.load_file(file)
+    country_key = File.basename(file, ".yaml")
+
+
+      data = data.inject({}) do |a, (k,subd)|
+        a[k] ||= {}
+        a[k]["unofficial_names"] = subd.delete("names")
+        a[k]["translations"] = {'en' => subd['name']}
+        a[k]["geo"] = {
+          "latitude" => subd.delete("latitude"),
+          "longitude" => subd.delete("longitude"),
+          "min_latitude" => subd.delete("min_latitude"),
+          "min_longitude" => subd.delete("min_longitude"),
+          "max_latitude" => subd.delete("max_latitude"),
+          "max_longitude" => subd.delete("max_longitude")
+        }
+
+        a[k] = a[k].merge(subd)
+        a
+      end
       File.open(file, 'w') { |f| f.write data.to_yaml }
+      begin
     rescue
       puts "failed to read #{file}: #{$ERROR_INFO}"
     end
@@ -32,7 +53,7 @@ task :update_cache do
   require 'yaml'
   require 'i18n_data'
 
-  codes = YAML.load_file(File.join(File.dirname(__FILE__), 'lib', 'countries', 'data', 'countries.yaml')) || {}
+  codes = Dir['lib/countries/data/countries/*.yaml'].map {|x| File.basename(x, File.extname(x))}.uniq
   data = {}
   empty_translations_hash = {}
   corrections = YAML.load_file(File.join(File.dirname(__FILE__), 'lib', 'countries', 'data', 'translation_corrections.yaml')) || {}
@@ -52,14 +73,14 @@ task :update_cache do
       end
     end
 
-    File.open(File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'locales', locale), 'wb') { |f| f.write(Marshal.dump(local_names)) }
+    File.open(File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'locales', "#{locale}.json"), 'wb') { |f| f.write(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]
   end
 
-  File.open(File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'countries'), 'wb') { |f| f.write(Marshal.dump(data)) }
+  File.open(File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'countries.json'), 'wb') { |f| f.write(data.to_json) }
 end
 
 require 'geocoder'
@@ -97,16 +118,16 @@ task :fetch_subdivisions do
       next unless (result = geocode(location))
       geometry = result.geometry
       if geometry['location']
-        state_data[code]['latitude'] = geometry['location']['lat']
-        state_data[code]['longitude'] = geometry['location']['lng']
+        state_data[code]['geo']['latitude'] = geometry['location']['lat']
+        state_data[code]['geo']['longitude'] = geometry['location']['lng']
       end
       next unless geometry['bounds']
-      state_data[code]['min_latitude'] = geometry['bounds']['southwest']['lat']
-      state_data[code]['min_longitude'] = geometry['bounds']['southwest']['lng']
-      state_data[code]['max_latitude'] = geometry['bounds']['northeast']['lat']
-      state_data[code]['max_longitude'] = geometry['bounds']['northeast']['lng']
+      state_data[code]['geo']['min_latitude'] = geometry['bounds']['southwest']['lat']
+      state_data[code]['geo']['min_longitude'] = geometry['bounds']['southwest']['lng']
+      state_data[code]['geo']['max_latitude'] = geometry['bounds']['northeast']['lat']
+      state_data[code]['geo']['max_longitude'] = geometry['bounds']['northeast']['lng']
     end
     # Write updated YAML for current country
-    File.open(File.join(File.dirname(__FILE__), 'lib', 'data', 'subdivisions', "#{c.alpha2}.yaml"), 'w+') { |f| f.write state_data.to_yaml }
+    File.open(File.join(File.dirname(__FILE__), 'lib','countries', 'data', 'subdivisions', "#{c.alpha2}.yaml"), 'w+') { |f| f.write state_data.to_yaml }
   end
 end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "countries"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/countries.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('i18n_data', '~> 0.7.0')
   gem.add_dependency('money', '~> 6.0')
+  gem.add_dependency('unicode_utils', '~> 1.4')
   gem.add_development_dependency('rspec', '>= 3')
-  gem.add_development_dependency('actionview', '>= 3')
-  gem.add_development_dependency 'yard'
+  gem.add_development_dependency('activesupport', '>= 3')
+
 end