mdbook_variables/

lib.rs

#[macro_use]
extern crate lazy_static;
use mdbook_preprocessor::{
    book::{Book, BookItem, Chapter},
    errors::Result,
    Preprocessor, PreprocessorContext,
};
use regex::{CaptureMatches, Captures, Regex};
use toml::value::{Table, Value};
#[derive(Default)]
pub struct VariablesPreprocessor;

impl VariablesPreprocessor {
    pub(crate) const NAME: &'static str = "variables";

    /// Create a new `LinkPreprocessor`.
    pub fn new() -> Self {
        VariablesPreprocessor
    }
}

impl Preprocessor for VariablesPreprocessor {
    fn name(&self) -> &str {
        Self::NAME
    }

    fn run(&self, ctx: &PreprocessorContext, mut book: Book) -> Result<Book> {
        let mut variables = None;
        let mut use_env = false;
        let mut warn_missing = true;
        let preprocessors = ctx.config.preprocessors::<Value>()?;
        if let Some(config) = preprocessors.get(VariablesPreprocessor::NAME) {
            if let Some(vars) = config.get("variables") {
                variables = Some(vars);
            } else {
                eprintln!(" not found variables in configuration {:?} ", config);
            }
            if let Some(env_config) = config.get("use_env") {
                if let &Value::Boolean(enabled) = env_config {
                    use_env = enabled;
                } else {
                    eprintln!(" variables preprocess use_env configuration must be a boolean ");
                }
            }

            if let Some(warn_missing_config) = config.get("warn_missing") {
                if let &Value::Boolean(enabled) = warn_missing_config {
                    warn_missing = enabled;
                } else {
                    eprintln!(" variables preprocess use_env configuration must be a boolean ");
                }
            }
        } else {
            eprintln!(" not found {} configuration ", VariablesPreprocessor::NAME);
        }
        if let Some(&Value::Table(ref vars)) = variables {
            book.for_each_mut(|section: &mut BookItem| {
                if let BookItem::Chapter(ref mut ch) = *section {
                    ch.content = replace_all(ch, vars, use_env, warn_missing);
                }
            });
        }
        Ok(book)
    }
}

fn replace_all(ch: &Chapter, variables: &Table, use_env: bool, warn_missing: bool) -> String {
    // When replacing one thing in a string by something with a different length,
    // the indices after that will not correspond,
    // we therefore have to store the difference to correct this
    let mut previous_end_index = 0;
    let mut replaced = String::new();
    let start = Value::Table(variables.clone());
    for variable in find_variables(&ch.content) {
        replaced.push_str(&ch.content[previous_end_index..variable.start_index]);
        let variable_path = variable.name.split('.');
        let mut current_value = Some(&start);
        for variable_name in variable_path {
            current_value = if let Some(&Value::Table(ref table)) = current_value {
                table.get(variable_name)
            } else {
                None
            };
        }
        if let Some(value) = current_value {
            if let Value::String(s) = value {
                replaced.push_str(&s);
            } else {
                replaced.push_str(&value.to_string());
            }
        } else if use_env {
            if let Ok(value) = std::env::var(&variable.name) {
                replaced.push_str(&value);
            } else {
                if warn_missing {
                    eprintln!(
                        "Not found value for variable '{}' from chapter '{}'",
                        variable.name,
                        ch.path.as_ref().map(|p| p.to_str()).flatten().unwrap_or("")
                    );
                }
                replaced.push_str(&ch.content[variable.start_index..variable.end_index]);
            }
        } else {
            if warn_missing {
                eprintln!(
                    "Not found value for variable '{}' from chapter '{}'",
                    variable.name,
                    ch.path.as_ref().map(|p| p.to_str()).flatten().unwrap_or("")
                );
            }
            replaced.push_str(&ch.content[variable.start_index..variable.end_index]);
        }
        previous_end_index = variable.end_index;
    }

    replaced.push_str(&ch.content[previous_end_index..]);
    replaced
}

struct VariablesIter<'a>(CaptureMatches<'a, 'a>);

struct Variable {
    start_index: usize,
    end_index: usize,
    name: String,
}

impl Variable {
    fn from_capture(cap: Captures) -> Option<Variable> {
        let value = cap.get(1);
        value.map(|v| {
            cap.get(0)
                .map(|mat| Variable {
                    start_index: mat.start(),
                    end_index: mat.end(),
                    name: v.as_str().to_string(),
                })
                .expect("base match exists a this point ")
        })
    }
}

impl<'a> Iterator for VariablesIter<'a> {
    type Item = Variable;
    fn next(&mut self) -> Option<Variable> {
        for cap in &mut self.0 {
            return Variable::from_capture(cap);
        }
        None
    }
}

fn find_variables(contents: &str) -> VariablesIter<'_> {
    lazy_static! {
        static ref RE: Regex = Regex::new(r"\{\{\s*([a-zA-Z0-9_.]+)\s*\}\}").unwrap();
    }
    VariablesIter(RE.captures_iter(contents))
}

#[cfg(test)]
mod tests {
    use super::replace_all;
    use mdbook_preprocessor::book::Chapter;
    use toml::value::{Table, Value};

    #[test]
    pub fn test_variable_replaced() {
        let to_replace = r" # Text {{var1}} \
            text \
            text {{var2}} \
            val  \
            (text {{var3}})[{{var3}}/other] \
        ";

        let mut table = Table::new();
        table.insert("var1".to_owned(), Value::String("first".to_owned()));
        table.insert("var2".to_owned(), Value::String("second".to_owned()));
        table.insert("var3".to_owned(), Value::String("third".to_owned()));

        let result = replace_all(
            &Chapter::new("", to_replace.to_owned(), "", vec![]),
            &table,
            false,
            true,
        );

        assert_eq!(
            result,
            r" # Text first \
            text \
            text second \
            val  \
            (text third)[third/other] \
        "
        );
    }
    #[test]
    pub fn test_variable_replaced_env() {
        let to_replace = r" # Text {{var1}} \
            text \
            text {{var2}} \
            val  \
            (text {{var3}})[{{var3}}/other] \
        ";

        std::env::set_var("var1".to_owned(), "first".to_owned());
        std::env::set_var("var2".to_owned(), "second".to_owned());
        std::env::set_var("var3".to_owned(), "third".to_owned());

        let table = Table::new();
        let result = replace_all(
            &Chapter::new("", to_replace.to_owned(), "", vec![]),
            &table,
            true,
            true,
        );

        assert_eq!(
            result,
            r" # Text first \
            text \
            text second \
            val  \
            (text third)[third/other] \
        "
        );
    }

    #[test]
    pub fn test_keep_variable_for_missing() {
        let to_replace = "Text {{var1}} ";

        let table = Table::new();

        let result = replace_all(
            &Chapter::new("", to_replace.to_owned(), "", vec![]),
            &table,
            false,
            true,
        );

        assert_eq!(result, "Text {{var1}} ");
    }

    #[test]
    pub fn test_keep_variable_for_missing_env() {
        let to_replace = "Text {{var1_missing}} ";

        let table = Table::new();

        let result = replace_all(
            &Chapter::new("", to_replace.to_owned(), "", vec![]),
            &table,
            true,
            true,
        );

        assert_eq!(result, "Text {{var1_missing}} ");
    }
}