carmen-rails is a Rails 3 plugin that supplies two new form helper methods:
country_select
and subregion_select
. It uses
carmen as its source of geographic data.
Just add carmen-rails to your Gemfile:
gem 'carmen-rails', '~> 1.0.0.beta3'
<%= form_for(@order) do |f| %>
<div class="field">
<%= f.label :country_code %><br />
<%= f.country_select :country_code, {priority: %w(US CA)}, prompt: 'Please select a country' %>
</div>
<% end %>
Carmen had a concept of excluded countries in the old days, where you could specify certain countries or regions to not include in a select.
The new (and much more flexible) way to handle this is to write a helper method that returns the subset of regions you want to provide:
def only_us_and_canada
Carmen::Country.all.select{|c| %w{US CA}.include?(c.code)}
end
And then in your form something like this:
<%= f.select :country, region_options_for_select(only_us_and_canada) %>
More docs coming soon. In the meantime, all of the public methods in carmen-rails have been thoroughly TomDoc'ed.
There is a live demo app that shows carmen-rails in action, and includes a step-by-step setup guide.
Using this library will automatically set Carmen to use Rails' built-in I18n functionality. This means that changing
some configuration should be done through Rails and not Carmen. For example, adding paths for additional locale files
should be done inside config/application.rb
:
config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]