countries 1.2.2 → 4.2.3

data/lib/countries/data.rb

@@ -1,33 +1,178 @@
 module ISO3166
-  ##
   # Handles building the in memory store of countries data
   class Data
-    @@cache = nil
+    @@cache_dir = [File.dirname(__FILE__), 'cache']
+    @@cache = {}
+    @@registered_data = {}
+    @@mutex = Mutex.new
+
     def initialize(alpha2)
       @alpha2 = alpha2.to_s.upcase
-      Data.load_cache unless @@cache
     end
 
     def call
-      @@cache[@alpha2]
+      self.class.update_cache[@alpha2]
     end
 
-    def self.codes
-      @@codes ||= Data.load_yaml(['countries', 'data', 'countries.yaml']).freeze
-    end
+    class << self
+      def cache_dir
+        @@cache_dir
+      end
 
-    private
+      def cache_dir=(value)
+        @@cache_dir = value
+      end
 
-    def self.datafile_path(file_array)
-      File.join([File.dirname(__FILE__), '..'] + file_array)
-    end
+      # Registers a new Country with custom data.
+      # If you are overriding an existing country, this does not perform a deep merge so you will need to __bring in all data you wish to be available__.
+      # Overriding an existing country will also remove it from the internal management of translations.
+      def register(data)
+        alpha2 = data[:alpha2].upcase
+        @@registered_data[alpha2] = deep_stringify_keys(data)
+        @@registered_data[alpha2]['translations'] = \
+          Translations.new.merge(data['translations'] || {})
+        @@cache = cache.merge(@@registered_data)
+      end
 
-    def self.load_yaml(file_array)
-      YAML.load_file(datafile_path(file_array))
-    end
+      # Removes a country from the loaded data
+      def unregister(alpha2)
+        alpha2 = alpha2.to_s.upcase
+        @@cache.delete(alpha2)
+        @@registered_data.delete(alpha2)
+      end
+
+      def cache
+        update_cache
+      end
+
+      # Resets the loaded data and cache
+      def reset
+        @@cache = {}
+        @@registered_data = {}
+        ISO3166.configuration.loaded_locales = []
+      end
+
+      def codes
+        load_data!
+        loaded_codes
+      end
+
+      def update_cache
+        load_data!
+        sync_translations!
+        @@cache
+      end
+
+      def load_data!
+        return @@cache unless load_required?
+        synchronized do
+          @@cache = load_cache %w(countries.json)
+          @@_country_codes = @@cache.keys
+          @@cache = @@cache.merge(@@registered_data)
+          @@cache
+        end
+      end
+
+      def sync_translations!
+        return unless cache_flush_required?
+
+        locales_to_remove.each do |locale|
+          unload_translations(locale)
+        end
+
+        locales_to_load.each do |locale|
+          load_translations(locale)
+        end
+      end
+
+      private
+
+      def synchronized(&block)
+        if use_mutex?
+          @@mutex.synchronize(&block)
+        else
+          block.call
+        end
+      end
+
+      def use_mutex?
+        # Stubbed in testing
+        true
+      end
+
+      def load_required?
+        synchronized do
+          @@cache.empty?
+        end
+      end
+
+      def loaded_codes
+        @@cache.keys
+      end
+
+      # Codes that we have translations for in dataset
+      def internal_codes
+        @@_country_codes - @@registered_data.keys
+      end
+
+      def cache_flush_required?
+        !locales_to_load.empty? || !locales_to_remove.empty?
+      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)
+        synchronized do
+          locale_names = load_cache(['locales', "#{locale}.json"])
+          internal_codes.each do |alpha2|
+            @@cache[alpha2]['translations'] ||= Translations.new
+            @@cache[alpha2]['translations'][locale] = locale_names[alpha2].freeze
+            @@cache[alpha2]['translated_names'] = @@cache[alpha2]['translations'].values.freeze
+          end
+          ISO3166.configuration.loaded_locales << locale
+        end
+      end
+
+      def unload_translations(locale)
+        synchronized do
+          internal_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
+      end
+
+      def load_cache(file_array)
+        file_path = datafile_path(file_array)
+        File.exist?(file_path) ? JSON.parse(File.binread(file_path)) : {}
+      end
+
+      def datafile_path(file_array)
+        File.join([@@cache_dir] + file_array)
+      end
 
-    def self.load_cache
-      @@cache ||= Marshal.load(File.binread(datafile_path %w(countries cache countries )))
+      def deep_stringify_keys(data)
+        data.transform_keys!(&:to_s)
+        data.transform_values! do |v|
+          v.is_a?(Hash) ? deep_stringify_keys(v) : v
+        end
+        return data
+      end
     end
   end
 end

data/lib/countries/global.rb

@@ -1,7 +1,17 @@
 require 'countries'
 
+# Some apps might not want to constantly call +ISO3166::Country+. This gem has a helper that can provide a Country class
+#
+# With global Country Helper enabled
+#
+#   c = Country['US']
+#
+# This will conflict with any existing Country constant
+#
+# To Use
+#
+#   gem 'countries', require: 'countries/global'
+#
 class Country < ISO3166::Country
-  def to_s
-    name
-  end
+
 end

data/lib/countries/iso3166.rb

@@ -1,7 +1,14 @@
 require 'yaml'
-require 'iso4217'
+require 'json'
 require 'i18n_data'
 
-require 'countries/setup'
+require 'countries/kwarg_struct'
+require 'countries/configuration'
 require 'countries/data'
+require 'countries/structure'
+require 'countries/translations'
+require 'countries/country/class_methods'
+require 'countries/country/emoji'
 require 'countries/country'
+require 'countries/subdivision'
+require 'countries/timezones'

data/lib/countries/kwarg_struct.rb

@@ -0,0 +1,12 @@
+module ISO3166
+  class KwargStruct < Struct
+    # Override the initialize to handle hashes of named parameters
+    def initialize(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      super(*args)
+      opts.each_pair do |k, v|
+        send "#{k}=", v
+      end
+    end
+  end
+end

data/lib/countries/mongoid.rb

@@ -1,31 +1,34 @@
-module ISO3166; end
-
-class ISO3166::Country
-  def mongoize
-    ISO3166::Country.mongoize(self)
-  end
+module ISO3166
+  class Country
+    def mongoize
+      ISO3166::Country.mongoize(self)
+    end
 
-  class << self
-    def mongoize(country)
-      if country.is_a?(self) && !country.data.nil?
-        country.alpha2
-      elsif send(:valid_alpha2?, country)
-        new(country).alpha2
+    class << self
+      # Convert an +ISO3166::Country+ to the data that is stored by Mongoid.
+      def mongoize(country)
+        if country.is_a?(self) && !country.data.nil?
+          country.alpha2
+        elsif send(:valid_alpha2?, country)
+          new(country).alpha2
+        end
       end
-    end
 
-    def demongoize(alpha2)
-      new(alpha2)
-    end
+      # Get the object as it was stored with Mongoid, and instantiate an +ISO3166::Country+.
+      def demongoize(alpha2)
+        new(alpha2)
+      end
 
-    def evolve(country)
-      mongoize(country)
-    end
+      # Convert an +ISO3166::Country+ to the data that is stored by Mongoid.
+      def evolve(country)
+        mongoize(country)
+      end
 
-    private
+      private
 
-    def valid_alpha2?(country)
-      country.is_a?(String) && !ISO3166::Country.new(country).nil?
+      def valid_alpha2?(country)
+        country.is_a?(String) && !ISO3166::Country.new(country).nil?
+      end
     end
   end
 end

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/sources/cldr/downloader.rb

@@ -0,0 +1,37 @@
+require 'uri'
+require 'net/http'
+require 'nokogiri'
+require 'fileutils'
+require 'json'
+
+# Support code to allow updating subdivision data from the Unicode CLDR repository
+module Sources
+  # Support code to allow updating subdivision data from the Unicode CLDR repository
+  module CLDR
+    # Downloads data from the Unicode CLDR repository
+    module Downloader
+      module_function
+
+      def subdivisions
+        download_folder('subdivisions')
+      end
+
+      def download_folder(type)
+        folder = File.join(ISO3166_ROOT_PATH, 'tmp', 'cldr', 'trunk', 'common', type)
+        FileUtils.mkdir_p(folder)
+        url = URI.parse("https://api.github.com/repos/unicode-org/cldr/contents/common/" + type)
+        path_listing = JSON.parse(Net::HTTP.get_response(url).body)
+        path_listing.each do |path|
+          if path['name'] =~ /\.xml$/
+            File.open(File.join(folder, path['name']), 'w') do |f|
+              raw_url = URI.parse(path['download_url'])
+              f.write(Net::HTTP.get_response(raw_url).body)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/lib/countries/sources/cldr/subdivision.rb

@@ -0,0 +1,35 @@
+module Sources
+  module CLDR
+    # Auxiliary Subdivision class to support loading Unicode CLDR data to update local files
+    class Subdivision
+      attr_reader :xml, :language_code
+      def initialize(language_code:, xml:)
+        @language_code = language_code
+        @xml = xml
+      end
+
+      def text
+        xml.text
+      end
+
+      def country_code
+        type[0..1].upcase
+      end
+
+      def code
+        type[2..-1].upcase
+      end
+
+      def type
+        xml.attributes['type'].value.delete('-')
+      end
+
+      def to_h
+        data = {}
+        data['translations'] ||= {}
+        data['translations'][language_code] = text
+        data
+      end
+    end
+  end
+end

data/lib/countries/sources/cldr/subdivision_updater.rb

@@ -0,0 +1,35 @@
+require 'active_support'
+require 'active_support/core_ext/hash/deep_merge'
+require 'nokogiri'
+require 'pry'
+
+module Sources
+  module CLDR
+    # Updates local subdivision files with data from the Unicode CLDR repository
+    class SubdivisionUpdater
+      def call
+        d = Dir['./tmp/cldr/trunk/common/subdivisions/*.xml']
+        loader = Sources::Local::CachedLoader.new(Sources::Local::Subdivision)
+        d.each do |file_path|
+          language_data = Nokogiri::XML(File.read(file_path))
+          language_code = File.basename(file_path, '.*')
+          subdivisions = language_data.css('subdivision')
+          next if subdivisions.empty?
+          last_country_code_seen = nil
+
+          subdivisions.each_with_index do |subdivision, index|
+            subdivision = Sources::CLDR::Subdivision.new(language_code: language_code, xml: subdivision)
+            data = loader.load(subdivision.country_code)
+            data[subdivision.code] ||= {}
+            data[subdivision.code] = data[subdivision.code].deep_merge(subdivision.to_h)
+            if (last_country_code_seen && last_country_code_seen != subdivision.country_code) || index == subdivisions.size - 1
+              puts "Updated #{subdivision.country_code} with language_code #{language_code}"
+              loader.save(subdivision.country_code, data)
+            end
+            last_country_code_seen = subdivision.country_code
+          end
+        end
+      end
+    end
+  end
+end

data/lib/countries/sources/local/cached_loader.rb

@@ -0,0 +1,29 @@
+module Sources
+  # Support code to allow updating subdivision data from the Unicode CLDR repository
+  module Local
+    # Loader for locally-cached data, to allow merging Unicode CLDR data with existing local data
+    class CachedLoader
+      attr_reader :klass
+      def initialize(klass)
+        @klass = klass
+        @loaded_countries = {}
+      end
+
+      def from_cache(country_code)
+        @loaded_countries[country_code]
+      end
+
+      def load(country_code)
+        if (data = from_cache(country_code))
+          data
+        else
+          @loaded_countries[country_code] = klass.load(country_code)
+        end
+      end
+
+      def save(country_code, data)
+        klass.new(country_code).save(data)
+      end
+    end
+  end
+end

data/lib/countries/sources/local/subdivision.rb

@@ -0,0 +1,33 @@
+module Sources
+  module Local
+    # Auxiliary Subdivision class to support loading the local subdivision data to be updated with Unicode CLDR data
+    class Subdivision
+      attr_reader :code
+      def initialize(code)
+        @code = code
+      end
+
+      def load
+        if File.exist?(file_path)
+          YAML.load_file(file_path) || {}
+        else
+          {}
+        end
+      end
+
+      def save(data)
+        File.open(file_path, 'w') { |f| f.write data.to_yaml }
+      rescue
+        puts "failed to read #{file}: #{$ERROR_INFO}"
+      end
+
+      def file_path
+        "lib/countries/data/subdivisions/#{code}.yaml"
+      end
+
+      def self.load(code)
+        new(code).load
+      end
+    end
+  end
+end

data/lib/countries/sources.rb

@@ -0,0 +1,6 @@
+require_relative './sources/local/cached_loader'
+require_relative './sources/local/subdivision'
+
+require_relative './sources/cldr/downloader'
+require_relative './sources/cldr/subdivision'
+require_relative './sources/cldr/subdivision_updater'

data/lib/countries/structure.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+#
+module ISO3166
+  DEFAULT_COUNTRY_HASH = {
+    'address_format' => nil,
+    'alpha2' => nil,
+    'alpha3' => nil,
+    'continent' => nil,
+    'country_code' => nil,
+    'currency_code' => nil,
+    'gec' => nil,
+    'geo' => {
+      'latitude' => nil,
+      'longitude' => nil,
+      'max_latitude' => nil,
+      'max_longitude' => nil,
+      'min_latitude' => nil,
+      'min_longitude' => nil,
+      'bounds' => {
+        'northeast' => {
+          'lat' => nil,
+          'lng' => nil
+        },
+        'southwest' => {
+          'lat' => nil,
+          'lng' => nil
+        }
+      }
+    },
+    'international_prefix' => nil,
+    'ioc' => nil,
+    'iso_long_name' => nil,
+    'iso_short_name' => nil,
+    'national_destination_code_lengths' => [],
+    'national_number_lengths' => [],
+    'national_prefix' => nil,
+    'nanp_prefix' => nil,
+    'nationality' => nil,
+    'number' => nil,
+    'languages_official' => [],
+    'languages_spoken' => [],
+    'translations' => {},
+    'postal_code' => nil,
+    'postal_code_format' => nil,
+    'region' => nil,
+    'unofficial_names' => [],
+    'start_of_week' => 'monday',
+    'subregion' => nil,
+    'un_locode' => nil,
+    'vat_rates' => {
+      'standard' => nil,
+      'reduced' => [nil, nil],
+      'super_reduced' => nil,
+      'parking' => nil
+    },
+    'world_region' => nil
+  }.freeze
+
+  DEFAULT_SUBDIVISION_HASH = {
+    'name' => nil,
+    'unofficial_names' => [],
+    'translations' => {},
+    'geo' => {
+      'latitude' => nil,
+      'longitude' => nil,
+      'max_latitude' => nil,
+      'max_longitude' => nil,
+      'min_latitude' => nil,
+      'min_longitude' => nil
+    }
+  }.freeze
+end

data/lib/countries/subdivision.rb

@@ -0,0 +1,10 @@
+module ISO3166
+  Subdivision = KwargStruct.new(
+    :name,
+    :code,
+    :unofficial_names,
+    :geo,
+    :translations,
+    :comments
+  )
+end