Udemy 7. モデル開発事前準備 #01
2020年07月05日に更新

【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)

このチャプターで達成すること

この「モデル開発事前準備」のチャプターでは、ユーザーモデル開発前の準備を行います。

具体的にはRailsの初期設定やGemのインストール、使われていないDockerイメージの削除などを行います。

このチャプターを通してモデル開発の前にやるべき事を学んでいきましょう。

今回達成すること

今回はapplication.rbの初期設定を行います。

ここの設定はアプリ全体に影響するので、最初に行うのが鉄則です。

apiディレクトリでブランチ切っとく

作業に入る前に「api」ディレクトリ上でブランチを作成しましょう。

root $ cd api
api  $ git checkout -b 20200702_initial_settings
  • 20200702_initial_settings … ブランチ名に作業開始日を付けると、日付ごとに並ぶので見返しやすくなります。これは筆者の癖なので、皆さんはご自由に。

確認しておきましょう。

api $ git branch

* 20200702_initial_settings
  master

ブランチに移動できていることを確認できたら「root」ディレクトリに戻っておきます。

api $ cd ..

application.rbの初期設定を行う

Railsの「config」ディレクトリ直下のapplication.rbには、アプリ全体の設定を記述します。

タイムゾーンの設定や、デフォルトで使用する言語、アプリ起動時に読み込むディレクトリなどを指定します。

Railsアプリのタイムゾーン設定

まずはタイムゾーンの設定を行いましょう。

application.rbに下記を追加してください。

初めからあるコメントは丸っと消しちゃって大丈夫です。

api/config/application.rb
...
module App
  class Application < Rails::Application
    # Initialize configuration defaults for originally generated Rails version.
    config.load_defaults 6.0

    # 追加
    # Railsアプリデフォルトのタイムゾーン(default 'UTC')
    # TimeZoneList: http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html
    config.time_zone = ENV["TZ"]

    config.api_only = true
  end
end

  • config.time_zone … Railsアプリのタイムゾーンを設定します。デフォルトはUTC

    設定できる値は下記URLにあるオブジェクトの値で、key(Tokyo), value(Asia/Tokyo)どちらでも構いません。

    ActiveSupport::TimeZone

  • ENV["TZ"] … RailsのDockerfileで設定した環境変数のタイムゾーンを取得しています。

    ここに入っている値は"Asia/Tokyo"です。

ここで設定したタイムゾーンはRailsのTimeWithZoneクラスに影響します。

Railsコンソールで確認してみましょう。

root $ docker-compose run --rm api rails c

# 設定タイムゾーンの確認
> Time.zone.name
=> "Asia/Tokyo"

# 現在時間がJSTになっているか確認
> Time.current
=> Thu, 02 Jul 2020 21:25:05 JST +09:00

日本時間になっていますね。

コンソールはexitで抜けましょう。(以後省略)

> exit

(コラム)Time.currentとTime.nowの違い

どちらも現在時刻を取得するメソッドですが違いがあります。

Time.current

Railsの独自のメソッドで、TimeWithZoneクラスを使用しています。

config.time_zoneで設定したタイムゾーンを元に現在時刻を取得します。

Time.now

Rubyのメソッドで、Timeクラスを使用しています。

環境変数TZの値、無ければシステム(OS)のタイムゾーンを元に現在時刻を取得します。

今回はDockerfileにTZ=Asia/Tokyoを指定しているので、Time.nowは日本時間を取得します。

指定できるタイムゾーンは下記URLの「TZ database name」の値です。

List of tz database time zones -Wiki

(コラム終わり)

データベースの読み書きに使用するタイムゾーン設定

Railsにはアプリのタイムゾーンとは別に、データベースの読み書きに使用するタイムゾーンがあります。

api/config/application.rb
...
module App
  class Application < Rails::Application
    ...

    # 追加
    # データベースの読み書きに使用するタイムゾーン(:local | :utc(default))
    config.active_record.default_timezone = :utc

    config.api_only = true
  end
end
  • config.active_record.default_timezone … データベースから日付と時刻を取り出した際のタイムゾーンを、世界時間と地方時間どちらのタイムゾーンで読み込むかを指定します。デフォルトは:utc

:utc … 世界時間Time.utcで読み込みます。

> Time.utc(2020,4,1,12) => 2020-04-01 12:00:00 UTC

:local … 地方時間Time.localで読み込みます。

> Time.local(2020,4,1,12) => 2020-04-01 12:00:00 +0900

Time.localはRubyのメソッドで、Rubyタイムゾーンを参照します。

RubyタイムゾーンはTime.now.zoneで確認できます。

> Time.now.zone
=> "JST"

config.active_record.default_timezoneの指定は下記にも影響があります。

1. データベースの保存時間に影響

:utcで保存した場合、世界標準時間で保存されます。

> time = Time.new(2020,4,1,12)
=> 2020-04-01 12:00:00 +0900

> User.create(name: "utc", email: "utc@examle.com", password_digest: "password", created_at: time)

> User.last.created_at_before_type_cast
=> 2020-04-01 03:00:00 UTC
  • <カラム名>_before_type_cast … 型変換前の値を取得する。

:localで保存した場合、日本時間で保存されます。

> User.create(name: "local", email: "local@examle.com", password_digest: "password", created_at: time)

> User.last.created_at_before_type_cast
=> 2020-04-01 12:00:00 +0900

2. Railsのタイムスタンプに影響

Railsのcreated_atupdated_atの時間を決定するタイムスタンプには下記のコードが使われています。

:utcと設定した場合はTime.now.utcの時間で保存されます。

def current_time_from_proper_timezone #:nodoc:
  self.class.default_timezone == :utc ? Time.now.utc : Time.now
end

参考 Rails -GitHub

3. 変更時は要注意

保存時と表示時のdefault_timezoneを合わせないと前後9時間の誤差が出るので注意が必要です。

PostgreSQL保存時間 保存表示共に local 保存表示共にutc 保存local/表示utc 保存utc/表示local
2020-04-01 03:00:00 2020-04-01 3:00:00 2020-04-01 3:00:00 2020-04-01 12:00:00 2020-03-31 18:00:00
- 一致 一致 9時後(+) 9時前(-)

今回の設定はデータベースPostgreSQLに合わせ、:utcに設定しています。

config.active_record.default_timezone = :utc

読み込み時はconfig.time_zoneで変換されるため日本時間で表示され、保存時はUTCで保存されます。

日本語化ファイルの読み込み設定

Railsには、エラーメッセージやメールタイトルを他の言語に翻訳する「i18n」と言うモジュールが入っています。

こいつが読み込むファイルを指定します。デフォルトは:en

api/config/application.rb
module App
  class Application < Rails::Application
    ...

    # 追加
    # i18nで使われるデフォルトのロケールファイルの指定(default :en)
    config.i18n.default_locale = :ja

    config.api_only = true
  end
end
  • config.i18n.default_locale = :ja … ここで指定した値のファイルをデフォルトの翻訳ファイルとして読み込みます。
    • :en … 読み込みファイルパス「/config/locales/en.yml」
    • :ja … 読み込みファイルパス「/config/locales/ja.yml」

Railsコンソールで設定を確認することができます。

> I18n.locale
=> :ja

Zeitwerk(ツァイトベルク)の設定

Railsの$LOAD_PATH自動読み込みパスを足すべきかどうかを指定します。デフォルトはtrue

api/config/application.rb
module App
  class Application < Rails::Application
    ...

    # 追加
    # $LOAD_PATHにautoload pathを追加しない(Zeitwerk有効時false推奨)
    config.add_autoload_paths_to_load_path = false

    config.api_only = true
  end
end

$LOAD_PATHとは

ファイルを読み込むRubyのメソッド「load」や「require(リィクゥァィア)」が、ファイルを参照するときに使われるディレクトリパス群です。

> pp $LOAD_PATH

["/app/lib",
 "/app/vendor",
 "/usr/local/bundle/gems/actioncable-6.0.3.1/lib",
 ...

application.rbにもrequire "rails"などと言った記述がありますが、これだけでどうやってRailsのGemファイルを参照しているのか疑問になりますよね。

それは$LOAD_PATHに「/usr/local/bundle/gems/rails-6.0.3.1/lib」というパスが指定されているので参照できているのです。

自動読み込みパスとは

Railsが自動で読み込むディレクトリパスのことを言います。

ここには「app」以下にある全てのサブディレクトリや、アプリが依存する可能性があるGemのパスが入っています。

これは、Rails6から組み込まれた「Zeitwerk(ツァイトベルク)」というオートロードシステムが読み込んでいます。

> pp ActiveSupport::Dependencies.autoload_paths

["/app/app/channels",
 "/app/app/controllers",
 "/app/app/controllers/concerns",
 "/app/app/jobs",
 "/app/app/mailers",
 "/app/app/models",
 ...

今回の設定まとめ

つまりconfig.add_autoload_paths_to_load_pathは、Railsが自動で読み込んでいるディレクトリパスを$LOAD_PATHに追加するかを決定します。

既に読み込んでいるのなら「require」を使わなくても読み込めるのでfalseとしています。

また、「Zeitwerk(ツァイトベルク)」を使用するアプリケーションではfalseが推奨されています。

参考 定数の自動読み込みと再読み込み (Zeitwerk) - Railsガイド

Zeitwerkが有効であるかは下記コマンドで確認できます。

> Rails.autoloaders.zeitwerk_enabled?
=> true

最終的なapplication.rb

最終的なapplication.rbはこのようになります。

api/config/application.rb
...
module App
  class Application < Rails::Application
    # Initialize configuration defaults for originally generated Rails version.
    config.load_defaults 6.0

    # Railsアプリデフォルトのタイムゾーン(default 'UTC')
    # TimeZoneList: http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html
    config.time_zone = ENV["TZ"]

    # データベースの読み書きに使用するタイムゾーン(:local | :utc(default))
    config.active_record.default_timezone = :utc

    # i18nで使われるデフォルトのロケールファイルの指定(default :en)
    config.i18n.default_locale = :ja

    # $LOAD_PATHにautoload pathを追加しない(Zeitwerk有効時false推奨)
    config.add_autoload_paths_to_load_path = false

    config.api_only = true
  end
end

ここまでの変更をコミットしときましょう。

root $ cd api && git commit -am "application.rb_initial_setting" && cd ..

[20200702_initial_settings 56ccbc8] application.rb_initial_setting
 1 file changed, 13 insertions(+), 8 deletions(-)

まとめ

今回はapplication.rbを編集し、初期設定を行いました。

ちなみに、Zeitwerkに「lib」ディレクトリ以下のファイルを読み込ますには、このように記述します。

application.rb
config.autoload_paths += %W(#{config.root}/lib)

ただ、

  • 公式であまり推奨されていないこと(完全な非推奨ではない)
  • 「lib」ディレクトリ以下に置くファイルが少量であること

を踏まえ、今回はファイル読み込みにrequireメソッドを使用します。

「lib」ディレクトリ以下にファイルが増えてきたらまた検討すれば良いでしょう。

さて次回は?

次回はモデル開発に必要なGemのインストール編!

それではまたここでお会いしましょう。

バイバイ。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
【随時更新】このカテゴリーで作るアプリケーションの仕様書
1. このカテゴリーの歩き方 #03
【随時更新】このカテゴリーの歩き方
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. 認証アプリのレイアウト設計 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. 認証アプリのレイアウト設計 #02
ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
新着
10. 認証アプリのレイアウト設計 #03
ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
新着
10. 認証アプリのレイアウト設計 #04
addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
新着
10. 認証アプリのレイアウト設計 #05
ウェルカムページをレスポンシブデザインに対応させよう(4/4)
新着
SPA開発
ブログ構築
小ネタ集