bean-rs 0.3.1

beancount clone in 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

use std::cmp::Ordering;

use log::debug;
use pest::iterators::Pairs;
use pest::Parser;

use crate::data::{self, DebugLine};
use crate::data::{Directive, Options};
use crate::error::{BeanError, ErrorType};
use crate::grammar::{BeanParser, Rule};
use crate::ledger::Ledger;
use crate::utils;

/// Parse the text using Pest
pub fn load(data: &str) -> Pairs<'_, Rule> {
    // The grammer has a badline option which will consume any nonsense
    // So in theory this shouldn't error!
    let mut entries = BeanParser::parse(Rule::root, data).unwrap();

    // There will always be at least an `EOI`, so this will also never error
    let entry = entries.next().unwrap();
    utils::debug_pair(&entry, 0);
    entry.into_inner()
}

/// Convert the AST Pest Pairs into a Vec of Directives
pub fn consume(entries: Pairs<'_, Rule>) -> Ledger {
    let mut errs: Vec<BeanError> = Vec::with_capacity(entries.len());
    let mut dirs: Vec<Directive> = Vec::new();
    let mut opts = Options::default();
    for entry in entries {
        debug!("{:?}\t{:?}", entry.as_rule(), entry.as_span(),);
        match entry.as_rule() {
            Rule::option => {
                opts.update_from_entry(entry);
            }
            Rule::custom => {
                dirs.push(Directive::ConfigCustom(data::ConfigCustom::from_entry(
                    entry,
                )));
            }
            Rule::query => {
                dirs.push(Directive::Query(data::Query::from_entry(entry)));
            }
            Rule::commodity => {
                dirs.push(Directive::Commodity(data::Commodity::from_entry(entry)));
            }
            Rule::open => {
                dirs.push(Directive::Open(data::Open::from_entry(entry)));
            }
            Rule::close => {
                dirs.push(Directive::Close(data::Close::from_entry(entry)));
            }
            Rule::balance => {
                dirs.push(Directive::Balance(data::Balance::from_entry(entry)));
            }
            Rule::pad => {
                dirs.push(Directive::Pad(data::Pad::from_entry(entry)));
            }
            Rule::price => {
                dirs.push(Directive::Price(data::Price::from_entry(entry)));
            }
            Rule::document => {
                dirs.push(Directive::Document(data::Document::from_entry(entry)));
            }
            Rule::note => {
                dirs.push(Directive::Note(data::Note::from_entry(entry)));
            }
            Rule::transaction => {
                dirs.push(Directive::Transaction(data::Transaction::from_entry(entry)));
            }
            Rule::EOI => {
                debug!("Hit EOI");
            }
            Rule::badline => {
                let (line, _) = entry.line_col();
                let debug = DebugLine::new(line);
                let err =
                    BeanError::new(ErrorType::Badline, &debug, "Found unparseable line", None);
                errs.push(err);
            }
            _ => {
                let (l, _) = entry.line_col();
                let debug = DebugLine::new(l);
                unreachable!("Found unexpected entry in file, abort.\n{debug}");
            }
        };
    }
    Ledger { dirs, errs, opts }
}

/// Sort the Directives by date and `order` inplace
pub fn sort(dirs: &mut [Directive]) {
    dirs.sort_by(|a, b| match a.date().cmp(b.date()) {
        Ordering::Equal => a.order().cmp(&b.order()),
        other => other,
    });
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_parse() {
        let text = r#"2023-01-01 open Assets:Bank GBP"#;
        let entries = load(&text);
        let Ledger {
            dirs,
            errs: _,
            opts: _,
        } = consume(entries);
        let got = &dirs[0];
        match got {
            Directive::Open(_) => (),
            _ => assert!(false, "Found wrong directive type"),
        }
    }

    #[test]
    fn test_bad_consume() {
        let text = r#"
            2023-01-01 foo
        "#;
        let entries = load(&text);
        let Ledger {
            dirs: _,
            errs,
            opts: _,
        } = consume(entries);
        assert!(errs.len() == 1);
    }

    #[test]
    fn test_consume() {
        let text = r#"
            option "operating_currency" "GBP"
        "#;
        let entries = load(&text);
        consume(entries);
    }
}