hstore_translate

Rails I18n library for ActiveRecord model/data translation using PostgreSQL's hstore datatype. It provides an interface inspired by Globalize3 but removes the need to maintain separate translation tables.

Requirements

• ActiveRecord > 3.1.0 (4+ for JRuby)
• I18n

Installation

gem install hstore_translate

When using bundler, put it in your Gemfile:

source 'https://rubygems.org'

gem 'activerecord'
gem 'pg', :platform => :ruby
gem 'activerecord-jdbcpostgresql-adapter', :platform => :jruby
gem 'hstore_translate'

For ActiveRecord < 4.0 you'll also want to add:

gem 'activerecord-postgres-hstore', '~> 0.7.0'

Model translations

Model translations allow you to translate your models' attribute values. E.g.

class Post < ActiveRecord::Base
  translates :title, :body
end

Allows you to translate the attributes :title and :body per locale:

I18n.locale = :en
post.title # => This database rocks!

I18n.locale = :he
post.title # => אתר זה טוב

You also have locale-specific convenience methods from easy_globalize3_accessors:

I18n.locale = :en
post.title # => This database rocks!
post.title_he # => אתר זה טוב

By default as many locales as your I18n.available_locales has defined methods as defined in your model. But you can specify exactly which locales you want to support

class Post < ActiveRecord::Base
  translates :title, :body, :locales => [:es, :fr]
end

To find records using translations without constructing hstore queries by hand:

Post.with_title_translation("This database rocks!") # => #<ActiveRecord::Relation ...>
Post.with_title_translation("אתר זה טוב", :he) # => #<ActiveRecord::Relation ...>

To order records using translations without constructing hstore queries by hand:

Post.order_by_title_translation # will order by :asc in current locale
Post.order_by_title_translation(:asc)
Post.order_by_title_translation(:desc, :he)

In order to make this work, you'll need to define an hstore column for each of your translated attributes, using the suffix "_translations":

class CreatePosts < ActiveRecord::Migration
  def up
    create_table :posts do |t|
      t.column :title_translations, 'hstore'
      t.column :body_translations,  'hstore'
      t.timestamps
    end
  end
  def down
    drop_table :posts
  end
end

I18n fallbacks for missing translations

It is possible to enable fallbacks for missing translations. It will depend on the configuration setting you have set for I18n translations in your Rails config.

You can enable them by adding the next line to config/application.rb (or only config/environments/production.rb if you only want them in production)

config.i18n.fallbacks = true

Sven Fuchs wrote a detailed explanation of the fallback mechanism.

Temporarily disable fallbacks

If you've enabled fallbacks for missing translations, you probably want to disable them in the admin interface to display which translations the user still has to fill in.

From:

I18n.locale = :en
post.title # => This database rocks!
post.title_nl # => This database rocks!

To:

I18n.locale = :en
post.title # => This database rocks!
post.disable_fallback
post.title_nl # => nil

You can also call your code into a block that temporarily disable or enable fallbacks.

I18n.locale = :en
post.title_nl # => This database rocks!

post.disable_fallback do
  post.title_nl # => nil
end

post.disable_fallback
post.enable_fallback do
  post.title_nl # => This database rocks!
end