path: root/tests/link_reference.rs

extern crate micromark;
use micromark::{
    mdast::{Definition, LinkReference, Node, Paragraph, ReferenceKind, Root, Text},
    micromark, micromark_to_mdast, micromark_with_options,
    unist::Position,
    CompileOptions, Constructs, Options, ParseOptions,
};
use pretty_assertions::assert_eq;

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

    assert_eq!(
        micromark("[bar]: /url \"title\"\n\n[foo][bar]"),
        "<p><a href=\"/url\" title=\"title\">foo</a></p>",
        "should support link references"
    );

    assert_eq!(
        micromark("[ref]: /uri\n\n[link [foo [bar]]][ref]"),
        "<p><a href=\"/uri\">link [foo [bar]]</a></p>",
        "should support balanced brackets in link references"
    );

    assert_eq!(
        micromark("[ref]: /uri\n\n[link \\[bar][ref]"),
        "<p><a href=\"/uri\">link [bar</a></p>",
        "should support escaped brackets in link references"
    );

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

    assert_eq!(
        micromark("[ref]: /uri\n\n[![moon](moon.jpg)][ref]"),
        "<p><a href=\"/uri\"><img src=\"moon.jpg\" alt=\"moon\" /></a></p>",
        "should support images in link references"
    );

    assert_eq!(
        micromark("[ref]: /uri\n\n[foo [bar](/uri)][ref]"),
        "<p>[foo <a href=\"/uri\">bar</a>]<a href=\"/uri\">ref</a></p>",
        "should not support links in link references"
    );

    assert_eq!(
        micromark("[ref]: /uri\n\n[foo *bar [baz][ref]*][ref]"),
        "<p>[foo <em>bar <a href=\"/uri\">baz</a></em>]<a href=\"/uri\">ref</a></p>",
        "should not support deep links in link references"
    );

    assert_eq!(
        micromark("[ref]: /uri\n\n*[foo*][ref]"),
        "<p>*<a href=\"/uri\">foo*</a></p>",
        "should prefer link references over emphasis (1)"
    );

    assert_eq!(
        micromark("[ref]: /uri\n\n[foo *bar][ref]"),
        "<p><a href=\"/uri\">foo *bar</a></p>",
        "should prefer link references over emphasis (2)"
    );

    assert_eq!(
        micromark_with_options("[ref]: /uri\n\n[foo <bar attr=\"][ref]\">", &danger)?,
        "<p>[foo <bar attr=\"][ref]\"></p>",
        "should prefer HTML over link references"
    );

    assert_eq!(
        micromark("[ref]: /uri\n\n[foo`][ref]`"),
        "<p>[foo<code>][ref]</code></p>",
        "should prefer code over link references"
    );

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

    assert_eq!(
        micromark("[bar]: /url \"title\"\n\n[foo][BaR]"),
        "<p><a href=\"/url\" title=\"title\">foo</a></p>",
        "should match references to definitions case-insensitively"
    );

    assert_eq!(
        micromark("[ТОЛПОЙ]: /url\n\n[Толпой][Толпой] is a Russian word."),
        "<p><a href=\"/url\">Толпой</a> is a Russian word.</p>",
        "should match references to definitions w/ unicode case-folding"
    );

    assert_eq!(
        micromark("[Foo\n  bar]: /url\n\n[Baz][Foo bar]"),
        "<p><a href=\"/url\">Baz</a></p>",
        "should match references to definitions w/ collapsing"
    );

    assert_eq!(
        micromark("[bar]: /url \"title\"\n\n[foo] [bar]"),
        "<p>[foo] <a href=\"/url\" title=\"title\">bar</a></p>",
        "should not support whitespace between label and reference (1)"
    );

    assert_eq!(
        micromark("[bar]: /url \"title\"\n\n[foo]\n[bar]"),
        "<p>[foo]\n<a href=\"/url\" title=\"title\">bar</a></p>",
        "should not support whitespace between label and reference (2)"
    );

    assert_eq!(
        micromark("[foo]: /url1\n\n[foo]: /url2\n\n[bar][foo]"),
        "<p><a href=\"/url1\">bar</a></p>",
        "should prefer earlier definitions"
    );

    assert_eq!(
        micromark("[foo!]: /url\n\n[bar][foo\\!]"),
        "<p>[bar][foo!]</p>",
        "should not match references to definitions w/ escapes"
    );

    assert_eq!(
        micromark("[ref[]: /uri\n\n[foo][ref[]"),
        "<p>[ref[]: /uri</p>\n<p>[foo][ref[]</p>",
        "should not support references w/ brackets (1)"
    );

    assert_eq!(
        micromark("[ref[bar]]: /uri\n\n[foo][ref[bar]]"),
        "<p>[ref[bar]]: /uri</p>\n<p>[foo][ref[bar]]</p>",
        "should not support references w/ brackets (2)"
    );

    assert_eq!(
        micromark("[[[foo]]]: /url\n\n[[[foo]]]"),
        "<p>[[[foo]]]: /url</p>\n<p>[[[foo]]]</p>",
        "should not support references w/ brackets (3)"
    );

    assert_eq!(
        micromark("[ref\\[]: /uri\n\n[foo][ref\\[]"),
        "<p><a href=\"/uri\">foo</a></p>",
        "should match references to definitions w/ matching escapes"
    );

    assert_eq!(
        micromark("[bar\\\\]: /uri\n\n[bar\\\\]"),
        "<p><a href=\"/uri\">bar\\</a></p>",
        "should support escapes"
    );

    assert_eq!(
        micromark("[]: /uri\n\n[]"),
        "<p>[]: /uri</p>\n<p>[]</p>",
        "should not support empty references"
    );

    assert_eq!(
        micromark("[\n ]: /uri\n\n[\n ]"),
        "<p>[\n]: /uri</p>\n<p>[\n]</p>",
        "should not support blank references"
    );

    assert_eq!(
        micromark("[foo]: /url \"title\"\n\n[foo][]"),
        "<p><a href=\"/url\" title=\"title\">foo</a></p>",
        "should support collaped references"
    );

    assert_eq!(
        micromark("[*foo* bar]: /url \"title\"\n\n[*foo* bar][]"),
        "<p><a href=\"/url\" title=\"title\"><em>foo</em> bar</a></p>",
        "should support content in collaped references"
    );

    assert_eq!(
        micromark("[foo]: /url \"title\"\n\n[Foo][]"),
        "<p><a href=\"/url\" title=\"title\">Foo</a></p>",
        "should match references to definitions case-insensitively"
    );

    assert_eq!(
        micromark("[foo]: /url \"title\"\n\n[foo] \n[]"),
        "<p><a href=\"/url\" title=\"title\">foo</a>\n[]</p>",
        "should not support whitespace between label and collaped reference"
    );

    assert_eq!(
        micromark("[foo]: /url \"title\"\n\n[foo]"),
        "<p><a href=\"/url\" title=\"title\">foo</a></p>",
        "should support shortcut references"
    );

    assert_eq!(
        micromark("[*foo* bar]: /url \"title\"\n\n[*foo* bar]"),
        "<p><a href=\"/url\" title=\"title\"><em>foo</em> bar</a></p>",
        "should support content in shortcut references (1)"
    );

    assert_eq!(
        micromark("[*foo* bar]: /url \"title\"\n\n[[*foo* bar]]"),
        "<p>[<a href=\"/url\" title=\"title\"><em>foo</em> bar</a>]</p>",
        "should support content in shortcut references (2)"
    );

    assert_eq!(
        micromark("[foo]: /url\n\n[[bar [foo]"),
        "<p>[[bar <a href=\"/url\">foo</a></p>",
        "should support content in shortcut references (3)"
    );

    assert_eq!(
        micromark("[foo]: /url \"title\"\n\n[Foo]"),
        "<p><a href=\"/url\" title=\"title\">Foo</a></p>",
        "should match shortcut references to definitions case-insensitively"
    );

    assert_eq!(
        micromark("[foo]: /url\n\n[foo] bar"),
        "<p><a href=\"/url\">foo</a> bar</p>",
        "should support whitespace after a shortcut reference"
    );

    assert_eq!(
        micromark("[foo]: /url \"title\"\n\n\\[foo]"),
        "<p>[foo]</p>",
        "should “support” an escaped shortcut reference"
    );

    assert_eq!(
        micromark("[foo*]: /url\n\n*[foo*]"),
        "<p>*<a href=\"/url\">foo*</a></p>",
        "should prefer shortcut references over emphasis"
    );

    assert_eq!(
        micromark("[foo]: /url1\n[bar]: /url2\n\n[foo][bar]"),
        "<p><a href=\"/url2\">foo</a></p>",
        "should prefer full references over shortcut references"
    );

    assert_eq!(
        micromark("[foo]: /url1\n\n[foo][]"),
        "<p><a href=\"/url1\">foo</a></p>",
        "should prefer collapsed references over shortcut references"
    );

    assert_eq!(
        micromark("[foo]: /url\n\n[foo]()"),
        "<p><a href=\"\">foo</a></p>",
        "should prefer resources over shortcut references (1)"
    );

    assert_eq!(
        micromark("[foo]: /url \"title\"\n\n[foo]()"),
        "<p><a href=\"\">foo</a></p>",
        "should prefer resources over shortcut references (2)"
    );

    assert_eq!(
        micromark("[foo]: /url1\n\n[foo](not a link)"),
        "<p><a href=\"/url1\">foo</a>(not a link)</p>",
        "should support shortcut references when followed by nonconforming resources"
    );

    assert_eq!(
        micromark("[baz]: /url\n\n[foo][bar][baz]"),
        "<p>[foo]<a href=\"/url\">bar</a></p>",
        "stable/unstable (1)"
    );

    assert_eq!(
        micromark("[baz]: /url1\n[bar]: /url2\n\n[foo][bar][baz]"),
        "<p><a href=\"/url2\">foo</a><a href=\"/url1\">baz</a></p>",
        "stable/unstable (2)"
    );

    assert_eq!(
        micromark("[baz]: /url1\n[foo]: /url2\n\n[foo][bar][baz]"),
        "<p>[foo]<a href=\"/url1\">bar</a></p>",
        "stable/unstable (3)"
    );

    // Extra
    // This matches most implimentations, but is not strictly according to spec.
    // See: <https://github.com/commonmark/commonmark-spec/issues/653>
    assert_eq!(
        micromark("[x]: /url\n\n[x][ ], [x][\t], [x][\n], [x][]"),
        "<p>[x][ ], [x][\t], [x][\n], <a href=\"/url\">x</a></p>",
        "should not support whitespace-only full references"
    );

    // See also: <https://github.com/commonmark/commonmark-spec/issues/616>
    assert_eq!(
        micromark("[+]: example.com\n[\\;]: example.com\n\nWill it link? [\\+], [;]"),
        "<p>Will it link? [+], [;]</p>",
        "should not support mismatched character escapes in shortcuts"
    );

    assert_eq!(
        micromark("[©]: example.com\n[&amp;]: example.com\n\nWill it link? [&copy;], [&]"),
        "<p>Will it link? [©], [&amp;]</p>",
        "should not support mismatched character references in shortcuts"
    );

    assert_eq!(
        micromark("[+]: example.com\n[\\;]: example.com\n\nWill it link? [\\+][], [;][]"),
        "<p>Will it link? [+][], [;][]</p>",
        "should not support mismatched character escapes in collapsed"
    );

    assert_eq!(
        micromark("[©]: example.com\n[&amp;]: example.com\n\nWill it link? [&copy;][], [&][]"),
        "<p>Will it link? [©][], [&amp;][]</p>",
        "should not support mismatched character references in collapsed"
    );

    assert_eq!(
        micromark("[+]: example.com\n[\\;]: example.com\n\nWill it link? [a][ \\+ ], [b][ ; ]"),
        "<p>Will it link? [a][ + ], [b][ ; ]</p>",
        "should not support mismatched character escapes in fulls"
    );

    assert_eq!(
        micromark(
            "[©]: example.com\n[&amp;]: example.com\n\nWill it link? [a][ &copy; ], [b][ & ]"
        ),
        "<p>Will it link? [a][ © ], [b][ &amp; ]</p>",
        "should not support mismatched character references in fulls"
    );

    assert_eq!(
        micromark(
            "[*f*][]
[&semi;][]
[\\;][]
[;][]
[*f*&semi;][]
[*f*\\;][]
[*f*;][]

[*f*]: alpha
[&semi;]: bravo
[\\;]: charlie
[;]: delta
[*f*&semi;]: echo
[*f*\\;]: foxtrot
[*f*;]: golf"
        ),
        "<p><a href=\"alpha\"><em>f</em></a>
<a href=\"bravo\">;</a>
<a href=\"charlie\">;</a>
<a href=\"delta\">;</a>
<a href=\"echo\"><em>f</em>;</a>
<a href=\"foxtrot\"><em>f</em>;</a>
<a href=\"golf\"><em>f</em>;</a></p>
",
        "should properly handle labels w/ character references and -escapes, and phrasing"
    );

    // 999 `x` characters.
    let max = "x".repeat(999);

    assert_eq!(
        micromark(format!("[{}]: a\n[y][{}]", max, max).as_str()),
        "<p><a href=\"a\">y</a></p>",
        "should support 999 characters in a reference"
    );

    assert_eq!(
        micromark(format!("[{}x]: a\n[y][{}x]", max, max).as_str()),
        format!("<p>[{}x]: a\n[y][{}x]</p>", max, max),
        "should not support 1000 characters in a reference"
    );

    assert_eq!(
        micromark("[x] missing-colon\n\nWill it link? [x]"),
        "<p>[x] missing-colon</p>\n<p>Will it link? [x]</p>",
        "should not fail on a missing colon in a definition"
    );

    assert_eq!(
        micromark_with_options(
            "[x]()",
            &Options {
                parse: ParseOptions {
                    constructs: Constructs {
                        label_start_link: false,
                        ..Constructs::default()
                    },
                    ..ParseOptions::default()
                },
                ..Options::default()
            }
        )?,
        "<p>[x]()</p>",
        "should support turning off label start (link)"
    );

    assert_eq!(
        micromark_with_options(
            "[x]()",
            &Options {
                parse: ParseOptions {
                    constructs: Constructs {
                        label_end: false,
                        ..Constructs::default()
                    },
                    ..ParseOptions::default()
                },
                ..Options::default()
            }
        )?,
        "<p>[x]()</p>",
        "should support turning off label end"
    );

    assert_eq!(
        micromark_to_mdast(
            "[x]: y\n\na [x] b [x][] c [d][x] e.",
            &ParseOptions::default()
        )?,
        Node::Root(Root {
            children: vec![
                Node::Definition(Definition {
                    identifier: "x".into(),
                    label: Some("x".into()),
                    url: "y".into(),
                    title: None,
                    position: Some(Position::new(1, 1, 0, 1, 7, 6))
                }),
                Node::Paragraph(Paragraph {
                    children: vec![
                        Node::Text(Text {
                            value: "a ".into(),
                            position: Some(Position::new(3, 1, 8, 3, 3, 10))
                        }),
                        Node::LinkReference(LinkReference {
                            reference_kind: ReferenceKind::Shortcut,
                            identifier: "x".into(),
                            label: Some("x".into()),
                            children: vec![Node::Text(Text {
                                value: "x".into(),
                                position: Some(Position::new(3, 4, 11, 3, 5, 12))
                            }),],
                            position: Some(Position::new(3, 3, 10, 3, 6, 13))
                        }),
                        Node::Text(Text {
                            value: " b ".into(),
                            position: Some(Position::new(3, 6, 13, 3, 9, 16))
                        }),
                        Node::LinkReference(LinkReference {
                            reference_kind: ReferenceKind::Collapsed,
                            identifier: "x".into(),
                            label: Some("x".into()),
                            children: vec![Node::Text(Text {
                                value: "x".into(),
                                position: Some(Position::new(3, 10, 17, 3, 11, 18))
                            }),],
                            position: Some(Position::new(3, 9, 16, 3, 14, 21))
                        }),
                        Node::Text(Text {
                            value: " c ".into(),
                            position: Some(Position::new(3, 14, 21, 3, 17, 24))
                        }),
                        Node::LinkReference(LinkReference {
                            reference_kind: ReferenceKind::Full,
                            identifier: "x".into(),
                            label: Some("x".into()),
                            children: vec![Node::Text(Text {
                                value: "d".into(),
                                position: Some(Position::new(3, 18, 25, 3, 19, 26))
                            }),],
                            position: Some(Position::new(3, 17, 24, 3, 23, 30))
                        }),
                        Node::Text(Text {
                            value: " e.".into(),
                            position: Some(Position::new(3, 23, 30, 3, 26, 33))
                        }),
                    ],
                    position: Some(Position::new(3, 1, 8, 3, 26, 33))
                }),
            ],
            position: Some(Position::new(1, 1, 0, 3, 26, 33))
        }),
        "should support link (reference) as `LinkReference`s in mdast"
    );

    Ok(())
}