Class: Cuprum::ParameterValidation::ValidationRule

Parent Namespace

Cuprum::ParameterValidation

Inherited Classes

Struct > Object

Defined In

lib/cuprum/parameter_validation/validation_rule.rb

Table Of Contents

• Overview
• Constants
  • BLOCK_VALIDATION_TYPE
  • NAMED_VALIDATION_TYPE
• Constructor
• Instance Attributes
  • block
  • method_name
  • name
  • options
  • type
• Instance Methods
  • initialize

Overview

Value class representing a single validation for a parameter.

Back To Top

Constants

BLOCK_VALIDATION_TYPE

= :_block_validation

Custom validation type for a block validation.

NAMED_VALIDATION_TYPE

= :_named_method_validation

Custom validation type for a named method validation.

Back To Top

Constructor

#initialize(name:, type:, method_name: nil, **options, &block) => ValidationRule

Parameters

• name (Symbol) — the name of the parameter to validate.
• type (Symbol) — the type of validation to perform.
• method_name (Symbol) — the name for the validation method.
• options (Hash) — additional options to pass to the validator.
• block (Proc) — a block to pass to the validator, if any.

Returns

• (ValidationRule) — a new instance of ValidationRule

Back To Top

Instance Attributes

#block => Object

Returns the value of attribute block

Returns

• (Object) — the current value of block

#method_name => Object

Returns the value of attribute method_name

Returns

• (Object) — the current value of method_name

#name => Object

Returns the value of attribute name

Returns

• (Object) — the current value of name

#options => Object

Returns the value of attribute options

Returns

• (Object) — the current value of options

#type => Object

Returns the value of attribute type

Returns

• (Object) — the current value of type

Back To Top

Instance Methods

Back To Top

---

Back to Documentation | Reference | Cuprum | Cuprum::ParameterValidation