class Athena::Validator::Constraints::Luhn
Overview
Validates that a credit card number passes the Luhn algorithm; a useful first step to validating a credit card.
The underlying value is converted to a string via #to_s
before being validated.
NOTE As with most other constraints, nil
and empty strings are considered valid values, in order to allow the value to be optional.
If the value is required, consider combining this constraint with AVD::Constraints::NotBlank
.
Configuration
Optional Arguments
message
Type: String
Default: This value is not a valid credit card number.
The message that will be shown if the value is not pass the Luhn check.
Placeholders
The following placeholders can be used in this message:
{{ value }}
- The current (invalid) value.
groups
Type: Array(String) | String | Nil
Default: nil
The [validation groups][Athena::Validator::Constraint--validation-groups] this constraint belongs to.
AVD::Constraint::DEFAULT_GROUP
is assumed if nil
.
payload
Type: Hash(String, String)?
Default: nil
Any arbitrary domain-specific data that should be stored with this constraint.
The [payload][Athena::Validator::Constraint--payload] is not used by Athena::Validator
, but its processing is completely up to you.
Defined in:
constraints/luhn.crConstant Summary
-
CHECKSUM_FAILED_ERROR =
"a4f089dd-fd63-4d50-ac30-34ed2a8dc9dd"
-
INVALID_CHARACTERS_ERROR =
"c42b8d36-d9e9-4f5f-aad6-5190e27a1102"
Constructors
Instance Method Summary
-
#validated_by : AVD::ConstraintValidator.class
Returns the
AVD::ConstraintValidator.class
that should handle validatingself
.
Instance methods inherited from class Athena::Validator::Constraint
add_implicit_group(group : String) : Nil
add_implicit_group,
groups : Array(String)
groups,
groups=(groups : Array(String))
groups=,
message : String
message,
payload : Hash(String, String) | Nil
payload,
validated_by : AVD::ConstraintValidator.class
validated_by
Constructor methods inherited from class Athena::Validator::Constraint
new(message : String, groups : Array(String) | String | Nil = nil, payload : Hash(String, String) | Nil = nil)
new
Class methods inherited from class Athena::Validator::Constraint
error_name(error_code : String) : String
error_name
Constructor Detail
Instance Method Detail
Returns the AVD::ConstraintValidator.class
that should handle validating self
.