use std::collections::HashMap; use chrono::prelude::*; use serde_derive::Deserialize; use tera::{Map, Value}; use errors::{bail, Result}; use utils::de::{fix_toml_dates, from_toml_datetime}; use crate::RawFrontMatter; /// The front matter of every page #[derive(Debug, Clone, PartialEq, Deserialize)] #[serde(default)] pub struct PageFrontMatter { /// of the page pub title: Option<String>, /// Description in <meta> that appears when linked, e.g. on twitter pub description: Option<String>, /// Updated date #[serde(default, deserialize_with = "from_toml_datetime")] pub updated: Option<String>, /// Date if we want to order pages (ie blog post) #[serde(default, deserialize_with = "from_toml_datetime")] pub date: Option<String>, /// Chrono converted datetime #[serde(default, skip_deserializing)] pub datetime: Option<NaiveDateTime>, /// The converted date into a (year, month, day) tuple #[serde(default, skip_deserializing)] pub datetime_tuple: Option<(i32, u32, u32)>, /// Whether this page is a draft pub draft: bool, /// The page slug. Will be used instead of the filename if present /// Can't be an empty string if present pub slug: Option<String>, /// The path the page appears at, overrides the slug if set in the front-matter /// otherwise is set after parsing front matter and sections /// Can't be an empty string if present pub path: Option<String>, pub taxonomies: HashMap<String, Vec<String>>, /// Integer to use to order content. Highest is at the bottom, lowest first pub weight: Option<usize>, /// All aliases for that page. Zola will create HTML templates that will /// redirect to this #[serde(skip_serializing)] pub aliases: Vec<String>, /// Specify a template different from `page.html` to use for that page #[serde(skip_serializing)] pub template: Option<String>, /// Whether the page is included in the search index /// Defaults to `true` but is only used if search if explicitly enabled in the config. #[serde(skip_serializing)] pub in_search_index: bool, /// Any extra parameter present in the front matter pub extra: Map<String, Value>, } /// Parse a string for a datetime coming from one of the supported TOML format /// There are three alternatives: /// 1. an offset datetime (plain RFC3339) /// 2. a local datetime (RFC3339 with timezone omitted) /// 3. a local date (YYYY-MM-DD). /// This tries each in order. fn parse_datetime(d: &str) -> Option<NaiveDateTime> { DateTime::parse_from_rfc3339(d) .or_else(|_| DateTime::parse_from_rfc3339(format!("{}Z", d).as_ref())) .map(|s| s.naive_local()) .or_else(|_| NaiveDate::parse_from_str(d, "%Y-%m-%d").map(|s| s.and_hms(0, 0, 0))) .ok() } impl PageFrontMatter { pub fn parse(raw: &RawFrontMatter) -> Result<PageFrontMatter> { let mut f: PageFrontMatter = raw.deserialize()?; if let Some(ref slug) = f.slug { if slug == "" { bail!("`slug` can't be empty if present") } } if let Some(ref path) = f.path { if path == "" { bail!("`path` can't be empty if present") } } f.extra = match fix_toml_dates(f.extra) { Value::Object(o) => o, _ => unreachable!("Got something other than a table in page extra"), }; f.date_to_datetime(); if let Some(ref date) = f.date { if f.datetime.is_none() { bail!("`date` could not be parsed: {}.", date); } } Ok(f) } /// Converts the TOML datetime to a Chrono naive datetime /// Also grabs the year/month/day tuple that will be used in serialization pub fn date_to_datetime(&mut self) { self.datetime = self.date.as_ref().map(|s| s.as_ref()).and_then(parse_datetime); self.datetime_tuple = self.datetime.map(|dt| (dt.year(), dt.month(), dt.day())); } pub fn weight(&self) -> usize { self.weight.unwrap() } } impl Default for PageFrontMatter { fn default() -> PageFrontMatter { PageFrontMatter { title: None, description: None, updated: None, date: None, datetime: None, datetime_tuple: None, draft: false, slug: None, path: None, taxonomies: HashMap::new(), weight: None, aliases: Vec::new(), in_search_index: true, template: None, extra: Map::new(), } } } #[cfg(test)] mod tests { use super::PageFrontMatter; use super::RawFrontMatter; use tera::to_value; use test_case::test_case; #[test_case(&RawFrontMatter::Toml(r#" "#); "toml")] #[test_case(&RawFrontMatter::Toml(r#" "#); "yaml")] fn can_have_empty_front_matter(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); println!("{:?}", res); assert!(res.is_ok()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there "#); "yaml")] fn can_parse_valid_front_matter(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); assert!(res.is_ok()); let res = res.unwrap(); assert_eq!(res.title.unwrap(), "Hello".to_string()); assert_eq!(res.description.unwrap(), "hey there".to_string()) } #[test_case(&RawFrontMatter::Toml(r#"title = |\n"#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#"title: |\n"#); "yaml")] fn errors_with_invalid_front_matter(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); assert!(res.is_err()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" slug = "" "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there slug: "" "#); "yaml")] fn errors_on_present_but_empty_slug(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); assert!(res.is_err()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" path = "" "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there path: "" "#); "yaml")] fn errors_on_present_but_empty_path(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); assert!(res.is_err()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = 2016-10-10 "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: 2016-10-10 "#); "yaml")] fn can_parse_date_yyyy_mm_dd(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content).unwrap(); assert!(res.datetime.is_some()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = 2002-10-02T15:00:00Z "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: 2002-10-02T15:00:00Z "#); "yaml")] fn can_parse_date_rfc3339(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content).unwrap(); assert!(res.datetime.is_some()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = 2002-10-02T15:00:00 "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: 2002-10-02T15:00:00 "#); "yaml")] fn can_parse_date_rfc3339_without_timezone(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content).unwrap(); assert!(res.datetime.is_some()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = 2002-10-02 15:00:00+02:00 "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: 2002-10-02 15:00:00+02:00 "#); "yaml")] fn can_parse_date_rfc3339_with_space(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content).unwrap(); assert!(res.datetime.is_some()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = 2002-10-02 15:00:00 "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: 2002-10-02 15:00:00 "#); "yaml")] fn can_parse_date_rfc3339_with_space_without_timezone(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content).unwrap(); assert!(res.datetime.is_some()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = 2002-10-02T15:00:00.123456Z "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: 2002-10-02T15:00:00.123456Z "#); "yaml")] fn can_parse_date_rfc3339_with_microseconds(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content).unwrap(); assert!(res.datetime.is_some()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = 2002/10/12 "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: 2002/10/12 "#); "yaml")] fn cannot_parse_random_date_format(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); assert!(res.is_err()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = 2002-14-01 "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: 2002-14-01 "#); "yaml")] fn cannot_parse_invalid_date_format(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); assert!(res.is_err()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = "2016-10-10" "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: "2016-10-10" "#); "yaml")] fn can_parse_valid_date_as_string(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content).unwrap(); assert!(res.date.is_some()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" date = "2002-14-01" "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there date: "2002-14-01" "#); "yaml")] fn cannot_parse_invalid_date_as_string(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); assert!(res.is_err()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" [extra] some-date = 2002-14-01 "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there extra: some-date: 2002-14-01 "#); "yaml")] fn can_parse_dates_in_extra(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); println!("{:?}", res); assert!(res.is_ok()); assert_eq!(res.unwrap().extra["some-date"], to_value("2002-14-01").unwrap()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" [extra.something] some-date = 2002-14-01 "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there extra: something: some-date: 2002-14-01 "#); "yaml")] fn can_parse_nested_dates_in_extra(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); println!("{:?}", res); assert!(res.is_ok()); assert_eq!(res.unwrap().extra["something"]["some-date"], to_value("2002-14-01").unwrap()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello" description = "hey there" [extra] date_example = 2020-05-04 [[extra.questions]] date = 2020-05-03 name = "Who is the prime minister of Uganda?" "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello description: hey there extra: date_example: 2020-05-04 questions: - date: 2020-05-03 name: "Who is the prime minister of Uganda?" "#); "yaml")] fn can_parse_fully_nested_dates_in_extra(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); println!("{:?}", res); assert!(res.is_ok()); assert_eq!(res.unwrap().extra["questions"][0]["date"], to_value("2020-05-03").unwrap()); } #[test_case(&RawFrontMatter::Toml(r#" title = "Hello World" [taxonomies] tags = ["Rust", "JavaScript"] categories = ["Dev"] "#); "toml")] #[test_case(&RawFrontMatter::Yaml(r#" title: Hello World taxonomies: tags: - Rust - JavaScript categories: - Dev "#); "yaml")] fn can_parse_taxonomies(content: &RawFrontMatter) { let res = PageFrontMatter::parse(content); println!("{:?}", res); assert!(res.is_ok()); let res2 = res.unwrap(); assert_eq!(res2.taxonomies["categories"], vec!["Dev"]); assert_eq!(res2.taxonomies["tags"], vec!["Rust", "JavaScript"]); } }