mmag

ハマったことメモなど

Phoenix v1.3からディレクトリ構成が変わるっぽい

Phoenix

※ 多分に推測が含まれています。あとでちゃんと調べないと ※

今まさに海の向こうではElixir & Phoenix Conf 2016が行われているのですが、インタネッツを通してこんなツイートが流れてきました。

他のツイートを探していくと、Phoenix 1.3ではwebディレクトリがlib/my_app/webのようにlib以下へ入るとのこと。

.
├── assets
├── config
├── lib
│   └── my_app
│       └── web
│           ├── channels
│           ├── controllers
│           ├── templates
│           └── views
├── priv
└── test

これはPhoenixアプリにおいてwebという領域が特別な意味を持つように思われているという懸念から来ています。webはその名の通りWebからアプリケーションへアクセスするためのインターフェースであって、アプリの一部分に過ぎないということを強調する狙いがあるようです。

github.com

さらにModelという概念も無くなり、以下の様な構成になるそうです。

.
├── assets
├── config
├── lib
│   └── my_app
│       ├── blog
│       │   ├── comment.ex # schema
│       │   └── post.ex    # schema
│       ├── blog.ex
│       ├── sales
│       │   ├── order.ex   # schema
│       │   └── payment.ex # schema
│       ├── sales.ex
│       └── web
│           ├── channels
│           ├── controllers
│           ├── templates
│           └── views
├── priv
└── test

models以下に全てのスキーマが置かれる状態を解消したいようです。これまでの流れを思い出してみると、ずっと前はPhoenixにはモデルが無く、Ectoの出現によりそれがそのままモデル層として入りました。そのときはモデルのコードには、use Ecto.Modelという一行を書いていました。ですがその後、それがEcto.Schemaに変更されました。どこで読んだかうろ覚えですが、Ectoを使って得られるものはデータであり構造体であり、モデルと呼ぶのは適切ではない、というのがこの変更の理由だったと記憶しています。そして今回modelsディレクトリすら無くなるとのことで、Phoenixとしては原点回帰のような形になり、Ectoはwebディレクトリの中から出されるような格好となるようです。つまり、アプリケーションにおけるPhoenixの立ち位置がフロント側へ寄る構成になるという理解でよいのでしょうか。

社内ISUCON

弊社GMOペパボで社内ISUCONというイベントが行われ、総勢10チームによる戦いが繰り広げられました。競技の詳細は近々テックブログあたりに書かれるんじゃないかと思うので割愛して忸怩たる思いを連ねます。

自分は若手チーム（2年目+1年目+1年目、自分は2年目）だったので「tsuki☆age」というチーム名で出場しましたが、「こんくらいイケるやろ」と思っていたところの20%も行かないくらいの悔しい感じでした。自分がググッて下調べしておいたミドルウェアの設定が間違っているというつまらんミスをして時間を使ってしまったり、ベンチマークが通らない原因を調べてもパッとせず、「一旦戻そう」となってgit checkout .という具合でした。突き上げならず。まだ正式な計測結果は出ていませんが、競技時間の終わりごろにインスタンスを再起動したらアプリとMySQLがなぜか立ち上がってこなかったので、ダメだろうなあという気持ち。情けないやら申し訳ないやら。

もう一度やるとすれば、アプリケーションのコードをイジる担当を置くべきなのかなとはぼんやり思っていますが、テストの無いコードをホイホイ触れるほどの力量が無いことがわかったので、そもそも力不足なんじゃんという。業務では絶対にサボらずにテスト可能な形で書いてテストもちゃんと書こうと誓いました。他の反省点や改善点は色々ありすぎてよくわからないので、3日くらい寝て、そのあと半年ほど放浪の旅に出てから考えます。

運営の@tnmtさんと@pyama86さんには学びの場を提供していただきまして感謝感謝です。あと周りからすればエンジニアが業務時間中に遊んでるようにしか見えないだろうなと思ったので、今回参加されなかった皆さんもご協力ありがとうございました。

Gettextの使い方メモ

Elixir

はいコンバンハ。

Gettextっていうモジュールがあるんですが、POTとかPOファイルとか、なんかよくわかんなかったので書いておきます。

できること

いわゆるi18n、アプリケーションの国際化ができます。Phoenixアプリ前提にしてしまいますが、例えばHTMLに

<h1><%= MyApp.Gettext.gettext "welcome!" %></h1>

と書いて、jaロケールのPOファイルには

msgid "welcome!"
msgstr "ようこそおいでくださいました"

enロケールのPOファイルには

msgid "welcome!"
msgstr "Welcome to My Page!"

と書いておくと、ロケールに応じていい感じに歓迎できるというわけです。ロケールの指定は、Gettext.put_locale/2で動的に設定したり、config/config.exs`などに

config :my_app, MyApp.Gettext, default_locale: "ja"

と書いて行います。

わかんなかったこと

POファイルの作り方で混乱しました。Phoenixアプリでは、privの下にgettextという謎ディレクトリが最初から作られています。

./priv
└── gettext
    ├── en
    │   └── LC_MESSAGES
    │       └── errors.po
    └── errors.pot

ここにはPOTファイルとPOファイルがあります。POTはPortable Object Templateの略なので、テンプレートです。どういうこっちゃと言うと、おもむろに

mix gettext.merge priv/gettext --locale ja

と打ってみると、このテンプレートをもとにjaロケール用のPOファイルが作られるのです。

./priv
└── gettext
    ├── en
    │   └── LC_MESSAGES
    │       └── errors.po
    ├── errors.pot
    └── ja
        └── LC_MESSAGES
            └── errors.po

まず大前提として、このテンプレートはコードから抽出された結果が吐き出される場所であるということを覚えておきましょう。ファイル名を変えたり内容でファイル分けたり、それなりに手で編集することもあるとは思いますが、日本語や英語をガリガリ書くのは別の場所です。

試しにUserモデルに

def changeset(model, params \\ %{}) do
  ...
  |> validate_length(:password, min: 8, message: MyApp.Gettext.gettext("password too short", count: 8))
  ...
end

と書いて抽出してみます。抽出タスクは

mix gettext.extract

です。これをやると、default.potが作られます。defaultという名前が気に入らない場合はdgettext("errors", "password too short")のようにdgettextでドメインを指定しましょう。

./priv
└── gettext
    ├── default.pot
    ├── en
    │   └── LC_MESSAGES
    │       └── errors.po
    ├── errors.pot
    └── ja
        └── LC_MESSAGES
            └── errors.po
# default.pot

## This file is a PO Template file.
##
## `msgid`s here are often extracted from source code.
## Add new translations manually only if they're dynamic
## translations that can't be statically extracted.
##
## Run `mix gettext.extract` to bring this file up to
## date. Leave `msgstr`s empty as changing them here as no
## effect: edit them in PO (`.po`) files instead.
msgid ""
msgstr ""
"Language: INSERT LANGUAGE HERE\n"

#: web/models/user.ex:31
msgid "password too short"
msgstr ""

Userモデルの中で使っているものが抽出されています。これでコードの変更がテンプレートファイルに反映されたので、各言語用のPOファイルへさらに反映させます。ここで使うのが先ほどのgettext.mergeタスクです。既に翻訳がいくつか書かれているところへ、新しい項目を放り込んでいくので”マージ”というわけです。

mix gettext.merge priv/gettext

enとjaの下に、default.potからdefault.poが作られています。

./priv
└── gettext
    ├── default.pot
    ├── en
    │   └── LC_MESSAGES
    │       ├── default.po
    │       └── errors.po
    ├── errors.pot
    └── ja
        └── LC_MESSAGES
            ├── default.po
            └── errors.po

ようやく翻訳を書くところへきました。ja/LC_MESSAGES/default.poに、"password too short"に対応する日本語を書きます。

## `msgid`s in this file come from POT (.pot) files.
##
## Do not add, change, or remove `msgid`s manually here as
## they're tied to the ones in the corresponding POT file
## (with the same domain).
##
## Use `mix gettext.extract --merge` or `mix gettext.merge`
## to merge POT files into PO files.
msgid ""
msgstr ""
"Language: ja\n"

#: web/models/user.ex:31
msgid "password too short"
msgstr "%{count}文字以上じゃないとダメっていう規則なんですよ。すません。"

まとめ

  • コード内でgettext "foobar"を使う
  • mix gettext.extractでテンプレートファイルを更新
  • mix gettext.merge priv/gettextで各言語ファイルに反映
  • 翻訳を書く

追記

コメントでphoenix-locale_jaを教えていただきました。Ectoのバリデーションエラーだけ翻訳を用意して頂いているようです。