Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Management and maintenance for your i18n files.

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Langulator

Manage your i18n.

Or rather: compile it into a single managable file and give it to the translator, so you don't have to deal with it.

For example, given that you've written the original translations in English and also need French and Norwegian versions, and that you have multiple paths that contain i18n yml files (<language>.yml), then this will give you a single output file where each key is listed with the translations immediately below it.

If you have partial translations in the target languages, these will be included.

Any extraneous translations (i.e. keys that may have been in use previously but are no longer referenced in the original language) will be discarded.

Any missing translations will be given keys with an empty spot, ready for translation.

It handles arbitrarily deep nestings.

Caveats

If you need something other than US-ASCII, you may want to consider using ruby 1.9.3.

In 1.9.2 (patch 290):

S\xC3\xB8knadstekst

In 1.9.3:

Søknadstekst

Installation

Add this line to your application's Gemfile:

gem 'langulator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install langulator

Usage

In Ruby

Compile

  • load individual translations
  • combine into aggregated translations
  • write to an aggregate file
Langulator.compile(:source_language => :en, :target_languages => [:fr, :no], :base_path => '**/i18n/', :to => '/tmp/translations.yml')

Input:

# config/i18n/en.yml
---
food:
  breakfast: Eggs
  lunch: Sandwich
  dinner:
    main_course: Steak
    desert: Chocolate mousse

# config/i18n/fr.yml
---
food:
  breakfast: Des oeufs
thank_you: Merci

# missing no.yml file

Outputs:

  # tmp/translations.yml
  config/i18n/:
    food:
      breakfast:
        en: Eggs
        fr: Des oeufs
        no: 
      lunch:
        en: Sandwich
        fr: 
        no: 
      dinner:
        main_course:
          en: Steak
          fr: 
          no: 
        desert:
          en: Chocolate pudding
          fr: 
          no: 

Decompile

  • load an aggregate file
  • separate into individual translations
  • write to individual translation files
Langulator.decompile(:from => './tmp/translations.yml')

Input:

  config/i18n/:
    food:
      breakfast:
        en: Eggs
        fr: Des oeufs
        no: Egg
      lunch:
        en: Sandwich
        fr: Sandwich
        no: Ostesmørbrød
      dinner:
        main_course:
          en: Steak
          fr: Biffteak
          no: Steak
        desert:
          en: Chocolate mousse
          fr: Mousse au chocolat
          no: Sjokolademousse

Output:

# config/i18n/en.yml
---
food:
  breakfast: Eggs
  lunch: Sandwich
  dinner:
    main_course: Steak
    desert: Chocolate mousse

# config/i18n/fr.yml
---
food:
  breakfast: Des oeufs
  lunch: Sandwich
  dinner:
    main_course: Biffteak
    desert: Mousse au chocolat

# config/i18n/no.yml
---
food:
  breakfast: Egg
  lunch: Sandwich
  dinner:
    main_course: Steak
    desert: Sjokolademousse

CLI

$~: langulator help

$~: langulator help compile

$~: langulator help decompile

Compile

$~: langulator compile -s en -t fr nb-no -p 'config/locales/**/' -f ./tmp/translations.yml

Decompile

$~: langulator decompile -f ./tmp/translations.yml

TODO

  • handle yml files that are namespaced by the language, e.g.
---
en:
  stuff: "whatever"

Contributing

  1. Fork it
  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 new Pull Request
Something went wrong with that request. Please try again.