Class: LcpRuby::Workflow::AuditContractValidator

Inherits:
Object
  • Object
show all
Defined in:
lib/lcp_ruby/workflow/audit_contract_validator.rb

Constant Summary collapse

REQUIRED_FIELDS = 
{
  "record_type" => "string",
  "record_id" => "integer",
  "workflow_name" => "string",
  "transition_name" => "string",
  "from_state" => "string",
  "to_state" => "string"
}.freeze
{
  "workflow_version" => "integer",
  "user_id" => "integer",
  "user_snapshot" => "json",
  "comment" => "text",
  "metadata" => "json"
}.freeze

Class Method Summary collapse

Class Method Details

.validate(model_def, field_mapping = nil) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/lcp_ruby/workflow/audit_contract_validator.rb', line 21

def self.validate(model_def, field_mapping = nil)
  field_mapping = (field_mapping || LcpRuby.configuration.workflow_audit_model_fields).transform_keys(&:to_s)
  errors = []
  warnings = []

  REQUIRED_FIELDS.each do |logical_name, expected_type|
    mapped_name = field_mapping[logical_name] || logical_name
    field = model_def.fields.find { |f| f.name == mapped_name.to_s }

    if field.nil?
      errors << "Workflow audit model '#{model_def.name}' must have a '#{mapped_name}' field (mapped as #{logical_name})"
      next
    end

    actual_type = field.type
    expected_types = expected_type == "json" ? %w[json jsonb] : [ expected_type ]
    unless expected_types.include?(actual_type)
      errors << "Workflow audit model '#{model_def.name}': '#{mapped_name}' field must be type " \
                 "'#{expected_type}' (got '#{actual_type}')"
    end
  end

  RECOMMENDED_FIELDS.each do |logical_name, expected_type|
    mapped_name = field_mapping[logical_name] || logical_name
    field = model_def.fields.find { |f| f.name == mapped_name.to_s }

    if field.nil?
      warnings << "Workflow audit model '#{model_def.name}': '#{mapped_name}' field is recommended (mapped as #{logical_name})"
      next
    end

    actual_type = field.type
    expected_types = expected_type == "json" ? %w[json jsonb] : [ expected_type ]
    unless expected_types.include?(actual_type)
      errors << "Workflow audit model '#{model_def.name}': '#{mapped_name}' field must be type " \
                 "'#{expected_type}' (got '#{actual_type}')"
    end
  end

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