1 use std::borrow::ToOwned;
2 use std::collections::{HashMap, HashSet};
5 use std::iter::Iterator;
7 #[derive(PartialEq, Eq, Debug)]
9 column_threshold: usize,
10 static_columns: Vec<Option<String>>,
11 hidden_columns: HashSet<String>,
14 fn apply_command(&mut self, line_num: usize, cmd: &str) -> Result<(), std::io::Error> {
15 if let Some(threshold) = cmd.strip_prefix("col_threshold ") {
16 self.column_threshold = threshold.parse().map_err(|e| {
18 std::io::ErrorKind::InvalidInput,
19 format!("line {line_num}: col_threshold must be numeric: {e}"),
22 } else if let Some(col) = cmd.strip_prefix("hide ") {
23 self.hidden_columns.insert(col.to_owned());
24 } else if let Some(col) = cmd.strip_prefix("col ") {
25 self.static_columns.push(Some(col.to_owned()));
26 } else if cmd == "colsep" {
27 self.static_columns.push(None);
29 return Err(std::io::Error::new(
30 std::io::ErrorKind::InvalidInput,
31 format!("line {line_num}: Unknown command: {cmd}"),
37 impl Default for Config {
38 fn default() -> Self {
41 static_columns: vec![],
42 hidden_columns: HashSet::new(),
47 const HEADER: &str = r#"<!DOCTYPE html>
50 <meta charset="utf-8">
51 <meta name="viewport" content="width=device-width, initial-scale=1">
53 td { text-align: center; }
54 /* h/t https://wabain.github.io/2019/10/13/css-rotated-table-header.html */
55 th, td { white-space: nowrap; }
56 th { text-align: left; font-weight: normal; }
57 th.spacer_row { height: .3em; }
58 .spacer_col { border: none; width: .2em; }
59 table { border-collapse: collapse }
60 tr.key > th { height: 10em; vertical-align: bottom; line-height: 1 }
61 tr.key > th > div { width: 1em; }
62 tr.key > th > div > div { width: 5em; transform-origin: bottom left; transform: translateX(1em) rotate(-65deg) }
63 td { border: thin solid gray; }
64 td.leftover { text-align: left; border: none; padding-left: .4em; }
65 td.yes { border: thin solid gray; background-color: #ddd; }
66 /* h/t https://stackoverflow.com/questions/5687035/css-bolding-some-text-without-changing-its-containers-size/46452396#46452396 */
67 .highlight { text-shadow: -0.06ex 0 black, 0.06ex 0 black; }
70 function highlight(id) { const e = document.getElementById(id); if (e) { e.classList.add( "highlight"); } }
71 function clear_highlight(id) { const e = document.getElementById(id); if (e) { e.classList.remove("highlight"); } }
72 function h2(a, b) { highlight(a); highlight(b); }
73 function ch2(a, b) { clear_highlight(a); clear_highlight(b); }
80 const FOOTER: &str = " </tbody>
85 #[derive(PartialEq, Eq, Debug)]
86 pub struct HTML(String);
88 fn escape(value: &str) -> HTML {
89 let mut escaped: String = String::new();
90 for c in value.chars() {
92 '>' => escaped.push_str(">"),
93 '<' => escaped.push_str("<"),
94 '\'' => escaped.push_str("'"),
95 '"' => escaped.push_str("""),
96 '&' => escaped.push_str("&"),
97 ok_c => escaped.push(ok_c),
103 impl From<&str> for HTML {
104 fn from(value: &str) -> HTML {
105 HTML(String::from(value))
108 impl FromIterator<HTML> for HTML {
109 fn from_iter<T>(iter: T) -> HTML
111 T: IntoIterator<Item = HTML>,
113 HTML(iter.into_iter().map(|html| html.0).collect::<String>())
116 impl std::fmt::Display for HTML {
117 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
118 write!(f, "{}", self.0)
122 #[derive(Debug, PartialEq, Eq)]
126 Entry(&'a str, Option<&'a str>),
129 impl<'a> From<&'a str> for InputLine<'a> {
130 fn from(value: &'a str) -> InputLine<'a> {
131 let trimmed = value.trim_end();
132 if trimmed.is_empty() {
134 } else if let Some(cmd) = trimmed.strip_prefix('!') {
135 InputLine::Command(cmd)
136 } else if !trimmed.starts_with(' ') {
137 InputLine::RowHeader(value.trim())
139 match value.split_once(':') {
140 None => InputLine::Entry(value.trim(), None),
141 Some((col, instance)) => InputLine::Entry(col.trim(), Some(instance.trim())),
147 #[derive(Debug, PartialEq, Eq)]
150 entries: HashMap<String, Vec<Option<String>>>,
153 #[derive(Debug, PartialEq, Eq)]
159 struct Reader<'cfg, Input: Iterator<Item = Result<String, std::io::Error>>> {
160 input: std::iter::Enumerate<Input>,
162 config: &'cfg mut Config,
164 impl<'cfg, Input: Iterator<Item = Result<String, std::io::Error>>> Reader<'cfg, Input> {
165 fn new(config: &'cfg mut Config, input: Input) -> Self {
167 input: input.enumerate(),
173 impl<'cfg, Input: Iterator<Item = Result<String, std::io::Error>>> Iterator
174 for Reader<'cfg, Input>
176 type Item = Result<Rowlike, std::io::Error>;
177 fn next(&mut self) -> Option<Self::Item> {
179 match self.input.next() {
180 None => return Ok(std::mem::take(&mut self.row).map(Rowlike::Row)).transpose(),
181 Some((_, Err(e))) => return Some(Err(e)),
182 Some((n, Ok(line))) => match InputLine::from(line.as_ref()) {
183 InputLine::Command(cmd) => {
184 if let Err(e) = self.config.apply_command(n + 1, cmd) {
188 InputLine::Blank if self.row.is_some() => {
189 return Ok(std::mem::take(&mut self.row).map(Rowlike::Row)).transpose()
191 InputLine::Blank => return Some(Ok(Rowlike::Spacer)),
192 InputLine::Entry(col, instance) => match &mut self.row {
194 return Some(Err(std::io::Error::other(format!(
195 "line {}: Entry with no header",
199 Some(ref mut row) => {
201 .entry(col.to_owned())
202 .and_modify(|is| is.push(instance.map(ToOwned::to_owned)))
203 .or_insert_with(|| vec![instance.map(ToOwned::to_owned)]);
206 InputLine::RowHeader(row) => {
207 let prev = std::mem::take(&mut self.row);
208 self.row = Some(Row {
209 label: row.to_owned(),
210 entries: HashMap::new(),
213 return Ok(prev.map(Rowlike::Row)).transpose();
222 fn read_input(input: impl std::io::Read) -> Result<(Vec<Rowlike>, Config), std::io::Error> {
223 let mut config = Config::default();
224 let reader = Reader::new(&mut config, std::io::BufReader::new(input).lines());
226 .collect::<Result<Vec<_>, _>>()
227 .map(|rows| (rows, config))
230 fn column_counts(rows: &[Rowlike]) -> Vec<(usize, String)> {
231 let empty = HashMap::new();
232 let mut counts: Vec<_> = rows
234 .flat_map(|rl| match rl {
235 Rowlike::Row(r) => r.entries.keys(),
236 Rowlike::Spacer => empty.keys(),
238 .fold(HashMap::new(), |mut cs, col| {
239 cs.entry(col.to_owned())
240 .and_modify(|n| *n += 1)
245 .map(|(col, n)| (n, col))
247 counts.sort_unstable_by(|(an, acol), (bn, bcol)| bn.cmp(an).then(acol.cmp(bcol)));
250 fn column_order(config: &Config, rows: &[Rowlike]) -> Vec<String> {
251 let static_columns: HashSet<&str> = config
255 .map(std::string::String::as_str)
259 .filter_map(|(n, col)| {
260 (n >= config.column_threshold
261 && !static_columns.contains(col.as_str())
262 && !config.hidden_columns.contains(&col))
268 fn render_one_instance(instance: &Option<String>) -> HTML {
270 None => HTML::from("✓"),
271 Some(instance) => HTML::escape(instance.as_ref()),
275 fn render_instances(instances: &[Option<String>]) -> HTML {
276 let all_empty = instances.iter().all(Option::is_none);
277 if all_empty && instances.len() == 1 {
279 } else if all_empty {
280 HTML(format!("{}", instances.len()))
285 .map(render_one_instance)
286 .map(|html| html.0) // Waiting for slice_concat_trait to stabilize
293 fn render_cell(col: &str, row: &mut Row) -> HTML {
294 let row_label = HTML::escape(row.label.as_ref());
295 let col_label = HTML::escape(col);
296 let instances: Option<&Vec<Option<String>>> = row.entries.get(col);
297 let class = HTML::from(if instances.is_none() { "" } else { "yes" });
298 let contents = match instances {
299 None => HTML::from(""),
300 Some(is) => render_instances(is),
302 row.entries.remove(col);
304 r#"<td class="{class}" onmouseover="h2('{row_label}','{col_label}')" onmouseout="ch2('{row_label}','{col_label}')">{contents}</td>"#
308 fn render_leftover(notcol: &str, instances: &[Option<String>]) -> HTML {
309 let label = HTML::escape(notcol);
310 let rest = render_instances(instances);
311 if rest == HTML::from("") {
312 HTML(format!("{label}"))
314 HTML(format!("{label}: {rest}"))
318 fn render_all_leftovers(config: &Config, row: &Row) -> HTML {
319 let mut order: Vec<_> = row
322 .filter(|&col| !config.hidden_columns.contains(col))
324 order.sort_unstable();
328 .map(|notcol| render_leftover(notcol, row.entries.get(notcol).expect("Key vanished?!")))
329 .map(|html| html.0) // Waiting for slice_concat_trait to stabilize
335 fn render_row(config: &Config, columns: &[String], rowlike: &mut Rowlike) -> HTML {
337 Rowlike::Spacer => HTML::from("<tr><th class=\"spacer_row\"></th></tr>\n"),
338 Rowlike::Row(row) => {
339 let row_label = HTML::escape(row.label.as_ref());
340 let static_cells = config
343 .map(|ocol| match ocol {
344 Some(col) if config.hidden_columns.contains(col) => HTML::from(""),
345 Some(col) => render_cell(col, row),
346 None => HTML::from(r#"<td class="spacer_col"></td>"#),
349 let dynamic_cells = columns
351 .filter(|&col| !config.hidden_columns.contains(col))
352 .map(|col| render_cell(col, row))
354 let leftovers = render_all_leftovers(config, row);
356 "<tr><th id=\"{row_label}\">{row_label}</th>{static_cells}{dynamic_cells}<td class=\"leftover\" onmouseover=\"highlight('{row_label}')\" onmouseout=\"clear_highlight('{row_label}')\">{leftovers}</td></tr>\n"
362 fn column_header_order<'a>(
364 columns: &'a [String],
365 ) -> impl Iterator<Item = Option<&'a String>> {
366 let static_columns = config.static_columns.iter().map(|oc| oc.as_ref());
367 let dynamic_columns = columns.iter().map(Some);
368 static_columns.chain(dynamic_columns).filter(|ocol| {
369 ocol.map_or(true, |col| !config.hidden_columns.contains(col))
373 fn render_column_headers(config: &Config, columns: &[String]) -> HTML {
375 String::from(r#"<tr class="key"><th></th>"#)
376 + &column_header_order(config, columns).fold(String::new(), |mut acc, ocol| {
379 let col_header = HTML::escape(col);
382 r#"<th id="{col_header}"><div><div>{col_header}</div></div></th>"#
385 None => write!(&mut acc, r#"<th class="col_spacer"></th>"#),
396 /// Will return `Err` if
397 /// * there's an i/o error while reading `input`
398 /// * the log has invalid syntax:
399 /// * an indented line with no preceding non-indented line
400 pub fn tablify(input: impl std::io::Read) -> Result<HTML, std::io::Error> {
401 let (rows, config) = read_input(input)?;
402 let columns = column_order(&config, &rows);
404 "{HEADER}{}{}{FOOTER}",
405 render_column_headers(&config, &columns),
407 .map(|mut r| render_row(&config, &columns, &mut r))
417 fn test_parse_line() {
418 assert_eq!(InputLine::from(""), InputLine::Blank);
419 assert_eq!(InputLine::from(" "), InputLine::Blank);
420 assert_eq!(InputLine::from("foo"), InputLine::RowHeader("foo"));
421 assert_eq!(InputLine::from("foo "), InputLine::RowHeader("foo"));
422 assert_eq!(InputLine::from(" foo"), InputLine::Entry("foo", None));
424 InputLine::from(" foo:bar"),
425 InputLine::Entry("foo", Some("bar"))
428 InputLine::from(" foo: bar"),
429 InputLine::Entry("foo", Some("bar"))
432 InputLine::from(" foo: bar "),
433 InputLine::Entry("foo", Some("bar"))
436 InputLine::from(" foo: bar "),
437 InputLine::Entry("foo", Some("bar"))
440 InputLine::from(" foo : bar "),
441 InputLine::Entry("foo", Some("bar"))
445 fn read_rows(input: impl std::io::Read) -> Result<Vec<Rowlike>, std::io::Error> {
446 read_input(input).map(|(rows, _)| rows)
448 fn read_config(input: impl std::io::Read) -> Result<Config, std::io::Error> {
449 read_input(input).map(|(_, config)| config)
452 fn test_read_rows() {
454 read_rows(&b"foo"[..]).unwrap(),
455 vec![Rowlike::Row(Row {
456 label: "foo".to_owned(),
457 entries: HashMap::new(),
461 read_rows(&b"bar"[..]).unwrap(),
462 vec![Rowlike::Row(Row {
463 label: "bar".to_owned(),
464 entries: HashMap::new(),
468 read_rows(&b"foo\nbar\n"[..]).unwrap(),
471 label: "foo".to_owned(),
472 entries: HashMap::new(),
475 label: "bar".to_owned(),
476 entries: HashMap::new(),
481 read_rows(&b"foo\n bar\n"[..]).unwrap(),
482 vec![Rowlike::Row(Row {
483 label: "foo".to_owned(),
484 entries: HashMap::from([("bar".to_owned(), vec![None])]),
488 read_rows(&b"foo\n bar\n baz\n"[..]).unwrap(),
489 vec![Rowlike::Row(Row {
490 label: "foo".to_owned(),
491 entries: HashMap::from([
492 ("bar".to_owned(), vec![None]),
493 ("baz".to_owned(), vec![None])
498 read_rows(&b"foo\n\nbar\n"[..]).unwrap(),
501 label: "foo".to_owned(),
502 entries: HashMap::new(),
505 label: "bar".to_owned(),
506 entries: HashMap::new(),
511 read_rows(&b"foo\n\n\nbar\n"[..]).unwrap(),
514 label: "foo".to_owned(),
515 entries: HashMap::new(),
519 label: "bar".to_owned(),
520 entries: HashMap::new(),
525 read_rows(&b"foo\n \nbar\n"[..]).unwrap(),
528 label: "foo".to_owned(),
529 entries: HashMap::new(),
532 label: "bar".to_owned(),
533 entries: HashMap::new(),
538 read_rows(&b"foo \n bar \n"[..]).unwrap(),
539 vec![Rowlike::Row(Row {
540 label: "foo".to_owned(),
541 entries: HashMap::from([("bar".to_owned(), vec![None])]),
545 let bad = read_rows(&b" foo"[..]);
546 assert!(bad.is_err());
547 assert!(format!("{bad:?}").contains("line 1: Entry with no header"));
549 let bad2 = read_rows(&b"foo\n\n bar"[..]);
550 assert!(bad2.is_err());
551 assert!(format!("{bad2:?}").contains("line 3: Entry with no header"));
555 fn test_read_config() {
557 read_config(&b"!col_threshold 10"[..])
563 read_config(&b"!col foo"[..]).unwrap().static_columns,
564 vec![Some("foo".to_owned())]
567 let bad_command = read_config(&b"!no such command"[..]);
568 assert!(bad_command.is_err());
569 assert!(format!("{bad_command:?}").contains("line 1: Unknown command"));
571 let bad_num = read_config(&b"!col_threshold foo"[..]);
572 assert!(bad_num.is_err());
573 assert!(format!("{bad_num:?}").contains("line 1: col_threshold must be numeric"));
577 fn test_column_counts() {
579 column_counts(&read_rows(&b"foo\n bar\n baz\n"[..]).unwrap()),
580 vec![(1, String::from("bar")), (1, String::from("baz"))]
583 column_counts(&read_rows(&b"foo\n bar\n baz\nquux\n baz"[..]).unwrap()),
584 vec![(2, String::from("baz")), (1, String::from("bar"))]
587 column_counts(&read_rows(&b"foo\n bar\n bar\n baz\n bar\nquux\n baz"[..]).unwrap()),
588 vec![(2, String::from("baz")), (1, String::from("bar"))]
592 &read_rows(&b"foo\n bar: 1\n bar: 2\n baz\n bar\nquux\n baz"[..]).unwrap()
594 vec![(2, String::from("baz")), (1, String::from("bar"))]
599 fn test_column_header_order() {
600 let mut cfg = Config::default();
602 assert!(column_header_order(&cfg, &["foo".to_owned()]).eq([Some(&"foo".to_owned())]));
604 cfg.static_columns.push(Some("bar".to_owned()));
605 assert!(column_header_order(&cfg, &["foo".to_owned()])
606 .eq([Some(&"bar".to_owned()), Some(&"foo".to_owned())]));
608 cfg.static_columns.push(None);
609 assert!(column_header_order(&cfg, &["foo".to_owned()]).eq([
610 Some(&"bar".to_owned()),
612 Some(&"foo".to_owned())
615 cfg.hidden_columns.insert("foo".to_owned());
616 assert!(column_header_order(&cfg, &["foo".to_owned()]).eq([Some(&"bar".to_owned()), None]));
618 cfg.hidden_columns.insert("bar".to_owned());
619 assert!(column_header_order(&cfg, &["foo".to_owned()]).eq([None]));
623 fn test_render_cell() {
628 label: "nope".to_owned(),
629 entries: HashMap::new(),
633 r#"<td class="" onmouseover="h2('nope','foo')" onmouseout="ch2('nope','foo')"></td>"#
640 label: "nope".to_owned(),
641 entries: HashMap::from([("bar".to_owned(), vec![None])]),
645 r#"<td class="" onmouseover="h2('nope','foo')" onmouseout="ch2('nope','foo')"></td>"#
652 label: "nope".to_owned(),
653 entries: HashMap::from([("foo".to_owned(), vec![None])]),
657 r#"<td class="yes" onmouseover="h2('nope','foo')" onmouseout="ch2('nope','foo')"></td>"#
664 label: "nope".to_owned(),
665 entries: HashMap::from([("foo".to_owned(), vec![None, None])]),
669 r#"<td class="yes" onmouseover="h2('nope','foo')" onmouseout="ch2('nope','foo')">2</td>"#
676 label: "nope".to_owned(),
677 entries: HashMap::from([(
679 vec![Some("5".to_owned()), Some("10".to_owned())]
684 r#"<td class="yes" onmouseover="h2('nope','foo')" onmouseout="ch2('nope','foo')">5 10</td>"#
691 label: "nope".to_owned(),
692 entries: HashMap::from([("foo".to_owned(), vec![Some("5".to_owned()), None])]),
696 r#"<td class="yes" onmouseover="h2('nope','foo')" onmouseout="ch2('nope','foo')">5 ✓</td>"#
703 label: "nope".to_owned(),
704 entries: HashMap::from([("heart".to_owned(), vec![Some("<3".to_owned())])]),
708 r#"<td class="yes" onmouseover="h2('nope','heart')" onmouseout="ch2('nope','heart')"><3</td>"#
715 label: "bob's".to_owned(),
716 entries: HashMap::from([("foo".to_owned(), vec![None])]),
720 r#"<td class="yes" onmouseover="h2('bob's','foo')" onmouseout="ch2('bob's','foo')"></td>"#
724 label: "nope".to_owned(),
725 entries: HashMap::from([
726 ("foo".to_owned(), vec![None]),
727 ("baz".to_owned(), vec![None]),
730 assert_eq!(r.entries.len(), 2);
731 render_cell("foo", &mut r);
732 assert_eq!(r.entries.len(), 1);
733 render_cell("bar", &mut r);
734 assert_eq!(r.entries.len(), 1);
735 render_cell("baz", &mut r);
736 assert_eq!(r.entries.len(), 0);
740 fn test_render_leftovers() {
742 render_all_leftovers(
745 label: "nope".to_owned(),
746 entries: HashMap::from([("foo".to_owned(), vec![None])]),
752 render_all_leftovers(
755 label: "nope".to_owned(),
756 entries: HashMap::from([
757 ("foo".to_owned(), vec![None]),
758 ("bar".to_owned(), vec![None])
762 HTML::from("bar, foo")
765 render_all_leftovers(
768 label: "nope".to_owned(),
769 entries: HashMap::from([
770 ("foo".to_owned(), vec![None]),
771 ("bar".to_owned(), vec![None, None])
775 HTML::from("bar: 2, foo")
778 render_all_leftovers(
781 static_columns: vec![],
782 hidden_columns: HashSet::from(["private".to_owned()]),
785 label: "nope".to_owned(),
786 entries: HashMap::from([("private".to_owned(), vec![None]),]),
794 fn test_render_row() {
799 &mut Rowlike::Row(Row {
800 label: "nope".to_owned(),
801 entries: HashMap::from([("bar".to_owned(), vec![None])]),
805 r#"<tr><th id="nope">nope</th><td class="" onmouseover="h2('nope','foo')" onmouseout="ch2('nope','foo')"></td><td class="leftover" onmouseover="highlight('nope')" onmouseout="clear_highlight('nope')">bar</td></tr>
813 static_columns: vec![Some("foo".to_owned()), Some("bar".to_owned())],
814 hidden_columns: HashSet::new(),
817 &mut Rowlike::Row(Row {
818 label: "nope".to_owned(),
819 entries: HashMap::from([
820 ("bar".to_owned(), vec![Some("r".to_owned())]),
821 ("baz".to_owned(), vec![Some("z".to_owned())]),
822 ("foo".to_owned(), vec![Some("f".to_owned())]),
827 r#"<tr><th id="nope">nope</th><td class="yes" onmouseover="h2('nope','foo')" onmouseout="ch2('nope','foo')">f</td><td class="yes" onmouseover="h2('nope','bar')" onmouseout="ch2('nope','bar')">r</td><td class="yes" onmouseover="h2('nope','baz')" onmouseout="ch2('nope','baz')">z</td><td class="leftover" onmouseover="highlight('nope')" onmouseout="clear_highlight('nope')"></td></tr>
835 static_columns: vec![Some("foo".to_owned()), None, Some("bar".to_owned())],
836 hidden_columns: HashSet::new(),
839 &mut Rowlike::Row(Row {
840 label: "nope".to_owned(),
841 entries: HashMap::from([
842 ("bar".to_owned(), vec![Some("r".to_owned())]),
843 ("foo".to_owned(), vec![Some("f".to_owned())]),
848 r#"<tr><th id="nope">nope</th><td class="yes" onmouseover="h2('nope','foo')" onmouseout="ch2('nope','foo')">f</td><td class="spacer_col"></td><td class="yes" onmouseover="h2('nope','bar')" onmouseout="ch2('nope','bar')">r</td><td class="leftover" onmouseover="highlight('nope')" onmouseout="clear_highlight('nope')"></td></tr>
856 static_columns: vec![],
857 hidden_columns: HashSet::from(["foo".to_owned()]),
860 &mut Rowlike::Row(Row {
861 label: "nope".to_owned(),
862 entries: HashMap::from([("foo".to_owned(), vec![Some("f".to_owned())]),]),
866 r#"<tr><th id="nope">nope</th><td class="leftover" onmouseover="highlight('nope')" onmouseout="clear_highlight('nope')"></td></tr>
874 static_columns: vec![Some("foo".to_owned())],
875 hidden_columns: HashSet::from(["foo".to_owned()]),
878 &mut Rowlike::Row(Row {
879 label: "nope".to_owned(),
880 entries: HashMap::from([("foo".to_owned(), vec![Some("f".to_owned())]),]),
884 r#"<tr><th id="nope">nope</th><td class="leftover" onmouseover="highlight('nope')" onmouseout="clear_highlight('nope')"></td></tr>