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

rename enum and variant #36

Merged
merged 1 commit into from
Jun 16, 2024
Merged

rename enum and variant #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions src/fmt_md.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,10 +371,10 @@ impl<'a> MdWriterState<'a> {
}
Inline::Text { variant, value } => {
let surround = match variant {
InlineVariant::Text => "",
InlineVariant::Code => "`",
InlineVariant::Math => "$",
InlineVariant::Html => "",
TextVariant::Plain => "",
TextVariant::Code => "`",
TextVariant::Math => "$",
TextVariant::Html => "",
};
out.write_str(surround);
out.write_str(value);
Expand Down Expand Up @@ -589,10 +589,10 @@ pub mod tests {
Inline(crate::tree::Inline::Span{variant: SpanVariant::Emphasis, ..}),
Inline(crate::tree::Inline::Span{variant: SpanVariant::Strong, ..}),

Inline(crate::tree::Inline::Text{variant: InlineVariant::Text, ..}),
Inline(crate::tree::Inline::Text{variant: InlineVariant::Code, ..}),
Inline(crate::tree::Inline::Text{variant: InlineVariant::Math, ..}),
Inline(crate::tree::Inline::Text{variant: InlineVariant::Html, ..}),
Inline(crate::tree::Inline::Text{variant: TextVariant::Plain, ..}),
Inline(crate::tree::Inline::Text{variant: TextVariant::Code, ..}),
Inline(crate::tree::Inline::Text{variant: TextVariant::Math, ..}),
Inline(crate::tree::Inline::Text{variant: TextVariant::Html, ..}),

Inline(crate::tree::Inline::Link{link: Link{title: None, reference: LinkReference::Inline, ..}, ..}),
Inline(crate::tree::Inline::Link{link: Link{title: None, reference: LinkReference::Full(_), ..}, ..}),
Expand Down Expand Up @@ -630,7 +630,7 @@ pub mod tests {
mdq_nodes![Root {
body: mdq_nodes![Paragraph {
body: vec![Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: "Hello, world".to_string()
}]
}]
Expand All @@ -647,13 +647,13 @@ pub mod tests {
body: mdq_nodes![
Paragraph {
body: vec![Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: "First".to_string()
}]
},
Paragraph {
body: vec![Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: "Second".to_string()
}]
},
Expand Down Expand Up @@ -742,7 +742,7 @@ pub mod tests {
check_render(
mdq_nodes![Paragraph {
body: vec![Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: "Hello, world".to_string()
}]
}],
Expand All @@ -762,7 +762,7 @@ pub mod tests {
mdq_nodes![BlockQuote {
body: mdq_nodes![Paragraph {
body: vec![Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: "Hello, world".to_string()
}]
}]
Expand Down Expand Up @@ -1265,7 +1265,7 @@ pub mod tests {
fn text() {
check_render(
vec![MdqNode::Inline(Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: "hello world".to_string(),
})],
indoc! {"hello world"},
Expand All @@ -1276,7 +1276,7 @@ pub mod tests {
fn code() {
check_render(
vec![MdqNode::Inline(Inline::Text {
variant: InlineVariant::Code,
variant: TextVariant::Code,
value: "hello world".to_string(),
})],
indoc! {"`hello world`"},
Expand All @@ -1287,7 +1287,7 @@ pub mod tests {
fn math() {
check_render(
vec![MdqNode::Inline(Inline::Text {
variant: InlineVariant::Math,
variant: TextVariant::Math,
value: "hello world".to_string(),
})],
indoc! {"$hello world$"},
Expand All @@ -1298,7 +1298,7 @@ pub mod tests {
fn html() {
check_render(
vec![MdqNode::Inline(Inline::Text {
variant: InlineVariant::Html,
variant: TextVariant::Html,
value: "<a hello />".to_string(),
})],
indoc! {"<a hello />"},
Expand Down
14 changes: 7 additions & 7 deletions src/fmt_str.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::tree::{Inline, InlineVariant};
use crate::tree::{Inline, TextVariant};
use std::borrow::Borrow;

pub fn inlines_to_plain_string<N: Borrow<Inline>>(inlines: &[N]) -> String {
Expand All @@ -18,7 +18,7 @@ fn build_inline(out: &mut String, elem: &Inline) {
match elem {
Inline::Span { children, .. } => build_inlines(out, children),
Inline::Text { variant, value, .. } => {
if !matches!(variant, InlineVariant::Html) {
if !matches!(variant, TextVariant::Html) {
out.push_str(value)
}
}
Expand All @@ -37,7 +37,7 @@ mod tests {
use super::*;
use indoc::indoc;

use crate::tree::{Inline, InlineVariant, MdqNode, SpanVariant};
use crate::tree::{Inline, MdqNode, SpanVariant, TextVariant};
use crate::unwrap;
use crate::utils_for_test::VariantsChecker;
use lazy_static::lazy_static;
Expand All @@ -48,10 +48,10 @@ mod tests {
Span { variant: SpanVariant::Delete, .. },
Span { variant: SpanVariant::Emphasis, .. },
Span { variant: SpanVariant::Strong, .. },
Text { variant: InlineVariant::Text, .. },
Text { variant: InlineVariant::Code, .. },
Text { variant: InlineVariant::Math, .. },
Text { variant: InlineVariant::Html, .. },
Text { variant: TextVariant::Plain, .. },
Text { variant: TextVariant::Code, .. },
Text { variant: TextVariant::Math, .. },
Text { variant: TextVariant::Html, .. },
Link { .. },
Image { .. },
Footnote(_),
Expand Down
66 changes: 32 additions & 34 deletions src/tree.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,11 @@ pub enum CodeVariant {
#[derive(Debug, PartialEq, Eq, Hash)]
pub enum Inline {
Span {
// TODO rename to Composite or something? Or Formatting?
variant: SpanVariant,
children: Vec<Inline>,
},
Text {
variant: InlineVariant,
variant: TextVariant,
value: String,
},
Link {
Expand Down Expand Up @@ -185,10 +184,9 @@ pub enum SpanVariant {
Strong,
}

// TODO rename to TextVariant
#[derive(Debug, PartialEq, Eq, Hash)]
pub enum InlineVariant {
Text, // TODO rename to Plain
pub enum TextVariant {
Plain,
Code,
Math,
Html,
Expand Down Expand Up @@ -231,8 +229,8 @@ impl TryFrom<mdast::Node> for MdqNode {
}
}

/// Defines all the mdx nodes as match arms. This let us easily mark them as TODOs, and in particular makes it so that
/// the prod and test code both marks them as TODOs using the same source list (namely, this macro).
/// Defines all the mdx nodes as match arms. This let us easily mark them as ignored, and in particular makes it so that
/// the prod and test code both marks them as ignored using the same source list (namely, this macro).
macro_rules! mdx_nodes {
{} => {
mdast::Node::MdxJsxFlowElement(_)
Expand Down Expand Up @@ -280,15 +278,15 @@ impl MdqNode {
})
}
mdast::Node::Break(_) => MdqNode::Inline(Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: "\n".to_string(),
}),
mdast::Node::InlineCode(node) => MdqNode::Inline(Inline::Text {
variant: InlineVariant::Code,
variant: TextVariant::Code,
value: node.value,
}),
mdast::Node::InlineMath(node) => MdqNode::Inline(Inline::Text {
variant: InlineVariant::Math,
variant: TextVariant::Math,
value: node.value,
}),
mdast::Node::Delete(node) => MdqNode::Inline(Inline::Span {
Expand Down Expand Up @@ -335,7 +333,7 @@ impl MdqNode {
children: MdqNode::inlines(node.children, lookups)?,
}),
mdast::Node::Text(node) => MdqNode::Inline(Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: node.value,
}),
mdast::Node::Code(node) => {
Expand Down Expand Up @@ -405,7 +403,7 @@ impl MdqNode {
value: node.value,
}),
mdast::Node::Html(node) => MdqNode::Inline(Inline::Text {
variant: InlineVariant::Html,
variant: TextVariant::Html,
value: node.value,
}),

Expand Down Expand Up @@ -530,11 +528,11 @@ impl MdqNode {
// a Node::Break between them.
if let (
Some(Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: prev_text,
}),
Inline::Text {
variant: InlineVariant::Text,
variant: TextVariant::Plain,
value: new_text,
},
) = (result.last_mut(), &inline)
Expand Down Expand Up @@ -876,17 +874,17 @@ mod tests {
check!(&root.children[0], Node::Paragraph(p), lookups => MdqNode::Paragraph(Paragraph{body}) = {
assert_eq!(p.children.len(), 3);
check!(&p.children[0], Node::Text(_), lookups => MdqNode::Inline(text) = {
assert_eq!(text, Inline::Text {variant: InlineVariant::Text, value: "hello ".to_string()});
assert_eq!(text, Inline::Text {variant: TextVariant::Plain, value: "hello ".to_string()});
});
check!(&p.children[1], Node::Break(_), lookups => MdqNode::Inline(text) = {
assert_eq!(text, Inline::Text {variant: InlineVariant::Text, value: "\n".to_string()});
assert_eq!(text, Inline::Text {variant: TextVariant::Plain, value: "\n".to_string()});
});
check!(&p.children[2], Node::Text(_), lookups => MdqNode::Inline(text) = {
assert_eq!(text, Inline::Text {variant: InlineVariant::Text, value: "world".to_string()});
assert_eq!(text, Inline::Text {variant: TextVariant::Plain, value: "world".to_string()});
});
assert_eq!(body, vec![
// note: just a single child, which has a two-line string
Inline::Text {variant: InlineVariant::Text, value: "hello \nworld".to_string()},
Inline::Text {variant: TextVariant::Plain, value: "hello \nworld".to_string()},
])
});
}
Expand All @@ -897,7 +895,7 @@ mod tests {

unwrap!(&root.children[0], Node::Paragraph(p));
check!(&p.children[0], Node::InlineCode(_), lookups => MdqNode::Inline(inline) = {
assert_eq!(inline, Inline::Text { variant: InlineVariant::Code, value: "foo".to_string() });
assert_eq!(inline, Inline::Text { variant: TextVariant::Code, value: "foo".to_string() });
});
}

Expand All @@ -909,7 +907,7 @@ mod tests {

unwrap!(&root.children[0], Node::Paragraph(p));
check!(&p.children[0], Node::InlineMath(_), lookups => MdqNode::Inline(inline) = {
assert_eq!(inline, Inline::Text { variant: InlineVariant::Math, value: r#" 0 \ne 1 "#.to_string() });
assert_eq!(inline, Inline::Text { variant: TextVariant::Math, value: r#" 0 \ne 1 "#.to_string() });
});
}

Expand All @@ -922,7 +920,7 @@ mod tests {
assert_eq!(inline, Inline::Span {
variant: SpanVariant::Delete,
children: vec![
Inline::Text { variant: InlineVariant::Text, value: "86 me".to_string()},
Inline::Text { variant: TextVariant::Plain, value: "86 me".to_string()},
]
});
});
Expand All @@ -937,7 +935,7 @@ mod tests {
assert_eq!(inline, Inline::Span {
variant: SpanVariant::Emphasis,
children: vec![
Inline::Text { variant: InlineVariant::Text, value: "86 me".to_string()},
Inline::Text { variant: TextVariant::Plain, value: "86 me".to_string()},
]
});
});
Expand All @@ -952,7 +950,7 @@ mod tests {
assert_eq!(inline, Inline::Span {
variant: SpanVariant::Strong,
children: vec![
Inline::Text { variant: InlineVariant::Text, value: "strongman".to_string()},
Inline::Text { variant: TextVariant::Plain, value: "strongman".to_string()},
]
});
});
Expand All @@ -965,7 +963,7 @@ mod tests {

check!(&root.children[0], Node::Html(_), lookups => MdqNode::Inline(inline) = {
assert_eq!(inline, Inline::Text {
variant: InlineVariant::Html,
variant: TextVariant::Html,
value: "<a href>".to_string(),
});
});
Expand All @@ -980,11 +978,11 @@ mod tests {
assert_eq!(body, vec![
mdq_inline!("In "),
Inline::Text {
variant: InlineVariant::Html,
variant: TextVariant::Html,
value: "<em>".to_string()},
mdq_inline!("a paragraph."),
Inline::Text {
variant: InlineVariant::Html,
variant: TextVariant::Html,
value: "</em>".to_string()},
])
});
Expand All @@ -1000,11 +998,11 @@ mod tests {
assert_eq!(body, vec![
mdq_inline!("In "),
Inline::Text {
variant: InlineVariant::Html,
variant: TextVariant::Html,
value: "<em\nnewline >".to_string()},
mdq_inline!("a paragraph."),
Inline::Text {
variant: InlineVariant::Html,
variant: TextVariant::Html,
value: "</em>".to_string()},
])
});
Expand Down Expand Up @@ -1247,7 +1245,7 @@ mod tests {
let (root, lookups) = parse_with(&ParseOptions::default(), "https://example.com");
unwrap!(&root.children[0], Node::Paragraph(p));
assert_eq!(p.children.len(), 1);
check!(&p.children[0], Node::Text(_), lookups => MdqNode::Inline(Inline::Text{variant: InlineVariant::Text, value}) = {
check!(&p.children[0], Node::Text(_), lookups => MdqNode::Inline(Inline::Text{variant: TextVariant::Plain, value}) = {
assert_eq!(value, "https://example.com".to_string());
});
}
Expand Down Expand Up @@ -1403,10 +1401,10 @@ mod tests {
Inline::Span{
variant: SpanVariant::Emphasis,
children: vec![
Inline::Text {variant: InlineVariant::Text,value: "my".to_string()}
Inline::Text {variant: TextVariant::Plain,value: "my".to_string()}
],
},
Inline::Text {variant: InlineVariant::Text,value: " text".to_string()}
Inline::Text {variant: TextVariant::Plain,value: " text".to_string()}

],
link: Link {
Expand All @@ -1430,7 +1428,7 @@ mod tests {
check!(&p.children[0], Node::LinkReference(_), lookups => MdqNode::Inline(link) = {
assert_eq!(link, Inline::Link {
text: vec![
Inline::Text {variant: InlineVariant::Text,value: "my text".to_string()},
Inline::Text {variant: TextVariant::Plain,value: "my text".to_string()},
],
link: Link {
url: "https://example.com/image.png".to_string(),
Expand Down Expand Up @@ -1584,11 +1582,11 @@ mod tests {
let (header_depth, header_title) = check!(&root.children[0], Node::Heading(_), lookups => MdqNode::Header(Header{depth, title, body}) = {
assert_eq!(depth, 2);
assert_eq!(title, vec![
Inline::Text { variant: InlineVariant::Text, value: "Header with ".to_string()},
Inline::Text { variant: TextVariant::Plain, value: "Header with ".to_string()},
Inline::Span {
variant: SpanVariant::Emphasis,
children: vec![
Inline::Text { variant: InlineVariant::Text, value: "emphasis".to_string()},
Inline::Text { variant: TextVariant::Plain, value: "emphasis".to_string()},
]
}
]);
Expand Down
2 changes: 1 addition & 1 deletion src/tree_test_utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ mod test_utils {
};
($text:literal) => {
crate::tree::Inline::Text {
variant: crate::tree::InlineVariant::Text,
variant: crate::tree::TextVariant::Plain,
value: $text.to_string(),
}
};
Expand Down