From c95b773596b06a574fd6ec4023676c9507992cc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Ducha=C3=AEne?= Date: Tue, 8 Sep 2020 10:16:05 -0400 Subject: [PATCH] Remove false positive possibilities --- src/preprocess/index.rs | 98 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 97 insertions(+), 1 deletion(-) diff --git a/src/preprocess/index.rs b/src/preprocess/index.rs index 0413a6ee..144698a8 100644 --- a/src/preprocess/index.rs +++ b/src/preprocess/index.rs @@ -39,7 +39,7 @@ impl Preprocessor for IndexPreprocessor { path.set_file_name("index.md"); } } - ch.content = ch.content.replace("README.md", "index.md"); + ch.content = replace_readme_in_string(&ch.content); } }); @@ -47,6 +47,45 @@ impl Preprocessor for IndexPreprocessor { } } +fn replace_readme_in_string(content: &str) -> String { + lazy_static! { + static ref RE_INLINE: Regex = Regex::new( + r"(?ix) #ignorecase, allow regex definition eXtended on multiple lines + \[([^\[]+)\] #[name_of_link] + \s? #optional whitespaces + \( #open parenthesis + ([^\[\s]*) #start of path : url/blabla/ + (readme.md) #part that will be replaced by index.md + (?: #BEGIN optional part, '?:' ignores capture of this whole (group) + \s+ #whitespace between path and optional title + ([^\[]*) #optional title + ) #END optional part + \s* #trailing whitespaces + \) #close parenthesis" + ) + .unwrap(); + static ref RE_REFERENCE: Regex = Regex::new( + r"(?ix) #ignorecase, allow regex definition eXtended on multiple lines + ^ #start of line + (\s*) #optional padding whitespaces + \[([^\[]+)\]: #[name_of_link]: + \s* #optional whitespaces + ([^\[\s]*) #start of path + (readme.md) #part that will be replaced by index.md + (?: #BEGIN optional part, '?:' ignores capture of this whole (group) + \s+ #whitespace between path and optional title + ([^\[]*) #optional title + ) #END optional part + \s* #trailing whitespaces + $ #end of line" + ) + .unwrap(); + } + let content = RE_INLINE.replace_all(&content, "[$1](${2}index.md $4)"); + let content = RE_REFERENCE.replace_all(&content, "${1}[$2]: ${3}index.md $5"); + content.to_string() +} + fn warn_readme_name_conflict>(readme_path: P, index_path: P) { let file_name = readme_path.as_ref().file_name().unwrap_or_default(); let parent_dir = index_path @@ -103,4 +142,61 @@ mod tests { let path = "path/to/README-README.md"; assert!(!is_readme_file(path)); } + + #[test] + fn do_not_replace_readme_in_normal_string_test() { + let expected = "content: ( index.md)"; + + let content = "content: ( Readme.md )"; + assert_ne!(replace_readme_in_string(content), expected); + + let content = "content: ( README.md )"; + assert_ne!(replace_readme_in_string(content), expected); + + let content = "content: ( rEaDmE.md )"; + assert_ne!(replace_readme_in_string(content), expected); + + let content = "content: ( README-README.md )"; + assert_ne!(replace_readme_in_string(content), expected); + } + #[test] + fn replace_readme_in_inline_link_test() { + let expected = "[content](./bla/index.md )"; + let expected_with_title = "[content](./bla/index.md \"title\" )"; + + let content = "[content](./bla/Readme.md )"; + assert_eq!(replace_readme_in_string(content), expected); + + let content = "[content](./bla/README.md )"; + assert_eq!(replace_readme_in_string(content), expected); + + let content = "[content](./bla/rEaDmE.md )"; + assert_eq!(replace_readme_in_string(content), expected); + + let content = "[content](./bla/rEaDmE.md \"title\" )"; + assert_eq!(replace_readme_in_string(content), expected_with_title); + + let content = "[content](./bla/README-README.md )"; + assert_ne!(replace_readme_in_string(content), expected); + } + #[test] + fn replace_readme_in_footnote_link_test() { + let expected = "[content]: ./bla/index.md "; + let expected_with_title = "[content]: ./bla/index.md \"title\" "; + + let content = "[content]: ./bla/Readme.md "; + assert_eq!(replace_readme_in_string(content), expected); + + let content = "[content]: ./bla/README.md "; + assert_eq!(replace_readme_in_string(content), expected); + + let content = "[content]: ./bla/rEaDmE.md "; + assert_eq!(replace_readme_in_string(content), expected); + + let content = "[content]: ./bla/rEaDmE.md \"title\" "; + assert_eq!(replace_readme_in_string(content), expected_with_title); + + let content = "[content]: ./bla/README-README.md "; + assert_ne!(replace_readme_in_string(content), expected); + } }