👔 up(str): update the SplitInlineComment() logic

- fix: textscan parse url as comments error
gookit · Feb 6, 2023 · 31445cd · 31445cd
1 parent 9eaddb5
commit 31445cd
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 24 deletions.
diff --git a/strutil/convert.go b/strutil/convert.go
@@ -92,6 +92,11 @@ func String(val any) (string, error) {
 	return AnyToString(val, true)
 }
 
+// ToString convert value to string
+func ToString(val any) (string, error) {
+	return AnyToString(val, true)
+}
+
 // QuietString convert value to string, will ignore error
 func QuietString(in any) string {
 	val, _ := AnyToString(in, false)
@@ -109,11 +114,6 @@ func StringOrErr(val any) (string, error) {
 	return AnyToString(val, true)
 }
 
-// ToString convert value to string
-func ToString(val any) (string, error) {
-	return AnyToString(val, true)
-}
-
 // AnyToString convert value to string.
 //
 // if defaultAsErr:

diff --git a/strutil/split.go b/strutil/split.go
@@ -123,15 +123,27 @@ func Substr(s string, pos, length int) string {
 	return string(runes[pos:stopIdx])
 }
 
-// SplitInlineComment for a text string.
-func SplitInlineComment(val string) (string, string) {
-	if pos := strings.IndexByte(val, '#'); pos > -1 {
-		return strings.TrimRight(val[0:pos], " "), val[pos:]
-	}
+// SplitInlineComment for an inline text string.
+func SplitInlineComment(val string, strict ...bool) (string, string) {
+	// strict check: must with space
+	if len(strict) > 0 && strict[0] {
+		if pos := strings.Index(val, " #"); pos > -1 {
+			return strings.TrimRight(val[0:pos], " "), val[pos+1:]
+		}
 
-	if pos := strings.Index(val, "//"); pos > -1 {
-		return strings.TrimRight(val[0:pos], " "), val[pos:]
+		if pos := strings.Index(val, " //"); pos > -1 {
+			return strings.TrimRight(val[0:pos], " "), val[pos+1:]
+		}
+	} else {
+		if pos := strings.IndexByte(val, '#'); pos > -1 {
+			return strings.TrimRight(val[0:pos], " "), val[pos:]
+		}
+
+		if pos := strings.Index(val, "//"); pos > -1 {
+			return strings.TrimRight(val[0:pos], " "), val[pos:]
+		}
 	}
+
 	return val, ""
 }
 

diff --git a/strutil/split_test.go b/strutil/split_test.go
@@ -86,15 +86,69 @@ func TestSubstr(t *testing.T) {
 }
 
 func TestSplitInlineComment(t *testing.T) {
-	val, comment := strutil.SplitInlineComment("value0")
-	assert.Eq(t, "value0", val)
-	assert.Eq(t, "", comment)
-
-	val, comment = strutil.SplitInlineComment("value0 // comments at end")
-	assert.Eq(t, "value0", val)
-	assert.Eq(t, "// comments at end", comment)
-
-	val, comment = strutil.SplitInlineComment("value0 # comments at end")
-	assert.Eq(t, "value0", val)
-	assert.Eq(t, "# comments at end", comment)
+	tests := []struct {
+		str    string
+		val    string
+		cmt    string
+		strict bool
+	}{
+		{
+			str: "value",
+			val: "value",
+		},
+		{
+			str: "value // comments at end",
+			val: "value",
+			cmt: "// comments at end",
+		},
+		{
+			str:    "value // comments at end",
+			val:    "value",
+			cmt:    "// comments at end",
+			strict: true,
+		},
+		{
+			str: "value// comments at end",
+			val: "value",
+			cmt: "// comments at end",
+		},
+		{
+			str:    "value// comments at end",
+			val:    "value// comments at end",
+			strict: true,
+		},
+		{
+			str: "value # comments at end",
+			val: "value",
+			cmt: "# comments at end",
+		},
+		{
+			str:    "value # comments at end",
+			val:    "value",
+			cmt:    "# comments at end",
+			strict: true,
+		},
+		{
+			str: "value# comments at end",
+			val: "value",
+			cmt: "# comments at end",
+		},
+		{
+			str:    "value# comments at end",
+			val:    "value# comments at end",
+			strict: true,
+		},
+	}
+
+	for i, tt := range tests {
+		idx := strutil.QuietString(i)
+		val, comment := strutil.SplitInlineComment(tt.str+idx, tt.strict)
+		if comment == "" {
+			assert.Eq(t, tt.val+idx, val)
+			assert.Eq(t, tt.cmt, comment)
+		} else {
+			assert.Eq(t, tt.val, val)
+			assert.Eq(t, tt.cmt+idx, comment)
+		}
+	}
 }
diff --git a/strutil/textscan/kvparse.go b/strutil/textscan/kvparse.go
@@ -127,7 +127,7 @@ func (m *KeyValueMatcher) inlineCommentsAndUnquote(vt *ValueToken, val string) s
 	if m.InlineComment {
 		// split inline comments
 		var comment string
-		val, comment = strutil.SplitInlineComment(val)
+		val, comment = strutil.SplitInlineComment(val, true)
 
 		if len(comment) > 0 {
 			cmt := NewCommentToken(comment)