]> 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 01668eb3db650e39157a85f0dc1f50b3663422c2..370eb5ddd553a80f2cb4ce75c24703bf285e7b91 100644 (file)
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,4 +1,5 @@
 use std::collections::{HashMap, HashSet};
 use std::collections::{HashMap, HashSet};
+use std::fmt::Write;
 use std::io::BufRead;
 use std::iter::Iterator;
 
 use std::io::BufRead;
 use std::iter::Iterator;
 
@@ -8,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\"); } }
@@ -32,12 +31,50 @@ const HEADER: &str = "<!DOCTYPE html>
 </head>
 <body>
   <table>
 </head>
 <body>
   <table>
-    <tbody>";
+    <tbody>
+";
 const FOOTER: &str = "    </tbody>
   </table>
 </body>
 </html>";
 
 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,
 #[derive(Debug, PartialEq, Eq, Hash)]
 struct Entry {
     col: String,
@@ -51,8 +88,8 @@ impl From<&str> for Entry {
                 instance: None,
             },
             Some((col, instance)) => Entry {
                 instance: None,
             },
             Some((col, instance)) => Entry {
-                col: String::from(col),
-                instance: Some(String::from(instance)),
+                col: String::from(col.trim()),
+                instance: Some(String::from(instance.trim())),
             },
         }
     }
             },
         }
     }
@@ -138,9 +175,73 @@ 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
 }
     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
 ///
 
 /// # Errors
 ///
@@ -148,10 +249,16 @@ fn column_counts(rows: &[RowInput]) -> Vec<(usize, 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 rows = read_rows(input).collect::<Result<Vec<_>, _>>()?;
-    let _columns = column_counts(&rows);
-    Ok(String::from(HEADER) + "Hello, world!" + FOOTER)
+    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)]
 }
 
 #[cfg(test)]
@@ -174,6 +281,13 @@ mod tests {
                 instance: Some(String::from("bar"))
             }
         );
                 instance: Some(String::from("bar"))
             }
         );
+        assert_eq!(
+            Entry::from("foo: bar"),
+            Entry {
+                col: String::from("foo"),
+                instance: Some(String::from("bar"))
+            }
+        );
     }
 
     #[test]
     }
 
     #[test]
@@ -286,7 +400,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(
@@ -294,7 +408,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(
@@ -302,7 +416,91 @@ 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"))]
+        );
+    }
+
+    #[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