README.md

Tolk

Tolk is a Rails engine designed to facilitate the translators doing the dirty work of translating your application to other languages.

Requirements

Tolk is compatible with Rails 4 and 5

Installation & Setup

To install add the following to your Gemfile:

  gem 'tolk'

Also add either kaminari or will_paginate:

gem 'kaminari'
# OR
gem 'will_paginate'

To setup just run:

  $ rake tolk:setup

and follow the guide!

Usage

Setup and import

Tolk treats I18n.default_locale as the master source of strings to be translated. If you want the master source to be different from I18n.default_locale, you can override it by setting Tolk::Locale.primary_locale_name. Developers are expected to make all the changes to the master locale file ( en.yml by default ) and treat all the other locale.yml files as readonly files.

As tolk stores all the keys and translated strings in the database, you need to ask Tolk to update its database from the primary yml file:

  $ rake tolk:sync

The above will fetch all the new keys from en.yml and put them in the database. Additionally, it'll also get rid of the deleted keys from the database and reflect updated translations - if any.

If you already have data in your non primary locale files, you will need to import those to Tolk as a one time thing:

  $ rake tolk:import

Upon visiting http://your_app.com/tolk - you will be presented with different options like creating new locale or providing translations for the existing locales.

Saving locales to files

Once done with translating all the pending strings, you are can write back the new locales to filesystem. You have two options when dumping database locale data to file:

  $ rake tolk:dump_yaml["the_target_locale"]

This command will generate a single yml file for a specified locale. The locale ISO code should be given in string format as the only argument ("en-us" or "en-gb" for example).

  $ rake tolk:dump_all

This will generate yml files for all non primary locales and put them in #{Rails.root}/config/locales/ directory by default.

You can use the dump_all method defined in Tolk::Locale directly and pass directory path as the argument if you want the generated files to be at a different location:

  $ rails runner "Tolk::Locale.dump_all('/Users/lifo')"

You can even download the yml file using Tolk web interface by appending .yaml to the locale url. E.g http://your_app.com/tolk/locales/de.yaml

Settings

You can add some settings in the initializer file

# config/initializers/tolk.rb
Tolk.config do |config|
  config.exclude_gems_token = true
  # exclude locales tokens from gems.

  config.block_xxx_en_yml_locale_files = true
  # reject files of type xxx.en.yml when syncing locales.

  config.dump_path = '/new/path'
  # Dump locale path by default the locales folder (config/locales).

  config.mapping['en'] = 'New English'
  config.mapping['fr'] = 'New French'
  # Mapping : a hash of the type { 'ar' => 'Arabic' }.

  config.primary_locale_name = 'de'
  # primary locale to not be overriden by default locale in development mode.

  config.strip_texts = false
  # Don't strip translation texts automatically
end

Translation statistics

You can ask statistics about missing or updated translations to be tracked for third party tools in http://your_app.com/tolk/stats.json endpoint.

{
  "ar":
    {
      "missing":2928,
      "updated":17,
      "updated_at":"2013-03-04T12:44:03Z"
    }
  ,"ca":
    {
      "missing":1377,
      "updated":1,
      "updated_at":"2013-03-04T13:06:46Z"
    }
  ,"fr":
    {
      "missing":735,
      "updated":5,
      "updated_at":"2013-03-04T13:15:51Z"
    }
}

Authentication

If you want to authenticate users who can access Tolk, you need to provide Tolk::ApplicationController.authenticator proc. For example:

  # config/initializers/tolk.rb
  Tolk::ApplicationController.authenticator = proc {
    authenticate_or_request_with_http_basic do |user_name, password|
      user_name == 'translator' && password == 'transpass'
    end
  }

Authenticator proc will be run from a before filter in controller context.

Handling blank and non-string values

Tolk speaks YAML for non strings values. If you want to enter a nil values, you could just enter '~'. Similarly, for an Array value, you could enter:

  ---
  - Sun
  - Mon

And Tolk will take care of generating the appropriate entry in the YAML file.

Launch test locally

bin/rails test