Added a test to make sure you can include rust files in chapters

This commit is contained in:
Michael Bryan 2017-11-18 23:21:59 +08:00
parent 527fc5cf79
commit 751da4f05f
No known key found for this signature in database
GPG Key ID: E9C602B0D9A998DC
5 changed files with 45 additions and 31 deletions

View File

@ -38,7 +38,9 @@ impl HtmlHandlebars {
BookItem::Chapter(ref ch) => BookItem::Chapter(ref ch) =>
{ {
let content = ch.content.clone(); let content = ch.content.clone();
let base = ch.path.parent().expect("All chapters must have a parent directory"); let base = ch.path.parent()
.map(|dir| ctx.src_dir.join(dir))
.expect("All chapters must have a parent directory");
// Parse and expand links // Parse and expand links
let content = preprocess::links::replace_all(&content, base)?; let content = preprocess::links::replace_all(&content, base)?;
@ -239,13 +241,14 @@ impl HtmlHandlebars {
impl Renderer for HtmlHandlebars { impl Renderer for HtmlHandlebars {
fn render(&self, book: &MDBook) -> Result<()> { fn render(&self, book: &MDBook) -> Result<()> {
let html_config = book.config.html_config().unwrap_or_default(); let html_config = book.config.html_config().unwrap_or_default();
let src_dir = book.root.join(&book.config.book.src);
debug!("[fn]: render"); debug!("[fn]: render");
let mut handlebars = Handlebars::new(); let mut handlebars = Handlebars::new();
let theme_dir = match html_config.theme { let theme_dir = match html_config.theme {
Some(ref theme) => theme, Some(ref theme) => theme.to_path_buf(),
None => Path::new("theme"), None => src_dir.join("theme"),
}; };
let theme = theme::Theme::new(theme_dir); let theme = theme::Theme::new(theme_dir);
@ -282,6 +285,7 @@ impl Renderer for HtmlHandlebars {
book: book, book: book,
handlebars: &handlebars, handlebars: &handlebars,
destination: destination.to_path_buf(), destination: destination.to_path_buf(),
src_dir: src_dir.clone(),
data: data.clone(), data: data.clone(),
is_index: i == 0, is_index: i == 0,
html_config: html_config.clone(), html_config: html_config.clone(),
@ -595,6 +599,7 @@ struct RenderItemContext<'a> {
handlebars: &'a Handlebars, handlebars: &'a Handlebars,
book: &'a MDBook, book: &'a MDBook,
destination: PathBuf, destination: PathBuf,
src_dir: PathBuf,
data: serde_json::Map<String, serde_json::Value>, data: serde_json::Map<String, serde_json::Value>,
is_index: bool, is_index: bool,
html_config: HtmlConfig, html_config: HtmlConfig,

View File

@ -0,0 +1,6 @@
fn main() {
println!("Hello World!");
#
# // You can even hide lines! :D
# println!("I am hidden! Expand the code snippet to see me");
}

View File

@ -1 +1,5 @@
# Second Chapter # Second Chapter
This makes sure you can insert runnable Rust files.
{{#playpen example.rs}}

View File

@ -2,6 +2,7 @@ extern crate mdbook;
extern crate tempdir; extern crate tempdir;
use std::path::PathBuf; use std::path::PathBuf;
use std::fs;
use mdbook::MDBook; use mdbook::MDBook;
use mdbook::config::Config; use mdbook::config::Config;
use tempdir::TempDir; use tempdir::TempDir;
@ -63,7 +64,7 @@ fn book_toml_isnt_required() {
let temp = TempDir::new("mdbook").unwrap(); let temp = TempDir::new("mdbook").unwrap();
let md = MDBook::init(temp.path()).build().unwrap(); let md = MDBook::init(temp.path()).build().unwrap();
assert!(!temp.path().join("book.toml").exists()); let _ = fs::remove_file(temp.path().join("book.toml"));
md.read_config().unwrap().build().unwrap(); md.read_config().unwrap().build().unwrap();
} }

View File

@ -10,7 +10,6 @@ mod dummy_book;
use dummy_book::{assert_contains_strings, DummyBook}; use dummy_book::{assert_contains_strings, DummyBook};
use std::fs::{remove_file, File}; use std::fs::{remove_file, File};
use std::io::Write;
use std::path::Path; use std::path::Path;
use std::ffi::OsStr; use std::ffi::OsStr;
use walkdir::{DirEntry, WalkDir, WalkDirIterator}; use walkdir::{DirEntry, WalkDir, WalkDirIterator};
@ -256,46 +255,45 @@ fn check_spacers() {
/// not exist. /// not exist.
#[test] #[test]
fn failure_on_missing_file() { fn failure_on_missing_file() {
let (md, _temp) = create_missing_setup(Some(false)); let (mut md, _temp) = create_missing_setup(false);
// On failure, `build()` does not return a specific error, so assume // On failure, `build()` does not return a specific error, so assume
// any error is a failure due to a missing file. // any error is a failure due to a missing file.
assert!(md.read_config().unwrap().build().is_err()); assert!(md.build().is_err());
} }
/// Ensure a missing file is created if `create-missing` is true. /// Ensure a missing file is created if `create-missing` is true.
#[test] #[test]
fn create_missing_file_with_config() { fn create_missing_file_with_config() {
let (md, temp) = create_missing_setup(Some(true)); let (mut md, temp) = create_missing_setup(true);
md.read_config().unwrap().build().unwrap(); md.build().unwrap();
assert!(temp.path().join("src").join("intro.md").exists()); assert!(temp.path().join("src").join("intro.md").exists());
} }
/// Ensure a missing file is created if `create-missing` is not set (the default fn create_missing_setup(create_missing: bool) -> (MDBook, TempDir) {
/// is true).
#[test]
fn create_missing_file_without_config() {
let (md, temp) = create_missing_setup(None);
md.read_config().unwrap().build().unwrap();
assert!(temp.path().join("src").join("intro.md").exists());
}
fn create_missing_setup(create_missing: Option<bool>) -> (MDBook, TempDir) {
let temp = DummyBook::new().build().unwrap(); let temp = DummyBook::new().build().unwrap();
let md = MDBook::load(temp.path()).unwrap(); let mut md = MDBook::load(temp.path()).unwrap();
let mut file = File::create(temp.path().join("book.toml")).unwrap();
match create_missing {
Some(true) => file.write_all(b"[build]\ncreate-missing = true\n").unwrap(),
Some(false) => file.write_all(b"[build]\ncreate-missing = false\n")
.unwrap(),
None => (),
}
file.flush().unwrap();
md.config.build.create_missing = create_missing;
remove_file(temp.path().join("src").join("intro.md")).unwrap(); remove_file(temp.path().join("src").join("intro.md")).unwrap();
(md, temp) (md, temp)
} }
/// This makes sure you can include a Rust file with `{{#playpen example.rs}}`.
/// Specification is in `book-example/src/format/rust.md`
#[test]
fn able_to_include_rust_files_in_chapters() {
let temp = DummyBook::new().build().unwrap();
let mut md = MDBook::load(temp.path()).unwrap();
md.build().unwrap();
let second = temp.path().join("book/second.html");
let playpen_strings = &[
r#"class="playpen""#,
r#"println!(&quot;Hello World!&quot;);"#,
];
assert_contains_strings(second, playpen_strings);
}