zola/components/rendering/tests/summary.rs

120 lines
3.5 KiB
Rust
Raw Normal View History

Shortcodes (#1640) * Next version * Added tests for shortcode insertion * Added TOC tests * Added test for #1475 and #1355 * Basic internal / external links tests * Added integration test * Added pseudocode and started on logos * Logos parsing for shortcodes * Fixed string literal parsing Moved string literal parsing to a new lexer in order to have greater control of control characters which are parsed. This fixes the bug that was present in the `string_from_quoted` function and also moves the `QuoteType` to be in the `ArgValueToken`. * Moved string literal logic to seperate module * Added square bracket notation for variables * Error handling rewritten Remove the Result from the `fetch_shortcodes` function. Added proper messages within the internal parsing. * Reorganized and documented the shortcode submodule * Added all logic for ShortcodeContext spans * Added working insertion code for MD files * Made functions generic over Markdown or HTML * Add check for embedding bodies * Structure of main function clear * Added test for `new_with_transforms` function * It runs! * Added the code for handling p-ed html shortcodes * Removed placeholders in markdown function * Adjusted integration tests * fetch_shortcodes now also returns a string * Start of HTML insertion * Kinda working everything * Loading of shortcodes and builtins * Fix tests * Some missed fixes * Tweaks + fmt * Remove string literal handling * Fix benches * Grab shortcode def only once per site * Fix benches * Rewrite of parser * Fix tests * Add test for #1655 * Re-enable integration test * Add test for #1601 * Add test for #1600 * Add test for #1500 * Add test for #1320 * Fix test on windows? Co-authored-by: Gijs Burghoorn <g.burghoorn@gmail.com>
2021-11-19 19:31:42 +00:00
mod common;
use common::ShortCode;
use libs::tera;
Shortcodes (#1640) * Next version * Added tests for shortcode insertion * Added TOC tests * Added test for #1475 and #1355 * Basic internal / external links tests * Added integration test * Added pseudocode and started on logos * Logos parsing for shortcodes * Fixed string literal parsing Moved string literal parsing to a new lexer in order to have greater control of control characters which are parsed. This fixes the bug that was present in the `string_from_quoted` function and also moves the `QuoteType` to be in the `ArgValueToken`. * Moved string literal logic to seperate module * Added square bracket notation for variables * Error handling rewritten Remove the Result from the `fetch_shortcodes` function. Added proper messages within the internal parsing. * Reorganized and documented the shortcode submodule * Added all logic for ShortcodeContext spans * Added working insertion code for MD files * Made functions generic over Markdown or HTML * Add check for embedding bodies * Structure of main function clear * Added test for `new_with_transforms` function * It runs! * Added the code for handling p-ed html shortcodes * Removed placeholders in markdown function * Adjusted integration tests * fetch_shortcodes now also returns a string * Start of HTML insertion * Kinda working everything * Loading of shortcodes and builtins * Fix tests * Some missed fixes * Tweaks + fmt * Remove string literal handling * Fix benches * Grab shortcode def only once per site * Fix benches * Rewrite of parser * Fix tests * Add test for #1655 * Re-enable integration test * Add test for #1601 * Add test for #1600 * Add test for #1500 * Add test for #1320 * Fix test on windows? Co-authored-by: Gijs Burghoorn <g.burghoorn@gmail.com>
2021-11-19 19:31:42 +00:00
macro_rules! test_scenario_summary {
($in_str:literal, $summary:literal, [$($shortcodes:ident),*]) => {
let config = config::Config::default_for_test();
#[allow(unused_mut)]
let mut tera = tera::Tera::default();
// Add all shortcodes
$(
tera.add_raw_template(
&format!("shortcodes/{}", $shortcodes.filename()),
$shortcodes.output
).expect("Failed to add raw template");
)*
let permalinks = std::collections::HashMap::new();
let mut context = rendering::RenderContext::new(
&tera,
&config,
&config.default_language,
"",
&permalinks,
front_matter::InsertAnchor::None,
);
let shortcode_def = utils::templates::get_shortcodes(&tera);
context.set_shortcode_definitions(&shortcode_def);
let rendered = rendering::render_content($in_str, &context);
assert!(rendered.is_ok());
let rendered = rendered.unwrap();
assert!(rendered.summary_len.is_some());
let summary_len = rendered.summary_len.unwrap();
assert_eq!(&rendered.body[..summary_len], $summary);
}
}
#[test]
fn basic_summary() {
test_scenario_summary!("Hello World!\n<!-- more -->\nAnd others!", "<p>Hello World!</p>\n", []);
test_scenario_summary!(
"Hello World!\n\nWow!\n<!-- more -->\nAnd others!",
"<p>Hello World!</p>\n<p>Wow!</p>\n",
[]
);
}
#[test]
fn summary_with_headers() {
test_scenario_summary!(
"# Hello World!\n<!-- more -->\nAnd others!",
"<h1 id=\"hello-world\">Hello World!</h1>\n",
[]
);
test_scenario_summary!(
"# Hello World!\n\nWow!\n<!-- more -->\nAnd others!",
"<h1 id=\"hello-world\">Hello World!</h1>\n<p>Wow!</p>\n",
[]
);
}
const MD_SIMPLE: ShortCode =
ShortCode::new("simple", "A lot of text to insert into the document", true);
const HTML_SIMPLE: ShortCode =
ShortCode::new("simple", "A lot of text to insert into the document", true);
#[test]
fn summary_with_md_shortcodes() {
test_scenario_summary!(
"{{ simple() }}\n<!-- more -->\nAnd others!",
"<p>A lot of text to insert into the document</p>\n",
[MD_SIMPLE]
);
test_scenario_summary!(
"{{ simple() }}\n\nWow!\n<!-- more -->\nAnd others!",
"<p>A lot of text to insert into the document</p>\n<p>Wow!</p>\n",
[MD_SIMPLE]
);
}
#[test]
fn summary_with_html_shortcodes() {
test_scenario_summary!(
"{{ simple() }}\n<!-- more -->\nAnd others!",
"<p>A lot of text to insert into the document</p>\n",
[HTML_SIMPLE]
);
test_scenario_summary!(
"{{ simple() }}\n\nWow!\n<!-- more -->\nAnd others!",
"<p>A lot of text to insert into the document</p>\n<p>Wow!</p>\n",
[HTML_SIMPLE]
);
}
// const INNER: ShortCode = ShortCode::new("inner", "World", false);
//
// const MD_RECURSIVE: ShortCode = ShortCode::new("outer", "Hello {{ inner() }}!", true);
// const HTML_RECURSIVE: ShortCode = ShortCode::new("outer", "Hello {{ inner() }}!", false);
//
// #[test]
// fn summary_with_recursive_shortcodes() {
// test_scenario_summary!(
// "{{ outer() }}\n<!-- more -->\nAnd others!",
// "<p>Hello World!</p>\n",
// [MD_RECURSIVE, INNER]
// );
//
// test_scenario_summary!(
// "{{ outer() }}\n<!-- more -->\nAnd others!",
// "<p>Hello World!</p>\n",
// [HTML_RECURSIVE, INNER]
// );
// }