varar-core 0.8.1

Markdown-native BDD — pure functional core engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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

//! Parameter comparison — port of `param-diff.ts` / `ParamDiff.java`. Compares a
//! sensor's returned inline actuals against the values captured from the document.

use crate::cell_diff::CellDiff;
use crate::registry::FormatFn;
use crate::span::Span;
use crate::value::Value;

/// Compares `returned` against `expected` with no display formatters.
pub fn compare_params(
    returned: &[Value],
    expected: &[Value],
    param_spans: &[Span],
    source_texts: &[String],
) -> Vec<CellDiff> {
    compare_params_with_formats(returned, expected, param_spans, source_texts, None)
}

/// Compares `returned` against `expected` (the captured args), one [`CellDiff`]
/// per parameter. `source_texts` supplies each diff's `expected` display;
/// `formats` (aligned 1:1, `None` entries where a type has none) renders display
/// strings only, never the verdict (which is structural [`Value`] equality).
pub fn compare_params_with_formats(
    returned: &[Value],
    expected: &[Value],
    param_spans: &[Span],
    source_texts: &[String],
    formats: Option<&[Option<FormatFn>]>,
) -> Vec<CellDiff> {
    let mut diffs = Vec::with_capacity(expected.len());
    for i in 0..expected.len() {
        // Structural equality is the verdict (`Objects.equals` parity).
        let ok = returned[i] == expected[i];
        let format = formats.and_then(|f| f.get(i)).and_then(|opt| opt.as_ref());
        let expected_text = if i < source_texts.len() {
            source_texts[i].clone()
        } else {
            render_param_value(&expected[i], format).0
        };
        let (actual_text, via_format) = render_param_value(&returned[i], format);
        diffs.push(CellDiff {
            column: format!("cell {}", i + 1),
            span: param_spans[i],
            expected: expected_text,
            actual: actual_text,
            ok,
            expected_value: Some(expected[i].clone()),
            actual_value: Some(returned[i].clone()),
            formatted: via_format,
        });
    }
    diffs
}

/// Renders one side of a parameter diff: the type's `format` when it has one
/// (and it produces a value), else the shared string/primitive chain.
fn render_param_value(value: &Value, format: Option<&FormatFn>) -> (String, bool) {
    if let Some(f) = format {
        if let Some(rendered) = f(value) {
            return (rendered, true);
        }
    }
    (crate::cell_diff::render_cell_value(value), false)
}