noyalib 0.0.1

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

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

//! Integration tests for comment capture via `load_comments`.

#![allow(clippy::unwrap_used)]

use noyalib::{load_comments, CommentKind};

#[test]
fn captures_full_line_comments() {
    let yaml = "# license header\n# author: sebs\nname: noyalib\n";
    let cs = load_comments(yaml).unwrap();
    assert_eq!(cs.len(), 2);
    assert!(cs[0].text.contains("license header"));
    assert!(cs[1].text.contains("author"));
    assert_eq!(cs[0].kind, CommentKind::Line);
    assert_eq!(cs[1].kind, CommentKind::Line);
}

#[test]
fn captures_inline_trailing() {
    let yaml = "port: 8080  # default HTTP\nhost: local  # bind\n";
    let cs = load_comments(yaml).unwrap();
    assert_eq!(cs.len(), 2);
    assert_eq!(cs[0].kind, CommentKind::Inline);
    assert_eq!(cs[1].kind, CommentKind::Inline);
    assert!(cs[0].text.contains("default"));
    assert!(cs[1].text.contains("bind"));
}

#[test]
fn spans_point_at_hash() {
    let yaml = "k: 1  # trail\n";
    let cs = load_comments(yaml).unwrap();
    assert_eq!(cs.len(), 1);
    // `#` is at byte 6.
    assert_eq!(&yaml[cs[0].start..cs[0].start + 1], "#");
    assert_eq!(cs[0].start, 6);
}

#[test]
fn end_stops_at_line_break() {
    let yaml = "# comment\nk: 1\n";
    let cs = load_comments(yaml).unwrap();
    assert_eq!(cs.len(), 1);
    // `# comment` is 9 bytes, no trailing newline in the range.
    assert_eq!(cs[0].end, 9);
    assert_eq!(&yaml[cs[0].start..cs[0].end], "# comment");
}

#[test]
fn empty_input_returns_no_comments() {
    let cs = load_comments("").unwrap();
    assert!(cs.is_empty());
}

#[test]
fn document_without_comments_returns_empty() {
    let cs = load_comments("a: 1\nb: 2\n").unwrap();
    assert!(cs.is_empty());
}

#[test]
fn hash_inside_quoted_string_is_not_a_comment() {
    let yaml = r#"k: "not a # comment"
"#;
    let cs = load_comments(yaml).unwrap();
    assert!(cs.is_empty());
}

#[test]
fn comments_inside_nested_mapping() {
    let yaml = "\
outer:
  # nested comment
  inner: value  # inline
";
    let cs = load_comments(yaml).unwrap();
    assert_eq!(cs.len(), 2);
    assert_eq!(cs[0].kind, CommentKind::Line);
    assert!(cs[0].text.contains("nested"));
    assert_eq!(cs[1].kind, CommentKind::Inline);
    assert!(cs[1].text.contains("inline"));
}

#[test]
fn comments_in_sequence() {
    let yaml = "\
- one    # first
- two    # second
- three  # third
";
    let cs = load_comments(yaml).unwrap();
    assert_eq!(cs.len(), 3);
    for c in &cs {
        assert_eq!(c.kind, CommentKind::Inline);
    }
}

#[test]
fn comment_crossref_with_spanned_field() {
    // The primary use case: find the comment attached to a specific
    // Spanned<T> field by byte-position proximity.
    use noyalib::Spanned;
    use serde::Deserialize;

    #[derive(Debug, Deserialize)]
    struct Cfg {
        port: Spanned<u16>,
    }

    let yaml = "port: 8080  # default HTTP\n";
    let cfg: Cfg = noyalib::from_str(yaml).unwrap();
    let cs = load_comments(yaml).unwrap();

    // Find the first comment on the same line as `port`.
    let port_line = cfg.port.start.line();
    let on_same_line = cs.iter().find(|c| {
        let line = yaml[..c.start].matches('\n').count() + 1;
        line == port_line
    });
    assert!(on_same_line.is_some());
    assert!(on_same_line.unwrap().text.contains("default"));
}

#[test]
fn parse_error_propagates() {
    // Malformed YAML (unclosed flow seq) returns an error.
    let err = load_comments("k: [unclosed").unwrap_err();
    let _ = err.to_string();
}