issue2551094 - markdown mismatch - new config for embedded newine

Make earlier patch to fix mismatch between simplemde formatting
of embedded newlines choosable. New option MARKDOWN_BREAK_ON_NEWLINE
added to config.ini. If set to true all 4 renders: markdown,
markdown2, mistune and simplemde will make a newline into a hard
linebreak using <br> when displayed.

Author: rouilj

CHANGES.txt

@@ -51,7 +51,10 @@ Features:
 - issue2550716 - Email address displayed after password reset request.
   This fix actually made it into 1.6 release. However this release
   documents how password reset works in user_guide.txt. (John Rouillard)
- 
+- issue2551094 - add new markdown config.ini setting to allow embedded
+  newlines to cause a linebreak same as GitHub Flavored Markdown.
+  (Patch: Cedric Krier; Doc change/checkin John Rouillard)
+
 2020-07-13 2.0.0
 
 Fixed:

roundup/cgi/templating.py

@@ -69,7 +69,13 @@ class Markdown(markdown2.Markdown):
             # don't allow disabled protocols in links
             _safe_protocols = re.compile('(?!' + ':|'.join([re.escape(s) for s in _disable_url_schemes]) + ':)', re.IGNORECASE)
 
-        markdown = lambda s: Markdown(safe_mode='escape', extras={ 'fenced-code-blocks' : True }).convert(s)
+        def _extras(config):
+            extras = { 'fenced-code-blocks' : True }
+            if config['MARKDOWN_BREAK_ON_NEWLINE']:
+                extras['break-on-newline'] = True
+            return extras
+
+        markdown = lambda s, c: Markdown(safe_mode='escape', extras=_extras(c)).convert(s)
     except ImportError:
         markdown = None
 
@@ -107,7 +113,13 @@ def extendMarkdown(self, md, md_globals=None):
                 else:
                     md.treeprocessors['restrict_links'] = RestrictLinksProcessor()
 
-        markdown = lambda s: markdown_impl(s, extensions=[SafeHtml(), 'fenced_code'])
+        def _extensions(config):
+            extensions = [SafeHtml(), 'fenced_code']
+            if config['MARKDOWN_BREAK_ON_NEWLINE']:
+                extensions.append('nl2br')
+            return extensions
+
+        markdown = lambda s, c: markdown_impl(s, extensions=_extensions(c))
     except ImportError:
         markdown = None
 
@@ -117,7 +129,14 @@ def _import_mistune():
     try:
         import mistune
         mistune._scheme_blacklist = [ s + ':' for s in _disable_url_schemes ]
-        markdown = mistune.markdown
+
+        def _options(config):
+            options = {}
+            if config['MARKDOWN_BREAK_ON_NEWLINE']:
+                options['hard_wrap'] = True
+            return options
+
+        markdown = lambda s, c: mistune.markdown(s, **_options(c))
     except ImportError:
         markdown = None
 
@@ -1731,7 +1750,7 @@ def markdown(self, hyperlink=1):
         if hyperlink:
             s = self.hyper_re.sub(self._hyper_repl_markdown, s)
         try:
-            s = u2s(markdown(s2u(s)))
+            s = u2s(markdown(s2u(s), self._db.config))
         except Exception:  # when markdown formatting fails return markup
             return self.plain(escape=0, hyperlink=hyperlink)
         return s

roundup/configuration.py

@@ -1329,6 +1329,12 @@ def str2value(self, value):
             "won't be attached to nosy mails. They will be replaced by\n"
             "a link to the tracker's download page for the file.")
     ), "Nosy messages sending"),
+    ("markdown", (
+        (BooleanOption, "break_on_newline", "no",
+            "If yes/true, render single new line characters in markdown\n"
+            "text with <br>. Set true if you want GitHub Flavored Markdown\n"
+            "(GFM) handling of embedded newlines."),
+    ), "Markdown rendering options."),
 )
 
 ### Configuration classes

share/roundup/templates/jinja2/html/issue.item.html

@@ -32,7 +32,8 @@
       var node = $('#change_note')[0];
       var initSimpleMde = function () {
         node.parentNode.appendChild($('<input/>', { type: 'hidden', name: 'msg-1@type', value: 'text/markdown'})[0]);
-        var simplemde = new SimpleMDE({ element: node, status: false, styleSelectedText: false, renderingConfig: {singleLineBreaks: false}});
+        var simplemde = new SimpleMDE({ element: node, status: false,
+      styleSelectedText: false, renderingConfig: {singleLineBreaks: {{ config.MARKDOWN_BREAK_ON_NEWLINE and 'true' or 'false' }} }});
         simplemde.render();
       };
       {% if context.id %}

test/test_templating.py

@@ -74,7 +74,7 @@ def setUp(self):
         # add client props for testing anti_csrf_nonce
         self.client.session_api = MockNull(_sid="1234567890")
         self.client.db.getuid = lambda : 10
-        self.client.db.config = {'WEB_CSRF_TOKEN_LIFETIME': 10 }
+        self.client.db.config = {'WEB_CSRF_TOKEN_LIFETIME': 10, 'MARKDOWN_BREAK_ON_NEWLINE': False }
 
 class HTMLDatabaseTestCase(TemplatingTestCase):
     def test_HTMLDatabase___getitem__(self):
@@ -477,6 +477,16 @@ def test_string_markdown_code_block_attribute(self):
               # so processing it returns original text
             self.assertEqual(m.replace('\n\n', '\n'), u2s(u'embedded code block <pre>\n``` python\nline 1\nline 2\n```\nnew </pre> paragraph'))
 
+    def test_break_on_newline(self):
+        self.client.db.config['MARKDOWN_BREAK_ON_NEWLINE'] = True
+        p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string with\nline break\ntwice.'))
+        m = p.markdown()
+        self.assertEqual(2, m.count('<br'))
+        self.client.db.config['MARKDOWN_BREAK_ON_NEWLINE'] = False
+
+        m = p.markdown()
+        self.assertEqual(0, m.count('<br'))
+
 
 @skip_mistune
 class MistuneTestCase(TemplatingTestCase, MarkdownTests) :