links-notation 0.25.0

Rust implementation of the Links Notation parser
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

use links_notation::{
    binary::{format_document, format_reference, BinaryLinoCodec},
    decode_reference_literal, encode_reference_literal, format_links, format_links_with_config,
    parse_lino_to_links, LiNo, StreamParser,
};

fn fixtures() -> Vec<String> {
    include_str!("../../../docs/protocol/reference-literals.txt")
        .lines()
        .filter(|line| !line.starts_with('#'))
        .map(|line| {
            if line == "-" {
                String::new()
            } else {
                String::from_utf8(
                    (0..line.len())
                        .step_by(2)
                        .map(|i| u8::from_str_radix(&line[i..i + 2], 16).unwrap())
                        .collect(),
                )
                .unwrap()
            }
        })
        .collect()
}

#[test]
fn native_reference_fidelity() {
    for reference in fixtures() {
        let original = vec![LiNo::Link {
            id: Some(reference.clone()),
            values: vec![
                LiNo::Ref(reference.clone()),
                LiNo::Link {
                    id: Some("nested".into()),
                    values: vec![LiNo::Ref(reference)],
                },
            ],
        }];
        assert_eq!(
            parse_lino_to_links(&format_links(&original)).unwrap(),
            original
        );
        for config in [
            links_notation::format_config::FormatConfig::builder()
                .less_parentheses(true)
                .build(),
            links_notation::format_config::FormatConfig::builder()
                .max_inline_refs(Some(1))
                .prefer_inline(false)
                .build(),
        ] {
            assert_eq!(
                parse_lino_to_links(&format_links_with_config(&original, &config)).unwrap(),
                original
            );
        }
    }
}

#[test]
fn reference_literals_at_every_chunk_split() {
    for reference in fixtures() {
        assert_eq!(
            decode_reference_literal(&encode_reference_literal(&reference)).unwrap(),
            reference
        );
        for literal in [
            format_reference(&reference),
            encode_reference_literal(&reference),
        ] {
            let text = format!("(root: {})\n({}: fixture)", literal, literal);
            let expected = vec![
                LiNo::Link {
                    id: Some("root".into()),
                    values: vec![LiNo::Ref(reference.clone())],
                },
                LiNo::Link {
                    id: Some(reference.clone()),
                    values: vec![LiNo::Ref("fixture".into())],
                },
            ];
            assert_eq!(parse_lino_to_links(&text).unwrap(), expected);
            for split in (0..=text.len()).filter(|&i| text.is_char_boundary(i)) {
                let mut stream = StreamParser::new();
                stream.write(&text[..split]).unwrap();
                stream.write(&text[split..]).unwrap();
                assert_eq!(stream.finish().unwrap(), expected);
            }
        }
    }
}

#[test]
fn binary_reference_fidelity() {
    let codec = BinaryLinoCodec::default();
    for reference in fixtures() {
        let original = vec![LiNo::Link {
            id: Some(reference.clone()),
            values: vec![LiNo::Ref(reference)],
        }];
        let decoded = codec.decode(&codec.encode(&original).unwrap()).unwrap();
        assert_eq!(decoded, original);
        assert_eq!(
            parse_lino_to_links(&format_document(&decoded)).unwrap(),
            original
        );
    }
}

#[test]
fn malformed_reference_literals_are_rejected() {
    for literal in include_str!("../../../docs/protocol/invalid-reference-literals.txt")
        .lines()
        .filter(|line| !line.starts_with('#'))
    {
        assert!(decode_reference_literal(literal).is_err(), "{literal}");
        assert!(parse_lino_to_links(literal).is_err(), "{literal}");
    }
    assert_eq!(decode_reference_literal("~1{C3A9}").unwrap(), "é");
}