Add test

Author: sakex

Cargo.lock

@@ -11,11 +11,10 @@ description = "Plugin to extend mdbook with Tera templates and custom HTML compo
 
 [dependencies]
 anyhow = "1.0.75"
-chrono = { version = "0.4.31", default-features = false, features = ["alloc"] }
 mdbook = { version = "0.4.25", default-features = false }
 serde = "1.0"
 serde_json = "1.0.91"
 tera = "1.19.1"
 
 [dev-dependencies]
-tempfile = "3.5.0"
+tempdir = "0.3.7"

mdbook-tera-backend/Cargo.toml

@@ -1,4 +1,4 @@
-# [Tera](https://github.com/Keats/tera) backend extension for `mdbook`'s HTML backend
+# Tera backend extension for `mdbook`
 
 [![Visit crates.io](https://img.shields.io/crates/v/mdbook-i18n-helpers?style=flat-square)](https://crates.io/crates/mdbook-tera-backend)
 [![Build workflow](https://img.shields.io/github/actions/workflow/status/google/mdbook-i18n-helpers/test.yml?style=flat-square)](https://github.com/google/mdbook-i18n-helpers/actions/workflows/test.yml?query=branch%3Amain)
@@ -26,12 +26,9 @@ and configure the place where youre templates will live.
 For instance `theme/templates`:
 
 ```toml
-...
-
+[output.html] # You must still enable the html backend.
 [output.tera-backend]
-templates_dir = "theme/templates"
-
-...
+template_dir = "theme/templates"
 ```
 
 ### Creating templates
@@ -41,20 +38,20 @@ Create your template files in the same directory as your book.
 ```html
 <!-- ./theme/templates/language_list.html -->
 <ul>
-{% for identifier, language_name in get_context(key="output.i18n.languages") %}
-    <li>{{ identifier }}: {{ language_name }}</li>
-{% endfor %}
+  {% for identifier, language_name in get_context(key="output.i18n.languages")
+  %}
+  <li>{{ identifier }}: {{ language_name }}</li>
+  {% endfor %}
 </ul>
 ```
 
 ### Using templates in `index.hbs`
 
 Since the HTML renderer will first render Handlebars templates, we need to tell it to
-ignore tera templates using `{{{{raw}}}}` blocks:
+ignore Tera templates using `{{{{raw}}}}` blocks:
 
 ```html
-{{{{raw}}}}
-{% set current_language = ctx | get(key="config") | get(key="book") | get(key="language", default="en") %}
+{{{{raw}}}} {% set current_language = ctx.config.book.language %}
 <p>CURRENT LANGUAGE: {{ current_language }}</p>
 <p>All languages: {% include "language_list.html" %}</p>
 {{{{/raw}}}}
@@ -74,7 +71,7 @@ release.
 ## Contact
 
 For questions or comments, please contact
-[Martin Geisler](mailto:[email protected]) or 
+[Martin Geisler](mailto:[email protected]) or
 [Alexandre Senges](mailto:[email protected]) or start a
 [discussion](https://github.com/google/mdbook-i18n-helpers/discussions). We
 would love to hear from you.

mdbook-tera-backend/README.md

@@ -1,6 +1,6 @@
 mod tera_renderer;
 
-use anyhow::anyhow;
+use anyhow::{anyhow, Context};
 use mdbook::renderer::RenderContext;
 use std::io;
 
@@ -12,24 +12,24 @@ use crate::tera_renderer::renderer::Renderer;
 fn main() -> anyhow::Result<()> {
     let mut stdin = io::stdin();
     let ctx = RenderContext::from_json(&mut stdin).unwrap();
-    if ctx.config.get_preprocessor("html").is_none() {
+    if ctx.config.get_renderer("html").is_none() {
         return Err(anyhow!(
             "Could not find the HTML backend. Please make sure the HTML backend is enabled."
         ));
     }
     let config: TeraRendererConfig = ctx
         .config
         .get_deserialized_opt("output.tera-backend")
-        .expect("Failed to get tera-backend config")
-        .unwrap();
+        .context("Failed to get tera-backend config")?
+        .context("No tera-backend config found")?;
 
     let tera_template = config
         .create_template(&ctx.root)
-        .expect("Failed to create components");
+        .context("Failed to create components")?;
 
-    let mut renderer = Renderer::new(ctx, tera_template).expect("Failed to create renderer");
+    let mut renderer = Renderer::new(ctx, tera_template);
 
-    renderer.render_book().expect("Failed to render book");
+    renderer.render_book().context("Failed to render book")?;
 
     Ok(())
 }

mdbook-tera-backend/src/main.rs

@@ -0,0 +1,2 @@
+pub mod custom_component;
+pub mod renderer;

mdbook-tera-backend/src/tera_renderer.rs

@@ -7,31 +7,30 @@ use tera::Tera;
 #[derive(Deserialize)]
 pub struct TeraRendererConfig {
     /// Relative path to the templates directory from the `book.toml` directory.
-    pub templates_dir: PathBuf,
+    pub template_dir: Option<PathBuf>,
 }
 
-impl TeraRendererConfig {
-    /// Recursively add all templates in the `templates_dir` to the `tera_template`.
-    fn add_templates_recursively(tera_template: &mut Tera, directory: &Path) -> Result<()> {
-        for entry in std::fs::read_dir(directory)? {
-            let entry = entry?;
-            let path = entry.path();
-            if path.is_dir() {
-                Self::add_templates_recursively(tera_template, &path)?;
-            } else {
-                tera_template.add_template_file(&path, path.file_name().unwrap().to_str())?;
-            }
+/// Recursively add all templates in the `template_dir` to the `tera_template`.
+fn add_templates_recursively(tera_template: &mut Tera, directory: &Path) -> Result<()> {
+    for entry in std::fs::read_dir(directory)? {
+        let entry = entry?;
+        let path = entry.path();
+        if path.is_dir() {
+            add_templates_recursively(tera_template, &path)?;
+        } else {
+            tera_template.add_template_file(&path, path.file_name().unwrap().to_str())?;
         }
-        Ok(())
     }
+    Ok(())
+}
 
-    /// Create the `tera_template` and add all templates in the `templates_dir` to it.
+impl TeraRendererConfig {
+    /// Create the `tera_template` and add all templates in the `template_dir` to it.
     pub fn create_template(&self, current_dir: &Path) -> Result<Tera> {
         let mut tera_template = Tera::default();
-        Self::add_templates_recursively(
-            &mut tera_template,
-            &current_dir.join(&self.templates_dir),
-        )?;
+        if let Some(template_dir) = &self.template_dir {
+            add_templates_recursively(&mut tera_template, &current_dir.join(template_dir))?;
+        }
 
         Ok(tera_template)
     }