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

//! A small library for pretty-printing tables in monospace text.
//!
//! Example
//!
//! ```
//! let data = [["Some", "printable"], ["data", "fields"]];
//! let mut out = Vec::new();
//! text_tables::render(&mut out, data).unwrap();
//! println!("{}", ::std::str::from_utf8(&out).unwrap());
//! ```

use std::{
    cmp,
    fmt::{Display, Write},
    io,
};

const CORNER_STR: &'static str = "+";
const HORIZ_BORDER_STR: &'static str = "-";
const VERT_BORDER_STR: &'static str = "|";
const SPACE_STR: &'static str = " ";
const NEW_LINE_STR: &'static str = "\n";

/// Render the table to a writer
///
/// Note that there are a lot of write calls, use a BufferedWriter if your writer is I/O for better
/// performance.
///
/// # Panics
///
/// Will panic if all rows are not the same length
pub fn render<W, T, R, C>(writer: &mut W, data: T) -> io::Result<()>
where
    W: io::Write,
    T: AsRef<[R]>,
    R: AsRef<[C]>,
    C: Display,
{
    let widths = widths(&data);
    let data = data.as_ref();

    render_border_line(writer, &widths)?;
    for row in data.iter() {
        let row = row.as_ref();
        render_text_line(writer, &widths, row)?;
        render_border_line(writer, &widths)?;
    }

    Ok(())
}

// Internal helpers
// ================

/// Get the largest width of each column.
fn widths<T, R, C>(data: T) -> Vec<usize>
where
    T: AsRef<[R]>,
    R: AsRef<[C]>,
    C: Display,
{
    // re-use a string to reduce memory allocs.
    let mut string_buf = String::new();
    let data = data.as_ref();
    // bail early if there is nothing to do
    if data.len() == 0 {
        return vec![];
    }
    // this would panic without len check above
    let row_len = data[0].as_ref().len();
    let mut widths = vec![0; row_len];
    for row in data.iter() {
        let row = row.as_ref();
        if row_len != row.len() {
            // todo better handle this situation
            panic!("rows must be the same length");
        }
        for (idx, cell) in row.iter().enumerate() {
            string_buf.clear();
            write!(string_buf, "{}", cell).unwrap(); // writing to a string cannot fail.
            widths[idx] = cmp::max(widths[idx], string_buf.len());
        }
    }
    widths
}

/// Render a border line
fn render_border_line<W: io::Write>(writer: &mut W, lengths: &[usize]) -> io::Result<()> {
    if lengths.len() == 0 || lengths[0] == 0 {
        return Ok(());
    }
    write!(writer, "{}", CORNER_STR)?;
    for len in lengths {
        for _ in 0..(*len + 2) {
            write!(writer, "{}", HORIZ_BORDER_STR)?;
        }
        write!(writer, "{}", CORNER_STR)?;
    }
    write!(writer, "\n")
}

/// Render a text line
fn render_text_line<W, C>(writer: &mut W, lengths: &[usize], row: &[C]) -> io::Result<()>
where
    W: io::Write,
    C: Display,
{
    if lengths.len() == 0 || lengths[0] == 0 {
        return Ok(());
    }
    let mut string_buf = String::new();
    write!(writer, "{}", VERT_BORDER_STR)?;
    for (cell, len) in row.iter().zip(lengths.iter()) {
        string_buf.clear();
        write!(string_buf, "{}", cell).unwrap(); // writing to string cannot fail.
        let extra = len - string_buf.len();
        write!(writer, "{}{}", SPACE_STR, string_buf)?;
        for _ in 0..extra + 1 {
            write!(writer, "{}", SPACE_STR)?;
        }
        write!(writer, "{}", VERT_BORDER_STR)?;
    }
    write!(writer, "{}", NEW_LINE_STR)?;

    Ok(())
}

#[cfg(test)]
mod tests {

    #[test]
    fn render() {
        let tables = vec![
            (vec![], &b""[..]),
            (vec![vec![]], &b""[..]),
            (
                vec![vec!["single", "line", "a"], vec!["second", "lines", "a"]],
                &b"\
+--------+-------+---+
| single | line  | a |
+--------+-------+---+
| second | lines | a |
+--------+-------+---+
"[..],
            ),
        ];
        for (table, result) in tables {
            let mut out = Vec::new();
            super::render(&mut out, &table).unwrap();
            assert_eq!(out, &result[..], "{:#?}", table);
        }
    }
}