noyalib 0.0.18

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

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

//! `Document::set_inline_comment` / `remove_inline_comment` — first-class
//! mutation of the trailing `#` comment on a single-line node.
//!
//! Each test parses a document, edits the inline comment, and checks the
//! byte-exact result. The typed value must never change; refusals leave
//! the document untouched.

#![allow(missing_docs)]

use noyalib::cst::parse_document;

// ── set: happy paths ────────────────────────────────────────────────

#[test]
fn set_adds_comment_when_none() {
    let mut doc = parse_document("port: 8080\n").unwrap();
    doc.set_inline_comment("port", "the listen port").unwrap();
    assert_eq!(doc.source(), "port: 8080  # the listen port\n");
}

#[test]
fn set_replaces_existing_comment_keeping_spacing() {
    let mut doc = parse_document("port: 8080  # old\n").unwrap();
    doc.set_inline_comment("port", "new").unwrap();
    assert_eq!(doc.source(), "port: 8080  # new\n");
}

#[test]
fn set_replaces_single_space_separated_comment() {
    let mut doc = parse_document("port: 8080 # old\n").unwrap();
    doc.set_inline_comment("port", "new").unwrap();
    // The existing single-space separation is preserved.
    assert_eq!(doc.source(), "port: 8080 # new\n");
}

#[test]
fn set_empty_text_writes_bare_hash() {
    let mut doc = parse_document("port: 8080\n").unwrap();
    doc.set_inline_comment("port", "").unwrap();
    assert_eq!(doc.source(), "port: 8080  #\n");
}

#[test]
fn set_on_nested_key() {
    let mut doc = parse_document("server:\n  host: localhost\n").unwrap();
    doc.set_inline_comment("server.host", "loopback").unwrap();
    assert_eq!(doc.source(), "server:\n  host: localhost  # loopback\n");
}

#[test]
fn set_on_a_sequence_item() {
    let mut doc = parse_document("- a\n- b\n").unwrap();
    doc.set_inline_comment("[1]", "second").unwrap();
    assert_eq!(doc.source(), "- a\n- b  # second\n");
}

#[test]
fn set_leaves_siblings_and_value_untouched() {
    let mut doc = parse_document("a: 1\nb: 2  # keep\nc: 3\n").unwrap();
    doc.set_inline_comment("a", "added").unwrap();
    assert_eq!(doc.source(), "a: 1  # added\nb: 2  # keep\nc: 3\n");
}

// ── set: refusals ───────────────────────────────────────────────────

#[test]
fn set_rejects_multiline_node() {
    let src = "server:\n  host: localhost\n  port: 8080\n";
    let mut doc = parse_document(src).unwrap();
    assert!(doc.set_inline_comment("server", "nope").is_err());
    assert_eq!(doc.source(), src);
}

#[test]
fn set_rejects_newline_in_text() {
    let src = "port: 8080\n";
    let mut doc = parse_document(src).unwrap();
    assert!(doc.set_inline_comment("port", "line1\nline2").is_err());
    assert_eq!(doc.source(), src);
}

#[test]
fn set_rejects_missing_path() {
    let src = "port: 8080\n";
    let mut doc = parse_document(src).unwrap();
    assert!(doc.set_inline_comment("nope", "x").is_err());
    assert_eq!(doc.source(), src);
}

// ── remove ──────────────────────────────────────────────────────────

#[test]
fn remove_existing_comment() {
    let mut doc = parse_document("port: 8080  # noise\n").unwrap();
    doc.remove_inline_comment("port").unwrap();
    assert_eq!(doc.source(), "port: 8080\n");
}

#[test]
fn remove_when_none_is_noop() {
    let src = "port: 8080\n";
    let mut doc = parse_document(src).unwrap();
    doc.remove_inline_comment("port").unwrap();
    assert_eq!(doc.source(), src);
}

#[test]
fn remove_missing_path_is_noop() {
    let src = "port: 8080\n";
    let mut doc = parse_document(src).unwrap();
    doc.remove_inline_comment("nope").unwrap();
    assert_eq!(doc.source(), src);
}

#[test]
fn remove_keeps_leading_comment() {
    let mut doc = parse_document("# above\nport: 8080  # inline\n").unwrap();
    doc.remove_inline_comment("port").unwrap();
    assert_eq!(doc.source(), "# above\nport: 8080\n");
}

// ── round-trip via comments_at + typed value ────────────────────────

#[test]
fn set_then_read_back_via_comments_at() {
    let mut doc = parse_document("port: 8080\n").unwrap();
    doc.set_inline_comment("port", "hello").unwrap();
    assert_eq!(doc.comments_at("port").inline.unwrap().text, " hello");
}

#[test]
fn value_is_unchanged_by_comment_edits() {
    use noyalib::Value;
    use noyalib::from_str;

    let before: Value = from_str("a: 1\nb: 2\n").unwrap();
    let mut doc = parse_document("a: 1\nb: 2\n").unwrap();
    doc.set_inline_comment("a", "x").unwrap();
    doc.remove_inline_comment("a").unwrap();
    let after: Value = from_str(doc.source()).unwrap();
    assert_eq!(before, after);
}