Merge pull request #866 from rust-lang-nursery/gh828

Fixing links in print.html

Author: steveklabnik

src/renderer/html_handlebars/hbs_renderer.rs

@@ -33,7 +33,11 @@ impl HtmlHandlebars {
         if let BookItem::Chapter(ref ch) = *item {
             let content = ch.content.clone();
             let content = utils::render_markdown(&content, ctx.html_config.curly_quotes);
-            print_content.push_str(&content);
+
+            let string_path = ch.path.parent().unwrap().display().to_string();
+
+            let fixed_content = utils::render_markdown_with_base(&ch.content, ctx.html_config.curly_quotes, &string_path);
+            print_content.push_str(&fixed_content);
 
             // Update the context with data for this file
             let path = ch

src/utils/mod.rs

@@ -66,15 +66,21 @@ pub fn id_from_content(content: &str) -> String {
     normalize_id(trimmed)
 }
 
-fn adjust_links(event: Event) -> Event {
+fn adjust_links<'a>(event: Event<'a>, with_base: &str) -> Event<'a> {
     lazy_static! {
         static ref HTTP_LINK: Regex = Regex::new("^https?://").unwrap();
-        static ref MD_LINK: Regex = Regex::new("(?P<link>.*).md(?P<anchor>#.*)?").unwrap();
+        static ref MD_LINK: Regex = Regex::new(r"(?P<link>.*)\.md(?P<anchor>#.*)?").unwrap();
     }
 
     match event {
         Event::Start(Tag::Link(dest, title)) => {
             if !HTTP_LINK.is_match(&dest) {
+                let dest = if !with_base.is_empty() {
+                    format!("{}/{}", with_base, dest)
+                } else {
+                    dest.clone().into_owned()
+                };
+
                 if let Some(caps) = MD_LINK.captures(&dest) {
                     let mut html_link = [&caps["link"], ".html"].concat();
 
@@ -94,6 +100,10 @@ fn adjust_links(event: Event) -> Event {
 
 /// Wrapper around the pulldown-cmark parser for rendering markdown to HTML.
 pub fn render_markdown(text: &str, curly_quotes: bool) -> String {
+    render_markdown_with_base(text, curly_quotes, "")
+}
+
+pub fn render_markdown_with_base(text: &str, curly_quotes: bool, base: &str) -> String {
     let mut s = String::with_capacity(text.len() * 3 / 2);
 
     let mut opts = Options::empty();
@@ -104,7 +114,7 @@ pub fn render_markdown(text: &str, curly_quotes: bool) -> String {
     let mut converter = EventQuoteConverter::new(curly_quotes);
     let events = p
         .map(clean_codeblock_headers)
-        .map(adjust_links)
+        .map(|event| adjust_links(event, base))
         .map(|event| converter.convert(event));
 
     html::push_html(&mut s, events);
@@ -220,6 +230,12 @@ mod tests {
                 render_markdown("[example_anchor](example.md#anchor)", false),
                 "<p><a href=\"example.html#anchor\">example_anchor</a></p>\n"
             );
+
+            // this anchor contains 'md' inside of it
+            assert_eq!(
+                render_markdown("[phantom data](foo.html#phantomdata)", false),
+                "<p><a href=\"foo.html#phantomdata\">phantom data</a></p>\n"
+            );
         }
 
         #[test]

tests/dummy_book/src/SUMMARY.md

@@ -8,6 +8,7 @@
     - [Includes](first/includes.md)
     - [Recursive](first/recursive.md)
 - [Second Chapter](second.md)
+    - [Nested Chapter](second/nested.md)
 
 ---
 

tests/dummy_book/src/second/nested.md

@@ -0,0 +1,4 @@
+# Testing relative links for the print page
+
+When we link to [the first section](../first/nested.md), it should work on
+both the print page and the non-print page.

tests/rendered_output.rs

@@ -31,7 +31,7 @@ const TOC_TOP_LEVEL: &[&'static str] = &[
     "Introduction",
 ];
 const TOC_SECOND_LEVEL: &[&'static str] =
-    &["1.1. Nested Chapter", "1.2. Includes", "1.3. Recursive"];
+    &["1.1. Nested Chapter", "1.2. Includes", "2.1. Nested Chapter", "1.3. Recursive"];
 
 /// Make sure you can load the dummy book and build it without panicking.
 #[test]
@@ -109,6 +109,20 @@ fn check_correct_cross_links_in_nested_dir() {
     );
 }
 
+#[test]
+fn check_correct_relative_links_in_print_page() {
+    let temp = DummyBook::new().build().unwrap();
+    let md = MDBook::load(temp.path()).unwrap();
+    md.build().unwrap();
+
+    let first = temp.path().join("book");
+
+    assert_contains_strings(
+        first.join("print.html"),
+        &[r##"<a href="second/../first/nested.html">the first section</a>,"##],
+    );
+}
+
 #[test]
 fn rendered_code_has_playpen_stuff() {
     let temp = DummyBook::new().build().unwrap();
@@ -443,7 +457,7 @@ mod search {
         assert_eq!(docs[&some_section]["body"], "");
         assert_eq!(
             docs[&summary]["body"],
-            "Dummy Book Introduction First Chapter Nested Chapter Includes Recursive Second Chapter Conclusion"
+            "Dummy Book Introduction First Chapter Nested Chapter Includes Recursive Second Chapter Nested Chapter Conclusion"
         );
         assert_eq!(docs[&summary]["breadcrumbs"], "First Chapter » Summary");
         assert_eq!(docs[&conclusion]["body"], "I put &lt;HTML&gt; in here!");