]> git.scottworley.com Git - tablify/blame - src/lib.rs
Render column headers
[tablify] / src / lib.rs
CommitLineData
397ef957 1use std::collections::{HashMap, HashSet};
9dfa98b7 2use std::io::BufRead;
75bb888a
SW
3use std::iter::Iterator;
4
cc2378d5
SW
5const HEADER: &str = "<!DOCTYPE html>
6<html>
7<head>
8 <meta charset=\"utf-8\">
9 <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">
10 <style>
11 /* h/t https://wabain.github.io/2019/10/13/css-rotated-table-header.html */
12 th, td { white-space: nowrap; }
13 th { text-align: left; font-weight: normal; }
14 table { border-collapse: collapse }
15 tr.key > th { height: 8em; vertical-align: bottom; line-height: 1 }
16 tr.key > th > div { width: 1em; }
17 tr.key > th > div > div { width: 5em; transform-origin: bottom left; transform: translateX(1em) rotate(-65deg) }
18 td { border: thin solid gray; }
19 td.numeric { text-align: right; }
20 td.yes { border: thin solid gray; background-color: gray; }
21 td.spacer { border: none; }
22 /* h/t https://stackoverflow.com/questions/5687035/css-bolding-some-text-without-changing-its-containers-size/46452396#46452396 */
23 .highlight { text-shadow: -0.06ex 0 black, 0.06ex 0 black; }
24 img { height: 1.2em; }
25 </style>
26 <script>
27 function highlight(id) { const e = document.getElementById(id); if (e) { e.classList.add( \"highlight\"); } }
28 function clear_highlight(id) { const e = document.getElementById(id); if (e) { e.classList.remove(\"highlight\"); } }
29 function h2(a, b) { highlight(a); highlight(b); }
30 function ch2(a, b) { clear_highlight(a); clear_highlight(b); }
31 </script>
32</head>
33<body>
34 <table>
76638ea1
SW
35 <tbody>
36";
cc2378d5
SW
37const FOOTER: &str = " </tbody>
38 </table>
39</body>
40</html>";
41
14e9852b 42#[derive(Debug, PartialEq, Eq, Hash)]
e8657dff
SW
43struct Entry {
44 col: String,
b8907770 45 instance: Option<String>,
e8657dff
SW
46}
47impl From<&str> for Entry {
48 fn from(value: &str) -> Entry {
b8907770
SW
49 match value.split_once(':') {
50 None => Entry {
51 col: String::from(value),
52 instance: None,
53 },
54 Some((col, instance)) => Entry {
0d999bc3
SW
55 col: String::from(col.trim()),
56 instance: Some(String::from(instance.trim())),
b8907770 57 },
e8657dff
SW
58 }
59 }
60}
14e9852b 61
75bb888a
SW
62#[derive(Debug, PartialEq, Eq)]
63struct RowInput {
64 label: String,
14e9852b 65 entries: Vec<Entry>,
75bb888a
SW
66}
67
201b9ef3 68struct Reader<Input: Iterator<Item = Result<String, std::io::Error>>> {
8110b492 69 input: std::iter::Enumerate<Input>,
201b9ef3
SW
70 row: Option<RowInput>,
71}
72impl<Input: Iterator<Item = Result<String, std::io::Error>>> Reader<Input> {
201b9ef3 73 fn new(input: Input) -> Self {
8110b492
SW
74 Self {
75 input: input.enumerate(),
76 row: None,
77 }
201b9ef3
SW
78 }
79}
80impl<Input: Iterator<Item = Result<String, std::io::Error>>> Iterator for Reader<Input> {
81 type Item = Result<RowInput, std::io::Error>;
82 fn next(&mut self) -> Option<Self::Item> {
83 loop {
1f6bd845
SW
84 match self
85 .input
86 .next()
8110b492 87 .map(|(n, r)| (n, r.map(|line| String::from(line.trim_end()))))
1f6bd845 88 {
201b9ef3 89 None => return Ok(std::mem::take(&mut self.row)).transpose(),
8110b492
SW
90 Some((_, Err(e))) => return Some(Err(e)),
91 Some((_, Ok(line))) if line.is_empty() && self.row.is_some() => {
201b9ef3
SW
92 return Ok(std::mem::take(&mut self.row)).transpose()
93 }
8110b492
SW
94 Some((_, Ok(line))) if line.is_empty() => {}
95 Some((n, Ok(line))) if line.starts_with(' ') => match &mut self.row {
96 None => {
97 return Some(Err(std::io::Error::other(format!(
98 "{}: Entry with no header",
99 n + 1
100 ))))
101 }
e8657dff 102 Some(ref mut row) => row.entries.push(Entry::from(line.trim())),
201b9ef3 103 },
8110b492 104 Some((_, Ok(line))) => {
201b9ef3
SW
105 let prev = std::mem::take(&mut self.row);
106 self.row = Some(RowInput {
107 label: line,
108 entries: vec![],
109 });
110 if prev.is_some() {
111 return Ok(prev).transpose();
112 }
113 }
114 }
115 }
116 }
117}
118
201b9ef3
SW
119fn read_rows(input: impl std::io::Read) -> impl Iterator<Item = Result<RowInput, std::io::Error>> {
120 Reader::new(std::io::BufReader::new(input).lines())
75bb888a
SW
121}
122
58b5f36d
SW
123fn column_counts(rows: &[RowInput]) -> Vec<(usize, String)> {
124 let mut counts: Vec<_> = rows
125 .iter()
b8907770
SW
126 .flat_map(|r| {
127 r.entries
128 .iter()
129 .map(|e| &e.col)
130 .collect::<HashSet<_>>()
131 .into_iter()
132 })
133 .fold(HashMap::new(), |mut cs, col| {
134 cs.entry(String::from(col))
58b5f36d 135 .and_modify(|n| *n += 1)
f272e502 136 .or_insert(1);
58b5f36d 137 cs
f272e502 138 })
58b5f36d
SW
139 .into_iter()
140 .map(|(col, n)| (n, col))
141 .collect();
142 counts.sort();
143 counts
f272e502 144}
d22b2e05
SW
145fn column_order(rows: &[RowInput]) -> Vec<String> {
146 column_counts(rows)
147 .into_iter()
148 .map(|(_, col)| col)
149 .collect()
150}
f272e502 151
de408c29
SW
152fn render_instance(entry: &Entry) -> String {
153 match &entry.instance {
154 None => String::from("✓ "),
155 Some(instance) => String::from(instance) + " ",
156 }
157}
158
159fn render_cell(col: &str, row: &RowInput) -> String {
160 // TODO: Escape HTML special characters
161 let entries: Vec<&Entry> = row.entries.iter().filter(|e| e.col == col).collect();
162 let class = if entries.is_empty() { "" } else { "yes" };
163 let all_empty = entries.iter().all(|e| e.instance.is_none());
164 let contents = if entries.is_empty() || (all_empty && entries.len() == 1) {
165 String::new()
166 } else if all_empty {
167 format!("{}", entries.len())
168 } else {
169 entries
170 .iter()
171 .map(|i| render_instance(i))
172 .collect::<String>()
173 };
174 format!("<td class=\"{class}\">{}</td>", contents.trim())
175}
176
177fn render_row(columns: &[String], row: &RowInput) -> String {
178 // This is O(n^2) & doesn't need to be
179 // TODO: Escape HTML special characters
180 format!(
181 "<tr><th>{}</th>{}</tr>\n",
182 row.label,
183 &columns
184 .iter()
185 .map(|col| render_cell(col, row))
186 .collect::<String>()
187 )
188}
189
76638ea1
SW
190fn render_column_headers(columns: &[String]) -> String {
191 // TODO: Escape HTML special characters
192 String::from("<th></th>")
193 + &columns
194 .iter()
195 .map(|c| format!("<th>{c}</th>"))
196 .collect::<String>()
197 + "\n"
198}
199
4b99fb70
SW
200/// # Errors
201///
202/// Will return `Err` if
203/// * there's an i/o error while reading `input`
204/// * the log has invalid syntax:
205/// * an indented line with no preceding non-indented line
206pub fn tablify(input: impl std::io::Read) -> Result<String, std::io::Error> {
207 let rows = read_rows(input).collect::<Result<Vec<_>, _>>()?;
de408c29
SW
208 let columns = column_order(&rows);
209 Ok(String::from(HEADER)
76638ea1 210 + &render_column_headers(&columns)
de408c29
SW
211 + &rows
212 .into_iter()
213 .map(|r| render_row(&columns, &r))
214 .collect::<String>()
215 + FOOTER)
ece97615 216}
75bb888a
SW
217
218#[cfg(test)]
219mod tests {
220 use super::*;
221
b8907770
SW
222 #[test]
223 fn test_parse_entry() {
224 assert_eq!(
225 Entry::from("foo"),
226 Entry {
227 col: String::from("foo"),
228 instance: None
229 }
230 );
231 assert_eq!(
232 Entry::from("foo:bar"),
233 Entry {
234 col: String::from("foo"),
235 instance: Some(String::from("bar"))
236 }
237 );
0d999bc3
SW
238 assert_eq!(
239 Entry::from("foo: bar"),
240 Entry {
241 col: String::from("foo"),
242 instance: Some(String::from("bar"))
243 }
244 );
b8907770
SW
245 }
246
75bb888a
SW
247 #[test]
248 fn test_read_rows() {
249 assert_eq!(
201b9ef3 250 read_rows(&b"foo"[..]).flatten().collect::<Vec<_>>(),
75bb888a
SW
251 vec![RowInput {
252 label: String::from("foo"),
253 entries: vec![]
254 }]
255 );
9dfa98b7 256 assert_eq!(
201b9ef3 257 read_rows(&b"bar"[..]).flatten().collect::<Vec<_>>(),
9dfa98b7
SW
258 vec![RowInput {
259 label: String::from("bar"),
260 entries: vec![]
261 }]
262 );
2aa9ef94 263 assert_eq!(
201b9ef3 264 read_rows(&b"foo\nbar\n"[..]).flatten().collect::<Vec<_>>(),
2aa9ef94
SW
265 vec![
266 RowInput {
267 label: String::from("foo"),
268 entries: vec![]
269 },
270 RowInput {
271 label: String::from("bar"),
272 entries: vec![]
273 }
274 ]
275 );
201b9ef3
SW
276 assert_eq!(
277 read_rows(&b"foo\n bar\n"[..]).flatten().collect::<Vec<_>>(),
278 vec![RowInput {
279 label: String::from("foo"),
e8657dff 280 entries: vec![Entry::from("bar")]
201b9ef3
SW
281 }]
282 );
283 assert_eq!(
284 read_rows(&b"foo\n bar\n baz\n"[..])
285 .flatten()
286 .collect::<Vec<_>>(),
287 vec![RowInput {
288 label: String::from("foo"),
e8657dff 289 entries: vec![Entry::from("bar"), Entry::from("baz")]
201b9ef3
SW
290 }]
291 );
292 assert_eq!(
293 read_rows(&b"foo\n\nbar\n"[..])
294 .flatten()
295 .collect::<Vec<_>>(),
296 vec![
297 RowInput {
298 label: String::from("foo"),
299 entries: vec![]
300 },
301 RowInput {
302 label: String::from("bar"),
303 entries: vec![]
304 }
305 ]
306 );
1f6bd845
SW
307 assert_eq!(
308 read_rows(&b"foo\n \nbar\n"[..])
309 .flatten()
310 .collect::<Vec<_>>(),
311 vec![
312 RowInput {
313 label: String::from("foo"),
314 entries: vec![]
315 },
316 RowInput {
317 label: String::from("bar"),
318 entries: vec![]
319 }
320 ]
321 );
322 assert_eq!(
323 read_rows(&b"foo \n bar \n"[..])
324 .flatten()
325 .collect::<Vec<_>>(),
326 vec![RowInput {
327 label: String::from("foo"),
e8657dff 328 entries: vec![Entry::from("bar")]
1f6bd845
SW
329 }]
330 );
201b9ef3
SW
331
332 let bad = read_rows(&b" foo"[..]).next().unwrap();
333 assert!(bad.is_err());
8110b492 334 assert!(format!("{bad:?}").contains("1: Entry with no header"));
201b9ef3
SW
335
336 let bad2 = read_rows(&b"foo\n\n bar"[..]).nth(1).unwrap();
337 assert!(bad2.is_err());
8110b492 338 assert!(format!("{bad2:?}").contains("3: Entry with no header"));
75bb888a 339 }
f272e502
SW
340
341 #[test]
342 fn test_column_counts() {
343 assert_eq!(
344 column_counts(
345 &read_rows(&b"foo\n bar\n baz\n"[..])
346 .collect::<Result<Vec<_>, _>>()
347 .unwrap()
348 ),
58b5f36d 349 vec![(1, String::from("bar")), (1, String::from("baz"))]
f272e502
SW
350 );
351 assert_eq!(
352 column_counts(
353 &read_rows(&b"foo\n bar\n baz\nquux\n baz"[..])
354 .collect::<Result<Vec<_>, _>>()
355 .unwrap()
356 ),
58b5f36d 357 vec![(1, String::from("bar")), (2, String::from("baz"))]
f272e502 358 );
397ef957
SW
359 assert_eq!(
360 column_counts(
361 &read_rows(&b"foo\n bar\n bar\n baz\n bar\nquux\n baz"[..])
362 .collect::<Result<Vec<_>, _>>()
363 .unwrap()
364 ),
58b5f36d 365 vec![(1, String::from("bar")), (2, String::from("baz"))]
397ef957 366 );
b8907770
SW
367 assert_eq!(
368 column_counts(
369 &read_rows(&b"foo\n bar: 1\n bar: 2\n baz\n bar\nquux\n baz"[..])
370 .collect::<Result<Vec<_>, _>>()
371 .unwrap()
372 ),
373 vec![(1, String::from("bar")), (2, String::from("baz"))]
374 );
f272e502 375 }
de408c29
SW
376
377 #[test]
378 fn test_render_cell() {
379 assert_eq!(
380 render_cell(
381 "foo",
382 &RowInput {
383 label: String::from("nope"),
384 entries: vec![]
385 }
386 ),
387 String::from("<td class=\"\"></td>")
388 );
389 assert_eq!(
390 render_cell(
391 "foo",
392 &RowInput {
393 label: String::from("nope"),
394 entries: vec![Entry::from("bar")]
395 }
396 ),
397 String::from("<td class=\"\"></td>")
398 );
399 assert_eq!(
400 render_cell(
401 "foo",
402 &RowInput {
403 label: String::from("nope"),
404 entries: vec![Entry::from("foo")]
405 }
406 ),
407 String::from("<td class=\"yes\"></td>")
408 );
409 assert_eq!(
410 render_cell(
411 "foo",
412 &RowInput {
413 label: String::from("nope"),
414 entries: vec![Entry::from("foo"), Entry::from("foo")]
415 }
416 ),
417 String::from("<td class=\"yes\">2</td>")
418 );
419 assert_eq!(
420 render_cell(
421 "foo",
422 &RowInput {
423 label: String::from("nope"),
424 entries: vec![Entry::from("foo: 5"), Entry::from("foo: 10")]
425 }
426 ),
427 String::from("<td class=\"yes\">5 10</td>")
428 );
429 assert_eq!(
430 render_cell(
431 "foo",
432 &RowInput {
433 label: String::from("nope"),
434 entries: vec![Entry::from("foo: 5"), Entry::from("foo")]
435 }
436 ),
437 String::from("<td class=\"yes\">5 ✓</td>")
438 );
439 }
75bb888a 440}