Skip to content

Commit

Permalink
feat!: retain more details on reference links
Browse files Browse the repository at this point in the history 
This raises the number of passing spec tests from 436 to 459.
  • Loading branch information
@notriddle
notriddle committed Sep 6, 2024
1 parent ab22a57 commit 3170061
Show file tree
Hide file tree
Showing 4 changed files with 135 additions and 19 deletions.
106 changes: 95 additions & 11 deletions src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,18 @@ pub struct State<'a> {
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum LinkCategory<'a> {
AngleBracketed,
Reference { uri: Cow<'a, str>, title: Cow<'a, str>, id: Cow<'a, str> },
Collapsed { uri: Cow<'a, str>, title: Cow<'a, str> },
Shortcut { uri: Cow<'a, str>, title: Cow<'a, str> },
Other { uri: Cow<'a, str>, title: Cow<'a, str> },
}

#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ImageLink<'a> {
uri: Cow<'a, str>,
title: Cow<'a, str>,
pub enum ImageLink<'a> {
Reference { uri: Cow<'a, str>, title: Cow<'a, str>, id: Cow<'a, str> },
Collapsed { uri: Cow<'a, str>, title: Cow<'a, str> },
Shortcut { uri: Cow<'a, str>, title: Cow<'a, str> },
Other { uri: Cow<'a, str>, title: Cow<'a, str> },
}

#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
Expand Down Expand Up @@ -301,13 +305,29 @@ where
link_type,
dest_url,
title,
id: _,
id,
} => {
state.link_stack.push(match link_type {
LinkType::Autolink | LinkType::Email => {
formatter.write_char('<')?;
LinkCategory::AngleBracketed
}
LinkType::Reference => {
formatter.write_char('[')?;
LinkCategory::Reference {
uri: dest_url.clone().into(),
title: title.clone().into(),
id: id.clone().into(),
}
}
LinkType::Collapsed => {
state.current_shortcut_text = Some(String::new());
formatter.write_char('[')?;
LinkCategory::Collapsed {
uri: dest_url.clone().into(),
title: title.clone().into(),
}
}
LinkType::Shortcut => {
state.current_shortcut_text = Some(String::new());
formatter.write_char('[')?;
Expand All @@ -327,14 +347,35 @@ where
Ok(())
}
Image {
link_type: _,
link_type,
dest_url,
title,
id: _,
id,
} => {
state.image_stack.push(ImageLink {
uri: dest_url.clone().into(),
title: title.clone().into(),
state.image_stack.push(match link_type {
LinkType::Reference => ImageLink::Reference {
uri: dest_url.clone().into(),
title: title.clone().into(),
id: id.clone().into(),
},
LinkType::Collapsed => {
state.current_shortcut_text = Some(String::new());
ImageLink::Collapsed {
uri: dest_url.clone().into(),
title: title.clone().into(),
}
},
LinkType::Shortcut => {
state.current_shortcut_text = Some(String::new());
ImageLink::Shortcut {
uri: dest_url.clone().into(),
title: title.clone().into(),
}
},
_ => ImageLink::Other {
uri: dest_url.clone().into(),
title: title.clone().into(),
},
});
formatter.write_str("![")
}
Expand Down Expand Up @@ -434,6 +475,22 @@ where
End(tag) => match tag {
TagEnd::Link => match state.link_stack.pop().unwrap() {
LinkCategory::AngleBracketed => formatter.write_char('>'),
LinkCategory::Reference { uri, title, id } => {
state
.shortcuts
.push((id.to_string(), uri.to_string(), title.to_string()));
formatter.write_str("][")?;
formatter.write_str(&id)?;
formatter.write_char(']')
}
LinkCategory::Collapsed { uri, title } => {
if let Some(shortcut_text) = state.current_shortcut_text.take() {
state
.shortcuts
.push((shortcut_text, uri.to_string(), title.to_string()));
}
formatter.write_str("][]")
}
LinkCategory::Shortcut { uri, title } => {
if let Some(shortcut_text) = state.current_shortcut_text.take() {
state
Expand All @@ -445,8 +502,35 @@ where
LinkCategory::Other { uri, title } => close_link(&uri, &title, formatter, LinkType::Inline),
},
TagEnd::Image => {
let ImageLink { uri, title } = state.image_stack.pop().unwrap();
close_link(uri.as_ref(), title.as_ref(), formatter, LinkType::Inline)
match state.image_stack.pop().unwrap() {
ImageLink::Reference { uri, title, id } => {
state
.shortcuts
.push((id.to_string(), uri.to_string(), title.to_string()));
formatter.write_str("][")?;
formatter.write_str(&id)?;
formatter.write_char(']')
}
ImageLink::Collapsed { uri, title } => {
if let Some(shortcut_text) = state.current_shortcut_text.take() {
state
.shortcuts
.push((shortcut_text, uri.to_string(), title.to_string()));
}
formatter.write_str("][]")
}
ImageLink::Shortcut { uri, title } => {
if let Some(shortcut_text) = state.current_shortcut_text.take() {
state
.shortcuts
.push((shortcut_text, uri.to_string(), title.to_string()));
}
formatter.write_char(']')
}
ImageLink::Other { uri, title } => {
close_link(uri.as_ref(), title.as_ref(), formatter, LinkType::Inline)
}
}
}
TagEnd::Emphasis => formatter.write_char(options.emphasis_token),
TagEnd::Strong => formatter.write_str(options.strong_token),
Expand Down
8 changes: 5 additions & 3 deletions tests/fixtures/snapshots/stupicat-event-by-event-output
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ tempor invidunt ut labore et dolore magna aliquyam erat
Lorem ipsum dolor sit amet, [consetetur
sadipscing](http://www.example.com/inline) elitr, sed diam nonumy eirmod tempor
invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos
et accusam et [justo duo dolores](http://www.example.com/reference) et ea rebum. Stet clita kasd gubergren, no
et accusam et [justo duo dolores][1] et ea rebum. Stet clita kasd gubergren, no
sea [takimata sanctus](./showcase.md) est Lorem ipsum dolor sit amet.

Ask to <user@example.com>.
Expand Down Expand Up @@ -216,7 +216,7 @@ What about \*this\* or \*\*that\*\*?

\[disabled named link\]: target

[named-link](bah)
[named-link][enabled]

\[disabled named link\]\[disabled\]

Expand Down Expand Up @@ -245,4 +245,6 @@ foo
[Links]: http://www.example.com/shortcut
[`diam`]: http://www.example.com/shortcut_code_diam
[`voluptua`]: http://www.example.com/shortcut_code_voluptua
[Images]: http://www.example.com/another_shortcut
[1]: http://www.example.com/reference
[Images]: http://www.example.com/another_shortcut
[enabled]: bah
8 changes: 5 additions & 3 deletions tests/fixtures/snapshots/stupicat-output
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ tempor invidunt ut labore et dolore magna aliquyam erat
Lorem ipsum dolor sit amet, [consetetur
sadipscing](http://www.example.com/inline) elitr, sed diam nonumy eirmod tempor
invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos
et accusam et [justo duo dolores](http://www.example.com/reference) et ea rebum. Stet clita kasd gubergren, no
et accusam et [justo duo dolores][1] et ea rebum. Stet clita kasd gubergren, no
sea [takimata sanctus](./showcase.md) est Lorem ipsum dolor sit amet.

Ask to <user@example.com>.
Expand Down Expand Up @@ -216,7 +216,7 @@ What about \*this\* or \*\*that\*\*?

\[disabled named link\]: target

[named-link](bah)
[named-link][enabled]

\[disabled named link\]\[disabled\]

Expand Down Expand Up @@ -245,4 +245,6 @@ foo
[Links]: http://www.example.com/shortcut
[`diam`]: http://www.example.com/shortcut_code_diam
[`voluptua`]: http://www.example.com/shortcut_code_voluptua
[Images]: http://www.example.com/another_shortcut
[1]: http://www.example.com/reference
[Images]: http://www.example.com/another_shortcut
[enabled]: bah
32 changes: 30 additions & 2 deletions tests/fmt.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,21 @@ mod inline_elements {
assert_eq!(
fmts_both("![a](b)\n![c][d]\n\n[d]: e"),
(
"![a](b)\n![c](e)".into(),
"![a](b)\n![c][d]\n\n[d]: e".into(),
State {
newlines_before_start: 2,
..Default::default()
}
)
);
}

#[test]
fn image_collapsed() {
assert_eq!(
fmts_both("![c][d]\n\n![c][]![c][]\n\n[d]: e\n[c]: f"),
(
"![c][d]\n\n![c][]![c][]\n\n[d]: e\n[c]: f".into(),
State {
newlines_before_start: 2,
..Default::default()
Expand Down Expand Up @@ -256,7 +270,21 @@ mod inline_elements {
assert_eq!(
fmts_both("[a](b)\n[c][d]\n\n[d]: e"),
(
"[a](b)\n[c](e)".into(),
"[a](b)\n[c][d]\n\n[d]: e".into(),
State {
newlines_before_start: 2,
..Default::default()
}
)
);
}

#[test]
fn links_collapsed() {
assert_eq!(
fmts_both("[c][d]\n\n[c][][c][]\n\n[d]: e\n[c]: f"),
(
"[c][d]\n\n[c][][c][]\n\n[d]: e\n[c]: f".into(),
State {
newlines_before_start: 2,
..Default::default()
Expand Down

0 comments on commit 3170061

Please sign in to comment.