countries 1.2.5 → 2.0.0.pre

data/lib/countries/country/attr_readers.rb

@@ -0,0 +1,49 @@
+module ISO3166
+  module Countries
+    module AttrReaders
+      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
+    end
+  end
+end

data/lib/countries/data.rb

@@ -4,30 +4,93 @@ module ISO3166
   class Data
     @@cache = nil
     def initialize(alpha2)
+      self.class.update_cache
       @alpha2 = alpha2.to_s.upcase
-      Data.load_cache unless @@cache
     end
 
     def call
       @@cache[@alpha2]
     end
 
-    def self.codes
-      @@codes ||= Data.load_yaml(['countries', 'data', 'countries.yaml']).freeze
-    end
+    class << self
+      def cache
+        update_cache
+      end
 
-    private
+      def reset
+        @@cache = nil
+        @@codes = nil
+      end
 
-    def self.datafile_path(file_array)
-      File.join([File.dirname(__FILE__), '..'] + file_array)
-    end
+      def codes
+        @@codes ||= load_yaml(['data', 'countries.yaml']).freeze
+      end
 
-    def self.load_yaml(file_array)
-      YAML.load_file(datafile_path(file_array))
-    end
+      def update_cache
+        return @@cache unless cache_flush_required?
+        @@cache ||= marshal %w(cache countries )
+
+        locales_to_remove.each do |locale|
+          unload_translations(locale)
+        end
+
+        locales_to_load.each do |locale|
+          load_translations(locale)
+        end
+
+        @@cache.freeze
+      end
+
+      private
+      def cache_flush_required?
+        locales_to_load.size && locales_to_remove.size
+      end
+
+      def locales_to_load
+        requested_locales - loaded_locales
+      end
+
+      def locales_to_remove
+        loaded_locales - requested_locales
+      end
+
+      def requested_locales
+        ISO3166.configuration.locales.map { |l| l.to_s.downcase }
+      end
+
+      def loaded_locales
+        ISO3166.configuration.loaded_locales.map { |l| l.to_s.downcase }
+      end
+
+      def load_translations(locale)
+        locale_names = marshal(['cache', 'locales', locale])
+        codes.each do |alpha2|
+          @@cache[alpha2]['translations'] ||= {}
+          @@cache[alpha2]['translations'][locale] = locale_names[alpha2].freeze
+          @@cache[alpha2]['translated_names'] = @@cache[alpha2]['translations'].values.freeze
+        end
+        ISO3166.configuration.loaded_locales << locale
+      end
+
+      def unload_translations(locale)
+        codes.each do |alpha2|
+          @@cache[alpha2]['translations'].delete(locale)
+          @@cache[alpha2]['translated_names'] = @@cache[alpha2]['translations'].values.freeze
+        end
+        ISO3166.configuration.loaded_locales.delete(locale)
+      end
+
+      def marshal(file_array)
+        Marshal.load(File.binread(datafile_path file_array))
+      end
+
+      def datafile_path(file_array)
+        File.join([File.dirname(__FILE__)] + file_array)
+      end
 
-    def self.load_cache
-      @@cache ||= Marshal.load(File.binread(datafile_path %w(countries cache countries )))
+      def load_yaml(file_array)
+        YAML.load_file(datafile_path(file_array))
+      end
     end
   end
 end

data/lib/countries/iso3166.rb

@@ -1,7 +1,9 @@
 require 'yaml'
-require 'iso4217'
 require 'i18n_data'
+require 'money'
 
-require 'countries/setup'
+require 'countries/configuration'
 require 'countries/data'
+require 'countries/country/attr_readers'
 require 'countries/country'
+require 'countries/timezones'

data/lib/countries/setup.rb

@@ -1,18 +1,18 @@
 module ISO3166
   ##
+  # <b>DEPRECATED:</b> Please use <tt>Data</tt> instead.
+  # TODO: Remove at version 2.1
   # Handles building the in memory store of countries data
   class Setup
+    # <b>DEPRECATED:</b> Please use <tt>Data.codes</tt> instead.
     def codes
-      @codes ||= Data.codes
+      warn "[DEPRECATION] `Setup.codes` is deprecated.  Please use `Data.codes` instead."
+      Data.codes
     end
 
     def data
-      return @data if instance_variable_defined?('@data')
-      @data = {}
-      codes.each do |alpha2|
-        @data[alpha2] = Data.new(alpha2).call
-      end
-      @data.freeze
+      warn "[DEPRECATION] `Setup.new.data` is deprecated without replacement
+      data is now loaded per locale Data.new(:en).call"
     end
   end
 end

data/lib/countries/timezones.rb

@@ -0,0 +1,11 @@
+# Extend Country class with support for timezones
+module ISO3166
+  # Extend Country class with support for timezones
+  module TimezoneExtensions
+    def timezones
+      @tz_country ||= TZInfo::Country.get(alpha2)
+    end
+  end
+end
+
+ISO3166::Country.send(:include, ISO3166::TimezoneExtensions)

data/lib/countries/version.rb

@@ -1,3 +1,3 @@
 module Countries
-  VERSION = '1.2.5'
+  VERSION = '2.0.0.pre'
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'ISO3166.configuration' do
+  it 'has a configuration' do
+    expect(ISO3166.configuration).to be_a ISO3166::Configuration
+  end
+
+  it 'locales can be changed' do
+    ISO3166.configuration.locales = [:es]
+    expect(ISO3166.configuration.locales).to eq [:es]
+  end
+
+  it 'locales are assumed from I18n.available_locales' do
+    I18n.available_locales = [:de, :en]
+    ISO3166.reset
+    expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
+    expect(ISO3166::Country.new('DE').translation(:es)).to eq nil
+  end
+
+  it 'locales can be changed' do
+    ISO3166.configuration.locales = [:de]
+    expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
+    expect(ISO3166::Country.new('DE').translation(:es)).to eq nil
+  end
+
+  it 'locales can be changed' do
+    ISO3166.configuration.locales = [:es, :de, :en]
+    expect(ISO3166::Country.new('DE').translation(:es)).to eq 'Alemania'
+    expect(ISO3166::Country.new('DE').translation(:en)).to eq 'Germany'
+    expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
+  end
+
+  it 'locales can be changed with a block' do
+    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
+
+    expect(ISO3166::Country.new('DE').translations.size).to eq 92
+
+    expect(ISO3166.configuration.loaded_locales.size).to eq 92
+  end
+end

data/spec/country_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe ISO3166::Country do
   let(:country) { ISO3166::Country.search('US') }
@@ -244,10 +244,21 @@ describe ISO3166::Country do
       expect(countries.first[0]).to eq('Afghanistan')
       expect(countries.size).to eq(250)
     end
+
+    it 'should return an alphabetized list of all country names translated to current locale with ISOCODE alpha2' do
+      ISO3166.configuration.locales = [:es, :de, :en]
+
+      countries = ISO3166::Country.all_names_with_codes(:es)
+      expect(countries).to be_an(Array)
+      expect(countries.first[0]).to be_a(String)
+      expect(countries.first[0]).to eq('Afganistán')
+      expect(countries.size).to eq(250)
+    end
   end
 
   describe 'translation' do
     it 'should return the localized name for a country to the selected locale' do
+      ISO3166.configuration.locales = [:es, :de, :en]
       countries = ISO3166::Country.new(:de).translation('de')
       expect(countries).to be_an(String)
       expect(countries).to eq('Deutschland')
@@ -311,41 +322,11 @@ describe ISO3166::Country do
 
   describe 'currency' do
     it 'should return an instance of Currency' do
-      expect(country.currency).to be_a(ISO4217::Currency)
+      expect(country.currency).to be_a(Money::Currency)
     end
 
     it 'should allow access to symbol' do
-      expect(country.currency[:symbol]).to eq('$')
-    end
-  end
-
-  describe 'Country class' do
-    context "when loaded via 'iso3166' existance" do
-      subject { defined?(Country) }
-
-      it { is_expected.to be_falsey }
-    end
-
-    context "when loaded via 'global'" do
-      before { require 'countries/global' }
-
-      describe 'existance' do
-        subject { defined?(Country) }
-
-        it { is_expected.to be_truthy }
-      end
-
-      describe 'superclass' do
-        subject { Country.superclass }
-
-        it { is_expected.to eq(ISO3166::Country) }
-      end
-
-      describe 'to_s' do
-        it 'should return the country name' do
-          expect(Country.new('GB').to_s).to eq('United Kingdom')
-        end
-      end
+      expect(country.currency.symbol).to eq('$')
     end
   end
 
@@ -467,6 +448,11 @@ describe ISO3166::Country do
     end
 
     context 'when search translation found' do
+      before do
+        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
+      end
       let(:uk) { ISO3166::Country.find_country_by_translated_names('Velika Britanija') }
 
       it 'should be a country instance' do
@@ -556,7 +542,7 @@ describe ISO3166::Country do
 
   describe 'names in Data' do
     it 'should be unique (to allow .find_by_name work properly)' do
-      names = ISO3166::Country::Setup.data.map do |_k, v|
+      names = ISO3166::Data.cache.map do |_k, v|
         [v['name'], v['names']].flatten.uniq
       end.flatten
 
@@ -568,7 +554,7 @@ describe ISO3166::Country do
     let(:norway) { ISO3166::Country.search('NO') }
 
     it 'should have a currency' do
-      expect(norway.currency).to be_a(ISO4217::Currency)
+      expect(norway.currency).to be_a(Money::Currency)
     end
   end
 
@@ -576,7 +562,7 @@ describe ISO3166::Country do
     let(:guernsey) { ISO3166::Country.search('GG') }
 
     it 'should have a currency' do
-      expect(guernsey.currency.code).to eq('GBP')
+      expect(guernsey.currency.iso_code).to eq('GBP')
     end
   end
 

data/spec/data_spec.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'benchmark'
+
+describe ISO3166::Data do
+  it 'responds to call' do
+    data = ISO3166::Data.new('US').call
+    expect(data['translated_names']).to be_a Array
+  end
+
+  it 'can load selective locales' do
+    # ISO3166::Data.update_cache
+    ISO3166.configuration.locales = [:es, :de, :en]
+    data = ISO3166::Data.new('US').call
+    expect(data['translated_names'].size).to eq (3)
+  end
+
+  it 'can load selective locales and reload efficiently' do
+    ISO3166.configuration.locales = [:es, :de, :en]
+    data = ISO3166::Data.new('US').call
+    expect(data['translations']).to eq({"de"=>"Vereinigte Staaten", "es"=>"Estados Unidos", "en"=>"United States"})
+    expect(data['translated_names'].sort).to eq ["Vereinigte Staaten", "Estados Unidos", "United States"].sort
+    ISO3166.configuration.locales = [:en]
+    data = ISO3166::Data.new('US').call
+    expect(data['translated_names'].size).to eq (1)
+  end
+
+  it 'locales will load prior to return results' do
+    # require 'memory_profiler'
+    ISO3166.configuration.locales = [:es, :de, :en]
+    # report = MemoryProfiler.report do
+      ISO3166::Data.update_cache
+    # end
+
+    # report.pretty_print(to_file: 'tmp/memory/3_locales')
+    ISO3166::Data.update_cache
+
+    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
+    # puts Benchmark.measure {ISO3166::Data.update_cache}
+
+    # report = MemoryProfiler.report do
+      ISO3166::Data.update_cache
+    # end
+
+    # report.pretty_print(to_file: 'tmp/memory/all_locales')
+
+    expect(ISO3166::Country.new('DE').translations.size).to eq 92
+
+    expect(ISO3166.configuration.loaded_locales.size).to eq 92
+  end
+
+  it 'locales will load prior and be cached' do
+    ISO3166.reset
+    ISO3166.configuration.locales = [:es, :de, :en]
+    expect(ISO3166::Data.send(:locales_to_load) ).to eql(['es', 'de', 'en'])
+    ISO3166::Data.update_cache
+    ISO3166.configuration.locales = [:es, :de, :en]
+    expect(ISO3166::Data.send(:locales_to_load) ).to eql([])
+  end
+
+  it 'locales will load prior and be cached' do
+    ISO3166.reset
+    ISO3166.configuration.locales = [:es, :de, :en]
+    expect(ISO3166::Data.send(:locales_to_remove) ).to eql([])
+    expect(ISO3166::Country.new('DE').translation('de')).to eq 'Deutschland'
+    ISO3166::Data.update_cache
+    ISO3166.configuration.locales = [:es, :en]
+    expect(ISO3166::Data.send(:locales_to_remove) ).to eql(['de'])
+    expect(ISO3166::Country.new('DE').translation('de')).to eq nil
+  end
+end

data/spec/global_spec.rb

@@ -0,0 +1,29 @@
+  describe 'global Country class' do
+    context "when loaded via 'iso3166' existance" do
+      subject { defined?(Country) }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context "when loaded via 'global'" do
+      before { require 'countries/global' }
+
+      describe 'existance' do
+        subject { defined?(Country) }
+
+        it { is_expected.to be_truthy }
+      end
+
+      describe 'superclass' do
+        subject { Country.superclass }
+
+        it { is_expected.to eq(ISO3166::Country) }
+      end
+
+      describe 'to_s' do
+        it 'should return the country name' do
+          expect(Country.new('GB').to_s).to eq('United Kingdom')
+        end
+      end
+    end
+  end