zola/components/rendering/tests/markdown.rs

1608 lines
45 KiB
Rust
Raw Normal View History

2017-07-04 12:27:32 +00:00
use std::collections::HashMap;
use tera::Tera;
2018-05-06 20:58:39 +00:00
use config::Config;
2017-07-04 12:27:32 +00:00
use front_matter::InsertAnchor;
2018-10-31 07:18:57 +00:00
use rendering::{render_content, RenderContext};
use templates::ZOLA_TERA;
use utils::slugs::SlugifyStrategy;
2017-07-04 12:27:32 +00:00
#[test]
2018-05-06 20:58:39 +00:00
fn can_do_render_content_simple() {
2017-07-04 12:27:32 +00:00
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content("hello", &context).unwrap();
2018-08-24 21:37:55 +00:00
assert_eq!(res.body, "<p>hello</p>\n");
2017-07-04 12:27:32 +00:00
}
#[test]
fn doesnt_highlight_code_block_with_highlighting_off() {
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.highlight_code = false;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content("```\n$ gutenberg server\n```", &context).unwrap();
2018-10-31 07:18:57 +00:00
assert_eq!(res.body, "<pre><code>$ gutenberg server\n</code></pre>\n");
2017-07-04 12:27:32 +00:00
}
#[test]
fn can_highlight_code_block_no_lang() {
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.highlight_code = true;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content("```\n$ gutenberg server\n$ ping\n```", &context).unwrap();
2017-07-04 12:27:32 +00:00
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<pre style=\"background-color:#2b303b;color:#c0c5ce;\"><code><span>$ gutenberg server\n</span><span>$ ping\n</span></code></pre>\n"
2017-07-04 12:27:32 +00:00
);
}
#[test]
fn can_highlight_code_block_with_lang() {
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.highlight_code = true;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content("```python\nlist.append(1)\n```", &context).unwrap();
2017-07-04 12:27:32 +00:00
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<pre data-lang=\"python\" style=\"background-color:#2b303b;color:#c0c5ce;\" class=\"language-python \"><code class=\"language-python\" data-lang=\"python\"><span>list.</span><span style=\"color:#bf616a;\">append</span><span>(</span><span style=\"color:#d08770;\">1</span><span>)\n</span></code></pre>\n"
2017-07-04 12:27:32 +00:00
);
}
#[test]
fn can_higlight_code_block_with_unknown_lang() {
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.highlight_code = true;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content("```yolo\nlist.append(1)\n```", &context).unwrap();
2017-07-04 12:27:32 +00:00
// defaults to plain text
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<pre data-lang=\"yolo\" style=\"background-color:#2b303b;color:#c0c5ce;\" class=\"language-yolo \"><code class=\"language-yolo\" data-lang=\"yolo\"><span>list.append(1)\n</span></code></pre>\n"
2017-07-04 12:27:32 +00:00
);
}
#[test]
fn can_render_shortcode() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-10-31 07:18:57 +00:00
let res = render_content(
r#"
2017-07-04 12:27:32 +00:00
Hello
{{ youtube(id="ub36ffWAqgQ") }}
2018-10-31 07:18:57 +00:00
"#,
&context,
)
.unwrap();
2018-08-24 21:37:55 +00:00
assert!(res.body.contains("<p>Hello</p>\n<div >"));
assert!(res
.body
.contains(r#"<iframe src="https://www.youtube-nocookie.com/embed/ub36ffWAqgQ""#));
2017-07-04 12:27:32 +00:00
}
#[test]
fn can_render_shortcode_with_markdown_char_in_args_name() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-10-31 07:18:57 +00:00
let input = vec!["name", "na_me", "n_a_me", "n1"];
for i in input {
2018-10-31 07:18:57 +00:00
let res =
render_content(&format!("{{{{ youtube(id=\"hey\", {}=1) }}}}", i), &context).unwrap();
assert!(res.body.contains(r#"<iframe src="https://www.youtube-nocookie.com/embed/hey""#));
}
}
#[test]
fn can_render_shortcode_with_markdown_char_in_args_value() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let input = vec![
"ub36ffWAqgQ-hey",
"ub36ffWAqgQ_hey",
"ub36ffWAqgQ_he_y",
"ub36ffWAqgQ*hey",
"ub36ffWAqgQ#hey",
];
for i in input {
2018-05-06 20:58:39 +00:00
let res = render_content(&format!("{{{{ youtube(id=\"{}\") }}}}", i), &context).unwrap();
2018-11-14 16:34:21 +00:00
assert!(res
.body
.contains(&format!(r#"<iframe src="https://www.youtube-nocookie.com/embed/{}""#, i)));
}
}
#[test]
fn can_render_html_shortcode_with_lang() {
let permalinks_ctx = HashMap::new();
let config = Config::default_for_test();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
tera.add_raw_template("shortcodes/i18nshortcode.html", "{{ lang }}").unwrap();
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("a{{ i18nshortcode() }}a", &context).unwrap();
assert_eq!(res.body, "<p>aena</p>\n");
}
#[test]
fn can_render_md_shortcode_with_lang() {
let permalinks_ctx = HashMap::new();
let config = Config::default_for_test();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
tera.add_raw_template("shortcodes/i18nshortcode.md", "![Book cover in {{ lang }}](cover.{{ lang }}.png)").unwrap();
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("{{ i18nshortcode() }}", &context).unwrap();
assert_eq!(res.body, "<p><img src=\"cover.en.png\" alt=\"Book cover in en\" /></p>\n");
}
#[test]
fn can_render_body_shortcode_with_markdown_char_in_name() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
2018-10-31 07:18:57 +00:00
let input = vec!["quo_te", "qu_o_te"];
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
for i in input {
2018-10-31 07:18:57 +00:00
tera.add_raw_template(
&format!("shortcodes/{}.html", i),
"<blockquote>{{ body }} - {{ author}}</blockquote>",
)
.unwrap();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-10-31 07:18:57 +00:00
let res =
render_content(&format!("{{% {}(author=\"Bob\") %}}\nhey\n{{% end %}}", i), &context)
.unwrap();
2018-08-24 21:37:55 +00:00
assert!(res.body.contains("<blockquote>hey - Bob</blockquote>"));
}
}
#[test]
fn can_render_body_shortcode_and_paragraph_after() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
let shortcode = "<p>{{ body }}</p>";
let markdown_string = r#"
{% figure() %}
This is a figure caption.
{% end %}
Here is another paragraph.
"#;
let expected = "<p>This is a figure caption.</p>
<p>Here is another paragraph.</p>
";
tera.add_raw_template("shortcodes/figure.html", shortcode).unwrap();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content(markdown_string, &context).unwrap();
2018-08-24 21:37:55 +00:00
assert_eq!(res.body, expected);
}
#[test]
fn can_render_two_body_shortcode_and_paragraph_after_with_line_break_between() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
let shortcode = "<p>{{ body }}</p>";
let markdown_string = r#"
{% figure() %}
This is a figure caption.
{% end %}
{% figure() %}
This is a figure caption.
{% end %}
Here is another paragraph.
"#;
let expected = "<p>This is a figure caption.</p>
<p>This is a figure caption.</p>
<p>Here is another paragraph.</p>
";
tera.add_raw_template("shortcodes/figure.html", shortcode).unwrap();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content(markdown_string, &context).unwrap();
2018-08-24 21:37:55 +00:00
assert_eq!(res.body, expected);
}
2017-07-04 12:27:32 +00:00
#[test]
fn can_render_several_shortcode_in_row() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-10-31 07:18:57 +00:00
let res = render_content(
r#"
2017-07-04 12:27:32 +00:00
Hello
{{ youtube(id="ub36ffWAqgQ") }}
{{ youtube(id="ub36ffWAqgQ", autoplay=true) }}
{{ vimeo(id="210073083") }}
{{ streamable(id="c0ic") }}
{{ gist(url="https://gist.github.com/Keats/32d26f699dcc13ebd41b") }}
2018-10-31 07:18:57 +00:00
"#,
&context,
)
.unwrap();
2018-08-24 21:37:55 +00:00
assert!(res.body.contains("<p>Hello</p>\n<div >"));
2018-11-14 16:34:21 +00:00
assert!(res
.body
.contains(r#"<iframe src="https://www.youtube-nocookie.com/embed/ub36ffWAqgQ""#));
assert!(res.body.contains(
r#"<iframe src="https://www.youtube-nocookie.com/embed/ub36ffWAqgQ?autoplay=1""#
));
2018-08-24 21:37:55 +00:00
assert!(res.body.contains(r#"<iframe src="https://www.streamable.com/e/c0ic""#));
assert!(res.body.contains(r#"//player.vimeo.com/video/210073083""#));
2017-07-04 12:27:32 +00:00
}
2017-10-23 13:54:32 +00:00
#[test]
2018-05-06 20:58:39 +00:00
fn doesnt_render_ignored_shortcodes() {
2017-10-23 13:54:32 +00:00
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.highlight_code = false;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content(r#"```{{/* youtube(id="w7Ft2ymGmfc") */}}```"#, &context).unwrap();
2018-08-24 21:37:55 +00:00
assert_eq!(res.body, "<p><code>{{ youtube(id=&quot;w7Ft2ymGmfc&quot;) }}</code></p>\n");
2017-07-04 12:27:32 +00:00
}
#[test]
fn can_render_shortcode_with_body() {
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
2018-10-31 07:18:57 +00:00
tera.add_raw_template(
"shortcodes/quote.html",
"<blockquote>{{ body }} - {{ author }}</blockquote>",
)
.unwrap();
2017-07-04 12:27:32 +00:00
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2017-07-04 12:27:32 +00:00
2018-10-31 07:18:57 +00:00
let res = render_content(
r#"
2017-07-04 12:27:32 +00:00
Hello
{% quote(author="Keats") %}
A quote
{% end %}
2018-10-31 07:18:57 +00:00
"#,
&context,
)
.unwrap();
2018-08-24 21:37:55 +00:00
assert_eq!(res.body, "<p>Hello</p>\n<blockquote>A quote - Keats</blockquote>\n");
2017-07-04 12:27:32 +00:00
}
#[test]
fn errors_rendering_unknown_shortcode() {
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content("{{ hello(flash=true) }}", &context);
2017-07-04 12:27:32 +00:00
assert!(res.is_err());
}
#[test]
fn can_make_valid_relative_link() {
let mut permalinks = HashMap::new();
permalinks.insert("pages/about.md".to_string(), "https://vincent.is/about".to_string());
let tera_ctx = Tera::default();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content(
r#"[rel link](@/pages/about.md), [abs link](https://vincent.is/about)"#,
&context,
2018-10-31 07:18:57 +00:00
)
.unwrap();
2017-07-04 12:27:32 +00:00
assert!(
2018-08-24 21:37:55 +00:00
res.body.contains(r#"<p><a href="https://vincent.is/about">rel link</a>, <a href="https://vincent.is/about">abs link</a></p>"#)
2017-07-04 12:27:32 +00:00
);
}
#[test]
fn can_make_relative_links_with_anchors() {
let mut permalinks = HashMap::new();
permalinks.insert("pages/about.md".to_string(), "https://vincent.is/about".to_string());
let tera_ctx = Tera::default();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks,
InsertAnchor::None,
);
let res = render_content(r#"[rel link](@/pages/about.md#cv)"#, &context).unwrap();
2017-07-04 12:27:32 +00:00
2018-10-31 07:18:57 +00:00
assert!(res.body.contains(r#"<p><a href="https://vincent.is/about#cv">rel link</a></p>"#));
2017-07-04 12:27:32 +00:00
}
#[test]
fn errors_relative_link_inexistant() {
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("[rel link](@/pages/about.md)", &context);
2017-07-04 12:27:32 +00:00
assert!(res.is_err());
}
#[test]
fn can_add_id_to_headings() {
2017-07-04 12:27:32 +00:00
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content(r#"# Hello"#, &context).unwrap();
2018-08-24 21:37:55 +00:00
assert_eq!(res.body, "<h1 id=\"hello\">Hello</h1>\n");
2017-07-04 12:27:32 +00:00
}
#[test]
fn can_add_id_to_headings_same_slug() {
2017-07-04 12:27:32 +00:00
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content("# Hello\n# Hello", &context).unwrap();
2018-08-24 21:37:55 +00:00
assert_eq!(res.body, "<h1 id=\"hello\">Hello</h1>\n<h1 id=\"hello-1\">Hello</h1>\n");
2017-07-04 12:27:32 +00:00
}
#[test]
fn can_add_non_slug_id_to_headings() {
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.slugify.anchors = SlugifyStrategy::Safe;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(r#"# L'écologie et vous"#, &context).unwrap();
assert_eq!(res.body, "<h1 id=\"L'écologie_et_vous\">L'écologie et vous</h1>\n");
}
Allow manual specification of header IDs (#685) Justification for this feature is added in the docs. Precedent for the precise syntax: Hugo. Hugo puts this syntax behind a preference named headerIds, and automatic header ID generation behind a preference named autoHeaderIds, with both enabled by default. I have not implemented a switch to disable this. My suggestion for a workaround for the improbable case of desiring a literal “{#…}” at the end of a header is to replace `}` with `&#125;`. The algorithm I have used is not identical to [that which Hugo uses][0], because Hugo’s looks to work at the source level, whereas here we work at the pulldown-cmark event level, which is generally more sane, but potentially limiting for extremely esoteric IDs. Practical differences in implementation from Hugo (based purely on reading [blackfriday’s implementation][0], not actually trying it): - I believe Hugo would treat `# Foo {#*bar*}` as a heading with text “Foo” and ID `*bar*`, since it is working at the source level; whereas this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as it works at the pulldown-cmark event level and doesn’t go out of its way to make that work (I’m not familiar with pulldown-cmark, but I get the impression that you could make it work Hugo’s way on this point). The difference should be negligible: only *very* esoteric hashes would include magic Markdown characters. - Hugo will automatically generate an ID for `{#}`, whereas what I’ve coded here will yield a blank ID instead (which feels more correct to me—`None` versus `Some("")`, and all that). In practice the results should be identical. Fixes #433. [0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234
2019-05-20 20:08:49 +00:00
#[test]
fn can_handle_manual_ids_on_headings() {
Allow manual specification of header IDs (#685) Justification for this feature is added in the docs. Precedent for the precise syntax: Hugo. Hugo puts this syntax behind a preference named headerIds, and automatic header ID generation behind a preference named autoHeaderIds, with both enabled by default. I have not implemented a switch to disable this. My suggestion for a workaround for the improbable case of desiring a literal “{#…}” at the end of a header is to replace `}` with `&#125;`. The algorithm I have used is not identical to [that which Hugo uses][0], because Hugo’s looks to work at the source level, whereas here we work at the pulldown-cmark event level, which is generally more sane, but potentially limiting for extremely esoteric IDs. Practical differences in implementation from Hugo (based purely on reading [blackfriday’s implementation][0], not actually trying it): - I believe Hugo would treat `# Foo {#*bar*}` as a heading with text “Foo” and ID `*bar*`, since it is working at the source level; whereas this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as it works at the pulldown-cmark event level and doesn’t go out of its way to make that work (I’m not familiar with pulldown-cmark, but I get the impression that you could make it work Hugo’s way on this point). The difference should be negligible: only *very* esoteric hashes would include magic Markdown characters. - Hugo will automatically generate an ID for `{#}`, whereas what I’ve coded here will yield a blank ID instead (which feels more correct to me—`None` versus `Some("")`, and all that). In practice the results should be identical. Fixes #433. [0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234
2019-05-20 20:08:49 +00:00
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
Allow manual specification of header IDs (#685) Justification for this feature is added in the docs. Precedent for the precise syntax: Hugo. Hugo puts this syntax behind a preference named headerIds, and automatic header ID generation behind a preference named autoHeaderIds, with both enabled by default. I have not implemented a switch to disable this. My suggestion for a workaround for the improbable case of desiring a literal “{#…}” at the end of a header is to replace `}` with `&#125;`. The algorithm I have used is not identical to [that which Hugo uses][0], because Hugo’s looks to work at the source level, whereas here we work at the pulldown-cmark event level, which is generally more sane, but potentially limiting for extremely esoteric IDs. Practical differences in implementation from Hugo (based purely on reading [blackfriday’s implementation][0], not actually trying it): - I believe Hugo would treat `# Foo {#*bar*}` as a heading with text “Foo” and ID `*bar*`, since it is working at the source level; whereas this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as it works at the pulldown-cmark event level and doesn’t go out of its way to make that work (I’m not familiar with pulldown-cmark, but I get the impression that you could make it work Hugo’s way on this point). The difference should be negligible: only *very* esoteric hashes would include magic Markdown characters. - Hugo will automatically generate an ID for `{#}`, whereas what I’ve coded here will yield a blank ID instead (which feels more correct to me—`None` versus `Some("")`, and all that). In practice the results should be identical. Fixes #433. [0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234
2019-05-20 20:08:49 +00:00
// Tested things: manual IDs; whitespace flexibility; that automatic IDs avoid collision with
// manual IDs; that duplicates are in fact permitted among manual IDs; that any non-plain-text
// in the middle of `{#…}` will disrupt it from being acknowledged as a manual ID (that last
// one could reasonably be considered a bug rather than a feature, but test it either way); one
// workaround for the improbable case where you actually want `{#…}` at the end of a heading.
2019-06-02 18:21:06 +00:00
let res = render_content(
"\
# Hello\n\
# Hello{#hello}\n\
# Hello {#hello}\n\
# Hello {#Something_else} \n\
# Workaround for literal {#&#125;\n\
# Hello\n\
# Auto {#*matic*}",
&context,
)
.unwrap();
assert_eq!(
res.body,
"\
<h1 id=\"hello-1\">Hello</h1>\n\
<h1 id=\"hello\">Hello</h1>\n\
<h1 id=\"hello\">Hello</h1>\n\
<h1 id=\"Something_else\">Hello</h1>\n\
<h1 id=\"workaround-for-literal\">Workaround for literal {#…}</h1>\n\
<h1 id=\"hello-2\">Hello</h1>\n\
<h1 id=\"auto-matic\">Auto {#<em>matic</em>}</h1>\n\
"
);
Allow manual specification of header IDs (#685) Justification for this feature is added in the docs. Precedent for the precise syntax: Hugo. Hugo puts this syntax behind a preference named headerIds, and automatic header ID generation behind a preference named autoHeaderIds, with both enabled by default. I have not implemented a switch to disable this. My suggestion for a workaround for the improbable case of desiring a literal “{#…}” at the end of a header is to replace `}` with `&#125;`. The algorithm I have used is not identical to [that which Hugo uses][0], because Hugo’s looks to work at the source level, whereas here we work at the pulldown-cmark event level, which is generally more sane, but potentially limiting for extremely esoteric IDs. Practical differences in implementation from Hugo (based purely on reading [blackfriday’s implementation][0], not actually trying it): - I believe Hugo would treat `# Foo {#*bar*}` as a heading with text “Foo” and ID `*bar*`, since it is working at the source level; whereas this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as it works at the pulldown-cmark event level and doesn’t go out of its way to make that work (I’m not familiar with pulldown-cmark, but I get the impression that you could make it work Hugo’s way on this point). The difference should be negligible: only *very* esoteric hashes would include magic Markdown characters. - Hugo will automatically generate an ID for `{#}`, whereas what I’ve coded here will yield a blank ID instead (which feels more correct to me—`None` versus `Some("")`, and all that). In practice the results should be identical. Fixes #433. [0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234
2019-05-20 20:08:49 +00:00
}
#[test]
fn blank_headings() {
Allow manual specification of header IDs (#685) Justification for this feature is added in the docs. Precedent for the precise syntax: Hugo. Hugo puts this syntax behind a preference named headerIds, and automatic header ID generation behind a preference named autoHeaderIds, with both enabled by default. I have not implemented a switch to disable this. My suggestion for a workaround for the improbable case of desiring a literal “{#…}” at the end of a header is to replace `}` with `&#125;`. The algorithm I have used is not identical to [that which Hugo uses][0], because Hugo’s looks to work at the source level, whereas here we work at the pulldown-cmark event level, which is generally more sane, but potentially limiting for extremely esoteric IDs. Practical differences in implementation from Hugo (based purely on reading [blackfriday’s implementation][0], not actually trying it): - I believe Hugo would treat `# Foo {#*bar*}` as a heading with text “Foo” and ID `*bar*`, since it is working at the source level; whereas this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as it works at the pulldown-cmark event level and doesn’t go out of its way to make that work (I’m not familiar with pulldown-cmark, but I get the impression that you could make it work Hugo’s way on this point). The difference should be negligible: only *very* esoteric hashes would include magic Markdown characters. - Hugo will automatically generate an ID for `{#}`, whereas what I’ve coded here will yield a blank ID instead (which feels more correct to me—`None` versus `Some("")`, and all that). In practice the results should be identical. Fixes #433. [0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234
2019-05-20 20:08:49 +00:00
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
Allow manual specification of header IDs (#685) Justification for this feature is added in the docs. Precedent for the precise syntax: Hugo. Hugo puts this syntax behind a preference named headerIds, and automatic header ID generation behind a preference named autoHeaderIds, with both enabled by default. I have not implemented a switch to disable this. My suggestion for a workaround for the improbable case of desiring a literal “{#…}” at the end of a header is to replace `}` with `&#125;`. The algorithm I have used is not identical to [that which Hugo uses][0], because Hugo’s looks to work at the source level, whereas here we work at the pulldown-cmark event level, which is generally more sane, but potentially limiting for extremely esoteric IDs. Practical differences in implementation from Hugo (based purely on reading [blackfriday’s implementation][0], not actually trying it): - I believe Hugo would treat `# Foo {#*bar*}` as a heading with text “Foo” and ID `*bar*`, since it is working at the source level; whereas this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as it works at the pulldown-cmark event level and doesn’t go out of its way to make that work (I’m not familiar with pulldown-cmark, but I get the impression that you could make it work Hugo’s way on this point). The difference should be negligible: only *very* esoteric hashes would include magic Markdown characters. - Hugo will automatically generate an ID for `{#}`, whereas what I’ve coded here will yield a blank ID instead (which feels more correct to me—`None` versus `Some("")`, and all that). In practice the results should be identical. Fixes #433. [0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234
2019-05-20 20:08:49 +00:00
let res = render_content("# \n#\n# {#hmm} \n# {#}", &context).unwrap();
2019-06-02 18:21:06 +00:00
assert_eq!(
res.body,
"<h1 id=\"-1\"></h1>\n<h1 id=\"-2\"></h1>\n<h1 id=\"hmm\"></h1>\n<h1 id=\"\"></h1>\n"
);
Allow manual specification of header IDs (#685) Justification for this feature is added in the docs. Precedent for the precise syntax: Hugo. Hugo puts this syntax behind a preference named headerIds, and automatic header ID generation behind a preference named autoHeaderIds, with both enabled by default. I have not implemented a switch to disable this. My suggestion for a workaround for the improbable case of desiring a literal “{#…}” at the end of a header is to replace `}` with `&#125;`. The algorithm I have used is not identical to [that which Hugo uses][0], because Hugo’s looks to work at the source level, whereas here we work at the pulldown-cmark event level, which is generally more sane, but potentially limiting for extremely esoteric IDs. Practical differences in implementation from Hugo (based purely on reading [blackfriday’s implementation][0], not actually trying it): - I believe Hugo would treat `# Foo {#*bar*}` as a heading with text “Foo” and ID `*bar*`, since it is working at the source level; whereas this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as it works at the pulldown-cmark event level and doesn’t go out of its way to make that work (I’m not familiar with pulldown-cmark, but I get the impression that you could make it work Hugo’s way on this point). The difference should be negligible: only *very* esoteric hashes would include magic Markdown characters. - Hugo will automatically generate an ID for `{#}`, whereas what I’ve coded here will yield a blank ID instead (which feels more correct to me—`None` versus `Some("")`, and all that). In practice the results should be identical. Fixes #433. [0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234
2019-05-20 20:08:49 +00:00
}
2017-07-04 12:27:32 +00:00
#[test]
fn can_insert_anchor_left() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::Left,
);
2018-05-06 20:58:39 +00:00
let res = render_content("# Hello", &context).unwrap();
2017-07-04 12:27:32 +00:00
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<h1 id=\"hello\"><a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a>Hello</h1>\n"
2017-07-04 12:27:32 +00:00
);
}
#[test]
fn can_insert_anchor_right() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::Right,
);
2018-05-06 20:58:39 +00:00
let res = render_content("# Hello", &context).unwrap();
2017-07-04 12:27:32 +00:00
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<h1 id=\"hello\">Hello<a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a></h1>\n"
2017-07-04 12:27:32 +00:00
);
}
#[test]
fn can_insert_anchor_for_multi_heading() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::Right,
);
let res = render_content("# Hello\n# World", &context).unwrap();
assert_eq!(
res.body,
"<h1 id=\"hello\">Hello<a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a></h1>\n\
<h1 id=\"world\">World<a class=\"zola-anchor\" href=\"#world\" aria-label=\"Anchor link for: world\">🔗</a></h1>\n"
);
}
2017-07-04 12:27:32 +00:00
// See https://github.com/Keats/gutenberg/issues/42
#[test]
fn can_insert_anchor_with_exclamation_mark() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::Left,
);
2018-05-06 20:58:39 +00:00
let res = render_content("# Hello!", &context).unwrap();
2017-07-04 12:27:32 +00:00
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<h1 id=\"hello\"><a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a>Hello!</h1>\n"
2017-07-04 12:27:32 +00:00
);
}
// See https://github.com/Keats/gutenberg/issues/53
#[test]
fn can_insert_anchor_with_link() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::Left,
);
2018-05-07 16:38:04 +00:00
let res = render_content("## [Rust](https://rust-lang.org)", &context).unwrap();
2017-07-04 12:27:32 +00:00
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<h2 id=\"rust\"><a class=\"zola-anchor\" href=\"#rust\" aria-label=\"Anchor link for: rust\">🔗</a><a href=\"https://rust-lang.org\">Rust</a></h2>\n"
2017-07-04 12:27:32 +00:00
);
}
#[test]
fn can_insert_anchor_with_other_special_chars() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::Left,
);
2018-05-06 20:58:39 +00:00
let res = render_content("# Hello*_()", &context).unwrap();
2017-07-04 12:27:32 +00:00
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<h1 id=\"hello\"><a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a>Hello*_()</h1>\n"
2017-07-04 12:27:32 +00:00
);
}
#[test]
fn can_insert_anchor_with_lang() {
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
tera.add_raw_template("anchor-link.html", "({{ lang }})").unwrap();
let permalinks_ctx = HashMap::new();
let config = Config::default_for_test();
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::Right,
);
let res = render_content("# Hello", &context).unwrap();
assert_eq!(
res.body,
"<h1 id=\"hello\">Hello(en)</h1>\n"
);
}
2017-07-04 12:27:32 +00:00
#[test]
fn can_make_toc() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2018-05-06 20:58:39 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
2018-05-06 20:58:39 +00:00
&config,
2021-03-13 20:04:01 +00:00
&config.default_language,
2017-07-04 12:27:32 +00:00
"https://mysite.com/something",
&permalinks_ctx,
InsertAnchor::Left,
2017-07-04 12:27:32 +00:00
);
2018-10-31 07:18:57 +00:00
let res = render_content(
r#"
# Heading 1
2017-07-04 12:27:32 +00:00
## Heading 2
2017-07-04 12:27:32 +00:00
## Another Heading 2
2017-07-04 12:27:32 +00:00
### Last one
2018-10-31 07:18:57 +00:00
"#,
&context,
)
.unwrap();
2017-07-04 12:27:32 +00:00
2018-08-24 21:37:55 +00:00
let toc = res.toc;
2017-07-04 12:27:32 +00:00
assert_eq!(toc.len(), 1);
assert_eq!(toc[0].children.len(), 2);
assert_eq!(toc[0].children[1].children.len(), 1);
}
2017-09-27 14:09:13 +00:00
#[test]
fn can_ignore_tags_in_toc() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
let context = RenderContext::new(
&ZOLA_TERA,
&config,
2021-03-13 20:04:01 +00:00
&config.default_language,
"https://mysite.com/something",
&permalinks_ctx,
InsertAnchor::Left,
);
2018-10-31 07:18:57 +00:00
let res = render_content(
r#"
## heading with `code`
## [anchor](https://duckduckgo.com/) in heading
## **bold** and *italics*
2018-10-31 07:18:57 +00:00
"#,
&context,
)
.unwrap();
let toc = res.toc;
assert_eq!(toc[0].id, "heading-with-code");
assert_eq!(toc[0].title, "heading with code");
assert_eq!(toc[1].id, "anchor-in-heading");
assert_eq!(toc[1].title, "anchor in heading");
assert_eq!(toc[2].id, "bold-and-italics");
assert_eq!(toc[2].title, "bold and italics");
}
2017-09-27 14:09:13 +00:00
#[test]
fn can_understand_backtick_in_titles() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content("# `Hello`", &context).unwrap();
2018-10-31 07:18:57 +00:00
assert_eq!(res.body, "<h1 id=\"hello\"><code>Hello</code></h1>\n");
2017-09-27 14:09:13 +00:00
}
#[test]
fn can_understand_backtick_in_paragraphs() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-06 20:58:39 +00:00
let res = render_content("Hello `world`", &context).unwrap();
2018-10-31 07:18:57 +00:00
assert_eq!(res.body, "<p>Hello <code>world</code></p>\n");
2017-09-27 14:09:13 +00:00
}
2018-05-07 16:38:04 +00:00
// https://github.com/Keats/gutenberg/issues/297
#[test]
fn can_understand_links_in_heading() {
2018-05-07 16:38:04 +00:00
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-05-07 16:38:04 +00:00
let res = render_content("# [Rust](https://rust-lang.org)", &context).unwrap();
2018-10-31 07:18:57 +00:00
assert_eq!(res.body, "<h1 id=\"rust\"><a href=\"https://rust-lang.org\">Rust</a></h1>\n");
2018-05-07 16:38:04 +00:00
}
#[test]
fn can_understand_link_with_title_in_heading() {
2018-05-07 16:38:04 +00:00
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-10-31 07:18:57 +00:00
let res =
render_content("# [Rust](https://rust-lang.org \"Rust homepage\")", &context).unwrap();
2018-05-07 16:38:04 +00:00
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
2018-05-07 16:38:04 +00:00
"<h1 id=\"rust\"><a href=\"https://rust-lang.org\" title=\"Rust homepage\">Rust</a></h1>\n"
);
}
2018-05-07 19:03:51 +00:00
#[test]
fn can_understand_emphasis_in_heading() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("# *Emphasis* text", &context).unwrap();
assert_eq!(res.body, "<h1 id=\"emphasis-text\"><em>Emphasis</em> text</h1>\n");
}
#[test]
fn can_understand_strong_in_heading() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("# **Strong** text", &context).unwrap();
assert_eq!(res.body, "<h1 id=\"strong-text\"><strong>Strong</strong> text</h1>\n");
}
#[test]
fn can_understand_code_in_heading() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("# `Code` text", &context).unwrap();
assert_eq!(res.body, "<h1 id=\"code-text\"><code>Code</code> text</h1>\n");
}
// See https://github.com/getzola/zola/issues/569
#[test]
fn can_understand_footnote_in_heading() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("# text [^1] there\n[^1]: footnote", &context).unwrap();
2020-02-10 19:48:52 +00:00
assert_eq!(
res.body,
r##"<h1 id="text-there">text <sup class="footnote-reference"><a href="#1">1</a></sup> there</h1>
<div class="footnote-definition" id="1"><sup class="footnote-definition-label">1</sup>
<p>footnote</p>
</div>
2020-02-10 19:48:52 +00:00
"##
);
}
2018-05-07 19:03:51 +00:00
#[test]
fn can_make_valid_relative_link_in_heading() {
2018-05-07 19:03:51 +00:00
let mut permalinks = HashMap::new();
permalinks.insert("pages/about.md".to_string(), "https://vincent.is/about/".to_string());
let tera_ctx = Tera::default();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks,
InsertAnchor::None,
);
let res = render_content(r#" # [rel link](@/pages/about.md)"#, &context).unwrap();
2018-05-07 19:03:51 +00:00
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
2018-05-07 19:03:51 +00:00
"<h1 id=\"rel-link\"><a href=\"https://vincent.is/about/\">rel link</a></h1>\n"
);
}
#[test]
fn can_make_permalinks_with_colocated_assets_for_link() {
2018-05-07 19:03:51 +00:00
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2018-10-31 07:18:57 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
2021-03-13 20:04:01 +00:00
&config.default_language,
2018-10-31 07:18:57 +00:00
"https://vincent.is/about/",
&permalinks_ctx,
InsertAnchor::None,
2018-05-07 19:03:51 +00:00
);
2018-10-31 07:18:57 +00:00
let res = render_content("[an image](image.jpg)", &context).unwrap();
assert_eq!(res.body, "<p><a href=\"image.jpg\">an image</a></p>\n");
2018-05-07 19:03:51 +00:00
}
#[test]
fn can_make_permalinks_with_colocated_assets_for_image() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2018-10-31 07:18:57 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
2021-03-13 20:04:01 +00:00
&config.default_language,
2018-10-31 07:18:57 +00:00
"https://vincent.is/about/",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("![alt text](image.jpg)", &context).unwrap();
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<p><img src=\"image.jpg\" alt=\"alt text\" /></p>\n"
);
}
#[test]
fn markdown_doesnt_wrap_html_in_paragraph() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2018-10-31 07:18:57 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
2021-03-13 20:04:01 +00:00
&config.default_language,
2018-10-31 07:18:57 +00:00
"https://vincent.is/about/",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(
r#"
Some text
<h1>Helo</h1>
<div>
<a href="mobx-flow.png">
<img src="mobx-flow.png" alt="MobX flow">
</a>
</div>
2018-10-31 07:18:57 +00:00
"#,
&context,
)
.unwrap();
assert_eq!(
2018-08-24 21:37:55 +00:00
res.body,
"<p>Some text</p>\n<h1>Helo</h1>\n<div>\n<a href=\"mobx-flow.png\">\n <img src=\"mobx-flow.png\" alt=\"MobX flow\">\n </a>\n</div>\n"
);
}
#[test]
fn correctly_captures_external_links() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2018-10-31 07:18:57 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
2021-03-13 20:04:01 +00:00
&config.default_language,
2018-10-31 07:18:57 +00:00
"https://vincent.is/about/",
&permalinks_ctx,
InsertAnchor::None,
);
let content = "
[a link](http://google.com)
[a link](http://google.comy)
Email: [foo@bar.baz](mailto:foo@bar.baz)
Email: <foo@bar.baz>
";
let res = render_content(content, &context).unwrap();
2019-06-02 18:21:06 +00:00
assert_eq!(
res.external_links,
&["http://google.com".to_owned(), "http://google.comy".to_owned()]
);
}
#[test]
fn can_handle_summaries() {
let tera_ctx = Tera::default();
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera_ctx,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2018-10-31 07:18:57 +00:00
let res = render_content(
2019-03-15 20:24:06 +00:00
r#"
Hello [My site][world]
<!-- more -->
Bla bla
[world]: https://vincentprouillet.com
"#,
2018-10-31 07:18:57 +00:00
&context,
)
.unwrap();
assert_eq!(
res.body,
"<p>Hello <a href=\"https://vincentprouillet.com\">My site</a></p>\n<span id=\"continue-reading\"></span>\n<p>Bla bla</p>\n"
);
assert_eq!(
res.summary_len,
2019-03-15 20:24:06 +00:00
Some("<p>Hello <a href=\"https://vincentprouillet.com/\">My site</a></p>".len())
);
}
// https://github.com/Keats/gutenberg/issues/522
#[test]
fn doesnt_try_to_highlight_content_from_shortcode() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
let shortcode = r#"
<figure>
{% if width %}
<img src="/images/{{ src }}" alt="{{ caption }}" width="{{ width }}" />
{% else %}
<img src="/images/{{ src }}" alt="{{ caption }}" />
{% endif %}
<figcaption>{{ caption }}</figcaption>
</figure>"#;
let markdown_string = r#"{{ figure(src="spherecluster.png", caption="Some spheres.") }}"#;
let expected = "<figure>\n \n <img src=\"/images/spherecluster.png\" alt=\"Some spheres.\" />\n \n\n <figcaption>Some spheres.</figcaption>\n</figure>";
tera.add_raw_template("shortcodes/figure.html", shortcode).unwrap();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(markdown_string, &context).unwrap();
assert_eq!(res.body, expected);
}
2019-01-10 16:17:07 +00:00
#[test]
fn can_emit_newlines_and_whitespace_with_shortcode() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
let shortcode = r#"<pre>
{{ body }}
</pre>"#;
let markdown_string = "{% preformatted() %}\nHello\n \n Zola\n \n !\n{% end %}";
let expected = "<pre>\nHello\n \n Zola\n \n !\n</pre>";
tera.add_raw_template(&format!("shortcodes/{}.html", "preformatted"), shortcode).unwrap();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(markdown_string, &context).unwrap();
assert_eq!(res.body, expected);
}
// TODO: re-enable once it's fixed in Tera
2019-01-10 16:17:07 +00:00
// https://github.com/Keats/tera/issues/373
//#[test]
//fn can_split_lines_shortcode_body() {
// let permalinks_ctx = HashMap::new();
// let mut tera = Tera::default();
// tera.extend(&ZOLA_TERA).unwrap();
//
// let shortcode = r#"{{ body | split(pat="\n") }}"#;
//
// let markdown_string = r#"
//{% alert() %}
//multi
//ple
//lines
//{% end %}
// "#;
//
// let expected = r#"<p>["multi", "ple", "lines"]</p>"#;
//
// tera.add_raw_template(&format!("shortcodes/{}.html", "alert"), shortcode).unwrap();
2021-06-02 19:46:19 +00:00
// let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
// let context = RenderContext::new(&tera, &config, &config.default_language, "", &permalinks_ctx, InsertAnchor::None);
//
// let res = render_content(markdown_string, &context).unwrap();
// assert_eq!(res.body, expected);
//}
2019-07-15 18:18:24 +00:00
// https://github.com/getzola/zola/issues/747
// https://github.com/getzola/zola/issues/816
2019-07-15 18:18:24 +00:00
#[test]
fn leaves_custom_url_scheme_untouched() {
let content = r#"[foo@bar.tld](xmpp:foo@bar.tld)
[(123) 456-7890](tel:+11234567890)
[blank page](about:blank)
"#;
2019-07-15 18:18:24 +00:00
let tera_ctx = Tera::default();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
let permalinks_ctx = HashMap::new();
let context = RenderContext::new(
&tera_ctx,
&config,
2021-03-13 20:04:01 +00:00
&config.default_language,
"https://vincent.is/",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(content, &context).unwrap();
let expected = r#"<p><a href="xmpp:foo@bar.tld">foo@bar.tld</a></p>
<p><a href="tel:+11234567890">(123) 456-7890</a></p>
<p><a href="about:blank">blank page</a></p>
"#;
assert_eq!(res.body, expected);
2019-07-15 18:18:24 +00:00
}
#[test]
fn stops_with_an_error_on_an_empty_link() {
let content = r#"[some link]()"#;
let tera_ctx = Tera::default();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
let permalinks_ctx = HashMap::new();
let context = RenderContext::new(
&tera_ctx,
&config,
2021-03-13 20:04:01 +00:00
&config.default_language,
"https://vincent.is/",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(content, &context);
let expected = "There is a link that is missing a URL";
assert!(res.is_err());
assert_eq!(res.unwrap_err().to_string(), expected);
}
#[test]
fn can_passthrough_markdown_from_shortcode() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
let shortcode = r#"{% for line in body | split(pat="\n") %}
> {{ line }}
{%- endfor %}
-- {{ author }}
"#;
let markdown_string = r#"
Hello
{% quote(author="Vincent") %}
# Passing through
*to* **the** document
{% end %}
Bla bla"#;
let expected = r#"<p>Hello</p>
<blockquote>
<h1 id="passing-through">Passing through</h1>
<p><em>to</em> <strong>the</strong> document</p>
</blockquote>
<p>-- Vincent</p>
<p>Bla bla</p>
"#;
tera.add_raw_template("shortcodes/quote.md", shortcode).unwrap();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(markdown_string, &context).unwrap();
assert_eq!(res.body, expected);
}
// https://github.com/getzola/zola/issues/1172
#[test]
fn can_render_shortcode_body_with_no_invalid_escaping() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
let shortcode = r#"
<a class="resize-image" href="/tlera-corp-gnat/gnat-with-picoblade-cable.jpg">
<img
src="https://placekitten.com/200/300"
alt="{{ alt }}">
</img>
<p>(click for full size)</p>
</a>
"#;
let markdown_string = r#"{{ resize_image(path="tlera-corp-gnat/gnat-with-picoblade-cable.jpg", width=600, alt="Some alt") }}"#;
let expected = "<a class=\"resize-image\" href=\"/tlera-corp-gnat/gnat-with-picoblade-cable.jpg\">\n <img\n src=\"https://placekitten.com/200/300\"\n alt=\"Some alt\">\n </img>\n <p>(click for full size)</p>\n</a>";
tera.add_raw_template("shortcodes/resize_image.html", shortcode).unwrap();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(markdown_string, &context).unwrap();
assert_eq!(res.body, expected);
}
// https://github.com/getzola/zola/issues/1172
#[test]
fn can_render_commented_out_shortcodes_fine() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
let shortcode = r#"
<a class="resize-image" href="/tlera-corp-gnat/gnat-with-picoblade-cable.jpg">
<img
src="https://placekitten.com/200/300"
alt="{{ alt }}">
</img>
<p>(click for full size)</p>
</a>
"#;
let markdown_string = r#"<!--{{ resize_image(path="tlera-corp-gnat/gnat-with-picoblade-cable.jpg", width=600, alt="Some alt") }}-->"#;
let expected = "<!--<a class=\"resize-image\" href=\"/tlera-corp-gnat/gnat-with-picoblade-cable.jpg\">\n <img\n src=\"https://placekitten.com/200/300\"\n alt=\"Some alt\">\n </img>\n <p>(click for full size)</p>\n</a>-->";
tera.add_raw_template("shortcodes/resize_image.html", shortcode).unwrap();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(markdown_string, &context).unwrap();
assert_eq!(res.body, expected);
}
// https://zola.discourse.group/t/zola-12-issue-with-continue-reading/590/7
#[test]
fn can_render_read_more_after_shortcode() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
let shortcode = r#"<p>Quote: {{body}}</p>"#;
let markdown_string = r#"
# Title
Some text
{{ quote(body="Nothing is impossible. The word itself says - I'm Possible" author="Audrey Hepburn")}}
<!-- more -->
Again more text"#;
let expected = r#"<h1 id="title">Title</h1>
<p>Some text</p>
<p>Quote: Nothing is impossible. The word itself says - I'm Possible</p>
<span id="continue-reading"></span>
<p>Again more text</p>
"#;
tera.add_raw_template("shortcodes/quote.md", shortcode).unwrap();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(markdown_string, &context).unwrap();
assert_eq!(res.body, expected);
}
#[test]
fn can_render_emoji_alias() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.render_emoji = true;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("Hello, World! :smile:", &context).unwrap();
assert_eq!(res.body, "<p>Hello, World! 😄</p>\n");
}
#[test]
fn emoji_aliases_are_ignored_when_disabled_in_config() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("Hello, World! :smile:", &context).unwrap();
assert_eq!(res.body, "<p>Hello, World! :smile:</p>\n");
}
#[test]
fn invocation_count_increments_in_shortcode() {
let permalinks_ctx = HashMap::new();
let mut tera = Tera::default();
tera.extend(&ZOLA_TERA).unwrap();
let shortcode_template_a = r#"<p>a: {{ nth }}</p>"#;
let shortcode_template_b = r#"<p>b: {{ nth }}</p>"#;
let markdown_string = r#"{{ a() }}
{{ b() }}
{{ a() }}
{{ b() }}
"#;
let expected = r#"<p>a: 1</p>
<p>b: 1</p>
<p>a: 2</p>
<p>b: 2</p>
"#;
tera.add_raw_template("shortcodes/a.html", shortcode_template_a).unwrap();
tera.add_raw_template("shortcodes/b.html", shortcode_template_b).unwrap();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content(markdown_string, &context).unwrap();
assert_eq!(res.body, expected);
}
#[test]
fn basic_external_links_unchanged() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let config = Config::default_for_test();
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("<https://google.com>", &context).unwrap();
assert_eq!(res.body, "<p><a href=\"https://google.com\">https://google.com</a></p>\n");
}
#[test]
fn can_set_target_blank_for_external_link() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.external_links_target_blank = true;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("<https://google.com>", &context).unwrap();
assert_eq!(res.body, "<p><a rel=\"noopener\" target=\"_blank\" href=\"https://google.com\">https://google.com</a></p>\n");
}
#[test]
fn can_set_nofollow_for_external_link() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.external_links_no_follow = true;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
// Testing href escaping while we're there
let res = render_content("<https://google.com/éllo>", &context).unwrap();
assert_eq!(
res.body,
"<p><a rel=\"nofollow\" href=\"https://google.com/%C3%A9llo\">https://google.com/éllo</a></p>\n"
);
}
#[test]
fn can_set_noreferrer_for_external_link() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.external_links_no_referrer = true;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("<https://google.com>", &context).unwrap();
assert_eq!(
res.body,
"<p><a rel=\"noreferrer\" href=\"https://google.com\">https://google.com</a></p>\n"
);
}
#[test]
fn can_set_all_options_for_external_link() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
config.markdown.external_links_target_blank = true;
config.markdown.external_links_no_follow = true;
config.markdown.external_links_no_referrer = true;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
let res = render_content("<https://google.com>", &context).unwrap();
assert_eq!(res.body, "<p><a rel=\"noopener nofollow noreferrer\" target=\"_blank\" href=\"https://google.com\">https://google.com</a></p>\n");
}
2020-11-27 10:11:19 +00:00
#[test]
fn can_use_smart_punctuation() {
let permalinks_ctx = HashMap::new();
2021-06-02 19:46:19 +00:00
let mut config = Config::default_for_test();
2020-11-27 10:11:19 +00:00
config.markdown.smart_punctuation = true;
2021-03-13 20:04:01 +00:00
let context = RenderContext::new(
&ZOLA_TERA,
&config,
&config.default_language,
"",
&permalinks_ctx,
InsertAnchor::None,
);
2020-11-27 10:11:19 +00:00
let res = render_content(r#"This -- is "it"..."#, &context).unwrap();
assert_eq!(res.body, "<p>This is “it”…</p>\n");
}