From 9ea886b5ffa257b4938d16099276ed92e2cd46e9 Mon Sep 17 00:00:00 2001
From: Cristian Maglie <c.maglie@arduino.cc>
Date: Tue, 4 Jun 2024 16:38:13 +0200
Subject: [PATCH] SplitQuotedString always returns a result

If the function finds an opening quote character and does not find the
closing quote character, it will return an error.

Previously, in case of error, the returned split array was always empty.

Now, in any case, the function will return the split array up to the
point where the error occurred.
---
 strings.go      | 26 +++++++++++++++++++++++---
 strings_test.go | 11 +++++++----
 2 files changed, 30 insertions(+), 7 deletions(-)

diff --git a/strings.go b/strings.go
index f64b15e..4eae333 100644
--- a/strings.go
+++ b/strings.go
@@ -39,9 +39,29 @@ import (
 // to use spaces in a single element of the split using quote characters.
 //
 // For example the call:
-//   SplitQuotedString(`This 'is an' "Hello World!" example`, `'"`, false)
+//
+//	SplitQuotedString(`This 'is an' "Hello World!" example`, `'"`, false)
+//
 // returns the following array:
-//   []string{"This", "is an", "Hello World!", "example"}
+//
+//	[]string{"This", "is an", "Hello World!", "example"}
+//
+// The quoteChars parameter is a string containing all the characters that
+// are considered as quote characters. If a quote character is found, the
+// function will consider the text between the quote character and the next
+// quote character as a single element of the split.
+//
+// The acceptEmptyArguments parameter is a boolean that indicates if the
+// function should consider empty arguments as valid elements of the split.
+// If set to false, the function will ignore empty arguments.
+//
+// If the function finds an opening quote character and does not find the
+// closing quote character, it will return an error. In any case, the function
+// will return the split array up to the point where the error occurred.
+//
+// The function does not support escaping of quote characters.
+//
+// The function is UTF-8 safe.
 func SplitQuotedString(src string, quoteChars string, acceptEmptyArguments bool) ([]string, error) {
 	// Make a map of valid quote runes
 	isQuote := map[rune]bool{}
@@ -83,7 +103,7 @@ func SplitQuotedString(src string, quoteChars string, acceptEmptyArguments bool)
 	}
 
 	if escapingChar != 0 {
-		return nil, fmt.Errorf("invalid quoting, no closing `%c` char found", escapingChar)
+		return result, fmt.Errorf("invalid quoting, no closing `%c` char found", escapingChar)
 	}
 
 	return result, nil
diff --git a/strings_test.go b/strings_test.go
index 2f5319d..9245f04 100644
--- a/strings_test.go
+++ b/strings_test.go
@@ -64,8 +64,11 @@ func TestSplitQuotedStringWithUTF8(t *testing.T) {
 }
 
 func TestSplitQuotedStringInvalid(t *testing.T) {
-	_, err := SplitQuotedString(`'this is' a 'test of quoting`, `"'`, true)
-	require.Error(t, err)
-	_, err = SplitQuotedString(`'this is' a "'test" of "quoting`, `"'`, true)
-	require.Error(t, err)
+	res, err := SplitQuotedString(`'this is' a 'test of quoting`, `"'`, true)
+	require.EqualError(t, err, "invalid quoting, no closing `'` char found")
+	require.Equal(t, res, []string{"this is", "a"})
+
+	res, err = SplitQuotedString(`'this is' a "'test" of "quoting`, `"'`, true)
+	require.EqualError(t, err, "invalid quoting, no closing `\"` char found")
+	require.Equal(t, res, []string{"this is", "a", "'test", "of"})
 }