bibtex-parser 0.3.1

BibTeX parser for Rust
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

use bibtex_parser::{ExpansionOptions, Library, Parser, UnresolvedVariablePolicy, Value};
use std::borrow::Cow;

#[test]
fn parsed_document_exposes_raw_parsed_and_requested_expanded_views() {
    let input = r#"
@string{venue = "VLDB"}
@article{paper,
  title = venue # " 2026",
  month = jan,
  note = missing
}
"#;

    let document = Parser::new().preserve_raw().parse_document(input).unwrap();
    let entry = &document.entries()[0];
    let title = &entry.fields[0].value;
    let month = &entry.fields[1].value;
    let note = &entry.fields[2].value;

    assert_eq!(title.raw_text(), Some(r#"venue # " 2026""#));
    assert!(matches!(title.parsed(), Value::Concat(_)));
    assert_eq!(title.expanded_text(), None);
    assert_eq!(
        document
            .expand_value(title.parsed(), ExpansionOptions::default())
            .unwrap(),
        "VLDB 2026"
    );
    assert_eq!(
        document
            .expand_value(month.parsed(), ExpansionOptions::default())
            .unwrap(),
        "January"
    );

    let preserve = ExpansionOptions {
        unresolved_variables: UnresolvedVariablePolicy::Preserve,
        ..ExpansionOptions::default()
    };
    assert_eq!(
        document.expand_value(note.parsed(), preserve).unwrap(),
        "missing"
    );

    let placeholder = ExpansionOptions {
        unresolved_variables: UnresolvedVariablePolicy::Placeholder,
        ..ExpansionOptions::default()
    };
    assert_eq!(
        document.expand_value(note.parsed(), placeholder).unwrap(),
        "{undefined:missing}"
    );
    assert!(document
        .expand_value(note.parsed(), ExpansionOptions::default())
        .is_err());
}

#[test]
fn parser_can_populate_expanded_values_on_request() {
    let input = r#"
@string{venue = "VLDB"}
@article{paper, title = venue # " 2026", month = jan}
"#;

    let document = Parser::new()
        .preserve_raw()
        .expand_values()
        .parse_document(input)
        .unwrap();
    let entry = &document.entries()[0];

    assert_eq!(entry.fields[0].value.expanded_text(), Some("VLDB 2026"));
    assert_eq!(entry.fields[1].value.expanded_text(), Some("January"));
    assert_eq!(entry.fields[0].value.raw_text(), Some(r#"venue # " 2026""#));
}

#[test]
fn public_value_text_projections_cover_core_value_shapes() {
    let literal = Value::Literal(Cow::Borrowed("A Title"));
    let number = Value::Number(2026);
    let variable = Value::Variable(Cow::Borrowed("venue"));
    let concat = Value::Concat(
        vec![
            Value::Variable(Cow::Borrowed("venue")),
            Value::Literal(Cow::Borrowed(" 2026")),
        ]
        .into_boxed_slice(),
    );

    assert_eq!(literal.to_plain_string(), "A Title");
    assert_eq!(number.to_plain_string(), "2026");
    assert_eq!(variable.to_plain_string(), "venue");
    assert_eq!(variable.to_lossy_string(), "{venue}");
    assert_eq!(concat.to_plain_string(), "venue 2026");
    assert_eq!(Value::from_plain_string("plain").as_str(), Some("plain"));
    assert_eq!(concat.to_bibtex_source(), "venue # { 2026}");
}

#[test]
fn semantic_value_projection_deindents_wrapped_lines_without_touching_raw_text() {
    let input = r#"
@article{paper,
  title = {First line
                  Second line
                  Third line}
}
"#;

    let document = Parser::new().preserve_raw().parse_document(input).unwrap();
    let title = &document.entries()[0].fields[0].value;

    assert_eq!(
        title.raw_text(),
        Some("{First line\n                  Second line\n                  Third line}")
    );
    assert_eq!(title.plain_text(), "First line\nSecond line\nThird line");
    assert_eq!(
        title.parsed().to_lossy_string(),
        "First line\nSecond line\nThird line"
    );
}

#[test]
fn library_expansion_defaults_remain_behavior_preserving() {
    let library = Library::parse(
        r#"
@string{venue = "VLDB"}
@article{paper, title = venue, month = jan}
"#,
    )
    .unwrap();
    let entry = &library.entries()[0];

    assert_eq!(entry.get_as_string("title"), Some("VLDB".to_string()));
    assert_eq!(entry.get_as_string("month"), Some("January".to_string()));
}

#[cfg(feature = "latex_to_unicode")]
#[test]
fn value_text_can_be_latex_to_unicode_normalized() {
    let value = Value::Literal(Cow::Borrowed(r#"Jos\'e"#));
    assert_eq!(value.to_unicode_plain_string(), "José");
}