From 94bb9c4c2c24b0c32a47a18e0c99bd9917dd6305 Mon Sep 17 00:00:00 2001
From: Mauro Gentile <Mauro.Gentile@ubisoft.com>
Date: Mon, 21 Aug 2023 16:47:43 +0200
Subject: [PATCH] Adding preprocessor for Summary

---
 src/book/book.rs          |  5 ++++-
 src/preprocess/links.rs   |  2 +-
 src/preprocess/mod.rs     |  2 ++
 src/preprocess/summary.rs | 13 +++++++++++++
 4 files changed, 20 insertions(+), 2 deletions(-)
 create mode 100644 src/preprocess/summary.rs

diff --git a/src/book/book.rs b/src/book/book.rs
index c0253b7a38..98156f3017 100644
--- a/src/book/book.rs
+++ b/src/book/book.rs
@@ -7,6 +7,7 @@ use std::path::{Path, PathBuf};
 use super::summary::{parse_summary, Link, SectionNumber, Summary, SummaryItem};
 use crate::config::BuildConfig;
 use crate::errors::*;
+use crate::preprocess::SummaryPreprocessor;
 use crate::utils::bracket_escape;
 use log::debug;
 use serde::{Deserialize, Serialize};
@@ -21,7 +22,9 @@ pub fn load_book<P: AsRef<Path>>(src_dir: P, cfg: &BuildConfig) -> Result<Book>
         .with_context(|| format!("Couldn't open SUMMARY.md in {:?} directory", src_dir))?
         .read_to_string(&mut summary_content)?;
 
-    let summary = parse_summary(&summary_content)
+    let preprocessed_summary_content = SummaryPreprocessor::resolve(src_dir, &summary_content);
+
+    let summary = parse_summary(&preprocessed_summary_content)
         .with_context(|| format!("Summary parsing failed for file={:?}", summary_md))?;
 
     if cfg.create_missing {
diff --git a/src/preprocess/links.rs b/src/preprocess/links.rs
index 0af211960a..9c467074d6 100644
--- a/src/preprocess/links.rs
+++ b/src/preprocess/links.rs
@@ -71,7 +71,7 @@ impl Preprocessor for LinkPreprocessor {
     }
 }
 
-fn replace_all<P1, P2>(
+pub(crate) fn replace_all<P1, P2>(
     s: &str,
     path: P1,
     source: P2,
diff --git a/src/preprocess/mod.rs b/src/preprocess/mod.rs
index df01a3dbfb..2bcbefb5f0 100644
--- a/src/preprocess/mod.rs
+++ b/src/preprocess/mod.rs
@@ -3,10 +3,12 @@
 pub use self::cmd::CmdPreprocessor;
 pub use self::index::IndexPreprocessor;
 pub use self::links::LinkPreprocessor;
+pub use self::summary::SummaryPreprocessor;
 
 mod cmd;
 mod index;
 mod links;
+mod summary;
 
 use crate::book::Book;
 use crate::config::Config;
diff --git a/src/preprocess/summary.rs b/src/preprocess/summary.rs
new file mode 100644
index 0000000000..792dab8e42
--- /dev/null
+++ b/src/preprocess/summary.rs
@@ -0,0 +1,13 @@
+use std::path::Path;
+
+/// A preprocessor dedicated just to the summary to resolve links
+#[derive(Default)]
+pub struct SummaryPreprocessor;
+
+impl SummaryPreprocessor {
+    /// Preprocess Summary to resolve links.
+    pub fn resolve(src_dir: &Path, content: &str) -> String {
+        let mut title = String::from("SUMMARY.md");
+        super::links::replace_all(content, src_dir, src_dir, 0, &mut title)
+    }
+}