carmen 0.2.13 → 1.0.0.beta1

data/iso_data/world/vn.yml

@@ -0,0 +1,129 @@
+---
+- code: '01'
+  type: province
+- code: '02'
+  type: province
+- code: '03'
+  type: province
+- code: '04'
+  type: province
+- code: '05'
+  type: province
+- code: '06'
+  type: province
+- code: '07'
+  type: province
+- code: '09'
+  type: province
+- code: '13'
+  type: province
+- code: '14'
+  type: province
+- code: '15'
+  type: province
+- code: '18'
+  type: province
+- code: '20'
+  type: province
+- code: '21'
+  type: province
+- code: '22'
+  type: province
+- code: '23'
+  type: province
+- code: '24'
+  type: province
+- code: '25'
+  type: province
+- code: '26'
+  type: province
+- code: '27'
+  type: province
+- code: '28'
+  type: province
+- code: '29'
+  type: province
+- code: '30'
+  type: province
+- code: '31'
+  type: province
+- code: '32'
+  type: province
+- code: '33'
+  type: province
+- code: '34'
+  type: province
+- code: '35'
+  type: province
+- code: '36'
+  type: province
+- code: '37'
+  type: province
+- code: '39'
+  type: province
+- code: '40'
+  type: province
+- code: '41'
+  type: province
+- code: '43'
+  type: province
+- code: '44'
+  type: province
+- code: '45'
+  type: province
+- code: '46'
+  type: province
+- code: '47'
+  type: province
+- code: '48'
+  type: province
+- code: '49'
+  type: province
+- code: '50'
+  type: province
+- code: '51'
+  type: province
+- code: '52'
+  type: province
+- code: '53'
+  type: province
+- code: '54'
+  type: province
+- code: '55'
+  type: province
+- code: '56'
+  type: province
+- code: '57'
+  type: province
+- code: '58'
+  type: province
+- code: '59'
+  type: province
+- code: '60'
+  type: province
+- code: '61'
+  type: province
+- code: '62'
+  type: province
+- code: '63'
+  type: province
+- code: '64'
+  type: province
+- code: '65'
+  type: province
+- code: '66'
+  type: province
+- code: '67'
+  type: province
+- code: '68'
+  type: province
+- code: '69'
+  type: province
+- code: '70'
+  type: province
+- code: '71'
+  type: province
+- code: '72'
+  type: province
+- code: '73'
+  type: province

data/iso_data/world/vu.yml

@@ -0,0 +1,13 @@
+---
+- code: MAP
+  type: province
+- code: PAM
+  type: province
+- code: SAM
+  type: province
+- code: SEE
+  type: province
+- code: TAE
+  type: province
+- code: TOB
+  type: province

data/iso_data/world/ws.yml

@@ -0,0 +1,23 @@
+---
+- code: AA
+  type: district
+- code: AL
+  type: district
+- code: AT
+  type: district
+- code: FA
+  type: district
+- code: GE
+  type: district
+- code: GI
+  type: district
+- code: PA
+  type: district
+- code: SA
+  type: district
+- code: TU
+  type: district
+- code: VF
+  type: district
+- code: VS
+  type: district

data/iso_data/world/ye.yml

@@ -0,0 +1,41 @@
+---
+- code: AB
+  type: governorate
+- code: AD
+  type: governorate
+- code: AM
+  type: governorate
+- code: BA
+  type: governorate
+- code: DA
+  type: governorate
+- code: DH
+  type: governorate
+- code: HD
+  type: governorate
+- code: HJ
+  type: governorate
+- code: IB
+  type: governorate
+- code: JA
+  type: governorate
+- code: LA
+  type: governorate
+- code: MA
+  type: governorate
+- code: MR
+  type: governorate
+- code: MU
+  type: governorate
+- code: MW
+  type: governorate
+- code: RA
+  type: governorate
+- code: SD
+  type: governorate
+- code: SH
+  type: governorate
+- code: SN
+  type: governorate
+- code: TA
+  type: governorate

data/iso_data/world/za.yml

@@ -0,0 +1,19 @@
+---
+- code: EC
+  type: province
+- code: FS
+  type: province
+- code: GT
+  type: province
+- code: LP
+  type: province
+- code: MP
+  type: province
+- code: NC
+  type: province
+- code: NL
+  type: province
+- code: NW
+  type: province
+- code: WC
+  type: province

data/iso_data/world/zm.yml

@@ -0,0 +1,19 @@
+---
+- code: '01'
+  type: province
+- code: '02'
+  type: province
+- code: '03'
+  type: province
+- code: '04'
+  type: province
+- code: '05'
+  type: province
+- code: '06'
+  type: province
+- code: '07'
+  type: province
+- code: '08'
+  type: province
+- code: '09'
+  type: province

data/iso_data/world/zw.yml

@@ -0,0 +1,21 @@
+---
+- code: BU
+  type: city
+- code: HA
+  type: city
+- code: MA
+  type: province
+- code: MC
+  type: province
+- code: ME
+  type: province
+- code: MI
+  type: province
+- code: MN
+  type: province
+- code: MS
+  type: province
+- code: MV
+  type: province
+- code: MW
+  type: province

data/lib/carmen.rb

@@ -1,161 +1,70 @@
 require 'yaml'
-begin
-  require 'ftools'
-rescue LoadError
-  require 'fileutils' # ftools is now fileutils in Ruby 1.9
-end
+require 'pathname'
 
-# Fix to autoload in Rails 3
-if defined?(Rails)
-  if Rails::VERSION::MAJOR > 2
-    require 'carmen/railtie'
-  else
-    require 'carmen/action_view_helpers'
-  end
-end
+lib_path = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib_path)
 
+require 'carmen/country'
+require 'carmen/i18n'
 require 'carmen/version'
 
 module Carmen
   class << self
-    attr_accessor :default_country, :default_locale, :excluded_countries, :excluded_states,
-                  :priority_countries
-  end
-
-  self.default_country = 'US'
-  self.default_locale = :en
-  self.excluded_countries = []
-  self.excluded_states = {}
-  self.priority_countries = []
-
-  @data_path = File.join(File.dirname(__FILE__), '..', 'data')
-
-  @states = Dir[File.join(@data_path, '/states/*.yml')].map do |file_name|
-    [File.basename(file_name, '.yml').upcase, YAML.load_file(file_name)]
-  end
-
-  # Raised when attempting to retrieve states for an unsupported country
-  class StatesNotSupported < RuntimeError; end
-
-  # Raised when attempting to work with a country not in the data set
-  class NonexistentCountry < RuntimeError; end
 
-  # Raised when attemting to switch to a locale which does not exist
-  class UnavailableLocale < RuntimeError; end
-
-  # Returns a list of all countries
-  def self.countries(options={})
-    # Use specified locale or fall back to default locale
-    locale = (options.delete(:locale) || @default_locale).to_s
-
-    # Load the country list for the specified locale
-    @countries ||= {}
-    unless @countries[locale]
-      # Check if data in the specified locale is available
-      localized_data = File.join(@data_path, "countries", "#{locale}.yml")
-      unless File.exists?(localized_data)
-        localized_data = File.join(@data_path, "countries", "#{@default_locale}.yml")
-        # raise(UnavailableLocale, "Could not load countries for '#{locale}' locale")
-      end
-
-      # As the data exists, load it
-      @countries[locale] = YAML.load_file(localized_data)
+    # Public: An array of locations where data files for Carmen are stored.
+    #
+    # Data in entries that appear later in the array takes precedence.
+    #
+    # Each path should follow the following structure:
+    # |- world.yml (all countries)
+    # \- regions   (directory for subregions, named by code)
+    #  |- be.yml   (subregion file for a country)
+    #
+    # Defaults to only the the `iso_data` directory within the Carmen directory.
+    attr_reader :data_paths
+
+    # Public: an object to use as the I18n backend.
+    #
+    # Ths suppiled object must respond to
+    # t(key).
+    #
+    # Defaults to an instance of Carmen::I18n::Simple.
+    attr_accessor :i18n_backend
+
+    # Private: the Carmen library's root directory.
+    #
+    # Provides a way to find the built-in data and locale files.
+    attr_accessor :root_path
+
+    # Public: Set the data path.
+    # path - The String path to the data directory.
+    def append_data_path(path)
+      World.instance.reset!
+      @data_paths << Pathname.new(path)
     end
 
-    # Return data after filtering excluded countries and prepending prepended countries
-    result = @countries[locale].reject { |c| excluded_countries.include?( c[1] ) }
-    priority_countries.map { |code| [ search_collection(result, code, 1, 0), code ] } + result
-  end
-
-
-  # Returns the country name corresponding to the supplied country code, optionally using the specified locale.
-  #  Carmen::country_name('TR') => 'Turkey'
-  #  Carmen::country_name('TR', :locale => :de) => 'Türkei'
-  def self.country_name(country_code, options={})
-    search_collection(countries(options), country_code, 1, 0)
-  end
-
-  # Returns the country code corresponding to the supplied country name
-  #  Carmen::country_code('Canada') => 'CA'
-  def self.country_code(country_name, options={})
-    search_collection(countries(options), country_name, 0, 1)
-  end
-
-  # Returns an array of all country codes
-  #  Carmen::country_codes => ['AF', 'AX', 'AL', ... ]
-  def self.country_codes
-    countries.map {|c| c[1] }
-  end
-
-  # Returns an array of all country names, optionally using the specified locale.
-  #  Carmen::country_names => ['Afghanistan', 'Aland Islands', 'Albania', ... ]
-  #  Carmen::country_names(:locale => :de) => ['Afghanistan', 'Åland', 'Albanien', ... ]
-  def self.country_names(options={})
-    countries(options).map {|c| c[0] }
-  end
-
-  # Returns the state name corresponding to the supplied state code within the default country
-  #  Carmen::state_code('New Hampshire') => 'NH'
-  def self.state_name(state_code, country_code = Carmen.default_country, options={})
-    search_collection(self.states(country_code, options), state_code, 1, 0)
-  end
-
-  # Returns the state code corresponding to the supplied state name within the specified country
-  #  Carmen::state_code('IL', 'US') => Illinois
-  def self.state_code(state_name, country_code = Carmen.default_country, options={})
-    search_collection(self.states(country_code, options), state_name, 0, 1)
-  end
-
-  # Returns an array of state names within the default code
-  #  Carmen::state_names('US') => ['Alabama', 'Arkansas', ... ]
-  def self.state_names(country_code = Carmen.default_country, options={})
-    self.states(country_code, options).map{|name, code| name}
-  end
-
-  # Returns an array of state codes within the specified country code
-  #   Carmen::state_codes('US') => ['AL', 'AR', ... ]
-  def self.state_codes(country_code = Carmen.default_country)
-    self.states(country_code).map{|name, code| code}
-  end
-
-  # Returns an array structure of state names and codes within the specified country code, or within the default country
-  # if none is provided.
-  #   Carmen::states('US') => [['Alabama', 'AL'], ['Arkansas', 'AR'], ... ]
-  #   Carmen::states => [['Alabama', 'AL'], ['Arkansas', 'AR'], ... ]
-  def self.states(country_code = Carmen.default_country, options={})
-    raise NonexistentCountry.new("Country not found for code #{country_code}") unless country_codes.include?(country_code)
-    raise StatesNotSupported unless states?(country_code)
-
-    results = search_collection(@states, country_code, 0, 1)
+    # Public: Clear the data_paths array.
+    # path - The String path to the data directory.
+    def clear_data_paths
+      World.instance.reset!
+      @data_paths = []
+    end
 
-    if excluded_states[country_code]
-        results.reject { |s| excluded_states[country_code].include?(s[1]) }
-    else
-        results
+    # Public: Reset the data_paths array to the defaults.
+    def reset_data_paths
+      clear_data_paths
+      append_data_path(root_path + 'iso_data')
     end
-  end
 
-  # Returns whether states are supported for the given country code
-  #   Carmen::states?('US') => true
-  #   Carmen::states?('ZZ') => false
-  def self.states?(country_code, options={})
-    @states.any? do |array| k,v = array
-      k == country_code
+    def reset_i18n_backend
+      locale_path = root_path + 'locale'
+      self.i18n_backend = Carmen::I18n::Simple.new(locale_path)
     end
   end
 
-  protected
+  self.root_path = Pathname.new(__FILE__) + '../..'
+
+  self.reset_data_paths
+  self.reset_i18n_backend
 
-  def self.search_collection(collection, value, index_to_match, index_to_retrieve)
-    value = value.to_s
-    return nil if collection.nil? || value =~ /^\s*$/
-    collection.each do |m|
-      return m[index_to_retrieve] if m[index_to_match].downcase == value.downcase
-    end
-    # In case we didn't get any results we'll try a broader search (via Regexp)
-    collection.each do |m|
-      return m[index_to_retrieve] if m[index_to_match].downcase.match(Regexp.escape(value.downcase))
-    end
-    nil
-  end
 end