carmen 0.1.1 → 0.2.0

data/.gitignore

@@ -2,3 +2,4 @@ doc
 pkg
 tags
 tmp
+.DS_Store

data/README.rdoc

@@ -2,10 +2,28 @@
 
 This library will work as a drop in replacement for the official Rails country_select and its various forks. The idea is to provide a single library for all geographic naming concerns, and unify them under a consistent API.
 
-States are supported for the following countries: Australia, Brazil, Canada, Cuba, Germany, Italy, Mexico, Ukraine, and United States.
+States are supported for the following countries: Australia, Brazil, Canada, Cuba, Denmark, Germany, Italy, Mexico, Norway, Spain, Ukraine, and United States.
 
-== State list retrieval
+== Installation
+
+  gem install carmen
+  
+If you're in Rails 2.3 or earlier, place this in your environment.rb:
+
+  config.gem 'carmen'
+  
+If you're in Rails 3, put this in your Gemfile:
+
+  gem "carmen"
 
+
+== Get a list of all countries
+  
+  Carmen.countries => […, ['Germany', 'DE'], …, ['United States', 'US'], …]
+  Carmen.countries(:locale => 'de') => […, ['Deutschland', 'DE'], …, ['Vereinigte Staaten von Amerika', 'US'], …]
+
+== State list retrieval
+  
   Carmen::states('US') => [['Alabama', 'AL'], ['Arkansas', 'AR'], ... ]
   Carmen::states => [['Alabama', 'AL'], ['Arkansas', 'AR'], ... ] # uses default country
   Carmen::state_names('US') => ['Alabama', 'Arkansas', ... ]
@@ -19,17 +37,61 @@ States are supported for the following countries: Australia, Brazil, Canada, Cub
   Carmen::state_code('Manitoba', 'CA') => 'MB'
   Carmen::state_name('AZ') => 'Arizona'
                    
-== The Data
 
-The raw lists are stored in constants
+== Default Country
 
-  Carmen::COUNTRIES => [['Afghanistan', 'AF'], ['Aland Islands', 'AX'], ]
+Methods that take a country code argument will use the default country if none is provided. The default default country is 'US'. You can change it to any country code:
 
-  Carmen::STATES => [['US', [['Alabama', 'AL'], ['Arkansas', 'AR'], ... ],
-                     ['CA', [['Alberta', 'AB'], ['British Columbia', 'BC'], ... ]]
+  Carmen.default_country = 'CA'
 
-== Default Country
+== Localization
 
-Methods that take a country code argument will use the default country if none is provided. The default default country is 'US'. You can change it to any country code:
+You can switch between different localizations of the countries list, by setting the locale value (default is :en):
+
+  Carmen.default_locale = :de
+  
+Methods that return country names also take an optional options hash as the last argument, which can be use to override the default locale for a single call:
+
+  Carmen::country_name('US') => 'United States'
+  Carmen::country_name('US', :locale => :de) => 'Vereinigte Staaten von Amerika'
+
+Currently included localizations are: English (:en), German (:de)
+
+
+== Todo
+
+* Many countries, such as Spain, have additional levels beneath 'state' that we would ideally support. Thanks to Alberto Molpeceres for bringing this to my attention.
+* Split the Rails-specific view helpers out into a separate gem (carmen-rails)
+
+== Changelog
+* 0.2.0 Merge in Maximilian Schulz's locale fork, refactor internals to better support locales, and update documentation.       
+        Remove Carmen::STATES and Carmen::COUNTRIES constants in favor of module instance variables and proper accessors.
+        Add a test_helper and remove dependency on RubyGems.
+* 0.1.3 DEPRECATE Carmen::COUNTRIES in favor of Carmen.countries
+
+
+== Development notes
+
+The plugin does not require rubygems anywhere in the test or libraries, so if you are having trouble with load errors running the tests, prepend your command with RUBYOPT=rubygems. {More info}[http://tomayko.com/writings/require-rubygems-antipattern].
+
+
+== Credits
+
+These fine characters have contributed state lists, patches, or reported bugs:
+
+Jose Angel Cortinas (jacortinas)
+Domizio Demichelis (ddnexus)
+Thiago Jackiw (railsfreaks)
+Russ Johnson (russjohnson)
+Henrik Hodne (dvyjones)
+Yuval Kordov (uberllama)
+Alberto Molpeceres (molpe)
+Dimas Priyanto (dimaspriyanto)
+Wojtek Ogrodowczyk (sharnik)
+Tobias Schmidt (grobie)
+Maximilian Schulz (namxam)
+Mani Tadayon (bowsersenior)
+Andriy Tyurnikov (andriytyurnikov)
+lonestarsoftware
 
-  Carmen.default_country = 'CA'
+If I missed your name in this list, please let me know and I will add it. I tried to find everyone that has sent in patches or found bugs, but I may have missed a few folks.

data/Rakefile

@@ -11,11 +11,12 @@ begin
     gem.email = "jim@autonomousmachine.com"
     gem.homepage = "http://github.com/jim/carmen"
     gem.authors = ["Jim Benton"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_development_dependency "mocha"
+    gem.add_development_dependency "rails"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
 require 'rake/testtask'
@@ -34,7 +35,7 @@ begin
   end
 rescue LoadError
   task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+    abort "RCov is not available. In order to run rcov, you must: gem install spicycode-rcov"
   end
 end
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/carmen.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{carmen}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jim Benton"]
-  s.date = %q{2010-01-09}
+  s.date = %q{2010-11-05}
   s.description = %q{A collection of geographis country and state names for Ruby. Also includes replacements for Rails' country_select and state_select plugins}
   s.email = %q{jim@autonomousmachine.com}
   s.extra_rdoc_files = [
@@ -22,40 +22,53 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "carmen.gemspec",
-     "data/countries.yml",
+     "data/countries/de.yml",
+     "data/countries/en.yml",
      "data/states/au.yml",
      "data/states/br.yml",
      "data/states/ca.yml",
      "data/states/cu.yml",
      "data/states/de.yml",
      "data/states/dk.yml",
+     "data/states/es.yml",
+     "data/states/hr.yml",
      "data/states/it.yml",
      "data/states/mx.yml",
+     "data/states/no.yml",
      "data/states/ua.yml",
      "data/states/us.yml",
      "lib/carmen.rb",
      "lib/carmen/action_view_helpers.rb",
      "rails/init.rb",
      "test/carmen_test.rb",
-     "test/carmen_view_helper_test.rb"
+     "test/carmen_view_helper_test.rb",
+     "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/jim/carmen}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A collection of geographis country and state names for Ruby}
   s.test_files = [
     "test/carmen_test.rb",
-     "test/carmen_view_helper_test.rb"
+     "test/carmen_view_helper_test.rb",
+     "test/test_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<rails>, [">= 0"])
     else
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 0"])
     end
   else
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 0"])
   end
 end
+

data/data/countries/de.yml

@@ -0,0 +1,525 @@
+--- 
+- - "Ascension (verwaltet von St. Helena)"
+  - AC
+- - Andorra
+  - AD
+- - Vereinigte Arabische Emirate
+  - AE
+- - Afghanistan
+  - AF
+- - Antigua und Barbuda
+  - AG
+- - Anguilla
+  - AI
+- - Albanien
+  - AL
+- - Armenien
+  - AM
+- - "Niederländische Antillen"
+  - AN
+- - Angola
+  - AO
+- - Antarktis
+  - AQ
+- - Argentinien
+  - AR
+- - Amerikanisch-Samoa
+  - AS
+- - Österreich
+  - AT
+- - Australien
+  - AU
+- - Aruba
+  - AW
+- - "Åland"
+  - AX
+- - Aserbaidschan
+  - AZ
+- - Bosnien und Herzegowina
+  - BA
+- - Barbados
+  - BB
+- - Bangladesch
+  - BD
+- - Belgien
+  - BE
+- - Burkina Faso
+  - BF
+- - Bulgarien
+  - BG
+- - Bahrain
+  - BH
+- - Burundi
+  - BI
+- - Benin
+  - BJ
+- - "Saint-Barthélemy"
+  - BL
+- - Bermuda
+  - BM
+- - Brunei Darussalam
+  - BN
+- - Bolivien
+  - BO
+- - Brasilien
+  - BR
+- - Bahamas
+  - BS
+- - Bhutan
+  - BT
+- - Burma (jetzt Myanmar)
+  - BU
+- - Bouvetinsel
+  - BV
+- - Botswana
+  - BW
+- - "Belarus (Weißrussland)"
+  - BY
+- - Belize
+  - BZ
+- - Kanada
+  - CA
+- - Kokosinseln
+  - CC
+- - Kongo, Demokratische Republik (ehem. Zaire)
+  - CD
+- - "Europäische Gemeinschaft"
+  - CE
+- - Zentralafrikanische Republik
+  - CF
+- - Republik Kongo
+  - CG
+- - Schweiz (Confoederatio Helvetica)
+  - CH
+- - "Côte d'Ivoire (Elfenbeinküste)"
+  - CI
+- - Cookinseln
+  - CK
+- - Chile
+  - CL
+- - Kamerun
+  - CM
+- - China, Volksrepublik
+  - CN
+- - Kolumbien
+  - CO
+- - "Clipperton"
+  - CP
+- - Costa Rica
+  - CR
+- - Serbien und Montenegro (ehemalig)
+  - CS
+- - Tschechoslowakei (ehemalig)
+  - CS
+- - Kuba
+  - CU
+- - Kap Verde
+  - CV
+- - Weihnachtsinsel
+  - CX
+- - Zypern
+  - CY
+- - Tschechische Republik
+  - CZ
+- - Deutschland
+  - DE
+- - "Diego Garcia"
+  - DG
+- - Dschibuti
+  - DJ
+- - "Dänemark"
+  - DK
+- - Dominica
+  - DM
+- - Dominikanische Republik
+  - DO
+- - Algerien
+  - DZ
+- - Ceuta, Melilla
+  - EA
+- - Ecuador
+  - EC
+- - Estland
+  - EE
+- - "Ägypten"
+  - EG
+- - Westsahara
+  - EH
+- - Eritrea
+  - ER
+- - Spanien
+  - ES
+- - "Äthiopien"
+  - ET
+- - "Europäische Union"
+  - EU
+- - Finnland
+  - FI (SF)
+- - Fidschi
+  - FJ
+- - Falklandinseln
+  - FK
+- - Mikronesien
+  - FM
+- - "Färöer"
+  - FO
+- - Frankreich
+  - FR
+- - "Frankreich (ohne Übersee-Départements)"
+  - FX
+- - Gabun
+  - GA
+- - "Vereinigtes Königreich Großritannien und Nordirland"
+  - GB
+- - Grenada
+  - GD
+- - Georgien
+  - GE
+- - "Französisch-Guayana"
+  - GF
+- - Guernsey (Kanalinsel)
+  - GG
+- - Ghana
+  - GH
+- - Gibraltar
+  - GI
+- - "Grönland"
+  - GL
+- - Gambia
+  - GM
+- - Guinea
+  - GN
+- - Guadeloupe
+  - GP
+- - "Äquatorialguinea"
+  - GQ
+- - Griechenland
+  - GR
+- - "Südgeorgien und die Südlichen Sandwichinseln"
+  - GS
+- - Guatemala
+  - GT
+- - Guam
+  - GU
+- - Guinea-Bissau
+  - GW
+- - Guyana
+  - GY
+- - Hongkong
+  - HK
+- - Heard und McDonaldinseln
+  - HM
+- - Honduras
+  - HN
+- - Kroatien
+  - HR
+- - Haiti
+  - HT
+- - Ungarn
+  - HU
+- - Kanarische Inseln
+  - IC
+- - Indonesien
+  - ID
+- - Irland
+  - IE
+- - Israel
+  - IL
+- - Insel Man
+  - IM
+- - Indien
+  - IN
+- - Britisches Territorium im Indischen Ozean
+  - IO
+- - Irak
+  - IQ
+- - Iran, Islamische Republik
+  - IR
+- - Island
+  - IS
+- - Italien
+  - IT
+- - Jersey (Kanalinsel)
+  - JE
+- - Jamaika
+  - JM
+- - Jordanien
+  - JO
+- - Japan
+  - JP
+- - Kenia
+  - KE
+- - Kirgisistan
+  - KG
+- - Kambodscha
+  - KH
+- - Kiribati
+  - KI
+- - Komoren
+  - KM
+- - St. Kitts und Nevis
+  - KN
+- - Korea, Demokratische Volksrepublik (Nordkorea)
+  - KP
+- - "Korea, Republik (Südkorea)"
+  - KR
+- - Kuwait
+  - KW
+- - Kaimaninseln
+  - KY
+- - Kasachstan
+  - KZ
+- - Laos, Demokratische Volksrepublik
+  - LA
+- - Libanon
+  - LB
+- - St. Lucia
+  - LC
+- - Liechtenstein
+  - LI
+- - Sri Lanka
+  - LK
+- - Liberia
+  - LR
+- - Lesotho
+  - LS
+- - Litauen
+  - LT
+- - Luxemburg
+  - LU
+- - Lettland
+  - LV
+- - Libysch-Arabische Dschamahirija (Libyen)
+  - LY
+- - Marokko
+  - MA
+- - Monaco
+  - MC
+- - Moldawien (Republik Moldau)
+  - MD
+- - Montenegro
+  - ME
+- - Saint-Martin (franz. Teil)
+  - MF
+- - Madagaskar
+  - MG
+- - Marshallinseln
+  - MH
+- - Mazedonien, ehem. jugoslawische Republik
+  - MK
+- - Mali
+  - ML
+- - Myanmar (Burma)
+  - MM
+- - Mongolei
+  - MN
+- - Macao
+  - MO
+- - "Nördliche Marianen"
+  - MP
+- - Martinique
+  - MQ
+- - Mauretanien
+  - MR
+- - Montserrat
+  - MS
+- - Malta
+  - MT
+- - Mauritius
+  - MU
+- - Malediven
+  - MV
+- - Malawi
+  - MW
+- - Mexiko
+  - MX
+- - Malaysia
+  - MY
+- - Mosambik
+  - MZ
+- - Namibia
+  - NA
+- - Neukaledonien
+  - NC
+- - Niger
+  - NE
+- - Norfolkinsel
+  - NF
+- - Nigeria
+  - NG
+- - Nicaragua
+  - NI
+- - Niederlande
+  - NL
+- - Norwegen
+  - NO
+- - Nepal
+  - NP
+- - Nauru
+  - NR
+- - Neutrale Zone (Saudi-Arabien und Irak bis 1993)
+  - NT
+- - Niue
+  - NU
+- - Neuseeland
+  - NZ
+- - Oman
+  - OM
+- - Panama
+  - PA
+- - Peru
+  - PE
+- - "Französisch-Polynesien"
+  - PF
+- - Papua-Neuguinea
+  - PG
+- - Philippinen
+  - PH
+- - Pakistan
+  - PK
+- - Polen
+  - PL
+- - Saint-Pierre und Miquelon
+  - PM
+- - Pitcairninseln
+  - PN
+- - Puerto Rico
+  - PR
+- - "Palästinensische Autonomiegebiete"
+  - PS
+- - Portugal
+  - PT
+- - Palau
+  - PW
+- - Paraguay
+  - PY
+- - Katar
+  - QA
+- - "Réunion"
+  - RE
+- - "Rumänien"
+  - RO
+- - Serbien
+  - RS
+- - "Russische Föderation"
+  - RU
+- - Ruanda
+  - RW
+- - Saudi-Arabien
+  - SA
+- - Salomonen
+  - SB
+- - Seychellen
+  - SC
+- - Sudan
+  - SD
+- - Schweden
+  - SE
+- - Singapur
+  - SG
+- - St. Helena
+  - SH
+- - Slowenien
+  - SI
+- - Svalbard und Jan Mayen
+  - SJ
+- - Slowakei
+  - SK
+- - Sierra Leone
+  - SL
+- - San Marino
+  - SM
+- - Senegal
+  - SN
+- - Somalia
+  - SO
+- - Suriname
+  - SR
+- - "São Tomé und Príncipe"
+  - ST
+- - "UdSSR (jetzt: Russische Föderation)"
+  - SU
+- - El Salvador
+  - SV
+- - Syrien, Arabische Republik
+  - SY
+- - Swasiland
+  - SZ
+- - "Tristan da Cunha (verwaltet von St. Helena)"
+  - TA
+- - Turks- und Caicosinseln
+  - TC
+- - Tschad
+  - TD
+- - "Französische Süd- und Antarktisgebiete"
+  - TF
+- - Togo
+  - TG
+- - Thailand
+  - TH
+- - Tadschikistan
+  - TJ
+- - Tokelau
+  - TK
+- - Osttimor (Timor-Leste)
+  - TL
+- - Turkmenistan
+  - TM
+- - Tunesien
+  - TN
+- - Tonga
+  - TO
+- - "Türkei"
+  - TR
+- - Trinidad und Tobago
+  - TT
+- - Tuvalu
+  - TV
+- - Republik China (Taiwan)
+  - TW
+- - Tansania, Vereinigte Republik
+  - TZ
+- - Ukraine
+  - UA
+- - Uganda
+  - UG
+- - United States Minor Outlying Islands
+  - UM
+- - Vereinigte Staaten von Amerika
+  - US
+- - Uruguay
+  - UY
+- - Usbekistan
+  - UZ
+- - Vatikanstadt
+  - VA
+- - St. Vincent und die Grenadinen
+  - VC
+- - Venezuela
+  - VE
+- - Britische Jungferninseln
+  - VG
+- - Amerikanische Jungferninseln
+  - VI
+- - Vietnam
+  - VN
+- - Vanuatu
+  - VU
+- - Wallis und Futuna
+  - WF
+- - Samoa
+  - WS
+- - Jemen
+  - YE
+- - Mayotte
+  - YT
+- - Jugoslawien (ehemalig)
+  - YU
+- - "Südafrika"
+  - ZA
+- - Sambia
+  - ZM
+- - Zaire (jetzt Demokratische Republik Kongo)
+  - ZR
+- - Simbabwe
+  - ZW