Fixes to ProperNamesRule (#10)

* ProperNamesRule fix codeBlocks logic and now ignores code block language
appmattus · Apr 16, 2019 · 97f7782 · 97f7782
1 parent e27d22e
commit 97f7782
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 7 deletions.
diff --git a/markdown/src/main/kotlin/com/appmattus/markdown/rules/ProperNamesRule.kt b/markdown/src/main/kotlin/com/appmattus/markdown/rules/ProperNamesRule.kt
@@ -5,6 +5,7 @@ import com.appmattus.markdown.errors.ErrorReporter
 import com.appmattus.markdown.processing.MarkdownDocument
 import com.vladsch.flexmark.ast.AutoLink
 import com.vladsch.flexmark.ast.Code
+import com.vladsch.flexmark.ast.FencedCodeBlock
 import com.vladsch.flexmark.ast.Link
 import com.vladsch.flexmark.util.sequence.BasedSequence
 import org.nibor.autolink.LinkExtractor
@@ -53,20 +54,21 @@ class ProperNamesRule(
 
         elements.addAll(
             document.allText
-                .filterNot { it.parent is Link || it.parent is Code || it.parent is AutoLink }
+                .filterNot {
+                    it.parent is Link || it.parent is Code || it.parent is AutoLink || it.parent is FencedCodeBlock
+                }
                 .map { it.chars }
         )
 
-
         elements.addAll(
             document.links
                 .filterNot { it.text.isLink() }
                 .map { it.text }
         )
 
-        if (!codeBlocks) {
+        if (codeBlocks) {
             elements.addAll(document.inlineCode.map { it.text })
-            elements.addAll(document.codeBlocks.map { it.chars })
+            elements.addAll(document.codeBlocks.map { it.contentChars })
         }
 
         elements.forEach { text ->

diff --git a/markdown/src/test/kotlin/com/appmattus/markdown/rules/ProperNamesRuleTest.kt b/markdown/src/test/kotlin/com/appmattus/markdown/rules/ProperNamesRuleTest.kt
@@ -5,6 +5,10 @@ import org.spekframework.spek2.style.gherkin.Feature
 
 object ProperNamesRuleTest : Spek({
     Feature("ProperNamesRule") {
+        FileRuleScenario(listOf("proper-names-codeblocks.md")) { ProperNamesRule(codeBlocks = true) }
+
+        FileRuleScenario(listOf("proper-names-ignore-codeblocks.md")) { ProperNamesRule(codeBlocks = false) }
+
         FileRuleScenario(listOf("proper-names-projects.md")) {
             ProperNamesRule(
                 names = listOf(
@@ -17,11 +21,10 @@ object ProperNamesRuleTest : Spek({
                     "Vue",
                     "vue-router"
                 ),
-                codeBlocks = true
+                codeBlocks = false
             )
         }
 
-        FileRuleScenario(exclude = listOf("proper-names-projects.md")) { ProperNamesRule() }
-
+        FileRuleScenario(exclude = listOf("proper-names-projects.md")) { ProperNamesRule(codeBlocks = true) }
     }
 })
diff --git a/markdown/src/test/resources/proper-names-codeblocks.md b/markdown/src/test/resources/proper-names-codeblocks.md
@@ -0,0 +1,6 @@
+
+```java
+Type above should not trigger but java will trigger {ProperNamesRule}
+```
+
+`java` will also trigger {ProperNamesRule}
diff --git a/markdown/src/test/resources/proper-names-ignore-codeblocks.md b/markdown/src/test/resources/proper-names-ignore-codeblocks.md
@@ -0,0 +1,6 @@
+
+```java
+Type above should not trigger the proper names rule nor should java
+```
+
+`java` should not trigger the rule either
diff --git a/markdown/src/test/resources/proper-names.md b/markdown/src/test/resources/proper-names.md
@@ -69,3 +69,7 @@ Bare URL exempt https://github.com/DavidAnson/MARKDOWNLINT {NoBareUrlsRule}
 A short paragraph
 about node.js and {ProperNamesRule}
 javascript. {ProperNamesRule}
+
+```java
+java will trigger {ProperNamesRule} but the block language will not
+```