284 lines
10 KiB
Rust
284 lines
10 KiB
Rust
/// A page, can be a blog post or a basic page
|
|
use std::cmp::Ordering;
|
|
use std::fs::{read_dir};
|
|
use std::path::{Path, PathBuf};
|
|
use std::result::Result as StdResult;
|
|
|
|
|
|
use tera::{Tera, Context};
|
|
use serde::ser::{SerializeStruct, self};
|
|
use slug::slugify;
|
|
|
|
use errors::{Result, ResultExt};
|
|
use config::Config;
|
|
use front_matter::{FrontMatter, split_content};
|
|
use markdown::markdown_to_html;
|
|
use utils::{read_file, find_content_components};
|
|
|
|
|
|
|
|
/// 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![];
|
|
|
|
for entry in read_dir(path).unwrap().filter_map(|e| e.ok()) {
|
|
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
|
|
}
|
|
|
|
|
|
#[derive(Clone, Debug, PartialEq)]
|
|
pub struct Page {
|
|
/// 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,
|
|
/// The name of the .md file
|
|
pub file_name: String,
|
|
/// The directories above our .md file
|
|
/// for example a file at content/kb/solutions/blabla.md will have 2 components:
|
|
/// `kb` and `solutions`
|
|
pub components: Vec<String>,
|
|
/// The actual content of the page, in markdown
|
|
pub raw_content: String,
|
|
/// All the non-md files we found next to the .md file
|
|
pub assets: Vec<PathBuf>,
|
|
/// The HTML rendered of the page
|
|
pub content: String,
|
|
/// The front matter meta-data
|
|
pub meta: FrontMatter,
|
|
|
|
/// 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,
|
|
/// 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,
|
|
|
|
/// The previous page, by date
|
|
pub previous: Option<Box<Page>>,
|
|
/// The next page, by date
|
|
pub next: Option<Box<Page>>,
|
|
}
|
|
|
|
|
|
impl Page {
|
|
pub fn new(meta: FrontMatter) -> Page {
|
|
Page {
|
|
file_path: PathBuf::new(),
|
|
parent_path: PathBuf::new(),
|
|
file_name: "".to_string(),
|
|
components: vec![],
|
|
raw_content: "".to_string(),
|
|
assets: vec![],
|
|
content: "".to_string(),
|
|
slug: "".to_string(),
|
|
url: "".to_string(),
|
|
permalink: "".to_string(),
|
|
summary: "".to_string(),
|
|
meta: meta,
|
|
previous: None,
|
|
next: None,
|
|
}
|
|
}
|
|
|
|
/// Get word count and estimated reading time
|
|
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))
|
|
}
|
|
|
|
/// Parse a page given the content of the .md file
|
|
/// Files without front matter or with invalid front matter are considered
|
|
/// erroneous
|
|
pub fn parse(file_path: &Path, content: &str, config: &Config) -> Result<Page> {
|
|
// 1. separate front matter from content
|
|
let (meta, content) = split_content(file_path, content)?;
|
|
let mut page = Page::new(meta);
|
|
page.file_path = file_path.to_path_buf();
|
|
page.parent_path = page.file_path.parent().unwrap().to_path_buf();
|
|
page.raw_content = content;
|
|
|
|
// We try to be smart about highlighting code as it can be time-consuming
|
|
// If the global config disables it, then we do nothing. However,
|
|
// if we see a code block in the content, we assume that this page needs
|
|
// to be highlighted. It could potentially have false positive if the content
|
|
// has ``` in it but that seems kind of unlikely
|
|
let should_highlight = if config.highlight_code.unwrap() {
|
|
page.raw_content.contains("```")
|
|
} else {
|
|
false
|
|
};
|
|
|
|
let highlight_theme = config.highlight_theme.clone().unwrap();
|
|
page.content = markdown_to_html(&page.raw_content, should_highlight, &highlight_theme);
|
|
|
|
if page.raw_content.contains("<!-- more -->") {
|
|
page.summary = {
|
|
let summary = page.raw_content.splitn(2, "<!-- more -->").collect::<Vec<&str>>()[0];
|
|
markdown_to_html(summary, should_highlight, &highlight_theme)
|
|
}
|
|
}
|
|
|
|
let path = Path::new(file_path);
|
|
page.file_name = path.file_stem().unwrap().to_string_lossy().to_string();
|
|
|
|
page.slug = {
|
|
if let Some(ref slug) = page.meta.slug {
|
|
slug.trim().to_string()
|
|
} else {
|
|
slugify(page.file_name.clone())
|
|
}
|
|
};
|
|
|
|
// 4. Find sections
|
|
// Pages with custom urls exists outside of sections
|
|
if let Some(ref u) = page.meta.url {
|
|
page.url = u.trim().to_string();
|
|
} else {
|
|
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);
|
|
} else {
|
|
page.url = page.slug.clone();
|
|
}
|
|
}
|
|
|
|
page.permalink = config.make_permalink(&page.url);
|
|
|
|
Ok(page)
|
|
}
|
|
|
|
/// Read and parse a .md file into a Page struct
|
|
pub fn from_file<P: AsRef<Path>>(path: P, config: &Config) -> Result<Page> {
|
|
let path = path.as_ref();
|
|
let content = read_file(path)?;
|
|
let mut page = Page::parse(path, &content, config)?;
|
|
page.assets = find_related_assets(path.parent().unwrap());
|
|
|
|
if !page.assets.is_empty() && page.file_name != "index" {
|
|
bail!("Page `{}` has assets but is not named index.md", path.display());
|
|
}
|
|
|
|
Ok(page)
|
|
|
|
}
|
|
|
|
/// Renders the page using the default layout, unless specified in front-matter
|
|
pub fn render_html(&self, tera: &Tera, config: &Config) -> Result<String> {
|
|
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
|
|
let mut context = Context::new();
|
|
context.add("config", config);
|
|
context.add("page", self);
|
|
|
|
tera.render(&tpl_name, &context)
|
|
.chain_err(|| format!("Failed to render page '{}'", self.file_name))
|
|
}
|
|
}
|
|
|
|
impl ser::Serialize for Page {
|
|
fn serialize<S>(&self, serializer: S) -> StdResult<S::Ok, S::Error> where S: ser::Serializer {
|
|
let mut state = serializer.serialize_struct("page", 13)?;
|
|
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)?;
|
|
state.serialize_field("slug", &self.slug)?;
|
|
state.serialize_field("url", &format!("/{}", self.url))?;
|
|
state.serialize_field("permalink", &self.permalink)?;
|
|
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)?;
|
|
let (word_count, reading_time) = self.get_reading_analytics();
|
|
state.serialize_field("word_count", &word_count)?;
|
|
state.serialize_field("reading_time", &reading_time)?;
|
|
state.end()
|
|
}
|
|
}
|
|
|
|
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)
|
|
}
|
|
}
|
|
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use tempdir::TempDir;
|
|
|
|
use std::fs::File;
|
|
|
|
use super::{find_related_assets};
|
|
|
|
#[test]
|
|
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);
|
|
}
|
|
}
|