A long-lived project that still receives updates
A Rack module for getting and setting a user's locale via a cookie or browser default language.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Development

Runtime

>= 1.8.2
>= 2.2.0
 Project Readme

Rack User Locale

Gem Version CI

A Rack module for getting and setting a user's locale via a cookie or browser default language.

Installation

gem install rack-user-locale

In a Gemfile:

gem 'rack-user-locale'

Usage

Add the following line to your Rack application

use Rack::UserLocale

and thats it!!

Your application will now attempt to set the I18n.locale value based on the following:

  • Whether a user has a user-locale cookie set
  • The "HTTP_ACCEPT_LANGUAGE" value. If there are multiple values it will attempt to set the one ranked highest
  • The I18n.default_locale value (basically a fallback)

Note:

The user locale detection is done on every Rack::Request, which would include all of the non Ruby/Rack actions like .css or .js files.

If you don't want this happen then you can use Rack::Static in your application and filter out which files Rack should serve up statically.

Something like this:

use Rack::Static, urls: ["/css", "/js"], root: "public"

This would serve anything in your public folder statically and wouldn't create a Rack::Request.

See the Rack::Static docs for more info.

Options

Accepted Locales

use Rack::UserLocale, accepted_locales: [:de, :en, :es, :fr, :ja, :pt, :zh] #(whatever codes you support)

If this option is supplied the users locale will either be set to one of the accepted locales in the array, otherwise it will be set to the I18n.default_locale value.

Should you wish to overwrite a users locale value at any point in your application, like for changing language prefs, then simple rewrite the user-locale cookie with a new value.

Cookie Name

If you don't want to use the default cookie name of user-locale, you can set it to something else by passing a cookie_name option.

use Rack::UserLocale, cookie_name: "some-cookie-name"

Inspiration

Credit to these gems for pointing me in the direction I wanted to go in...

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/technicalpanda/rack-user-locale. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting with this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.