]> git.scottworley.com Git - tablify/blobdiff - src/lib.rs
projects / tablify / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Escape HTML characters properly
[tablify] / src / lib.rs
diff --git a/src/lib.rs b/src/lib.rs
index 0e2007d389f178fa37255d5ff9e47a4861916420..370eb5ddd553a80f2cb4ce75c24703bf285e7b91 100644 (file)
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,37 +1,506 @@
-#[cfg(test)]
+use std::collections::{HashMap, HashSet};
+use std::fmt::Write;
+use std::io::BufRead;
 use std::iter::Iterator;
 
 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>
+    td { text-align: center; }
+    /* 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: 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.yes { border: thin solid gray; background-color: #ddd; }
+    /* 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; }
+  </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(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("&gt;"),
+                '<' => escaped.push_str("&lt;"),
+                '\'' => escaped.push_str("&#39;"),
+                '"' => escaped.push_str("&quot;"),
+                '&' => escaped.push_str("&amp;"),
+                ok_c => escaped.push(ok_c),
+            }
+        }
+        HTML(escaped)
+    }
+}
+impl From<&str> for HTML {
+    fn from(value: &str) -> HTML {
+        HTML(String::from(value))
+    }
+}
+impl FromIterator<HTML> for HTML {
+    fn from_iter<T>(iter: T) -> HTML
+    where
+        T: IntoIterator<Item = HTML>,
+    {
+        HTML(iter.into_iter().map(|html| html.0).collect::<String>())
+    }
+}
+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, 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,
 #[derive(Debug, PartialEq, Eq)]
 struct RowInput {
     label: String,
-    entries: Vec<String>,
+    entries: Vec<Entry>,
 }
 
 }
 
-#[cfg(test)]
-fn read_rows(_input: &impl std::io::Read) -> impl Iterator<Item = RowInput> {
-    vec![RowInput {
-        label: String::from("foo"),
-        entries: vec![],
-    }]
-    .into_iter()
+struct Reader<Input: Iterator<Item = Result<String, std::io::Error>>> {
+    input: std::iter::Enumerate<Input>,
+    row: Option<RowInput>,
+}
+impl<Input: Iterator<Item = Result<String, std::io::Error>>> Reader<Input> {
+    fn new(input: Input) -> Self {
+        Self {
+            input: input.enumerate(),
+            row: None,
+        }
+    }
+}
+impl<Input: Iterator<Item = Result<String, std::io::Error>>> Iterator for Reader<Input> {
+    type Item = Result<RowInput, std::io::Error>;
+    fn next(&mut self) -> Option<Self::Item> {
+        loop {
+            match self
+                .input
+                .next()
+                .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() => {
+                    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(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();
+                    }
+                }
+            }
+        }
+    }
 }
 
 }
 
-pub fn tablify(_input: &impl std::io::Read) -> String {
-    String::from("Hello, world!")
+fn read_rows(input: impl std::io::Read) -> impl Iterator<Item = Result<RowInput, std::io::Error>> {
+    Reader::new(std::io::BufReader::new(input).lines())
+}
+
+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_unstable_by(|(an, acol), (bn, bcol)| bn.cmp(an).then(acol.cmp(bcol)));
+    counts
+}
+fn column_order(rows: &[RowInput]) -> Vec<String> {
+    column_counts(rows)
+        .into_iter()
+        .map(|(_, col)| col)
+        .collect()
+}
+
+fn render_instance(entry: &Entry) -> HTML {
+    match &entry.instance {
+        None => HTML::from("✓"),
+        Some(instance) => HTML::escape(instance.as_ref()),
+    }
+}
+
+fn render_cell(col: &str, row: &RowInput) -> HTML {
+    let row_label = HTML::escape(row.label.as_ref());
+    let col_label = HTML::escape(col);
+    let entries: Vec<&Entry> = row.entries.iter().filter(|e| e.col == col).collect();
+    let class = HTML::from(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) {
+        HTML::from("")
+    } else if all_empty {
+        HTML(format!("{}", entries.len()))
+    } else {
+        HTML(
+            entries
+                .iter()
+                .map(|i| render_instance(i))
+                .map(|html| html.0) // Waiting for slice_concat_trait to stabilize
+                .collect::<Vec<_>>()
+                .join(" "),
+        )
+    };
+    HTML(format!("<td class=\"{class}\" onmouseover=\"h2('{row_label}','{col_label}')\" onmouseout=\"ch2('{row_label}','{col_label}')\">{contents}</td>"))
+}
+
+fn render_row(columns: &[String], row: &RowInput) -> HTML {
+    // This is O(n^2) & doesn't need to be
+    let row_label = HTML::escape(row.label.as_ref());
+    HTML(format!(
+        "<tr><th id=\"{row_label}\">{row_label}</th>{}</tr>\n",
+        &columns
+            .iter()
+            .map(|col| render_cell(col, row))
+            .collect::<HTML>()
+    ))
+}
+
+fn render_column_headers(columns: &[String]) -> HTML {
+    HTML(
+        String::from("<tr class=\"key\"><th></th>")
+            + &columns.iter().fold(String::new(), |mut acc, col| {
+                let col_header = HTML::escape(col.as_ref());
+                write!(
+                    &mut acc,
+                    "<th id=\"{col_header}\"><div><div>{col_header}</div></div></th>"
+                )
+                .unwrap();
+                acc
+            })
+            + "</tr>\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<HTML, std::io::Error> {
+    let rows = read_rows(input).collect::<Result<Vec<_>, _>>()?;
+    let columns = column_order(&rows);
+    Ok(HTML(format!(
+        "{HEADER}{}{}{FOOTER}",
+        render_column_headers(&columns),
+        rows.into_iter()
+            .map(|r| render_row(&columns, &r))
+            .collect::<HTML>()
+    )))
 }
 
 #[cfg(test)]
 mod tests {
     use super::*;
 
 }
 
 #[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!(
     #[test]
     fn test_read_rows() {
         assert_eq!(
-            read_rows(&&b"foo"[..]).collect::<Vec<_>>(),
+            read_rows(&b"foo"[..]).flatten().collect::<Vec<_>>(),
             vec![RowInput {
                 label: String::from("foo"),
                 entries: vec![]
             }]
         );
             vec![RowInput {
                 label: String::from("foo"),
                 entries: vec![]
             }]
         );
+        assert_eq!(
+            read_rows(&b"bar"[..]).flatten().collect::<Vec<_>>(),
+            vec![RowInput {
+                label: String::from("bar"),
+                entries: vec![]
+            }]
+        );
+        assert_eq!(
+            read_rows(&b"foo\nbar\n"[..]).flatten().collect::<Vec<_>>(),
+            vec![
+                RowInput {
+                    label: String::from("foo"),
+                    entries: vec![]
+                },
+                RowInput {
+                    label: String::from("bar"),
+                    entries: vec![]
+                }
+            ]
+        );
+        assert_eq!(
+            read_rows(&b"foo\n bar\n"[..]).flatten().collect::<Vec<_>>(),
+            vec![RowInput {
+                label: String::from("foo"),
+                entries: vec![Entry::from("bar")]
+            }]
+        );
+        assert_eq!(
+            read_rows(&b"foo\n bar\n baz\n"[..])
+                .flatten()
+                .collect::<Vec<_>>(),
+            vec![RowInput {
+                label: String::from("foo"),
+                entries: vec![Entry::from("bar"), Entry::from("baz")]
+            }]
+        );
+        assert_eq!(
+            read_rows(&b"foo\n\nbar\n"[..])
+                .flatten()
+                .collect::<Vec<_>>(),
+            vec![
+                RowInput {
+                    label: String::from("foo"),
+                    entries: vec![]
+                },
+                RowInput {
+                    label: String::from("bar"),
+                    entries: vec![]
+                }
+            ]
+        );
+        assert_eq!(
+            read_rows(&b"foo\n \nbar\n"[..])
+                .flatten()
+                .collect::<Vec<_>>(),
+            vec![
+                RowInput {
+                    label: String::from("foo"),
+                    entries: vec![]
+                },
+                RowInput {
+                    label: String::from("bar"),
+                    entries: vec![]
+                }
+            ]
+        );
+        assert_eq!(
+            read_rows(&b"foo  \n bar  \n"[..])
+                .flatten()
+                .collect::<Vec<_>>(),
+            vec![RowInput {
+                label: String::from("foo"),
+                entries: vec![Entry::from("bar")]
+            }]
+        );
+
+        let bad = read_rows(&b" foo"[..]).next().unwrap();
+        assert!(bad.is_err());
+        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("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![(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::<Result<Vec<_>, _>>()
+                    .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::<Result<Vec<_>, _>>()
+                    .unwrap()
+            ),
+            vec![(2, String::from("baz")), (1, String::from("bar"))]
+        );
+    }
+
+    #[test]
+    fn test_render_cell() {
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![]
+                }
+            ),
+            HTML::from("<td class=\"\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\"></td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("bar")]
+                }
+            ),
+            HTML::from("<td class=\"\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\"></td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("foo")]
+                }
+            ),
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\"></td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("foo"), Entry::from("foo")]
+                }
+            ),
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\">2</td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("foo: 5"), Entry::from("foo: 10")]
+                }
+            ),
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\">5 10</td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("foo: 5"), Entry::from("foo")]
+                }
+            ),
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\">5 ✓</td>")
+        );
+        assert_eq!(
+            render_cell(
+                "heart",
+                &RowInput {
+                    label: String::from("nope"),
+                    entries: vec![Entry::from("heart: <3")]
+                }
+            ),
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','heart')\" onmouseout=\"ch2('nope','heart')\">&lt;3</td>")
+        );
+        assert_eq!(
+            render_cell(
+                "foo",
+                &RowInput {
+                    label: String::from("bob's"),
+                    entries: vec![Entry::from("foo")]
+                }
+            ),
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('bob&#39;s','foo')\" onmouseout=\"ch2('bob&#39;s','foo')\"></td>")
+        );
     }
 }
     }
 }
Summarize a text log as an HTML table