varar-core 0.6.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

//! Doc-string comparison — port of `doc-string-diff.ts` / `DocStringDiff.java`.

use crate::error::StepError;
use crate::span::Span;
use crate::value::Value;

/// A doc-string content difference: the fence body's span plus expected/actual.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct DocStringDiff {
    pub span: Span,
    pub expected: String,
    pub actual: String,
}

impl DocStringDiff {
    pub fn new(
        span: Span,
        expected: impl Into<String>,
        actual: impl Into<String>,
    ) -> DocStringDiff {
        DocStringDiff {
            span,
            expected: expected.into(),
            actual: actual.into(),
        }
    }
}

/// Compares a doc-string step's return against the fence body (exact equality,
/// trailing newline included). `None` → no check. A non-string return →
/// [`StepError::ReturnShape`].
pub fn compare_doc_string(
    returned: Option<&Value>,
    content: &str,
    span: Span,
) -> Result<Option<DocStringDiff>, StepError> {
    let s = match returned {
        None => return Ok(None),
        Some(Value::String(s)) => s,
        Some(other) => {
            return Err(StepError::ReturnShape(format!(
                "expected a doc string (string), got {}",
                other.type_name()
            )));
        }
    };
    if s == content {
        Ok(None)
    } else {
        Ok(Some(DocStringDiff::new(span, content, s.clone())))
    }
}