datui-lib 0.2.56

Data Exploration in the Terminal (library)
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

//! Help overlay content loaded from `help-strings/*.txt` at compile time.
//! Edit the .txt files to change help content without touching Rust code.

macro_rules! include_help {
    ($name:literal) => {
        include_str!(concat!(
            env!("CARGO_MANIFEST_DIR"),
            "/src/help-strings/",
            $name,
            ".txt"
        ))
    };
}

pub fn main_view() -> &'static str {
    include_help!("main_view")
}

pub fn query() -> &'static str {
    include_help!("query")
}

pub fn editing() -> &'static str {
    include_help!("editing")
}

pub fn sort_filter() -> &'static str {
    include_help!("sort_filter")
}

pub fn pivot_melt() -> &'static str {
    include_help!("pivot_melt")
}

pub fn export() -> &'static str {
    include_help!("export")
}

pub fn info_panel() -> &'static str {
    include_help!("info_panel")
}

pub fn chart() -> &'static str {
    include_help!("chart")
}

pub fn template() -> &'static str {
    include_help!("template")
}

pub fn analysis_distribution_detail() -> &'static str {
    include_help!("analysis_distribution_detail")
}

pub fn analysis_correlation_detail() -> &'static str {
    include_help!("analysis_correlation_detail")
}

pub fn analysis_distribution() -> &'static str {
    include_help!("analysis_distribution")
}

pub fn analysis_describe() -> &'static str {
    include_help!("analysis_describe")
}

pub fn analysis_correlation_matrix() -> &'static str {
    include_help!("analysis_correlation_matrix")
}

#[cfg(test)]
mod tests {
    use super::*;

    /// The data table has no on-screen indicator for its display toggles, so
    /// the help overlay is the only place a user can discover them. Keep both
    /// listed.
    #[test]
    fn main_view_help_documents_display_toggles() {
        let help = main_view();
        assert!(help.contains("N:"), "row numbers toggle missing from help");
        assert!(
            help.contains("F:"),
            "number formatting toggle missing from help"
        );
        assert!(
            help.contains("number formatting"),
            "the F toggle needs a description a user can search for"
        );
    }
}