Udemy 8. ユーザーモデル開発 #02
2020年07月14日に更新

Railsユーザーモデルのバリデーション設定(has_secure_password解説)

今回達成すること

前回作成したユーザーテーブルにバリデーションを設定していきます。

全体のバリデーション設定は以下のようになります。

カラム 内容 入力 最小文字数 最大文字数 書式チェック 一意性
name ユーザー名 必須 30 しない なし
email メースアドレス 必須 255 する なし
password_digest パスワード 必須 8 72(bcryptの仕様) する なし
activated メール認証フラグ - - - -
admin 管理者フラグ - - - -

今回はnamepasswordのバリデーション設定を行い、emailは次の記事でカスタムバリデーションを設定します。

それでは参りましょうー。

パスワード暗号化のメソッドを追加

バリデーション前にパスワードを暗号化するメソッドを追加しましょう。

「app/models」ディレクトリのuser.rbに、has_secure_password(ハズセキュアパスワード)メソッドを追加します。

api/app/models/user.rb
class User < ApplicationRecord
  # 追加
  # gem bcrypt
  has_secure_password
end

has_secure_passwordとは?

has_secure_passwordとは、Gem bcrypt(ビークリプト)を追加すると使えるようになるメソッドで、パスワードを暗号化して保存してくれます。

使い方は簡単で、モデルファイルにhas_secure_passwordを追加するだけ有効になります。

注意点は、暗号化されたパスワードはpassword_digestというカラムに保存されるので、同一名称のカラムを用意しておく必要があります。

has_secure_passwordの便利機能

このメソッドを追加するだけで様々な便利機能が使えます。

passwordとpassword_confirmation属性の追加

  • ユーザーテーブルへ保存する際にpassword属性で保存が行えます。

    これにより、正式なカラム名password_digest属性を使用する必要がなくなります。

  • password_confirmation(パスワードコンファーメイション)とは、データベースに保存されない仮想の属性で、パスワードの入力確認に使われます。

    この属性を使用するとpasswordpassword_confirmationの双方が一致しているかのバリデーションが自動で追加されます。

authenticate()メソッドの追加

authenticate()とは、ユーザーのパスワード一致判定を行うメソッドです。

このメソッドを使えば、ユーザーが正しいパスワードを入力しているかを判定することができます。

引数にそのユーザーのパスワードを渡し、一致すればユーザーを返し、不一致の場合はfalseを返します。

> User.first.authenticate("password")

パスワードの最大文字数が72文字になる

自動で最大文字数72文字のバリデーションが追加されます。

自身でバリデーションを設定した場合は、エラーメッセージが2重で表示されます。

最大文字数制限のバリデーションは追加しないようにしましょう。

ユーザー作成時にパスワードの入力を検証してくれる

新規会員登録の時だけ入力必須を検証してくれるバリデーションが追加されます。

更新時には検証されません。

これにより、パスワード更新のバリデーションがより簡単に行えます。

参考 第6章 ユーザーのモデルを作成する - Railsチュートリアル

nameのバリデーション

それではバリデーション設定に入ります。

user.rbnameのバリデーションを追加しましょう。

api/app/models/user.rb
class User < ApplicationRecord
	...

  # 追加
  # validates
  validates :name, presence: true,
                   length: { maximum: 30, allow_blank: true }
end
  • presence(プレゼンス): true … 入力必須を検証します。
  • length: {} … 文字数について検証します。
    • maximum(マキシマム): 30 … 文字数30文字までを検証します。
    • allow_blank: true … NULL、空白の場合は検証をスキップします。

allow_blank: trueの使い所

例えば「入力必須」と「文字数10文字以上」のバリデーションを設定したnameカラムを未入力で保存した場合。

Railsは素直なので双方の検証エラーを吐き出します。

「名前を入力してください」

「名前は10文字以上で入力してください」


エンドユーザーからすれば、エラーメッセージが大量に表示されることは非常にストレスです。

ここで出力すべきは入力してないことによるエラー「名前を入力してください」のメッセージだけで良いのです。

このようにallow_blank: trueは、未入力の場合に無駄な検証を行わない場合に使用します。

passwordのバリデーション

続いてパスワードのバリデーション設定を行います。

api/app/models/user.rb
class User < ApplicationRecord
	...
  # 追加
  VALID_PASSWORD_REGEX = /\A[\w\-]+\z/
  validates :password, presence: true,
                       length: { minimum: 8 },
                       format: {
                         with: VALID_PASSWORD_REGEX
                       },
                       allow_blank: true
end
  • length: { minimum: 8 } … 8文字以上であるかを検証します。

  • format: {} … 入力形式を検証します。

    • with: VALID_PASSWORD_REGEX … 入力形式を変数で指定しています。
  • VALID_PASSWORD_REGEX = /\A[\w\-]+\z/ … 正規表現で入力形式を宣言しています。
    • \A … 文字列の先頭にマッチ
    • [\w\-] … 「a-zA-Z0-9_」と「-」にマッチ
    • + … 一回以上繰り返す
    • \z … 文字列の末尾にマッチ
    • まとめ … 先頭から末尾まで、全て「a-zA-Z0-9_」と「-」にマッチする文字列を許容する。
  • allow_blank: true

    ユーザー編集画面ではセキュリティ上、パスワードを表示しません。

    その場合、空白でもバリデーションが通るようこの設定を行います。

    ユーザー新規作成時には、has_secure_passwordメソッドが入力必須を検証してくれるので安心してください。

activated, adminのバリデーション

今回、activatedadminに対するバリデーションは行いません。

Boolean型に入力必須の検証はできない

まず、Boolean型に対するバリデーションにpresence: true(入力必須)は正常に動作しません。

# NG
validates :activated, presence: true

値がfalseの場合にRailsがバリデーションエラーを返してしまうからです。

Boolean型に入力必須のバリデーションは設定しないようにしてください。

対応)入力値を検証するinclusionを使う

Boolean型に正しくtruefalseが入っているかを検証するにはinclusion(インクルージョン)を使います。

# OK
validates :activated, inclusion: { in: [ true, false ] }
  • inclusion: { in: [引数] } … ユーザーが入力した値が引数に含まれているかを検証します。

今回の場合)バリデーションの設定はしない

今回の場合は、マイグレーションファイルでデフォルト値(false)を設定しています。

意図的にNULLを保存しない限り、NULL値が保存されることはありません。

さらにRailsはtruefalse以外の値が入力された場合Boolean型に変換して保存を行います。


つまり、NULLになるリスクもBoolean型以外の値が保存されるリスクもかなり低いということです。

そこにバリデーションは必要ないと判断し設定していません。

(今回はここまで。)

まとめ

この記事ではユーザーモデルにnamepasswordのバリデーションを設定しました。

筆者も最初はBoolean型のカラムにせっせとバリデーションを設定していたのですが、何度も書いてて「あ、いらんなこれ」と気付きました。

ガチガチのバリーデーションよりも、ユーザーが操作するUI画面をちゃんと設計することの方が大切です。

さて次回は?

バリデーションのエラーメッセージを日本語化に対応する設定を行います。

Railsには多言語化対応する「I18n(アイエイティーンエヌ)」モジュールはデフォルトで入っています。

次回はその「I18n」モジュールが読み込む日本語用ファイル、ja.ymlを編集していきましょう。

↓下の記事リストに続く。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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開発
ブログ構築
小ネタ集