]> git.scottworley.com Git - tablify/blame - src/lib.rs
Remove entries as they're rendered
[tablify] / src / lib.rs
CommitLineData
88a08162
SW
1use std::borrow::ToOwned;
2use std::collections::HashMap;
7067975b 3use std::fmt::Write;
9dfa98b7 4use std::io::BufRead;
75bb888a
SW
5use std::iter::Iterator;
6
28cf4fa2
SW
7pub struct Config {}
8
cc2378d5
SW
9const HEADER: &str = "<!DOCTYPE html>
10<html>
11<head>
12 <meta charset=\"utf-8\">
13 <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">
14 <style>
b8b365ce 15 td { text-align: center; }
cc2378d5
SW
16 /* h/t https://wabain.github.io/2019/10/13/css-rotated-table-header.html */
17 th, td { white-space: nowrap; }
18 th { text-align: left; font-weight: normal; }
19 table { border-collapse: collapse }
3bc643e9 20 tr.key > th { height: 10em; vertical-align: bottom; line-height: 1 }
cc2378d5
SW
21 tr.key > th > div { width: 1em; }
22 tr.key > th > div > div { width: 5em; transform-origin: bottom left; transform: translateX(1em) rotate(-65deg) }
23 td { border: thin solid gray; }
1dda21e6 24 td.yes { border: thin solid gray; background-color: #ddd; }
cc2378d5
SW
25 /* h/t https://stackoverflow.com/questions/5687035/css-bolding-some-text-without-changing-its-containers-size/46452396#46452396 */
26 .highlight { text-shadow: -0.06ex 0 black, 0.06ex 0 black; }
cc2378d5
SW
27 </style>
28 <script>
29 function highlight(id) { const e = document.getElementById(id); if (e) { e.classList.add( \"highlight\"); } }
30 function clear_highlight(id) { const e = document.getElementById(id); if (e) { e.classList.remove(\"highlight\"); } }
31 function h2(a, b) { highlight(a); highlight(b); }
32 function ch2(a, b) { clear_highlight(a); clear_highlight(b); }
33 </script>
34</head>
35<body>
36 <table>
76638ea1
SW
37 <tbody>
38";
cc2378d5
SW
39const FOOTER: &str = " </tbody>
40 </table>
41</body>
42</html>";
43
70436f23
SW
44#[derive(PartialEq, Eq, Debug)]
45pub struct HTML(String);
46impl HTML {
47 fn escape(value: &str) -> HTML {
48 let mut escaped: String = String::new();
49 for c in value.chars() {
50 match c {
51 '>' => escaped.push_str("&gt;"),
52 '<' => escaped.push_str("&lt;"),
53 '\'' => escaped.push_str("&#39;"),
54 '"' => escaped.push_str("&quot;"),
55 '&' => escaped.push_str("&amp;"),
56 ok_c => escaped.push(ok_c),
57 }
58 }
59 HTML(escaped)
60 }
61}
62impl From<&str> for HTML {
63 fn from(value: &str) -> HTML {
64 HTML(String::from(value))
65 }
66}
67impl FromIterator<HTML> for HTML {
68 fn from_iter<T>(iter: T) -> HTML
69 where
70 T: IntoIterator<Item = HTML>,
71 {
72 HTML(iter.into_iter().map(|html| html.0).collect::<String>())
73 }
74}
75impl std::fmt::Display for HTML {
76 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
77 write!(f, "{}", self.0)
78 }
79}
80
88a08162
SW
81#[derive(Debug, PartialEq, Eq)]
82enum InputLine<'a> {
83 Blank,
84 RowHeader(&'a str),
85 Entry(&'a str, Option<&'a str>),
e8657dff 86}
88a08162
SW
87impl<'a> From<&'a str> for InputLine<'a> {
88 fn from(value: &'a str) -> InputLine<'a> {
89 let trimmed = value.trim_end();
90 if trimmed.is_empty() {
91 InputLine::Blank
92 } else if !trimmed.starts_with(' ') {
93 InputLine::RowHeader(value.trim())
94 } else {
95 match value.split_once(':') {
96 None => InputLine::Entry(value.trim(), None),
97 Some((col, instance)) => InputLine::Entry(col.trim(), Some(instance.trim())),
98 }
e8657dff
SW
99 }
100 }
101}
14e9852b 102
75bb888a 103#[derive(Debug, PartialEq, Eq)]
88a08162
SW
104struct Row {
105 label: String,
106 entries: HashMap<String, Vec<Option<String>>>,
75bb888a
SW
107}
108
88a08162 109struct Reader<Input: Iterator<Item = Result<String, std::io::Error>>> {
8110b492 110 input: std::iter::Enumerate<Input>,
88a08162 111 row: Option<Row>,
201b9ef3 112}
88a08162 113impl<Input: Iterator<Item = Result<String, std::io::Error>>> Reader<Input> {
201b9ef3 114 fn new(input: Input) -> Self {
8110b492
SW
115 Self {
116 input: input.enumerate(),
117 row: None,
118 }
201b9ef3
SW
119 }
120}
88a08162
SW
121impl<Input: Iterator<Item = Result<String, std::io::Error>>> Iterator for Reader<Input> {
122 type Item = Result<Row, std::io::Error>;
201b9ef3
SW
123 fn next(&mut self) -> Option<Self::Item> {
124 loop {
8bf0d5b1 125 match self.input.next() {
201b9ef3 126 None => return Ok(std::mem::take(&mut self.row)).transpose(),
8110b492 127 Some((_, Err(e))) => return Some(Err(e)),
88a08162
SW
128 Some((n, Ok(line))) => match InputLine::from(line.as_ref()) {
129 InputLine::Blank if self.row.is_some() => {
130 return Ok(std::mem::take(&mut self.row)).transpose()
8110b492 131 }
88a08162
SW
132 InputLine::Blank => {}
133 InputLine::Entry(col, instance) => match &mut self.row {
134 None => {
135 return Some(Err(std::io::Error::other(format!(
136 "{}: Entry with no header",
137 n + 1
138 ))))
139 }
140 Some(ref mut row) => {
141 row.entries
142 .entry(col.to_owned())
143 .and_modify(|is| is.push(instance.map(ToOwned::to_owned)))
144 .or_insert_with(|| vec![instance.map(ToOwned::to_owned)]);
145 }
146 },
147 InputLine::RowHeader(row) => {
148 let prev = std::mem::take(&mut self.row);
149 self.row = Some(Row {
150 label: row.to_owned(),
151 entries: HashMap::new(),
152 });
153 if prev.is_some() {
154 return Ok(prev).transpose();
155 }
201b9ef3 156 }
88a08162 157 },
201b9ef3
SW
158 }
159 }
160 }
161}
162
88a08162 163fn read_rows(input: impl std::io::Read) -> impl Iterator<Item = Result<Row, std::io::Error>> {
201b9ef3 164 Reader::new(std::io::BufReader::new(input).lines())
75bb888a
SW
165}
166
88a08162 167fn column_counts(rows: &[Row]) -> Vec<(usize, String)> {
58b5f36d
SW
168 let mut counts: Vec<_> = rows
169 .iter()
88a08162 170 .flat_map(|r| r.entries.keys())
b8907770 171 .fold(HashMap::new(), |mut cs, col| {
88a08162 172 cs.entry(col.to_owned())
58b5f36d 173 .and_modify(|n| *n += 1)
f272e502 174 .or_insert(1);
58b5f36d 175 cs
f272e502 176 })
58b5f36d
SW
177 .into_iter()
178 .map(|(col, n)| (n, col))
179 .collect();
38d1167a 180 counts.sort_unstable_by(|(an, acol), (bn, bcol)| bn.cmp(an).then(acol.cmp(bcol)));
58b5f36d 181 counts
f272e502 182}
88a08162 183fn column_order(rows: &[Row]) -> Vec<String> {
d22b2e05
SW
184 column_counts(rows)
185 .into_iter()
186 .map(|(_, col)| col)
187 .collect()
188}
f272e502 189
88a08162
SW
190fn render_instance(instance: &Option<String>) -> HTML {
191 match instance {
70436f23
SW
192 None => HTML::from("✓"),
193 Some(instance) => HTML::escape(instance.as_ref()),
de408c29
SW
194 }
195}
196
d9bfcf4d 197fn render_cell(col: &str, row: &mut Row) -> HTML {
70436f23
SW
198 let row_label = HTML::escape(row.label.as_ref());
199 let col_label = HTML::escape(col);
88a08162
SW
200 let instances: Option<&Vec<Option<String>>> = row.entries.get(col);
201 let class = HTML::from(if instances.is_none() { "" } else { "yes" });
202 let all_empty = instances
203 .iter()
204 .flat_map(|is| is.iter())
205 .all(Option::is_none);
206 let contents = if instances.is_none() || (all_empty && instances.unwrap().len() == 1) {
70436f23 207 HTML::from("")
de408c29 208 } else if all_empty {
88a08162 209 HTML(format!("{}", instances.unwrap().len()))
de408c29 210 } else {
70436f23 211 HTML(
88a08162
SW
212 instances
213 .unwrap()
70436f23 214 .iter()
88a08162 215 .map(render_instance)
70436f23
SW
216 .map(|html| html.0) // Waiting for slice_concat_trait to stabilize
217 .collect::<Vec<_>>()
218 .join(" "),
219 )
de408c29 220 };
d9bfcf4d 221 row.entries.remove(col);
70436f23 222 HTML(format!("<td class=\"{class}\" onmouseover=\"h2('{row_label}','{col_label}')\" onmouseout=\"ch2('{row_label}','{col_label}')\">{contents}</td>"))
de408c29
SW
223}
224
d9bfcf4d 225fn render_row(columns: &[String], row: &mut Row) -> HTML {
70436f23
SW
226 let row_label = HTML::escape(row.label.as_ref());
227 HTML(format!(
92476edc 228 "<tr><th id=\"{row_label}\">{row_label}</th>{}</tr>\n",
de408c29
SW
229 &columns
230 .iter()
231 .map(|col| render_cell(col, row))
70436f23
SW
232 .collect::<HTML>()
233 ))
de408c29
SW
234}
235
70436f23
SW
236fn render_column_headers(columns: &[String]) -> HTML {
237 HTML(
238 String::from("<tr class=\"key\"><th></th>")
239 + &columns.iter().fold(String::new(), |mut acc, col| {
240 let col_header = HTML::escape(col.as_ref());
241 write!(
242 &mut acc,
243 "<th id=\"{col_header}\"><div><div>{col_header}</div></div></th>"
244 )
245 .unwrap();
246 acc
247 })
248 + "</tr>\n",
249 )
76638ea1
SW
250}
251
4b99fb70
SW
252/// # Errors
253///
254/// Will return `Err` if
255/// * there's an i/o error while reading `input`
256/// * the log has invalid syntax:
257/// * an indented line with no preceding non-indented line
28cf4fa2 258pub fn tablify(config: &Config, input: impl std::io::Read) -> Result<HTML, std::io::Error> {
4b99fb70 259 let rows = read_rows(input).collect::<Result<Vec<_>, _>>()?;
de408c29 260 let columns = column_order(&rows);
70436f23
SW
261 Ok(HTML(format!(
262 "{HEADER}{}{}{FOOTER}",
263 render_column_headers(&columns),
264 rows.into_iter()
d9bfcf4d 265 .map(|mut r| render_row(&columns, &mut r))
70436f23
SW
266 .collect::<HTML>()
267 )))
ece97615 268}
75bb888a
SW
269
270#[cfg(test)]
271mod tests {
272 use super::*;
273
b8907770 274 #[test]
88a08162
SW
275 fn test_parse_line() {
276 assert_eq!(InputLine::from(""), InputLine::Blank);
277 assert_eq!(InputLine::from(" "), InputLine::Blank);
278 assert_eq!(InputLine::from("foo"), InputLine::RowHeader("foo"));
279 assert_eq!(InputLine::from("foo "), InputLine::RowHeader("foo"));
280 assert_eq!(InputLine::from(" foo"), InputLine::Entry("foo", None));
b8907770 281 assert_eq!(
88a08162
SW
282 InputLine::from(" foo:bar"),
283 InputLine::Entry("foo", Some("bar"))
b8907770
SW
284 );
285 assert_eq!(
88a08162
SW
286 InputLine::from(" foo: bar"),
287 InputLine::Entry("foo", Some("bar"))
b8907770 288 );
0d999bc3 289 assert_eq!(
88a08162
SW
290 InputLine::from(" foo: bar "),
291 InputLine::Entry("foo", Some("bar"))
292 );
293 assert_eq!(
294 InputLine::from(" foo: bar "),
295 InputLine::Entry("foo", Some("bar"))
296 );
297 assert_eq!(
298 InputLine::from(" foo : bar "),
299 InputLine::Entry("foo", Some("bar"))
0d999bc3 300 );
b8907770
SW
301 }
302
75bb888a
SW
303 #[test]
304 fn test_read_rows() {
305 assert_eq!(
201b9ef3 306 read_rows(&b"foo"[..]).flatten().collect::<Vec<_>>(),
88a08162
SW
307 vec![Row {
308 label: "foo".to_owned(),
309 entries: HashMap::new(),
75bb888a
SW
310 }]
311 );
9dfa98b7 312 assert_eq!(
201b9ef3 313 read_rows(&b"bar"[..]).flatten().collect::<Vec<_>>(),
88a08162
SW
314 vec![Row {
315 label: "bar".to_owned(),
316 entries: HashMap::new(),
9dfa98b7
SW
317 }]
318 );
2aa9ef94 319 assert_eq!(
201b9ef3 320 read_rows(&b"foo\nbar\n"[..]).flatten().collect::<Vec<_>>(),
2aa9ef94 321 vec![
88a08162
SW
322 Row {
323 label: "foo".to_owned(),
324 entries: HashMap::new(),
2aa9ef94 325 },
88a08162
SW
326 Row {
327 label: "bar".to_owned(),
328 entries: HashMap::new(),
2aa9ef94
SW
329 }
330 ]
331 );
201b9ef3
SW
332 assert_eq!(
333 read_rows(&b"foo\n bar\n"[..]).flatten().collect::<Vec<_>>(),
88a08162
SW
334 vec![Row {
335 label: "foo".to_owned(),
336 entries: HashMap::from([("bar".to_owned(), vec![None])]),
201b9ef3
SW
337 }]
338 );
339 assert_eq!(
340 read_rows(&b"foo\n bar\n baz\n"[..])
341 .flatten()
342 .collect::<Vec<_>>(),
88a08162
SW
343 vec![Row {
344 label: "foo".to_owned(),
345 entries: HashMap::from([
346 ("bar".to_owned(), vec![None]),
347 ("baz".to_owned(), vec![None])
348 ]),
201b9ef3
SW
349 }]
350 );
351 assert_eq!(
352 read_rows(&b"foo\n\nbar\n"[..])
353 .flatten()
354 .collect::<Vec<_>>(),
355 vec![
88a08162
SW
356 Row {
357 label: "foo".to_owned(),
358 entries: HashMap::new(),
201b9ef3 359 },
88a08162
SW
360 Row {
361 label: "bar".to_owned(),
362 entries: HashMap::new(),
201b9ef3
SW
363 }
364 ]
365 );
1f6bd845
SW
366 assert_eq!(
367 read_rows(&b"foo\n \nbar\n"[..])
368 .flatten()
369 .collect::<Vec<_>>(),
370 vec![
88a08162
SW
371 Row {
372 label: "foo".to_owned(),
373 entries: HashMap::new(),
1f6bd845 374 },
88a08162
SW
375 Row {
376 label: "bar".to_owned(),
377 entries: HashMap::new(),
1f6bd845
SW
378 }
379 ]
380 );
381 assert_eq!(
382 read_rows(&b"foo \n bar \n"[..])
383 .flatten()
384 .collect::<Vec<_>>(),
88a08162
SW
385 vec![Row {
386 label: "foo".to_owned(),
387 entries: HashMap::from([("bar".to_owned(), vec![None])]),
1f6bd845
SW
388 }]
389 );
201b9ef3
SW
390
391 let bad = read_rows(&b" foo"[..]).next().unwrap();
392 assert!(bad.is_err());
8110b492 393 assert!(format!("{bad:?}").contains("1: Entry with no header"));
201b9ef3
SW
394
395 let bad2 = read_rows(&b"foo\n\n bar"[..]).nth(1).unwrap();
396 assert!(bad2.is_err());
8110b492 397 assert!(format!("{bad2:?}").contains("3: Entry with no header"));
75bb888a 398 }
f272e502
SW
399
400 #[test]
401 fn test_column_counts() {
402 assert_eq!(
403 column_counts(
404 &read_rows(&b"foo\n bar\n baz\n"[..])
405 .collect::<Result<Vec<_>, _>>()
406 .unwrap()
407 ),
58b5f36d 408 vec![(1, String::from("bar")), (1, String::from("baz"))]
f272e502
SW
409 );
410 assert_eq!(
411 column_counts(
412 &read_rows(&b"foo\n bar\n baz\nquux\n baz"[..])
413 .collect::<Result<Vec<_>, _>>()
414 .unwrap()
415 ),
38d1167a 416 vec![(2, String::from("baz")), (1, String::from("bar"))]
f272e502 417 );
397ef957
SW
418 assert_eq!(
419 column_counts(
420 &read_rows(&b"foo\n bar\n bar\n baz\n bar\nquux\n baz"[..])
421 .collect::<Result<Vec<_>, _>>()
422 .unwrap()
423 ),
38d1167a 424 vec![(2, String::from("baz")), (1, String::from("bar"))]
397ef957 425 );
b8907770
SW
426 assert_eq!(
427 column_counts(
428 &read_rows(&b"foo\n bar: 1\n bar: 2\n baz\n bar\nquux\n baz"[..])
429 .collect::<Result<Vec<_>, _>>()
430 .unwrap()
431 ),
38d1167a 432 vec![(2, String::from("baz")), (1, String::from("bar"))]
b8907770 433 );
f272e502 434 }
de408c29
SW
435
436 #[test]
437 fn test_render_cell() {
438 assert_eq!(
439 render_cell(
440 "foo",
d9bfcf4d 441 &mut Row {
88a08162
SW
442 label: "nope".to_owned(),
443 entries: HashMap::new(),
de408c29
SW
444 }
445 ),
70436f23 446 HTML::from("<td class=\"\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\"></td>")
de408c29
SW
447 );
448 assert_eq!(
449 render_cell(
450 "foo",
d9bfcf4d 451 &mut Row {
88a08162
SW
452 label: "nope".to_owned(),
453 entries: HashMap::from([("bar".to_owned(), vec![None])]),
de408c29
SW
454 }
455 ),
70436f23 456 HTML::from("<td class=\"\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\"></td>")
de408c29
SW
457 );
458 assert_eq!(
459 render_cell(
460 "foo",
d9bfcf4d 461 &mut Row {
88a08162
SW
462 label: "nope".to_owned(),
463 entries: HashMap::from([("foo".to_owned(), vec![None])]),
de408c29
SW
464 }
465 ),
70436f23 466 HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\"></td>")
de408c29
SW
467 );
468 assert_eq!(
469 render_cell(
470 "foo",
d9bfcf4d 471 &mut Row {
88a08162
SW
472 label: "nope".to_owned(),
473 entries: HashMap::from([("foo".to_owned(), vec![None, None])]),
de408c29
SW
474 }
475 ),
70436f23 476 HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\">2</td>")
de408c29
SW
477 );
478 assert_eq!(
479 render_cell(
480 "foo",
d9bfcf4d 481 &mut Row {
88a08162
SW
482 label: "nope".to_owned(),
483 entries: HashMap::from([("foo".to_owned(), vec![Some("5".to_owned()), Some("10".to_owned())])]),
de408c29
SW
484 }
485 ),
70436f23 486 HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\">5 10</td>")
de408c29
SW
487 );
488 assert_eq!(
489 render_cell(
490 "foo",
d9bfcf4d 491 &mut Row {
88a08162
SW
492 label: "nope".to_owned(),
493 entries: HashMap::from([("foo".to_owned(), vec![Some("5".to_owned()), None])]),
de408c29
SW
494 }
495 ),
70436f23
SW
496 HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\">5 ✓</td>")
497 );
498 assert_eq!(
499 render_cell(
500 "heart",
d9bfcf4d 501 &mut Row {
88a08162
SW
502 label: "nope".to_owned(),
503 entries: HashMap::from([("heart".to_owned(), vec![Some("<3".to_owned())])]),
70436f23
SW
504 }
505 ),
506 HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','heart')\" onmouseout=\"ch2('nope','heart')\">&lt;3</td>")
507 );
508 assert_eq!(
509 render_cell(
510 "foo",
d9bfcf4d 511 &mut Row {
88a08162
SW
512 label: "bob's".to_owned(),
513 entries: HashMap::from([("foo".to_owned(), vec![None])]),
70436f23
SW
514 }
515 ),
516 HTML::from("<td class=\"yes\" onmouseover=\"h2('bob&#39;s','foo')\" onmouseout=\"ch2('bob&#39;s','foo')\"></td>")
de408c29 517 );
d9bfcf4d
SW
518 let mut r = Row {
519 label: "nope".to_owned(),
520 entries: HashMap::from([
521 ("foo".to_owned(), vec![None]),
522 ("baz".to_owned(), vec![None]),
523 ]),
524 };
525 assert_eq!(r.entries.len(), 2);
526 render_cell("foo", &mut r);
527 assert_eq!(r.entries.len(), 1);
528 render_cell("bar", &mut r);
529 assert_eq!(r.entries.len(), 1);
530 render_cell("baz", &mut r);
531 assert_eq!(r.entries.len(), 0);
de408c29 532 }
75bb888a 533}