Class: Lutaml::Qea::Validation::BaseValidator

Inherits:
Object
  • Object
show all
Defined in:
lib/lutaml/qea/validation/base_validator.rb

Overview

Base class for all validators providing common validation infrastructure and helper methods

Examples:

Creating a custom validator

class MyValidator < BaseValidator
  def validate
    check_required_field(:name)
    check_reference(:parent_id, :packages)
  end
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(result:, context: {}) ⇒ BaseValidator

Creates a new validator

Parameters:

  • result (ValidationResult) —

    Result object to populate

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

    Validation context including database connection, document, etc.



27
28
29
30
 
# File 'lib/lutaml/qea/validation/base_validator.rb', line 27

def initialize(result:, context: {})
  @result = result
  @context = context
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



20
21
22
 
# File 'lib/lutaml/qea/validation/base_validator.rb', line 20

def context
  @context
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



20
21
22
 
# File 'lib/lutaml/qea/validation/base_validator.rb', line 20

def result
  @result
end

Instance Method Details

#call ⇒ void

This method returns an undefined value.

Runs validation Result is populated in the shared @result object



46
47
48
 
# File 'lib/lutaml/qea/validation/base_validator.rb', line 46

def call
  validate
end

#validate ⇒ ValidationResult

Performs validation and returns the result

This method should be overridden by subclasses

Returns:

Raises:

  • (NotImplementedError) 


37
38
39
40
 
# File 'lib/lutaml/qea/validation/base_validator.rb', line 37

def validate
  raise NotImplementedError,
        "#{self.class} must implement #validate"
end