2016-12-06 08:27:03 +00:00
|
|
|
/// A page, can be a blog post or a basic page
|
2017-03-06 11:58:31 +00:00
|
|
|
use std::cmp::Ordering;
|
2017-03-14 12:25:45 +00:00
|
|
|
use std::fs::{read_dir};
|
2017-03-12 03:54:57 +00:00
|
|
|
use std::path::{Path, PathBuf};
|
2017-02-23 08:34:57 +00:00
|
|
|
use std::result::Result as StdResult;
|
2016-12-06 08:27:03 +00:00
|
|
|
|
2016-12-13 06:22:24 +00:00
|
|
|
|
2017-02-23 08:34:57 +00:00
|
|
|
use tera::{Tera, Context};
|
|
|
|
use serde::ser::{SerializeStruct, self};
|
2017-03-03 08:12:40 +00:00
|
|
|
use slug::slugify;
|
2016-12-06 08:27:03 +00:00
|
|
|
|
2016-12-11 06:05:03 +00:00
|
|
|
use errors::{Result, ResultExt};
|
2016-12-06 12:48:23 +00:00
|
|
|
use config::Config;
|
2017-03-14 12:25:45 +00:00
|
|
|
use front_matter::{FrontMatter, split_content};
|
2017-03-07 12:34:31 +00:00
|
|
|
use markdown::markdown_to_html;
|
2017-03-14 12:25:45 +00:00
|
|
|
use utils::{read_file, find_content_components};
|
2016-12-06 08:27:03 +00:00
|
|
|
|
|
|
|
|
2017-03-07 03:42:14 +00:00
|
|
|
|
2017-03-12 03:54:57 +00:00
|
|
|
/// Looks into the current folder for the path and see if there's anything that is not a .md
|
|
|
|
/// file. Those will be copied next to the rendered .html file
|
|
|
|
fn find_related_assets(path: &Path) -> Vec<PathBuf> {
|
|
|
|
let mut assets = vec![];
|
|
|
|
|
2017-03-14 12:25:45 +00:00
|
|
|
for entry in read_dir(path).unwrap().filter_map(|e| e.ok()) {
|
2017-03-12 03:54:57 +00:00
|
|
|
let entry_path = entry.path();
|
|
|
|
if entry_path.is_file() {
|
|
|
|
match entry_path.extension() {
|
|
|
|
Some(e) => match e.to_str() {
|
|
|
|
Some("md") => continue,
|
|
|
|
_ => assets.push(entry_path.to_path_buf()),
|
|
|
|
},
|
|
|
|
None => continue,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
assets
|
|
|
|
}
|
|
|
|
|
2016-12-06 11:53:14 +00:00
|
|
|
|
2017-03-14 12:25:45 +00:00
|
|
|
#[derive(Clone, Debug, PartialEq)]
|
2016-12-11 06:05:03 +00:00
|
|
|
pub struct Page {
|
2017-03-14 12:25:45 +00:00
|
|
|
/// The .md path
|
|
|
|
pub file_path: PathBuf,
|
|
|
|
/// The parent directory of the file. Is actually the grand parent directory
|
|
|
|
/// if it's an asset folder
|
|
|
|
pub parent_path: PathBuf,
|
2017-02-23 08:34:57 +00:00
|
|
|
/// The name of the .md file
|
2017-03-14 12:25:45 +00:00
|
|
|
pub file_name: String,
|
|
|
|
/// The directories above our .md file
|
|
|
|
/// for example a file at content/kb/solutions/blabla.md will have 2 components:
|
2017-02-23 08:34:57 +00:00
|
|
|
/// `kb` and `solutions`
|
2017-03-14 12:25:45 +00:00
|
|
|
pub components: Vec<String>,
|
2017-02-23 08:34:57 +00:00
|
|
|
/// The actual content of the page, in markdown
|
2016-12-13 09:05:59 +00:00
|
|
|
pub raw_content: String,
|
2017-03-12 03:54:57 +00:00
|
|
|
/// All the non-md files we found next to the .md file
|
|
|
|
pub assets: Vec<PathBuf>,
|
2017-02-23 08:34:57 +00:00
|
|
|
/// The HTML rendered of the page
|
2016-12-11 06:05:03 +00:00
|
|
|
pub content: String,
|
2017-02-23 08:34:57 +00:00
|
|
|
/// The front matter meta-data
|
|
|
|
pub meta: FrontMatter,
|
2017-03-06 14:45:57 +00:00
|
|
|
|
|
|
|
/// The slug of that page.
|
|
|
|
/// First tries to find the slug in the meta and defaults to filename otherwise
|
|
|
|
pub slug: String,
|
|
|
|
/// The relative URL of the page
|
|
|
|
pub url: String,
|
|
|
|
/// The full URL for that page
|
|
|
|
pub permalink: String,
|
2017-03-07 03:42:14 +00:00
|
|
|
/// The summary for the article, defaults to empty string
|
|
|
|
/// When <!-- more --> is found in the text, will take the content up to that part
|
|
|
|
/// as summary
|
|
|
|
pub summary: String,
|
2017-03-06 14:45:57 +00:00
|
|
|
|
2017-03-22 11:59:49 +00:00
|
|
|
/// The previous page, by date globally
|
2017-02-23 08:34:57 +00:00
|
|
|
pub previous: Option<Box<Page>>,
|
2017-03-22 11:59:49 +00:00
|
|
|
/// The previous page, by date only for the section the page is in
|
|
|
|
pub previous_in_section: Option<Box<Page>>,
|
2017-02-23 08:34:57 +00:00
|
|
|
/// The next page, by date
|
|
|
|
pub next: Option<Box<Page>>,
|
2017-03-22 11:59:49 +00:00
|
|
|
/// The next page, by date only for the section the page is in
|
|
|
|
pub next_in_section: Option<Box<Page>>,
|
2016-12-06 08:27:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-02-23 08:34:57 +00:00
|
|
|
impl Page {
|
|
|
|
pub fn new(meta: FrontMatter) -> Page {
|
2016-12-06 11:53:14 +00:00
|
|
|
Page {
|
2017-03-14 12:25:45 +00:00
|
|
|
file_path: PathBuf::new(),
|
|
|
|
parent_path: PathBuf::new(),
|
|
|
|
file_name: "".to_string(),
|
|
|
|
components: vec![],
|
2016-12-13 06:22:24 +00:00
|
|
|
raw_content: "".to_string(),
|
2017-03-12 03:54:57 +00:00
|
|
|
assets: vec![],
|
2016-12-06 11:53:14 +00:00
|
|
|
content: "".to_string(),
|
2017-03-06 14:45:57 +00:00
|
|
|
slug: "".to_string(),
|
|
|
|
url: "".to_string(),
|
|
|
|
permalink: "".to_string(),
|
2017-03-07 03:42:14 +00:00
|
|
|
summary: "".to_string(),
|
2017-02-23 08:34:57 +00:00
|
|
|
meta: meta,
|
|
|
|
previous: None,
|
2017-03-22 11:59:49 +00:00
|
|
|
previous_in_section: None,
|
2017-02-23 08:34:57 +00:00
|
|
|
next: None,
|
2017-03-22 11:59:49 +00:00
|
|
|
next_in_section: None,
|
2016-12-06 11:53:14 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-22 11:59:49 +00:00
|
|
|
pub fn has_date(&self) -> bool {
|
|
|
|
self.meta.date.is_some()
|
|
|
|
}
|
|
|
|
|
2017-03-12 03:54:57 +00:00
|
|
|
/// Get word count and estimated reading time
|
2017-03-06 13:45:33 +00:00
|
|
|
pub fn get_reading_analytics(&self) -> (usize, usize) {
|
|
|
|
// Only works for latin language but good enough for a start
|
|
|
|
let word_count: usize = self.raw_content.split_whitespace().count();
|
|
|
|
|
|
|
|
// https://help.medium.com/hc/en-us/articles/214991667-Read-time
|
|
|
|
// 275 seems a bit too high though
|
|
|
|
(word_count, (word_count / 200))
|
|
|
|
}
|
|
|
|
|
2017-03-12 03:54:57 +00:00
|
|
|
/// Parse a page given the content of the .md file
|
|
|
|
/// Files without front matter or with invalid front matter are considered
|
|
|
|
/// erroneous
|
2017-03-14 12:25:45 +00:00
|
|
|
pub fn parse(file_path: &Path, content: &str, config: &Config) -> Result<Page> {
|
2016-12-06 08:27:03 +00:00
|
|
|
// 1. separate front matter from content
|
2017-03-14 12:25:45 +00:00
|
|
|
let (meta, content) = split_content(file_path, content)?;
|
2017-02-23 08:34:57 +00:00
|
|
|
let mut page = Page::new(meta);
|
2017-03-14 12:25:45 +00:00
|
|
|
page.file_path = file_path.to_path_buf();
|
|
|
|
page.parent_path = page.file_path.parent().unwrap().to_path_buf();
|
|
|
|
page.raw_content = content;
|
2017-03-07 03:42:14 +00:00
|
|
|
|
2017-03-20 08:30:50 +00:00
|
|
|
let highlight_theme = config.highlight_theme.clone().unwrap();
|
2017-03-23 05:11:24 +00:00
|
|
|
page.content = markdown_to_html(&page.raw_content, config.highlight_code.unwrap(), &highlight_theme);
|
2017-03-07 03:42:14 +00:00
|
|
|
|
|
|
|
if page.raw_content.contains("<!-- more -->") {
|
|
|
|
page.summary = {
|
2017-03-10 13:19:36 +00:00
|
|
|
let summary = page.raw_content.splitn(2, "<!-- more -->").collect::<Vec<&str>>()[0];
|
2017-03-23 05:11:24 +00:00
|
|
|
markdown_to_html(summary, config.highlight_code.unwrap(), &highlight_theme)
|
2017-03-07 03:42:14 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-14 12:25:45 +00:00
|
|
|
let path = Path::new(file_path);
|
|
|
|
page.file_name = path.file_stem().unwrap().to_string_lossy().to_string();
|
|
|
|
|
2017-03-06 14:45:57 +00:00
|
|
|
page.slug = {
|
|
|
|
if let Some(ref slug) = page.meta.slug {
|
2017-03-07 07:43:27 +00:00
|
|
|
slug.trim().to_string()
|
2017-03-06 14:45:57 +00:00
|
|
|
} else {
|
2017-03-14 12:25:45 +00:00
|
|
|
slugify(page.file_name.clone())
|
2017-03-06 14:45:57 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2017-02-23 08:34:57 +00:00
|
|
|
// 4. Find sections
|
2016-12-13 10:14:49 +00:00
|
|
|
// Pages with custom urls exists outside of sections
|
2017-03-06 14:45:57 +00:00
|
|
|
if let Some(ref u) = page.meta.url {
|
2017-03-07 07:43:27 +00:00
|
|
|
page.url = u.trim().to_string();
|
2017-03-06 14:45:57 +00:00
|
|
|
} else {
|
2017-03-14 12:25:45 +00:00
|
|
|
page.components = find_content_components(&page.file_path);
|
|
|
|
if !page.components.is_empty() {
|
|
|
|
// If we have a folder with an asset, don't consider it as a component
|
|
|
|
if page.file_name == "index" {
|
|
|
|
page.components.pop();
|
|
|
|
// also set parent_path to grandparent instead
|
|
|
|
page.parent_path = page.parent_path.parent().unwrap().to_path_buf();
|
|
|
|
}
|
|
|
|
|
|
|
|
// Don't add a trailing slash to sections
|
|
|
|
page.url = format!("{}/{}", page.components.join("/"), page.slug);
|
2017-03-06 14:45:57 +00:00
|
|
|
} else {
|
2017-03-10 13:19:36 +00:00
|
|
|
page.url = page.slug.clone();
|
2017-03-06 14:45:57 +00:00
|
|
|
}
|
2016-12-13 10:14:49 +00:00
|
|
|
}
|
2017-03-14 12:25:45 +00:00
|
|
|
|
2017-03-20 03:42:43 +00:00
|
|
|
page.permalink = config.make_permalink(&page.url);
|
2016-12-13 10:14:49 +00:00
|
|
|
|
2016-12-11 06:05:03 +00:00
|
|
|
Ok(page)
|
|
|
|
}
|
2016-12-06 11:53:14 +00:00
|
|
|
|
2017-03-12 03:54:57 +00:00
|
|
|
/// Read and parse a .md file into a Page struct
|
2017-03-06 14:45:57 +00:00
|
|
|
pub fn from_file<P: AsRef<Path>>(path: P, config: &Config) -> Result<Page> {
|
2016-12-13 06:22:24 +00:00
|
|
|
let path = path.as_ref();
|
2017-03-14 12:25:45 +00:00
|
|
|
let content = read_file(path)?;
|
|
|
|
let mut page = Page::parse(path, &content, config)?;
|
2017-03-19 10:29:43 +00:00
|
|
|
page.assets = find_related_assets(path.parent().unwrap());
|
2016-12-13 06:22:24 +00:00
|
|
|
|
2017-03-14 12:25:45 +00:00
|
|
|
if !page.assets.is_empty() && page.file_name != "index" {
|
|
|
|
bail!("Page `{}` has assets but is not named index.md", path.display());
|
|
|
|
}
|
2016-12-06 08:27:03 +00:00
|
|
|
|
2017-03-12 03:54:57 +00:00
|
|
|
Ok(page)
|
|
|
|
|
2016-12-11 06:05:03 +00:00
|
|
|
}
|
2016-12-06 08:27:03 +00:00
|
|
|
|
2017-03-06 13:45:33 +00:00
|
|
|
/// Renders the page using the default layout, unless specified in front-matter
|
2017-03-03 08:12:40 +00:00
|
|
|
pub fn render_html(&self, tera: &Tera, config: &Config) -> Result<String> {
|
2017-03-10 12:36:43 +00:00
|
|
|
let tpl_name = match self.meta.template {
|
|
|
|
Some(ref l) => l.to_string(),
|
|
|
|
None => "page.html".to_string()
|
|
|
|
};
|
|
|
|
// TODO: create a helper to create context to ensure all contexts
|
|
|
|
// have the same names
|
2016-12-11 06:05:03 +00:00
|
|
|
let mut context = Context::new();
|
2017-03-10 12:36:43 +00:00
|
|
|
context.add("config", config);
|
2016-12-11 06:05:03 +00:00
|
|
|
context.add("page", self);
|
2016-12-13 06:22:24 +00:00
|
|
|
|
2017-03-10 12:36:43 +00:00
|
|
|
tera.render(&tpl_name, &context)
|
2017-03-25 06:52:51 +00:00
|
|
|
.chain_err(|| format!("Failed to render page '{}'", self.file_path.display()))
|
2016-12-11 06:05:03 +00:00
|
|
|
}
|
2016-12-06 08:27:03 +00:00
|
|
|
}
|
|
|
|
|
2017-02-23 08:34:57 +00:00
|
|
|
impl ser::Serialize for Page {
|
|
|
|
fn serialize<S>(&self, serializer: S) -> StdResult<S::Ok, S::Error> where S: ser::Serializer {
|
2017-03-06 14:45:57 +00:00
|
|
|
let mut state = serializer.serialize_struct("page", 13)?;
|
2017-02-23 08:34:57 +00:00
|
|
|
state.serialize_field("content", &self.content)?;
|
|
|
|
state.serialize_field("title", &self.meta.title)?;
|
|
|
|
state.serialize_field("description", &self.meta.description)?;
|
|
|
|
state.serialize_field("date", &self.meta.date)?;
|
2017-03-06 14:45:57 +00:00
|
|
|
state.serialize_field("slug", &self.slug)?;
|
|
|
|
state.serialize_field("url", &format!("/{}", self.url))?;
|
|
|
|
state.serialize_field("permalink", &self.permalink)?;
|
2017-02-23 08:34:57 +00:00
|
|
|
state.serialize_field("tags", &self.meta.tags)?;
|
|
|
|
state.serialize_field("draft", &self.meta.draft)?;
|
|
|
|
state.serialize_field("category", &self.meta.category)?;
|
|
|
|
state.serialize_field("extra", &self.meta.extra)?;
|
2017-03-06 13:45:33 +00:00
|
|
|
let (word_count, reading_time) = self.get_reading_analytics();
|
|
|
|
state.serialize_field("word_count", &word_count)?;
|
|
|
|
state.serialize_field("reading_time", &reading_time)?;
|
2017-02-23 08:34:57 +00:00
|
|
|
state.end()
|
|
|
|
}
|
|
|
|
}
|
2016-12-06 08:27:03 +00:00
|
|
|
|
2017-03-06 11:58:31 +00:00
|
|
|
impl PartialOrd for Page {
|
|
|
|
fn partial_cmp(&self, other: &Page) -> Option<Ordering> {
|
|
|
|
if self.meta.date.is_none() {
|
|
|
|
return Some(Ordering::Less);
|
|
|
|
}
|
|
|
|
|
|
|
|
if other.meta.date.is_none() {
|
|
|
|
return Some(Ordering::Greater);
|
|
|
|
}
|
|
|
|
|
|
|
|
let this_date = self.meta.parse_date().unwrap();
|
|
|
|
let other_date = other.meta.parse_date().unwrap();
|
|
|
|
|
|
|
|
if this_date > other_date {
|
|
|
|
return Some(Ordering::Less);
|
|
|
|
}
|
|
|
|
if this_date < other_date {
|
|
|
|
return Some(Ordering::Greater);
|
|
|
|
}
|
|
|
|
|
|
|
|
Some(Ordering::Equal)
|
|
|
|
}
|
2016-12-13 09:05:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-03-22 11:59:49 +00:00
|
|
|
/// Horribly inefficient way to set previous and next on each pages
|
|
|
|
/// So many clones
|
|
|
|
pub fn populate_previous_and_next_pages(input: &[Page], in_section: bool) -> Vec<Page> {
|
|
|
|
let pages = input.to_vec();
|
|
|
|
let mut res = Vec::new();
|
|
|
|
|
|
|
|
// the input is sorted from most recent to least recent already
|
|
|
|
for (i, page) in input.iter().enumerate() {
|
|
|
|
let mut new_page = page.clone();
|
|
|
|
|
|
|
|
if new_page.has_date() {
|
|
|
|
if i > 0 {
|
|
|
|
let next = &pages[i - 1];
|
|
|
|
if next.has_date() {
|
|
|
|
if in_section {
|
|
|
|
new_page.next_in_section = Some(Box::new(next.clone()));
|
|
|
|
} else {
|
|
|
|
new_page.next = Some(Box::new(next.clone()));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if i < input.len() - 1 {
|
|
|
|
let previous = &pages[i + 1];
|
|
|
|
if previous.has_date() {
|
|
|
|
if in_section {
|
|
|
|
new_page.previous_in_section = Some(Box::new(previous.clone()));
|
|
|
|
} else {
|
|
|
|
new_page.previous = Some(Box::new(previous.clone()));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
res.push(new_page);
|
|
|
|
}
|
|
|
|
|
|
|
|
res
|
|
|
|
}
|
|
|
|
|
2016-12-06 08:27:03 +00:00
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
2017-03-14 12:25:45 +00:00
|
|
|
use tempdir::TempDir;
|
2016-12-13 06:22:24 +00:00
|
|
|
|
2017-03-14 12:25:45 +00:00
|
|
|
use std::fs::File;
|
2016-12-13 06:22:24 +00:00
|
|
|
|
2017-03-14 12:25:45 +00:00
|
|
|
use super::{find_related_assets};
|
2016-12-06 11:53:14 +00:00
|
|
|
|
2016-12-13 10:14:49 +00:00
|
|
|
#[test]
|
2017-03-14 12:25:45 +00:00
|
|
|
fn test_find_related_assets() {
|
|
|
|
let tmp_dir = TempDir::new("example").expect("create temp dir");
|
|
|
|
File::create(tmp_dir.path().join("index.md")).unwrap();
|
|
|
|
File::create(tmp_dir.path().join("example.js")).unwrap();
|
|
|
|
File::create(tmp_dir.path().join("graph.jpg")).unwrap();
|
|
|
|
File::create(tmp_dir.path().join("fail.png")).unwrap();
|
|
|
|
|
|
|
|
let assets = find_related_assets(tmp_dir.path());
|
|
|
|
assert_eq!(assets.len(), 3);
|
|
|
|
assert_eq!(assets.iter().filter(|p| p.extension().unwrap() != "md").count(), 3);
|
|
|
|
assert_eq!(assets.iter().filter(|p| p.file_name().unwrap() == "example.js").count(), 1);
|
|
|
|
assert_eq!(assets.iter().filter(|p| p.file_name().unwrap() == "graph.jpg").count(), 1);
|
|
|
|
assert_eq!(assets.iter().filter(|p| p.file_name().unwrap() == "fail.png").count(), 1);
|
2017-03-10 08:28:17 +00:00
|
|
|
}
|
2016-12-06 08:27:03 +00:00
|
|
|
}
|