improve regex rendering in markdown

Author: hannesfostie

lib/prmd/templates/schemata/helper.erb

@@ -138,10 +138,15 @@
 
     if value['pattern']
       # Prevent the pipe regex pattern characters from being interpreted
-      # as markdown table
+      # as markdown table.
       # Prevent instances of []() in regexes from being rendered as
-      # markdown links
-      pattern = value['pattern'].gsub(/\|/, '|').gsub(/\[/, '[')
+      # markdown links.
+      # Prevent patterns with * being rendered as having emphasis
+      # or being an unordered list.
+      pattern = value['pattern']
+        .gsub(/\|/, '|')
+        .gsub(/\[/, '[')
+        .gsub(/\*/, '*')
 
       description += "<br/> **pattern:** <pre>#{pattern}</pre>"
     end

test/commands/render_test.rb

@@ -51,7 +51,7 @@ def test_render_for_example_as_an_array
   end
 
   def test_render_for_regex_patterns_with_pipes
-    expression = /<pre>\^&#91;a-z\]\(\?:&#91;a-z\]&#x7c;\)\+&#91;a-z\]\$/
+    expression = /<pre>\^&lbrack;a-z\]\(\?:&lbrack;a&vert;b\]\)\&ast;&lbrack;a-z]&ast;\$/
     markdown = render
     assert_match expression, markdown
   end
@@ -123,7 +123,7 @@ def data
               'description' => 'A string with a regex pattern applied to it.',
               'type' => 'string',
               'example' => 'second',
-              'pattern' => '^[a-z](?:[a-z]&#x7c;)+[a-z]$'
+              'pattern' => '^[a-z](?:[a|b])*[a-z]*$'
             },
             'option1' => {
               'properties' => {