Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Locale setting for rails projects
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
gemfiles
lib
spec
.document
.gitignore
.rspec
.travis.yml
Appraisals
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
rails_locale_detection.gemspec

README.md

rails_locale_detection

Build Status Dependency Status

Sets the current locale of a request using a combination of params, cookies, http headers, and an optional user object.

In turn, it checks the value of params[:locale], cookies[:locale] and HTTP_ACCEPT_LANGUAGE headers to find a locale that corresponds to the available locales, then stores the locale in a cookie for future requests. If a user_locale method is provided, any valid return value will be used, with preference over the other locale detection methods except for params[:locale].

Changes to version 2

  • Rails 4 compatibility
  • Namespace has been changed from Rails::LocaleDetection to RailsLocaleDetection, although the previous namespace is still supported for legacy config files
  • Locale detection has been moved to a seperate object, to avoid polluting controllers with extra methods.
  • Detection order has been changed to param first, as this make more sense in most contexts.
  • Shortcut locale accessors are now mixed into views as well

Usage

Include the gem in your Gemfile

gem 'rails_locale_detection'

Set your default and available locales

I18n.default_locale = :en
I18n.available_locales = [:en, :fr]

To support user locales, add a user_locale method

class ApplicationController < ActionController::Base
  def user_locale
    current_user.locale if current_user
  end
end

Methods for accessing current_locale, available_locales, and alternate_locales are available in controller and views

Configuration

Configuration is done via a block that can be added as an initializer:

RailsLocaleDetection.config do |config|
  config.locale_expiry = 3.months
  config.set_default_url_option = :always # valid values are true, false, :always, :never and :explicity
  config.detection_order = [:param, :user, :cookie, :request]
  config.automatically_detect = true
  config.locale_key = :locale
end

The configuration options:

  • locale_expiry sets how long the locale cookie lasts.
  • set_default_url_option determines under which conditions the default_url_option is set
    • true or :always sets the option on all requests
    • false or :never never sets the option
    • :explicity sets the option only when a param[:locale] is present
  • detection_order set the order in which locale detection occurs. Omit values to skip those sources
  • automatically_detect configures automatic inclusion of the detection callback. You can set this to false and include the callback yourself by calling detect_locale in your controller as required.
  • locale_key configures the key used for param and cookie

Contributing to rails_locale_detection

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2012 Mateo Murphy. See LICENSE.txt for further details.

Something went wrong with that request. Please try again.