]> git.scottworley.com Git - tablify/blobdiff - src/lib.rs
Clippy wants this to use mut and write!
[tablify] / src / lib.rs
index 72a3add0ef2f9edccc34cc6f39b9ce8df9f79b56..a3878c56f879436aedd0d18220a60a076e3ffa7c 100644 (file)
@@ -1,22 +1,81 @@
-#[cfg(test)]
+use std::collections::{HashMap, HashSet};
+use std::fmt::Write;
 use std::io::BufRead;
-#[cfg(test)]
 use std::iter::Iterator;
 
+const HEADER: &str = "<!DOCTYPE html>
+<html>
+<head>
+  <meta charset=\"utf-8\">
+  <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">
+  <style>
+    /* 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; }
+    table { border-collapse: collapse }
+    tr.key > th { height: 8em; 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.numeric { text-align: right; }
+    td.yes { border: thin solid gray; background-color: gray; }
+    td.spacer { border: none; }
+    /* 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; }
+    img { height: 1.2em; }
+  </style>
+  <script>
+    function highlight(id)       { const e = document.getElementById(id); if (e) { e.classList.add(   \"highlight\"); } }
+    function clear_highlight(id) { const e = document.getElementById(id); if (e) { e.classList.remove(\"highlight\"); } }
+    function h2(a, b)  {       highlight(a);       highlight(b); }
+    function ch2(a, b) { clear_highlight(a); clear_highlight(b); }
+  </script>
+</head>
+<body>
+  <table>
+    <tbody>
+";
+const FOOTER: &str = "    </tbody>
+  </table>
+</body>
+</html>";
+
+#[derive(Debug, PartialEq, Eq, Hash)]
+struct Entry {
+    col: String,
+    instance: Option<String>,
+}
+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())),
+            },
+        }
+    }
+}
+
 #[derive(Debug, PartialEq, Eq)]
 struct RowInput {
     label: String,
-    entries: Vec<String>,
+    entries: Vec<Entry>,
 }
 
 struct Reader<Input: Iterator<Item = Result<String, std::io::Error>>> {
-    input: Input,
+    input: std::iter::Enumerate<Input>,
     row: Option<RowInput>,
 }
 impl<Input: Iterator<Item = Result<String, std::io::Error>>> Reader<Input> {
-    #[cfg(test)]
     fn new(input: Input) -> Self {
-        Self { input, row: None }
+        Self {
+            input: input.enumerate(),
+            row: None,
+        }
     }
 }
 impl<Input: Iterator<Item = Result<String, std::io::Error>>> Iterator for Reader<Input> {
@@ -26,19 +85,24 @@ impl<Input: Iterator<Item = Result<String, std::io::Error>>> Iterator for Reader
             match self
                 .input
                 .next()
-                .map(|r| r.map(|line| String::from(line.trim_end())))
+                .map(|(n, r)| (n, r.map(|line| String::from(line.trim_end()))))
             {
                 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() => {
+                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(Ok(line)) if line.starts_with(' ') => match &mut self.row {
-                    None => return Some(Err(std::io::Error::other("Entry with no header"))),
-                    Some(ref mut row) => row.entries.push(String::from(line.trim())),
+                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(ref mut row) => row.entries.push(Entry::from(line.trim())),
                 },
-                Some(Ok(line)) => {
+                Some((_, Ok(line))) => {
                     let prev = std::mem::take(&mut self.row);
                     self.row = Some(RowInput {
                         label: line,
@@ -53,19 +117,134 @@ impl<Input: Iterator<Item = Result<String, std::io::Error>>> Iterator for Reader
     }
 }
 
-#[cfg(test)]
 fn read_rows(input: impl std::io::Read) -> impl Iterator<Item = Result<RowInput, std::io::Error>> {
     Reader::new(std::io::BufReader::new(input).lines())
 }
 
-pub fn tablify(_input: &impl std::io::Read) -> String {
-    String::from("Hello, world!")
+fn column_counts(rows: &[RowInput]) -> Vec<(usize, String)> {
+    let mut counts: Vec<_> = rows
+        .iter()
+        .flat_map(|r| {
+            r.entries
+                .iter()
+                .map(|e| &e.col)
+                .collect::<HashSet<_>>()
+                .into_iter()
+        })
+        .fold(HashMap::new(), |mut cs, col| {
+            cs.entry(String::from(col))
+                .and_modify(|n| *n += 1)
+                .or_insert(1);
+            cs
+        })
+        .into_iter()
+        .map(|(col, n)| (n, col))
+        .collect();
+    counts.sort();
+    counts
+}
+fn column_order(rows: &[RowInput]) -> Vec<String> {
+    column_counts(rows)
+        .into_iter()
+        .map(|(_, col)| col)
+        .collect()
+}
+
+fn render_instance(entry: &Entry) -> String {
+    match &entry.instance {
+        None => String::from("✓ "),
+        Some(instance) => String::from(instance) + " ",
+    }
+}
+
+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()
+    } else if all_empty {
+        format!("{}", entries.len())
+    } else {
+        entries
+            .iter()
+            .map(|i| render_instance(i))
+            .collect::<String>()
+    };
+    format!("<td class=\"{class}\">{}</td>", contents.trim())
+}
+
+fn render_row(columns: &[String], row: &RowInput) -> String {
+    // This is O(n^2) & doesn't need to be
+    // TODO: Escape HTML special characters
+    format!(
+        "<tr><th>{}</th>{}</tr>\n",
+        row.label,
+        &columns
+            .iter()
+            .map(|col| render_cell(col, row))
+            .collect::<String>()
+    )
+}
+
+fn render_column_headers(columns: &[String]) -> String {
+    // TODO: Escape HTML special characters
+    String::from("<th></th>")
+        + &columns.iter().fold(String::new(), |mut acc, c| {
+            write!(&mut acc, "<th>{c}</th>").unwrap();
+            acc
+        })
+        + "\n"
+}
+
+/// # Errors
+///
+/// Will return `Err` if
+///   * 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<String, std::io::Error> {
+    let rows = read_rows(input).collect::<Result<Vec<_>, _>>()?;
+    let columns = column_order(&rows);
+    Ok(String::from(HEADER)
+        + &render_column_headers(&columns)
+        + &rows
+            .into_iter()
+            .map(|r| render_row(&columns, &r))
+            .collect::<String>()
+        + FOOTER)
 }
 
 #[cfg(test)]
 mod tests {
     use super::*;
 
+    #[test]
+    fn test_parse_entry() {
+        assert_eq!(
+            Entry::from("foo"),
+            Entry {
+                col: String::from("foo"),
+                instance: None
+            }
+        );
+        assert_eq!(
+            Entry::from("foo:bar"),
+            Entry {
+                col: String::from("foo"),
+                instance: Some(String::from("bar"))
+            }
+        );
+        assert_eq!(
+            Entry::from("foo: bar"),
+            Entry {
+                col: String::from("foo"),
+                instance: Some(String::from("bar"))
+            }
+        );
+    }
+
     #[test]
     fn test_read_rows() {
         assert_eq!(
@@ -99,7 +278,7 @@ mod tests {
             read_rows(&b"foo\n bar\n"[..]).flatten().collect::<Vec<_>>(),
             vec![RowInput {
                 label: String::from("foo"),
-                entries: vec![String::from("bar")]
+                entries: vec![Entry::from("bar")]
             }]
         );
         assert_eq!(
@@ -108,7 +287,7 @@ mod tests {
                 .collect::<Vec<_>>(),
             vec![RowInput {
                 label: String::from("foo"),
-                entries: vec![String::from("bar"), String::from("baz")]
+                entries: vec![Entry::from("bar"), Entry::from("baz")]
             }]
         );
         assert_eq!(
@@ -147,16 +326,116 @@ mod tests {
                 .collect::<Vec<_>>(),
             vec![RowInput {
                 label: String::from("foo"),
-                entries: vec![String::from("bar")]
+                entries: vec![Entry::from("bar")]
             }]
         );
 
         let bad = read_rows(&b" foo"[..]).next().unwrap();
         assert!(bad.is_err());
-        assert!(format!("{bad:?}").contains("Entry with no header"));
+        assert!(format!("{bad:?}").contains("1: Entry with no header"));
 
         let bad2 = read_rows(&b"foo\n\n bar"[..]).nth(1).unwrap();
         assert!(bad2.is_err());
-        assert!(format!("{bad2:?}").contains("Entry with no header"));
+        assert!(format!("{bad2:?}").contains("3: Entry with no header"));
+    }
+
+    #[test]
+    fn test_column_counts() {
+        assert_eq!(
+            column_counts(
+                &read_rows(&b"foo\n bar\n baz\n"[..])
+                    .collect::<Result<Vec<_>, _>>()
+                    .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::<Result<Vec<_>, _>>()
+                    .unwrap()
+            ),
+            vec![(1, String::from("bar")), (2, String::from("baz"))]
+        );
+        assert_eq!(
+            column_counts(
+                &read_rows(&b"foo\n bar\n bar\n baz\n bar\nquux\n baz"[..])
+                    .collect::<Result<Vec<_>, _>>()
+                    .unwrap()
+            ),
+            vec![(1, String::from("bar")), (2, String::from("baz"))]
+        );
+        assert_eq!(
+            column_counts(
+                &read_rows(&b"foo\n bar: 1\n bar: 2\n baz\n bar\nquux\n baz"[..])
+                    .collect::<Result<Vec<_>, _>>()
+                    .unwrap()
+            ),
+            vec![(1, String::from("bar")), (2, String::from("baz"))]
+        );
+    }
+
+    #[test]
+    fn test_render_cell() {
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![]
+                }
+            ),
+            String::from("<td class=\"\"></td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("bar")]
+                }
+            ),
+            String::from("<td class=\"\"></td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("foo")]
+                }
+            ),
+            String::from("<td class=\"yes\"></td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("foo"), Entry::from("foo")]
+                }
+            ),
+            String::from("<td class=\"yes\">2</td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("foo: 5"), Entry::from("foo: 10")]
+                }
+            ),
+            String::from("<td class=\"yes\">5 10</td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("foo: 5"), Entry::from("foo")]
+                }
+            ),
+            String::from("<td class=\"yes\">5 ✓</td>")
+        );
     }
 }