zola/components/templates/src/global_fns.rs

408 lines
13 KiB
Rust
Raw Normal View History

2017-05-03 14:16:09 +00:00
use std::collections::HashMap;
2018-02-02 20:35:04 +00:00
use std::sync::{Arc, Mutex};
2017-05-03 14:16:09 +00:00
use tera::{GlobalFn, Value, from_value, to_value, Result};
2018-10-02 14:42:34 +00:00
use library::{Taxonomy, Library};
use config::Config;
2017-07-01 07:47:41 +00:00
use utils::site::resolve_internal_link;
2018-02-02 20:35:04 +00:00
use imageproc;
2017-05-03 14:16:09 +00:00
2018-02-02 20:35:04 +00:00
macro_rules! required_arg {
($ty: ty, $e: expr, $err: expr) => {
match $e {
2018-02-02 20:35:04 +00:00
Some(v) => match from_value::<$ty>(v.clone()) {
Ok(u) => u,
Err(_) => return Err($err.into())
},
None => return Err($err.into())
2018-02-02 20:35:04 +00:00
}
};
}
macro_rules! optional_arg {
($ty: ty, $e: expr, $err: expr) => {
match $e {
Some(v) => match from_value::<$ty>(v.clone()) {
Ok(u) => Some(u),
Err(_) => return Err($err.into())
},
None => None
}
};
}
2018-01-12 23:10:19 +00:00
pub fn make_trans(config: Config) -> GlobalFn {
2018-03-12 19:11:03 +00:00
let translations_config = config.translations;
2018-02-02 20:35:04 +00:00
let default_lang = config.default_language.clone();
2018-01-12 23:10:19 +00:00
Box::new(move |args| -> Result<Value> {
2018-02-02 20:35:04 +00:00
let key = required_arg!(String, args.get("key"), "`trans` requires a `key` argument.");
2018-06-25 17:13:21 +00:00
let lang = optional_arg!(
String,
args.get("lang"),
"`trans`: `lang` must be a string."
2018-09-30 19:15:09 +00:00
).unwrap_or_else(|| default_lang.clone());
2018-01-12 23:10:19 +00:00
let translations = &translations_config[lang.as_str()];
Ok(to_value(&translations[key.as_str()]).unwrap())
})
}
2018-10-02 14:42:34 +00:00
pub fn make_get_page(library: &Library) -> GlobalFn {
2017-05-03 14:16:09 +00:00
let mut pages = HashMap::new();
2018-10-02 14:42:34 +00:00
for page in library.pages_values() {
pages.insert(
page.file.relative.clone(),
library.get_cached_page_value(&page.file.path).clone(),
);
2017-05-03 14:16:09 +00:00
}
Box::new(move |args| -> Result<Value> {
2018-06-25 17:13:21 +00:00
let path = required_arg!(
String,
args.get("path"),
"`get_page` requires a `path` argument with a string value"
);
match pages.get(&path) {
2018-10-02 14:42:34 +00:00
Some(p) => Ok(p.clone()),
None => Err(format!("Page `{}` not found.", path).into())
2017-05-03 14:16:09 +00:00
}
})
}
2017-05-17 10:04:26 +00:00
2018-10-02 14:42:34 +00:00
pub fn make_get_section(library: &Library) -> GlobalFn {
2017-05-23 11:03:25 +00:00
let mut sections = HashMap::new();
2018-10-02 14:42:34 +00:00
for section in library.sections_values() {
sections.insert(
section.file.relative.clone(),
library.get_cached_section_value(&section.file.path).clone(),
);
2017-05-23 11:03:25 +00:00
}
Box::new(move |args| -> Result<Value> {
2018-06-25 17:13:21 +00:00
let path = required_arg!(
String,
args.get("path"),
"`get_section` requires a `path` argument with a string value"
);
2018-10-02 14:42:34 +00:00
match sections.get(&path) {
2018-10-02 14:42:34 +00:00
Some(p) => Ok(p.clone()),
None => Err(format!("Section `{}` not found.", path).into())
2017-05-23 11:03:25 +00:00
}
})
}
2017-08-07 14:29:58 +00:00
pub fn make_get_url(permalinks: HashMap<String, String>, config: Config) -> GlobalFn {
Box::new(move |args| -> Result<Value> {
let cachebust = args
.get("cachebust")
2017-08-07 14:29:58 +00:00
.map_or(false, |c| {
from_value::<bool>(c.clone()).unwrap_or(false)
});
let trailing_slash = args
.get("trailing_slash")
.map_or(false, |c| {
from_value::<bool>(c.clone()).unwrap_or(false)
});
2018-06-25 17:13:21 +00:00
let path = required_arg!(
String,
args.get("path"),
"`get_url` requires a `path` argument with a string value"
);
if path.starts_with("./") {
match resolve_internal_link(&path, &permalinks) {
Ok(url) => Ok(to_value(url).unwrap()),
Err(_) => Err(format!("Could not resolve URL for link `{}` not found.", path).into())
}
} else {
// anything else
let mut permalink = config.make_permalink(&path);
2018-09-30 19:15:09 +00:00
if !trailing_slash && permalink.ends_with('/') {
permalink.pop(); // Removes the slash
}
if cachebust {
permalink = format!("{}?t={}", permalink, config.build_timestamp.unwrap());
}
Ok(to_value(permalink).unwrap())
}
})
}
2018-10-02 14:42:34 +00:00
pub fn make_get_taxonomy(all_taxonomies: &[Taxonomy], library: &Library) -> GlobalFn {
2018-07-16 08:54:05 +00:00
let mut taxonomies = HashMap::new();
for taxonomy in all_taxonomies {
2018-10-02 14:42:34 +00:00
taxonomies.insert(
taxonomy.kind.name.clone(),
to_value(taxonomy.to_serialized(library)).unwrap()
);
2018-07-16 08:54:05 +00:00
}
Box::new(move |args| -> Result<Value> {
2018-06-25 17:13:21 +00:00
let kind = required_arg!(
String,
args.get("kind"),
2018-07-16 08:54:05 +00:00
"`get_taxonomy` requires a `kind` argument with a string value"
2018-06-25 17:13:21 +00:00
);
2018-07-16 08:54:05 +00:00
let container = match taxonomies.get(&kind) {
Some(c) => c,
None => return Err(
format!("`get_taxonomy` received an unknown taxonomy as kind: {}", kind).into()
2018-06-25 17:13:21 +00:00
),
};
2018-09-30 19:15:09 +00:00
Ok(to_value(container).unwrap())
})
}
2018-10-02 14:42:34 +00:00
pub fn make_get_taxonomy_url(all_taxonomies: &[Taxonomy]) -> GlobalFn {
let mut taxonomies = HashMap::new();
for taxonomy in all_taxonomies {
2018-10-02 14:42:34 +00:00
let mut items = HashMap::new();
for item in &taxonomy.items {
items.insert(item.name.clone(), item.permalink.clone());
}
taxonomies.insert(taxonomy.kind.name.clone(), items);
}
Box::new(move |args| -> Result<Value> {
let kind = required_arg!(
String,
args.get("kind"),
"`get_taxonomy_url` requires a `kind` argument with a string value"
);
let name = required_arg!(
String,
args.get("name"),
"`get_taxonomy_url` requires a `name` argument with a string value"
);
let container = match taxonomies.get(&kind) {
Some(c) => c,
None => return Err(
format!("`get_taxonomy_url` received an unknown taxonomy as kind: {}", kind).into()
)
};
2018-10-02 14:42:34 +00:00
if let Some(ref permalink) = container.get(&name) {
return Ok(to_value(permalink.clone()).unwrap());
}
Err(
format!("`get_taxonomy_url`: couldn't find `{}` in `{}` taxonomy", name, kind).into()
)
})
}
2018-02-02 20:35:04 +00:00
pub fn make_resize_image(imageproc: Arc<Mutex<imageproc::Processor>>) -> GlobalFn {
static DEFAULT_OP: &'static str = "fill";
const DEFAULT_Q: u8 = 75;
Box::new(move |args| -> Result<Value> {
2018-06-25 17:13:21 +00:00
let path = required_arg!(
String,
args.get("path"),
"`resize_image` requires a `path` argument with a string value"
);
let width = optional_arg!(
u32,
args.get("width"),
"`resize_image`: `width` must be a non-negative integer"
);
let height = optional_arg!(
u32,
args.get("height"),
"`resize_image`: `height` must be a non-negative integer"
);
let op = optional_arg!(
String,
args.get("op"),
"`resize_image`: `op` must be a string"
2018-09-30 19:15:09 +00:00
).unwrap_or_else(|| DEFAULT_OP.to_string());
2018-06-25 17:13:21 +00:00
let quality = optional_arg!(
u8,
args.get("quality"),
"`resize_image`: `quality` must be a number"
).unwrap_or(DEFAULT_Q);
2018-02-02 20:35:04 +00:00
if quality == 0 || quality > 100 {
return Err("`resize_image`: `quality` must be in range 1-100".to_string().into());
}
let mut imageproc = imageproc.lock().unwrap();
if !imageproc.source_exists(&path) {
return Err(format!("`resize_image`: Cannot find path: {}", path).into());
}
2018-06-25 17:13:21 +00:00
let imageop = imageproc::ImageOp::from_args(path.clone(), &op, width, height, quality)
.map_err(|e| format!("`resize_image`: {}", e))?;
2018-02-02 20:35:04 +00:00
let url = imageproc.insert(imageop);
to_value(url).map_err(|err| err.into())
})
}
#[cfg(test)]
mod tests {
use super::{make_get_url, make_get_taxonomy, make_get_taxonomy_url, make_trans};
use std::collections::HashMap;
2018-10-02 14:42:34 +00:00
use tera::{to_value, Value};
2018-07-16 08:54:05 +00:00
use config::{Config, Taxonomy as TaxonomyConfig};
2018-10-02 14:42:34 +00:00
use library::{Taxonomy, TaxonomyItem, Library};
#[test]
2017-08-07 14:29:58 +00:00
fn can_add_cachebust_to_url() {
let config = Config::default();
2017-08-07 14:29:58 +00:00
let static_fn = make_get_url(HashMap::new(), config);
let mut args = HashMap::new();
args.insert("path".to_string(), to_value("app.css").unwrap());
2017-08-07 14:29:58 +00:00
args.insert("cachebust".to_string(), to_value(true).unwrap());
assert_eq!(static_fn(args).unwrap(), "http://a-website.com/app.css?t=1");
}
#[test]
fn can_add_trailing_slashes() {
let config = Config::default();
let static_fn = make_get_url(HashMap::new(), config);
let mut args = HashMap::new();
args.insert("path".to_string(), to_value("app.css").unwrap());
args.insert("trailing_slash".to_string(), to_value(true).unwrap());
assert_eq!(static_fn(args).unwrap(), "http://a-website.com/app.css/");
}
#[test]
fn can_add_slashes_and_cachebust() {
let config = Config::default();
let static_fn = make_get_url(HashMap::new(), config);
let mut args = HashMap::new();
args.insert("path".to_string(), to_value("app.css").unwrap());
args.insert("trailing_slash".to_string(), to_value(true).unwrap());
args.insert("cachebust".to_string(), to_value(true).unwrap());
assert_eq!(static_fn(args).unwrap(), "http://a-website.com/app.css/?t=1");
}
#[test]
2017-08-07 14:29:58 +00:00
fn can_link_to_some_static_file() {
let config = Config::default();
2017-08-07 14:29:58 +00:00
let static_fn = make_get_url(HashMap::new(), config);
let mut args = HashMap::new();
args.insert("path".to_string(), to_value("app.css").unwrap());
assert_eq!(static_fn(args).unwrap(), "http://a-website.com/app.css");
}
#[test]
2018-07-16 08:54:05 +00:00
fn can_get_taxonomy() {
2018-07-31 13:17:31 +00:00
let taxo_config = TaxonomyConfig { name: "tags".to_string(), ..TaxonomyConfig::default() };
2018-10-02 14:42:34 +00:00
let library = Library::new(0, 0);
let tag = TaxonomyItem::new(
2018-10-02 14:42:34 +00:00
"Programming",
2018-07-16 08:54:05 +00:00
"tags",
&Config::default(),
vec![],
2018-10-02 14:42:34 +00:00
&library
);
let tags = Taxonomy {
2018-07-16 08:54:05 +00:00
kind: taxo_config,
items: vec![tag],
};
2018-10-02 14:42:34 +00:00
let taxonomies = vec![tags.clone()];
let static_fn = make_get_taxonomy(&taxonomies, &library);
// can find it correctly
let mut args = HashMap::new();
2018-07-16 08:54:05 +00:00
args.insert("kind".to_string(), to_value("tags").unwrap());
2018-10-02 14:42:34 +00:00
let res = static_fn(args).unwrap();
let res_obj = res.as_object().unwrap();
assert_eq!(res_obj["kind"], to_value(tags.kind).unwrap());
assert_eq!(res_obj["items"].clone().as_array().unwrap().len(), 1);
assert_eq!(
res_obj["items"].clone().as_array().unwrap()[0].clone().as_object().unwrap()["name"],
Value::String("Programming".to_string())
);
assert_eq!(
res_obj["items"].clone().as_array().unwrap()[0].clone().as_object().unwrap()["slug"],
Value::String("programming".to_string())
);
assert_eq!(
res_obj["items"].clone().as_array().unwrap()[0].clone().as_object().unwrap()["permalink"],
Value::String("http://a-website.com/tags/programming/".to_string())
);
assert_eq!(
res_obj["items"].clone().as_array().unwrap()[0].clone().as_object().unwrap()["pages"],
Value::Array(vec![])
);
// and errors if it can't find it
let mut args = HashMap::new();
2018-07-16 08:54:05 +00:00
args.insert("kind".to_string(), to_value("something-else").unwrap());
assert!(static_fn(args).is_err());
}
2018-01-12 23:10:19 +00:00
#[test]
fn can_get_taxonomy_url() {
let taxo_config = TaxonomyConfig { name: "tags".to_string(), ..TaxonomyConfig::default() };
2018-10-02 14:42:34 +00:00
let library = Library::new(0, 0);
let tag = TaxonomyItem::new(
"Programming",
"tags",
&Config::default(),
vec![],
2018-10-02 14:42:34 +00:00
&library
);
let tags = Taxonomy {
kind: taxo_config,
items: vec![tag],
};
2018-10-02 14:42:34 +00:00
let taxonomies = vec![tags.clone()];
let static_fn = make_get_taxonomy_url(&taxonomies);
// can find it correctly
let mut args = HashMap::new();
args.insert("kind".to_string(), to_value("tags").unwrap());
args.insert("name".to_string(), to_value("Programming").unwrap());
2018-08-03 16:32:30 +00:00
assert_eq!(static_fn(args).unwrap(), to_value("http://a-website.com/tags/programming/").unwrap());
// and errors if it can't find it
let mut args = HashMap::new();
args.insert("kind".to_string(), to_value("tags").unwrap());
args.insert("name".to_string(), to_value("random").unwrap());
assert!(static_fn(args).is_err());
}
2018-01-12 23:10:19 +00:00
#[test]
fn can_translate_a_string() {
let trans_config = r#"
base_url = "https://remplace-par-ton-url.fr"
default_language = "fr"
[translations]
[translations.fr]
title = "Un titre"
[translations.en]
title = "A title"
"#;
let config = Config::parse(trans_config).unwrap();
let static_fn = make_trans(config);
let mut args = HashMap::new();
args.insert("key".to_string(), to_value("title").unwrap());
assert_eq!(static_fn(args.clone()).unwrap(), "Un titre");
args.insert("lang".to_string(), to_value("en").unwrap());
assert_eq!(static_fn(args.clone()).unwrap(), "A title");
args.insert("lang".to_string(), to_value("fr").unwrap());
assert_eq!(static_fn(args.clone()).unwrap(), "Un titre");
}
}