markdown-rs/tests/link_resource.rs

use markdown::{
    mdast::{Image, Link, Node, Paragraph, Root, Text},
    message, to_html, to_html_with_options, to_mdast,
    unist::Position,
    CompileOptions, Options,
};
use pretty_assertions::assert_eq;

#[test]
fn link_resource() -> Result<(), message::Message> {
    let danger = Options {
        compile: CompileOptions {
            allow_dangerous_html: true,
            allow_dangerous_protocol: true,
            ..Default::default()
        },
        ..Default::default()
    };

    assert_eq!(
        to_html("[link](/uri \"title\")"),
        "<p><a href=\"/uri\" title=\"title\">link</a></p>",
        "should support links"
    );

    assert_eq!(
        to_html("[link](/uri)"),
        "<p><a href=\"/uri\">link</a></p>",
        "should support links w/o title"
    );

    assert_eq!(
        to_html("[link]()"),
        "<p><a href=\"\">link</a></p>",
        "should support links w/o destination"
    );

    assert_eq!(
        to_html("[link](<>)"),
        "<p><a href=\"\">link</a></p>",
        "should support links w/ empty enclosed destination"
    );

    assert_eq!(
        to_html("[link](/my uri)"),
        "<p>[link](/my uri)</p>",
        "should not support links w/ spaces in destination"
    );

    assert_eq!(
        to_html("[link](</my uri>)"),
        "<p><a href=\"/my%20uri\">link</a></p>",
        "should support links w/ spaces in enclosed destination"
    );

    assert_eq!(
        to_html("[link](foo\nbar)"),
        "<p>[link](foo\nbar)</p>",
        "should not support links w/ line endings in destination"
    );

    assert_eq!(
        to_html_with_options("[link](<foo\nbar>)", &danger)?,
        "<p>[link](<foo\nbar>)</p>",
        "should not support links w/ line endings in enclosed destination"
    );

    assert_eq!(
        to_html("[a](<b)c>)"),
        "<p><a href=\"b)c\">a</a></p>",
        "should support links w/ closing parens in destination"
    );

    assert_eq!(
        to_html("[link](<foo\\>)"),
        "<p>[link](&lt;foo&gt;)</p>",
        "should not support links w/ enclosed destinations w/o end"
    );

    assert_eq!(
        to_html_with_options("[a](<b)c\n[a](<b)c>\n[a](<b>c)", &danger)?,
        "<p>[a](&lt;b)c\n[a](&lt;b)c&gt;\n[a](<b>c)</p>",
        "should not support links w/ unmatched enclosed destinations"
    );

    assert_eq!(
        to_html("[link](\\(foo\\))"),
        "<p><a href=\"(foo)\">link</a></p>",
        "should support links w/ destinations w/ escaped parens"
    );

    assert_eq!(
        to_html("[link](foo(and(bar)))"),
        "<p><a href=\"foo(and(bar))\">link</a></p>",
        "should support links w/ destinations w/ balanced parens"
    );

    assert_eq!(
        to_html("[link](foo\\(and\\(bar\\))"),
        "<p><a href=\"foo(and(bar)\">link</a></p>",
        "should support links w/ destinations w/ escaped parens"
    );

    assert_eq!(
        to_html("[link](<foo(and(bar)>)"),
        "<p><a href=\"foo(and(bar)\">link</a></p>",
        "should support links w/ enclosed destinations w/ parens"
    );

    assert_eq!(
        to_html_with_options("[link](foo\\)\\:)", &danger)?,
        "<p><a href=\"foo):\">link</a></p>",
        "should support links w/ escapes in destinations"
    );

    assert_eq!(
        to_html("[link](#fragment)"),
        "<p><a href=\"#fragment\">link</a></p>",
        "should support links w/ destinations to fragments"
    );

    assert_eq!(
        to_html("[link](http://example.com#fragment)"),
        "<p><a href=\"http://example.com#fragment\">link</a></p>",
        "should support links w/ destinations to URLs w/ fragments"
    );

    assert_eq!(
        to_html("[link](http://example.com?foo=3#frag)"),
        "<p><a href=\"http://example.com?foo=3#frag\">link</a></p>",
        "should support links w/ destinations to URLs w/ search and fragments"
    );

    assert_eq!(
        to_html("[link](foo\\bar)"),
        "<p><a href=\"foo%5Cbar\">link</a></p>",
        "should not support non-punctuation character escapes in links"
    );

    assert_eq!(
        to_html("[link](foo%20b&auml;)"),
        "<p><a href=\"foo%20b%C3%A4\">link</a></p>",
        "should support character references in links"
    );

    assert_eq!(
        to_html("[link](\"title\")"),
        "<p><a href=\"%22title%22\">link</a></p>",
        "should not support links w/ only a title"
    );

    assert_eq!(
        to_html("[link](/url \"title\")"),
        "<p><a href=\"/url\" title=\"title\">link</a></p>",
        "should support titles w/ double quotes"
    );

    assert_eq!(
        to_html("[link](/url 'title')"),
        "<p><a href=\"/url\" title=\"title\">link</a></p>",
        "should support titles w/ single quotes"
    );

    assert_eq!(
        to_html("[link](/url (title))"),
        "<p><a href=\"/url\" title=\"title\">link</a></p>",
        "should support titles w/ parens"
    );

    assert_eq!(
        to_html("[link](/url \"title \\\"&quot;\")"),
        "<p><a href=\"/url\" title=\"title &quot;&quot;\">link</a></p>",
        "should support character references and escapes in titles"
    );

    assert_eq!(
        to_html("[link](/url \"title\")"),
        "<p><a href=\"/url%C2%A0%22title%22\">link</a></p>",
        "should not support unicode whitespace between destination and title"
    );

    assert_eq!(
        to_html("[link](/url \"title \"and\" title\")"),
        "<p>[link](/url &quot;title &quot;and&quot; title&quot;)</p>",
        "should not support nested balanced quotes in title"
    );

    assert_eq!(
        to_html("[link](/url 'title \"and\" title')"),
        "<p><a href=\"/url\" title=\"title &quot;and&quot; title\">link</a></p>",
        "should support the other quotes in titles"
    );

    assert_eq!(
        to_html("[link](   /uri\n  \"title\"  )"),
        "<p><a href=\"/uri\" title=\"title\">link</a></p>",
        "should support whitespace around destination and title (1)"
    );

    assert_eq!(
        to_html("[link](\t\n/uri \"title\")"),
        "<p><a href=\"/uri\" title=\"title\">link</a></p>",
        "should support whitespace around destination and title (2)"
    );

    assert_eq!(
        to_html("[link](/uri  \"title\"\t\n)"),
        "<p><a href=\"/uri\" title=\"title\">link</a></p>",
        "should support whitespace around destination and title (3)"
    );

    assert_eq!(
        to_html("[link] (/uri)"),
        "<p>[link] (/uri)</p>",
        "should not support whitespace between label and resource"
    );

    assert_eq!(
        to_html("[link [foo [bar]]](/uri)"),
        "<p><a href=\"/uri\">link [foo [bar]]</a></p>",
        "should support balanced brackets"
    );

    assert_eq!(
        to_html("[link] bar](/uri)"),
        "<p>[link] bar](/uri)</p>",
        "should not support unbalanced brackets (1)"
    );

    assert_eq!(
        to_html("[link [bar](/uri)"),
        "<p>[link <a href=\"/uri\">bar</a></p>",
        "should not support unbalanced brackets (2)"
    );

    assert_eq!(
        to_html("[link \\[bar](/uri)"),
        "<p><a href=\"/uri\">link [bar</a></p>",
        "should support characer escapes"
    );

    assert_eq!(
        to_html("[link *foo **bar** `#`*](/uri)"),
        "<p><a href=\"/uri\">link <em>foo <strong>bar</strong> <code>#</code></em></a></p>",
        "should support content"
    );

    assert_eq!(
        to_html("[![moon](moon.jpg)](/uri)"),
        "<p><a href=\"/uri\"><img src=\"moon.jpg\" alt=\"moon\" /></a></p>",
        "should support an image as content"
    );

    assert_eq!(
        to_html("[foo [bar](/uri)](/uri)"),
        "<p>[foo <a href=\"/uri\">bar</a>](/uri)</p>",
        "should not support links in links (1)"
    );

    assert_eq!(
        to_html("[foo *[bar [baz](/uri)](/uri)*](/uri)"),
        "<p>[foo <em>[bar <a href=\"/uri\">baz</a>](/uri)</em>](/uri)</p>",
        "should not support links in links (2)"
    );

    assert_eq!(
        to_html("![[[foo](uri1)](uri2)](uri3)"),
        "<p><img src=\"uri3\" alt=\"[foo](uri2)\" /></p>",
        "should not support links in links (3)"
    );

    assert_eq!(
        to_html("*[foo*](/uri)"),
        "<p>*<a href=\"/uri\">foo*</a></p>",
        "should prefer links over emphasis (1)"
    );

    assert_eq!(
        to_html("[foo *bar](baz*)"),
        "<p><a href=\"baz*\">foo *bar</a></p>",
        "should prefer links over emphasis (2)"
    );

    assert_eq!(
        to_html_with_options("[foo <bar attr=\"](baz)\">", &danger)?,
        "<p>[foo <bar attr=\"](baz)\"></p>",
        "should prefer HTML over links"
    );

    assert_eq!(
        to_html("[foo`](/uri)`"),
        "<p>[foo<code>](/uri)</code></p>",
        "should prefer code over links"
    );

    assert_eq!(
        to_html("[foo<http://example.com/?search=](uri)>"),
        "<p>[foo<a href=\"http://example.com/?search=%5D(uri)\">http://example.com/?search=](uri)</a></p>",
        "should prefer autolinks over links"
    );

    assert_eq!(
        to_html("[foo<http://example.com/?search=](uri)>"),
        "<p>[foo<a href=\"http://example.com/?search=%5D(uri)\">http://example.com/?search=](uri)</a></p>",
        "should prefer autolinks over links"
    );

    // Extra
    assert_eq!(
        to_html("[]()"),
        "<p><a href=\"\"></a></p>",
        "should support an empty link"
    );

    // See: <https://github.com/commonmark/commonmark.js/issues/192>
    assert_eq!(
        to_html("[](<> \"\")"),
        "<p><a href=\"\"></a></p>",
        "should ignore an empty title"
    );

    assert_eq!(
        to_html_with_options("[a](<b>\"c\")", &danger)?,
        "<p>[a](<b>&quot;c&quot;)</p>",
        "should require whitespace between enclosed destination and title"
    );

    assert_eq!(
        to_html("[](<"),
        "<p>[](&lt;</p>",
        "should not support an unclosed enclosed destination"
    );

    assert_eq!(
        to_html("[]("),
        "<p>[](</p>",
        "should not support an unclosed destination"
    );

    assert_eq!(
        to_html("[](\\<)"),
        "<p><a href=\"%3C\"></a></p>",
        "should support unenclosed link destination starting w/ escapes"
    );

    assert_eq!(
        to_html("[](<\\<>)"),
        "<p><a href=\"%3C\"></a></p>",
        "should support enclosed link destination starting w/ escapes"
    );

    assert_eq!(
        to_html("[](\\"),
        "<p>[](\\</p>",
        "should not support unenclosed link destination starting w/ an incorrect escape"
    );

    assert_eq!(
        to_html("[](<\\"),
        "<p>[](&lt;\\</p>",
        "should not support enclosed link destination starting w/ an incorrect escape"
    );

    assert_eq!(
        to_html("[](a \""),
        "<p>[](a &quot;</p>",
        "should not support an eof in a link title (1)"
    );

    assert_eq!(
        to_html("[](a '"),
        "<p>[](a '</p>",
        "should not support an eof in a link title (2)"
    );

    assert_eq!(
        to_html("[](a ("),
        "<p>[](a (</p>",
        "should not support an eof in a link title (3)"
    );

    assert_eq!(
        to_html("[](a \"\\"),
        "<p>[](a &quot;\\</p>",
        "should not support an eof in a link title escape (1)"
    );

    assert_eq!(
        to_html("[](a '\\"),
        "<p>[](a '\\</p>",
        "should not support an eof in a link title escape (2)"
    );

    assert_eq!(
        to_html("[](a (\\"),
        "<p>[](a (\\</p>",
        "should not support an eof in a link title escape (3)"
    );

    assert_eq!(
        to_html("[](a \"\\\"\")"),
        "<p><a href=\"a\" title=\"&quot;\"></a></p>",
        "should support a character escape to start a link title (1)"
    );

    assert_eq!(
        to_html("[](a '\\'')"),
        "<p><a href=\"a\" title=\"\'\"></a></p>",
        "should support a character escape to start a link title (2)"
    );

    assert_eq!(
        to_html("[](a (\\)))"),
        "<p><a href=\"a\" title=\")\"></a></p>",
        "should support a character escape to start a link title (3)"
    );

    assert_eq!(
        to_html("[&amp;&copy;&](example.com/&amp;&copy;& \"&amp;&copy;&\")"),
        "<p><a href=\"example.com/&amp;%C2%A9&amp;\" title=\"&amp;©&amp;\">&amp;©&amp;</a></p>",
        "should support character references in links"
    );

    assert_eq!(
        to_html("[a](1())"),
        "<p><a href=\"1()\">a</a></p>",
        "should support 1 set of parens"
    );

    assert_eq!(
        to_html("[a](1(2()))"),
        "<p><a href=\"1(2())\">a</a></p>",
        "should support 2 sets of parens"
    );

    assert_eq!(
        to_html(
            "[a](1(2(3(4(5(6(7(8(9(10(11(12(13(14(15(16(17(18(19(20(21(22(23(24(25(26(27(28(29(30(31(32()))))))))))))))))))))))))))))))))"),
        "<p><a href=\"1(2(3(4(5(6(7(8(9(10(11(12(13(14(15(16(17(18(19(20(21(22(23(24(25(26(27(28(29(30(31(32())))))))))))))))))))))))))))))))\">a</a></p>",
        "should support 32 sets of parens"
    );

    assert_eq!(
        to_html(
            "[a](1(2(3(4(5(6(7(8(9(10(11(12(13(14(15(16(17(18(19(20(21(22(23(24(25(26(27(28(29(30(31(32(33())))))))))))))))))))))))))))))))))"),
        "<p>[a](1(2(3(4(5(6(7(8(9(10(11(12(13(14(15(16(17(18(19(20(21(22(23(24(25(26(27(28(29(30(31(32(33())))))))))))))))))))))))))))))))))</p>",
        "should not support 33 or more sets of parens"
    );

    assert_eq!(
        to_html("[a](b \"\n c\")"),
        "<p><a href=\"b\" title=\"\nc\">a</a></p>",
        "should support an eol at the start of a title"
    );

    assert_eq!(
        to_html("[a](b( \"c\")"),
        "<p>[a](b( &quot;c&quot;)</p>",
        "should not support whitespace when unbalanced in a raw destination"
    );

    assert_eq!(
        to_html("[a](\0)"),
        "<p><a href=\"%EF%BF%BD\">a</a></p>",
        "should support a single NUL character as a link resource"
    );

    assert_eq!(
        to_mdast(
            "a [alpha]() b [bravo](charlie 'delta') c.",
            &Default::default()
        )?,
        Node::Root(Root {
            children: vec![Node::Paragraph(Paragraph {
                children: vec![
                    Node::Text(Text {
                        value: "a ".into(),
                        position: Some(Position::new(1, 1, 0, 1, 3, 2))
                    }),
                    Node::Link(Link {
                        url: String::new(),
                        title: None,
                        children: vec![Node::Text(Text {
                            value: "alpha".into(),
                            position: Some(Position::new(1, 4, 3, 1, 9, 8))
                        }),],
                        position: Some(Position::new(1, 3, 2, 1, 12, 11))
                    }),
                    Node::Text(Text {
                        value: " b ".into(),
                        position: Some(Position::new(1, 12, 11, 1, 15, 14))
                    }),
                    Node::Link(Link {
                        url: "charlie".into(),
                        title: Some("delta".into()),
                        children: vec![Node::Text(Text {
                            value: "bravo".into(),
                            position: Some(Position::new(1, 16, 15, 1, 21, 20))
                        }),],
                        position: Some(Position::new(1, 15, 14, 1, 39, 38))
                    }),
                    Node::Text(Text {
                        value: " c.".into(),
                        position: Some(Position::new(1, 39, 38, 1, 42, 41))
                    })
                ],
                position: Some(Position::new(1, 1, 0, 1, 42, 41))
            })],
            position: Some(Position::new(1, 1, 0, 1, 42, 41))
        }),
        "should support link (resource) as `Link`s in mdast"
    );

    assert_eq!(
        to_mdast("[![name](image)](url)", &Default::default())?,
        Node::Root(Root {
            children: vec![Node::Paragraph(Paragraph {
                children: vec![Node::Link(Link {
                    children: vec![Node::Image(Image {
                        alt: "name".into(),
                        url: "image".into(),
                        title: None,
                        position: Some(Position::new(1, 2, 1, 1, 16, 15)),
                    }),],
                    url: "url".into(),
                    title: None,
                    position: Some(Position::new(1, 1, 0, 1, 22, 21)),
                }),],
                position: Some(Position::new(1, 1, 0, 1, 22, 21)),
            }),],
            position: Some(Position::new(1, 1, 0, 1, 22, 21))
        }),
        "should support nested links in mdast"
    );

    Ok(())
}