Module: Varar::Core::Execute

Defined in:
lib/varar/core/execute.rb

Overview

Execute an ExecutionPlan: route stimulus/sensor returns, replace immutable state, compare sensor returns via the diff helpers, invert expected failures. Handlers are user callbacks (sync). Port of execute.ts.

Class Method Summary collapse

Class Method Details

.augment_stack(error, _step, _var_path) ⇒ Object

In TS this injects a synthetic at <text> (path:line:col) frame for editor navigation; the conformance trace derives the anchor separately via failure_anchor, so here it is a no-op that returns the error.



186
187
188
 
# File 'lib/varar/core/execute.rb', line 186

def augment_stack(error, _step, _var_path)
  error
end

.build_run(plan, ex, example_index, create_ctx, observer, var_path) ⇒ Object 



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
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
 
# File 'lib/varar/core/execute.rb', line 56

def build_run(plan, ex, example_index, create_ctx, observer, var_path)
  lambda do
    state_by_file = {}
    last_return = nil
    thrown = nil

    ex.steps.each_with_index do |step, i|
      file = step.step_def.expression_source_file
      state_by_file[file] = DeepFreeze.deep_freeze(create_ctx.call(file)) unless state_by_file.key?(file)
      state = state_by_file[file]

      extra = []
      if step.data_table
        extra << ([step.data_table.header.cells] + step.data_table.rows.map(&:cells))
      elsif step.doc_string
        extra << step.doc_string.content
      end

      begin
        returned = step.step_def.handler.call(state, *step.args, *extra)
        last_return = returned
        case step.step_def.kind
        when 'stimulus'
          # Full replacement: the returned Hash IS the next state (deep-frozen).
          # There is no merge — a return with fewer keys shrinks the state.
          # nil is a no-op; any other type is a contract violation.
          unless returned.nil?
            unless returned.is_a?(Hash)
              raise ReturnShapeError,
                    'a stimulus must return the complete next state, ' \
                    'or nothing to leave it unchanged'
            end

            state = DeepFreeze.deep_freeze(returned)
            state_by_file[file] = state
          end
        when 'sensor'
          compare_sensor_return(plan, ex, step, returned, extra) if ex.row_checks.nil? && !returned.nil?
        else
          raise ReturnShapeError, "unknown step kind: #{step.step_def.kind}"
        end
      rescue StandardError => e
        augmented = augment_stack(e, step, var_path)
        observer&.call(observation(ex, example_index, i + 1, file, 'fail', augmented))
        thrown = augmented
        break
      end

      observer&.call(observation(ex, example_index, i + 1, file, 'pass'))
    end

    # Header-bound row checks (after all steps).
    if thrown.nil? && ex.row_checks && !ex.row_checks.empty?
      bad = CellDiffs.compare_row(last_return, ex.row_checks).reject(&:ok)
      unless bad.empty?
        last_step = ex.steps.last
        augmented = augment_stack(CellMismatchError.new(bad), last_step, var_path)
        observer&.call(observation(ex, example_index, ex.steps.length,
                                   last_step.step_def.expression_source_file, 'fail', augmented))
        thrown = augmented
      end
    end

    # Expected-failure inversion.
    if ex.expected_outcome == 'fail'
      if thrown.nil?
        error = UnexpectedPassError.new
        last = ex.steps.last
        raise(last ? augment_stack(error, last, var_path) : error)
      end
      raise thrown if ex.expected_error_message && !thrown.message.include?(ex.expected_error_message)

      return # satisfied expected-failure → pass
    end

    raise thrown if thrown
  end
end

.collect_examples(plan, create_context:, observer: nil, reporter: nil) ⇒ Object

Collect all examples into an ordered Array of QueuedExamples.



36
37
38
39
40
41
 
# File 'lib/varar/core/execute.rb', line 36

def collect_examples(plan, create_context:, observer: nil, reporter: nil)
  queue = []
  sink = ->(name, run, _info) { queue << QueuedExample.new(name: name, run: run) }
  execute_plan(plan, sink: sink, create_context: create_context, observer: observer, reporter: reporter)
  queue
end

.compare_sensor_return(plan, _ex, step, returned, extra) ⇒ Object

Sensor slot contract: zero slots + a return is a mistake; one slot IS the return; two+ is a positional array. Raises the appropriate diff error.

Raises:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/varar/core/execute.rb', line 137

def compare_sensor_return(plan, _ex, step, returned, extra)
  slot_count = step.args.length + extra.length
  if slot_count.zero?
    raise ReturnShapeError, 'this sensor has no parameters, data table or doc string — ' \
                            'nothing to compare a return value against (raise to fail, return nothing to pass)'
  end

  if slot_count == 1
    slots = [returned]
  else
    unless returned.is_a?(Array)
      raise ReturnShapeError,
            "a sensor with #{slot_count} parameters must return a list of " \
            "#{slot_count} values, got #{returned.class}"
    end
    unless returned.length == slot_count
      raise ReturnShapeError,
            "sensor return must have #{slot_count} element(s), got #{returned.length}"
    end

    slots = returned
  end

  inline_returned = slots[0...step.args.length]
  source_texts = step.param_spans.map do |s|
    Offsets.utf16_slice(plan.var_doc.source, s.start_offset, s.end_offset)
  end
  param_diffs = ParamDiff.compare_params(inline_returned, step.args, step.param_spans, source_texts,
                                         step.formats).reject(&:ok)
  raise CellMismatchError, param_diffs unless param_diffs.empty?

  if step.data_table
    bad = CellDiffs.compare_table(slots[step.args.length], step.data_table).reject(&:ok)
    raise CellMismatchError, bad unless bad.empty?
  elsif step.doc_string
    diff = DocStringDiffs.compare_doc_string(slots[step.args.length], step.doc_string.content,
                                             step.doc_string.span)
    raise DocStringMismatchError, diff unless diff.nil?
  end
end

.execute_plan(plan, sink:, create_context:, observer: nil, reporter: nil) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/varar/core/execute.rb', line 43

def execute_plan(plan, sink:, create_context:, observer: nil, reporter: nil)
  plan.diagnostics.each { |d| reporter.call(d) } if reporter
  create_ctx = create_context || ->(_file) { {} }
  var_path = plan.var_doc.path

  plan.examples.each_with_index do |ex, example_index|
    seen_lines = {}
    ex.steps.each { |s| seen_lines[s.match_span.start_line] = true }
    info = { lines: seen_lines.keys }
    sink.call(ex.name, build_run(plan, ex, example_index, create_ctx, observer, var_path), info)
  end
end

.observation(ex, example_index, ordinal, file, outcome, error = nil) ⇒ Object 



178
179
180
181
 
# File 'lib/varar/core/execute.rb', line 178

def observation(ex, example_index, ordinal, file, outcome, error = nil)
  StepObservation.new(example_name: ex.name, example_index: example_index, ordinal: ordinal,
                      step_file: file, outcome: outcome, error: error)
end