refactor: consider a space as the footer separator token

Author: lppedd

src/main/kotlin/com/github/lppedd/cc/parser/ConventionalCommitParser.kt

@@ -105,7 +105,7 @@ internal fun parseConventionalCommit(message: String, lenient: Boolean = false):
   while (reader.current?.type == CCToken.Type.FOOTER_TYPE) {
     val footerType = reader.takeAndAdvance()
 
-    // Consume/skip the separator, if present
+    // Consume/skip the separator (':' or ' '), if present
     reader.consume(CCToken.Type.SEPARATOR)
 
     // Allow a missing footer value, even in non-lenient mode

src/main/kotlin/com/github/lppedd/cc/parser/strictConventionalCommit.flex

@@ -29,16 +29,29 @@ package com.github.lppedd.cc.parser;
     return value;
   }
 
-  private int getWsPushback() {
-    final int length = yylength();
+  private int getFooterTypePushback() {
+    int i = yylength() - 1;
+    int pushback = 0;
 
-    for (int i = length - 1, count = 0; i >= 0; i--, count++) {
-      if (!Character.isWhitespace(yycharat(i))) {
-        return count;
+    // Push back trailing whitespace
+    for (; i >= 0 && Character.isWhitespace(yycharat(i)); i--, pushback++);
+
+    // Check whether we now have a trailing '#'
+    while (i >= 0 && yycharat(i) == '#') {
+      // If '#' is attached (e.g., 'Something#'), keep it as part of the type and stop
+      if (i - 1 >= 0 && !Character.isWhitespace(yycharat(i - 1))) {
+        break;
       }
+
+      // Since the '#' char is preceeded by a whitespace, push it back
+      i--;
+      pushback++;
+
+      // Push back any whitespace before the '#' we have just encountered
+      for (; i >= 0 && Character.isWhitespace(yycharat(i)); i--, pushback++);
     }
 
-    return length;
+    return pushback;
   }
 
   private CCToken token(final CCToken.Type type) {
@@ -66,6 +79,7 @@ FooterType  = [^\s:][^:\r\n]*
 %state BODY_OR_FOOTERS
 %state BODY
 %state FOOTERS
+%state FOOTER_HASH_SEPARATOR
 %state FOOTER_VALUE
 
 %%
@@ -136,9 +150,9 @@ FooterType  = [^\s:][^:\r\n]*
 
       // Closes #16
       ^{FooterType}{WS} / #.* {
-        // Push back any terminating whitespace, which should be part of the footer value instead
-        yypushback(getWsPushback());
-        yybegin(FOOTER_VALUE);
+        // Push back any trailing whitespace or '#'
+        yypushback(getFooterTypePushback());
+        yybegin(FOOTER_HASH_SEPARATOR);
         return token(CCToken.Type.FOOTER_TYPE);
       }
 
@@ -181,9 +195,9 @@ FooterType  = [^\s:][^:\r\n]*
 
       // Closes #16
       ^{FooterType}{WS} / #.* {
-        // Push back any terminating whitespace, which should be part of the footer value instead
-        yypushback(getWsPushback());
-        yybegin(FOOTER_VALUE);
+        // Push back any trailing whitespace or '#'
+        yypushback(getFooterTypePushback());
+        yybegin(FOOTER_HASH_SEPARATOR);
         return token(CCToken.Type.FOOTER_TYPE);
       }
 
@@ -201,6 +215,15 @@ FooterType  = [^\s:][^:\r\n]*
       }
 }
 
+<FOOTER_HASH_SEPARATOR> {
+      // Lex exactly one whitespace as the footer separator token ' '.
+      // Additional whitespace will be lexed as part of the footer value.
+      {WS} {
+        yybegin(FOOTER_VALUE);
+        return token(CCToken.Type.SEPARATOR);
+      }
+}
+
 <FOOTER_VALUE> {
       // Closes #16           | .+
       //  multiline footer    | ({NewLine}{Space}+([^\s]+{Space}*)+)*

src/test/kotlin/com/github/lppedd/cc/parser/ConventionalCommitParserTest.kt

@@ -166,6 +166,7 @@ class ConventionalCommitParserTest {
       |
       |Closes: example 1
       |Fixes   #12
+      |Fixes  #  # #12
       |[Author]   
       |Refs: example 2
       """.trimMargin()
@@ -177,7 +178,7 @@ class ConventionalCommitParserTest {
     assertEquals("refactor", message.type)
     assertEquals("scope", message.scope)
     assertEquals("foo", message.subject.trim())
-    assertEquals(4, message.footers.size)
+    assertEquals(5, message.footers.size)
 
     val (type1, value1) = message.footers[0]
     assertEquals("Closes", type1)
@@ -188,12 +189,16 @@ class ConventionalCommitParserTest {
     assertEquals("#12", value2.trim())
 
     val (type3, value3) = message.footers[2]
-    assertEquals("[Author]   ", type3)
-    assertEquals("", value3)
+    assertEquals("Fixes", type3)
+    assertEquals("#  # #12", value3.trim())
 
     val (type4, value4) = message.footers[3]
-    assertEquals("Refs", type4)
-    assertEquals("example 2", value4.trim())
+    assertEquals("[Author]   ", type4)
+    assertEquals("", value4)
+
+    val (type5, value5) = message.footers[4]
+    assertEquals("Refs", type5)
+    assertEquals("example 2", value5.trim())
 
     assertFalse(message.isBreakingChange)
   }