testing_table 0.3.0

An easy to use library for pretty print tables of Rust `struct`s and `enum`s.
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

/// Build a static table.
///
/// # Example
///
/// ```text
/// static_table!(
///     "|--|--|"
///     "|XX|XY|"
///     "|--|--|"
/// )
/// ```
#[macro_export]
macro_rules! static_table {
    ($($line:expr)*) => {
        concat!(
            $($line, "\n",)*
        )
        .trim_end_matches('\n')
    };
}

/// Create a test for a given table.
///
/// # Example
///
/// ```text
/// test_table!(
///     test_name,
///     Table::new([[1, 2, 3], [4, 5, 6]]),
///     "|--|--|"
///     "|XX|XY|"
///     "|--|--|"
/// )
/// ```
///
/// ```text
/// test_table!(
///     test_name,
///     Table::new([[1, 2, 3], [4, 5, 6]]), // got
///     Table::new([[1, 2, 3], [4, 5, 6]]), // expected
/// )
/// ```
#[macro_export]
macro_rules! test_table {
    ($test:ident, $table:expr, $($line:expr)*) => {
        #[test]
        fn $test() {
            $crate::assert_table!($table, $($line)*);
        }
    };
    ($test:ident, $table:expr, $expected:expr,) => {
        #[test]
        fn $test() {
            let table = $table.to_string();
            let expected = $expected.to_string();
            assert_eq!(
                table,
                expected,
                "\ngot:\n{}\nexpected:\n{}",
                table,
                expected,
            );
        }
    };
}

/// Assert a given table.
///
/// # Example
///
/// ```text
/// assert_table!(
///     Table::new([[1, 2, 3], [4, 5, 6]]),
///     "|--|--|"
///     "|XX|XY|"
///     "|--|--|"
/// )
/// ```
#[macro_export]
macro_rules! assert_table {
    ($table:expr, $($line:expr)*) => {
        let table = $table.to_string();
        let expected = $crate::static_table!($($line)*);
        assert_eq!(
            table,
            expected,
            "\ngot:\n{}\nexpected:\n{}",
            table,
            expected,
        );
    };
}

/// Assert a given table width.
///
/// # Example
///
/// ```text
/// assert_width!(Table::new([[1, 2, 3], [4, 5, 6]]), 10);
/// ```
#[macro_export]
macro_rules! assert_width {
    ($table:expr, $expected:expr) => {
        let expected = $expected;
        let table = $table.to_string();
        let width = $crate::get_text_width(&table);
        assert_eq!(width, expected);
    };
}