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

はじめに

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】Paranoiaを使用した論理削除(ソフトデリート)
# はじめに Paranoiaは、Railsアプリケーションで論理削除(ソフトデリート)を実現するためのGemです。 論理削除は、データベースのレコードを物理的に削除するのではなく、削除フラグを設定することで「削除済み」とみなす方法です。こ [...]
2024年7月20日 21:33
【Rails】activerecord-multi-tenantを使用したマルチテナントアプリケーションの作成
# はじめに マルチテナントアプリケーションでは、複数の顧客(テナント)が同じアプリケーションを利用するため、データの分離が必要です。 activerecord-multi-tenantは、このようなマルチテナント環境をサポートするための便 [...]
2024年7月18日 16:50
【Rails】RubyとRailsにおけるattr_reader, attr_writer, attr_accessorの概念と使用方法
# はじめに RubyとRailsの開発において、`attr_reader`,`attr_writer`,`attr_accessor`は非常に便利なメソッドです。これらは、クラス内でインスタンス変数に対するゲッターおよびセッターメソッドを簡単に [...]
2024年7月17日 18:11
【Rails】RubyとRailsにおけるyieldの概念と使用方法
# はじめに RubyとRailsにおける`yield`は、メソッドやテンプレートの中で動的にコードブロックを実行する能力を提供し、これによってコードの再利用性と拡張性が大幅に向上します。本記事では、RubyとRailsにおける`yield`の概 [...]
2024年7月17日 13:15
【Rails】AASMを使用してオブジェクトの状態遷移を効率的に管理
# はじめに Railsアプリケーションにおいて、オブジェクトの状態管理は重要な課題の一つです。AASM (Acts As State Machine) gemは、複雑な状態遷移を効率的に管理します。本記事では、AASMの基本的な使い方を解説して [...]
2024年7月16日 18:00
【Rails】RSpec + Swagger + rswagでアプリケーションのAPIをテストおよびドキュメント化する方法
# はじめに Railsアプリケーションの開発において、APIのテストとドキュメント化は重要な要素です。 RSpecはテストフレームワークとして広く利用されており、SwaggerはAPIの設計とドキュメント化を支援します。これらを統合するr [...]
2024年7月16日 14:27
【Rails】mailcatcherを使用して開発環境でメール送信をテストする方法
# はじめに mailcatcherは、開発環境でのメール送信をキャプチャするためのツールです。ローカルで送信されたメールをブラウザ上で簡単に確認できるようにします。mailcatcherをRailsアプリケーションで使用する方法について説明しま [...]
2024年7月15日 16:37
【Rails】impressionistを使用してページビューやクリック数を追跡する方法
# はじめに impressionist Gemを使用してRailsアプリケーションでページビューやクリック数を追跡する方法について説明します。 # 実装方法 ## impressionist Gemのインストール まず、impre [...]
2024年7月15日 14:18