FastGettext 项目技术文档

1. 安装指南

1.1 添加 Gem 到 Gemfile

首先，在项目的 Gemfile 中添加 gettext_i18n_rails 依赖：

gem 'gettext_i18n_rails'

1.2 可选依赖

如果你需要查找翻译或构建 .mo 文件，可以添加 gettext 依赖：

gem 'gettext', '>=3.0.2', require: false

如果你需要查找 haml 或 slim 文件中的翻译，可以添加 ruby_parser 依赖：

gem 'ruby_parser', require: false, group: :development

1.3 添加语言

使用以下命令添加第一个语言：

rake gettext:add_language[XX]

或者

LANGUAGE=[XX] rake gettext:add_language

其中 XX 是 ISO 639-1 的 2 字母代码。

该命令会创建 locale 目录，并运行 gettext:find 查找所有标记为翻译的字符串。

2. 项目的使用说明

2.1 初始化

将默认的日期、句子连接器和 ActiveRecord 错误信息从 rails i18n 复制到 config/locales 目录。

在 config/initializers/fast_gettext.rb 中初始化：

FastGettext.add_text_domain 'app', path: 'locale', type: :po
FastGettext.default_available_locales = ['en', 'de'] # 允许的语言
FastGettext.default_text_domain = 'app'

在应用控制器中设置语言：

class ApplicationController < ...
  before_action :set_gettext_locale

2.2 翻译

性能在所有后端几乎相同，因为翻译在第一次使用后会被缓存。

2.2.1 使用 .po 文件

FastGettext.add_text_domain 'app', path: 'locale', type: :po

• 使用 _('translations')
• 运行 rake gettext:find，让 GetText 查找所有翻译
• 可选运行 rake gettext:store_model_attributes，解析数据库以查找可翻译的列
• 如果是第一次翻译，为每个语言复制 locale/app.pot 到 locale/de/app.po
• 在 locale/de/app.po 中翻译消息

2.3 数据库翻译

最可扩展的方法，所有翻译人员可以同时在线工作。

使用 translation database Rails engine 进行翻译。

FastGettext::TranslationRepository::Db.require_models
FastGettext.add_text_domain 'app', type: :db, model: TranslationKey

3. 项目 API 使用文档

3.1 FastGettext API

3.1.1 添加文本域

FastGettext.add_text_domain 'app', path: 'locale', type: :po

3.1.2 设置默认语言

FastGettext.default_available_locales = ['en', 'de']

3.1.3 设置默认文本域

FastGettext.default_text_domain = 'app'

3.2 I18n 集成

I18n.locale <==> FastGettext.locale.to_sym
I18n.locale = :de <==> FastGettext.locale = 'de'

4. 项目安装方式

4.1 通过 Gemfile 安装

gem 'gettext_i18n_rails'

4.2 可选依赖

gem 'gettext', '>=3.0.2', require: false
gem 'ruby_parser', require: false, group: :development

4.3 添加语言

rake gettext:add_language[XX]

或者

LANGUAGE=[XX] rake gettext:add_language

5. 其他配置

5.1 自定义可翻译文件列表

namespace :gettext do
  def files_to_translate
    Dir.glob("{app,lib,config,locale}/**/*.{rb,erb,haml,slim,rhtml}")
  end
end

5.2 自定义文本域设置任务

Rake::Task["gettext:setup"].clear

namespace :gettext do
  task :setup => [:environment] do
    domains = Application.config.gettext["domains"]

    domains.each do |domain, options|
      files = Dir.glob(options["paths"])

      GetText::Tools::Task.define do |task|
        task.package_name = options["name"]
        task.package_version = "1.0.0"
        task.domain = options["name"]
        task.po_base_directory = locale_path
        task.mo_base_directory = locale_path
        task.files = files
        task.enable_description = false
        task.msgmerge_options = gettext_msgmerge_options
        task.msgcat_options = gettext_msgcat_options
        task.xgettext_options = gettext_xgettext_options
      end
    end
  end
end

5.3 更改 msgmerge, msgcat, 和 xgettext 选项

Rails.application.config.gettext_i18n_rails.msgmerge = %w[--no-location]
Rails.application.config.gettext_i18n_rails.msgcat = %w[--no-location]
Rails.application.config.gettext_i18n_rails.xgettext = %w[--no-location]

或者

Rails.application.config.gettext_i18n_rails.default_options = %w[--no-location]

5.4 使用 I18n 替代 Gettext 进行 ActiveRecord/ActiveModel 翻译

Rails.application.config.gettext_i18n_rails.use_for_active_record_attributes = false

6. 使用 JavaScript 进行翻译

如果你希望在客户端 JavaScript 中使用 .PO 文件，可以查看 GettextI18nRailsJs 扩展。