mod summary; mod book; mod init; pub use self::book::{Book, BookItem, BookItems, Chapter}; pub use self::init::BookBuilder; use std::path::{Path, PathBuf}; use std::io::Write; use std::process::Command; use tempdir::TempDir; use utils; use renderer::{HtmlHandlebars, Renderer}; use preprocess; use errors::*; use config::Config; pub struct MDBook { pub root: PathBuf, pub config: Config, book: Book, renderer: Box, pub livereload: Option, } impl MDBook { /// Load a book from its root directory on disk. pub fn load>(book_root: P) -> Result { let book_root = book_root.into(); let config_location = book_root.join("book.toml"); let config = if config_location.exists() { Config::from_disk(&config_location)? } else { Config::default() }; let src_dir = book_root.join(&config.book.src); let book = book::load_book(&src_dir)?; Ok(MDBook { root: book_root, config: config, book: book, renderer: Box::new(HtmlHandlebars::new()), livereload: None, }) } /// Returns a flat depth-first iterator over the elements of the book, /// it returns an [BookItem enum](bookitem.html): /// `(section: String, bookitem: &BookItem)` /// /// ```no_run /// # extern crate mdbook; /// # use mdbook::MDBook; /// # use mdbook::book::BookItem; /// # #[allow(unused_variables)] /// # fn main() { /// # let book = MDBook::new("mybook"); /// for item in book.iter() { /// match *item { /// BookItem::Chapter(ref chapter) => {}, /// BookItem::Spacer => {}, /// } /// } /// /// // would print something like this: /// // 1. Chapter 1 /// // 1.1 Sub Chapter /// // 1.2 Sub Chapter /// // 2. Chapter 2 /// // /// // etc. /// # } /// ``` pub fn iter(&self) -> BookItems { self.book.iter() } /// `init()` gives you a `BookBuilder` which you can use to setup a new book /// and its accompanying directory structure. /// /// The `BookBuilder` creates some boilerplate files and directories to get /// you started with your book. /// /// ```text /// book-test/ /// ├── book /// └── src /// ├── chapter_1.md /// └── SUMMARY.md /// ``` /// /// It uses the path provided as the root directory for your book, then adds /// in a `src/` directory containing a `SUMMARY.md` and `chapter_1.md` file /// to get you started. pub fn init>(book_root: P) -> BookBuilder { BookBuilder::new(book_root) } /// Tells the renderer to build our book and put it in the build directory. pub fn build(&mut self) -> Result<()> { debug!("[fn]: build"); let dest = self.get_destination(); if dest.exists() { utils::fs::remove_dir_content(&dest).chain_err(|| "Unable to clear output directory")?; } self.renderer.render(self) } pub fn write_file>(&self, filename: P, content: &[u8]) -> Result<()> { let path = self.get_destination().join(filename); utils::fs::create_file(&path)?.write_all(content) .map_err(|e| e.into()) } /// Parses the `book.json` file (if it exists) to extract /// the configuration parameters. /// The `book.json` file should be in the root directory of the book. /// The root directory is the one specified when creating a new `MDBook` pub fn read_config(mut self) -> Result { let config_path = self.root.join("book.toml"); if config_path.exists() { debug!("[*] Loading the config from {}", config_path.display()); self.config = Config::from_disk(&config_path)?; } else { self.config = Config::default(); } Ok(self) } /// You can change the default renderer to another one /// by using this method. The only requirement /// is for your renderer to implement the /// [Renderer trait](../../renderer/renderer/trait.Renderer.html) /// /// ```no_run /// extern crate mdbook; /// use mdbook::MDBook; /// use mdbook::renderer::HtmlHandlebars; /// /// # #[allow(unused_variables)] /// fn main() { /// let book = MDBook::new("mybook") /// .set_renderer(Box::new(HtmlHandlebars::new())); /// /// // In this example we replace the default renderer /// // by the default renderer... /// // Don't forget to put your renderer in a Box /// } /// ``` /// /// **note:** Don't forget to put your renderer in a `Box` /// before passing it to `set_renderer()` pub fn set_renderer(mut self, renderer: Box) -> Self { self.renderer = renderer; self } pub fn test(&mut self, library_paths: Vec<&str>) -> Result<()> { let library_args: Vec<&str> = (0..library_paths.len()).map(|_| "-L") .zip(library_paths.into_iter()) .flat_map(|x| vec![x.0, x.1]) .collect(); let temp_dir = TempDir::new("mdbook")?; for item in self.iter() { if let BookItem::Chapter(ref ch) = *item { if !ch.path.as_os_str().is_empty() { let path = self.get_source().join(&ch.path); let base = path.parent().ok_or_else(|| String::from("Invalid bookitem path!"))?; let content = utils::fs::file_to_string(&path)?; // Parse and expand links let content = preprocess::links::replace_all(&content, base)?; println!("[*]: Testing file: {:?}", path); // write preprocessed file to tempdir let path = temp_dir.path().join(&ch.path); let mut tmpf = utils::fs::create_file(&path)?; tmpf.write_all(content.as_bytes())?; let output = Command::new("rustdoc").arg(&path) .arg("--test") .args(&library_args) .output()?; if !output.status.success() { bail!(ErrorKind::Subprocess( "Rustdoc returned an error".to_string(), output )); } } } } Ok(()) } pub fn get_destination(&self) -> PathBuf { self.root.join(&self.config.build.build_dir) } pub fn get_source(&self) -> PathBuf { self.root.join(&self.config.book.src) } pub fn theme_dir(&self) -> PathBuf { match self.config.html_config().and_then(|h| h.theme) { Some(d) => self.root.join(d), None => self.root.join("theme"), } } }