ibflex 1.3.0

/*!

 * Parser for Ledger's output of the `register` command.
 */

use std::str::FromStr;

use chrono::{NaiveDate, NaiveDateTime};
use rust_decimal::Decimal;

use crate::{flex_enums::CashAction, model::CommonTransaction, ISO_DATE_FORMAT};

/**

 * Ledger Register row.
 */
// pub struct RegisterRow {}

/**

 * Clean-up the ledger register report.
 * The report variable is a list of lines.
 */
pub fn clean_up_register_output(lines: Vec<&str>) -> Vec<String> {
    let mut new_vec = vec![];

    // eliminate useless lines
    for line in lines {
        if line.is_empty() {
            continue;
        }

        // Check the account line. If empty, skip. This is just the running total.
        if line.chars().nth(50).unwrap() == ' ' {
            continue;
        }

        new_vec.push(line.to_owned());
    }

    new_vec
}

/**

 * Parse raw lines from the ledger register output and get RegisterRow.
 */
pub fn get_rows_from_register(ledger_lines: Vec<String>) -> Vec<CommonTransaction> {
    let mut txs: Vec<CommonTransaction> = vec![];
    // remember the transaction row, with the medatada: date, symbol...
    let empty_tx = CommonTransaction::default();
    let mut prev_row = &empty_tx;

    for line in ledger_lines {
        let tx = get_row_from_register_line(&line, prev_row);

        txs.push(tx);

        prev_row = txs.last().unwrap();
    }
    txs
}

/// Parse one register line into a Transaction object
fn get_row_from_register_line(line: &str, header: &CommonTransaction) -> CommonTransaction {
    // header is the transaction with the date (and other metadata?)

    log::debug!("parsing: {:?}", line);

    if line.is_empty() {
        panic!("The lines must be prepared by `clean_up_register_output`");
    }

    let has_symbol = line.chars().nth(1).unwrap() != ' ';

    let date_str = &line[0..10].trim();
    let payee_str = &line[11..46].trim();
    let account_str = &line[46..85].trim();
    let amount_str = &line[85..107].trim();

    let mut tx = CommonTransaction::default();

    // Date
    tx.date = if date_str.is_empty() {
        header.date
    } else {
        // parse
        // log::debug!("parsing date: {:?}", date_str);

        let tx_date =
            NaiveDate::parse_from_str(date_str, ISO_DATE_FORMAT).expect("valid date expected");
        NaiveDateTime::from(tx_date.and_hms_opt(0, 0, 0).unwrap())
    };

    // Report Date
    tx.report_date = tx.date.format(ISO_DATE_FORMAT).to_string();

    // Payee
    tx.payee = if payee_str.is_empty() {
        header.payee.to_owned()
    } else {
        payee_str.to_string()
    };

    // Symbol
    tx.symbol = if has_symbol {
        let parts: Vec<&str> = payee_str.split_whitespace().collect();
        let symbol = parts[0];
        // if symbol.contains('.') {
        //     let index = symbol.find('.').unwrap();
        //     symbol = &symbol[0..index];
        // }
        symbol.to_string()
    } else {
        header.symbol.to_string()
    };

    // Type
    // Get just the first 2 characters.
    let account = &account_str[0..2];
    tx.r#type = if account == "In" {
        CashAction::Dividend.to_string()
    } else if account == "Ex" {
        CashAction::WhTax.to_string()
    } else {
        log::warn!("Could not parse type {:?}", account);

        "Error!".to_string()
    };

    // Account
    tx.account = account_str.to_string();

    // Amount
    // Get from the end.
    let parts: Vec<&str> = amount_str.split_whitespace().collect();
    if parts.len() > 2 {
        println!("cannot parse: {:?}", tx);
    }
    assert!(parts.len() == 2, "Invalid amount in ledger: {:?}", amount_str);

    let amount = parts[0].replace(",", "");
    tx.amount = Decimal::from_str(&amount).expect("a valid number");

    // Currency
    tx.currency = parts[1].to_string();

    tx
}

// tests

#[cfg(test)]
mod tests {

    use chrono::{Datelike, NaiveDate};
    use rust_decimal::Decimal;

    use crate::{
        ledger_reg_output_parser::{clean_up_register_output, get_rows_from_register},
        model::CommonTransaction,
    };

    use super::get_row_from_register_line;

    /**

     * Parse the transaction top row, with date/payee/account/amount
     * `l r --init-file tests/init.ledger`
     */
    #[test_log::test]
    fn test_parse_header_row() {
        let line = r#"2022-12-01 Supermarket                        Expenses:Food                                      15.00 EUR            15.00 EUR"#;

        let header = CommonTransaction::default();

        let actual = get_row_from_register_line(line, &header);

        log::debug!("actual: {:?}", actual);

        // Assertions

        // Date
        assert_eq!(actual.date.year(), 2022);
        // Report Date
        assert!(!actual.report_date.is_empty());
        // Payee
        assert!(!actual.payee.is_empty());
        assert_eq!(actual.payee, "Supermarket");
        // Account
        assert!(!actual.account.is_empty());
        assert_eq!(actual.account, "Expenses:Food");
        // Symbol
        //assert!(!actual.symbol.is_empty());
        // Type
        assert!(!actual.r#type.is_empty());
        // Amount
        assert!(!actual.amount.is_zero());
        assert_eq!(actual.amount, Decimal::from(15));
        // Currency
        assert!(!actual.currency.is_empty());
        assert_eq!(actual.currency, "EUR");
    }

    #[test_log::test]
    fn parse_distribution_report() {
        let ledger_output = r#"2022-12-15 TRET_AS Distribution                  Income:Investment:IB:TRET_AS                      -38.40 EUR           -38.40 EUR
                                              Expenses:Investment:IB:Withholding Tax              5.77 EUR           -32.63 EUR"#;
        let lines = ledger_output.lines().collect();
        log::debug!("lines: {:?}", lines);

        let clean_lines = clean_up_register_output(lines);
        let rows = get_rows_from_register(clean_lines);

        log::debug!("rows: {:?}", rows);

        // Assertions

        assert_eq!(2, rows.len());

        // Symbol
        assert_eq!("TRET_AS", rows[0].symbol);

        // 2nd row

        assert_eq!(Decimal::from_str_exact("5.77").unwrap(), rows[1].amount);

        // todo: assert other fields
    }

    /**

     * Parse the posting rows (not the top row).
     * `l r --init-file tests/init.ledger`
     */
    #[test_log::test]
    fn parse_posting_row_test() {
        let date = NaiveDate::from_ymd_opt(2022, 12, 1)
            .unwrap()
            .and_hms_opt(0, 0, 0)
            .unwrap();
        let header = CommonTransaction {
            date: date,
            report_date: String::default(), // The report date comes from the Flex report.
            payee: "Supermarket".to_string(),
            account: "Expenses:Food".to_string(),
            amount: Decimal::from(15),
            currency: "EUR".to_string(),
            description: String::default(),
            symbol: String::default(),
            r#type: String::default(),
        };

        let line = r#"                                              Assets:Bank:Checking                              -15.00 EUR                    0"#;

        let actual = get_row_from_register_line(line, &header);

        // Date
        assert_eq!(actual.date.year(), 2022);
        // Report Date
        assert!(!actual.report_date.is_empty());
        // Payee
        assert!(!actual.payee.is_empty());
        assert_eq!(actual.payee, "Supermarket");
        // Account
        assert!(!actual.account.is_empty());
        assert_eq!(actual.account, "Assets:Bank:Checking");
        // Type
        assert!(!actual.r#type.is_empty());
        // Amount
        assert!(!actual.amount.is_zero());
        assert_eq!(actual.amount, Decimal::from(-15));
        // Currency
        assert!(!actual.currency.is_empty());
        assert_eq!(actual.currency, "EUR");
    }
}