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

use bibtex_parser::{
    DiagnosticCode, DiagnosticSeverity, DiagnosticTarget, ParseStatus, ParsedBlock, ParsedEntry,
    ParsedEntryStatus, Parser,
};

#[test]
fn parsed_document_preserves_library_relationship_and_block_order() {
    let input = r#"
@string{venue = "VLDB"}
@preamble{"preface"}
% retained comment
@article{paper,
  title = "Example Paper",
  journal = venue,
  year = 2026
}
"#;

    let document = Parser::new()
        .capture_source()
        .parse_document(input)
        .unwrap();

    assert_eq!(document.status(), ParseStatus::Ok);
    assert_eq!(document.library().entries().len(), 1);
    assert_eq!(document.entries().len(), 1);
    assert_eq!(document.strings().len(), 1);
    assert_eq!(document.preambles().len(), 1);
    assert_eq!(document.comments().len(), 1);
    assert_eq!(document.failed_blocks().len(), 0);
    assert_eq!(document.diagnostics().len(), 0);
    assert_eq!(document.sources().len(), 1);
    assert!(document.sources()[0].is_anonymous());

    assert_eq!(
        document.blocks(),
        &[
            ParsedBlock::String(0),
            ParsedBlock::Preamble(0),
            ParsedBlock::Comment(0),
            ParsedBlock::Entry(0),
        ]
    );

    let entry = &document.entries()[0];
    assert_eq!(entry.key(), "paper");
    assert_eq!(entry.status, ParsedEntryStatus::Complete);
    assert!(entry.source.is_some());
    assert!(entry.raw.is_none());
    assert_eq!(entry.fields.len(), 3);
    assert_eq!(entry.fields[0].name, "title");
    assert!(entry.fields[0].raw.is_none());
}

#[test]
fn parsed_document_exposes_failed_blocks_and_diagnostics() {
    let input = r#"
@article{, title = "Missing key"}
@book{ok, title = "Recovered"}
"#;

    let document = Parser::new()
        .tolerant()
        .capture_source()
        .parse_document(input)
        .unwrap();

    assert_eq!(document.status(), ParseStatus::Partial);
    assert_eq!(document.library().entries().len(), 1);
    assert_eq!(document.entries()[0].key(), "ok");
    assert_eq!(document.failed_blocks().len(), 1);
    assert_eq!(document.diagnostics().len(), 1);
    assert_eq!(document.failed_blocks()[0].diagnostics.len(), 1);
    assert!(document.failed_blocks()[0].raw.contains("@article{,"));
    assert_eq!(
        document.diagnostics()[0].severity,
        DiagnosticSeverity::Error
    );
    assert_eq!(
        document.diagnostics()[0].code,
        DiagnosticCode::MISSING_ENTRY_KEY
    );
    assert_eq!(
        document.diagnostics()[0].target,
        DiagnosticTarget::FailedBlock(0)
    );
    assert!(document.diagnostics()[0].source.is_some());
}

#[test]
fn parsed_entry_round_trips_to_structured_entry() {
    let input = r#"@article{paper, title = "Example Paper", year = 2026}"#;
    let document = Parser::new().parse_document(input).unwrap();

    let parsed_entry: ParsedEntry<'_> = document.entries()[0].clone();
    let structured = parsed_entry.into_entry();

    assert_eq!(structured.key(), "paper");
    assert_eq!(structured.fields().len(), 2);
    assert_eq!(structured.get("title"), Some("Example Paper"));
}