use minijinja::Environment;
mod files;
mod inline;
const TEMPLATE_GROUPS: &[&[(&str, &str)]] = &[inline::TEMPLATES, files::TEMPLATES];
pub(crate) fn make_env() -> Environment<'static> {
let mut env = Environment::new();
env.set_trim_blocks(true);
env.set_lstrip_blocks(true);
env.set_keep_trailing_newline(true);
for templates in TEMPLATE_GROUPS {
for (name, src) in *templates {
env.add_template(name, src).expect("built-in template is valid");
}
}
env
}
pub(crate) fn render(template_name: &str, ctx: minijinja::Value) -> String {
let rendered = make_env()
.get_template(template_name)
.unwrap_or_else(|_| panic!("template {template_name} not found"))
.render(ctx)
.unwrap_or_else(|e| panic!("template {template_name} failed to render: {e}"));
crate::core::keep_marker::strip_keep_markers(&rendered)
}
#[cfg(test)]
mod autoescape_tests {
#[test]
fn rendering_a_text_template_does_not_autoescape() {
let mut env = super::make_env();
env.add_template("autoescape_probe.ex.jinja", "{{ probe }}")
.expect("probe template is valid");
let rendered = env
.get_template("autoescape_probe.ex.jinja")
.expect("probe template is registered")
.render(minijinja::context! { probe => "a<b>&\"c\"'d'" })
.expect("probe template renders");
assert_eq!(
rendered, "a<b>&\"c\"'d'",
"the environment must emit text verbatim; HTML-escaping here would corrupt every \
value the backends escape for their own target language before rendering"
);
}
#[test]
fn the_tagged_enum_encoder_template_passes_escaped_values_through_unchanged() {
let rendered = super::render(
"elixir_tagged_enum_encoder.ex.jinja",
minijinja::context! {
fn_name => "encode_e",
enum_name => "E",
tag => "ta\\#{1}g",
variants => vec![minijinja::context! {
atom => "a",
wire => "wi\\#{1}re",
is_unit => true,
field_renames => Vec::<minijinja::Value>::new(),
}],
},
);
assert!(
rendered.contains("defp encode_e(:a), do: %{\"ta\\#{1}g\" => \"wi\\#{1}re\"}"),
"escaped values must survive rendering byte for byte; got:\n{rendered}"
);
}
}
#[cfg(test)]
mod template_registration_tests {
use super::TEMPLATE_GROUPS;
use std::collections::HashSet;
use std::path::Path;
#[test]
fn every_template_file_is_registered() {
let templates_dir = Path::new(concat!(env!("CARGO_MANIFEST_DIR"), "/src/backends/rustler/templates"));
let registered_contents: HashSet<&str> = TEMPLATE_GROUPS
.iter()
.flat_map(|group| group.iter())
.map(|(_, content)| *content)
.collect();
let mut unregistered = Vec::new();
collect_unregistered(templates_dir, templates_dir, ®istered_contents, &mut unregistered);
unregistered.sort();
assert!(
unregistered.is_empty(),
"found .jinja file(s) in templates/ whose content is not registered in TEMPLATE_GROUPS: {unregistered:?}"
);
}
fn collect_unregistered(
root: &Path,
dir: &Path,
registered_contents: &HashSet<&str>,
unregistered: &mut Vec<String>,
) {
for entry in std::fs::read_dir(dir).expect("read templates directory") {
let entry = entry.expect("read templates directory entry");
let path = entry.path();
if path.is_dir() {
collect_unregistered(root, &path, registered_contents, unregistered);
continue;
}
if path.extension().and_then(|ext| ext.to_str()) != Some("jinja") {
continue;
}
let content = std::fs::read_to_string(&path).expect("read template file");
if !registered_contents.contains(content.as_str()) {
let relative = path
.strip_prefix(root)
.expect("template path under templates root")
.to_str()
.expect("template path is valid UTF-8")
.replace('\\', "/");
unregistered.push(relative);
}
}
}
}