【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】Railsアップグレードまとめ
# はじめに Ruby on Railsに限らず、何らかのフレームワークを使ってWebシステムを構築している場合、フレームワークのアップグレード作業は避けて通れません。 一般的にフレームワークはバージョン毎にEOL (End of Life [...]
2022年10月1日 14:32
【Rails】ユーザー登録時に行うメールアドレス認証機能の実装方法
# はじめに ユーザー登録/解除やログイン/ログアウトといった認証機能の導入に「devise」というGemを使っている人は多いと思います。「devise」では以下のように記述するだけで、ユーザー登録時に確認メールを送付しメールアドレス認証を行う機 [...]
2022年9月24日 14:24
【Rails】モデルに列挙型(enum)を定義し、使いこなす方法
# はじめに Railsはモデルでカラム名と同名の列挙型(enum)を定義することで、カラムと列挙型の変数を紐付けることができます。カラムと列挙型の変数を紐付けると、カラムに対して様々な便利な使い方ができるようになります。 本記事では、モデ [...]
2022年9月3日 10:29
【Rails】RailsでCORSとPreflight requestの設定を行う方法
# はじめに RailsアプリをAPIサーバーとして構築するには、CORS (Cross-Origin Resource Sharing)と Preflight requestの設定を行う必要があります。APIサーバーは外部からの要求に対して処理 [...]
2022年8月27日 10:44
【Ruby】Bundlerを使ってRubyGemsを作成/公開する方法
# はじめに Bundlerを使ってRubyGemsを作成および公開する方法について説明します。Bundlerを使わずにRubyGemsを作成/公開する方法については以下の記事を参照してください。 <iframe class="hatena [...]
2022年7月12日 23:18
【Ruby】RubyGemsを作成/公開する方法
# はじめに RubyGemsを作成および公開する方法について説明します。Bundlerを使ってRubyGemsを作成する方法については以下の記事を参照してください。 <iframe class="hatenablogcard" style [...]
2022年7月11日 21:52
【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