X-Git-Url: http://git.scottworley.com/tablify/blobdiff_plain/36bc3a39ef440cc1af77d7d88844cacbe6b4387d..a638dfe78611c069402096f0c702c3f51648962c:/src/lib.rs?ds=sidebyside diff --git a/src/lib.rs b/src/lib.rs index cbe9ae9..b4b8bbc 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,11 +1,47 @@ 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, +#[derive(PartialEq, Eq, Debug)] +struct Config { + column_threshold: usize, + static_columns: Vec>, + hidden_columns: HashSet, +} +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 { + 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(), + } + } } const HEADER: &str = r#" @@ -18,6 +54,8 @@ const HEADER: &str = r#" /* h/t https://wabain.github.io/2019/10/13/css-rotated-table-header.html */ 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; } @@ -86,12 +124,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 { @@ -109,34 +150,49 @@ struct Row { entries: HashMap>>, } -struct Reader>> { +#[derive(Debug, PartialEq, Eq)] +enum Rowlike { + Row(Row), + Spacer, +} + +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 { - type Item = Result; +impl<'cfg, Input: Iterator>> Iterator + for Reader<'cfg, Input> +{ + type Item = Result; fn next(&mut self) -> Option { loop { match self.input.next() { - None => return Ok(std::mem::take(&mut self.row)).transpose(), + 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)).transpose() + return Ok(std::mem::take(&mut self.row).map(Rowlike::Row)).transpose() } - InputLine::Blank => {} + InputLine::Blank => return Some(Ok(Rowlike::Spacer)), 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 )))) } @@ -154,7 +210,7 @@ impl>> Iterator for Reader entries: HashMap::new(), }); if prev.is_some() { - return Ok(prev).transpose(); + return Ok(prev.map(Rowlike::Row)).transpose(); } } }, @@ -163,14 +219,22 @@ impl>> Iterator for Reader } } -fn read_rows(input: impl std::io::Read) -> impl Iterator> { - Reader::new(std::io::BufReader::new(input).lines()) +fn read_input(input: impl std::io::Read) -> Result<(Vec, Config), std::io::Error> { + let mut config = Config::default(); + let reader = Reader::new(&mut config, std::io::BufReader::new(input).lines()); + reader + .collect::, _>>() + .map(|rows| (rows, config)) } -fn column_counts(rows: &[Row]) -> Vec<(usize, String)> { +fn column_counts(rows: &[Rowlike]) -> Vec<(usize, String)> { + let empty = HashMap::new(); let mut counts: Vec<_> = rows .iter() - .flat_map(|r| r.entries.keys()) + .flat_map(|rl| match rl { + Rowlike::Row(r) => r.entries.keys(), + Rowlike::Spacer => empty.keys(), + }) .fold(HashMap::new(), |mut cs, col| { cs.entry(col.to_owned()) .and_modify(|n| *n += 1) @@ -183,10 +247,21 @@ fn column_counts(rows: &[Row]) -> Vec<(usize, String)> { counts.sort_unstable_by(|(an, acol), (bn, bcol)| bn.cmp(an).then(acol.cmp(bcol))); counts } -fn column_order(config: &Config, rows: &[Row]) -> Vec { +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() } @@ -240,8 +315,12 @@ fn render_leftover(notcol: &str, instances: &[Option]) -> HTML { } } -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 @@ -253,27 +332,58 @@ fn render_all_leftovers(row: &Row) -> HTML { ) } -fn render_row(columns: &[String], row: &mut Row) -> HTML { - let row_label = HTML::escape(row.label.as_ref()); - let cells = columns - .iter() - .map(|col| render_cell(col, row)) - .collect::(); - let leftovers = render_all_leftovers(row); - HTML(format!( - "{row_label}{cells}{leftovers}\n" - )) +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 static_cells = config + .static_columns + .iter() + .map(|ocol| match ocol { + Some(col) if config.hidden_columns.contains(col) => HTML::from(""), + Some(col) => render_cell(col, row), + None => HTML::from(r#""#), + }) + .collect::(); + let dynamic_cells = columns + .iter() + .filter(|&col| !config.hidden_columns.contains(col)) + .map(|col| render_cell(col, row)) + .collect::(); + let leftovers = render_all_leftovers(config, row); + HTML(format!( + "{row_label}{static_cells}{dynamic_cells}{leftovers}\n" + )) + } + } +} + +fn column_header_order<'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)) + }) } -fn render_column_headers(columns: &[String]) -> HTML { +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_order(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 }) @@ -287,14 +397,14 @@ fn render_column_headers(columns: &[String]) -> HTML { /// * there's an i/o error while reading `input` /// * the log has invalid syntax: /// * an indented line with no preceding non-indented line -pub fn tablify(config: &Config, input: impl std::io::Read) -> Result { - let rows = read_rows(input).collect::, _>>()?; - let columns = column_order(config, &rows); +pub fn tablify(input: impl std::io::Read) -> Result { + let (rows, config) = read_input(input)?; + 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::() ))) } @@ -332,139 +442,183 @@ mod tests { ); } + 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!( - read_rows(&b"foo"[..]).flatten().collect::>(), - vec![Row { + read_rows(&b"foo"[..]).unwrap(), + vec![Rowlike::Row(Row { label: "foo".to_owned(), entries: HashMap::new(), - }] + })] ); assert_eq!( - read_rows(&b"bar"[..]).flatten().collect::>(), - vec![Row { + read_rows(&b"bar"[..]).unwrap(), + vec![Rowlike::Row(Row { label: "bar".to_owned(), entries: HashMap::new(), - }] + })] ); assert_eq!( - read_rows(&b"foo\nbar\n"[..]).flatten().collect::>(), + read_rows(&b"foo\nbar\n"[..]).unwrap(), vec![ - Row { + Rowlike::Row(Row { label: "foo".to_owned(), entries: HashMap::new(), - }, - Row { + }), + Rowlike::Row(Row { label: "bar".to_owned(), entries: HashMap::new(), - } + }) ] ); assert_eq!( - read_rows(&b"foo\n bar\n"[..]).flatten().collect::>(), - vec![Row { + read_rows(&b"foo\n bar\n"[..]).unwrap(), + vec![Rowlike::Row(Row { label: "foo".to_owned(), entries: HashMap::from([("bar".to_owned(), vec![None])]), - }] + })] ); assert_eq!( - read_rows(&b"foo\n bar\n baz\n"[..]) - .flatten() - .collect::>(), - vec![Row { + read_rows(&b"foo\n bar\n baz\n"[..]).unwrap(), + vec![Rowlike::Row(Row { label: "foo".to_owned(), entries: HashMap::from([ ("bar".to_owned(), vec![None]), ("baz".to_owned(), vec![None]) ]), - }] + })] ); assert_eq!( - read_rows(&b"foo\n\nbar\n"[..]) - .flatten() - .collect::>(), + read_rows(&b"foo\n\nbar\n"[..]).unwrap(), vec![ - Row { + Rowlike::Row(Row { label: "foo".to_owned(), entries: HashMap::new(), - }, - Row { + }), + Rowlike::Row(Row { label: "bar".to_owned(), entries: HashMap::new(), - } + }) ] ); assert_eq!( - read_rows(&b"foo\n \nbar\n"[..]) - .flatten() - .collect::>(), + read_rows(&b"foo\n\n\nbar\n"[..]).unwrap(), vec![ - Row { + Rowlike::Row(Row { label: "foo".to_owned(), entries: HashMap::new(), - }, - Row { + }), + Rowlike::Spacer, + Rowlike::Row(Row { label: "bar".to_owned(), entries: HashMap::new(), - } + }) + ] + ); + assert_eq!( + read_rows(&b"foo\n \nbar\n"[..]).unwrap(), + vec![ + Rowlike::Row(Row { + label: "foo".to_owned(), + entries: HashMap::new(), + }), + Rowlike::Row(Row { + label: "bar".to_owned(), + entries: HashMap::new(), + }) ] ); assert_eq!( - read_rows(&b"foo \n bar \n"[..]) - .flatten() - .collect::>(), - vec![Row { + read_rows(&b"foo \n bar \n"[..]).unwrap(), + vec![Rowlike::Row(Row { label: "foo".to_owned(), entries: HashMap::from([("bar".to_owned(), vec![None])]), - }] + })] ); - let bad = read_rows(&b" foo"[..]).next().unwrap(); + 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"[..]).nth(1).unwrap(); + 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())] + ); + + 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")); } #[test] fn test_column_counts() { assert_eq!( - column_counts( - &read_rows(&b"foo\n bar\n baz\n"[..]) - .collect::, _>>() - .unwrap() - ), + column_counts(&read_rows(&b"foo\n bar\n baz\n"[..]).unwrap()), vec![(1, String::from("bar")), (1, String::from("baz"))] ); assert_eq!( - column_counts( - &read_rows(&b"foo\n bar\n baz\nquux\n baz"[..]) - .collect::, _>>() - .unwrap() - ), + column_counts(&read_rows(&b"foo\n bar\n baz\nquux\n baz"[..]).unwrap()), vec![(2, String::from("baz")), (1, String::from("bar"))] ); assert_eq!( - column_counts( - &read_rows(&b"foo\n bar\n bar\n baz\n bar\nquux\n baz"[..]) - .collect::, _>>() - .unwrap() - ), + column_counts(&read_rows(&b"foo\n bar\n bar\n baz\n bar\nquux\n baz"[..]).unwrap()), vec![(2, String::from("baz")), (1, String::from("bar"))] ); assert_eq!( column_counts( - &read_rows(&b"foo\n bar: 1\n bar: 2\n baz\n bar\nquux\n baz"[..]) - .collect::, _>>() - .unwrap() + &read_rows(&b"foo\n bar: 1\n bar: 2\n baz\n bar\nquux\n baz"[..]).unwrap() ), vec![(2, String::from("baz")), (1, String::from("bar"))] ); } + #[test] + fn test_column_header_order() { + let mut cfg = Config::default(); + + assert!(column_header_order(&cfg, &["foo".to_owned()]).eq([Some(&"foo".to_owned())])); + + cfg.static_columns.push(Some("bar".to_owned())); + assert!(column_header_order(&cfg, &["foo".to_owned()]) + .eq([Some(&"bar".to_owned()), Some(&"foo".to_owned())])); + + cfg.static_columns.push(None); + assert!(column_header_order(&cfg, &["foo".to_owned()]).eq([ + Some(&"bar".to_owned()), + None, + Some(&"foo".to_owned()) + ])); + + cfg.hidden_columns.insert("foo".to_owned()); + assert!(column_header_order(&cfg, &["foo".to_owned()]).eq([Some(&"bar".to_owned()), None])); + + cfg.hidden_columns.insert("bar".to_owned()); + assert!(column_header_order(&cfg, &["foo".to_owned()]).eq([None])); + } + #[test] fn test_render_cell() { assert_eq!( @@ -585,46 +739,149 @@ mod tests { #[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]) - ]), - }), + 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: 2, foo") ); + assert_eq!( + render_all_leftovers( + &Config { + column_threshold: 2, + static_columns: vec![], + hidden_columns: HashSet::from(["private".to_owned()]), + }, + &Row { + label: "nope".to_owned(), + entries: HashMap::from([("private".to_owned(), vec![None]),]), + } + ), + HTML::from("") + ); } #[test] fn test_render_row() { assert_eq!( render_row( + &Config::default(), &["foo".to_owned()], - &mut Row { + &mut Rowlike::Row(Row { label: "nope".to_owned(), entries: HashMap::from([("bar".to_owned(), vec![None])]), - } + }) ), HTML::from( 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(), + }, + &["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(), + }, + &[], + &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()]), + }, + &[], + &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()]), + }, + &[], + &mut Rowlike::Row(Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![Some("f".to_owned())]),]), + }) + ), + HTML::from( + r#"nope "# ) );