X-Git-Url: http://git.scottworley.com/tablify/blobdiff_plain/b2f318323ffed782b90237e38015d65638848d3d..156f8d37e7451b5f31f02f32b0f0eb07df8c3954:/src/lib.rs?ds=inline diff --git a/src/lib.rs b/src/lib.rs index d974461..e199470 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -4,28 +4,82 @@ use std::fmt::Write; use std::io::BufRead; use std::iter::Iterator; +fn tally_marks(n: usize, mark: Option<&str>) -> String { + match mark { + None => { + let fives = { 0..n / 5 }.map(|_| '𝍸'); + let ones = { 0..n % 5 }.map(|_| '𝍷'); + fives.chain(ones).collect() + } + Some(m) => { 0..n }.map(|_| m).collect(), + } +} + #[derive(PartialEq, Eq, Debug)] struct Config { column_threshold: usize, - static_columns: Vec, + static_columns: Vec>, + hidden_columns: HashSet, + substitute_labels: HashMap, + mark: HashMap, } impl Config { - fn apply_command(&mut self, cmd: &str) -> Result<(), std::io::Error> { + fn apply_command(&mut self, line_num: usize, cmd: &str) -> Result<(), std::io::Error> { if let Some(threshold) = cmd.strip_prefix("col_threshold ") { - self.column_threshold = threshold - .parse() - .map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidInput, e))?; + self.column_threshold = threshold.parse().map_err(|e| { + std::io::Error::new( + std::io::ErrorKind::InvalidInput, + format!("line {line_num}: col_threshold must be numeric: {e}"), + ) + })?; + } else if let Some(col) = cmd.strip_prefix("hide ") { + self.hidden_columns.insert(col.to_owned()); } else if let Some(col) = cmd.strip_prefix("col ") { - self.static_columns.push(col.to_owned()); + self.static_columns.push(Some(col.to_owned())); + } else if cmd == "colsep" { + self.static_columns.push(None); + } else if let Some(directive) = cmd.strip_prefix("label ") { + match directive.split_once(':') { + None => { + return Err(std::io::Error::new( + std::io::ErrorKind::InvalidInput, + format!("line {line_num}: Annotation missing ':'"), + )) + } + Some((col, label)) => self + .substitute_labels + .insert(col.to_owned(), label.to_owned()), + }; + } else if let Some(directive) = cmd.strip_prefix("mark ") { + match directive.split_once(':') { + None => { + return Err(std::io::Error::new( + std::io::ErrorKind::InvalidInput, + format!("line {line_num}: Mark missing ':'"), + )) + } + Some((col, label)) => self.mark.insert(col.to_owned(), label.to_owned()), + }; } else { return Err(std::io::Error::new( std::io::ErrorKind::InvalidInput, - format!("Unknown command: {cmd}"), + format!("line {line_num}: Unknown command: {cmd}"), )); } Ok(()) } } +impl Default for Config { + fn default() -> Self { + Self { + column_threshold: 2, + static_columns: vec![], + hidden_columns: HashSet::new(), + substitute_labels: HashMap::new(), + mark: HashMap::new(), + } + } +} const HEADER: &str = r#" @@ -38,13 +92,14 @@ const HEADER: &str = r#" th, td { white-space: nowrap; } th { text-align: left; font-weight: normal; } th.spacer_row { height: .3em; } + .spacer_col { border: none; width: .2em; } table { border-collapse: collapse } tr.key > th { height: 10em; vertical-align: bottom; line-height: 1 } tr.key > th > div { width: 1em; } tr.key > th > div > div { width: 5em; transform-origin: bottom left; transform: translateX(1em) rotate(-65deg) } td { border: thin solid gray; } td.leftover { text-align: left; border: none; padding-left: .4em; } - td.yes { border: thin solid gray; background-color: #ddd; } + td.yes { border: thin solid gray; background-color: #eee; } /* h/t https://stackoverflow.com/questions/5687035/css-bolding-some-text-without-changing-its-containers-size/46452396#46452396 */ .highlight { text-shadow: -0.06ex 0 black, 0.06ex 0 black; } @@ -163,7 +218,7 @@ impl<'cfg, Input: Iterator>> Iterator Some((_, Err(e))) => return Some(Err(e)), Some((n, Ok(line))) => match InputLine::from(line.as_ref()) { InputLine::Command(cmd) => { - if let Err(e) = self.config.apply_command(cmd) { + if let Err(e) = self.config.apply_command(n + 1, cmd) { return Some(Err(e)); } } @@ -174,7 +229,7 @@ impl<'cfg, Input: Iterator>> Iterator InputLine::Entry(col, instance) => match &mut self.row { None => { return Some(Err(std::io::Error::other(format!( - "{}: Entry with no header", + "line {}: Entry with no header", n + 1 )))) } @@ -202,10 +257,7 @@ impl<'cfg, Input: Iterator>> Iterator } fn read_input(input: impl std::io::Read) -> Result<(Vec, Config), std::io::Error> { - let mut config = Config { - column_threshold: 2, - static_columns: vec![], - }; + let mut config = Config::default(); let reader = Reader::new(&mut config, std::io::BufReader::new(input).lines()); reader .collect::, _>>() @@ -236,73 +288,100 @@ fn column_order(config: &Config, rows: &[Rowlike]) -> Vec { let static_columns: HashSet<&str> = config .static_columns .iter() + .flatten() .map(std::string::String::as_str) .collect(); column_counts(rows) .into_iter() .filter_map(|(n, col)| { - (n >= config.column_threshold && !static_columns.contains(col.as_str())).then_some(col) + (n >= config.column_threshold + && !static_columns.contains(col.as_str()) + && !config.hidden_columns.contains(&col)) + .then_some(col) }) .collect() } -fn render_one_instance(instance: &Option) -> HTML { - match instance { - None => HTML::from("✓"), - Some(instance) => HTML::escape(instance.as_ref()), +fn render_instances(instances: &[Option], mark: Option<&str>) -> HTML { + let mut tally = 0; + let mut out = vec![]; + for ins in instances { + match ins { + None => tally += 1, + Some(content) => { + if tally > 0 { + out.push(HTML(tally_marks(tally, mark))); + tally = 0; + } + out.push(HTML::escape(content)); + } + } } -} - -fn render_instances(instances: &[Option]) -> HTML { - let all_empty = instances.iter().all(Option::is_none); - if all_empty && instances.len() == 1 { - HTML::from("") - } else if all_empty { - HTML(format!("{}", instances.len())) - } else { - HTML( - instances - .iter() - .map(render_one_instance) - .map(|html| html.0) // Waiting for slice_concat_trait to stabilize - .collect::>() - .join(" "), - ) + if tally > 0 { + out.push(HTML(tally_marks(tally, mark))); } + HTML( + out.into_iter() + .map(|html| html.0) // Waiting for slice_concat_trait to stabilize + .collect::>() + .join(" "), + ) } -fn render_cell(col: &str, row: &mut Row) -> HTML { +fn render_cell(config: &Config, col: &str, row: &mut Row) -> HTML { let row_label = HTML::escape(row.label.as_ref()); - let col_label = HTML::escape(col); + let col_label = HTML::escape( + config + .substitute_labels + .get(col) + .map_or(col, std::string::String::as_str), + ); let instances: Option<&Vec>> = row.entries.get(col); - let class = HTML::from(if instances.is_none() { "" } else { "yes" }); + let is_empty = match instances { + None => true, + Some(is) => is.iter().all(|ins| match ins { + None => false, + Some(content) => content == "×", + }), + }; + let class = HTML::from(if is_empty { "" } else { r#" class="yes""# }); let contents = match instances { None => HTML::from(""), - Some(is) => render_instances(is), + Some(is) => render_instances(is, config.mark.get(col).map(String::as_str)), }; row.entries.remove(col); HTML(format!( - r#"{contents}"# + r#"{contents}"# )) } -fn render_leftover(notcol: &str, instances: &[Option]) -> HTML { +fn render_leftover(config: &Config, notcol: &str, instances: &[Option]) -> HTML { let label = HTML::escape(notcol); - let rest = render_instances(instances); - if rest == HTML::from("") { + if instances.len() == 1 && instances[0].is_none() { HTML(format!("{label}")) } else { + let rest = render_instances(instances, config.mark.get(notcol).map(String::as_str)); HTML(format!("{label}: {rest}")) } } -fn render_all_leftovers(row: &Row) -> HTML { - let mut order: Vec<_> = row.entries.keys().collect(); +fn render_all_leftovers(config: &Config, row: &Row) -> HTML { + let mut order: Vec<_> = row + .entries + .keys() + .filter(|&col| !config.hidden_columns.contains(col)) + .collect(); order.sort_unstable(); HTML( order .into_iter() - .map(|notcol| render_leftover(notcol, row.entries.get(notcol).expect("Key vanished?!"))) + .map(|notcol| { + render_leftover( + config, + notcol, + row.entries.get(notcol).expect("Key vanished?!"), + ) + }) .map(|html| html.0) // Waiting for slice_concat_trait to stabilize .collect::>() .join(", "), @@ -317,13 +396,18 @@ fn render_row(config: &Config, columns: &[String], rowlike: &mut Rowlike) -> HTM let static_cells = config .static_columns .iter() - .map(|col| render_cell(col, row)) + .map(|ocol| match ocol { + Some(col) if config.hidden_columns.contains(col) => HTML::from(""), + Some(col) => render_cell(config, col, row), + None => HTML::from(r#""#), + }) .collect::(); let dynamic_cells = columns .iter() - .map(|col| render_cell(col, row)) + .filter(|&col| !config.hidden_columns.contains(col)) + .map(|col| render_cell(config, col, row)) .collect::(); - let leftovers = render_all_leftovers(row); + let leftovers = render_all_leftovers(config, row); HTML(format!( "{row_label}{static_cells}{dynamic_cells}{leftovers}\n" )) @@ -331,21 +415,40 @@ fn render_row(config: &Config, columns: &[String], rowlike: &mut Rowlike) -> HTM } } +fn column_header_labels<'a>( + config: &'a Config, + columns: &'a [String], +) -> impl Iterator> { + let static_columns = config.static_columns.iter().map(|oc| oc.as_ref()); + let dynamic_columns = columns.iter().map(Some); + static_columns + .chain(dynamic_columns) + .filter(|ocol| ocol.map_or(true, |col| !config.hidden_columns.contains(col))) + .map(|ocol| { + ocol.map(|col| match config.substitute_labels.get(col) { + None => col, + Some(substitute) => substitute, + }) + }) +} + fn render_column_headers(config: &Config, columns: &[String]) -> HTML { HTML( String::from(r#""#) - + &config.static_columns.iter().chain(columns.iter()).fold( - String::new(), - |mut acc, col| { - let col_header = HTML::escape(col.as_ref()); - write!( - &mut acc, - r#"
{col_header}
"# - ) - .unwrap(); - acc - }, - ) + + &column_header_labels(config, columns).fold(String::new(), |mut acc, ocol| { + match ocol { + Some(col) => { + let col_header = HTML::escape(col); + write!( + &mut acc, + r#"
{col_header}
"# + ) + } + None => write!(&mut acc, r#""#), + } + .unwrap(); + acc + }) + "\n", ) } @@ -401,6 +504,26 @@ mod tests { ); } + #[test] + fn test_tally_marks() { + assert_eq!(tally_marks(1, None), "𝍷"); + assert_eq!(tally_marks(2, None), "𝍷𝍷"); + assert_eq!(tally_marks(3, None), "𝍷𝍷𝍷"); + assert_eq!(tally_marks(4, None), "𝍷𝍷𝍷𝍷"); + assert_eq!(tally_marks(5, None), "𝍸"); + assert_eq!(tally_marks(6, None), "𝍸𝍷"); + assert_eq!(tally_marks(7, None), "𝍸𝍷𝍷"); + assert_eq!(tally_marks(8, None), "𝍸𝍷𝍷𝍷"); + assert_eq!(tally_marks(9, None), "𝍸𝍷𝍷𝍷𝍷"); + assert_eq!(tally_marks(10, None), "𝍸𝍸"); + assert_eq!(tally_marks(11, None), "𝍸𝍸𝍷"); + assert_eq!(tally_marks(1, Some("x")), "x"); + assert_eq!(tally_marks(4, Some("x")), "xxxx"); + assert_eq!(tally_marks(5, Some("x")), "xxxxx"); + assert_eq!(tally_marks(6, Some("x")), "xxxxxx"); + assert_eq!(tally_marks(2, Some("🍔")), "🍔🍔"); + } + fn read_rows(input: impl std::io::Read) -> Result, std::io::Error> { read_input(input).map(|(rows, _)| rows) } @@ -503,11 +626,11 @@ mod tests { let bad = read_rows(&b" foo"[..]); assert!(bad.is_err()); - assert!(format!("{bad:?}").contains("1: Entry with no header")); + assert!(format!("{bad:?}").contains("line 1: Entry with no header")); let bad2 = read_rows(&b"foo\n\n bar"[..]); assert!(bad2.is_err()); - assert!(format!("{bad2:?}").contains("3: Entry with no header")); + assert!(format!("{bad2:?}").contains("line 3: Entry with no header")); } #[test] @@ -520,16 +643,31 @@ mod tests { ); assert_eq!( read_config(&b"!col foo"[..]).unwrap().static_columns, - vec!["foo".to_owned()] + vec![Some("foo".to_owned())] + ); + assert_eq!( + read_config(&b"!label foo:bar"[..]) + .unwrap() + .substitute_labels["foo"], + "bar" ); + assert_eq!(read_config(&b"!mark foo:*"[..]).unwrap().mark["foo"], "*"); let bad_command = read_config(&b"!no such command"[..]); assert!(bad_command.is_err()); - assert!(format!("{bad_command:?}").contains("Unknown command")); + assert!(format!("{bad_command:?}").contains("line 1: Unknown command")); let bad_num = read_config(&b"!col_threshold foo"[..]); assert!(bad_num.is_err()); - assert!(format!("{bad_num:?}").contains("Parse")); + assert!(format!("{bad_num:?}").contains("line 1: col_threshold must be numeric")); + + let bad_sub = read_config(&b"!label foo"[..]); + assert!(bad_sub.is_err()); + assert!(format!("{bad_sub:?}").contains("line 1: Annotation missing ':'")); + + let bad_mark = read_config(&b"!mark foo"[..]); + assert!(bad_mark.is_err()); + assert!(format!("{bad_mark:?}").contains("line 1: Mark missing ':'")); } #[test] @@ -554,10 +692,43 @@ mod tests { ); } + #[test] + fn test_column_header_labels() { + let mut cfg = Config::default(); + + assert!(column_header_labels(&cfg, &["foo".to_owned()]).eq([Some(&"foo".to_owned())])); + + cfg.static_columns.push(Some("bar".to_owned())); + assert!(column_header_labels(&cfg, &["foo".to_owned()]) + .eq([Some(&"bar".to_owned()), Some(&"foo".to_owned())])); + + cfg.static_columns.push(None); + assert!(column_header_labels(&cfg, &["foo".to_owned()]).eq([ + Some(&"bar".to_owned()), + None, + Some(&"foo".to_owned()) + ])); + + cfg.substitute_labels + .insert("foo".to_owned(), "foo (bits)".to_owned()); + assert!(column_header_labels(&cfg, &["foo".to_owned()]).eq([ + Some(&"bar".to_owned()), + None, + Some(&"foo (bits)".to_owned()) + ])); + + cfg.hidden_columns.insert("foo".to_owned()); + assert!(column_header_labels(&cfg, &["foo".to_owned()]).eq([Some(&"bar".to_owned()), None])); + + cfg.hidden_columns.insert("bar".to_owned()); + assert!(column_header_labels(&cfg, &["foo".to_owned()]).eq([None])); + } + #[test] fn test_render_cell() { assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -565,11 +736,12 @@ mod tests { } ), HTML::from( - r#""# + r#""# ) ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -577,11 +749,12 @@ mod tests { } ), HTML::from( - r#""# + r#""# ) ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -589,11 +762,12 @@ mod tests { } ), HTML::from( - r#""# + r#"𝍷"# ) ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -601,11 +775,12 @@ mod tests { } ), HTML::from( - r#"2"# + r#"𝍷𝍷"# ) ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -621,6 +796,7 @@ mod tests { ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -628,11 +804,25 @@ mod tests { } ), HTML::from( - r#"5 ✓"# + r#"5 𝍷"# + ) + ); + assert_eq!( + render_cell( + &Config::default(), + "foo", + &mut Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![Some("×".to_owned())])]), + } + ), + HTML::from( + r#"×"# ) ); assert_eq!( render_cell( + &Config::default(), "heart", &mut Row { label: "nope".to_owned(), @@ -645,6 +835,7 @@ mod tests { ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "bob's".to_owned(), @@ -652,9 +843,29 @@ mod tests { } ), HTML::from( - r#""# + r#"𝍷"# ) ); + assert_eq!( + render_cell( + &Config { + column_threshold: 2, + static_columns: vec![], + hidden_columns: HashSet::new(), + substitute_labels: HashMap::new(), + mark: HashMap::from([("foo".to_owned(), "🦄".to_owned())]), + }, + "foo", + &mut Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![None])]), + } + ), + HTML::from( + r#"🦄"# + ) + ); + let mut r = Row { label: "nope".to_owned(), entries: HashMap::from([ @@ -663,42 +874,83 @@ mod tests { ]), }; assert_eq!(r.entries.len(), 2); - render_cell("foo", &mut r); + render_cell(&Config::default(), "foo", &mut r); assert_eq!(r.entries.len(), 1); - render_cell("bar", &mut r); + render_cell(&Config::default(), "bar", &mut r); assert_eq!(r.entries.len(), 1); - render_cell("baz", &mut r); + render_cell(&Config::default(), "baz", &mut r); assert_eq!(r.entries.len(), 0); } #[test] fn test_render_leftovers() { assert_eq!( - render_all_leftovers(&Row { - label: "nope".to_owned(), - entries: HashMap::from([("foo".to_owned(), vec![None])]), - }), + render_all_leftovers( + &Config::default(), + &Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![None])]), + } + ), HTML::from("foo") ); assert_eq!( - render_all_leftovers(&Row { - label: "nope".to_owned(), - entries: HashMap::from([ - ("foo".to_owned(), vec![None]), - ("bar".to_owned(), vec![None]) - ]), - }), + render_all_leftovers( + &Config::default(), + &Row { + label: "nope".to_owned(), + entries: HashMap::from([ + ("foo".to_owned(), vec![None]), + ("bar".to_owned(), vec![None]) + ]), + } + ), HTML::from("bar, foo") ); assert_eq!( - render_all_leftovers(&Row { - label: "nope".to_owned(), - entries: HashMap::from([ - ("foo".to_owned(), vec![None]), - ("bar".to_owned(), vec![None, None]) - ]), - }), - HTML::from("bar: 2, foo") + render_all_leftovers( + &Config::default(), + &Row { + label: "nope".to_owned(), + entries: HashMap::from([ + ("foo".to_owned(), vec![None]), + ("bar".to_owned(), vec![None, None]) + ]), + } + ), + HTML::from("bar: 𝍷𝍷, foo") + ); + assert_eq!( + render_all_leftovers( + &Config { + column_threshold: 2, + static_columns: vec![], + hidden_columns: HashSet::from(["private".to_owned()]), + substitute_labels: HashMap::new(), + mark: HashMap::new(), + }, + &Row { + label: "nope".to_owned(), + entries: HashMap::from([("private".to_owned(), vec![None]),]), + } + ), + HTML::from("") + ); + assert_eq!( + render_all_leftovers( + &Config { + column_threshold: 2, + static_columns: vec![], + hidden_columns: HashSet::new(), + substitute_labels: HashMap::new(), + mark: HashMap::from([("foo".to_owned(), "🌈".to_owned())]), + }, + &Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![None, None])]), + } + ), + HTML::from("foo: 🌈🌈") ); } @@ -706,10 +958,7 @@ mod tests { fn test_render_row() { assert_eq!( render_row( - &Config { - column_threshold: 0, - static_columns: vec![], - }, + &Config::default(), &["foo".to_owned()], &mut Rowlike::Row(Row { label: "nope".to_owned(), @@ -717,7 +966,7 @@ mod tests { }) ), HTML::from( - r#"nopebar + r#"nopebar "# ) ); @@ -725,7 +974,10 @@ mod tests { render_row( &Config { column_threshold: 0, - static_columns: vec!["foo".to_owned(), "bar".to_owned()], + static_columns: vec![Some("foo".to_owned()), Some("bar".to_owned())], + hidden_columns: HashSet::new(), + substitute_labels: HashMap::new(), + mark: HashMap::new(), }, &["baz".to_owned()], &mut Rowlike::Row(Row { @@ -739,6 +991,89 @@ mod tests { ), HTML::from( r#"nopefrz +"# + ) + ); + assert_eq!( + render_row( + &Config { + column_threshold: 0, + static_columns: vec![Some("foo".to_owned()), None, Some("bar".to_owned())], + hidden_columns: HashSet::new(), + substitute_labels: HashMap::new(), + mark: HashMap::new(), + }, + &[], + &mut Rowlike::Row(Row { + label: "nope".to_owned(), + entries: HashMap::from([ + ("bar".to_owned(), vec![Some("r".to_owned())]), + ("foo".to_owned(), vec![Some("f".to_owned())]), + ]), + }) + ), + HTML::from( + r#"nopefr +"# + ) + ); + assert_eq!( + render_row( + &Config { + column_threshold: 0, + static_columns: vec![], + hidden_columns: HashSet::from(["foo".to_owned()]), + substitute_labels: HashMap::new(), + mark: HashMap::new(), + }, + &[], + &mut Rowlike::Row(Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![Some("f".to_owned())]),]), + }) + ), + HTML::from( + r#"nope +"# + ) + ); + assert_eq!( + render_row( + &Config { + column_threshold: 0, + static_columns: vec![Some("foo".to_owned())], + hidden_columns: HashSet::from(["foo".to_owned()]), + substitute_labels: HashMap::new(), + mark: HashMap::new(), + }, + &[], + &mut Rowlike::Row(Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![Some("f".to_owned())]),]), + }) + ), + HTML::from( + r#"nope +"# + ) + ); + assert_eq!( + render_row( + &Config { + column_threshold: 0, + static_columns: vec![], + hidden_columns: HashSet::new(), + substitute_labels: HashMap::from([("foo".to_owned(), "bar".to_owned())]), + mark: HashMap::new(), + }, + &["foo".to_owned()], + &mut Rowlike::Row(Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![None])]), + }) + ), + HTML::from( + r#"nope𝍷 "# ) );