Add html-validation crate

.circleci/config.yml

@@ -24,8 +24,8 @@ jobs:
           keys:
             # Checksum ensures that when we update versions for our `html-macro` dependencies we clear our cache, otherwise
             # compiletest-rs can error when the target directory has multiple versions of a crate.
-            - v6-cargo-cache-test-{{ arch }}-{{ .Branch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
-            - v6-cargo-cache-test-{{ arch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
+            - v7-cargo-cache-test-{{ arch }}-{{ .Branch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
+            - v7-cargo-cache-test-{{ arch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
 
       # Install nightly & wasm
       - run:
@@ -65,12 +65,12 @@ jobs:
 
       # Save cache
       - save_cache:
-          key: v6-cargo-cache-test-{{ arch }}-{{ .Branch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
+          key: v7-cargo-cache-test-{{ arch }}-{{ .Branch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
           paths:
             - target
             - /usr/local/cargo
       - save_cache:
-          key: v6-cargo-cache-test-{{ arch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
+          key: v7-cargo-cache-test-{{ arch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
           paths:
             - target
             - /usr/local/cargo
@@ -84,8 +84,8 @@ jobs:
       # Multiple caches are used to increase the chance of a cache hit.
       - restore_cache:
           keys:
-            - v6-cargo-cache-docs-{{ arch }}-{{ .Branch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
-            - v6-cargo-cache-docs-{{ arch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
+            - v7-cargo-cache-docs-{{ arch }}-{{ .Branch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
+            - v7-cargo-cache-docs-{{ arch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
 
       # Install nightly
       - run:
@@ -120,12 +120,12 @@ jobs:
 
       # Save cache
       - save_cache:
-          key: v6-cargo-cache-docs-{{ arch }}-{{ .Branch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
+          key: v7-cargo-cache-docs-{{ arch }}-{{ .Branch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
           paths:
             - target
             - /usr/local/cargo
       - save_cache:
-          key: v6-cargo-cache-docs-{{ arch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
+          key: v7-cargo-cache-docs-{{ arch }}-{{ checksum "./crates/html-macro/Cargo.toml" }}-{{ checksum "./crates/virtual-dom-rs/Cargo.toml" }}
           paths:
             - target
             - /usr/local/cargo

Cargo.toml

@@ -13,6 +13,7 @@ members = [
   "crates/html-macro",
   "crates/html-macro-test",
   "crates/html-macro-ui",
+  "crates/html-validation",
   "crates/router-rs",
   "crates/router-rs-macro",
   "crates/router-rs-macro-test",

crates/html-macro/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "html-macro"
-version = "0.1.2"
+version = "0.1.3"
 description = "html macro"
 authors = ["Chinedu Francis Nwafili <[email protected]>"]
 keywords = ["virtual", "dom", "wasm", "assembly", "webassembly"]
@@ -16,5 +16,4 @@ proc-macro = true
 proc-macro2 = { version = "0.4", features = ["span-locations"] }
 quote = "0.6.11"
 syn = { version = "0.15", features = ["full", "extra-traits"] }
-# TODO: Remove this in favor of crates/html-validation
-virtual-node = { path = "../virtual-node", version = "0.2.3" }
+html-validation = {path = "../html-validation", version = "0.1.0"}

crates/html-macro/src/parser/mod.rs

@@ -241,7 +241,6 @@ struct RecentSpanLocations {
     most_recent_block_start: Option<Span>,
 }
 
-// TODO: Cache this as a HashSet inside of our parser
 fn is_self_closing(tag: &str) -> bool {
-    virtual_node::SELF_CLOSING_TAGS.contains(tag)
+    html_validation::is_self_closing(tag)
 }

crates/html-validation/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "html-validation"
+version = "0.1.0"
+authors = ["Chinedu Francis Nwafili <[email protected]>"]
+description = "Validation for HTML elements and attributes"
+keywords = ["html", "validation", "valid", "dom", "virtual"]
+license = "MIT/Apache-2.0"
+repository = "https://github.com/chinedufn/percy"
+edition = "2018"
+
+[dependencies]
+lazy_static = "1.0"

crates/html-validation/src/lib.rs

@@ -0,0 +1,33 @@
+//! Validation for html attributes and elements
+
+#![deny(missing_docs)]
+
+use lazy_static::lazy_static;
+use std::collections::hash_set::HashSet;
+
+// Used to uniquely identify elements that contain closures so that the DomUpdater can
+// look them up by their unique id.
+// When the DomUpdater sees that the element no longer exists it will drop all of it's
+// Rc'd Closures for those events.
+lazy_static! {
+    static ref SELF_CLOSING_TAGS: HashSet<&'static str> = [
+        "area", "base", "br", "col", "hr", "img", "input", "link", "meta", "param", "command",
+        "keygen", "source",
+    ]
+    .iter()
+    .cloned()
+    .collect();
+}
+
+/// Whether or not this tag is self closing
+///
+/// ```
+/// use html_validation::is_self_closing;
+///
+/// assert_eq!(is_self_closing("br"), true);
+///
+/// assert_eq!(is_self_closing("div"), false);
+/// ```
+pub fn is_self_closing(tag: &str) -> bool {
+    SELF_CLOSING_TAGS.contains(tag)
+}

crates/virtual-node/Cargo.toml

@@ -12,6 +12,7 @@ edition = "2018"
 [dependencies]
 js-sys = "0.3"
 wasm-bindgen = {version = "0.2.33", features = ["default", "nightly"]}
+html-validation = {path = "../html-validation", version = "0.1.0"}
 lazy_static = "1.0"
 
 [dependencies.web-sys]

crates/virtual-node/src/lib.rs

@@ -20,8 +20,6 @@ use web_sys::{self, Element, EventTarget, Node, Text};
 use wasm_bindgen::JsCast;
 use wasm_bindgen::JsValue;
 
-use lazy_static::lazy_static;
-
 use std::iter::FromIterator;
 use std::ops::Deref;
 use std::option::Iter;
@@ -31,15 +29,9 @@ use std::sync::Mutex;
 // look them up by their unique id.
 // When the DomUpdater sees that the element no longer exists it will drop all of it's
 // Rc'd Closures for those events.
+use lazy_static::lazy_static;
 lazy_static! {
     static ref ELEM_UNIQUE_ID: Mutex<u32> = Mutex::new(0);
-    pub static ref SELF_CLOSING_TAGS: HashSet<&'static str> = [
-        "area", "base", "br", "col", "hr", "img", "input", "link", "meta", "param", "command",
-        "keygen", "source",
-    ]
-    .iter()
-    .cloned()
-    .collect();
 }
 
 /// When building your views you'll typically use the `html!` macro to generate
@@ -220,11 +212,6 @@ impl VElement {
         }
     }
 
-    /// Whether or not this is a self closing tag such as <br> or <img />
-    pub fn is_self_closing(&self) -> bool {
-        SELF_CLOSING_TAGS.contains(self.tag.as_str())
-    }
-
     /// Build a DOM element by recursively creating DOM nodes for this element and it's
     /// children, it's children's children, etc.
     pub fn create_element_node(&self) -> CreatedNode<Element> {
@@ -525,7 +512,7 @@ impl fmt::Display for VElement {
             write!(f, "{}", child.to_string())?;
         }
 
-        if !self.is_self_closing() {
+        if !html_validation::is_self_closing(&self.tag) {
             write!(f, "</{}>", self.tag)?;
         }