【Rails】Active Record(モデル)の書き方《バリデーション篇》

2022年6月16日 18:19

はじめに

ActiveRecord(モデル)のバリデーション設定を行うことで、実際にデータが保存される前に不適合データを弾くことができます。ほとんどのデータベースはカラムに制約を設定することができますが、Railsアプリのモデルでバリデーションを行えば、Railsアプリとデータベース間の無駄なやり取りを減らすことができます。また、テストやメンテナンスのしやすさもメリットのひとつです。

本記事では、ActiveRecord(モデル)のバリデーションについてまとめています。

バリデーションの使い方

バリデーションの動作

バリデーションはコントローラーでデータを保存、作成、更新しようとしたときに実行されます。バリデーションチェックの結果が不適合だった場合、saveupdatefalseを返し、createはインスタンスの中身をそのまま返します。また、末尾に!(エクスクラメーションマーク)が付いているメソッドはActiveRecord::RecordInvalid例外が発生します。

メソッド 説明
save/save! newで作成したインスタンス、値を更新したインスタンスを保存する。
create/create! モデルのインスタンスを作成し保存する。
update/update! モデルのインスタンスを更新し保存する。

バリデーションチェックの結果が不適合だった場合、インスタンスのerrorsハッシュにエラー内容が格納されます。

# ユーザーモデル
validates :name, presence: true
validates :age, presence: true

# ユーザーコントローラー
user = User.new(name: 'Jane')
user.save
user.errors.messages
# => {:age=>["can't be blank"]}

エラー内容をビューに表示する時はerrors.full_messagesを使います。フォームのエラー表示については以下の記事を参照してください。

バリデーションの種類

モデルにはたくさんのバリデーションが用意されています。ここでは、よく使うであろうバリデーションのみを紹介します。

presence

presenceは指定された属性に値が入力されているかを確認します。入力された値がnil、空欄、ホワイトスペース("")の場合、不適合となります。

validates :name, presence: true

length

lengthは指定した長さと合致しているかを確認します。指定した長さに合致しなければ不適合となります。

validates :name, length: { minimum: 1 }
validates :content, length: { maximum: 300 }
validates :password, length: { in: 8..32 }
validates :cell_phone_number, length: { is: 11 }

format

formatwithオプションで指定した正規表現に合致しているかを確認します。入力された値が正規表現に合致しなければ不適合となります。

validates :content, format: { with: /[ぁ-んァ-ヶ一-龥]+?/ }

正規表現の内容が「数字のみ」の場合、numericalityを使うこともできます。デフォルトでは整数または浮動小数点の数字を許可します。整数のみを許可したい場合はonly_integerを有効にします。

validates :age, numericality: { only_integer: true }

# 以下と同じバリデーション
# validates :age, format: { with: /\A[+-]?\d+\z/ }

confirmation

confirmationは2つのテキストフィールドが完全に一致しているかを確認します。メールアドレスやパスワードの確認などで2つが一致していなければ不適合となります。このバリデーションを指定した属性に_confirmationを付け足した確認用の属性が自動で作成されます。

確認用の属性がnilの場合はこのバリデーションが行われないため、確認用の属性には必ずpresenceを指定しておきます。

validates :password, confirmation: true
validates :password_confirmation, presence: true

acceptance

acceptanceはフォームのチェックボックスがオンかを確認します。「利用規約に同意する」などのチェックボックスがオンになっていなければ不適合となります。このバリデーションを指定する属性は画面上でしか使われないため(データベースに保存する必要がないため)、テーブルに対応するカラムが存在する必要はありません。

validates :accept, acceptance: true

独自のエラーメッセージ

バリデーションチェックの結果が不適合だった場合にerrorsハッシュに格納される独自のエラーメッセージを定義できます。

validates :content, presence: true, format: { with: /[ぁ-んァ-ヶ一-龥]+?/, \
                    message: 'には日本語を含めてください Content must contain Japanese.' }

まとめ

最近のモダンブラウザはフォームに入力した値が送信される前に簡単なフォーマットチェック(メールアドレスなど)を行ってくれます。ですが、やはりそれだけでは不十分なことも多いので、Railsアプリでバリデーションを設定しておく必要があります。

本記事を参考にして、ActiveRecord(モデル)のバリデーションについて覚えていただければと思います。

関連記事

【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12
【Rails】モデルに外部キーを設定する方法とよく起こるエラー内容について
# はじめに Railsでモデルに外部キーを設定する方法について説明します。 # モデルに外部キーを設定する ## リレーションシップ 今回は1つのブログ記事は複数のコメントを持つ1対多のリレーションシップを例に説明します。現在は` [...]
2022年2月10日 14:18
【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22
【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58
【Rails】rotpを使った2段階認証の実装方法【初学者】
# はじめに 昨今はIDとパスワードによる認証だけでなく、ワンタイムパスワードによる2段階認証を導入するWebアプリが増えてきました。Railsで作成したWebアプリでも、IDとパスワードによる認証に加えて2段階認証を導入するニーズが高まっていま [...]
2021年11月27日 13:02
【Rails】deviseを使った認証機能の実装【初学者】
# はじめに Railsアプリに認証機能を導入するには「devise」というGemを使う方法が最も簡単です。「devise」は認証に係る機能をほとんどコードを書くことなく実装できる反面、処理がブラックボックス化されており、全容が把握しづらいという [...]
2021年11月27日 13:01