Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 3.08 KB

README.md

File metadata and controls

88 lines (58 loc) · 3.08 KB

ActiveRecord Globalize Build Status Code Climate Test Coverage Inline docs

Rails I18n library for ActiveRecord model/data translation using PostgreSQL's hstore datatype. It provides an interface inspired by hstore_translate but without the need for data migrations (zero down time solution for large set of data).

Installation

Add this line to your application's Gemfile:

gem 'activerecord_globalize'

And then execute:

$ bundle

Or install it yourself as:

$ gem install activerecord_globalize

Usage

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.string :title
      t.string :body
      t.column :title_translations, 'hstore'
      t.column :body_translations,  'hstore'
      t.timestamps
    end
  end
  def down
    drop_table :posts
  end
end

then run rake db:migrate

If you got an error PG::UndefinedObject: ERROR: type "hstore" does not exist add enable_extension 'hstore' before creating hstore columns in migration file to enable hstore extention on postgres db.

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

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 # => אתר זה טוב

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/eventtus/activerecord_globalize/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

MIT/BSD

Credits

Eventtus

Created by Mohamed Elfiky and sponsored by Eventtus.