Limit whitespace to after : and , for named args

Author: jpbetz

v2/codetags/parser.go

@@ -142,17 +142,16 @@ func RawValues(enabled bool) ParseOption {
 	}
 }
 
-const (
-	stTag           = "stTag"
-	stMaybeArgs     = "stMaybeArgs"
-	stArg           = "stArg"
-	stArgEndOfToken = "stArgEndOfToken"
-	stMaybeValue    = "stMaybeValue"
-	stValue         = "stValue"
-	stMaybeComment  = "stMaybeComment"
-)
-
 func parseTag(input string, opts parseOpts) (Tag, error) {
+	const (
+		stTag           = "stTag"
+		stMaybeArgs     = "stMaybeArgs"
+		stArg           = "stArg"
+		stArgEndOfToken = "stArgEndOfToken"
+		stMaybeValue    = "stMaybeValue"
+		stValue         = "stValue"
+		stMaybeComment  = "stMaybeComment"
+	)
 	var startTag, endTag *Tag // both ends of the chain when parsing chained tags
 
 	// accumulators
@@ -216,7 +215,7 @@ func parseTag(input string, opts parseOpts) (Tag, error) {
 	var err error
 	st := stTag
 parseLoop:
-	for r := s.skipWhitespacePeek(); r != EOF; r = s.skipWhitespacePeek() {
+	for r := s.peek(); r != EOF; r = s.peek() {
 		switch st {
 		case stTag:
 			switch {
@@ -276,10 +275,14 @@ parseLoop:
 
 				switch {
 				case r == ',' || r == ')': // positional arg
+					if r == ',' {
+						r = s.skipWhitespace() // allow whitespace after ,
+					}
 					saveBoolOrString(identifier)
 					st = stArgEndOfToken
 				case r == ':': // named arg
-					s.next() // consume :
+					s.next()               // consume :
+					r = s.skipWhitespace() // allow whitespace after :
 					saveName(identifier)
 					st = stArg
 				default:
@@ -291,7 +294,8 @@ parseLoop:
 		case stArgEndOfToken:
 			switch {
 			case r == ',':
-				s.next() // consume ,
+				s.next()               // consume ,
+				r = s.skipWhitespace() // allow whitespace after ,
 				st = stArg
 			case r == ')':
 				s.next() // consume )
@@ -363,7 +367,7 @@ parseLoop:
 			}
 		case stMaybeComment:
 			switch {
-			case r == '/' && s.peekN(1) == '/':
+			case s.nextIsTrailingComment():
 				s.remainder()
 			default:
 				break parseLoop

v2/codetags/parser_test.go

@@ -67,6 +67,11 @@ func TestParse(t *testing.T) {
 			input:  "name // comment",
 			expect: mkt("name"),
 		},
+		{
+			name:   "name with comment after extra spaces",
+			input:  "name \t // comment",
+			expect: mkt("name"),
+		},
 		{
 			name:   "name with dash",
 			input:  "name-dash",
@@ -89,6 +94,16 @@ func TestParse(t *testing.T) {
 			input:     "name=",
 			wantError: "unexpected end of input",
 		},
+		{
+			name:      "space before =",
+			input:     "name =x",
+			wantError: "unexpected character ' '",
+		},
+		{
+			name:      "space after =",
+			input:     "name= x",
+			wantError: "unexpected character ' '",
+		},
 
 		// String arguments tests
 		{
@@ -203,6 +218,51 @@ func TestParse(t *testing.T) {
 			input:     "name=+badRaw(missing`)",
 			wantError: "unexpected character '`'",
 		},
+		{
+			name:      "space before (",
+			input:     "name ()",
+			wantError: "unexpected character ' '",
+		},
+		{
+			name:      "space between ( and )",
+			input:     "name ( )",
+			wantError: "unexpected character ' '",
+		},
+		{
+			name:      "space before arg",
+			input:     "name( x)",
+			wantError: "unexpected character ' '",
+		},
+		{
+			name:      "space after arg",
+			input:     "name(x )",
+			wantError: "unexpected character ' '",
+		},
+		{
+			name:      "space before :",
+			input:     "name(k :v)",
+			wantError: "unexpected character ' '",
+		},
+		{
+			name:      "space before value",
+			input:     "name(k:v )",
+			wantError: "unexpected character ' '",
+		},
+		{
+			name:      "space before ,",
+			input:     "name(k:v ,k2:v2)",
+			wantError: "unexpected character ' '",
+		},
+		{
+			name:      "space before =",
+			input:     "name() =x",
+			wantError: "unexpected character ' '",
+		},
+		{
+			name:      "space after =",
+			input:     "name()= x",
+			wantError: "unexpected character ' '",
+		},
 
 		// Named arguments tests
 		{
@@ -311,7 +371,7 @@ func TestParse(t *testing.T) {
 		{
 			name:      "space in value",
 			input:     "key=one two",
-			wantError: "unexpected character 't'",
+			wantError: "unexpected character ' '",
 		},
 		{
 			name:      "unclosed backtick quoted string",

v2/codetags/scanner.go

@@ -49,18 +49,28 @@ func (s *scanner) peekN(n int) rune {
 	return s.buf[s.pos+n]
 }
 
-func (s *scanner) skipWhitespace() bool {
-	found := false
+func (s *scanner) skipWhitespace() rune {
 	for r := s.peek(); unicode.IsSpace(r); r = s.peek() {
 		s.next()
-		found = true
 	}
-	return found
+	return s.peek()
 }
 
-func (s *scanner) skipWhitespacePeek() rune {
-	s.skipWhitespace()
-	return s.peek()
+func (s *scanner) nextIsTrailingComment() bool {
+	if s.pos >= len(s.buf)-1 {
+		return false
+	}
+	for i := s.pos; i < len(s.buf)-1; i++ {
+		switch {
+		case unicode.IsSpace(s.buf[i]):
+			continue
+		case s.buf[i] == '/' && s.buf[i+1] == '/':
+			return true
+		default:
+			return false
+		}
+	}
+	return false
 }
 
 func (s *scanner) remainder() string {