Skip to content

Switch from pulldown-cmark to comrak #981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 26, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 32 additions & 10 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ serde_derive = "1.0.0"
serde = "1.0.0"
clippy = { version = "=0.0.142", optional = true }
chrono = "0.4.0"
pulldown-cmark = { version = "0.0.15", default-features = false }
comrak = { version = "0.1.8", default-features = false }
ammonia = "0.5.0"

conduit = "0.8"
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ extern crate serde_json;
extern crate serde_derive;
extern crate ammonia;
extern crate chrono;
extern crate comrak;
extern crate curl;
extern crate diesel_full_text_search;
extern crate dotenv;
Expand All @@ -31,7 +32,6 @@ extern crate hex;
extern crate license_exprs;
extern crate oauth2;
extern crate openssl;
extern crate pulldown_cmark;
extern crate r2d2;
extern crate r2d2_diesel;
extern crate rand;
Expand Down
74 changes: 36 additions & 38 deletions src/render.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
use ammonia::Ammonia;
use pulldown_cmark::Parser;
use pulldown_cmark::html;
use comrak;

use util::CargoResult;

Expand All @@ -24,12 +23,13 @@ impl<'a> MarkdownRenderer<'a> {
"dl",
"dt",
"em",
"i",
"h1",
"h2",
"h3",
"hr",
"i",
"img",
"input",
"kbd",
"li",
"ol",
Expand Down Expand Up @@ -61,6 +61,10 @@ impl<'a> MarkdownRenderer<'a> {
.cloned()
.collect(),
),
(
"input",
["checked", "disabled", "type"].iter().cloned().collect(),
),
].iter()
.cloned()
.collect();
Expand All @@ -75,9 +79,15 @@ impl<'a> MarkdownRenderer<'a> {

/// Renders the given markdown to HTML using the current settings.
pub fn to_html(&self, text: &str) -> CargoResult<String> {
let mut rendered = String::with_capacity(text.len() * 3 / 2);
let parser = Parser::new(text);
html::push_html(&mut rendered, parser);
let options = comrak::ComrakOptions {
ext_autolink: true,
ext_strikethrough: true,
ext_table: true,
ext_tagfilter: true,
ext_tasklist: true,
..comrak::ComrakOptions::default()
};
let rendered = comrak::markdown_to_html(text, &options);
Ok(self.html_sanitizer.clean(&rendered))
}
}
Expand Down Expand Up @@ -113,56 +123,44 @@ mod tests {
#[test]
fn empty_text() {
let text = "";
let result = markdown_to_html(text);
assert_eq!(result.is_ok(), true);
let rendered = result.unwrap();
assert_eq!(rendered, "");
let result = markdown_to_html(text).unwrap();
assert_eq!(result, "");
}

#[test]
fn text_with_script_tag() {
let text = "foo_readme\n\n<script>alert('Hello World')</script>";
let result = markdown_to_html(text);
assert_eq!(result.is_ok(), true);
let rendered = result.unwrap();
assert_eq!(rendered.contains("foo_readme"), true);
assert_eq!(rendered.contains("script"), false);
assert_eq!(rendered.contains("alert('Hello World')"), true);
let result = markdown_to_html(text).unwrap();
assert_eq!(
result,
"<p>foo_readme</p>\n&lt;script&gt;alert(\'Hello World\')&lt;/script&gt;\n"
);
}

#[test]
fn text_with_iframe_tag() {
let text = "foo_readme\n\n<iframe>alert('Hello World')</iframe>";
let result = markdown_to_html(text);
assert_eq!(result.is_ok(), true);
let rendered = result.unwrap();
assert_eq!(rendered.contains("foo_readme"), true);
assert_eq!(rendered.contains("iframe"), false);
assert_eq!(rendered.contains("alert('Hello World')"), true);
let result = markdown_to_html(text).unwrap();
assert_eq!(
result,
"<p>foo_readme</p>\n&lt;iframe&gt;alert(\'Hello World\')&lt;/iframe&gt;\n"
);
}

#[test]
fn text_with_unknwon_tag() {
fn text_with_unknown_tag() {
let text = "foo_readme\n\n<unknown>alert('Hello World')</unknown>";
let result = markdown_to_html(text);
assert_eq!(result.is_ok(), true);
let rendered = result.unwrap();
assert_eq!(rendered.contains("foo_readme"), true);
assert_eq!(rendered.contains("unknown"), false);
assert_eq!(rendered.contains("alert('Hello World')"), true);
let result = markdown_to_html(text).unwrap();
assert_eq!(result, "<p>foo_readme</p>\n<p>alert(\'Hello World\')</p>\n");
}

#[test]
fn text_with_inline_javascript() {
let text = r#"foo_readme\n\n<a href="https://crates.io/crates/cargo-registry" onclick="window.alert('Got you')">Crate page</a>"#;
let result = markdown_to_html(text);
assert_eq!(result.is_ok(), true);
let rendered = result.unwrap();
assert_eq!(rendered.contains("foo_readme"), true);
assert_eq!(rendered.contains("<a"), true);
assert_eq!(rendered.contains("href="), true);
assert_eq!(rendered.contains("onclick"), false);
assert_eq!(rendered.contains("window.alert"), false);
assert_eq!(rendered.contains("Crate page"), true);
let result = markdown_to_html(text).unwrap();
assert_eq!(
result,
"<p>foo_readme\\n\\n<a href=\"https://crates.io/crates/cargo-registry\">Crate page</a></p>\n"
);
}
}