class Assert::Assertions::Choice(PropertyType, ChoicesType)

• Assert::Assertions::Choice(PropertyType, ChoicesType)
• Assert::Assertions::Assertion
• Reference
• Object

Overview

Validates a property is a valid choice.

Optional Arguments

• min_matches - Must select at least min_matches to be valid.
• min_message - Message to display if too few choices are selected.
• max_matches - Must select at most max_matches to be valid.
• max_message - Message to display if too many choices are selected.
• multiple_message - Message to display if one or more values in actual are not in choices.

Example

class Example
  include Assert

  def initialize; end

  @[Assert::Choice(choices: ["Active", "Inactive", "Pending"])]
  property status : String = "Inactive"

  @[Assert::Choice(choices: [2, 4, 6], multiple_message: "One ore more value is invalid")]
  property fav_numbers : Array(Int32) = [2, 4, 6]

  @[Assert::Choice(choices: ['a', 'b', 'c'], min_matches: 2, min_message: "You must have at least 2 choices")]
  property fav_letters_min : Array(Char) = ['a', 'c']

  @[Assert::Choice(choices: ['a', 'b', 'c'], max_matches: 2, max_message: "You must have at most 2 choices")]
  property fav_letters_max : Array(Char) = ['a']
end

Example.new.valid? # => true

NOTE The generic ChoicesType represents the type of choices.

Defined in:

Constructors

• .new(property_name : String, actual : PropertyType, choices : ChoicesType, min_matches : Int32? = nil, max_matches : Int32? = nil, min_message : String? = nil, max_message : String? = nil, multiple_message : String? = nil, message : String? = nil, groups : Array(String)? = nil)

Instance Method Summary

• #default_message_template : String

  Returns the default #message_template to use if no message is provided.

• #message : String

  The message to display if self is not valid.

• #valid? : Bool

  Returns true if a property satisfies self, otherwise false.

Constructor Detail

Instance Method Detail