i18n-backend-side_by_side

Tired of jumping between language files when translating keys? Stop jumping and have all the languages side by side.

This gem is a subclass of the default I18n::Backend::Simple backend. It changes the way translations get loaded from files in order to support specifying the language code anywhere along the key path as opposed to the root key. This allows for all languages being defined next to each other, making it easier to translate between them.

How It Works

Let's assume your app supports English, Spanish, and German. You probably have one file per language:

locales/
  view.en.yml
  view.es.yml
  view.de.yml

The files might look something like this (e.g. locales/en.yml):

en:
  view:
    title: Welcome
    inbox:
      zero: You have no messages
      one: You have one message
      other: 'You have %{count} messages'

Whenever you have to add or modify a key, you have to edit all files. Also, you can't see all translations at once for a specific key. With this gem you can merge all the files and specify the translation for a key at that key:

_:
  view:
    title:
      _en: Welcome
      _es: Bienvenido
      _de: Willkommen
    common_message: This string is available for all languages
    inbox:
      _en:
        zero: You have no messages
        one: You have one message
        other: 'You have %{count} messages'
      _es:
        zero: No tiene mensajes
        one: Tienes un mensaje
        other: 'Tienes %{count} messajes'
      _de:
        zero: Du hast keine Nachrichten
        one: Du hast eine Nachricht
        other: 'Du hast %{count} Nachrichten'

Two things to note here:

The root key is an underscore. Omitting it results in the file being processed as a regular translation file, without support for side-by-side translations.
The language codes are prefixed with an underscore. This is needed in order to distinguish a language code key from a normal key. This also means that regular keys can't start with an underscore.

When the files get loaded, they're transformed on the fly to the original format by moving the language code to the beginning of the key path:

_.foo.bar._en            => en.foo.bar
_.foo.bar._en-UK.abc.xyz => en-UK.foo.bar.abc.xyz

Installation

Add this line to your application's Gemfile:

gem 'i18n-backend-side_by_side'

Set up I18n to use an instance of this backend:

I18n.backend = I18n::Backend::SideBySide.new

That's it. Continue using I18n as you're used to. Happy translating!

Authors

Pratik Mukerji (pmukerji)
Philipe Fatio (fphilipe)

Issue with partial pluralized translation

Won't work when only one language is not pluralized.

Example:

        body:
          one:
            _en: Someone
          other:
            _en: Someones
          _it: Qualcuno

Puma caught this error: undefined method `each' for #<String:0x00007f9aaec287b0> (NoMethodError)
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `_process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `block in _process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `each'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `_process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `block in _process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `each'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `_process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `block in _process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `each'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `_process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `block in _process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `each'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `_process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `block in _process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `each'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:34:in `_process'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-backend-side_by_side-1.0.0/lib/i18n/backend/side_by_side.rb:20:in `load_file'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/base.rb:15:in `block in load_translations'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/base.rb:15:in `each'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/base.rb:15:in `load_translations'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/simple.rb:63:in `init_translations'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/simple.rb:77:in `lookup'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/base.rb:29:in `translate'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/fallbacks.rb:47:in `block (2 levels) in translate'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/fallbacks.rb:46:in `catch'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/fallbacks.rb:46:in `block in translate'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/fallbacks.rb:44:in `each'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n/backend/fallbacks.rb:44:in `translate'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n.rb:169:in `block in translate'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n.rb:165:in `catch'
/Users/nrako/.gem/ruby/2.5.1/gems/i18n-0.9.5/lib/i18n.rb:165:in `translate'
(erb):51:in `render_form'
/Users/nrako/.rubies/ruby-2.5.1/lib/ruby/2.5.0/erb.rb:876:in `eval'
/Users/nrako/.rubies/ruby-2.5.1/lib/ruby/2.5.0/erb.rb:876:in `result'
/Users/nrako/.gem/ruby/2.5.1/gems/honeybadger-2.7.2/lib/honeybadger/rack/user_feedback.rb:49:in `render_form'
/Users/nrako/.gem/ruby/2.5.1/gems/honeybadger-2.7.2/lib/honeybadger/rack/user_feedback.rb:29:in `call'
/Users/nrako/.gem/ruby/2.5.1/gems/honeybadger-2.7.2/lib/honeybadger/rack/user_informer.rb:18:in `call'
/Users/nrako/.gem/ruby/2.5.1/gems/xipio-1.0.0/lib/xipio/middleware.rb:10:in `call'
/Users/nrako/.gem/ruby/2.5.1/gems/rack-cors-1.0.1/lib/rack/cors.rb:93:in `call'
/Users/nrako/.gem/ruby/2.5.1/gems/webpacker-3.0.2/lib/webpacker/dev_server_proxy.rb:17:in `perform_request'
/Users/nrako/.gem/ruby/2.5.1/gems/rack-proxy-0.6.2/lib/rack/proxy.rb:57:in `call'
/Users/nrako/.gem/ruby/2.5.1/gems/railties-5.1.6/lib/rails/engine.rb:522:in `call'
/Users/nrako/.gem/ruby/2.5.1/gems/railties-5.1.6/lib/rails/railtie.rb:185:in `public_send'
/Users/nrako/.gem/ruby/2.5.1/gems/railties-5.1.6/lib/rails/railtie.rb:185:in `method_missing'
/Users/nrako/.gem/ruby/2.5.1/gems/rack-status-1.0.0/lib/rack/status.rb:13:in `call'
/Users/nrako/.gem/ruby/2.5.1/gems/puma-3.10.0/lib/puma/configuration.rb:225:in `call'
/Users/nrako/.gem/ruby/2.5.1/gems/puma-3.10.0/lib/puma/server.rb:605:in `handle_request'
/Users/nrako/.gem/ruby/2.5.1/gems/puma-3.10.0/lib/puma/server.rb:437:in `process_client'
/Users/nrako/.gem/ruby/2.5.1/gems/puma-3.10.0/lib/puma/server.rb:301:in `block in run'
/Users/nrako/.gem/ruby/2.5.1/gems/puma-3.10.0/lib/puma/thread_pool.rb:120:in `block in spawn_thread'

electric-feel / i18n-backend-side_by_side Goto Github PK