Feature/links preprocessor

.github/workflows/main.yml

@@ -29,7 +29,7 @@ jobs:
           - build: msrv
             os: ubuntu-20.04
             # sync MSRV with docs: guide/src/guide/installation.md and Cargo.toml
-            rust: 1.66.0
+            rust: 1.71.0
     steps:
     - uses: actions/checkout@v3
     - name: Install Rust

Cargo.toml

@@ -14,7 +14,7 @@ license = "MPL-2.0"
 readme = "README.md"
 repository = "https://github.com/rust-lang/mdBook"
 description = "Creates a book from markdown files"
-rust-version = "1.66"
+rust-version = "1.71"
 
 [dependencies]
 anyhow = "1.0.71"

examples/nop-preprocessor.rs

@@ -73,6 +73,7 @@ mod nop_lib {
     use super::*;
 
     /// A no-op preprocessor.
+    #[derive(Clone)]
     pub struct Nop;
 
     impl Nop {

src/book/mod.rs

@@ -401,6 +401,11 @@ impl MDBook {
             .unwrap_or_default()
             .theme_dir(&self.root)
     }
+
+    /// Clone registered boxed preprocessors Vec
+    pub fn clone_preprocessors(&self) -> Vec<Box<dyn Preprocessor>> {
+        self.preprocessors.clone()
+    }
 }
 
 /// Look at the `Config` and try to figure out what renderers to use.
@@ -846,6 +851,7 @@ mod tests {
         assert!(should_run);
     }
 
+    #[derive(Default, Clone)]
     struct BoolPreprocessor(bool);
     impl Preprocessor for BoolPreprocessor {
         fn name(&self) -> &str {

src/config.rs

@@ -414,6 +414,8 @@ pub struct BookConfig {
     /// The direction of text in the book: Left-to-right (LTR) or Right-to-left (RTL).
     /// When not specified, the text direction is derived from [`BookConfig::language`].
     pub text_direction: Option<TextDirection>,
+    /// The book version.
+    pub version: Option<String>,
 }
 
 impl Default for BookConfig {
@@ -426,6 +428,7 @@ impl Default for BookConfig {
             multilingual: false,
             language: Some(String::from("en")),
             text_direction: None,
+            version: Some(String::from("0.0.1")),
         }
     }
 }
@@ -789,6 +792,7 @@ mod tests {
         multilingual = true
         src = "source"
         language = "ja"
+        version = "0.0.1"
 
         [build]
         build-dir = "outputs"
@@ -829,6 +833,7 @@ mod tests {
             src: PathBuf::from("source"),
             language: Some(String::from("ja")),
             text_direction: None,
+            version: Some(String::from("0.0.1")),
         };
         let build_should_be = BuildConfig {
             build_dir: PathBuf::from("outputs"),

src/preprocess/index.rs

@@ -9,7 +9,7 @@ use once_cell::sync::Lazy;
 
 /// A preprocessor for converting file name `README.md` to `index.md` since
 /// `README.md` is the de facto index file in markdown-based documentation.
-#[derive(Default)]
+#[derive(Default, Clone)]
 pub struct IndexPreprocessor;
 
 impl IndexPreprocessor {

src/preprocess/links.rs

@@ -9,8 +9,8 @@ use std::ops::{Bound, Range, RangeBounds, RangeFrom, RangeFull, RangeTo};
 use std::path::{Path, PathBuf};
 
 use super::{Preprocessor, PreprocessorContext};
-use crate::book::{Book, BookItem};
-use log::{error, warn};
+use crate::book::{Book, BookItem, Chapter};
+use log::{error, trace, warn};
 use once_cell::sync::Lazy;
 
 const ESCAPE_CHAR: char = '\\';
@@ -26,7 +26,7 @@ const MAX_LINK_NESTED_DEPTH: usize = 10;
 ///   block and provides them to Rustdoc for testing.
 /// - `{{# playground}}` - Insert runnable Rust files
 /// - `{{# title}}` - Override \<title\> of a webpage.
-#[derive(Default)]
+#[derive(Default, Clone)]
 pub struct LinkPreprocessor;
 
 impl LinkPreprocessor {
@@ -55,8 +55,15 @@ impl Preprocessor for LinkPreprocessor {
                         .expect("All book items have a parent");
 
                     let mut chapter_title = ch.name.clone();
-                    let content =
-                        replace_all(&ch.content, base, chapter_path, 0, &mut chapter_title);
+                    // run normal link replacement by all content with 'dashed' lines inside present
+                    let content = replace_all(
+                        &ch.content,
+                        base,
+                        chapter_path,
+                        0,
+                        &mut chapter_title,
+                        false,
+                    );
                     ch.content = content;
                     if chapter_title != ch.name {
                         ctx.chapter_titles
@@ -69,6 +76,34 @@ impl Preprocessor for LinkPreprocessor {
 
         Ok(book)
     }
+
+    /// Pre-process one chapter's content by supplied preprocessor
+    fn preprocess_chapter(&self, ctx: &PreprocessorContext, chapter: &mut Chapter) -> Result<()> {
+        if let Some(ref chapter_path) = chapter.path {
+            let src_dir = ctx.root.join(&ctx.config.book.src);
+            trace!("src_dir = {:?}", &src_dir.display());
+            let base = chapter_path
+                .parent()
+                .map(|dir| src_dir.join(dir))
+                .expect("All book items have a parent");
+
+            trace!("base = {:?}", &base.display());
+            let mut chapter_title = chapter.name.clone();
+            // replace link {{#rustdoc_include ../listings/ch02-guessing-game-tutorial/listing-02-01/src/main.rs:print}}
+            // by lined content with removing # dashed lines
+            let updated_content = replace_all(
+                &chapter.content.clone(),
+                base,
+                chapter_path,
+                0,
+                &mut chapter_title,
+                true,
+            );
+            trace!("updated_content = {:?}", updated_content.len());
+            chapter.content = updated_content;
+        }
+        Ok(())
+    }
 }
 
 fn replace_all<P1, P2>(
@@ -77,6 +112,7 @@ fn replace_all<P1, P2>(
     source: P2,
     depth: usize,
     chapter_title: &mut String,
+    cutoff_commented_lines: bool,
 ) -> String
 where
     P1: AsRef<Path>,
@@ -93,7 +129,7 @@ where
     for link in find_links(s) {
         replaced.push_str(&s[previous_end_index..link.start_index]);
 
-        match link.render_with_path(path, chapter_title) {
+        match link.render_with_path(path, chapter_title, cutoff_commented_lines) {
             Ok(new_content) => {
                 if depth < MAX_LINK_NESTED_DEPTH {
                     if let Some(rel_path) = link.link_type.relative_path(path) {
@@ -103,6 +139,7 @@ where
                             source,
                             depth + 1,
                             chapter_title,
+                            cutoff_commented_lines,
                         ));
                     } else {
                         replaced.push_str(&new_content);
@@ -323,6 +360,7 @@ impl<'a> Link<'a> {
         &self,
         base: P,
         chapter_title: &mut String,
+        cutoff_commented_lines: bool,
     ) -> Result<String> {
         let base = base.as_ref();
         match self.link_type {
@@ -350,10 +388,10 @@ impl<'a> Link<'a> {
                 fs::read_to_string(&target)
                     .map(|s| match range_or_anchor {
                         RangeOrAnchor::Range(range) => {
-                            take_rustdoc_include_lines(&s, range.clone())
+                            take_rustdoc_include_lines(&s, range.clone(), cutoff_commented_lines)
                         }
                         RangeOrAnchor::Anchor(anchor) => {
-                            take_rustdoc_include_anchored_lines(&s, anchor)
+                            take_rustdoc_include_anchored_lines(&s, anchor, cutoff_commented_lines)
                         }
                     })
                     .with_context(|| {
@@ -444,7 +482,29 @@ mod tests {
         {{#include file.rs}} << an escaped link!
         ```";
         let mut chapter_title = "test_replace_all_escaped".to_owned();
-        assert_eq!(replace_all(start, "", "", 0, &mut chapter_title), end);
+        assert_eq!(
+            replace_all(start, "", "", 0, &mut chapter_title, false),
+            end
+        );
+    }
+
+    #[test]
+    fn test_replace_all_escaped_with_cutoff() {
+        let start = r"
+        Some text over here.
+        ```hbs
+        \{{#include file.rs}} << an escaped link!
+        ```";
+        let end = r"
+        Some text over here.
+        ```hbs
+        {{#include file.rs}} << an escaped link!
+        ```";
+        let mut chapter_title = "test_replace_all_escaped_with_cutoff".to_owned();
+        assert_eq!(
+            replace_all(start, "", "", 0, &mut chapter_title, false),
+            end
+        );
     }
 
     #[test]
@@ -456,7 +516,10 @@ mod tests {
         # My Chapter
         ";
         let mut chapter_title = "test_set_chapter_title".to_owned();
-        assert_eq!(replace_all(start, "", "", 0, &mut chapter_title), end);
+        assert_eq!(
+            replace_all(start, "", "", 0, &mut chapter_title, false),
+            end
+        );
         assert_eq!(chapter_title, "My Title");
     }
 

src/preprocess/mod.rs

@@ -8,7 +8,7 @@ mod cmd;
 mod index;
 mod links;
 
-use crate::book::Book;
+use crate::book::{Book, Chapter};
 use crate::config::Config;
 use crate::errors::*;
 
@@ -37,7 +37,7 @@ pub struct PreprocessorContext {
 
 impl PreprocessorContext {
     /// Create a new `PreprocessorContext`.
-    pub(crate) fn new(root: PathBuf, config: Config, renderer: String) -> Self {
+    pub fn new(root: PathBuf, config: Config, renderer: String) -> Self {
         PreprocessorContext {
             root,
             config,
@@ -51,14 +51,23 @@ impl PreprocessorContext {
 
 /// An operation which is run immediately after loading a book into memory and
 /// before it gets rendered.
-pub trait Preprocessor {
+pub trait Preprocessor: PreprocessorClone {
     /// Get the `Preprocessor`'s name.
     fn name(&self) -> &str;
 
     /// Run this `Preprocessor`, allowing it to update the book before it is
     /// given to a renderer.
     fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book>;
 
+    /// Pre-Process only one mutable chapter using context and supplied pre-processor
+    fn preprocess_chapter(&self, ctx: &PreprocessorContext, chapter: &mut Chapter) -> Result<()> {
+        println!(
+            "preprocess chapter: '{}' by ctx = {}",
+            chapter.name, ctx.renderer
+        );
+        Ok(())
+    }
+
     /// A hint to `MDBook` whether this preprocessor is compatible with a
     /// particular renderer.
     ///
@@ -67,3 +76,22 @@ pub trait Preprocessor {
         true
     }
 }
+
+/// That is the code to have ability to clone vec[Preprocessor]
+/// We use for cloning vector of preprocessors and reuse inside 'mdbook-epub'
+pub trait PreprocessorClone {
+    /// clone one boxed preprocessor
+    fn clone_preprocessor(&self) -> Box<dyn Preprocessor>;
+}
+
+impl<T: 'static + Preprocessor + Clone> PreprocessorClone for T {
+    fn clone_preprocessor(&self) -> Box<dyn Preprocessor> {
+        Box::new(self.clone())
+    }
+}
+
+impl Clone for Box<dyn Preprocessor> {
+    fn clone(&self) -> Box<dyn Preprocessor> {
+        self.clone_preprocessor()
+    }
+}