module CouchRest::Validation::ValidatesFormat

Public Instance Methods

validates_format(*fields) click to toggle source

# File lib/couchrest/validation/validators/format_validator.rb, line 115
def validates_format(*fields)
  warn "[DEPRECATION] `validates_format` is deprecated.  Please use `validates_format_of` instead."
  validates_format_of(*fields)
end

validates_format_of(*fields) click to toggle source

Validates that the attribute is in the specified format. You may use the :as (or :with, it’s an alias) option to specify the pre-defined format that you want to validate against. You may also specify your own format via a Proc or Regexp passed to the the :as or :with options.

@option :allow_nil<Boolean> true/false (default is true) @option :as<Format, Proc, Regexp> the pre-defined format, Proc or Regexp to validate against @option :with<Format, Proc, Regexp> an alias for :as

@details [Pre-defined Formats]

:email_address (format is specified in DataMapper::Validation::Format::Email)
:url (format is specified in DataMapper::Validation::Format::Url)

@example [Usage]

class Page

  property :email, String
  property :zip_code, String

  validates_format_of :email, :as => :email_address
  validates_format_of :zip_code, :with => /^\d{5}$/

  # a call to valid? will return false unless:
  # email is formatted like an email address
  # and
  # zip_code is a string of 5 digits

# File lib/couchrest/validation/validators/format_validator.rb, line 110
def validates_format_of(*fields)
  opts = opts_from_validator_args(fields)
  add_validator_to_context(opts, fields, CouchRest::Validation::FormatValidator)
end