]> git.scottworley.com Git - tablify/blobdiff - src/lib.rs
projects / tablify / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Prefer &str over String
[tablify] / src / lib.rs
diff --git a/src/lib.rs b/src/lib.rs
index a3878c56f879436aedd0d18220a60a076e3ffa7c..199b8abd2732705484cc770b5ee948af71da332c 100644 (file)
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -9,20 +9,18 @@ const HEADER: &str = "<!DOCTYPE html>
   <meta charset=\"utf-8\">
   <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">
   <style>
   <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 }
     /* 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 { 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; }
     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; }
+    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; }
     /* 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\"); } }
   </style>
   <script>
     function highlight(id)       { const e = document.getElementById(id); if (e) { e.classList.add(   \"highlight\"); } }
@@ -40,37 +38,74 @@ const FOOTER: &str = "    </tbody>
 </body>
 </html>";
 
 </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)]
 #[derive(Debug, PartialEq, Eq, Hash)]
-struct Entry {
-    col: String,
-    instance: Option<String>,
+struct Entry<'a> {
+    col: &'a str,
+    instance: Option<&'a str>,
 }
 }
-impl From<&str> for Entry {
-    fn from(value: &str) -> Entry {
+impl<'a> From<&'a str> for Entry<'a> {
+    fn from(value: &'a str) -> Entry<'a> {
         match value.split_once(':') {
             None => Entry {
         match value.split_once(':') {
             None => Entry {
-                col: String::from(value),
+                col: value,
                 instance: None,
             },
             Some((col, instance)) => Entry {
                 instance: None,
             },
             Some((col, instance)) => Entry {
-                col: String::from(col.trim()),
-                instance: Some(String::from(instance.trim())),
+                col: col.trim(),
+                instance: Some(instance.trim()),
             },
         }
     }
 }
 
 #[derive(Debug, PartialEq, Eq)]
             },
         }
     }
 }
 
 #[derive(Debug, PartialEq, Eq)]
-struct RowInput {
-    label: String,
-    entries: Vec<Entry>,
+struct RowInput<'a> {
+    label: &'a str,
+    entries: Vec<Entry<'a>>,
 }
 
 }
 
-struct Reader<Input: Iterator<Item = Result<String, std::io::Error>>> {
+struct Reader<'a, Input: Iterator<Item = Result<String, std::io::Error>>> {
     input: std::iter::Enumerate<Input>,
     input: std::iter::Enumerate<Input>,
-    row: Option<RowInput>,
+    row: Option<RowInput<'a>>,
 }
 }
-impl<Input: Iterator<Item = Result<String, std::io::Error>>> Reader<Input> {
+impl<'a, Input: Iterator<Item = Result<String, std::io::Error>>> Reader<'a, Input> {
     fn new(input: Input) -> Self {
         Self {
             input: input.enumerate(),
     fn new(input: Input) -> Self {
         Self {
             input: input.enumerate(),
@@ -78,14 +113,15 @@ impl<Input: Iterator<Item = Result<String, std::io::Error>>> Reader<Input> {
         }
     }
 }
         }
     }
 }
-impl<Input: Iterator<Item = Result<String, std::io::Error>>> Iterator for Reader<Input> {
-    type Item = Result<RowInput, std::io::Error>;
+impl<'a, Input: Iterator<Item = Result<String, std::io::Error>>> Iterator for Reader<'a, Input> {
+    type Item = Result<RowInput<'a>, std::io::Error>;
     fn next(&mut self) -> Option<Self::Item> {
         loop {
             match self
                 .input
                 .next()
     fn next(&mut self) -> Option<Self::Item> {
         loop {
             match self
                 .input
                 .next()
-                .map(|(n, r)| (n, r.map(|line| String::from(line.trim_end()))))
+                // TODO: Don't leak
+                .map(|(n, r)| (n, r.map(|line| String::from(line).leak().trim_end())))
             {
                 None => return Ok(std::mem::take(&mut self.row)).transpose(),
                 Some((_, Err(e))) => return Some(Err(e)),
             {
                 None => return Ok(std::mem::take(&mut self.row)).transpose(),
                 Some((_, Err(e))) => return Some(Err(e)),
@@ -117,7 +153,9 @@ impl<Input: Iterator<Item = Result<String, std::io::Error>>> Iterator for Reader
     }
 }
 
     }
 }
 
-fn read_rows(input: impl std::io::Read) -> impl Iterator<Item = Result<RowInput, std::io::Error>> {
+fn read_rows(
+    input: impl std::io::Read,
+) -> impl Iterator<Item = Result<RowInput<'static>, std::io::Error>> {
     Reader::new(std::io::BufReader::new(input).lines())
 }
 
     Reader::new(std::io::BufReader::new(input).lines())
 }
 
@@ -132,7 +170,7 @@ fn column_counts(rows: &[RowInput]) -> Vec<(usize, String)> {
                 .into_iter()
         })
         .fold(HashMap::new(), |mut cs, col| {
                 .into_iter()
         })
         .fold(HashMap::new(), |mut cs, col| {
-            cs.entry(String::from(col))
+            cs.entry(String::from(*col))
                 .and_modify(|n| *n += 1)
                 .or_insert(1);
             cs
                 .and_modify(|n| *n += 1)
                 .or_insert(1);
             cs
@@ -140,7 +178,7 @@ fn column_counts(rows: &[RowInput]) -> Vec<(usize, String)> {
         .into_iter()
         .map(|(col, n)| (n, col))
         .collect();
         .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<String> {
     counts
 }
 fn column_order(rows: &[RowInput]) -> Vec<String> {
@@ -150,52 +188,62 @@ fn column_order(rows: &[RowInput]) -> Vec<String> {
         .collect()
 }
 
         .collect()
 }
 
-fn render_instance(entry: &Entry) -> String {
+fn render_instance(entry: &Entry) -> HTML {
     match &entry.instance {
     match &entry.instance {
-        None => String::from("✓ "),
-        Some(instance) => String::from(instance) + " ",
+        None => HTML::from("✓"),
+        Some(instance) => HTML::escape(instance.as_ref()),
     }
 }
 
     }
 }
 
-fn render_cell(col: &str, row: &RowInput) -> String {
-    // TODO: Escape HTML special characters
+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 entries: Vec<&Entry> = row.entries.iter().filter(|e| e.col == col).collect();
-    let class = if entries.is_empty() { "" } else { "yes" };
+    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) {
     let all_empty = entries.iter().all(|e| e.instance.is_none());
     let contents = if entries.is_empty() || (all_empty && entries.len() == 1) {
-        String::new()
+        HTML::from("")
     } else if all_empty {
     } else if all_empty {
-        format!("{}", entries.len())
+        HTML(format!("{}", entries.len()))
     } else {
     } else {
-        entries
-            .iter()
-            .map(|i| render_instance(i))
-            .collect::<String>()
+        HTML(
+            entries
+                .iter()
+                .map(|i| render_instance(i))
+                .map(|html| html.0) // Waiting for slice_concat_trait to stabilize
+                .collect::<Vec<_>>()
+                .join(" "),
+        )
     };
     };
-    format!("<td class=\"{class}\">{}</td>", contents.trim())
+    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) -> String {
+fn render_row(columns: &[String], row: &RowInput) -> HTML {
     // This is O(n^2) & doesn't need to be
     // This is O(n^2) & doesn't need to be
-    // TODO: Escape HTML special characters
-    format!(
-        "<tr><th>{}</th>{}</tr>\n",
-        row.label,
+    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))
         &columns
             .iter()
             .map(|col| render_cell(col, row))
-            .collect::<String>()
-    )
+            .collect::<HTML>()
+    ))
 }
 
 }
 
-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"
+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
 }
 
 /// # Errors
@@ -204,16 +252,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
 ///   * 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> {
+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);
     let rows = read_rows(input).collect::<Result<Vec<_>, _>>()?;
     let columns = column_order(&rows);
-    Ok(String::from(HEADER)
-        + &render_column_headers(&columns)
-        + &rows
-            .into_iter()
+    Ok(HTML(format!(
+        "{HEADER}{}{}{FOOTER}",
+        render_column_headers(&columns),
+        rows.into_iter()
             .map(|r| render_row(&columns, &r))
             .map(|r| render_row(&columns, &r))
-            .collect::<String>()
-        + FOOTER)
+            .collect::<HTML>()
+    )))
 }
 
 #[cfg(test)]
 }
 
 #[cfg(test)]
@@ -225,22 +273,22 @@ mod tests {
         assert_eq!(
             Entry::from("foo"),
             Entry {
         assert_eq!(
             Entry::from("foo"),
             Entry {
-                col: String::from("foo"),
+                col: "foo",
                 instance: None
             }
         );
         assert_eq!(
             Entry::from("foo:bar"),
             Entry {
                 instance: None
             }
         );
         assert_eq!(
             Entry::from("foo:bar"),
             Entry {
-                col: String::from("foo"),
-                instance: Some(String::from("bar"))
+                col: "foo",
+                instance: Some("bar")
             }
         );
         assert_eq!(
             Entry::from("foo: bar"),
             Entry {
             }
         );
         assert_eq!(
             Entry::from("foo: bar"),
             Entry {
-                col: String::from("foo"),
-                instance: Some(String::from("bar"))
+                col: "foo",
+                instance: Some("bar")
             }
         );
     }
             }
         );
     }
@@ -250,14 +298,14 @@ mod tests {
         assert_eq!(
             read_rows(&b"foo"[..]).flatten().collect::<Vec<_>>(),
             vec![RowInput {
         assert_eq!(
             read_rows(&b"foo"[..]).flatten().collect::<Vec<_>>(),
             vec![RowInput {
-                label: String::from("foo"),
+                label: "foo",
                 entries: vec![]
             }]
         );
         assert_eq!(
             read_rows(&b"bar"[..]).flatten().collect::<Vec<_>>(),
             vec![RowInput {
                 entries: vec![]
             }]
         );
         assert_eq!(
             read_rows(&b"bar"[..]).flatten().collect::<Vec<_>>(),
             vec![RowInput {
-                label: String::from("bar"),
+                label: "bar",
                 entries: vec![]
             }]
         );
                 entries: vec![]
             }]
         );
@@ -265,11 +313,11 @@ mod tests {
             read_rows(&b"foo\nbar\n"[..]).flatten().collect::<Vec<_>>(),
             vec![
                 RowInput {
             read_rows(&b"foo\nbar\n"[..]).flatten().collect::<Vec<_>>(),
             vec![
                 RowInput {
-                    label: String::from("foo"),
+                    label: "foo",
                     entries: vec![]
                 },
                 RowInput {
                     entries: vec![]
                 },
                 RowInput {
-                    label: String::from("bar"),
+                    label: "bar",
                     entries: vec![]
                 }
             ]
                     entries: vec![]
                 }
             ]
@@ -277,7 +325,7 @@ mod tests {
         assert_eq!(
             read_rows(&b"foo\n bar\n"[..]).flatten().collect::<Vec<_>>(),
             vec![RowInput {
         assert_eq!(
             read_rows(&b"foo\n bar\n"[..]).flatten().collect::<Vec<_>>(),
             vec![RowInput {
-                label: String::from("foo"),
+                label: "foo",
                 entries: vec![Entry::from("bar")]
             }]
         );
                 entries: vec![Entry::from("bar")]
             }]
         );
@@ -286,7 +334,7 @@ mod tests {
                 .flatten()
                 .collect::<Vec<_>>(),
             vec![RowInput {
                 .flatten()
                 .collect::<Vec<_>>(),
             vec![RowInput {
-                label: String::from("foo"),
+                label: "foo",
                 entries: vec![Entry::from("bar"), Entry::from("baz")]
             }]
         );
                 entries: vec![Entry::from("bar"), Entry::from("baz")]
             }]
         );
@@ -296,11 +344,11 @@ mod tests {
                 .collect::<Vec<_>>(),
             vec![
                 RowInput {
                 .collect::<Vec<_>>(),
             vec![
                 RowInput {
-                    label: String::from("foo"),
+                    label: "foo",
                     entries: vec![]
                 },
                 RowInput {
                     entries: vec![]
                 },
                 RowInput {
-                    label: String::from("bar"),
+                    label: "bar",
                     entries: vec![]
                 }
             ]
                     entries: vec![]
                 }
             ]
@@ -311,11 +359,11 @@ mod tests {
                 .collect::<Vec<_>>(),
             vec![
                 RowInput {
                 .collect::<Vec<_>>(),
             vec![
                 RowInput {
-                    label: String::from("foo"),
+                    label: "foo",
                     entries: vec![]
                 },
                 RowInput {
                     entries: vec![]
                 },
                 RowInput {
-                    label: String::from("bar"),
+                    label: "bar",
                     entries: vec![]
                 }
             ]
                     entries: vec![]
                 }
             ]
@@ -325,7 +373,7 @@ mod tests {
                 .flatten()
                 .collect::<Vec<_>>(),
             vec![RowInput {
                 .flatten()
                 .collect::<Vec<_>>(),
             vec![RowInput {
-                label: String::from("foo"),
+                label: "foo",
                 entries: vec![Entry::from("bar")]
             }]
         );
                 entries: vec![Entry::from("bar")]
             }]
         );
@@ -355,7 +403,7 @@ mod tests {
                     .collect::<Result<Vec<_>, _>>()
                     .unwrap()
             ),
                     .collect::<Result<Vec<_>, _>>()
                     .unwrap()
             ),
-            vec![(1, String::from("bar")), (2, String::from("baz"))]
+            vec![(2, String::from("baz")), (1, String::from("bar"))]
         );
         assert_eq!(
             column_counts(
         );
         assert_eq!(
             column_counts(
@@ -363,7 +411,7 @@ mod tests {
                     .collect::<Result<Vec<_>, _>>()
                     .unwrap()
             ),
                     .collect::<Result<Vec<_>, _>>()
                     .unwrap()
             ),
-            vec![(1, String::from("bar")), (2, String::from("baz"))]
+            vec![(2, String::from("baz")), (1, String::from("bar"))]
         );
         assert_eq!(
             column_counts(
         );
         assert_eq!(
             column_counts(
@@ -371,7 +419,7 @@ mod tests {
                     .collect::<Result<Vec<_>, _>>()
                     .unwrap()
             ),
                     .collect::<Result<Vec<_>, _>>()
                     .unwrap()
             ),
-            vec![(1, String::from("bar")), (2, String::from("baz"))]
+            vec![(2, String::from("baz")), (1, String::from("bar"))]
         );
     }
 
         );
     }
 
@@ -381,61 +429,81 @@ mod tests {
             render_cell(
                 "foo",
                 &RowInput {
             render_cell(
                 "foo",
                 &RowInput {
-                    label: String::from("nope"),
+                    label: "nope",
                     entries: vec![]
                 }
             ),
                     entries: vec![]
                 }
             ),
-            String::from("<td class=\"\"></td>")
+            HTML::from("<td class=\"\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\"></td>")
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
-                    label: String::from("nope"),
+                    label: "nope",
                     entries: vec![Entry::from("bar")]
                 }
             ),
                     entries: vec![Entry::from("bar")]
                 }
             ),
-            String::from("<td class=\"\"></td>")
+            HTML::from("<td class=\"\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\"></td>")
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
-                    label: String::from("nope"),
+                    label: "nope",
                     entries: vec![Entry::from("foo")]
                 }
             ),
                     entries: vec![Entry::from("foo")]
                 }
             ),
-            String::from("<td class=\"yes\"></td>")
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\"></td>")
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
-                    label: String::from("nope"),
+                    label: "nope",
                     entries: vec![Entry::from("foo"), Entry::from("foo")]
                 }
             ),
                     entries: vec![Entry::from("foo"), Entry::from("foo")]
                 }
             ),
-            String::from("<td class=\"yes\">2</td>")
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\">2</td>")
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
-                    label: String::from("nope"),
+                    label: "nope",
                     entries: vec![Entry::from("foo: 5"), Entry::from("foo: 10")]
                 }
             ),
                     entries: vec![Entry::from("foo: 5"), Entry::from("foo: 10")]
                 }
             ),
-            String::from("<td class=\"yes\">5 10</td>")
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\">5 10</td>")
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
         );
         assert_eq!(
             render_cell(
                 "foo",
                 &RowInput {
-                    label: String::from("nope"),
+                    label: "nope",
                     entries: vec![Entry::from("foo: 5"), Entry::from("foo")]
                 }
             ),
                     entries: vec![Entry::from("foo: 5"), Entry::from("foo")]
                 }
             ),
-            String::from("<td class=\"yes\">5 ✓</td>")
+            HTML::from("<td class=\"yes\" onmouseover=\"h2('nope','foo')\" onmouseout=\"ch2('nope','foo')\">5 ✓</td>")
+        );
+        assert_eq!(
+            render_cell(
+                "heart",
+                &RowInput {
+                    label: "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: "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