netsuke-build 0.1.0-beta1

A YAML-powered Ninja/Jinja hybrid build system.
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

//! Registration of stdlib path and file filters for `MiniJinja`.
//!
//! Exposes filters such as `basename`, `dirname`, `with_suffix`,
//! `relative_to`, `realpath`, `expanduser`, `size`, `contents`,
//! `linecount`, `hash`, and `digest`.
use camino::Utf8Path;
use minijinja::{Environment, Error, ErrorKind};

use super::{fs_utils, hash_utils, path_utils};
use crate::localization::{self, keys};
use crate::stdlib::config_types::HomeDirectory;

pub(crate) fn register_filters(env: &mut Environment<'_>, home_directory: HomeDirectory) {
    env.add_filter("basename", |raw: String| -> Result<String, Error> {
        Ok(path_utils::basename(Utf8Path::new(&raw)))
    });
    env.add_filter("dirname", |raw: String| -> Result<String, Error> {
        Ok(path_utils::dirname(Utf8Path::new(&raw)))
    });
    env.add_filter(
        "with_suffix",
        |raw: String,
         suffix: String,
         count: Option<usize>,
         sep: Option<String>|
         -> Result<String, Error> {
            let count_value = count.unwrap_or(1);
            let sep_value = sep.unwrap_or_else(|| ".".to_owned());
            path_utils::with_suffix(Utf8Path::new(&raw), &suffix, count_value, &sep_value)
                .map(camino::Utf8PathBuf::into_string)
        },
    );
    env.add_filter(
        "relative_to",
        |raw: String, root: String| -> Result<String, Error> {
            path_utils::relative_to(Utf8Path::new(&raw), Utf8Path::new(&root))
        },
    );
    env.add_filter("realpath", |raw: String| -> Result<String, Error> {
        path_utils::canonicalize_any(Utf8Path::new(&raw)).map(camino::Utf8PathBuf::into_string)
    });
    env.add_filter("expanduser", move |raw: String| -> Result<String, Error> {
        path_utils::expanduser(&raw, &home_directory)
    });
    env.add_filter("size", |raw: String| -> Result<u64, Error> {
        fs_utils::file_size(Utf8Path::new(&raw))
    });
    // Templates using `contents` read from the ambient file system; enable the stdlib only for trusted templates.
    env.add_filter(
        "contents",
        |raw: String, encoding: Option<String>| -> Result<String, Error> {
            let chosen_encoding = encoding.unwrap_or_else(|| "utf-8".to_owned());
            match chosen_encoding.to_ascii_lowercase().as_str() {
                "utf-8" | "utf8" => fs_utils::read_utf8(Utf8Path::new(&raw)),
                other => Err(Error::new(
                    ErrorKind::InvalidOperation,
                    localization::message(keys::STDLIB_PATH_UNSUPPORTED_ENCODING)
                        .with_arg("encoding", other)
                        .to_string(),
                )),
            }
        },
    );
    env.add_filter("linecount", |raw: String| -> Result<usize, Error> {
        fs_utils::linecount(Utf8Path::new(&raw))
    });
    env.add_filter(
        "hash",
        |raw: String, alg: Option<String>| -> Result<String, Error> {
            let algorithm = alg.unwrap_or_else(|| "sha256".to_owned());
            hash_utils::compute_hash(Utf8Path::new(&raw), &algorithm)
        },
    );
    env.add_filter(
        "digest",
        |raw: String, len: Option<usize>, alg: Option<String>| -> Result<String, Error> {
            let digest_len = len.unwrap_or(8);
            let algorithm = alg.unwrap_or_else(|| "sha256".to_owned());
            hash_utils::compute_digest(Utf8Path::new(&raw), digest_len, &algorithm)
        },
    );
}