meta-language 0.40.0

A self-describing links-network core for lossless language representation
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
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use crate::{LinkNetwork, ParseConfiguration};

use super::{LinkRule, LinkRuleRegistry};

/// Expected outcome for a rule snapshot case.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum LinkRuleSnapshotExpectation {
    /// The rule must match the source.
    Valid,
    /// The rule must not match the source.
    Invalid,
}

/// One valid/invalid source case for a rule suite.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct LinkRuleSnapshotCase {
    name: String,
    source: String,
    language: String,
    expectation: LinkRuleSnapshotExpectation,
}

impl LinkRuleSnapshotCase {
    /// Creates a snapshot case.
    #[must_use]
    pub fn new(
        name: impl Into<String>,
        source: impl Into<String>,
        language: impl Into<String>,
        expectation: LinkRuleSnapshotExpectation,
    ) -> Self {
        Self {
            name: name.into(),
            source: source.into(),
            language: language.into(),
            expectation,
        }
    }
}

/// Valid/invalid rule snapshot suite.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct LinkRuleSnapshotSuite {
    rule: LinkRule,
    cases: Vec<LinkRuleSnapshotCase>,
}

impl LinkRuleSnapshotSuite {
    /// Creates a snapshot suite for `rule`.
    #[must_use]
    pub const fn new(rule: LinkRule) -> Self {
        Self {
            rule,
            cases: Vec::new(),
        }
    }

    /// Adds a case.
    #[must_use]
    pub fn with_case(mut self, case: LinkRuleSnapshotCase) -> Self {
        self.cases.push(case);
        self
    }

    /// Runs all cases against freshly parsed sources.
    #[must_use]
    pub fn run(
        &self,
        registry: &LinkRuleRegistry,
        configuration: ParseConfiguration,
    ) -> LinkRuleSnapshotReport {
        let cases = self
            .cases
            .iter()
            .map(|case| {
                let network = LinkNetwork::parse(&case.source, &case.language, configuration);
                let matches = self.rule.matches(&network, registry);
                let has_match = !matches.is_empty();
                let passed = match case.expectation {
                    LinkRuleSnapshotExpectation::Valid => has_match,
                    LinkRuleSnapshotExpectation::Invalid => !has_match,
                };
                LinkRuleSnapshotResult {
                    name: case.name.clone(),
                    expectation: case.expectation,
                    matched: has_match,
                    match_count: matches.len(),
                    passed,
                }
            })
            .collect();
        LinkRuleSnapshotReport { cases }
    }
}

/// Snapshot suite result.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct LinkRuleSnapshotReport {
    cases: Vec<LinkRuleSnapshotResult>,
}

impl LinkRuleSnapshotReport {
    /// Returns whether every case passed.
    #[must_use]
    pub fn is_success(&self) -> bool {
        self.cases.iter().all(|case| case.passed)
    }

    /// Per-case results.
    #[must_use]
    pub fn cases(&self) -> &[LinkRuleSnapshotResult] {
        &self.cases
    }
}

/// One snapshot case result.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct LinkRuleSnapshotResult {
    name: String,
    expectation: LinkRuleSnapshotExpectation,
    matched: bool,
    match_count: usize,
    passed: bool,
}

impl LinkRuleSnapshotResult {
    /// Case name.
    #[must_use]
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Expected rule outcome.
    #[must_use]
    pub const fn expectation(&self) -> LinkRuleSnapshotExpectation {
        self.expectation
    }

    /// Whether the rule matched the parsed source.
    #[must_use]
    pub const fn matched(&self) -> bool {
        self.matched
    }

    /// Number of matches.
    #[must_use]
    pub const fn match_count(&self) -> usize {
        self.match_count
    }

    /// Whether this case passed.
    #[must_use]
    pub const fn passed(&self) -> bool {
        self.passed
    }
}