X-Git-Url: http://git.scottworley.com/tablify/blobdiff_plain/586b332ada9b821cbc7838ffa9151c9886387918..61a7497779d8e9a7d7b73a53c55d252177d68e1c:/src/lib.rs?ds=inline diff --git a/src/lib.rs b/src/lib.rs index 5c994c9..c1a4761 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,11 +1,67 @@ use std::borrow::ToOwned; -use std::collections::HashMap; +use std::collections::{HashMap, HashSet}; use std::fmt::Write; use std::io::BufRead; use std::iter::Iterator; -pub struct Config { - pub column_threshold: usize, +fn tally_marks(n: usize) -> String { + let fives = { 0..n / 5 }.map(|_| '𝍸'); + let ones = { 0..n % 5 }.map(|_| '𝍷'); + fives.chain(ones).collect() +} + +#[derive(PartialEq, Eq, Debug)] +struct Config { + column_threshold: usize, + static_columns: Vec>, + hidden_columns: HashSet, + substitute_labels: HashMap, +} +impl Config { + 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, + 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(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 { + return Err(std::io::Error::new( + std::io::ErrorKind::InvalidInput, + 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(), + } + } } const HEADER: &str = r#" @@ -19,6 +75,7 @@ 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; } @@ -87,12 +144,15 @@ enum InputLine<'a> { Blank, RowHeader(&'a str), Entry(&'a str, Option<&'a str>), + Command(&'a str), } impl<'a> From<&'a str> for InputLine<'a> { fn from(value: &'a str) -> InputLine<'a> { let trimmed = value.trim_end(); if trimmed.is_empty() { InputLine::Blank + } else if let Some(cmd) = trimmed.strip_prefix('!') { + InputLine::Command(cmd) } else if !trimmed.starts_with(' ') { InputLine::RowHeader(value.trim()) } else { @@ -116,19 +176,23 @@ enum Rowlike { Spacer, } -struct Reader>> { +struct Reader<'cfg, Input: Iterator>> { input: std::iter::Enumerate, row: Option, + config: &'cfg mut Config, } -impl>> Reader { - fn new(input: Input) -> Self { +impl<'cfg, Input: Iterator>> Reader<'cfg, Input> { + fn new(config: &'cfg mut Config, input: Input) -> Self { Self { input: input.enumerate(), row: None, + config, } } } -impl>> Iterator for Reader { +impl<'cfg, Input: Iterator>> Iterator + for Reader<'cfg, Input> +{ type Item = Result; fn next(&mut self) -> Option { loop { @@ -136,6 +200,11 @@ impl>> Iterator for Reader None => return Ok(std::mem::take(&mut self.row).map(Rowlike::Row)).transpose(), 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(n + 1, cmd) { + return Some(Err(e)); + } + } InputLine::Blank if self.row.is_some() => { return Ok(std::mem::take(&mut self.row).map(Rowlike::Row)).transpose() } @@ -143,7 +212,7 @@ impl>> Iterator for Reader 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 )))) } @@ -171,12 +240,11 @@ impl>> Iterator for Reader } fn read_input(input: impl std::io::Read) -> Result<(Vec, Config), std::io::Error> { - let default_config = Config { - column_threshold: 2, - }; - Reader::new(std::io::BufReader::new(input).lines()) + let mut config = Config::default(); + let reader = Reader::new(&mut config, std::io::BufReader::new(input).lines()); + reader .collect::, _>>() - .map(|rows| (rows, default_config)) + .map(|rows| (rows, config)) } fn column_counts(rows: &[Rowlike]) -> Vec<(usize, String)> { @@ -200,64 +268,92 @@ fn column_counts(rows: &[Rowlike]) -> Vec<(usize, String)> { counts } 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).then_some(col)) + .filter_map(|(n, 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]) -> 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(" "), - ) + 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))); + tally = 0; + } + out.push(HTML::escape(content)); + } + } + } + if tally > 0 { + out.push(HTML(tally_marks(tally))); } + 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), }; row.entries.remove(col); HTML(format!( - r#"{contents}"# + r#"{contents}"# )) } fn render_leftover(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); 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 @@ -269,32 +365,64 @@ fn render_all_leftovers(row: &Row) -> HTML { ) } -fn render_row(columns: &[String], rowlike: &mut Rowlike) -> HTML { +fn render_row(config: &Config, columns: &[String], rowlike: &mut Rowlike) -> HTML { match rowlike { Rowlike::Spacer => HTML::from("\n"), Rowlike::Row(row) => { let row_label = HTML::escape(row.label.as_ref()); - let cells = columns + 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 leftovers = render_all_leftovers(row); + let dynamic_cells = columns + .iter() + .filter(|&col| !config.hidden_columns.contains(col)) + .map(|col| render_cell(config, col, row)) + .collect::(); + let leftovers = render_all_leftovers(config, row); HTML(format!( - "{row_label}{cells}{leftovers}\n" + "{row_label}{static_cells}{dynamic_cells}{leftovers}\n" )) } } } -fn render_column_headers(columns: &[String]) -> HTML { +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#""#) - + &columns.iter().fold(String::new(), |mut acc, col| { - let col_header = HTML::escape(col.as_ref()); - write!( - &mut acc, - r#"
{col_header}
"# - ) + + &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 }) @@ -313,9 +441,9 @@ pub fn tablify(input: impl std::io::Read) -> Result { let columns = column_order(&config, &rows); Ok(HTML(format!( "{HEADER}{}{}{FOOTER}", - render_column_headers(&columns), + render_column_headers(&config, &columns), rows.into_iter() - .map(|mut r| render_row(&columns, &mut r)) + .map(|mut r| render_row(&config, &columns, &mut r)) .collect::() ))) } @@ -353,9 +481,27 @@ mod tests { ); } + #[test] + fn test_tally_marks() { + assert_eq!(tally_marks(1), "𝍷"); + assert_eq!(tally_marks(2), "𝍷𝍷"); + assert_eq!(tally_marks(3), "𝍷𝍷𝍷"); + assert_eq!(tally_marks(4), "𝍷𝍷𝍷𝍷"); + assert_eq!(tally_marks(5), "𝍸"); + assert_eq!(tally_marks(6), "𝍸𝍷"); + assert_eq!(tally_marks(7), "𝍸𝍷𝍷"); + assert_eq!(tally_marks(8), "𝍸𝍷𝍷𝍷"); + assert_eq!(tally_marks(9), "𝍸𝍷𝍷𝍷𝍷"); + assert_eq!(tally_marks(10), "𝍸𝍸"); + assert_eq!(tally_marks(11), "𝍸𝍸𝍷"); + } + fn read_rows(input: impl std::io::Read) -> Result, std::io::Error> { read_input(input).map(|(rows, _)| rows) } + fn read_config(input: impl std::io::Read) -> Result { + read_input(input).map(|(_, config)| config) + } #[test] fn test_read_rows() { assert_eq!( @@ -452,11 +598,43 @@ 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] + fn test_read_config() { + assert_eq!( + read_config(&b"!col_threshold 10"[..]) + .unwrap() + .column_threshold, + 10 + ); + assert_eq!( + read_config(&b"!col foo"[..]).unwrap().static_columns, + vec![Some("foo".to_owned())] + ); + assert_eq!( + read_config(&b"!label foo:bar"[..]) + .unwrap() + .substitute_labels["foo"], + "bar" + ); + + let bad_command = read_config(&b"!no such command"[..]); + assert!(bad_command.is_err()); + 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("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 ':'")); } #[test] @@ -481,10 +659,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(), @@ -492,11 +703,12 @@ mod tests { } ), HTML::from( - r#""# + r#""# ) ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -504,11 +716,12 @@ mod tests { } ), HTML::from( - r#""# + r#""# ) ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -516,11 +729,12 @@ mod tests { } ), HTML::from( - r#""# + r#"𝍷"# ) ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -528,11 +742,12 @@ mod tests { } ), HTML::from( - r#"2"# + r#"𝍷𝍷"# ) ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -548,6 +763,7 @@ mod tests { ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "nope".to_owned(), @@ -555,11 +771,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(), @@ -572,6 +802,7 @@ mod tests { ); assert_eq!( render_cell( + &Config::default(), "foo", &mut Row { label: "bob's".to_owned(), @@ -579,7 +810,7 @@ mod tests { } ), HTML::from( - r#""# + r#"𝍷"# ) ); let mut r = Row { @@ -590,42 +821,66 @@ 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(), + }, + &Row { + label: "nope".to_owned(), + entries: HashMap::from([("private".to_owned(), vec![None]),]), + } + ), + HTML::from("") ); } @@ -633,6 +888,7 @@ mod tests { fn test_render_row() { assert_eq!( render_row( + &Config::default(), &["foo".to_owned()], &mut Rowlike::Row(Row { label: "nope".to_owned(), @@ -640,7 +896,109 @@ mod tests { }) ), HTML::from( - r#"nopebar + r#"nopebar +"# + ) + ); + assert_eq!( + render_row( + &Config { + column_threshold: 0, + static_columns: vec![Some("foo".to_owned()), Some("bar".to_owned())], + hidden_columns: HashSet::new(), + substitute_labels: HashMap::new(), + }, + &["baz".to_owned()], + &mut Rowlike::Row(Row { + label: "nope".to_owned(), + entries: HashMap::from([ + ("bar".to_owned(), vec![Some("r".to_owned())]), + ("baz".to_owned(), vec![Some("z".to_owned())]), + ("foo".to_owned(), vec![Some("f".to_owned())]), + ]), + }) + ), + 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(), + }, + &[], + &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(), + }, + &[], + &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(), + }, + &[], + &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())]), + }, + &["foo".to_owned()], + &mut Rowlike::Row(Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![None])]), + }) + ), + HTML::from( + r#"nope𝍷 "# ) );