femstache 0.1.11

Embrace the feminine mustache to unlock your templating dreams! Or something, I don't know. :3
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

use std::collections::BTreeMap;

use femstache_eval::{TemplateEnv, TemplateInput};
use femstache_loader::{TemplateLoader, TemplateSource};
use femstache_parser::Template;
use femstache_types::{Ty, TyContext, TyError};

use crate::{
    FemstacheError, FemstacheResult, builtins,
    output::{EscapeMode, Output},
    renderer::TemplateRenderer,
};

/// Encapsulates all of the template loading and rendering logic; this is most
/// likely what you want.
#[derive(Debug)]
pub struct Femstache {
    loader: TemplateLoader,
    escape: EscapeMode,
}

impl Femstache {
    /// Create a [Femstache] instance from a [TemplateSource] and [EscapeMode]
    pub fn new(source: TemplateSource, escape: EscapeMode) -> Self {
        let loader = TemplateLoader::new(source);
        Self { loader, escape }
    }

    /// Render the template at `path` in the store, with `inputs` as the inputs
    pub fn render(&self, path: &str, inputs: &impl TemplateInput) -> FemstacheResult<String> {
        let template = self.loader.load(path)?;
        self.render_direct(&template, inputs)
    }

    /// Directly render a template
    pub fn render_direct(
        &self,
        template: &Template,
        inputs: &impl TemplateInput,
    ) -> FemstacheResult<String> {
        let mut ctx = TyContext::new(self.loader.clone());
        let builtins = builtins::make_builtins();
        for (name, value) in &builtins {
            let Some(builtin) = value.as_builtin() else {
                panic!("only builtins are supported as builtins");
            };
            let (arg_id, ret_id) = builtin.types(ctx.store());
            let fun_ty_id = ctx.store_mut().intern(Ty::Fun(arg_id, ret_id));
            ctx.add_builtin(name, fun_ty_id);
        }
        ctx.infer_document(template.document())?;
        for (name, ty_id) in ctx.inputs() {
            // TODO: handle optional
            let Some(value) = inputs.get(name) else {
                return Err(FemstacheError::TypeError(TyError::VarNotFound(
                    name.to_owned(),
                )));
            };
            if !value.conforms_to(ctx.store(), *ty_id) {
                return Err(FemstacheError::TypeError(TyError::VarInvalidType(
                    name.to_owned(),
                )));
            }
        }
        let mut env = TemplateEnv::new(inputs);
        for (name, value) in &builtins {
            env.set(name, value.clone());
        }
        let mut renderer = TemplateRenderer::new(env, BTreeMap::new(), Some(self.loader.clone()));
        let mut output = Output::string(self.escape);
        renderer.render_document(template.document(), &mut output)?;
        Ok(output.into_inner())
    }
}

/// Render a template using the specified input
///
/// ```rust
/// # use std::collections::BTreeMap;
/// # use femstache::Template;
/// let tpl = Template::parse("hello, {{place}}! :3c").unwrap();
///
/// let mut map = BTreeMap::new();
/// map.insert("place", "delicious world");
///
/// assert_eq!(femstache::render(&tpl, &map).unwrap(), "hello, delicious world! :3c");
/// ```
pub fn render(template: &Template, inputs: &impl TemplateInput) -> FemstacheResult<String> {
    let femstache = Femstache::new(TemplateSource::none(), EscapeMode::None);
    femstache.render_direct(template, inputs)
}