ソフトウェア/rails/国際化

最新の Rails4 の国際化事情 †

昔は非常に苦労しましたが ＞ ソフトウェア/rails/言語ネゴシエーション
最近はかなりいろいろ便利になっているようですね。

• http://guides.rubyonrails.org/i18n.html
• http://memo.yomukaku.net/entries/LXvSUpT

ページ構成 †

今回、ページ構成は以下のようにしました。

xxxx というページを以下の３つのアドレスで参照可能にします。

http://www.example.com/xxxx

http ヘッダーの Accept-Language を参照してユーザーに合わせた言語で表示する

http://www.example.com/ja/xxxx

日本語で表示する

http://www.example.com/en/xxxx

英語で表示する

routes の指定 †

conf/routes.rb

LANG:ruby
# coding: utf-8
MyApp::Application.routes.draw do

  # '/' は MyDefaultController.index へ
  root 'my_default#index'
 
  # 有効なロケールは en と ja
  locale_regexp= /en|ja/

   # '/en', '/ja' は MyDefaultController.index へ
  get ':locale' => 'my_default#index',
      constraints: { locale: locale_regexp }
 
  # 省略可能な locale スコープを用意する
  scope "(:locale)", locale: locale_regexp do
  
    # some_resources には、'/some_resources/1', '/en/some_resources/1', 
    # '/ja/some_resources/1' どれでもアクセス可能
    resources :some_resources
    
    # 各種コントローラへマップする
    # これらも /, /en/, /ja/ のどれでもアクセスできる
    get ':controller(/:action(/:id))'
  
  end

end

これで、例えば

• /some_resources/1
• /en/some_resources/1
• /ja/some_resources/1

すべてが SomeResourcesController にマップされます。

routes.rb で Redirect を使ってはいけない †

routes.rb で Redirect してしまうと、下記の default_url_options が反映されないために 望み通りの結果が得られません。

そこで一旦何らかの Controller の method に受けてから、 Controller 内で redirect_to することでこの問題を回避します。

routes.rb で

LANG:ruby
get "cont01/some" => Redirect("cont01#other")

とする代わりに、

LANG:ruby
get "cont01/some" => "cont01#some"

として、一旦 Cont01Controller.some に受けておき、

LANG:ruby
class Cont01Controller < ApplicationController

  def some
    redirect_to action: :other
  end

  def other
    ...

  end

end

のように Controller 内で redirect_to を呼びます。

I18n.locale の設定 †

上記のルート設定を用いると、 /en/xxxx や /ja/xxxx でアクセスした場合には param[:locale] に 'en' や 'ja' が入りますので、その値を I18n.locale に代入することで、 正しいロケールを使って出力できるようになります。

/xxxx として、ロケールを直接指定しなかった場合 param[:locale] は nil になるので、かわりにブラウザから渡された Accept-Language ヘッダー情報にからロケールを抜き出して用いることで、 ユーザーの好みに合わせたロケールでページを表示できます。

Accept-Language ヘッダーの値はブラウザの言語設定の結果が反映されます。 つまり、ブラウザの設定で「日本語」が優先されている場合には 日本語で、「英語」が優先されている場合には英語で表示できることになります。

Accept-Language ヘッダー情報も指定されなかった場合には、 I18n.default_locale（デフォルト値は :en）を使います。

I18n.default_locale の値は config/application.rb あるいは config/initializers/i18n.rb などで自分で指定してもよいです。

app/controllers/application_controller.rb

LANG:ruby
# coding: utf-8
class ApplicationController < ActionController::Base
  # Prevent CSRF attacks by raising an exception.
  # For APIs, you may want to use :null_session instead.
  protect_from_forgery with: :exception
  
  before_filter :set_locale

  private
  
  ###################### ロケール関連

  def set_locale
    I18n.locale = params[:locale] || default_locale
  end

  def default_locale
    extract_locale_from_accept_language_header ||
    I18n.default_locale
  end

  def extract_locale_from_accept_language_header
    ( request.env['HTTP_ACCEPT_LANGUAGE'] || '' ).scan(/^[a-z]{2}/).first
  end

  # 現在のロケールが自動判別ロケールと異なる場合、、
  # リンク先に現在のロケールを追加する
  # 引数は必要？？？詳しくは次項を参照
  def default_url_options(options = {})
    if I18n.locale.to_sym == default_locale.to_sym
      super()
    else
      # キーは必ず Symbol で渡すべし
      # http://d.hatena.ne.jp/ux00ff/20120124/1327373780
      { :locale => I18n.locale }
    end
  end

end

default_url_options の指定 †

/en/xxxx というページに /yyyy というページへのリンクを表示するとき、 その飛び先を /en/yyyy としておくと、訪問者は英語のページを読み進めることができます。 これが /xxxx へのリンクになっていると、急に日本語ページが表示されてしまうかもしれません。

そこで、上のコードのように default_url_options を定義することにより、 現在のロケールが自動判別されたロケールと異なる場合に、 ページ内に表示するリンクすべてに現在のロケールを追加します。

これで url からコントローラへ、コントローラから url へ、 locale を正しく保った上で両方向のマッピングができるようになりました。

各言語用の view を作成 †

• app/views/my_default/index.en.html
• app/views/my_default/index.ja.html
• app/views/my_default/_form.en.html
• app/views/my_default/_form.ja.html

のように、日本語版と、英語版の２つのファイルを用意しておくと、 I18n.locale の指定に従って、適切な方が使われます。

render partial: "form" などで読み込む _form などのサブ view も、 上記のように en と ja の２つを用意しておけば適切な方が読み込まれます。

わざわざ２つ用意する必要のないファイルは、これまで通り

• app/view/my_default/the_page.html

としておけば、I18n.locale が en でも ja でも、このファイルが使われます。

各種メッセージの翻訳を作成 †

I18n には ruby のコードから表示するメッセージの翻訳を行う機能があります。

この設定は通常、config/locales/ 以下に .yml ファイルとして置きます。

まず、config/locales/*/ にある *.yml ファイルをロケール設定ファイルとして システムへ読み込むため、以下の設定を行います。

config/application.rb

LANG:ruby
   config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}').to_s]
   config.i18n.default_locale = :ja   # 上記を参照。必要に応じて設定する。

そして、

• config/locales/defaults/en.yml
• config/locales/defaults/ja.yml
• config/locales/models/some_model/en.yml
• config/locales/models/some_model/ja.yml
• config/locales/views/my_default/en.yml
• config/locales/views/my_default/ja.yml

などとして、各種訳語ファイルを作成します。

訳語ファイルの中身は yaml 形式で、 以下のようにキーと実際のメッセージのペアをたくさん格納した形になります。

LANG:yaml
en:
  some_message: "This is an English message."
ja:
  some_message: "これは日本語のメッセージです。"

上記設定があれば、view 内で

<%=t :some_message %>

とすることで、"This is an English message." または "これは日本語のメッセージです。" のどちらかが、適切に選ばれて表示されます。

詳しくはこちらが分かりやすかったです。
http://morizyun.github.io/blog/i18n-english-rails-ruby-many-languages/

http://tkyk.name/blog/2011/06/22/Rails-Ruby-rails3_i18n/ によれば、
新たにファイルを追加した場合はサーバを再起動しなければ有効にならないそうです。

LANG:yaml
en:
  my_default:
    index:
      title: "Title of app/views/my_default/index.html.erb"
    other:
      title: "Title of app/views/my_default/other.html.erb"

LANG:yaml
ja:
  activerecord:
    models:
      user: ユーザー
    attributes:
      user:
        login: "ログインネーム"

LANG:yaml
en:
  activerecord:
    models:
      user:
        one: "User"
        other: "Users"
    attributes:
      user:
        login: "Handle"

I18n.* の便利な機能 †

LANG:ruby
I18n.backend.store_translations :en, thanks: 'Thanks %{name}!'
I18n.translate :thanks, name: 'Jeremy'
# => 'Thanks Jeremy!'

I18n.backend.store_translations :en, inbox: {
  one: 'one message',
  other: '%{count} messages'
}
I18n.translate :inbox, count: 2
# => '2 messages'
 
I18n.translate :inbox, count: 1
# => 'one message'

Rails メッセージの翻訳 †

LANG:yaml
es:
  books:
    index:
      title: "Title of app/views/books/index.html.erb"

<%= t '.title' %>

LANG:html
<%= t(:some_key, raise: true) %>

LANG:yaml
en:
  welcome: <b>welcome!</b>
  hello_html: <b>hello!</b>
  title:
    html: <b>title!</b>

LANG:html
<div><%= t('welcome') %></div>       # エスケープされる → &lt;b&gt;welcome!&lt;/b&gt;
<div><%= raw t('welcome') %></div>   # エスケープされない
<div><%= t('hello_html') %></div>    # エスケープされない
<div><%= t('title.html') %></div>    # エスケープされない

LANG:yaml
ja:
  activerecord:
    models:
      user: ユーザー
    attributes:
      user:
        login: "ログインネーム"

LANG:yaml
en:
  activerecord:
    models:
      user:
        one: "User"
        other: "Users"
    attributes:
      user:
        login: "Handle"

LANG:yaml
ja:
  activemodel:
    models:
      my_form: "モデル名"
    attributes:
      my_form
        attr_name: "属性名"

LANG:ruby
class User < ActiveRecord::Base
  validates :name, presence: true
end

activerecord.errors.models.user.attributes.name.blank
activerecord.errors.models.user.blank
activerecord.errors.messages.blank
errors.attributes.name.blank
errors.messages.blank

LANG:yaml
ja:
  activerecord:
    errors:
      models:
        my_model:
          'There is a critical error!': >
              致命的なエラーが発生しました

LANG:ruby
   errors.add(:some_column, :'There is a critical error!')

en:
  errors:
    format: "%{attribute} %{message}"

LANG:yaml
en:
  activerecord:
    errors:
      template:
        header:
          one:   "1 error prohibited this %{model} from being saved"
          other: "%{count} errors prohibited this %{model} from being saved"
        body:    "There were problems with the following fields:"

LANG:ruby
# user_mailer.rb
class UserMailer < ActionMailer::Base
  def welcome(user)
    #...
  end
end

en:
  user_mailer:
    welcome:
      subject: "Welcome to Rails Guides!"

Java Script の多言語化 †

http://morizyun.github.io/blog/i18n-english-rails-ruby-many-languages/ より、

Gemfile

# javascriptのi18n対応
gem "i18n-js"

初期設定 (config/i18n-js.yml の作成)

LANG:console
$ bundle install
$ rake i18n:js:setup

app/assets/javascripts/application.js

LANG:javascript
//= require i18n
//= require i18n/translations

app/views/layouts/application.html.erb

LANG:html
<script type="text/javascript">
  I18n.defaultLocale = "<%= I18n.default_locale %>";
  I18n.locale = "<%= I18n.locale %>";
</script>

config/i18n-js.yml

ja:
  hello: "こんにちは"

使用したい javascript 中にて、

LANG:javascript
I18n.t("hello");

参照：https://github.com/fnando/i18n-js

SEO 視点での国際化 †

http://morizyun.github.io/blog/i18n-english-rails-ruby-many-languages/ より、

Google の記事が紹介されていました：
https://support.google.com/webmasters/answer/182192

要検討 †

• http://qiita.com/awakia/items/cab830238bbfaa924f02
  • config.i18n.available_locales = [:ja, :en] というのがある？
  • 「YAMLは同じキーがあった場合は内容を上書きするので、00などをつけて順番を選べるようにしておくと都合が良い。 辞書順に上から読み込まれて行くので、内容がコンフリクトした場合は数値が大きいほうの設定が使われる様になる。」
  • フォルダーに分けている場合の読み込み順はどうなるだろう？

コメント †