noyalib 0.0.39

A pure Rust YAML library with zero unsafe code and full serde integration
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
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

// SPDX-License-Identifier: MIT OR Apache-2.0
// Copyright (c) 2026 Noyalib. All rights reserved.

//! Multi-document splitting for `parse_stream`.

use noyalib::cst::{Document, parse_stream, parse_stream_with_config};
use noyalib::{Error, ParserConfig, Value, load_all_as};

fn join_sources(docs: &[Document]) -> String {
    docs.iter().map(Document::source).collect()
}

#[test]
fn single_implicit_doc() {
    let src = "foo: 1\n";
    let docs = parse_stream(src).unwrap();
    assert_eq!(docs.len(), 1);
    assert_eq!(docs[0].source(), src);
}

#[test]
fn single_explicit_doc() {
    let src = "---\nfoo: 1\n";
    let docs = parse_stream(src).unwrap();
    assert_eq!(docs.len(), 1);
    assert_eq!(docs[0].source(), src);
}

#[test]
fn two_explicit_docs_no_end_marker() {
    let src = "---\nfoo: 1\n---\nbar: 2\n";
    let docs = parse_stream(src).unwrap();
    assert_eq!(docs.len(), 2);
    assert_eq!(docs[0].source(), "---\nfoo: 1\n");
    assert_eq!(docs[1].source(), "---\nbar: 2\n");
    assert_eq!(join_sources(&docs), src);
    assert_eq!(docs[0].as_value()["foo"].as_i64(), Some(1));
    assert_eq!(docs[1].as_value()["bar"].as_i64(), Some(2));
}

#[test]
fn two_docs_with_explicit_end() {
    let src = "---\nfoo: 1\n...\n---\nbar: 2\n";
    let docs = parse_stream(src).unwrap();
    assert_eq!(docs.len(), 2);
    assert_eq!(docs[0].source(), "---\nfoo: 1\n...\n");
    assert_eq!(docs[1].source(), "---\nbar: 2\n");
    assert_eq!(join_sources(&docs), src);
}

#[test]
fn bare_then_explicit() {
    let src = "foo: 1\n---\nbar: 2\n";
    let docs = parse_stream(src).unwrap();
    assert_eq!(docs.len(), 2);
    assert_eq!(docs[0].source(), "foo: 1\n");
    assert_eq!(docs[1].source(), "---\nbar: 2\n");
    assert_eq!(join_sources(&docs), src);
}

#[test]
fn explicit_then_bare_via_end_marker() {
    let src = "---\nfoo: 1\n...\nbar: 2\n";
    let docs = parse_stream(src).unwrap();
    assert_eq!(docs.len(), 2);
    assert_eq!(docs[0].source(), "---\nfoo: 1\n...\n");
    assert_eq!(docs[1].source(), "bar: 2\n");
    assert_eq!(join_sources(&docs), src);
}

#[test]
fn three_docs() {
    let src = "---\na: 1\n---\nb: 2\n---\nc: 3\n";
    let docs = parse_stream(src).unwrap();
    assert_eq!(docs.len(), 3);
    assert_eq!(join_sources(&docs), src);
    assert_eq!(docs[0].as_value()["a"].as_i64(), Some(1));
    assert_eq!(docs[1].as_value()["b"].as_i64(), Some(2));
    assert_eq!(docs[2].as_value()["c"].as_i64(), Some(3));
}

#[test]
fn comment_between_docs_attaches_to_next() {
    let src = "---\nfoo: 1\n# between\n---\nbar: 2\n";
    let docs = parse_stream(src).unwrap();
    assert_eq!(docs.len(), 2);
    // Comment is *before* the second `---`, so it stays with doc 0.
    assert_eq!(docs[0].source(), "---\nfoo: 1\n# between\n");
    assert_eq!(docs[1].source(), "---\nbar: 2\n");
    assert_eq!(join_sources(&docs), src);
}

#[test]
fn comment_after_end_marker_attaches_to_next() {
    let src = "---\nfoo: 1\n...\n# trailer\n---\nbar: 2\n";
    let docs = parse_stream(src).unwrap();
    assert_eq!(docs.len(), 2);
    // After `...`, trivia goes into the next document's prologue.
    assert_eq!(docs[0].source(), "---\nfoo: 1\n...\n");
    assert_eq!(docs[1].source(), "# trailer\n---\nbar: 2\n");
    assert_eq!(join_sources(&docs), src);
}

#[test]
fn each_doc_independently_editable() {
    let src = "---\nversion: 0.1.0\n---\nversion: 0.2.0\n";
    let mut docs = parse_stream(src).unwrap();
    docs[0].set("version", "0.1.1").unwrap();
    docs[1].set("version", "0.2.1").unwrap();
    assert_eq!(docs[0].source(), "---\nversion: 0.1.1\n");
    assert_eq!(docs[1].source(), "---\nversion: 0.2.1\n");
}

// Error locations count from the start of the stream (#407).

#[test]
fn error_in_a_later_document_is_located_in_the_stream() {
    let src = "a: 1\n---\nb: 2\n---\nc: *nope\n";
    let err = parse_stream(src).unwrap_err();
    let loc = err.location().expect("located");
    assert_eq!((loc.index(), loc.line(), loc.column()), (21, 5, 4));
    assert!(src[loc.index()..].starts_with("*nope"));
    // The typed loader reports the same position for the same bytes.
    let typed = load_all_as::<Value>(src).unwrap_err();
    assert_eq!(typed.location(), Some(loc));
    // Both CST entry points agree.
    let cfg = ParserConfig::new();
    let with_config = parse_stream_with_config(src, &cfg).unwrap_err();
    assert_eq!(with_config.location(), Some(loc));
    assert_eq!(err.to_string(), "unknown anchor: nope at line 5, column 4");
}

#[test]
fn error_in_the_first_document_is_unchanged() {
    let src = "a: *nope\n---\nb: 1\n";
    let loc = parse_stream(src).unwrap_err().location().expect("located");
    assert_eq!((loc.index(), loc.line(), loc.column()), (3, 1, 4));
}

#[test]
fn key_collision_in_a_later_document_is_located_in_the_stream() {
    let src = "a: 1\n---\nb: 2\n---\n1: x\n\"1\": y\n";
    let err = parse_stream(src).unwrap_err();
    assert!(matches!(err, Error::KeyCollisionAt { .. }), "{err:?}");
    let loc = err.location().expect("located");
    assert_eq!((loc.index(), loc.line(), loc.column()), (23, 6, 1));
    let typed = load_all_as::<Value>(src).unwrap_err();
    assert_eq!(typed.location(), Some(loc));
}

#[test]
fn similar_anchor_suggestion_is_located_in_the_stream() {
    let src = "a: 1\n---\nb: &nope 1\nc: *nop\n";
    let err = parse_stream(src).unwrap_err();
    let Error::UnknownAnchorAt {
        location,
        suggestion,
        ..
    } = err
    else {
        panic!("{err:?}");
    };
    assert_eq!((location.line(), location.column()), (4, 4));
    let (name, at) = suggestion.expect("a similar anchor is suggested");
    assert_eq!(name, "nope");
    assert_eq!((at.index(), at.line(), at.column()), (12, 3, 4));
    assert!(src[at.index()..].starts_with("&nope"));
}

#[test]
fn rendered_error_shows_the_failing_line_of_the_stream() {
    let src = "a: 1\n---\nb: 2\n---\nc: *nope\n";
    let rendered = parse_stream(src).unwrap_err().render(src);
    assert!(rendered.contains("5 | c: *nope"), "{rendered}");
}

#[test]
fn directive_after_an_unclosed_document_is_located_in_the_stream() {
    // YAML 1.2.2 ยง9.1.4: a directive needs the previous document
    // closed by `...`. The scanner rejects the stream before any
    // document is parsed; the error still carries the directive's
    // position, the same one the typed loader reports.
    let src = "a: 1\n%YAML 1.2\n---\nb: 2\n";
    let err = parse_stream(src).unwrap_err();
    let loc = err.location().expect("located");
    assert_eq!((loc.index(), loc.line(), loc.column()), (5, 2, 1));
    assert!(src[loc.index()..].starts_with("%YAML"));
    let typed = load_all_as::<Value>(src).unwrap_err();
    assert_eq!(typed.location(), Some(loc));
    assert!(
        err.to_string()
            .contains("directive must be preceded by '...'"),
        "{err}"
    );
}

#[test]
fn a_document_end_marker_that_closes_nothing_is_not_a_document() {
    // The suite's HWV9: a stream that is only `...` has no documents.
    // parse_stream keeps its one-document-minimum for empty input, but
    // a leading `...` must not add a document the typed loaders do not
    // see; it becomes the prologue of the document that follows.
    for (src, docs) in [
        ("...\nfoo\n", 1),
        ("...\n---\na: 1\n", 1),
        ("# c\n...\nfoo\n", 1),
        ("a: 1\n...\n...\nb: 2\n", 2),
        ("a: 1\n...\n...\n", 1),
        ("---\n...\n", 1),
    ] {
        let parsed = parse_stream(src).unwrap_or_else(|e| panic!("{src:?}: {e}"));
        assert_eq!(parsed.len(), docs, "{src:?}");
        assert_eq!(parsed.iter().map(Document::source).collect::<String>(), src);
        assert_eq!(
            load_all_as::<Value>(src).unwrap().len(),
            docs,
            "typed {src:?}"
        );
    }
}