markdown-table 0.2.0

Creating markdown tables with Rust!
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
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
154
155
156
157
158
159
160

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

use anyhow::{bail, Result};

use pad::{Alignment, PadStr};

#[derive(Debug, Clone)]
pub enum HeadingAlignment {
    Left,
    Center,
    Right,
    Default,
}

impl HeadingAlignment {
    fn to_padded_string(&self, length: usize) -> String {
        match self {
            HeadingAlignment::Default => "---".pad(length, '-', Alignment::Left, false),
            HeadingAlignment::Left => ":--".pad(length, '-', Alignment::Left, false),
            HeadingAlignment::Center => {
                format!("{}:", ":-".pad(length - 1, '-', Alignment::Left, false))
            }
            HeadingAlignment::Right => "--:".pad(length, '-', Alignment::Right, false),
        }
    }
}

#[derive(Debug, Clone)]
pub struct Heading {
    label: String,
    alignment: HeadingAlignment,
}

impl Heading {
    pub fn new(label: String, alignment: Option<HeadingAlignment>) -> Self {
        Self {
            label,
            alignment: alignment.unwrap_or(HeadingAlignment::Default),
        }
    }
}

#[derive(Debug, Clone)]
pub struct MarkdownTable<T>
where
    T: ToString + Display,
{
    headings: Option<Vec<Heading>>,
    cells: Vec<Vec<T>>,
}

impl<T> MarkdownTable<T>
where
    T: ToString + Display,
{
    pub fn new(cells: Vec<Vec<T>>) -> Self {
        Self {
            cells,
            headings: None,
        }
    }

    pub fn with_headings(&mut self, headings: Vec<Heading>) -> &Self {
        self.headings = Some(headings);
        self
    }

    pub fn as_markdown(&self) -> Result<String> {
        match &self.headings {
            Some(headings) => {
                let mut col_width: Vec<usize> = headings
                    .iter()
                    .map(|h| cmp::max(5, h.label.len()))
                    .collect();

                for row in &self.cells {
                    for (col_index, value) in row.iter().enumerate() {
                        // TODO using tostring,  may be not good as mutliline string will break it
                        let value_len = value.to_string().len();
                        if value_len > col_width[col_index] {
                            col_width[col_index] = value_len;
                        }
                    }
                }
                let header_row = format!(
                    "|{}|",
                    headings
                        .iter()
                        .enumerate()
                        .map(|(i, h)| format!(" {} ", h.label).pad_to_width(col_width[i]))
                        .collect::<Vec<String>>()
                        .join("|")
                );
                let header_split_row = format!(
                    "|{}|",
                    headings
                        .iter()
                        .enumerate()
                        .map(|(i, h)| format!(
                            " {} ",
                            h.alignment.to_padded_string(col_width[i] - 2)
                        ))
                        .collect::<Vec<String>>()
                        .join("|")
                );
                let cells_row = self
                    .cells
                    .iter()
                    .map(|v| {
                        format!(
                            "|{}|",
                            v.iter()
                                .enumerate()
                                .map(|(i, v_inner)| format!(" {} ", v_inner)
                                    .pad_to_width(col_width[i]))
                                .collect::<Vec<String>>()
                                .join("|")
                        )
                    })
                    .collect::<Vec<String>>()
                    .join("\n");
                Ok(format!(
                    "{}\n{}\n{}\n",
                    header_row, header_split_row, cells_row
                ))
            }
            None => {
                if !self.cells.is_empty() {
                    Ok(format!(
                        "<table>{}</table>",
                        self.cells
                            .iter()
                            .map(|v| {
                                format!(
                                    "<tr>{}",
                                    v.iter()
                                        .map(|v_inner| format!("<td>{}", v_inner))
                                        .collect::<Vec<String>>()
                                        .join("")
                                )
                            })
                            .collect::<Vec<String>>()
                            .join(""),
                    ))
                } else {
                    bail!("Table must have at least 1 row.".to_string())
                }
            }
        }
    }
}

impl<T> ToString for MarkdownTable<T>
where
    T: ToString + Display,
{
    fn to_string(&self) -> String {
        self.as_markdown().unwrap()
    }
}