Merge pull request #641 from rust-lang-nursery/pre-release

Michael-F-Bryan · web-flow · commit 3bc5d907f416 · 2018-03-15T09:24:26.000+08:00
Pre release
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,8 +1,8 @@
 [package]
 name = "mdbook"
-version = "0.1.4-alpha.0"
+version = "0.1.5-alpha.0"
 authors = ["Mathieu David <mathieudavid@mathieudavid.org>", "Michael-F-Bryan <michaelfbryan@gmail.com>"]
-description = "create books from markdown files (like Gitbook)"
+description = "Create books from markdown files"
 documentation = "http://rust-lang-nursery.github.io/mdBook/index.html"
 repository = "https://github.com/rust-lang-nursery/mdBook"
 keywords = ["book", "gitbook", "rustbook", "markdown"]
@@ -16,13 +16,13 @@ exclude = [
 
 [package.metadata.release]
 sign-commit = true
-push-remote = "upstream"
+push-remote = "origin"
 tag-prefix = "v"
 
 [dependencies]
 clap = "2.24"
 chrono = "0.4"
-handlebars = "0.29"
+handlebars = "0.32"
 serde = "1.0"
 serde_derive = "1.0"
 error-chain = "0.11"
@@ -51,15 +51,15 @@ staticfile = { version = "0.4", optional = true }
 ws = { version = "0.7", optional = true}
 
 # Search feature
-elasticlunr-rs = { version = "0.2", optional = true }
+elasticlunr-rs = { version = "1.0", optional = true }
 ammonia = { version = "1.1", optional = true }
 
 [build-dependencies]
 error-chain = "0.11"
 
 [dev-dependencies]
 select = "0.4"
-pretty_assertions = "0.4"
+pretty_assertions = "0.5"
 walkdir = "2.0"
 pulldown-cmark-to-cmark = "1.1.0"
 
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
     <tr>
         <td><strong>Windows</strong></td>
         <td>
-            <a href="https://ci.appveyor.com/project/azerupi/mdbook/"><img src="https://ci.appveyor.com/api/projects/status/o38racsnbcospyc8/branch/master?svg=true"></a>
+            <a href="https://ci.appveyor.com/project/rust-lang-libs/mdbook"><img src="https://ci.appveyor.com/api/projects/status/ysyke2rvo85sni55?svg=true"></a>
         </td>
     </tr>
     <tr>
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,7 +1,8 @@
 //! # mdBook
 //!
-//! **mdBook** is similar to GitBook but implemented in Rust.
-//! It offers a command line interface, but can also be used as a regular crate.
+//! **mdBook** is a tool for rendering a collection of markdown documents into
+//! a form more suitable for end users like HTML or EPUB.  It offers a command
+//! line interface, but this crate can be used if more control is required.
 //!
 //! This is the API doc, the [user guide] is also available if you want
 //! information about the command line tool, format, structure etc. It is also
@@ -15,6 +16,12 @@
 //! - Accessing the public API to help create a new Renderer
 //! - ...
 //!
+//! > **Note:** While we try to ensure `mdbook`'s command-line interface and
+//! > behaviour are backwards compatible, the tool's internals are still
+//! > evolving and being iterated on. If you wish to prevent accidental
+//! > breakages it is recommended to pin any tools building on top of the
+//! > `mdbook` crate to a specific release.
+//!
 //! # Examples
 //!
 //! If creating a new book from scratch, you'll want to get a `BookBuilder` via
diff --git a/src/renderer/html_handlebars/helpers/navigation.rs b/src/renderer/html_handlebars/helpers/navigation.rs
@@ -4,7 +4,6 @@ use std::collections::BTreeMap;
 use serde_json;
 use handlebars::{Context, Handlebars, Helper, RenderContext, RenderError, Renderable};
 
-
 type StringMap = BTreeMap<String, String>;
 
 /// Target for `find_chapter`.
@@ -15,22 +14,23 @@ enum Target {
 
 impl Target {
     /// Returns target if found.
-    fn find(&self,
-            base_path: &String,
-            current_path: &String,
-            current_item: &StringMap,
-            previous_item: &StringMap,
-            ) -> Result<Option<StringMap>, RenderError> {
+    fn find(
+        &self,
+        base_path: &String,
+        current_path: &String,
+        current_item: &StringMap,
+        previous_item: &StringMap,
+    ) -> Result<Option<StringMap>, RenderError> {
         match self {
             &Target::Next => {
-                let previous_path = previous_item.get("path").ok_or_else(|| {
-                    RenderError::new("No path found for chapter in JSON data")
-                })?;
+                let previous_path = previous_item
+                    .get("path")
+                    .ok_or_else(|| RenderError::new("No path found for chapter in JSON data"))?;
 
                 if previous_path == base_path {
                     return Ok(Some(current_item.clone()));
                 }
-            },
+            }
 
             &Target::Previous => {
                 if current_path == base_path {
@@ -43,21 +43,18 @@ impl Target {
     }
 }
 
-fn find_chapter(
-    rc: &mut RenderContext,
-    target: Target
-) -> Result<Option<StringMap>, RenderError> {
+fn find_chapter(rc: &mut RenderContext, target: Target) -> Result<Option<StringMap>, RenderError> {
     debug!("Get data from context");
 
-    let chapters = rc.evaluate_absolute("chapters").and_then(|c| {
+    let chapters = rc.evaluate_absolute("chapters", true).and_then(|c| {
         serde_json::value::from_value::<Vec<StringMap>>(c.clone())
             .map_err(|_| RenderError::new("Could not decode the JSON data"))
     })?;
 
-    let base_path = rc.evaluate_absolute("path")?
-                      .as_str()
-                      .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
-                      .replace("\"", "");
+    let base_path = rc.evaluate_absolute("path", true)?
+        .as_str()
+        .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
+        .replace("\"", "");
 
     let mut previous: Option<StringMap> = None;
 
@@ -78,7 +75,7 @@ fn find_chapter(
         }
     }
 
-   Ok(None)
+    Ok(None)
 }
 
 fn render(
@@ -91,18 +88,21 @@ fn render(
 
     let mut context = BTreeMap::new();
 
-    chapter.get("name")
-            .ok_or_else(|| RenderError::new("No title found for chapter in JSON data"))
-            .map(|name| context.insert("title".to_owned(), json!(name)))?;
-
-    chapter.get("path")
-            .ok_or_else(|| RenderError::new("No path found for chapter in JSON data"))
-            .and_then(|p| {
-                    Path::new(p).with_extension("html")
-                    .to_str()
-                    .ok_or_else(|| RenderError::new("Link could not be converted to str"))
-                    .map(|p| context.insert("link".to_owned(), json!(p.replace("\\", "/"))))
-            })?;
+    chapter
+        .get("name")
+        .ok_or_else(|| RenderError::new("No title found for chapter in JSON data"))
+        .map(|name| context.insert("title".to_owned(), json!(name)))?;
+
+    chapter
+        .get("path")
+        .ok_or_else(|| RenderError::new("No path found for chapter in JSON data"))
+        .and_then(|p| {
+            Path::new(p)
+                .with_extension("html")
+                .to_str()
+                .ok_or_else(|| RenderError::new("Link could not be converted to str"))
+                .map(|p| context.insert("link".to_owned(), json!(p.replace("\\", "/"))))
+        })?;
 
     trace!("Render template");
 
@@ -138,14 +138,14 @@ pub fn next(_h: &Helper, r: &Handlebars, rc: &mut RenderContext) -> Result<(), R
 
 #[cfg(test)]
 mod tests {
-   use super::*;
+    use super::*;
 
-   static TEMPLATE: &'static str =
-      "{{#previous}}{{title}}: {{link}}{{/previous}}|{{#next}}{{title}}: {{link}}{{/next}}";
+    static TEMPLATE: &'static str =
+        "{{#previous}}{{title}}: {{link}}{{/previous}}|{{#next}}{{title}}: {{link}}{{/next}}";
 
-   #[test]
-   fn test_next_previous() {
-      let data = json!({
+    #[test]
+    fn test_next_previous() {
+        let data = json!({
          "name": "two",
          "path": "two.path",
          "chapters": [
@@ -164,18 +164,19 @@ mod tests {
          ]
       });
 
-      let mut h = Handlebars::new();
-      h.register_helper("previous", Box::new(previous));
-      h.register_helper("next", Box::new(next));
+        let mut h = Handlebars::new();
+        h.register_helper("previous", Box::new(previous));
+        h.register_helper("next", Box::new(next));
 
-      assert_eq!(
-         h.template_render(TEMPLATE, &data).unwrap(),
-         "one: one.html|three: three.html");
-   }
+        assert_eq!(
+            h.render_template(TEMPLATE, &data).unwrap(),
+            "one: one.html|three: three.html"
+        );
+    }
 
-   #[test]
-   fn test_first() {
-      let data = json!({
+    #[test]
+    fn test_first() {
+        let data = json!({
          "name": "one",
          "path": "one.path",
          "chapters": [
@@ -194,17 +195,18 @@ mod tests {
          ]
       });
 
-      let mut h = Handlebars::new();
-      h.register_helper("previous", Box::new(previous));
-      h.register_helper("next", Box::new(next));
-
-      assert_eq!(
-         h.template_render(TEMPLATE, &data).unwrap(),
-         "|two: two.html");
-   }
-   #[test]
-   fn test_last() {
-      let data = json!({
+        let mut h = Handlebars::new();
+        h.register_helper("previous", Box::new(previous));
+        h.register_helper("next", Box::new(next));
+
+        assert_eq!(
+            h.render_template(TEMPLATE, &data).unwrap(),
+            "|two: two.html"
+        );
+    }
+    #[test]
+    fn test_last() {
+        let data = json!({
          "name": "three",
          "path": "three.path",
          "chapters": [
@@ -223,12 +225,13 @@ mod tests {
          ]
       });
 
-      let mut h = Handlebars::new();
-      h.register_helper("previous", Box::new(previous));
-      h.register_helper("next", Box::new(next));
+        let mut h = Handlebars::new();
+        h.register_helper("previous", Box::new(previous));
+        h.register_helper("next", Box::new(next));
 
-      assert_eq!(
-         h.template_render(TEMPLATE, &data).unwrap(),
-         "two: two.html|");
-   }
+        assert_eq!(
+            h.render_template(TEMPLATE, &data).unwrap(),
+            "two: two.html|"
+        );
+    }
 }
diff --git a/src/renderer/html_handlebars/helpers/toc.rs b/src/renderer/html_handlebars/helpers/toc.rs
@@ -8,22 +8,22 @@ use pulldown_cmark::{html, Event, Parser, Tag};
 // Handlebars helper to construct TOC
 #[derive(Clone, Copy)]
 pub struct RenderToc {
-    pub no_section_label: bool
+    pub no_section_label: bool,
 }
 
 impl HelperDef for RenderToc {
     fn call(&self, _h: &Helper, _: &Handlebars, rc: &mut RenderContext) -> Result<(), RenderError> {
         // get value from context data
         // rc.get_path() is current json parent path, you should always use it like this
         // param is the key of value you want to display
-        let chapters = rc.evaluate_absolute("chapters").and_then(|c| {
+        let chapters = rc.evaluate_absolute("chapters", true).and_then(|c| {
             serde_json::value::from_value::<Vec<BTreeMap<String, String>>>(c.clone())
                 .map_err(|_| RenderError::new("Could not decode the JSON data"))
         })?;
-        let current = rc.evaluate_absolute("path")?
-                        .as_str()
-                        .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
-                        .replace("\"", "");
+        let current = rc.evaluate_absolute("path", true)?
+            .as_str()
+            .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
+            .replace("\"", "");
 
         rc.writer.write_all(b"<ol class=\"chapter\">")?;
 
@@ -107,12 +107,12 @@ impl HelperDef for RenderToc {
 
                 // filter all events that are not inline code blocks
                 let parser = Parser::new(name).filter(|event| match *event {
-                                                          Event::Start(Tag::Code) |
-                                                          Event::End(Tag::Code) |
-                                                          Event::InlineHtml(_) |
-                                                          Event::Text(_) => true,
-                                                          _ => false,
-                                                      });
+                    Event::Start(Tag::Code)
+                    | Event::End(Tag::Code)
+                    | Event::InlineHtml(_)
+                    | Event::Text(_) => true,
+                    _ => false,
+                });
 
                 // render markdown to html
                 let mut markdown_parsed_name = String::with_capacity(name.len() * 3 / 2);
