Allow Alerts With No Body

Author: rdestefa

commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertTitle.java

@@ -18,8 +18,7 @@
  * the {@code AlertTitle} contains a {@code Text} node ({@code "Custom "}) followed
  * by an {@code Emphasis} node wrapping {@code "title"}.
  *
- * @see AlertsExtension.Builder#allowCustomTitles()
- * @see AlertsExtension.Builder#disallowCustomTitles()
+ * @see AlertsExtension.Builder#allowCustomTitles(boolean)
  */
 public class AlertTitle extends CustomNode {
 }

commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertBlockParser.java

@@ -2,15 +2,13 @@
 
 import java.util.Locale;
 import java.util.Set;
-import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 import org.commonmark.ext.gfm.alerts.Alert;
 import org.commonmark.ext.gfm.alerts.AlertTitle;
 import org.commonmark.node.Block;
 import org.commonmark.node.BlockQuote;
 import org.commonmark.node.Document;
-import org.commonmark.node.Paragraph;
 import org.commonmark.parser.InlineParser;
 import org.commonmark.parser.SourceLine;
 import org.commonmark.parser.SourceLines;
@@ -28,12 +26,10 @@ public class AlertBlockParser extends AbstractBlockParser {
     private static final Pattern ALERT_PATTERN_CUSTOM_TITLE = Pattern.compile("^\\[!([a-zA-Z]+)](.*)$");
 
     private final Alert block;
-    private final String typeOriginalCase;
     private final String titleContent;
 
-    private AlertBlockParser(String type, String typeOriginalCase, String titleContent) {
+    private AlertBlockParser(String type, String titleContent) {
         this.block = new Alert(type);
-        this.typeOriginalCase = typeOriginalCase;
         this.titleContent = titleContent;
     }
 
@@ -76,16 +72,6 @@ public BlockContinue tryContinue(ParserState state) {
 
     @Override
     public void parseInlines(InlineParser inlineParser) {
-        // Determine if there is any non-title body content.
-        if (block.getFirstChild() == null) {
-            /*
-             * Replace the Alert with a BlockQuote whose only paragraph contains
-             * the original first line text.
-             */
-            demoteToBlockQuote(inlineParser);
-            return;
-        }
-
         if (titleContent.isEmpty()) {
             return;
         }
@@ -104,28 +90,6 @@ public void parseInlines(InlineParser inlineParser) {
         block.prependChild(titleNode);
     }
 
-    private void demoteToBlockQuote(InlineParser inlineParser) {
-        var bq = new BlockQuote();
-        bq.setSourceSpans(block.getSourceSpans());
-        var p = new Paragraph();
-
-        // Build the literal text including the alert marker and title.
-        var literal = "[!" + typeOriginalCase + "]";
-        if (!titleContent.isEmpty()) {
-            /*
-             * This may not preserve the original number of spaces between the
-             * alert marker and title (e.g., if there were 0 or 2+ spaces).
-             */
-            literal += " " + titleContent;
-        }
-
-        // Parse the inlines of the full content (alert marker + title)
-        inlineParser.parse(SourceLines.of(SourceLine.of(literal, null)), p);
-        bq.appendChild(p);
-        block.insertAfter(bq);
-        block.unlink();
-    }
-
     public static class Factory extends AbstractBlockParserFactory {
 
         private final Set<String> allowedTypes;
@@ -212,8 +176,7 @@ private BlockStart tryStartFresh(CharSequence line, int nextNonSpace, ParserStat
                 return BlockStart.none();
             }
 
-            var typeOriginalCase = matcher.group(1);
-            var type = typeOriginalCase.toUpperCase(Locale.ROOT);
+            var type = matcher.group(1).toUpperCase(Locale.ROOT);
             if (!allowedTypes.contains(type)) {
                 return BlockStart.none();
             }
@@ -224,7 +187,7 @@ private BlockStart tryStartFresh(CharSequence line, int nextNonSpace, ParserStat
             }
 
             // Consume the rest of the first line.
-            var start = BlockStart.of(new AlertBlockParser(type, typeOriginalCase, titleContent)).atIndex(line.length());
+            var start = BlockStart.of(new AlertBlockParser(type, titleContent)).atIndex(line.length());
 
             // If we got here via the promotion path, replace the empty BlockQuote.
             var matched = state.getActiveBlockParser().getBlock();

commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTest.java

@@ -214,19 +214,19 @@ public void customTitleIgnoresBlockContent() {
 
     @Test
     public void customTitleNoBody() {
-        // Inlines should be parsed as usual after falling back to a block quote.
+        // Alerts with no body are allowed.
         assertRenderingCustomTitles("> [!NOTE] Custom _title_\n>  \n>\n>",
-                "<blockquote>\n" +
-                "<p>[!NOTE] Custom <em>title</em></p>\n" +
-                "</blockquote>\n");
+                "<div class=\"markdown-alert markdown-alert-note\" data-alert-type=\"note\">\n" +
+                "<p class=\"markdown-alert-title\">Custom <em>title</em></p>\n" +
+                "</div>\n");
     }
 
     @Test
     public void customTitleNoBodyNoSpace() {
-        assertRenderingCustomTitles("> [!NOTE] Custom _title_\n>  \n>\n>",
-                "<blockquote>\n" +
-                "<p>[!NOTE] Custom <em>title</em></p>\n" +
-                "</blockquote>\n");
+        assertRenderingCustomTitles("> [!NOTE] Custom _title_",
+                "<div class=\"markdown-alert markdown-alert-note\" data-alert-type=\"note\">\n" +
+                "<p class=\"markdown-alert-title\">Custom <em>title</em></p>\n" +
+                "</div>\n");
     }
 
     @Test
@@ -252,18 +252,18 @@ public void onlyHtmlCommentsInTitleUseDefaultTitle() {
     @Test
     public void noLazyContinuationAfterMarker() {
         assertRendering("> [!NOTE]\nBody text",
-                "<blockquote>\n" +
-                "<p>[!NOTE]</p>\n" +
-                "</blockquote>\n" +
+                "<div class=\"markdown-alert markdown-alert-note\" data-alert-type=\"note\">\n" +
+                "<p class=\"markdown-alert-title\">Note</p>\n" +
+                "</div>\n" +
                 "<p>Body text</p>\n");
     }
 
     @Test
     public void noLazyContinuationAfterTitle() {
         assertRenderingCustomTitles("> [!NOTE] Custom title\nBody text",
-                "<blockquote>\n" +
-                "<p>[!NOTE] Custom title</p>\n" +
-                "</blockquote>\n" +
+                "<div class=\"markdown-alert markdown-alert-note\" data-alert-type=\"note\">\n" +
+                "<p class=\"markdown-alert-title\">Custom title</p>\n" +
+                "</div>\n" +
                 "<p>Body text</p>\n");
     }
 

commonmark-ext-gfm-alerts/src/test/resources/alerts-spec-template.md

@@ -134,20 +134,6 @@ Unconfigured custom type is not an alert:
 > Should be blockquote
 ````````````````````````````````
 
-Marker with no content:
-
-```````````````````````````````` example alert
-> [!NOTE]
-````````````````````````````````
-
-Whitespace-only content after marker:
-
-```````````````````````````````` example alert
-> [!TIP]
->   
->  
-````````````````````````````````
-
 Extra space inside marker:
 
 ```````````````````````````````` example alert
@@ -198,14 +184,6 @@ Leading spaces before blockquote marker:
    > Content
 ````````````````````````````````
 
-Blank line after marker ends the blockquote (not an alert):
-
-```````````````````````````````` example alert
-> [!NOTE]
-
-Some text
-````````````````````````````````
-
 Alert followed by blockquote:
 
 ```````````````````````````````` example alert

commonmark-ext-gfm-alerts/src/test/resources/alerts-spec.txt

@@ -236,28 +236,6 @@ Should be blockquote</p>
 </blockquote>
 ````````````````````````````````
 
-Marker with no content:
-
-```````````````````````````````` example alert
-> [!NOTE]
-.
-<blockquote>
-<p>[!NOTE]</p>
-</blockquote>
-````````````````````````````````
-
-Whitespace-only content after marker:
-
-```````````````````````````````` example alert
-> [!TIP]
->   
->  
-.
-<blockquote>
-<p>[!TIP]</p>
-</blockquote>
-````````````````````````````````
-
 Extra space inside marker:
 
 ```````````````````````````````` example alert
@@ -309,7 +287,7 @@ Regular blockquote is not affected:
 Trailing spaces after marker:
 
 ```````````````````````````````` example alert
-> [!NOTE]  
+> [!NOTE]
 > This is a note
 .
 <div class="markdown-alert markdown-alert-note" data-alert-type="note">
@@ -342,19 +320,6 @@ Leading spaces before blockquote marker:
 </div>
 ````````````````````````````````
 
-Blank line after marker ends the blockquote (not an alert):
-
-```````````````````````````````` example alert
-> [!NOTE]
-
-Some text
-.
-<blockquote>
-<p>[!NOTE]</p>
-</blockquote>
-<p>Some text</p>
-````````````````````````````````
-
 Alert followed by blockquote:
 
 ```````````````````````````````` example alert