From 24fec22e912c1aa2569e95683ca95edf1aafce8b Mon Sep 17 00:00:00 2001
From: Titus Wormer
Date: Fri, 17 Jun 2022 17:45:50 +0200
Subject: Add support for definitions
* Add definitions
* Add partials for label, destination, title
* Add `go`, to attempt something, and do something else on `ok`
---
tests/character_escape.rs | 2 +-
tests/character_reference.rs | 2 +-
tests/definition.rs | 446 +++++++++++++++++++++++++++++++++++++++++++
3 files changed, 448 insertions(+), 2 deletions(-)
create mode 100644 tests/definition.rs
(limited to 'tests')
diff --git a/tests/character_escape.rs b/tests/character_escape.rs
index 9e2a5c8..ba94ab3 100644
--- a/tests/character_escape.rs
+++ b/tests/character_escape.rs
@@ -67,7 +67,7 @@ fn character_escape() {
// "should escape in resource and title"
// );
- // To do: definition.
+ // To do: link (reference).
// assert_eq!(
// micromark("[foo]: /bar\\* \"ti\\*tle\"\n\n[foo]"),
// "foo
",
diff --git a/tests/character_reference.rs b/tests/character_reference.rs
index e351088..bcd0aca 100644
--- a/tests/character_reference.rs
+++ b/tests/character_reference.rs
@@ -61,7 +61,7 @@ fn character_reference() {
// "should support character references in resource URLs and titles"
// );
- // To do: definition.
+ // To do: link (resource).
// assert_eq!(
// micromark("[foo]: /föö \"föö\"\n\n[foo]"),
// "foo
",
diff --git a/tests/definition.rs b/tests/definition.rs
new file mode 100644
index 0000000..f0869a3
--- /dev/null
+++ b/tests/definition.rs
@@ -0,0 +1,446 @@
+extern crate micromark;
+use micromark::{micromark, micromark_with_options, CompileOptions};
+
+const DANGER: &CompileOptions = &CompileOptions {
+ allow_dangerous_html: true,
+ allow_dangerous_protocol: true,
+};
+
+#[test]
+fn definition() {
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]: /url \"title\"\n\n[foo]"),
+ // "foo
",
+ // "should support link definitions"
+ // );
+
+ assert_eq!(
+ micromark("[foo]:\n\n/url\n\n[foo]"),
+ "[foo]:
\n/url
\n[foo]
",
+ "should not support blank lines before destination"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark(" [foo]: \n /url \n 'the title' \n\n[foo]"),
+ // "foo
",
+ // "should support whitespace and line endings in definitions"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[Foo*bar\\]]:my_(url) 'title (with parens)'\n\n[Foo*bar\\]]"),
+ // "Foo*bar]
",
+ // "should support complex definitions (1)"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[Foo bar]:\n\n'title'\n\n[Foo bar]"),
+ // "Foo bar
",
+ // "should support complex definitions (2)"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]: /url '\ntitle\nline1\nline2\n'\n\n[foo]"),
+ // "foo
",
+ // "should support line endings in titles"
+ // );
+
+ // To do: some bug
+ // assert_eq!(
+ // micromark("[foo]: /url 'title\n\nwith blank line'\n\n[foo]"),
+ // "[foo]: /url 'title
\nwith blank line'
\n[foo]
",
+ // "should not support blank lines in titles"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]:\n/url\n\n[foo]"),
+ // "foo
",
+ // "should support definitions w/o title"
+ // );
+
+ assert_eq!(
+ micromark("[foo]:\n\n[foo]"),
+ "[foo]:
\n[foo]
",
+ "should not support definitions w/o destination"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]: <>\n\n[foo]"),
+ // "foo
",
+ // "should support definitions w/ explicit empty destinations"
+ // );
+
+ assert_eq!(
+ micromark_with_options("[foo]: (baz)\n\n[foo]", DANGER),
+ "[foo]: (baz)
\n[foo]
",
+ "should not support definitions w/ no whitespace between destination and title"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]: /url\\bar\\*baz \"foo\\\"bar\\baz\"\n\n[foo]"),
+ // "foo
",
+ // "should support character escapes in destinations and titles"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]\n\n[foo]: url"),
+ // "foo
\n",
+ // "should support a link before a definition"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]: first\n[foo]: second\n\n[foo]"),
+ // "foo
",
+ // "should match w/ the first definition"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[FOO]: /url\n\n[Foo]"),
+ // "Foo
",
+ // "should match w/ case-insensitive (1)"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[ΑΓΩ]: /φου\n\n[αγω]"),
+ // "αγω
",
+ // "should match w/ case-insensitive (2)"
+ // );
+
+ assert_eq!(
+ micromark("[foo]: /url"),
+ "",
+ "should not contribute anything w/o reference (1)"
+ );
+
+ assert_eq!(
+ micromark("[\nfoo\n]: /url\nbar"),
+ "bar
",
+ "should not contribute anything w/o reference (2)"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]: /url \"title\" \n\n[foo]"),
+ // "foo
",
+ // "should support whitespace after title"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]: /url\n\"title\" \n\n[foo]"),
+ // "foo
",
+ // "should support whitespace after title on a separate line"
+ // );
+
+ assert_eq!(
+ micromark("[foo]: /url \"title\" ok"),
+ "[foo]: /url "title" ok
",
+ "should not support non-whitespace content after definitions (1)"
+ );
+
+ assert_eq!(
+ micromark("[foo]: /url\n\"title\" ok"),
+ ""title" ok
",
+ "should not support non-whitespace content after definitions (2)"
+ );
+
+ assert_eq!(
+ micromark(" [foo]: /url \"title\"\n\n[foo]"),
+ "[foo]: /url "title"\n
\n[foo]
",
+ "should prefer indented code over definitions"
+ );
+
+ assert_eq!(
+ micromark("```\n[foo]: /url\n```\n\n[foo]"),
+ "[foo]: /url\n
\n[foo]
",
+ "should not support definitions in fenced code"
+ );
+
+ assert_eq!(
+ micromark("Foo\n[bar]: /baz\n\n[bar]"),
+ "Foo\n[bar]: /baz
\n[bar]
",
+ "should not support definitions in paragraphs"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("# [Foo]\n[foo]: /url\n> bar"),
+ // "\n\nbar
\n
",
+ // "should not support definitions in headings"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]: /url\nbar\n===\n[foo]"),
+ // "bar
\nfoo
",
+ // "should support setext headings after definitions"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[foo]: /url\n===\n[foo]"),
+ // "===\nfoo
",
+ // "should not support setext heading underlines after definitions"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark(
+ // "[foo]: /foo-url \"foo\"\n[bar]: /bar-url\n \"bar\"\n[baz]: /baz-url\n\n[foo],\n[bar],\n[baz]"
+ // ),
+ // "foo,\nbar,\nbaz
",
+ // "should support definitions after definitions"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("> [foo]: /url\n\n[foo]"),
+ // "\n
\nfoo
",
+ // "should support definitions in block quotes"
+ // );
+
+ // Extra
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[\\[\\+\\]]: example.com\n\nLink: [\\[\\+\\]]."),
+ // "Link: [+].
",
+ // "should match w/ character escapes"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: \\\" \\(\\)\\\"\n\n[x]"),
+ // "x
",
+ // "should support character escapes & references in unenclosed destinations"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: <\\> \\+\\>>\n\n[x]"),
+ // "x
",
+ // "should support character escapes & references in enclosed destinations"
+ // );
+
+ assert_eq!(
+ micromark("[x]: <\n\n[x]"),
+ "[x]: <
\n[x]
",
+ "should not support a line ending at start of enclosed destination"
+ );
+
+ assert_eq!(
+ micromark("[x]: [x]: <x
\n[x]
",
+ "should not support a line ending in enclosed destination"
+ );
+
+ assert_eq!(
+ micromark("[x]: \u{000b}a\n\n[x]"),
+ "[x]: \u{000b}a
\n[x]
",
+ "should not support ascii control characters at the start of destination"
+ );
+
+ assert_eq!(
+ micromark("[x]: a\u{000b}b\n\n[x]"),
+ "[x]: a\u{000b}b
\n[x]
",
+ "should not support ascii control characters in destination"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: <\u{000b}a>\n\n[x]"),
+ // "x
",
+ // "should support ascii control characters at the start of enclosed destination"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: \n\n[x]"),
+ // "x
",
+ // "should support ascii control characters in enclosed destinations"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: a \"\\\"\"\n\n[x]"),
+ // "x
",
+ // "should support character escapes at the start of a title"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: a \"\\\"\"\n\n[x]"),
+ // "x
",
+ // "should support double quoted titles"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: a '\"'\n\n[x]"),
+ // "x
",
+ // "should support double quoted titles"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: a (\"\")\n\n[x]"),
+ // "x
",
+ // "should support paren enclosed titles"
+ // );
+
+ assert_eq!(
+ micromark("[x]: a(()\n\n[x]"),
+ "[x]: a(()
\n[x]
",
+ "should not support more opening than closing parens in the destination"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: a(())\n\n[x]"),
+ // "x
",
+ // "should support balanced opening and closing parens in the destination"
+ // );
+
+ assert_eq!(
+ micromark("[x]: a())\n\n[x]"),
+ "[x]: a())
\n[x]
",
+ "should not support more closing than opening parens in the destination"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: a \t\n\n[x]"),
+ // "x
",
+ // "should support trailing whitespace after a destination"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: a \"\"X \t\n\n[x]"),
+ // "x
",
+ // "should support trailing whitespace after a destination"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[&©&]: example.com/&©& \"&©&\"\n\n[&©&]"),
+ // "&©&
",
+ // "should support character references in definitions"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]:\nexample.com\n\n[x]"),
+ // "x
",
+ // "should support a line ending before a destination"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: \t\nexample.com\n\n[x]"),
+ // "x
",
+ // "should support whitespace before a destination"
+ // );
+
+ // See:
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[x]: <> \"\"\n[][x]"),
+ // "
",
+ // "should ignore an empty title"
+ // );
+
+ assert_eq!(
+ micromark_with_options("[a]\n\n[a]: ", DANGER),
+ "[a]
\n[a]: <b
",
+ "should not support a less than in an enclosed destination"
+ );
+
+ assert_eq!(
+ micromark("[a]\n\n[a]: b(c"),
+ "[a]
\n[a]: b(c
",
+ "should not support an extra left paren (`(`) in a raw destination"
+ );
+
+ assert_eq!(
+ micromark("[a]\n\n[a]: b)c"),
+ "[a]
\n[a]: b)c
",
+ "should not support an extra right paren (`)`) in a raw destination"
+ );
+
+ assert_eq!(
+ micromark("[a]\n\n[a]: b)c"),
+ "[a]
\n[a]: b)c
",
+ "should not support an extra right paren (`)`) in a raw destination"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[a]\n\n[a]: a(1(2(3(4()))))b"),
+ // "a
\n",
+ // "should support 4 or more sets of parens in a raw destination (link resources don’t)"
+ // );
+
+ assert_eq!(
+ micromark("[a]\n\n[a]: aaa)"),
+ "[a]
\n[a]: aaa)
",
+ "should not support a final (unbalanced) right paren in a raw destination"
+ );
+
+ assert_eq!(
+ micromark("[a]\n\n[a]: aaa) \"a\""),
+ "[a]
\n[a]: aaa) "a"
",
+ "should not support a final (unbalanced) right paren in a raw destination “before” a title"
+ );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark(" [a]: b \"c\"\n [d]: e\n [f]: g \"h\"\n [i]: j\n\t[k]: l (m)\n\t n [k] o"),
+ // "n k o
",
+ // "should support subsequent indented definitions"
+ // );
+
+ // To do: link (reference).
+ // assert_eq!(
+ // micromark("[a\n b]: c\n\n[a\n b]"),
+ // "a\nb
",
+ // "should support line prefixes in definition labels"
+ // );
+
+ assert_eq!(
+ micromark("[a]: )\n\n[a]"),
+ "[a]: )
\n[a]
",
+ "should not support definitions w/ only a closing paren as a raw destination"
+ );
+
+ assert_eq!(
+ micromark("[a]: )b\n\n[a]"),
+ "[a]: )b
\n[a]
",
+ "should not support definitions w/ closing paren + more text as a raw destination"
+ );
+
+ assert_eq!(
+ micromark("[a]: b)\n\n[a]"),
+ "[a]: b)
\n[a]
",
+ "should not support definitions w/ text + a closing paren as a raw destination"
+ );
+
+ // To do: support turning off things.
+ // assert_eq!(
+ // micromark("[foo]: /url \"title\"", {
+ // extensions: [{disable: {null: ["definition"]}}]
+ // }),
+ // "[foo]: /url "title"
",
+ // "should support turning off definitions"
+ // );
+}
--
cgit