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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
use crate::assertion::assertion;
use crate::close::close;
#[cfg(all(test, feature = "unstable"))]
use crate::commodity::Commodity;
use crate::include::{include, Include};
use crate::open::open;
use crate::pad::{pad, Pad};
#[cfg(all(test, feature = "unstable"))]
use crate::pest_parser::{Pair, Rule};
use crate::price::{price, Price};
use crate::{Assertion, Close, Date, Open};
use nom::branch::alt;
use nom::{combinator::map, IResult};

use crate::transaction::{transaction, Transaction};

/// A directive
///
/// A beancount file is made of directives.
///
/// By far the the most common directive is the [`Transaction`].
#[derive(Debug, Clone)]
#[non_exhaustive]
pub enum Directive<'a> {
    /// The [`Transaction`](crate::Transaction) directive
    Transaction(Transaction<'a>),
    /// The [`Price`](crate::Price) directive
    Price(Price<'a>),
    /// The [`Open`](crate::Open) account directive
    Open(Open<'a>),
    /// The [`Close`](crate::Close) account directive
    Close(Close<'a>),
    /// The [`Assertion`](crate::Assertion) (`balance`) account directive
    Assertion(Assertion<'a>),
    /// The [`Include`](crate::Include) directive
    Include(Include),
    /// The [`Pad`](crate::Pad) directive
    Pad(Pad<'a>),
    /// The [`Commodity`](crate::Commodity) directive
    #[cfg(all(test, feature = "unstable"))]
    Commodity(Commodity<'a>),
    /// The [`Option`](crate::Option) directive
    #[cfg(all(test, feature = "unstable"))]
    Option(crate::Option<'a>),
}

impl<'a> Directive<'a> {
    /// Returns the [`Transaction`] reference if this directive is a transaction
    ///
    /// See also [`Directive::into_transaction`]
    #[must_use]
    pub fn as_transaction(&self) -> Option<&Transaction<'a>> {
        match self {
            Directive::Transaction(trx) => Some(trx),
            _ => None,
        }
    }

    /// Convert into a [`Transaction`] if this directive is a transaction
    ///
    /// See also [`Directive::as_transaction`]
    #[must_use]
    pub fn into_transaction(self) -> Option<Transaction<'a>> {
        match self {
            Directive::Transaction(trx) => Some(trx),
            _ => None,
        }
    }

    /// Returns the date of the directive (if there is one)
    #[must_use]
    pub fn date(&self) -> Option<Date> {
        match self {
            Directive::Transaction(t) => Some(t.date()),
            Directive::Open(o) => Some(o.date()),
            Directive::Close(c) => Some(c.date()),
            Directive::Price(p) => Some(p.date()),
            Directive::Assertion(a) => Some(a.date()),
            Directive::Include(_) => None,
            Directive::Pad(p) => Some(p.date()),
            #[cfg(all(test, feature = "unstable"))]
            Directive::Commodity(_) => None,
            #[cfg(all(test, feature = "unstable"))]
            Directive::Option(_) => None,
        }
    }

    #[cfg(all(test, feature = "unstable"))]
    pub(crate) fn from_pair(pair: Pair<'a>) -> Self {
        match pair.as_rule() {
            Rule::transaction => Directive::Transaction(Transaction::from_pair(pair)),
            Rule::balance => Directive::Assertion(Assertion::from_pair(pair)),
            Rule::open => Directive::Open(Open::from_pair(pair)),
            Rule::close => Directive::Close(Close::from_pair(pair)),
            Rule::commodity => Directive::Commodity(Commodity::from_pair(pair)),
            Rule::option => Directive::Option(crate::Option::from_pair(pair)),
            rule => panic!("unexpected directive rule {rule:?}"),
        }
    }
}

pub(crate) fn directive(input: &str) -> IResult<&str, Directive<'_>> {
    alt((
        map(transaction, Directive::Transaction),
        map(price, Directive::Price),
        map(open, Directive::Open),
        map(close, Directive::Close),
        map(assertion, Directive::Assertion),
        map(pad, Directive::Pad),
        map(include, Directive::Include),
    ))(input)
}

#[cfg(test)]
mod tests {
    use nom::combinator::all_consuming;

    use crate::account;

    use super::*;

    #[test]
    fn transaction() {
        let input = r#"2022-09-10 txn "My transaction""#;
        let transaction = directive(input).unwrap().1.into_transaction().unwrap();
        assert_eq!(transaction.narration(), Some("My transaction"));
    }

    #[test]
    fn price() {
        let result = directive("2014-07-09 price CHF  5 PLN");
        let Ok((_, Directive::Price(price))) = result else {
            panic!("Expected a price directive but was: {result:?}")
        };
        assert_eq!(price.commodity(), "CHF");
        assert_eq!(price.price().currency(), "PLN");
    }

    #[test]
    fn simple_open_directive() {
        let result = directive("2014-05-01 open Liabilities:CreditCard:CapitalOne");
        let Ok((_, Directive::Open(directive))) = result else {
          panic!("Expected an open directive but was: {result:?}")
        };
        assert_eq!(directive.account().type_(), account::Type::Liabilities);
    }

    #[test]
    fn include_directive() {
        let (_, directive) = all_consuming(directive)(r#"include "myfile.beancount""#).unwrap();
        assert_eq!(directive.date(), None);
        let Directive::Include(include) = directive else {
            panic!("Expected an include directive but was: {directive:?}")
        };
        assert_eq!(include.path().to_str(), Some("myfile.beancount"));
    }

    #[test]
    fn pad_directive() {
        let (_, directive) =
            all_consuming(directive)("2022-02-11 pad Assets:Cash Equity:OpeningBalances").unwrap();
        assert_eq!(directive.date(), Some(Date::new(2022, 2, 11)));
        let Directive::Pad(pad) = directive else {
            panic!("Expected an include directive but was: {directive:?}")
        };
        assert_eq!(pad.target_account().components(), ["Cash"]);
        assert_eq!(pad.source_account().components(), ["OpeningBalances"]);
    }

    #[rstest]
    fn invalid(
        #[values(
            "2022-09-11 txn that is incorrect",
            "2022-09-11 * that is incorrect",
            "2022-09-11 ! that is incorrect"
        )]
        input: &str,
    ) {
        assert!(matches!(directive(input), Err(nom::Err::Failure(_))));
    }

    #[rstest]
    fn not_matching(#[values(" ")] input: &str) {
        assert!(matches!(directive(input), Err(nom::Err::Error(_))));
    }

    #[rstest]
    #[case("2022-11-06 txn", Date::new(2022, 11, 6))]
    #[case("2021-02-26 open Liabilities:Debt", Date::new(2021, 2, 26))]
    #[case("2021-02-26 close Liabilities:Debt", Date::new(2021, 2, 26))]
    #[case("2014-07-09 price HOOL  600 USD", Date::new(2014, 7, 9))]
    fn date(#[case] input: &str, #[case] expected_date: Date) {
        let (_, directive) = directive(input).expect("should successfully parse directive");
        let date = directive.date().expect("directive should have a date");
        assert_eq!(date, expected_date);
    }
}