svenfuchs / I18n Active_record

h1. I18n::Backend::ActiveRecord

!https://travis-ci.org/svenfuchs/i18n-active_record.svg?branch=master!:https://travis-ci.org/svenfuchs/i18n-active_record

This repository contains the I18n ActiveRecord backend and support code that has been extracted from the "I18n":http://github.com/svenfuchs/i18n. It is fully compatible with Rails 3, 4, 5 and 6.

h2. Installation

For Bundler put the following in your Gemfile:

  gem 'i18n-active_record', :require => 'i18n/active_record'

After updating your bundle, run the installer

  rails g i18n:active_record:install

It creates a migration:

  class CreateTranslations < ActiveRecord::Migration
    def self.up
      create_table :translations do |t|
        t.string :locale
        t.string :key
        t.text   :value
        t.text   :interpolations
        t.boolean :is_proc, :default => false

        t.timestamps
      end
    end

    def self.down
      drop_table :translations
    end
  end

To specify table name use:

  rails g i18n:active_record:install MyTranslation

With the translation model you will be able to manage your translation, and add new translations or languages through it.

By default the installer creates a new file in config/initializers named i18n_active_record.rb with the following content.

  require 'i18n/backend/active_record'

  Translation  = I18n::Backend::ActiveRecord::Translation

  if Translation.table_exists?
    I18n.backend = I18n::Backend::ActiveRecord.new

    I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Memoize)
    I18n::Backend::Simple.send(:include, I18n::Backend::Memoize)
    I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)

    I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Simple.new, I18n.backend)
  end

To perform a simpler installation use:

  rails g i18n:active_record:install --simple

It generates:

  require 'i18n/backend/active_record'
  I18n.backend = I18n::Backend::ActiveRecord.new

You may also configure whether the ActiveRecord backend should use @destroy@ or @delete@ when cleaning up internally.

I18n::Backend::ActiveRecord.configure do |config|
  config.cleanup_with_destroy = true # defaults to false
end

h2. Usage

You can now use @I18n.t('Your String')@ to lookup translations in the database.

h2. Missing Translations -> Interpolations

The interpolations field in the Translations table is used by I18n::Backend::ActiveRecord::Missing to store the interpolations seen the first time this Translation was requested. This will help translators understand what interpolations to expect, and thus to include when providing the translations.

The interpolations field is otherwise unused since the "value" in Translation.value is actually used for interpolation during actual translations.

h2. Examples

• http://collectiveidea.com/blog/archives/2016/05/31/beyond-yml-files-dynamic-translations/

h2. Maintainers

• Sven Fuchs
• Tim Masliuchenko