Class: Coradoc::Validation::Rule

Inherits:

Object

• Object
• Coradoc::Validation::Rule

Defined in:

lib/coradoc/validation.rb

Overview

Base class for validation rules

Direct Known Subclasses

Coradoc::Validation::Rules::Count, Coradoc::Validation::Rules::Custom, Coradoc::Validation::Rules::Format, Coradoc::Validation::Rules::Length, Coradoc::Validation::Rules::Required, Coradoc::Validation::Rules::Type

Instance Attribute Summary

• #name ⇒ Object readonly

  Returns the value of attribute name.

• #options ⇒ Object readonly

  Returns the value of attribute options.

Instance Method Summary

• #initialize(name, **options) ⇒ Rule constructor

  Create a validation rule.

• #validate(element, context = {}) ⇒ Array<String>

  Validate an element.

Constructor Details

#initialize(name, **options) ⇒ Rule

Create a validation rule

Parameters:

• name (Symbol) —

  Rule name

• options (Hash) —

  Rule options

# File 'lib/coradoc/validation.rb', line 184

def initialize(name, **options)
  @name = name
  @options = options
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.

# File 'lib/coradoc/validation.rb', line 178

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.

# File 'lib/coradoc/validation.rb', line 178

def options
  @options
end

Instance Method Details

#validate(element, context = {}) ⇒ Array<String>

Validate an element

Parameters:

• element (Object) —

  Element to validate

• context (Hash) (defaults to: {}) —

  Validation context

Returns:

• (Array<String>) —

  Error messages

Raises:

• (NotImplementedError)

# File 'lib/coradoc/validation.rb', line 194

def validate(element, context = {})
  raise NotImplementedError, 'Subclasses must implement #validate'
end