Module: Enolib::Errors::Validation

Defined in:
lib/enolib/errors/validation.rb

Class Method Summary collapse

Class Method Details

.comment_error(context, message, element) ⇒ Object 



6
7
8
9
10
11
12
 
# File 'lib/enolib/errors/validation.rb', line 6

def self.comment_error(context, message, element)
  ValidationError.new(
    context.messages.comment_error(message),
    context.reporter.new(context).report_comments(element).snippet,
    Selections.select_comments(element)
  )
end

.element_error(context, message, element) ⇒ Object 



14
15
16
17
18
19
20
 
# File 'lib/enolib/errors/validation.rb', line 14

def self.element_error(context, message, element)
  ValidationError.new(
    message,
    context.reporter.new(context).report_element(element).snippet,
    Selections.select_element(element)
  )
end

.key_error(context, message, element) ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/enolib/errors/validation.rb', line 22

def self.key_error(context, message, element)
  ValidationError.new(
    context.messages.key_error(message),
    context.reporter.new(context).report_line(element).snippet,
    Selections.select_key(element)
  )
end

.missing_comment(context, element) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/enolib/errors/validation.rb', line 30

def self.missing_comment(context, element)
  ValidationError.new(
    context.messages::MISSING_COMMENT,
    context.reporter.new(context).report_line(element).snippet, # TODO: Question-tag an empty line before an element with missing comment
    Selections.selection(element, :line, RANGE_BEGIN)
  )
end

.missing_element(context, key, parent, message) ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/enolib/errors/validation.rb', line 38

def self.missing_element(context, key, parent, message)
  ValidationError.new(
    key ? context.messages.send(message + '_with_key', key) : context.messages.const_get(message.upcase), # TODO: Solve the upcase rather through a different generated message type, e.g. method instead of constant
    context.reporter.new(context).report_missing_element(parent).snippet,
    parent[:type] == :document ? Selections::DOCUMENT_BEGIN : Selections.selection(parent, :line, RANGE_END)
  )
end

.missing_value(context, element) ⇒ Object 



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
 
# File 'lib/enolib/errors/validation.rb', line 46

def self.missing_value(context, element)
  selection = {}

  if element[:type] == :field ||
     element[:type] == :empty_element ||
     element[:type] == :multiline_field_begin
    message = context.messages.missing_field_value(element[:key])

    selection[:from] =
      if element[:ranges].has_key?(:template)
        Selections.cursor(element, :template, RANGE_END)
      elsif element[:ranges].has_key?(:element_operator)
        Selections.cursor(element, :element_operator, RANGE_END)
      else
        Selections.cursor(element, :line, RANGE_END)
      end
  elsif element[:type] == :fieldset_entry
    message = context.messages.missing_fieldset_entry_value(element[:key])
    selection[:from] = Selections.cursor(element, :entry_operator, RANGE_END)
  elsif element[:type] == :list_item
    message = context.messages.missing_list_item_value(element[:parent][:key])
    selection[:from] = Selections.cursor(element, :item_operator, RANGE_END)
  end

  snippet = context.reporter.new(context).report_element(element).snippet

  selection[:to] =
    if element[:type] == :field && element.has_key?(:continuations)
      Selections.cursor(element[:continuations].last, :line, RANGE_END)
    else
      Selections.cursor(element, :line, RANGE_END)
    end

  ValidationError.new(message, snippet, selection)
end

.unexpected_element(context, message, element) ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/enolib/errors/validation.rb', line 82

def self.unexpected_element(context, message, element)
  ValidationError.new(
    message || context.messages::UNEXPECTED_ELEMENT,
    context.reporter.new(context).report_element(element).snippet,
    Selections.select_element(element)
  )
end

.unexpected_element_type(context, key, section, message) ⇒ Object 



98
99
100
101
102
103
104
 
# File 'lib/enolib/errors/validation.rb', line 98

def self.unexpected_element_type(context, key, section, message)
  ValidationError.new(
    key ? context.messages.send(message + '_with_key', key) : context.messages.const_get(message.upcase), # TODO: Solve the upcase rather through a different generated message type, e.g. method instead of constant
    context.reporter.new(context).report_element(section).snippet,
    Selections.select_element(section)
  )
end

.unexpected_multiple_elements(context, key, elements, message) ⇒ Object 



90
91
92
93
94
95
96
 
# File 'lib/enolib/errors/validation.rb', line 90

def self.unexpected_multiple_elements(context, key, elements, message)
  ValidationError.new(
    key ? context.messages.send(message + '_with_key', key) : context.messages.const_get(message.upcase), # TODO: Solve the upcase rather through a different generated message type, e.g. method instead of constant
    context.reporter.new(context).report_elements(elements).snippet,
    Selections.select_element(elements[0])
  )
end

.value_error(context, message, element) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/enolib/errors/validation.rb', line 106

def self.value_error(context, message, element)
  if element.has_key?(:mirror)
    snippet = context.reporter.new(context).report_line(element).snippet
    select = select_key(element)
  elsif element[:type] == :multiline_field_begin
    if element.has_key?(:lines)
      snippet = context.reporter.new(context).report_multiline_value(element).snippet
      select = Selections.selection(element[:lines][0], :line, RANGE_BEGIN, element[:lines][-1], :line, RANGE_END)
    else
      snippet = context.reporter.new(context).report_element(element).snippet
      select = Selections.selection(element, :line, RANGE_END)
    end
  else
    snippet = context.reporter.new(context).report_element(element).snippet
    select = {
      from:
        if element[:ranges].has_key?(:value)
          Selections.cursor(element, :value, RANGE_BEGIN)
        elsif element[:ranges].has_key?(:element_operator)
          Selections.cursor(element, :element_operator, RANGE_END)
        elsif element[:ranges].has_key?(:entry_operator)
          Selections.cursor(element, :entry_operator, RANGE_END)
        elsif element[:type] == :list_item
          Selections.cursor(element, :item_operator, RANGE_END)
        else
          # TODO: Possibly never reached - think through state permutations
          Selections.cursor(element, :line, RANGE_END)
        end,
      to:
        if element.has_key?(:continuations)
          Selections.cursor(element[:continuations][-1], :line, RANGE_END)
        elsif element[:ranges].has_key?(:value)
          Selections.cursor(element, :value, RANGE_END)
        else
          Selections.cursor(element, :line, RANGE_END)
        end
    }
  end

  ValidationError.new(context.messages.value_error(message), snippet, select)
end