Class: MiniDefender::Validator

Inherits:
Object
  • Object
show all
Defined in:
lib/mini_defender/validator.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rules, data) ⇒ Validator

Returns a new instance of Validator.



7
8
9
10
11
12
13
14
15
16
# File 'lib/mini_defender/validator.rb', line 7

def initialize(rules, data)
  @rules = rules
  @data = data.flatten_keys(keep_roots: true)
  @errors = nil
  @validated = {}
  @coerced = {}
  @expander = RulesExpander.new
  @factory = RulesFactory.new
  @array_patterns = @expander.array_patterns(rules)
end

Instance Attribute Details

#dataObject (readonly)

Returns the value of attribute data.



5
6
7
# File 'lib/mini_defender/validator.rb', line 5

def data
  @data
end

#errorsObject (readonly)

Returns the value of attribute errors.



5
6
7
# File 'lib/mini_defender/validator.rb', line 5

def errors
  @errors
end

#rulesObject (readonly)

Returns the value of attribute rules.



5
6
7
# File 'lib/mini_defender/validator.rb', line 5

def rules
  @rules
end

Instance Method Details

#coercedObject



130
131
132
133
# File 'lib/mini_defender/validator.rb', line 130

def coerced
  validate! if @errors.nil?
  @coerced_compacted = compact_expanded(@coerced)
end

#fails?Boolean

Returns:

  • (Boolean)


121
122
123
# File 'lib/mini_defender/validator.rb', line 121

def fails?
  !passes?
end

#neighbor_values(key, level = 1) ⇒ Array

Returns:

  • (Array)


142
143
144
# File 'lib/mini_defender/validator.rb', line 142

def neighbor_values(key, level = 1)
  neighbors(key, level).values
end

#neighbors(key, level = 1) ⇒ Hash

Returns:

  • (Hash)


136
137
138
139
# File 'lib/mini_defender/validator.rb', line 136

def neighbors(key, level = 1)
  pattern = leveled_search_pattern(key, level)
  @data.filter { |k, _| k.match?(pattern) }
end

#passes?Boolean

Returns:

  • (Boolean)


116
117
118
119
# File 'lib/mini_defender/validator.rb', line 116

def passes?
  validate if @errors.nil?
  @errors.empty?
end

#validateObject



18
19
20
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/mini_defender/validator.rb', line 18

def validate
  unless @errors.nil?
    return
  end

  @errors = {}

  data_rules = @rules.to_h do |k, set|
    [k, @factory.init_set(set)]
  end

  # Set default values for missing data key compared to rules
  defaults_rules = data_rules.filter { |k, set| set.any? { |r| r.defaults?(self) } }
  defaults_rules.each do |key_pattern, set|
    # If element is not inside an array
    unless key_pattern.match?(/\*/)
      if missing_value?(@data[key_pattern])
        @data[key_pattern] = set.map { |r| r.default_value(self) }.reject(&:nil?).first
      end

      next
    end

    parent, sep, child_key = key_pattern.rpartition('*')
    parent += sep

    # If parent or a sibling exists, add the default value
    pattern = Regexp.new("\\A#{parent.gsub('*', '\d')}\\z")
    additions = {}
    @data.each do |k, _|
      unless k.match?(pattern)
        next
      end

      current_child_key = "#{k}#{child_key}"

      unless missing_value?(@data[current_child_key])
        next
      end

      additions[current_child_key] = set.map { |r| r.default_value(self) }.reject(&:nil?).first
    end

    @data.merge!(additions)
  end

  data_rules = @expander.expand(data_rules, @data)
  data_rules.each do |k, rule_set|
    @errors[k] = []

    value_included = true
    required = rule_set.any? { |r| r.implicit?(self) }

    unless @data.key?(k)
      if required
        @errors[k] << 'This field is missing.'
      end

      next
    end

    value = coerced = @data[k]
    force_coerce = false

    rule_set.each do |rule|
      next unless rule.active?(self)

      value_included &= !rule.excluded?(self)

      if rule.passes?(k, coerced, self)
        coerced = rule.coerce(coerced)
        force_coerce = rule.force_coerce?
      else
        @errors[k] << rule.error_message(k, coerced, self)
      end
    end

    if force_coerce
      value = coerced
    end

    if @errors[k].empty? && value_included
      @validated[k] = value
      @coerced[k] = coerced
    end
  end

  @errors.reject! { |_, v| v.empty? }
end

#validate!Object



108
109
110
111
112
113
114
# File 'lib/mini_defender/validator.rb', line 108

def validate!
  validate if @errors.nil?

  unless @errors.empty?
    raise ValidationError.new('Data validation failed', @errors)
  end
end

#validatedObject



125
126
127
128
# File 'lib/mini_defender/validator.rb', line 125

def validated
  validate! if @errors.nil?
  @validated_compacted ||= compact_expanded(@validated)
end