X-Git-Url: http://git.scottworley.com/tablify/blobdiff_plain/7067975b593ef6a8b639f61dda710b023ec26a25..36bc3a39ef440cc1af77d7d88844cacbe6b4387d:/src/lib.rs diff --git a/src/lib.rs b/src/lib.rs index a3878c5..cbe9ae9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,32 +1,36 @@ -use std::collections::{HashMap, HashSet}; +use std::borrow::ToOwned; +use std::collections::HashMap; use std::fmt::Write; use std::io::BufRead; use std::iter::Iterator; -const HEADER: &str = " +pub struct Config { + pub column_threshold: usize, +} + +const HEADER: &str = r#" - - + + @@ -34,41 +38,80 @@ const HEADER: &str = " -"; +"#; const FOOTER: &str = "
"; -#[derive(Debug, PartialEq, Eq, Hash)] -struct Entry { - col: String, - instance: Option, +#[derive(PartialEq, Eq, Debug)] +pub struct HTML(String); +impl HTML { + fn escape(value: &str) -> HTML { + let mut escaped: String = String::new(); + for c in value.chars() { + match c { + '>' => escaped.push_str(">"), + '<' => escaped.push_str("<"), + '\'' => escaped.push_str("'"), + '"' => escaped.push_str("""), + '&' => escaped.push_str("&"), + ok_c => escaped.push(ok_c), + } + } + HTML(escaped) + } +} +impl From<&str> for HTML { + fn from(value: &str) -> HTML { + HTML(String::from(value)) + } +} +impl FromIterator for HTML { + fn from_iter(iter: T) -> HTML + where + T: IntoIterator, + { + HTML(iter.into_iter().map(|html| html.0).collect::()) + } +} +impl std::fmt::Display for HTML { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.0) + } +} + +#[derive(Debug, PartialEq, Eq)] +enum InputLine<'a> { + Blank, + RowHeader(&'a str), + Entry(&'a str, Option<&'a str>), } -impl From<&str> for Entry { - fn from(value: &str) -> Entry { - match value.split_once(':') { - None => Entry { - col: String::from(value), - instance: None, - }, - Some((col, instance)) => Entry { - col: String::from(col.trim()), - instance: Some(String::from(instance.trim())), - }, +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 !trimmed.starts_with(' ') { + InputLine::RowHeader(value.trim()) + } else { + match value.split_once(':') { + None => InputLine::Entry(value.trim(), None), + Some((col, instance)) => InputLine::Entry(col.trim(), Some(instance.trim())), + } } } } #[derive(Debug, PartialEq, Eq)] -struct RowInput { +struct Row { label: String, - entries: Vec, + entries: HashMap>>, } struct Reader>> { input: std::iter::Enumerate, - row: Option, + row: Option, } impl>> Reader { fn new(input: Input) -> Self { @@ -79,60 +122,57 @@ impl>> Reader { } } impl>> Iterator for Reader { - type Item = Result; + type Item = Result; fn next(&mut self) -> Option { loop { - match self - .input - .next() - .map(|(n, r)| (n, r.map(|line| String::from(line.trim_end())))) - { + match self.input.next() { None => return Ok(std::mem::take(&mut self.row)).transpose(), Some((_, Err(e))) => return Some(Err(e)), - Some((_, Ok(line))) if line.is_empty() && self.row.is_some() => { - return Ok(std::mem::take(&mut self.row)).transpose() - } - Some((_, Ok(line))) if line.is_empty() => {} - Some((n, Ok(line))) if line.starts_with(' ') => match &mut self.row { - None => { - return Some(Err(std::io::Error::other(format!( - "{}: Entry with no header", - n + 1 - )))) + Some((n, Ok(line))) => match InputLine::from(line.as_ref()) { + InputLine::Blank if self.row.is_some() => { + return Ok(std::mem::take(&mut self.row)).transpose() } - Some(ref mut row) => row.entries.push(Entry::from(line.trim())), - }, - Some((_, Ok(line))) => { - let prev = std::mem::take(&mut self.row); - self.row = Some(RowInput { - label: line, - entries: vec![], - }); - if prev.is_some() { - return Ok(prev).transpose(); + InputLine::Blank => {} + InputLine::Entry(col, instance) => match &mut self.row { + None => { + return Some(Err(std::io::Error::other(format!( + "{}: Entry with no header", + n + 1 + )))) + } + Some(ref mut row) => { + row.entries + .entry(col.to_owned()) + .and_modify(|is| is.push(instance.map(ToOwned::to_owned))) + .or_insert_with(|| vec![instance.map(ToOwned::to_owned)]); + } + }, + InputLine::RowHeader(row) => { + let prev = std::mem::take(&mut self.row); + self.row = Some(Row { + label: row.to_owned(), + entries: HashMap::new(), + }); + if prev.is_some() { + return Ok(prev).transpose(); + } } - } + }, } } } } -fn read_rows(input: impl std::io::Read) -> impl Iterator> { +fn read_rows(input: impl std::io::Read) -> impl Iterator> { Reader::new(std::io::BufReader::new(input).lines()) } -fn column_counts(rows: &[RowInput]) -> Vec<(usize, String)> { +fn column_counts(rows: &[Row]) -> Vec<(usize, String)> { let mut counts: Vec<_> = rows .iter() - .flat_map(|r| { - r.entries - .iter() - .map(|e| &e.col) - .collect::>() - .into_iter() - }) + .flat_map(|r| r.entries.keys()) .fold(HashMap::new(), |mut cs, col| { - cs.entry(String::from(col)) + cs.entry(col.to_owned()) .and_modify(|n| *n += 1) .or_insert(1); cs @@ -140,62 +180,105 @@ fn column_counts(rows: &[RowInput]) -> Vec<(usize, String)> { .into_iter() .map(|(col, n)| (n, col)) .collect(); - counts.sort(); + counts.sort_unstable_by(|(an, acol), (bn, bcol)| bn.cmp(an).then(acol.cmp(bcol))); counts } -fn column_order(rows: &[RowInput]) -> Vec { +fn column_order(config: &Config, rows: &[Row]) -> Vec { column_counts(rows) .into_iter() - .map(|(_, col)| col) + .filter_map(|(n, col)| (n >= config.column_threshold).then_some(col)) .collect() } -fn render_instance(entry: &Entry) -> String { - match &entry.instance { - None => String::from("✓ "), - Some(instance) => String::from(instance) + " ", +fn render_one_instance(instance: &Option) -> HTML { + match instance { + None => HTML::from("✓"), + Some(instance) => HTML::escape(instance.as_ref()), } } -fn render_cell(col: &str, row: &RowInput) -> String { - // TODO: Escape HTML special characters - let entries: Vec<&Entry> = row.entries.iter().filter(|e| e.col == col).collect(); - let class = if entries.is_empty() { "" } else { "yes" }; - let all_empty = entries.iter().all(|e| e.instance.is_none()); - let contents = if entries.is_empty() || (all_empty && entries.len() == 1) { - String::new() +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 { - format!("{}", entries.len()) + HTML(format!("{}", instances.len())) } else { - entries - .iter() - .map(|i| render_instance(i)) - .collect::() + HTML( + instances + .iter() + .map(render_one_instance) + .map(|html| html.0) // Waiting for slice_concat_trait to stabilize + .collect::>() + .join(" "), + ) + } +} + +fn render_cell(col: &str, row: &mut Row) -> HTML { + let row_label = HTML::escape(row.label.as_ref()); + let col_label = HTML::escape(col); + let instances: Option<&Vec>> = row.entries.get(col); + let class = HTML::from(if instances.is_none() { "" } else { "yes" }); + let contents = match instances { + None => HTML::from(""), + Some(is) => render_instances(is), }; - format!("{}", contents.trim()) + row.entries.remove(col); + HTML(format!( + r#"{contents}"# + )) } -fn render_row(columns: &[String], row: &RowInput) -> String { - // This is O(n^2) & doesn't need to be - // TODO: Escape HTML special characters - format!( - "{}{}\n", - row.label, - &columns - .iter() - .map(|col| render_cell(col, row)) - .collect::() +fn render_leftover(notcol: &str, instances: &[Option]) -> HTML { + let label = HTML::escape(notcol); + let rest = render_instances(instances); + if rest == HTML::from("") { + HTML(format!("{label}")) + } else { + HTML(format!("{label}: {rest}")) + } +} + +fn render_all_leftovers(row: &Row) -> HTML { + let mut order: Vec<_> = row.entries.keys().collect(); + order.sort_unstable(); + HTML( + order + .into_iter() + .map(|notcol| render_leftover(notcol, row.entries.get(notcol).expect("Key vanished?!"))) + .map(|html| html.0) // Waiting for slice_concat_trait to stabilize + .collect::>() + .join(", "), ) } -fn render_column_headers(columns: &[String]) -> String { - // TODO: Escape HTML special characters - String::from("") - + &columns.iter().fold(String::new(), |mut acc, c| { - write!(&mut acc, "{c}").unwrap(); - acc - }) - + "\n" +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_column_headers(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}
"# + ) + .unwrap(); + acc + }) + + "\n", + ) } /// # Errors @@ -204,16 +287,16 @@ fn render_column_headers(columns: &[String]) -> String { /// * 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(input: impl std::io::Read) -> Result { +pub fn tablify(config: &Config, input: impl std::io::Read) -> Result { let rows = read_rows(input).collect::, _>>()?; - let columns = column_order(&rows); - Ok(String::from(HEADER) - + &render_column_headers(&columns) - + &rows - .into_iter() - .map(|r| render_row(&columns, &r)) - .collect::() - + FOOTER) + let columns = column_order(config, &rows); + Ok(HTML(format!( + "{HEADER}{}{}{FOOTER}", + render_column_headers(&columns), + rows.into_iter() + .map(|mut r| render_row(&columns, &mut r)) + .collect::() + ))) } #[cfg(test)] @@ -221,27 +304,31 @@ mod tests { use super::*; #[test] - fn test_parse_entry() { + fn test_parse_line() { + assert_eq!(InputLine::from(""), InputLine::Blank); + assert_eq!(InputLine::from(" "), InputLine::Blank); + assert_eq!(InputLine::from("foo"), InputLine::RowHeader("foo")); + assert_eq!(InputLine::from("foo "), InputLine::RowHeader("foo")); + assert_eq!(InputLine::from(" foo"), InputLine::Entry("foo", None)); assert_eq!( - Entry::from("foo"), - Entry { - col: String::from("foo"), - instance: None - } + InputLine::from(" foo:bar"), + InputLine::Entry("foo", Some("bar")) ); assert_eq!( - Entry::from("foo:bar"), - Entry { - col: String::from("foo"), - instance: Some(String::from("bar")) - } + InputLine::from(" foo: bar"), + InputLine::Entry("foo", Some("bar")) ); assert_eq!( - Entry::from("foo: bar"), - Entry { - col: String::from("foo"), - instance: Some(String::from("bar")) - } + InputLine::from(" foo: bar "), + InputLine::Entry("foo", Some("bar")) + ); + assert_eq!( + InputLine::from(" foo: bar "), + InputLine::Entry("foo", Some("bar")) + ); + assert_eq!( + InputLine::from(" foo : bar "), + InputLine::Entry("foo", Some("bar")) ); } @@ -249,45 +336,48 @@ mod tests { fn test_read_rows() { assert_eq!( read_rows(&b"foo"[..]).flatten().collect::>(), - vec![RowInput { - label: String::from("foo"), - entries: vec![] + vec![Row { + label: "foo".to_owned(), + entries: HashMap::new(), }] ); assert_eq!( read_rows(&b"bar"[..]).flatten().collect::>(), - vec![RowInput { - label: String::from("bar"), - entries: vec![] + vec![Row { + label: "bar".to_owned(), + entries: HashMap::new(), }] ); assert_eq!( read_rows(&b"foo\nbar\n"[..]).flatten().collect::>(), vec![ - RowInput { - label: String::from("foo"), - entries: vec![] + Row { + label: "foo".to_owned(), + entries: HashMap::new(), }, - RowInput { - label: String::from("bar"), - entries: vec![] + Row { + label: "bar".to_owned(), + entries: HashMap::new(), } ] ); assert_eq!( read_rows(&b"foo\n bar\n"[..]).flatten().collect::>(), - vec![RowInput { - label: String::from("foo"), - entries: vec![Entry::from("bar")] + vec![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![RowInput { - label: String::from("foo"), - entries: vec![Entry::from("bar"), Entry::from("baz")] + vec![Row { + label: "foo".to_owned(), + entries: HashMap::from([ + ("bar".to_owned(), vec![None]), + ("baz".to_owned(), vec![None]) + ]), }] ); assert_eq!( @@ -295,13 +385,13 @@ mod tests { .flatten() .collect::>(), vec![ - RowInput { - label: String::from("foo"), - entries: vec![] + Row { + label: "foo".to_owned(), + entries: HashMap::new(), }, - RowInput { - label: String::from("bar"), - entries: vec![] + Row { + label: "bar".to_owned(), + entries: HashMap::new(), } ] ); @@ -310,13 +400,13 @@ mod tests { .flatten() .collect::>(), vec![ - RowInput { - label: String::from("foo"), - entries: vec![] + Row { + label: "foo".to_owned(), + entries: HashMap::new(), }, - RowInput { - label: String::from("bar"), - entries: vec![] + Row { + label: "bar".to_owned(), + entries: HashMap::new(), } ] ); @@ -324,9 +414,9 @@ mod tests { read_rows(&b"foo \n bar \n"[..]) .flatten() .collect::>(), - vec![RowInput { - label: String::from("foo"), - entries: vec![Entry::from("bar")] + vec![Row { + label: "foo".to_owned(), + entries: HashMap::from([("bar".to_owned(), vec![None])]), }] ); @@ -355,7 +445,7 @@ mod tests { .collect::, _>>() .unwrap() ), - vec![(1, String::from("bar")), (2, String::from("baz"))] + vec![(2, String::from("baz")), (1, String::from("bar"))] ); assert_eq!( column_counts( @@ -363,7 +453,7 @@ mod tests { .collect::, _>>() .unwrap() ), - vec![(1, String::from("bar")), (2, String::from("baz"))] + vec![(2, String::from("baz")), (1, String::from("bar"))] ); assert_eq!( column_counts( @@ -371,7 +461,7 @@ mod tests { .collect::, _>>() .unwrap() ), - vec![(1, String::from("bar")), (2, String::from("baz"))] + vec![(2, String::from("baz")), (1, String::from("bar"))] ); } @@ -380,62 +470,163 @@ mod tests { assert_eq!( render_cell( "foo", - &RowInput { - label: String::from("nope"), - entries: vec![] + &mut Row { + label: "nope".to_owned(), + entries: HashMap::new(), } ), - String::from("") + HTML::from( + r#""# + ) ); assert_eq!( render_cell( "foo", - &RowInput { - label: String::from("nope"), - entries: vec![Entry::from("bar")] + &mut Row { + label: "nope".to_owned(), + entries: HashMap::from([("bar".to_owned(), vec![None])]), } ), - String::from("") + HTML::from( + r#""# + ) ); assert_eq!( render_cell( "foo", - &RowInput { - label: String::from("nope"), - entries: vec![Entry::from("foo")] + &mut Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![None])]), } ), - String::from("") + HTML::from( + r#""# + ) ); assert_eq!( render_cell( "foo", - &RowInput { - label: String::from("nope"), - entries: vec![Entry::from("foo"), Entry::from("foo")] + &mut Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![None, None])]), } ), - String::from("2") + HTML::from( + r#"2"# + ) ); assert_eq!( render_cell( "foo", - &RowInput { - label: String::from("nope"), - entries: vec![Entry::from("foo: 5"), Entry::from("foo: 10")] + &mut Row { + label: "nope".to_owned(), + entries: HashMap::from([( + "foo".to_owned(), + vec![Some("5".to_owned()), Some("10".to_owned())] + )]), } ), - String::from("5 10") + HTML::from( + r#"5 10"# + ) ); assert_eq!( render_cell( "foo", - &RowInput { - label: String::from("nope"), - entries: vec![Entry::from("foo: 5"), Entry::from("foo")] + &mut Row { + label: "nope".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![Some("5".to_owned()), None])]), + } + ), + HTML::from( + r#"5 ✓"# + ) + ); + assert_eq!( + render_cell( + "heart", + &mut Row { + label: "nope".to_owned(), + entries: HashMap::from([("heart".to_owned(), vec![Some("<3".to_owned())])]), + } + ), + HTML::from( + r#"<3"# + ) + ); + assert_eq!( + render_cell( + "foo", + &mut Row { + label: "bob's".to_owned(), + entries: HashMap::from([("foo".to_owned(), vec![None])]), + } + ), + HTML::from( + r#""# + ) + ); + let mut r = Row { + label: "nope".to_owned(), + entries: HashMap::from([ + ("foo".to_owned(), vec![None]), + ("baz".to_owned(), vec![None]), + ]), + }; + assert_eq!(r.entries.len(), 2); + render_cell("foo", &mut r); + assert_eq!(r.entries.len(), 1); + render_cell("bar", &mut r); + assert_eq!(r.entries.len(), 1); + render_cell("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])]), + }), + 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]) + ]), + }), + 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") + ); + } + + #[test] + fn test_render_row() { + assert_eq!( + render_row( + &["foo".to_owned()], + &mut Row { + label: "nope".to_owned(), + entries: HashMap::from([("bar".to_owned(), vec![None])]), } ), - String::from("5 ✓") + HTML::from( + r#"nopebar +"# + ) ); } }