Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix casing of dynamic tags #2578

Merged
merged 3 commits into from Apr 5, 2022
Merged

Fix casing of dynamic tags #2578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49fb6c0
fix casing of dynamic tags
WorldSEnder Apr 5, 2022
d4be78e
add test case for unknown tag names
WorldSEnder Apr 5, 2022
1e418e2
add lint for non-normalized tags
WorldSEnder Apr 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
56 changes: 31 additions & 25 deletions packages/yew-macro/src/html_tree/html_element.rs
View file
Open in desktop
Expand Up @@ -4,6 +4,7 @@ use crate::stringify::{Stringify, Value};
use crate::{non_capitalized_ascii, Peek, PeekValue};
use boolinator::Boolinator;
use proc_macro2::{Delimiter, TokenStream};
use proc_macro_error::emit_warning;
use quote::{quote, quote_spanned, ToTokens};
use syn::buffer::Cursor;
use syn::parse::{Parse, ParseStream};
Expand Down Expand Up @@ -295,9 +296,20 @@ impl ToTokens for HtmlElement {
};

tokens.extend(match &name {
TagName::Lit(name) => {
let name_span = name.span();
let name = name.to_ascii_lowercase_string();
TagName::Lit(dashedname) => {
let name_span = dashedname.span();
let name = dashedname.to_ascii_lowercase_string();
if name != dashedname.to_string() {
emit_warning!(
dashedname.span(),
format!(
"The tag '{0}' is not matching its normalized form '{1}'. If you want \
to keep this form, change this to a dynamic tag `@{{\"{0}\"}}`.",
dashedname,
name,
)
)
}
let node = match &*name {
"input" => {
quote! {
Expand Down Expand Up @@ -375,18 +387,15 @@ impl ToTokens for HtmlElement {
let mut #vtag_name = ::std::convert::Into::<
::std::borrow::Cow::<'static, ::std::primitive::str>
>::into(#expr);
if !#vtag_name.is_ascii() {
::std::panic!(
"a dynamic tag returned a tag name containing non ASCII characters: `{}`",
#vtag_name,
);
}
// convert to lowercase because the runtime checks rely on it.
#vtag_name.to_mut().make_ascii_lowercase();
::std::debug_assert!(
#vtag_name.is_ascii(),
"a dynamic tag returned a tag name containing non ASCII characters: `{}`",
#vtag_name,
);

#[allow(clippy::redundant_clone, unused_braces, clippy::let_and_return)]
let mut #vtag = match ::std::convert::AsRef::<::std::primitive::str>::as_ref(&#vtag_name) {
"input" => {
let mut #vtag = match () {
_ if "input".eq_ignore_ascii_case(::std::convert::AsRef::<::std::primitive::str>::as_ref(&#vtag_name)) => {
::yew::virtual_dom::VTag::__new_textarea(
#value,
#node_ref,
Expand All @@ -395,7 +404,7 @@ impl ToTokens for HtmlElement {
#listeners,
)
}
"textarea" => {
_ if "textarea".eq_ignore_ascii_case(::std::convert::AsRef::<::std::primitive::str>::as_ref(&#vtag_name)) => {
::yew::virtual_dom::VTag::__new_textarea(
#value,
#node_ref,
Expand Down Expand Up @@ -429,17 +438,14 @@ impl ToTokens for HtmlElement {
//
// check void element
if !#vtag.children().is_empty() {
match #vtag.tag() {
"area" | "base" | "br" | "col" | "embed" | "hr" | "img" | "input"
| "link" | "meta" | "param" | "source" | "track" | "wbr"
=> {
::std::panic!(
"a dynamic tag tried to create a `<{0}>` tag with children. `<{0}>` is a void element which can't have any children.",
#vtag.tag(),
);
}
_ => {}
}
::std::debug_assert!(
!::std::matches!(#vtag.tag().to_ascii_lowercase().as_str(),
"area" | "base" | "br" | "col" | "embed" | "hr" | "img" | "input"
| "link" | "meta" | "param" | "source" | "track" | "wbr"
),
"a dynamic tag tried to create a `<{0}>` tag with children. `<{0}>` is a void element which can't have any children.",
#vtag.tag(),
);
}

::std::convert::Into::<::yew::virtual_dom::VNode>::into(#vtag)
Expand Down
3 changes: 3 additions & 0 deletions packages/yew-macro/tests/html_lints/fail.rs
View file
Open in desktop
Expand Up @@ -13,5 +13,8 @@ fn main() {
let bad_img = html! {
<img src="img.jpeg"/>
};
let misformed_tagname = html! {
<tExTAreA />
};
compile_error!("This macro call exists to deliberately fail the compilation of the test so we can verify output of lints");
}
10 changes: 8 additions & 2 deletions packages/yew-macro/tests/html_lints/fail.stderr
View file
Open in desktop
Expand Up @@ -22,8 +22,14 @@ warning: All `<img>` tags should have an `alt` attribute which provides a human-
14 | <img src="img.jpeg"/>
| ^^^

warning: The tag 'tExTAreA' is not matching its normalized form 'textarea'. If you want to keep this form, change this to a dynamic tag `@{"tExTAreA"}`.
--> tests/html_lints/fail.rs:17:10
|
17 | <tExTAreA />
| ^^^^^^^^

error: This macro call exists to deliberately fail the compilation of the test so we can verify output of lints
--> tests/html_lints/fail.rs:16:5
--> tests/html_lints/fail.rs:19:5
|
16 | compile_error!("This macro call exists to deliberately fail the compilation of the test so we can verify output of lints");
19 | compile_error!("This macro call exists to deliberately fail the compilation of the test so we can verify output of lints");
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11 changes: 11 additions & 0 deletions packages/yew/src/dom_bundle/btag/mod.rs
View file
Open in desktop
Expand Up @@ -845,9 +845,20 @@ mod tests {
<@{"tExTAREa"}/>
};
let vtag = assert_vtag_ref(&el);
// textarea is a special element, so it gets normalized
assert_eq!(vtag.tag(), "textarea");
}

#[test]
fn dynamic_tags_allow_custom_capitalization() {
let el = html! {
<@{"clipPath"}/>
};
let vtag = assert_vtag_ref(&el);
// no special treatment for elements not recognized e.g. clipPath
assert_eq!(vtag.tag(), "clipPath");
}

#[test]
fn reset_node_ref() {
let (root, scope, parent) = setup_parent();
Expand Down