Пълното ръководство за интернационализация на релсите (i18n)

В тази статия ще научите как да превеждате приложението си Rails на множество езици, да работите с преводи, да локализирате дата и време и да превключвате локали. Ще видим всички тези аспекти в действие, като създадем примерно приложение и го подобрим стъпка по стъпка. В края на статията ще имате всички необходими знания, за да започнете да прилагате тези концепции в реални проекти.

Подготовка на вашето приложение Rails

И така, както вече казах, ще видим всички концепции в действие, затова нека създадем ново приложение Rails, като стартираме:

rails new SampleApp

За този урок използвам Rails 5.2.1 , но повечето от описаните концепции се отнасят и за по-стари версии.

Сега нека генерираме StaticPagesControllerкое ще има indexдействие (нашата основна страница):

rails g controller StaticPages index

Настройте views/static_pages/index.html.erbизгледа, като добавите малко примерно съдържание:

Welcome!

We provide some fancy services to good people.

Също така бих искал да добавя страница за обратна връзка, където нашите потребители ще могат да споделят мнението си (надяваме се, положително) за компанията. Всяка обратна връзка ще съдържа име на автора и действителното съобщение:

rails g scaffold Feedback author message

Ние ще се интересуваме само от две действия: new(което ще покаже формуляра за публикуване на рецензия и също така ще изброи всички съществуващи рецензии) и create(за действително валидиране и продължаване на рецензиите). Разбира се, в идеалния случай прегледите трябва да бъдат предварително модерирани, но днес няма да се занимаваме с това.

Променете newдействието, за да извлечете всички отзиви от базата данни и да ги подредите по дата на създаване:

# feedbacks_controller.rb # ... def new @feedback = Feedback.new @feedbacks = Feedback.order created_at: :desc end

Също така бих искал да пренасоча потребителя към страницата за обратна връзка, когато формулярът се обработва и новият запис се запази:

# feedbacks_controller.rb # ... def create @feedback = Feedback.new(feedback_params) if @feedback.save redirect_to new_feedback_path else @feedbacks = Feedback.order created_at: :desc render :new end end

Оказвайте колекцията от отзиви на newстраницата:

И накрая, създайте частична за отделна обратна връзка:

Posted by

Погрижете се за маршрутите:

# config/routes.rb Rails.application.routes.draw do resources :feedbacks root 'static_pages#index' end

Накрая добавете глобално меню към оформлението:

    Сега изпълнете миграции и стартирайте сървъра:

    rails db:migrate rails s

    Придвижете се до //locahost:3000и се уверете, че всичко е наред. Сега, след като има с какво да работим, нека да преминем към основната част и да локализираме нашето приложение.

    Малко конфигурация

    Преди да извършваме преводи, трябва да решим кои езици ще се поддържат. Можете да изберете всеки, но аз ще се придържам към руски и английски, като последният е зададен по подразбиране. Отразете това във config/application.rbфайла:

    # ... config.i18n.available_locales = [:en, :ru] config.i18n.default_locale = :en

    Също така закачете скъпоценен камък rails-i18n, който има локални данни за различни езици. Например, той е превел имена на месеците, правила за плурализация и други полезни неща.

    # Gemfile # ... gem 'rails-i18n'

    Просто инсталирайте този скъпоценен камък и сте готови:

    bundle install

    Съхраняване на преводи

    След като всичко е конфигурирано, нека се погрижим за началната страница и да преведем текста там.

    Най-простият начин да направите това е чрез използване на локализирани изгледи. Всичко, което трябва да направите, е да създадете изгледи с име index.LANG_CODE.html.erb, където LANG_CODEсъответства на един от поддържаните езици. И така, в тази демонстрация трябва да създадем две гледни точки: index.en.html.erbи index.ru.html.erb. Вътре просто поставете съдържание за английска и руска версия на сайта и Rails автоматично ще избере правилния изглед въз основа на зададения в момента локал. Удобно, а?

    Този подход обаче не винаги е осъществим. Друг начин би бил да съхраните преведените низове в отделен файл и да изобразите правилната версия на низа въз основа на избрания език. По подразбиране Rails използва YAML файлове, които трябва да се съхраняват в config/localesдиректорията. Преводите за различни езици се съхраняват в отделни файлове и всеки файл е кръстен на този език.

    Отворете config/localesпапката и обърнете внимание, че вътре вече има en.ymlфайл, който съдържа някои примерни данни:

    en: hello: "Hello world"

    И така, enе ключ от най-високо ниво, представящ езика, за който са предназначени тези преводи. След това има вложена двойка ключ-стойност, където helloе ключът за превод и Hello worldе действителният преведен низ. Нека заменим тази двойка със следното съдържание:

    en: welcome: "Welcome!"

    Това е само приветствено съобщение от нашата начална страница. Сега създайте ru.ymlфайл в config/localesпапката и предоставете преведено приветствено съобщение и там:

    ru: welcome: "Добро пожаловать!"

    Току-що създадохме превод за първия ни низ, което е наистина страхотно.

    Извършване на прости преводи

    Сега, когато сме попълнили YAML файловете с някои данни, нека видим как да използваме преведените низове в изгледите. Всъщност това е толкова просто, колкото използването на translateметода, който е псевдоним, както t. Този метод има един задължителен аргумент: името на ключа за превод:

    Когато се поиска страницата, Rails търси низа, който съответства на предоставения ключ, и го изобразява. Ако исканият превод не може да бъде намерен, Rails просто ще изобрази ключа на екрана (и ще го превърне в по-разбираема от човека форма).

    Translation keys can be named anything you like (well, nearly anything) but of course it is advised to give them some meaningful names so that you can understand what text they correspond to.

    Let’s take care of the second message:

    en: welcome: "Welcome!" services_html: "We provide some fancy services to good people."
    ru: welcome: "Добро пожаловать!" services_html: "Мы предоставляем различные услуги для хороших людей."

    Why do we need this _html postfix? Well, as you can see our string has some HTML markup, and by default Rails will render the em tag as plain text. As long as we don’t want this to happen, we mark the string as a “safe HTML”.

    Now just use the t method again:

    More On Translation Keys

    Our homepage is now localized, but let’s stop for a moment and think about what we have done. All in all, our translation keys have meaningful names, but what happens if we are going to have, say, 500 messages in the app? This number is actually not that big, and large websites may have thousands of translations.

    If all our key-values pairs are stored right under the en (or ru) key without any further grouping, this leads to two main problems:

    • We need to make sure that all the keys have unique names. This becomes increasingly complex as your application grows.
    • It is hard to locate all related translations (for example, translations for a single page or feature).

    Therefore, it would be a good idea to further group your translations under arbitrary keys. For example, you may do something like this:

    en: main_page: header: welcome: "Welcoming message goes here"

    The level of nesting is not limited (but you should be reasonable about it), and the keys in different groups may have identical names.

    It is beneficial, however, to follow the folder structure of your views (in a moment we will see why). Therefore, tweak the YAML files in the following way:

    en: static_pages: index: welcome: "Welcome!" services_html: "We provide some fancy services to good people."
    ru: static_pages: index: welcome: "Добро пожаловать!" services_html: "Мы предоставляем различные услуги для хороших людей."

    Generally, you need to provide full path to the translation key when referencing it in the t method:

    However, there is also a “lazy” lookup available. If you perform translation in a view or controller, and the translation keys are namespaced properly following the folder structure, you may omit the namespaces all together. This way, the above code turns to:

    Note that the leading dot is required here.

    Let’s also translate our global menu and namespace the translations properly:

    en: global: menu: home: "Home" feedback: "Feedback"
    ru: global: menu: home: "Главная" feedback: "Отзывы"

    In this case we can’t take advantage of the lazy lookup, so provide the full path:

      Translating Models

      Now let’s proceed to the Feedback page and take care of the form. The first thing we need to translate is the labels for the inputs. It appears that Rails allows us to provide translations for the model attributes, and they will be automatically utilized as needed. All you need to do is namespace these translations properly:

      en: activerecord: attributes: feedback: author: "Your name" message: "Message"
      ru: activerecord: attributes: feedback: author: "Ваше имя" message: "Сообщение"

      The labels will now be translated automatically. As for the “submit” button, you can provide translation for model itself by saying:

      en: activerecord: models: feedback: "Feedback"

      But honestly I don’t like the “Create Feedback” text on this button, so let’s stick with a generic “Submit” word:

      en: global: forms: submit: Submit
      ru: global: forms: submit: Отправить

      Now utilize this translation:

      Error Messages

      Probably we do not want the visitors to post empty feedback messages, therefore provide some simple validation rules:

      # models/feedback.rb # ... validates :author, presence: true validates :message, presence: true, length: {minimum: 5}

      But what about the corresponding error messages? How do we translate them? It appears that we don’t need to do anything at all as rails-i18n gem already knows how to localize common errors. For example, this file contains error messages for the Russian locale. If you actually do want to tweak the default error messages, then check the official doc that explains how to achieve that.

      One problem with the form, however, is that the error messages subtitle (the one that says “N errors prohibited this feedback from being saved:”) is not translated. Let’s fix it now and also talk about pluralization.

      Pluralization Rules

      As long as potentially there can be one or more error messages, the “error” word in the subtitle should be pluralized accordingly. In English words are usually pluralized by adding an “s” postfix, but for Russian the rules are a bit more complex.

      I already mentioned that the rails-i18n gem contains pluralization rules for all the supported languages, so we don’t need to bother writing them from scratch. All you need to do is provide the proper key for each possible case. So, for English there are only two possible cases: one error or many errors (of course, there can be no errors, but in this case the message won’t be displayed at all).

      en: global: forms: submit: Submit messages: errors: one: "One error prohibited this feedback from being saved" other: "%{count} errors prohibited this feedback from being saved"

      The %{count} here is interpolation – we take the passed value and place it right into the string.

      Now take care of the Russian locale which has more possible cases:

      ru: global: forms: submit: Отправить messages: errors: one: "Не удалось сохранить отзыв! Найдена одна ошибка:" few: "Не удалось сохранить отзыв! Найдены %{count} ошибки:" many: "Не удалось сохранить отзыв! Найдено %{count} ошибок:" other: "Не удалось сохранить отзыв! Найдена %{count} ошибка:"

      Having this in place, just utilize these translation:

      Note that in this case we pass the translation key as well as the value for the count variable. Rails will take the proper translation variant based on this number. Also the value of the count will be interpolated into each %{count} placeholder.

      Our next stop is the _feedback.html.erb partial. Here we need to localize two strings: “Posted by…” and datetime (created_at field). As for “Posted by…”, let’s just utilize the interpolation again:

      en: global: feedback: posted_by: "Posted by %{author}"
      ru: global: feedback: posted_by: "Автор: %{author}"

      But what about the created_at? To take care of it, we can take advantage of the localize method aliased as just l. It is very similar to the Ruby’s strftime, but produces a translated version of the date (specifically, the months’ names are translated properly). Let’s use a predefined format called :long:

      If you would like to add your very own format, it is possible too as explained here.

      Switching Between Locales

      So, our app is now fully translated… but there is a very minor thing: we cannot change the locale! Come to think of it, this is quite a major issue really, so let’s fix it now.

      There are a handful of possible ways of setting and persisting the chosen locale across the requests. We are going to stick with the following approach:

      • Our URLs will have an optional :locale parameter, and so they’ll look like //localhost:3000/en/some_page
      • If this parameter is set and the specified locale is supported, we translate the app into the corresponding language
      • If this parameter is not set or the locale is not supported, set a default locale

      Sounds straightforward? Then let’s dive into the code!

      First of all, tweak the routes.rb by including a scope:

      # config/routes.rb scope "(:locale)", locale: /#")/ do # your routes here... end

      Here we are validating the specified parameter using a RegEx to make sure that the locale is supported (note that the anchor characters like \A are not permitted here).

      Next, set a before_action in the ApplicationController to check and set the locale on each request:

      # application_controller.rb # ... before_action :set_locale private def set_locale I18n.locale = extract_locale || I18n.default_locale end def extract_locale parsed_locale = params[:locale] I18n.available_locales.map(&:to_s).include?(parsed_locale) ? parsed_locale : nil end

      Also, in order to persist the chosen locale across the requests, set the default_url_options:

      # application_controller.rb # ... private def default_url_options { locale: I18n.locale } end

      The is going to include the locale parameter into every link generated with Rails helpers.

      The last step is to present two links to switch between locales:

          As an exercise, you may make these links more fancy and, for instance, redirect the user back to the page that he was browsing.

          Simplify Your Life With Lokalise

          By now you are probably thinking that supporting multiple languages on a big website is probably a pain. And, honestly, you are right. Of course, the translations can be namespaced, and even split into multiple YAML files if needed, but still you must make sure that all the keys are translated for each and every locale.

          Luckily, there is a solution to this problem: the Lokalise platform that makes working with the localization files much simpler. Let me guide you through the initial setup which is nothing complex really.

          • To get started, grab your free trial
          • Install Lokalise CLI that will be used to upload and download translation files
          • Open your personal profile page, navigate to the “API tokens” section, and generate a read/write token
          • Create a new project, give it some name, and set English as a base language
          • On the project page click the “More” button and choose “Settings”. On this page you should see the project ID
          • Now from the command line simply run lokalise --token import --lang_iso en --file config/locales/en.yml while providing your generated token and project ID (on Windows you may also need to provide the full path to the file). This should upload English translation to Lokalise. Run the same command for the Russian locale.
          • Navigate back to the project overview page. You should see all your translation keys and values there. Of course, it is possible to edit, delete them, as well as add new ones. Here you may also filter the keys and, for example, find the untraslated ones which is really convenient.
          • After you are done editing the translations, download them back by running lokalise --token export --type yaml --bundle_structure %LANG_ISO%.yml --unzip_to E:/Supreme/docs/work/lokalise/rails/SampleApp/config/locales/. Great!

          Lokalise has many more features including support for dozens of platforms and formats, ability to order translations from professionals, and even the possibility to upload screenshots in order to read texts from them. So, stick with Lokalise and make your life easier!

          Conclusion

          In this article we have thoroughly discussed how to introduce internationalization support in Rails applications and implemented it ourselves. You have learned how and where to store translations, how to look them up, what are localized views, how to translate error messages and ActiveRecord-related stuff, as well as how to switch between locales and persist the chosen locale among the request. Not bad for today, eh?

          Of course, it is impossible to cover all ins and outs of Rails I18n in one article, and so I recommend checking out the official guide that gives some more detailed information on the topic and provides useful examples.

          Originally published at blog.lokalise.co on August 23, 2018.