Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elmassimo/i18n_multitenant
🌎 Provides a convenient way to use tenant-specific translations
https://github.com/elmassimo/i18n_multitenant
i18n multi-tenant rails ruby translations
Last synced: about 2 months ago
JSON representation
🌎 Provides a convenient way to use tenant-specific translations
- Host: GitHub
- URL: https://github.com/elmassimo/i18n_multitenant
- Owner: ElMassimo
- License: mit
- Created: 2017-01-11T20:47:35.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2022-02-27T22:06:16.000Z (almost 3 years ago)
- Last Synced: 2024-12-05T15:49:55.901Z (about 2 months ago)
- Topics: i18n, multi-tenant, rails, ruby, translations
- Language: Ruby
- Homepage: https://maximomussini.com/posts/i18n-multitenant/
- Size: 20.5 KB
- Stars: 18
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
i18n Multi-Tenant
====================
[](http://badge.fury.io/rb/i18n_multitenant)
[](https://github.com/ElMassimo/i18n_multitenant/actions)
[](https://codeclimate.com/github/ElMassimo/i18n_multitenant/coverage)
[](https://codeclimate.com/github/ElMassimo/i18n_multitenant)
[](https://github.com/ElMassimo/i18n_multitenant/blob/master/LICENSE.txt)
This gem is a small utility that provides the basic configuration to perform
tenant-specific translations in multi-tenant apps.
Read more about it in the [blog announcement](https://maximomussini.com/posts/i18n-multitenant/).
## Setting the locale 🌎
You can set a locale globally using:
```ruby
I18nMultitenant.set(locale: :en, tenant: 'Tenant Name')
```
It's usually preferable to set a locale locally by scoping the change to a block:
```ruby
I18nMultitenant.with_locale(locale: :en, tenant: 'Tenant Name') do
# perform translations
end
```
For example, using an `around_action` in Rails:
```ruby
around_action do
I18nMultitenant.with_locale(locale: :en, tenant: 'Tenant Name') { yield }
end
```
## Locale files 📝
The library leverages the use of fallbacks, using the tenant name as a locale variant.
You can organize the files in nested folders as you find suitable, the only
requirement is that the root of a translation file uses the following convention:
```yaml
lang-TENANT_NAME:
...
```
For a few different examples, check out the [locale files used in tests](https://github.com/ElMassimo/i18n_multitenant/tree/master/spec/support/config), but here are few valid roots:
```yaml
en:
en-US:
en-US-TENANT_NAME:
```
Any name can be passed through the `:tenant` option, and it will be normalized
to be uppercase and not contain any hyphens, dots, or spaces.
If you need to use names that are not be valid yml keys even after this process,
you will need to sanitize the names yourself before handing them over to `set`.
## Installation 💿
Add this line to your application's Gemfile and run `bundle install`:
```ruby
gem 'i18n_multitenant'
```
Or install it yourself running:
```sh
gem install i18n_multitenant
```
## Configuration ⚙️
In Rails everything should be configured out of the box, but you can perform
the configuration yourself in other applications by calling:
```ruby
I18nMultitenant.configure(I18n) # or pass I18n.config
```
## Front-end Translations
If you also need to perform translations in the front-end, you can use a library
like [`i18n-js`](https://github.com/fnando/i18n-js). You can easily configure
`i18n-js` to support multi-tenant translations by leveraging `i18n` itself:
```erb
I18n.locale = <%= I18n.locale.to_json.html_safe %>;
I18n.locales[I18n.locale] = <%= I18n.fallbacks[I18n.locale].to_json.html_safe %>
```