Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A simple collection of geographic names and abbreviations for Rails apps (includes replacements for country_select and state_select)
Ruby
branch: 1.0dev

This branch is 236 commits behind jim:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
data
iso_data
lib
script
spec
test
.gitignore
CHANGELOG.md
DEPRECATED_API.md
Gemfile
MIT-LICENSE
README.md
Rakefile
VERSION
carmen.gemspec

README.md

Carmen- A repository of geographic regions for Ruby

A Little History

Carmen began its life as a replacement for Rails' country_select and state_select helpers. The API of the library was designed to facilitate a few view helpers and model validations, and that was about it.

Today

It's been a few years since Carmen was released, and it has been used by a lot of projects. Many fine individuals have contributed code and data- I'm really happy with the way the community has improved the library. But this growth has brought to light many of the weaknesses in the current library and implementation.

I have decided that it is time to go back and rethink Carmen's data model and API, and in the process address some long standing issues. Carmen 1.0 will feature the following:

  • A new, cleaner API
  • Support for the old API via an optional require
  • More complete data via the iso-codes Debian package (idea borrowed from here)
  • A sane approach to internationalization, utilizing an existing i18n library.

The TODO

  • Switch to a more complete data source (done)
  • Add the ability to overlay custom data on the dataset
  • Rewrite spike-level V2 API implementation
  • Provide a legacy api so existing users have an upgrade path ('carmen/legacy')
  • Separate Rails view methods out into a carmen-rails gem
  • i18n integration
Something went wrong with that request. Please try again.