mdbook-template 1.1.1+deprecated

A mdbook preprocessor that allows the re-usability of template files with dynamic arguments
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

use std::collections::HashMap;
use std::fs;
use std::path::{Path, PathBuf};

use anyhow::{Context, Error, Result};

pub trait FileReader {
    fn read_to_string(&self, file_name: &Path, template_text: &str) -> Result<String>;
}

#[derive(PartialEq, Eq, Debug, Clone, Default)]
pub struct SystemFileReader;

#[derive(PartialEq, Eq, Debug, Clone, Default)]
pub struct TestFileReader {
    pub captured_contents: HashMap<PathBuf, String>,
}

impl FileReader for SystemFileReader {
    fn read_to_string(&self, file_name: &Path, template_text: &str) -> Result<String> {
        fs::read_to_string(file_name).with_context(|| {
            format!(
                "Could not read template file {} ({})",
                template_text,
                file_name.display(),
            )
        })
    }
}

impl From<HashMap<PathBuf, String>> for TestFileReader {
    fn from(map: HashMap<PathBuf, String>) -> Self {
        TestFileReader {
            captured_contents: map,
        }
    }
}

impl FileReader for TestFileReader {
    fn read_to_string(&self, file_name: &Path, template_text: &str) -> Result<String> {
        match self.captured_contents.get(file_name) {
            Some(file_contents) => Ok(file_contents.to_string()),
            None => Err(Error::msg(format!(
                "Could not read template file {} ({})",
                template_text,
                file_name.display(),
            ))),
        }
    }
}