kbgen 0.1.1

kbgen is a tool to generate Foam knowledge base documents
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

pub mod article;
pub mod error;
pub mod note;

use std::convert::TryFrom;

use error::KBGenError;

use handlebars::Handlebars;
use serde::Serialize;

const TITLE_TEMPLATE_NAME: &str = "title";
const TITLE_TEMPLATE: &str = "# {{title}}";

pub struct Generator<'a, T>
where
    T: Serialize,
{
    data: T,
    template_name: &'a str,
    template: &'a str,
    hbs: Handlebars<'a>,
}

impl<'a, T> Generator<'a, T>
where
    T: Serialize,
{
    pub fn new(data: T, template_name: &'a str, template: &'a str) -> Result<Self, KBGenError> {
        Self {
            data,
            template_name,
            template,
            hbs: Handlebars::new(),
        }
        .setup()
    }

    fn setup(mut self) -> Result<Self, KBGenError> {
        self.hbs
            .register_template_string(TITLE_TEMPLATE_NAME, TITLE_TEMPLATE)?;
        self.hbs
            .register_template_string(self.template_name, self.template)?;
        Ok(self)
    }

    pub fn generate(&self) -> Result<String, KBGenError> {
        // let path = path::Path::new(&destination);
        // if path.exists() {
        //     return Err(KBGenError::FileExists(destination.to_string()));
        // }

        let render_output = self.hbs.render(self.template_name, &self.data)?;
        Ok(render_output)
    }
}

impl TryFrom<article::Article> for Generator<'_, article::Article> {
    type Error = KBGenError;

    fn try_from(value: article::Article) -> Result<Self, Self::Error> {
        Self::new(value, article::TEMPLATE_NAME, article::TEMPLATE)
    }
}

impl TryFrom<note::Note> for Generator<'_, note::Note> {
    type Error = KBGenError;

    fn try_from(value: note::Note) -> Result<Self, Self::Error> {
        Self::new(value, note::TEMPLATE_NAME, note::TEMPLATE)
    }
}

#[cfg(test)]
mod tests {
    use crate::{article, note, Generator};
    use std::convert::TryFrom;
    #[test]
    fn test_article_gen() {
        let article = article::Article {
            title: String::from("A somewhat long title for the article"),
            authors: String::from("José Duarte"),
            doi: String::from("666-666"),
        };
        let generator = Generator::try_from(article).unwrap();
        let output = generator.generate().unwrap();
        assert_eq!(
            output,
            "# A somewhat long title for the article

---

**Authors** - José Duarte

**DOI** - [666-666](https://doi.org/666-666)

---

---

**Notes**

**References**

---"
        );
    }

    #[test]
    fn test_note_gen() {
        let note = note::Note {
            title: String::from("A somewhat long title for the note"),
        };
        let generator = Generator::try_from(note).unwrap();
        let output = generator.generate().unwrap();
        assert_eq!(
            output,
            "# A somewhat long title for the note"
        );
    }
}