【Rails】バリデーションで指定できるオプションまとめ

どうもおはようポテト(@ohayoupoteto22)です。

Railsで避けては通れないバリデーション。

とういう方に向けて「Railsのバリデーションで指定できる検証クラス」をまとめました。

初学者の備忘録ゆえに至らない点もあると思いますが参考になれば幸いです⸝⸝- ̫ -⸝⸝

Railsのバリデーションのオプションまとめ

length

validates :example,
  length: {minimum: 810, maximum: 114514}

lengthは文字列の長さをチェックしてくれます。

指定できるパラメーターは以下にまとめました。

lengthのパラメーター

numericality

validates :example,
  numericality: { only_integer: true, greater_than: 810}

numericalityは数値について色々チェックしてくれます。

指定できるパラメーターは以下にまとめました。

numericalityのパラメーター

format

validates :example,
  format: {with : /Aオフ会[0-9]+人z/}

formatは正規表現パターンとマッチするかチェックしてくれます。

その際にパラメーターとしてwithを使います。

uniqueness

validates :example,
  uniquness: true

uniquenessは値が重複していないかチェックしてくれます。

指定できるパラメータは以下にまとめました。

uniquenessのパラメーター

validates :example1,
  uniqueness: {scope: [:example2, :example3]}

scopeというパラメーターでは、「どの列も含め一意にするか」を設定できます。

上の例だとexample1〜3の三つのカラムの中で一件しか登録できないようになります。

presence

validates :example,
  presence: true

presenceは値が空ではないかチェックしてくれます。

absence

validates :example,
  absence: true

absenceは値が空かチェックしてくれます。

acceptance

validates :example,
  acceptance: true

acceptanceはチェックボックスにチェックが入ってるかどうか検証してくれます。

パラメーターとしてチェック時の値を表すacceptが指定できます。

confirmation

validates :example,
  confirmation: true

confirmationは重要な項目を確認のために2回入力させる場合に、それらが等しいかチェックしてくれます。

inclusion

validates :example,
inculseion: {in: ["syamu_game","大物youtube r","貝塚土竜"]}

inclusionは指定したオブジェクトに含まれている値かチェックしてくれます。

その際にパラーメーターとしてinを使います。

exclusion

validates :example,
exclusion: {in: ["syamu_game","大物youtube r","貝塚土竜"]}

exclusionは指定したオブジェクトに含まれていない値かチェックしてくれます。

その際にパラメーターとしてinを使います。

各検証クラス共通のパラメーター

上で挙げた検証クラス全てで共通で使えるパラメータがあります。

まとめるとこんな感じ。

allow_nill / allow_blank

validates :example,
  uniqueness: {allow_blank: true},
  length: {minimum: 810, allow_nill: true}

allow_nill(allow_blank)はそのレコードがnill(nillか空)であった場合にその項目の検証をスキップしてくれるパラメーターです。

上の例でいうとexampleというカラムは、nillか空の場合一意かどうかの検証(uniqueness)はスキップされ、nillの場合長さの検証(length)はスキップされる…ってな具合です。

if / unless

validates :example,
  uniqueness: {unless: "example2.blank?"},
  length: {minimum: 810, if: "!example2.blank?"}

if(unless)は特定の条件下でのみその項目の検証を行うパラメーターです。

上の例でいうとexample2というカラムのレコードが空でなければ一意かどうかと長さの検証をする…ということですね。

on

validates :example,
  uniqueness: {on: create},
  length: {minimum: 810, on: update}

onは登録/更新どちらの際にその検証を行うか設定できるパラメーターです。

上の例でいうと一意の検証は登録時のみに、長さの検証は更新時のみにするように設定しています。

message

validates :example,
  uniqueness: {message: "%{value}は既に使われています。"},
  length: {minimum: 810, message: "%{count}はイキスギィ！"}

messageはその名の通りエラーメッセージを設定できるパラメーターです。

「%{value}」には入力された値、「%{count}」には数値の検証パラメータが入ります。

まとめ

以上、Railsのバリデーションで指定できる検証クラスまとめでした。

参考になれば幸いです！では⸝⸝- ̫ -⸝⸝
参考 Active Record バリデーションRailsガイド