countries 1.2.5 → 2.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ee687bca4e24ba2898509688d95338b53b593bd
-  data.tar.gz: cda7ae980090e58b83d2bcb7a47635019c9412d4
+  metadata.gz: e56e233e585a77d0e16537d69e5055d9db7f1201
+  data.tar.gz: 8e0d126fdd580391306a14f444b1cb1f767b088b
 SHA512:
-  metadata.gz: b4a58a0e7b18602487f105c53e73d8fb94e0b400465ff7a021e3ce8429adfd7285da97ff0b3ed645d43be8f974034b795dc298de827e841cef665d365f6bea74
-  data.tar.gz: 5c2f7e88a4969b272cedb5dad3bdd82c8716f8db98438f74b9fe0056e5b550df9b76881923fc963680bae828c1dd4435799b20522145dd2a1545ba78aa3d5645
+  metadata.gz: 1110e82fab2598d0242edcad19c73e398bda739bfd8cd8201dd9c2d6944a2edf2b789526cf42dcf8292ff8c661ce5247b39d94d69991693480a931ffcdc04aa9
+  data.tar.gz: 2dc3bf71824639180e6daba333f31ba15d7fc6ad74c0da9fdd0df9d884ba89259d2417a5c728baf823e39087eb6873bf32087963b2380e717b972506a9577dd7

data/.gitignore

@@ -21,5 +21,5 @@ tmp
 .ruby-gemset
 .idea/
 Gemfile.lock
-rspec
+bin/rspec
 examples.txt

data/CHANGELOG.md

@@ -2,8 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## 1.2.5 @ 2016-01-22
-- Rebuilding cache
+## 2.0.0 (unreleased)
+- Selective loading translations of countries
+- Auto detect I18n locales to load
+- Add Configuration methods to force locales to load
+- Dropped currencies gem in favor of money
+- Add Time Zone Support
 
 ## 1.2.4 @ 2016-01-21
 - Romanian Standard VAT rate is 20% as of 2016-01-01 #325 @dougal

data/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 gem 'rake'
 gem 'geocoder'
 gem 'retryable'
+gem 'tzinfo'
 
 # Specify your gem's dependencies in countries.gemspec
 gemspec

data/README.markdown

@@ -35,9 +35,6 @@ has become
 Basic Usage
 -----------
 
-Note that Country class still exist by default.
-(is inherited from ISO3166::Country to keep backward compatibility).
-
 Simply load a new country object using Country.new(*alpha2*) or the shortcut Country[*alpha2*]. An example works best.
 
     c = ISO3166::Country.new('US')
@@ -45,6 +42,24 @@ Simply load a new country object using Country.new(*alpha2*) or the shortcut Cou
     # with global Country Helper
     c = Country['US']
 
+Configuration
+
+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 it's supported translations.
+
+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
+
+or something a bit more simple
+
+    ISO3166.configure do |config|
+      config.locales = [:en, :de, :fr, :es]
+    end
+
 Attribute-Based Finder Methods
 ------------
 
@@ -101,6 +116,17 @@ Country Info
     c.region #=> "Americas"
     c.subregion #=> "Northern America"
 
+  Timezones **(optional)**
+
+  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)
+
+  ```c.timezones``` # see [tzinfo docs]( http://www.rubydoc.info/gems/tzinfo/TZInfo/Country)
+
   Telephone Routing (E164)
 
     c.country_code #=> "1"
@@ -123,11 +149,11 @@ Country Info
 Currencies
 ----------
 
-Countries now uses the [Currencies][] gem. What this means is you now get back a Currency object that gives you access to all the currency information. It acts the same as a hash so the same ['name'] methods still work.
+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['code'] #=> 'USD'
-    c.currency['name'] #=> 'Dollars'
-    c.currency['symbol'] #=> '$'
+    c.currency.iso_code #=> 'USD'
+    c.currency.name #=> 'Dollars'
+    c.currency.symbol #=> '$'
 
 Address Formatting
 ------------------

data/Rakefile

@@ -52,14 +52,11 @@ task :update_cache do
       end
     end
 
-    codes.each do |alpha2|
-      data[alpha2] ||= YAML.load_file(File.join(File.dirname(__FILE__), 'lib', 'countries', 'data', 'countries', "#{alpha2}.yaml"))[alpha2]
-      data[alpha2]['translations'] ||= empty_translations_hash.dup
-      data[alpha2]['translations'][locale] = local_names[alpha2]
-      data[alpha2]['translated_names'] ||= []
-      data[alpha2]['translated_names'] << local_names[alpha2]
-      data[alpha2]['translated_names'] = data[alpha2]['translated_names'].uniq
-    end
+    File.open(File.join(File.dirname(__FILE__), 'lib', 'countries', 'cache', 'locales', locale), 'wb') { |f| f.write(Marshal.dump(local_names)) }
+  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)) }
@@ -97,19 +94,17 @@ task :fetch_subdivisions do
         location = "#{data['name']} State, United States"
       end
 
-      if (result = geocode(location))
-        geometry = result.geometry
-        if geometry['location']
-          state_data[code]['latitude'] = geometry['location']['lat']
-          state_data[code]['longitude'] = geometry['location']['lng']
-        end
-        if 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']
-        end
+      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']
       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']
     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 }

data/countries.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = Countries::VERSION
 
   gem.add_dependency('i18n_data', '~> 0.7.0')
-  gem.add_dependency('currencies', '~> 0.4.2')
+  gem.add_dependency('money', '~> 6.0')
   gem.add_development_dependency('rspec', '>= 3')
   gem.add_development_dependency('actionview', '>= 3')
   gem.add_development_dependency 'yard'

data/lib/countries/configuration.rb

@@ -0,0 +1,37 @@
+module ISO3166
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+    Data.reset
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :locales, :loaded_locales
+
+    def initialize
+      @locales = default_locales
+      @loaded_locales = []
+    end
+
+    private
+
+    def default_locales
+      if Object.const_defined?('I18n') && I18n.respond_to?(:available_locales)
+        I18n.available_locales
+      else
+        [:en]
+      end
+    end
+  end
+end

data/lib/countries/country.rb

@@ -1,201 +1,157 @@
-module ISO3166; end
-
-class ISO3166::Country
-  Setup = ISO3166::Setup.new
-
-  AttrReaders = [
-    :number,
-    :alpha2,
-    :alpha3,
-    :name,
-    :names,
-    :latitude,
-    :longitude,
-    :continent,
-    :region,
-    :subregion,
-    :world_region,
-    :country_code,
-    :national_destination_code_lengths,
-    :national_number_lengths,
-    :international_prefix,
-    :national_prefix,
-    :address_format,
-    :translations,
-    :translated_names,
-    :ioc,
-    :gec,
-    :un_locode,
-    :languages,
-    :nationality,
-    :dissolved_on,
-    :eu_member,
-    :alt_currency,
-    :vat_rates,
-    :postal_code,
-    :min_longitude,
-    :min_latitude,
-    :max_longitude,
-    :max_latitude,
-    :latitude_dec,
-    :longitude_dec
-  ]
-
-  AttrReaders.each do |meth|
-    define_method meth do
-      @data[meth.to_s]
-    end
-  end
-
-  attr_reader :data
-
-  def initialize(country_data)
-    @data = country_data.is_a?(Hash) ? country_data : ISO3166::Data.new(country_data).call
-  end
-
-  def valid?
-    !(@data.nil? || @data.empty?)
-  end
+module ISO3166
+  class Country
+    attr_reader :data
 
-  alias_method :zip, :postal_code
-  alias_method :zip?, :postal_code
-  alias_method :postal_code?, :postal_code
-
-  def ==(other)
-    other == data
-  end
-
-  def <=>(other)
-    to_s <=> other.to_s
-  end
-
-  def currency
-    ISO4217::Currency.from_code(@data['currency'])
-  end
+    include ISO3166::Countries::AttrReaders
 
-  def currency_code
-    @data['currency']
-  end
+    def initialize(country_data)
+      @data = country_data.is_a?(Hash) ? country_data : ISO3166::Data.new(country_data).call
+    end
 
-  def subdivisions
-    @subdivisions ||= subdivisions? ? YAML.load_file(File.join(File.dirname(__FILE__), 'data', 'subdivisions', "#{alpha2}.yaml")) : {}
-  end
+    def valid?
+      !(@data.nil? || @data.empty?)
+    end
 
-  alias_method :states, :subdivisions
+    alias_method :zip, :postal_code
+    alias_method :zip?, :postal_code
+    alias_method :postal_code?, :postal_code
 
-  def subdivisions?
-    File.exist?(File.join(File.dirname(__FILE__), 'data', 'subdivisions', "#{alpha2}.yaml"))
-  end
+    def ==(other)
+      other == data
+    end
 
-  def in_eu?
-    @data['eu_member'].nil? ? false : @data['eu_member']
-  end
+    def <=>(other)
+      to_s <=> other.to_s
+    end
 
-  def to_s
-    @data['name']
-  end
+    def currency
+      Money::Currency.find(@data['currency'])
+    end
 
-  def translation(locale = 'en')
-    @data['translations'][locale.downcase.to_s]
-  end
+    def currency_code
+      @data['currency']
+    end
 
-  def local_names
-    @local_names ||= languages.map { |language| translations[language] }
-  end
+    def subdivisions
+      @subdivisions ||= subdivisions? ? YAML.load_file(File.join(File.dirname(__FILE__), 'data', 'subdivisions', "#{alpha2}.yaml")) : {}
+    end
 
-  def local_name
-    @local_name ||= local_names.first
-  end
+    alias_method :states, :subdivisions
 
-  class << self
-    def new(country_data)
-      super if country_data.is_a?(Hash) || codes.include?(country_data.to_s.upcase)
+    def subdivisions?
+      File.exist?(File.join(File.dirname(__FILE__), 'data', 'subdivisions', "#{alpha2}.yaml"))
     end
 
-    def codes
-      Setup.codes
+    def in_eu?
+      @data['eu_member'].nil? ? false : @data['eu_member']
     end
 
-    def all(&blk)
-      blk ||= proc { |_alpha2, d| ISO3166::Country.new(d) }
-      Setup.data.map(&blk)
+    def to_s
+      @data['name']
     end
 
-    alias_method :countries, :all
-
-    def all_translated(locale = 'en')
-      translations(locale).values
+    def translation(locale = 'en')
+      @data['translations'][locale.to_s.downcase]
     end
 
-    def all_names_with_codes(locale = 'en')
-      ISO3166::Country.all.map do |c|
-        [(c.translation(locale) || c.name).html_safe, c.alpha2]
-      end.sort_by { |d| d[0] }
+    def local_names
+      @local_names ||= languages.map { |language| translations[language] }
     end
 
-    def translations(locale = 'en')
-      I18nData.countries(locale.upcase)
+    def local_name
+      @local_name ||= local_names.first
     end
 
-    def search(query)
-      country = new(query.to_s.upcase)
-      (country && country.valid?) ? country : nil
-    end
+    class << self
+      def new(country_data)
+        super if country_data.is_a?(Hash) || codes.include?(country_data.to_s.upcase)
+      end
 
-    def [](query)
-      search(query)
-    end
+      def codes
+        ISO3166::Data.codes
+      end
 
-    def method_missing(*m)
-      regex = m.first.to_s.match(/^find_(all_)?(country_|countries_)?by_(.+)/)
-      super unless regex
+      def all(&blk)
+        blk ||= proc { |_alpha2, d| ISO3166::Country.new(d) }
+        ISO3166::Data.cache.map(&blk)
+      end
 
-      countries = find_by(Regexp.last_match[3], m[1], Regexp.last_match[2])
-      Regexp.last_match[1] ? countries : countries.last
-    end
+      alias_method :countries, :all
+
+      def all_translated(locale = 'en')
+        translations(locale).values
+      end
 
-    def find_all_by(attribute, val)
-      attributes, value = parse_attributes(attribute, val)
+      def all_names_with_codes(locale = 'en')
+        ISO3166::Country.all.map do |c|
+          [(c.translation(locale) || c.name).html_safe, c.alpha2]
+        end.sort_by { |d| d[0] }
+      end
 
-      Setup.data.select do |_, v|
-        attributes.map do |attr|
-          Array(v[attr]).any? { |n| value === n.to_s.downcase }
-        end.include?(true)
+      def translations(locale = 'en')
+        I18nData.countries(locale.upcase)
       end
-    end
 
-    protected
+      def search(query)
+        country = new(query.to_s.upcase)
+        (country && country.valid?) ? country : nil
+      end
+
+      def [](query)
+        search(query)
+      end
 
-    def parse_attributes(attribute, val)
-      fail "Invalid attribute name '#{attribute}'" unless instance_methods.include?(attribute.to_sym)
+      def method_missing(*m)
+        regex = m.first.to_s.match(/^find_(all_)?(country_|countries_)?by_(.+)/)
+        super unless regex
 
-      attributes = Array(attribute.to_s)
-      if attributes == ['name']
-        attributes << 'names'
-        # TODO: Revisit when better data from i18n_data
-        # attributes << 'translated_names'
+        countries = find_by(Regexp.last_match[3], m[1], Regexp.last_match[2])
+        Regexp.last_match[1] ? countries : countries.last
       end
 
-      val = (val.is_a?(Regexp) ? Regexp.new(val.source, 'i') : val.to_s.downcase)
+      def find_all_by(attribute, val)
+        attributes, value = parse_attributes(attribute, val)
 
-      [attributes, val]
-    end
+        ISO3166::Data.cache.select do |_, v|
+          attributes.map do |attr|
+            Array(v[attr]).any? { |n| value === n.to_s.downcase }
+          end.include?(true)
+        end
+      end
+
+      protected
+
+      def parse_attributes(attribute, val)
+        fail "Invalid attribute name '#{attribute}'" unless instance_methods.include?(attribute.to_sym)
 
-    def find_by(attribute, value, obj = nil)
-      find_all_by(attribute.downcase, value).map do |country|
-        obj.nil? ? country : new(country.last)
+        attributes = Array(attribute.to_s)
+        if attributes == ['name']
+          attributes << 'names'
+          # TODO: Revisit when better data from i18n_data
+          # attributes << 'translated_names'
+        end
+
+        val = (val.is_a?(Regexp) ? Regexp.new(val.source, 'i') : val.to_s.downcase)
+
+        [attributes, val]
+      end
+
+      def find_by(attribute, value, obj = nil)
+        find_all_by(attribute.downcase, value).map do |country|
+          obj.nil? ? country : new(country.last)
+        end
       end
     end
   end
-end
 
-def ISO3166::Country(country_data_or_country)
-  case country_data_or_country
-  when ISO3166::Country
-    country_data_or_country
-  when String, Symbol
-    ISO3166::Country.search(country_data_or_country)
-  else
-    fail TypeError, "can't convert #{country_data_or_country.class.name} into ISO3166::Country"
+  def ISO3166::Country(country_data_or_country)
+    case country_data_or_country
+    when ISO3166::Country
+      country_data_or_country
+    when String, Symbol
+      ISO3166::Country.search(country_data_or_country)
+    else
+      fail TypeError, "can't convert #{country_data_or_country.class.name} into ISO3166::Country"
+    end
   end
 end