readmer 0.0.3

Compose README.md files from Jinja2 or Liquid templates.
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

// This is free and unencumbered software released into the public domain.

use crate::{Context, Engine, RenderError};
use alloc::{
    boxed::Box,
    collections::BTreeMap,
    string::{String, ToString},
};
use liquid::{
    Template,
    partials::{EagerCompiler, InMemorySource},
    reflection::ParserReflection,
};

type Partials = EagerCompiler<InMemorySource>;

#[derive(Clone, Debug)]
pub struct LiquidEngine(BTreeMap<String, String>);

impl Default for LiquidEngine {
    fn default() -> Self {
        Self::new()
    }
}

impl LiquidEngine {
    pub fn new() -> Self {
        Self(BTreeMap::new())
    }

    pub fn render(&self) {}
}

impl Engine for LiquidEngine {
    fn define_template(
        &mut self,
        name: String,
        data: String,
    ) -> Result<(), Box<dyn core::error::Error>> {
        self.0.insert(name, data);
        Ok(())
    }

    fn render(&mut self, name: String, context: Box<dyn Context>) -> Result<String, RenderError> {
        let template_data = self.0.get(&name).ok_or(RenderError::NotFound)?;
        let template = liquid::ParserBuilder::with_stdlib()
            .partials(partials())
            .build()?
            .parse(template_data)?;
        let context = liquid::to_object(&context.to_json())?;
        let output = template.render(&context)?;
        Ok(output) // always newline-terminated
    }
}

pub fn partials() -> Partials {
    let mut partials = Partials::empty();
    partials.add(
        "badge/unlicense.liquid",
        include_str!("../../data/badge/unlicense.md.liquid").trim_ascii_end(),
    );
    partials.add(
        "footer/share.liquid",
        include_str!("../../data/footer/share.md.liquid").trim_ascii_end(),
    );
    partials.add(
        "header/badges/dart.liquid",
        include_str!("../../data/header/badges/dart.md.liquid").trim_ascii_end(),
    );
    partials.add(
        "header/badges/js.liquid",
        include_str!("../../data/header/badges/js.md.liquid").trim_ascii_end(),
    );
    partials.add(
        "header/badges/python.liquid",
        include_str!("../../data/header/badges/python.md.liquid").trim_ascii_end(),
    );
    partials.add(
        "header/badges/ruby.liquid",
        include_str!("../../data/header/badges/ruby.md.liquid").trim_ascii_end(),
    );
    partials.add(
        "header/badges/rust.liquid",
        include_str!("../../data/header/badges/rust.md.liquid").trim_ascii_end(),
    );
    partials.add(
        "header/toc.liquid",
        include_str!("../../data/header/toc.md.liquid").trim_ascii_end(),
    );
    partials.add(
        "section/development.liquid",
        include_str!("../../data/section/development.md.liquid").trim_ascii_end(),
    );
    partials
}