Class: LcpRuby::Auditing::ContractValidator

Inherits:
Object
  • Object
show all
Defined in:
lib/lcp_ruby/auditing/contract_validator.rb

Constant Summary collapse

REQUIRED_FIELDS = 
{
  "auditable_type" => "string",
  "auditable_id" => "integer",
  "action" => "string",
  "changes_data" => "json"
}.freeze
{
  "user_id" => "integer",
  "user_snapshot" => "json"
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model_def, field_mapping = nil) ⇒ ContractValidator

Returns a new instance of ContractValidator.



24
25
26
27
28
29
 
# File 'lib/lcp_ruby/auditing/contract_validator.rb', line 24

def initialize(model_def, field_mapping = nil)
  @model_def = model_def
  @field_mapping = (field_mapping || LcpRuby.configuration.audit_model_fields).transform_keys(&:to_s)
  @errors = []
  @warnings = []
end

Class Method Details

.validate(model_def, field_mapping = nil) ⇒ Metadata::ContractResult

Validates that the given model definition satisfies the audit model contract.

Parameters:

  • model_def (Metadata::ModelDefinition) —

    the audit model definition

  • field_mapping (Hash) (defaults to: nil) —

    field mapping from configuration

Returns:



20
21
22
 
# File 'lib/lcp_ruby/auditing/contract_validator.rb', line 20

def self.validate(model_def, field_mapping = nil)
  new(model_def, field_mapping).validate
end

Instance Method Details

#validate ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/lcp_ruby/auditing/contract_validator.rb', line 31

def validate
  validate_required_fields
  validate_recommended_fields
  validate_created_at

  Metadata::ContractResult.new(errors: @errors, warnings: @warnings)
end