Railsドキュメント

検証(validation)

検証の流れ

1. モデルに検証する条件を定義
2. 保存する前に、検証
3. 検証の結果、エラーが無ければ保存。エラーがあれば、エラーメッセージを表示

属性の値が一意であることを検証(validates_uniqueness_of)

適応バージョン

説明

属性の値が一意であることを検証

使い方

validates_uniqueness_of(検証するフィールド名 [, オプション])

オプション

例

class User < ActiveRecord::Base
  validates_uniqueness_of :user_name, :scope => :account_id
end

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activerecord-4.0.0.beta1/lib/active_record/validations/uniqueness.rb, line 216
def validates_uniqueness_of(*attr_names)
  validates_with UniquenessValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_uniqueness_of - GitHub

関連付けられているオブジェクトを検証(validates_associated)

適応バージョン

説明

関連付けられているオブジェクトを検証

使い方

validates_associated(検証対象 [, ...])

オプション

例

class Book < ActiveRecord::Base
  has_many :pages
  belongs_to :library
  validates_associated :pages, :library
end

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activerecord-4.0.0.beta1/lib/active_record/validations/associated.rb, line 44
def validates_associated(*attr_names)
  validates_with AssociatedValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_associated - GitHub

実行前にリクエストの検証(verify)

適応バージョン

説明

アクションの実行前にチェックを行う

使い方

verify オプション

オプション

例

セッションにuser_idがない場合は、indexにリダイレクト

verify :session => "user_id", :redirect_to { :action => "index" }

POSTでアクセスしてない場合は、indexにリダイレクト

verify :method => :post, :redirect_to { :action => "index" }

create,update,deleteアクション以外は、indexにリダイレクト

verify :only => [:create, :update, :delete], :redirect_to { :action => "index" }

ソースコード

# File activesupport/lib/active_support/message_verifier.rb, line 41
def verify(signed_message)
  raise InvalidSignature if signed_message.blank?

  data, digest = signed_message.split("--")
  if data.present? && digest.present? && secure_compare(digest, generate_digest(data))
    @serializer.load(::Base64.decode64(data))
  else
    raise InvalidSignature
  end
end

ソースコード検索

• Search: verify - GitHub

チェックボックスのチェックが入っているか(acceptance)

適応バージョン

説明

チェックボックスのチェックが入っているか

使い方

validates(検証するフィールド名, :acceptance => 検証パラメータ)

オプション

例

validates :terms, acceptance: true

ソースコード検索

• Search: acceptance - GitHub

2つのフィールドが等しいか(confirmation)

適応バージョン

説明

2つのフィールドが等しいか

使い方

validates(検証するフィールド名, :confirmation => 検証パラメータ)

オプション

例

validates :password, confirmation: true

ソースコード検索

• Search: confirmation - GitHub

値が配列・範囲に含まれていないか(exclusion)

適応バージョン

説明

値が配列に含まれていないか

使い方

validates(検証するフィールド名, :exclusion => 検証パラメータ)

オプション

例

validates :username, exclusion: { in: %w(admin superuser) }

ソースコード検索

• Search: exclusion - GitHub

値が配列・範囲に含まれているか(inclusion)

適応バージョン

説明

値が配列・範囲に含まれているか

使い方

validates(検証するフィールド名, :inclusion => 検証パラメータ)

オプション

例

validates :age, inclusion: { in: 0..9 }

ソースコード検索

• Search: inclusion - GitHub

正規表現パターンに一致しているか(format)

適応バージョン

説明

正規表現パターンに一致しているか

使い方

validates(検証するフィールド名, :format => 検証パラメータ)

オプション

例

validates :email, format: { with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, on: :create }

ソースコード検索

• Search: format - GitHub

文字列の長さをチェック(length)

適応バージョン

説明

文字列の長さをチェック

使い方

validates(検証するフィールド名, :length => 検証パラメータ)

オプション

例

validates :first_name, length: { maximum: 30 }

ソースコード検索

• Search: length - GitHub

数値の大小、型をチェック(numericality)

適応バージョン

説明

チェックボックスのチェックが入っているか

使い方

validates(検証するフィールド名, :numericality => 検証パラメータ)

オプション

例

validates :age, numericality: true

ソースコード検索

• Search: numericality - GitHub

値が空でないか(presence)

適応バージョン

説明

チェックボックスのチェックが入っているか

使い方

validates(検証するフィールド名, :presence => 検証パラメータ)

オプション

例

validates :username, presence: true

ソースコード検索

• Search: presence - GitHub

値が一意であるか(uniqueness)

適応バージョン

説明

値が一意であるか

使い方

validates(検証するフィールド名, :uniqueness => 検証パラメータ)

オプション

例

validates :username, uniqueness: true

ソースコード検索

• Search: uniqueness - GitHub

値が空でないか(validates_presence_of)

適応バージョン

説明

値が空でないかを検証

使い方

validates_presence_of(検証対象 [, ...])

オプション

例

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activerecord-4.0.0.beta1/lib/active_record/validations/presence.rb, line 60
def validates_presence_of(*attr_names)
  validates_with PresenceValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_presence_of - GitHub

モデルの検証を定義(validate)

適応バージョン

説明

モデルの検証を定義する

使い方

validate 検証メソッド名 [, ...]

オプション

例

class Comment
  include ActiveModel::Validations

  validate :must_be_friends

  def must_be_friends
    errors.add(:base, 'Must be friends to leave a comment') unless commenter.friend_of?(commentee)
  end
end

class Comment
  include ActiveModel::Validations

  validate do |comment|
    comment.must_be_friends
  end

  def must_be_friends
    errors.add(:base, 'Must be friends to leave a comment') unless commenter.friend_of?(commentee)
  end
end

ソースコード検索

• Search: validate - GitHub

空白であることを検証(validates_absence_of)

適応バージョン

説明

空白であることを検証する

使い方

validates_absence_of(検証するフィールド名 [, ...])

オプション

例

class Person < ActiveRecord::Base
  validates_acceptance_of :terms_of_service
  validates_acceptance_of :eula, message: 'must be abided'
end

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activemodel-4.0.0.beta1/lib/active_model/validations/absence.rb, line 26
def validates_absence_of(*attr_names)
  validates_with AbsenceValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_absence_of - GitHub

チェックボックスにチェックが入っているか検証(validates_acceptance_of)

適応バージョン

説明

チェックボックスにチェックが入っているか検証する

使い方

validates_acceptance_of(検証するフィールド名 [, ...])

オプション

例

class Person < ActiveRecord::Base
  validates_acceptance_of :terms_of_service
  validates_acceptance_of :eula, message: 'must be abided'
end

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activemodel-4.0.0.beta1/lib/active_model/validations/acceptance.rb, line 50
def validates_acceptance_of(*attr_names)
  validates_with AcceptanceValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_acceptance_of - GitHub

2つのフィールドが等しいか検証(validates_confirmation_of)

適応バージョン

説明

2つのフィールドが等しいか検証する

使い方

validates_confirmation_of(検証するフィールド名 [, ...])

オプション

例

Model:
  class Person < ActiveRecord::Base
    validates_confirmation_of :user_name, :password
    validates_confirmation_of :email_address,
                              message: 'should match confirmation'
  end

View:
  <%= password_field "person", "password" %>
  <%= password_field "person", "password_confirmation" %>

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activemodel-4.0.0.beta1/lib/active_model/validations/confirmation.rb, line 52
def validates_confirmation_of(*attr_names)
  validates_with ConfirmationValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_confirmation_of - GitHub

値が配列・範囲に含まれていないか検証(validates_exclusion_of)

適応バージョン

説明

値が配列・範囲に含まれていないか検証する

使い方

validates_exclusion_of(検証するフィールド名 [, ...])

オプション

例

class Person < ActiveRecord::Base
  validates_exclusion_of :username, in: %w( admin superuser ), message: "You don't belong here"
  validates_exclusion_of :age, in: 30..60, message: 'This site is only for under 30 and over 60'
  validates_exclusion_of :format, in: %w( mov avi ), message: "extension %{value} is not allowed"
  validates_exclusion_of :password, in: ->(person) { [person.username, person.first_name] },
                         message: 'should not be the same as your username or first name'
  validates_exclusion_of :karma, in: :reserved_karmas
end

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activemodel-4.0.0.beta1/lib/active_model/validations/exclusion.rb, line 45
def validates_exclusion_of(*attr_names)
  validates_with ExclusionValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_exclusion_of - GitHub

正規表現パターンに一致しているか検証(validates_format_of)

適応バージョン

説明

正規表現パターンに一致しているか検証する

使い方

validates_format_of(検証するフィールド名 [, ...])

オプション

例

class Person < ActiveRecord::Base
  validates_format_of :email, with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/, on: :create
end

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activemodel-4.0.0.beta1/lib/active_model/validations/format.rb, line 110
def validates_format_of(*attr_names)
  validates_with FormatValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_format_of - GitHub

値が配列・範囲に含まれているか検証(validates_inclusion_of)

適応バージョン

説明

値が配列・範囲に含まれているか検証する

使い方

validates_inclusion_of(検証するフィールド名 [, ...])

オプション

例

class Person < ActiveRecord::Base
  validates_inclusion_of :gender, in: %w( m f )
  validates_inclusion_of :age, in: 0..99
  validates_inclusion_of :format, in: %w( jpg gif png ), message: "extension %{value} is not included in the list"
  validates_inclusion_of :states, in: ->(person) { STATES[person.country] }
  validates_inclusion_of :karma, in: :available_karmas
end

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activemodel-4.0.0.beta1/lib/active_model/validations/inclusion.rb, line 44
def validates_inclusion_of(*attr_names)
  validates_with InclusionValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_inclusion_of - GitHub

文字列の長さをチェック(validates_length_of)

適応バージョン

説明

文字列の長さをチェックする

使い方

validates_length_of(検証するフィールド名 [, ...])

オプション

例

class Person < ActiveRecord::Base
  validates_length_of :first_name, maximum: 30
  validates_length_of :last_name, maximum: 30, message: "less than 30 if you don't mind"
  validates_length_of :fax, in: 7..32, allow_nil: true
  validates_length_of :phone, in: 7..32, allow_blank: true
  validates_length_of :user_name, within: 6..20, too_long: 'pick a shorter name', too_short: 'pick a longer name'
  validates_length_of :zip_code, minimum: 5, too_short: 'please enter at least 5 characters'
  validates_length_of :smurf_leader, is: 4, message: "papa is spelled with 4 characters... don't play me."
  validates_length_of :essay, minimum: 100, too_short: 'Your essay must be at least 100 words.',
                      tokenizer: ->(str) { str.scan(/\w+/) }
end

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activemodel-4.0.0.beta1/lib/active_model/validations/length.rb, line 119
def validates_length_of(*attr_names)
  validates_with LengthValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_length_of - GitHub

数値の大小、型をチェック(validates_numericality_of)

適応バージョン

説明

数値の大小、型をチェックする

使い方

validates_numericality_of(検証するフィールド名 [, ...])

オプション

例

class Person < ActiveRecord::Base
  validates_numericality_of :value, on: :create
end

ソースコード

# File /usr/local/lib/ruby/gems/2.0.0/gems/activemodel-4.0.0.beta1/lib/active_model/validations/numericality.rb, line 131
def validates_numericality_of(*attr_names)
  validates_with NumericalityValidator, _merge_attributes(attr_names)
end

ソースコード検索

• Search: validates_numericality_of - GitHub