- A
- C
- V
實例公開方法
attribute_method?(屬性) 連結
如果 屬性
是屬性方法,則傳回 true
,否則傳回 false
。
class Person
include ActiveModel::Validations
attr_accessor :name
end
User.attribute_method?(:name) # => true
User.attribute_method?(:age) # => false
來源: 顯示 | 在 GitHub 上
# File activemodel/lib/active_model/validations.rb, line 284 def attribute_method?(attribute) method_defined?(attribute) end
clear_validators!() 連結
清除所有驗證器和驗證。
請注意,這將清除用於驗證 validates_with
和 validate
方法的模型的所有內容。它會清除使用 validates_with
呼叫建立的驗證器,以及使用 validate
呼叫設定的回呼。
class Person
include ActiveModel::Validations
validates_with MyValidator
validates_with OtherValidator, on: :create
validates_with StrictValidator, strict: true
validate :cannot_be_robot
def cannot_be_robot
errors.add(:base, 'A person cannot be a robot') if person_is_robot
end
end
Person.validators
# => [
# #<MyValidator:0x007fbff403e808 @options={}>,
# #<OtherValidator:0x007fbff403d930 @options={on: :create}>,
# #<StrictValidator:0x007fbff3204a30 @options={strict:true}>
# ]
如果執行 Person.clear_validators!
,然後檢查此類別有哪些驗證器,您會取得
Person.validators # => []
此外,由 validate :cannot_be_robot
設定的回呼會被清除,因此
Person._validate_callbacks.empty? # => true
來源: 顯示 | 在 GitHub 上
# File activemodel/lib/active_model/validations.rb, line 248 def clear_validators! reset_callbacks(:validate) _validators.clear end
validate(*args, &block) 連結
將驗證方法或區塊新增到類別。當覆寫 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
或使用區塊,其中 self
指向要驗證的目前記錄
class Comment
include ActiveModel::Validations
validate do
errors.add(:base, 'Must be friends to leave a comment') unless commenter.friend_of?(commentee)
end
end
請注意,驗證方法的傳回值無關緊要。無法停止驗證回呼鏈。
選項
-
:on
- 指定此驗證處於活動狀態的內容。預設在所有驗證內容中執行nil
。您可以傳遞符號或符號陣列。(例如on: :create
或on: :custom_validation_context
或on: [:create, :custom_validation_context]
) -
:if
- 指定要呼叫的方法、程序或字串,以確定是否應執行驗證(例如if: :allow_validation
或if: Proc.new { |user| user.signup_step > 2 }
)。方法、程序或字串應傳回或評估為true
或false
值。 -
:unless
- 指定要呼叫的方法、程序或字串,以確定是否不應執行驗證(例如unless: :skip_validation
或unless: Proc.new { |user| user.signup_step <= 2 }
)。方法、程序或字串應傳回或評估為true
或false
值。
注意:對同一個方法呼叫 validate
多次會覆寫先前的定義。
來源:顯示 | 在 GitHub 上
# File activemodel/lib/active_model/validations.rb, line 171 def validate(*args, &block) options = args.extract_options! if args.all?(Symbol) options.each_key do |k| unless VALID_OPTIONS_FOR_VALIDATE.include?(k) raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{VALID_OPTIONS_FOR_VALIDATE.map(&:inspect).join(', ')}. Perhaps you meant to call `validates` instead of `validate`?") end end end if options.key?(:on) options = options.merge(if: [predicate_for_validation_context(options[:on]), *options[:if]]) end set_callback(:validate, *args, options, &block) end
validates(*attributes) 連結
此方法是所有預設驗證程式和任何以「Validator」結尾的客製驗證程式類別的捷徑。請注意,Rails 預設驗證程式可以在特定類別內部覆寫,方法是在其位置建立客製驗證程式類別,例如 PresenceValidator。
使用 Rails 預設驗證程式的範例
validates :username, absence: true
validates :terms, acceptance: true
validates :password, confirmation: true
validates :username, exclusion: { in: %w(admin superuser) }
validates :email, format: { with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i, on: :create }
validates :age, inclusion: { in: 0..9 }
validates :first_name, length: { maximum: 30 }
validates :age, numericality: true
validates :username, presence: true
validates
方法的強大之處在於在單一呼叫中針對特定屬性使用客製驗證程式和預設驗證程式。
class EmailValidator < ActiveModel::EachValidator
def validate_each(record, attribute, value)
record.errors.add attribute, (options[:message] || "is not an email") unless
/\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i.match?(value)
end
end
class Person
include ActiveModel::Validations
attr_accessor :name, :email
validates :name, presence: true, length: { maximum: 100 }
validates :email, presence: true, email: true
end
Validator
類別也可能存在於正在驗證的類別中,允許根據需要包含驗證器的自訂模組。
class Film
include ActiveModel::Validations
class TitleValidator < ActiveModel::EachValidator
def validate_each(record, attribute, value)
record.errors.add attribute, "must start with 'the'" unless /\Athe/i.match?(value)
end
end
validates :name, title: true
end
此外,驗證器類別可以位於另一個命名空間中,並仍然可以在任何類別中使用。
validates :name, :'film/title' => true
驗證器雜湊也可以以捷徑形式處理正規表示式、範圍、陣列和字串。
validates :email, format: /@/
validates :role, inclusion: %w(admin contributor)
validates :password, length: 6..20
在使用捷徑形式時,範圍和陣列會以 options[:in]
傳遞給驗證器的初始化程式,而其他類型(包括正規表示式和字串)則會以 options[:with]
傳遞。
還有一系列可用於驗證器的選項
-
:on
- 指定此驗證處於活動狀態的內容。預設在所有驗證內容中執行nil
。您可以傳遞符號或符號陣列。(例如on: :create
或on: :custom_validation_context
或on: [:create, :custom_validation_context]
) -
:if
- 指定要呼叫的方法、程序或字串,以確定是否應執行驗證(例如if: :allow_validation
或if: Proc.new { |user| user.signup_step > 2 }
)。方法、程序或字串應傳回或評估為true
或false
值。 -
:unless
- 指定要呼叫的方法、程序或字串,以確定是否不應執行驗證(例如unless: :skip_validation
或unless: Proc.new { |user| user.signup_step <= 2 }
)。方法、程序或字串應傳回或評估為true
或false
值。 -
:allow_nil
- 如果屬性為nil
,則略過驗證。 -
:allow_blank
- 如果屬性為空白,則略過驗證。 -
:strict
- 如果:strict
選項設為 true,則會引發ActiveModel::StrictValidationFailed
,而不是新增錯誤。:strict
選項也可以設為任何其他例外。
範例
validates :password, presence: true, confirmation: true, if: :password_required?
validates :token, length: { is: 24 }, strict: TokenLengthException
最後,選項 :if
、:unless
、:on
、:allow_blank
、:allow_nil
、:strict
和 :message
可以作為雜湊提供給一個特定驗證器
validates :password, presence: { if: :password_required?, message: 'is forgotten.' }, confirmation: true
來源:顯示 | 在 GitHub 上
# File activemodel/lib/active_model/validations/validates.rb, line 106 def validates(*attributes) defaults = attributes.extract_options!.dup validations = defaults.slice!(*_validates_default_keys) raise ArgumentError, "You need to supply at least one attribute" if attributes.empty? raise ArgumentError, "You need to supply at least one validation" if validations.empty? defaults[:attributes] = attributes validations.each do |key, options| key = "#{key.to_s.camelize}Validator" begin validator = const_get(key) rescue NameError raise ArgumentError, "Unknown validator: '#{key}'" end next unless options validates_with(validator, defaults.merge(_parse_validates_options(options))) end end
validates!(*attributes) 連結
此方法用於定義無法由最終使用者更正且被視為例外的驗證。因此,每個使用驚嘆號或將 :strict
選項設為 true
定義的驗證器在驗證失敗時,將永遠引發 ActiveModel::StrictValidationFailed
,而不是新增錯誤。有關驗證本身的更多資訊,請參閱 validates
。
class Person
include ActiveModel::Validations
attr_accessor :name
validates! :name, presence: true
end
person = Person.new
person.name = ''
person.valid?
# => ActiveModel::StrictValidationFailed: Name can't be blank
來源:顯示 | 在 GitHub 上
# File activemodel/lib/active_model/validations/validates.rb, line 148 def validates!(*attributes) options = attributes.extract_options! options[:strict] = true validates(*(attributes << options)) end
validates_each(*attr_names, &block) 連結
根據區塊驗證每個屬性。
class Person
include ActiveModel::Validations
attr_accessor :first_name, :last_name
validates_each :first_name, :last_name, allow_blank: true do |record, attr, value|
record.errors.add attr, "starts with z." if value.start_with?("z")
end
end
選項
-
:on
- 指定此驗證處於活動狀態的內容。預設在所有驗證內容中執行nil
。您可以傳遞符號或符號陣列。(例如on: :create
或on: :custom_validation_context
或on: [:create, :custom_validation_context]
) -
:allow_nil
- 如果屬性為nil
,則略過驗證。 -
:allow_blank
- 如果屬性為空白,則略過驗證。 -
:if
- 指定要呼叫的方法、程序或字串,以確定是否應執行驗證(例如if: :allow_validation
或if: Proc.new { |user| user.signup_step > 2 }
)。方法、程序或字串應傳回或評估為true
或false
值。 -
:unless
- 指定要呼叫的方法、程序或字串,以確定是否不應執行驗證(例如unless: :skip_validation
或unless: Proc.new { |user| user.signup_step <= 2 }
)。方法、程序或字串應傳回或評估為true
或false
值。
來源:顯示 | 在 GitHub 上
# File activemodel/lib/active_model/validations.rb, line 104 def validates_each(*attr_names, &block) validates_with BlockValidator, _merge_attributes(attr_names), &block end
validates_with(*args, &block) 連結
將記錄傳遞給指定的類別或類別,並允許他們根據更複雜的條件新增錯誤。
class Person
include ActiveModel::Validations
validates_with MyValidator
end
class MyValidator < ActiveModel::Validator
def validate(record)
if some_complex_logic
record.errors.add :base, 'This record is invalid'
end
end
private
def some_complex_logic
# ...
end
end
您也可以像這樣傳遞多個類別
class Person
include ActiveModel::Validations
validates_with MyValidator, MyOtherValidator, on: :create
end
validates_with
沒有預設的錯誤訊息。您必須手動將錯誤新增到驗證器類別中的記錄錯誤集合。
若要實作驗證方法,您必須定義一個 record
參數,也就是要驗證的記錄。
組態選項
-
:on
- 指定此驗證處於活動狀態的內容。預設在所有驗證內容中執行nil
。您可以傳遞符號或符號陣列。(例如on: :create
或on: :custom_validation_context
或on: [:create, :custom_validation_context]
) -
:if
- 指定一個方法、程序或字串,用於呼叫以判斷是否應執行驗證(例如if: :allow_validation
或if: Proc.new { |user| user.signup_step > 2 }
)。方法、程序或字串應傳回或評估為true
或false
值。 -
:unless
- 指定要呼叫的方法、程序或字串,以確定是否不應執行驗證(例如unless: :skip_validation
或unless: Proc.new { |user| user.signup_step <= 2 }
)。方法、程序或字串應傳回或評估為true
或false
值。 -
:strict
- 指定驗證是否應嚴格。有關更多資訊,請參閱ActiveModel::Validations#validates!
。
如果您傳遞任何其他組態選項,它們將傳遞給類別並可用作 options
class Person
include ActiveModel::Validations
validates_with MyValidator, my_custom_key: 'my custom value'
end
class MyValidator < ActiveModel::Validator
def validate(record)
options[:my_custom_key] # => "my custom value"
end
end
來源:顯示 | 在 GitHub 上
# File activemodel/lib/active_model/validations/with.rb, line 88 def validates_with(*args, &block) options = args.extract_options! options[:class] = self args.each do |klass| validator = klass.new(options.dup, &block) if validator.respond_to?(:attributes) && !validator.attributes.empty? validator.attributes.each do |attribute| _validators[attribute.to_sym] << validator end else _validators[nil] << validator end validate(validator, options) end end
validators() 連結
列出所有用於使用 validates_with
方法驗證模型的驗證器。
class Person
include ActiveModel::Validations
validates_with MyValidator
validates_with OtherValidator, on: :create
validates_with StrictValidator, strict: true
end
Person.validators
# => [
# #<MyValidator:0x007fbff403e808 @options={}>,
# #<OtherValidator:0x007fbff403d930 @options={on: :create}>,
# #<StrictValidator:0x007fbff3204a30 @options={strict:true}>
# ]
來源:顯示 | 在 GitHub 上
# File activemodel/lib/active_model/validations.rb, line 206 def validators _validators.values.flatten.uniq end
validators_on(*attributes) 連結
列出所有用於驗證特定屬性的驗證器。
class Person
include ActiveModel::Validations
attr_accessor :name, :age
validates_presence_of :name
validates_inclusion_of :age, in: 0..99
end
Person.validators_on(:name)
# => [
# #<ActiveModel::Validations::PresenceValidator:0x007fe604914e60 @attributes=[:name], @options={}>,
# ]
來源:顯示 | 在 GitHub 上
# File activemodel/lib/active_model/validations.rb, line 268 def validators_on(*attributes) attributes.flat_map do |attribute| _validators[attribute.to_sym] end end