Add heading (setext)

1 files changed, 279 insertions, 0 deletions

diff --git a/tests/heading_setext.rs b/tests/heading_setext.rs
new file mode 100644
index 0000000..92a5b43
--- /dev/null
+++ b/tests/heading_setext.rs
@@ -0,0 +1,279 @@
+extern crate micromark;
+use micromark::micromark;
+
+#[test]
+fn heading_setext() {
+    // To do: emphasis.
+    // assert_eq!(
+    //     micromark("Foo *bar*\n========="),
+    //     "<h1>Foo <em>bar</em></h1>",
+    //     "should support a heading w/ an equals to (rank of 1)"
+    // );
+
+    // To do: emphasis.
+    // assert_eq!(
+    //     micromark("Foo *bar*\n---------"),
+    //     "<h2>Foo <em>bar</em></h2>",
+    //     "should support a heading w/ a dash (rank of 2)"
+    // );
+
+    // To do: emphasis.
+    // assert_eq!(
+    //     micromark("Foo *bar\nbaz*\n===="),
+    //     "<h1>Foo <em>bar\nbaz</em></h1>",
+    //     "should support line endings in setext headings"
+    // );
+
+    // To do: emphasis, trim.
+    // assert_eq!(
+    //     micromark("  Foo *bar\nbaz*\t\n===="),
+    //     "<h1>Foo <em>bar\nbaz</em></h1>",
+    //     "should not include initial and final whitespace around content"
+    // );
+
+    assert_eq!(
+        micromark("Foo\n-------------------------"),
+        "<h2>Foo</h2>",
+        "should support long underlines"
+    );
+
+    assert_eq!(
+        micromark("Foo\n="),
+        "<h1>Foo</h1>",
+        "should support short underlines"
+    );
+
+    assert_eq!(
+        micromark(" Foo\n  ==="),
+        "<h1>Foo</h1>",
+        "should support indented content w/ 1 space"
+    );
+
+    assert_eq!(
+        micromark("  Foo\n---"),
+        "<h2>Foo</h2>",
+        "should support indented content w/ 2 spaces"
+    );
+
+    assert_eq!(
+        micromark("   Foo\n---"),
+        "<h2>Foo</h2>",
+        "should support indented content w/ 3 spaces"
+    );
+
+    assert_eq!(
+        micromark("    Foo\n    ---"),
+        "<pre><code>Foo\n---\n</code></pre>",
+        "should not support too much indented content (1)"
+    );
+
+    assert_eq!(
+        micromark("    Foo\n---"),
+        "<pre><code>Foo\n</code></pre>\n<hr />",
+        "should not support too much indented content (2)"
+    );
+
+    assert_eq!(
+        micromark("Foo\n   ----      "),
+        "<h2>Foo</h2>",
+        "should support initial and final whitespace around the underline"
+    );
+
+    assert_eq!(
+        micromark("Foo\n   ="),
+        "<h1>Foo</h1>",
+        "should support whitespace before underline"
+    );
+
+    // To do: trim paragraphs.
+    // assert_eq!(
+    //     micromark("Foo\n    ="),
+    //     "<p>Foo\n=</p>",
+    //     "should not support too much whitespace before underline (1)"
+    // );
+
+    // To do: trim paragraphs.
+    // assert_eq!(
+    //     micromark("Foo\n\t="),
+    //     "<p>Foo\n=</p>",
+    //     "should not support too much whitespace before underline (2)"
+    // );
+
+    assert_eq!(
+        micromark("Foo\n= ="),
+        "<p>Foo\n= =</p>",
+        "should not support whitespace in the underline (1)"
+    );
+
+    assert_eq!(
+        micromark("Foo\n--- -"),
+        "<p>Foo</p>\n<hr />",
+        "should not support whitespace in the underline (2)"
+    );
+
+    // To do: trim setext.
+    // assert_eq!(
+    //     micromark("Foo  \n-----"),
+    //     "<h2>Foo</h2>",
+    //     "should not support a hard break w/ spaces at the end"
+    // );
+
+    assert_eq!(
+        micromark("Foo\\\n-----"),
+        "<h2>Foo\\</h2>",
+        "should not support a hard break w/ backslash at the end"
+    );
+
+    assert_eq!(
+        micromark("`Foo\n----\n`"),
+        "<h2>`Foo</h2>\n<p>`</p>",
+        "should precede over inline constructs (1)"
+    );
+
+    assert_eq!(
+        micromark("<a title=\"a lot\n---\nof dashes\"/>"),
+        "<h2>&lt;a title=&quot;a lot</h2>\n<p>of dashes&quot;/&gt;</p>",
+        "should precede over inline constructs (2)"
+    );
+
+    // To do: block quote.
+    // assert_eq!(
+    //     micromark("> Foo\n---"),
+    //     "<blockquote>\n<p>Foo</p>\n</blockquote>\n<hr />",
+    //     "should not allow underline to be lazy (1)"
+    // );
+
+    // To do: block quote.
+    // assert_eq!(
+    //     micromark("> foo\nbar\n==="),
+    //     "<blockquote>\n<p>foo\nbar\n===</p>\n</blockquote>",
+    //     "should not allow underline to be lazy (2)"
+    // );
+
+    // To do: list.
+    // assert_eq!(
+    //     micromark("- Foo\n---"),
+    //     "<ul>\n<li>Foo</li>\n</ul>\n<hr />",
+    //     "should not allow underline to be lazy (3)"
+    // );
+
+    assert_eq!(
+        micromark("Foo\nBar\n---"),
+        "<h2>Foo\nBar</h2>",
+        "should support line endings in setext headings"
+    );
+
+    assert_eq!(
+        micromark("---\nFoo\n---\nBar\n---\nBaz"),
+        "<hr />\n<h2>Foo</h2>\n<h2>Bar</h2>\n<p>Baz</p>",
+        "should support adjacent setext headings"
+    );
+
+    assert_eq!(
+        micromark("\n===="),
+        "<p>====</p>",
+        "should not support empty setext headings"
+    );
+
+    assert_eq!(
+        micromark("---\n---"),
+        "<hr />\n<hr />",
+        "should prefer other constructs over setext headings (1)"
+    );
+
+    // To do: list.
+    // assert_eq!(
+    //     micromark("- foo\n-----"),
+    //     "<ul>\n<li>foo</li>\n</ul>\n<hr />",
+    //     "should prefer other constructs over setext headings (2)"
+    // );
+
+    assert_eq!(
+        micromark("    foo\n---"),
+        "<pre><code>foo\n</code></pre>\n<hr />",
+        "should prefer other constructs over setext headings (3)"
+    );
+
+    // To do: block quote.
+    // assert_eq!(
+    //     micromark("> foo\n-----"),
+    //     "<blockquote>\n<p>foo</p>\n</blockquote>\n<hr />",
+    //     "should prefer other constructs over setext headings (4)"
+    // );
+
+    assert_eq!(
+        micromark("\\> foo\n------"),
+        "<h2>&gt; foo</h2>",
+        "should support starting w/ character escapes"
+    );
+
+    assert_eq!(
+        micromark("Foo\nbar\n---\nbaz"),
+        "<h2>Foo\nbar</h2>\n<p>baz</p>",
+        "paragraph and heading interplay (1)"
+    );
+
+    assert_eq!(
+        micromark("Foo\n\nbar\n---\nbaz"),
+        "<p>Foo</p>\n<h2>bar</h2>\n<p>baz</p>",
+        "paragraph and heading interplay (2)"
+    );
+
+    assert_eq!(
+        micromark("Foo\nbar\n\n---\n\nbaz"),
+        "<p>Foo\nbar</p>\n<hr />\n<p>baz</p>",
+        "paragraph and heading interplay (3)"
+    );
+
+    assert_eq!(
+        micromark("Foo\nbar\n* * *\nbaz"),
+        "<p>Foo\nbar</p>\n<hr />\n<p>baz</p>",
+        "paragraph and heading interplay (4)"
+    );
+
+    assert_eq!(
+        micromark("Foo\nbar\n\\---\nbaz"),
+        "<p>Foo\nbar\n---\nbaz</p>",
+        "paragraph and heading interplay (5)"
+    );
+
+    // Extra:
+    assert_eq!(
+        micromark("Foo  \nbar\n-----"),
+        "<h2>Foo<br />\nbar</h2>",
+        "should support a hard break w/ spaces in between"
+    );
+
+    assert_eq!(
+        micromark("Foo\\\nbar\n-----"),
+        "<h2>Foo<br />\nbar</h2>",
+        "should support a hard break w/ backslash in between"
+    );
+
+    assert_eq!(
+        micromark("a\n-\nb"),
+        "<h2>a</h2>\n<p>b</p>",
+        "should prefer a setext heading over an interrupting list"
+    );
+
+    // To do: block quote.
+    // assert_eq!(
+    //     micromark("> ===\na"),
+    //     "<blockquote>\n<p>===\na</p>\n</blockquote>",
+    //     "should not support lazyness (1)"
+    // );
+
+    // To do: block quote.
+    // assert_eq!(
+    //     micromark("> a\n==="),
+    //     "<blockquote>\n<p>a\n===</p>\n</blockquote>",
+    //     "should not support lazyness (2)"
+    // );
+
+    // To do: turning things off.
+    //   assert_eq!(
+    //     micromark("a\n-", {extensions: [{disable: {null: ["setextUnderline"]}}]}),
+    //     "<p>a\n-</p>",
+    //     "should support turning off setext underlines"
+    //   );
+}