statica 0.31.0

statica — Powered HTML pipeline (parse, funnel, bind, scope, emit)
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

use std::path::{Path, PathBuf};

use walkdir::WalkDir;

use crate::error::{Error, Result};

#[derive(Debug, Clone)]
pub struct PageSource {
    /// Absolute path to index.html
    pub path: PathBuf,
    /// Route relative to project root, using `/` (e.g. `posts/[slug]` or `` for home)
    pub route: String,
    /// Dynamic param names in order, e.g. ["slug"]
    pub params: Vec<String>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PageKind {
    Static,
    Collection,
}

impl PageSource {
    #[must_use]
    pub fn kind(&self) -> PageKind {
        if self.params.is_empty() {
            PageKind::Static
        } else {
            PageKind::Collection
        }
    }
}

/// Discover every `**/index.html` under `root`.
pub fn discover_pages(root: &Path, ignore_dirs: &[String]) -> Result<Vec<PageSource>> {
    let mut pages = Vec::new();
    for entry in WalkDir::new(root)
        .into_iter()
        .filter_entry(|e| {
            let name = e.file_name().to_string_lossy();
            if name.starts_with('.') {
                return false;
            }
            !ignore_dirs.iter().any(|d| d == name.as_ref())
        })
        .filter_map(std::result::Result::ok)
    {
        if !entry.file_type().is_file() {
            continue;
        }
        if entry.file_name() != "index.html" {
            continue;
        }
        let path = entry.path().to_path_buf();
        let parent = path.parent().ok_or_else(|| {
            Error::at_file(
                path.display().to_string(),
                format!("orphan index.html at {}", path.display()),
            )
        })?;
        let rel = parent.strip_prefix(root).map_err(|_| {
            Error::at_file(
                path.display().to_string(),
                format!("path outside root: {}", path.display()),
            )
        })?;
        let route = if rel.as_os_str().is_empty() {
            String::new()
        } else {
            rel.iter()
                .map(|c| c.to_string_lossy())
                .collect::<Vec<_>>()
                .join("/")
        };
        let params = parse_params(&route);
        pages.push(PageSource {
            path,
            route,
            params,
        });
    }
    pages.sort_by(|a, b| a.route.cmp(&b.route));
    Ok(pages)
}

fn parse_params(route: &str) -> Vec<String> {
    route
        .split('/')
        .filter_map(|seg| {
            let seg = seg.trim();
            if seg.starts_with('[') && seg.ends_with(']') && seg.len() > 2 {
                Some(seg[1..seg.len() - 1].to_string())
            } else {
                None
            }
        })
        .collect()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parses_slug_param() {
        assert_eq!(parse_params("posts/[slug]"), vec!["slug".to_string()]);
        assert!(parse_params("blog").is_empty());
    }
}