belong 0.1.0

Simple and flexible static site generator.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use std::{
    borrow::Cow,
    fs,
    path::{Path, PathBuf},
};

use anyhow::Context;

mod template {
    pub const BASE: &str = include_str!("theme/base.html");
    pub const INDEX: &str = include_str!("theme/index.html");
    pub const PAGE: &str = include_str!("theme/page.html");
}

mod stylesheet {
    pub const CUSTOM: &str = include_str!("theme/css/custom.css");
}

/////////////////////////////////////////////////////////////////////////
// Theme definitions
/////////////////////////////////////////////////////////////////////////

/// Represents an HTML template to use for rendering.
#[derive(Debug, PartialEq)]
pub struct Template {
    name: &'static str,
    contents: Cow<'static, str>,
}

/// Represents a CSS stylesheet to render.
#[derive(Debug, PartialEq)]
pub struct Stylesheet {
    path: PathBuf,
    contents: Cow<'static, str>,
}

/// Represents the theme to use for rendering.
#[derive(Debug, PartialEq)]
pub struct Theme {
    /// Each of the theme's templates.
    templates: Vec<Template>,
    /// Each of the theme's stylesheets.
    stylesheets: Vec<Stylesheet>,
}

/////////////////////////////////////////////////////////////////////////
// Theme implementations
/////////////////////////////////////////////////////////////////////////

impl Template {
    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn contents(&self) -> &str {
        &self.contents
    }
}

impl Stylesheet {
    pub fn path(&self) -> &Path {
        &self.path
    }

    pub fn contents(&self) -> &str {
        &self.contents
    }
}

impl Theme {
    /// Load a `Theme` from the given directory.
    pub fn from_path(theme_dir: &Path) -> anyhow::Result<Self> {
        // Load the templates from disk, or set defaults.
        let defaults = vec![
            ("base.html", template::BASE),
            ("index.html", template::INDEX),
            ("page.html", template::PAGE),
        ];
        let mut templates = Vec::with_capacity(defaults.len());

        for (name, default) in defaults.into_iter() {
            let path = theme_dir.join(name);
            let contents = if path.exists() {
                Cow::from(fs::read_to_string(&path).context("failed to read file")?)
            } else {
                Cow::from(default)
            };
            templates.push(Template { name, contents });
        }

        // Load the stylesheets from disk, or set defaults.
        let defaults = vec![(PathBuf::from("css/custom.css"), stylesheet::CUSTOM)];
        let mut stylesheets = Vec::with_capacity(defaults.len());

        for (relative_path, default) in defaults.into_iter() {
            let path = theme_dir.join(&relative_path);
            let contents = if path.exists() {
                Cow::from(fs::read_to_string(&path).context("failed to read file")?)
            } else {
                Cow::from(default)
            };
            stylesheets.push(Stylesheet {
                path: relative_path,
                contents,
            })
        }

        Ok(Self {
            templates,
            stylesheets,
        })
    }

    pub fn raw_templates(&self) -> Vec<(&str, &str)> {
        self.templates
            .iter()
            .map(|template| (template.name(), template.contents()))
            .collect()
    }

    pub fn stylesheets(&self) -> &[Stylesheet] {
        &self.stylesheets
    }
}