ibflex 1.3.0

A library and a CLI for reading Interactive Brokers Flex reports and comparing to Ledger-cli transactions
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

/*!

 * Read the required Flex Query report file(s).
 * The logic for choosing a file.
 */

const FILE_SUFFIX: &str = "_cash-tx.xml";

/**

 * Loads the Flex report.
 * If the direct path to the report is given, then the report is loaded. This
 * parameter takes precedence over path.
 * If the path to the directory is given, the latest report from that directory
 * will be loaded.
 */
pub fn load_report(flex_report_path: Option<String>, flex_reports_dir: Option<String>) -> String {
    log::debug!("load_report with: {:?}, {:?}", flex_report_path, flex_reports_dir);

    let report_path = match flex_report_path {
        Some(file_path) => file_path.to_owned(),
        None => get_latest_report_path(flex_reports_dir),
    };

    println!("Using {}", report_path);

    std::fs::read_to_string(report_path).expect("xml file read")
}

/**

 * Gets the path to the latest report file in the given directory or the 
 * current directory, if None received.
 */
pub fn get_latest_report_path(report_dir: Option<String>) -> String {
    // Load the latest report file.
    let mut pattern = format!("*{}", FILE_SUFFIX);

    if let Some(dir_path) = report_dir {
        pattern = dir_path + pattern.as_str();
    }

    get_latest_filename(&pattern)
}

/// Get the latest of the filest matching the given pattern.
/// Pattern example: *.xml
fn get_latest_filename(file_pattern: &str) -> String {
    log::debug!("file pattern: {:?}", file_pattern);

    let mut filenames: Vec<String> = glob::glob(file_pattern)
        .expect("directory list")
        .filter_map(|entry| {
            let path_buf = entry.unwrap();
            if path_buf.is_file() {
                let val = path_buf.to_str().unwrap().to_string();
                Some(val)
            } else {
                None
            }
        })
        .collect();

    if filenames.is_empty() {
        panic!("Aborting. No XML files found for pattern {}.", file_pattern);
    }

    filenames.sort();

    let result = filenames.last().unwrap().to_owned();

    result
}


#[cfg(test)]
mod tests {
    use std::path::MAIN_SEPARATOR;

    use crate::{flex_query::FlexQueryResponse, flex_reader::load_report, 
        test_fixtures::*, compare::CompareParams};

    use super::get_latest_filename;

    #[test_log::test]
    fn test_dir_list() {
        let actual = get_latest_filename("tests/*.xml");

        assert!(!actual.is_empty());
        //let path = canonicalize("tests/report_1.xml").unwrap();
        //let expected = path.as_os_str().to_str().unwrap();
        let mut expected = "tests".to_string();
        expected.push(MAIN_SEPARATOR);
        // expected.push_str("report_1.xml");
        // expected.push_str("tax_adj_report.xml");
        expected.push_str("tcf.xml");
        assert_eq!(expected, actual);
    }

    #[rstest::rstest]
    fn test_parse_file(cmp_params: CompareParams) -> anyhow::Result<()> {
        let report = load_report(cmp_params.flex_report_path, cmp_params.flex_reports_dir);
        let actual = FlexQueryResponse::from(report);

        assert_ne!(
            0,
            actual
                .flex_statements
                .flex_statement
                .cash_transactions
                .cash_transaction
                .len()
        );

        Ok(())
    }
}