Fix autofix mode for non-latin comments.

tetafro · May 16, 2020 · 4e037ac · 4e037ac
1 parent d40d72a
commit 4e037ac
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 3 deletions.
diff --git a/godot.go b/godot.go
@@ -162,7 +162,7 @@ func check(fset *token.FileSet, group *ast.CommentGroup) (iss Issue, ok bool) {
 func checkComment(comment string) (pos position, ok bool) {
 	// Check last line of "//"-comment
 	if strings.HasPrefix(comment, "//") {
-		pos.column = len(comment)
+		pos.column = len([]rune(comment)) // runes for non-latin chars
 		comment = strings.TrimPrefix(comment, "//")
 		if checkLastChar(comment) {
 			return position{}, true
@@ -189,7 +189,9 @@ func checkComment(comment string) (pos position, ok bool) {
 	comment = lines[i]
 	comment = strings.TrimSuffix(comment, "*/")
 	comment = strings.TrimRight(comment, " ")
-	pos.column = len(comment) // last non-space char in comment line
+	// Get position of the last non-space char in comment line, use runes
+	// in case of non-latin chars
+	pos.column = len([]rune(comment))
 	comment = strings.TrimPrefix(comment, "/*")
 
 	if checkLastChar(comment) {
@@ -238,6 +240,7 @@ func makeReplacement(s string, pos position) string {
 	line := []rune(lines[pos.line])
 	if len(line) < pos.column {
 		// This should never happen
+		println(s, len(line), pos.column)
 		return ""
 	}
 	// Insert a period

diff --git a/godot_test.go b/godot_test.go
@@ -119,6 +119,18 @@ func TestCheckComment(t *testing.T) {
 			ok:      true,
 			pos:     position{},
 		},
+		{
+			name:    "singleline comment: cyrillic, with period",
+			comment: "// Кириллица.",
+			ok:      true,
+			pos:     position{},
+		},
+		{
+			name:    "singleline comment: cyrillic, without period",
+			comment: "// Кириллица",
+			ok:      false,
+			pos:     position{line: 0, column: 12},
+		},
 		// Multiline comments
 		{
 			name:    "multiline comment: ok",
@@ -212,10 +224,22 @@ func TestCheckComment(t *testing.T) {
 		},
 		{
 			name:    "multiline comment: url at the end of line",
-			comment: "/*\n" + "Read more: http://example.com/" + "*/",
+			comment: "/*\n" + "Read more: http://example.com/\n" + "*/",
+			ok:      true,
+			pos:     position{},
+		},
+		{
+			name:    "multiline comment: cyrillic, with period",
+			comment: "/*\n" + "Кириллица.\n" + "*/",
 			ok:      true,
 			pos:     position{},
 		},
+		{
+			name:    "multiline comment: cyrillic, without period",
+			comment: "/*\n" + "Кириллица\n" + "*/",
+			ok:      false,
+			pos:     position{line: 1, column: 9},
+		},
 	}
 
 	for _, tt := range testCases {
@@ -254,6 +278,12 @@ func TestMakeReplacement(t *testing.T) {
 			pos:         position{line: 0, column: 3},
 			replacement: "//x.",
 		},
+		{
+			name:        "cyrillic singleline comment",
+			comment:     "// Привет, мир",
+			pos:         position{line: 0, column: 14},
+			replacement: "// Привет, мир.",
+		},
 		{
 			name:        "multiline comment",
 			comment:     "/*\n" + "Hello, world\n" + "*/",
@@ -272,6 +302,12 @@ func TestMakeReplacement(t *testing.T) {
 			pos:         position{line: 0, column: 15},
 			replacement: "/* Hello, world. */",
 		},
+		{
+			name:        "cyrillic multiline comment",
+			comment:     "/* Привет, мир */",
+			pos:         position{line: 0, column: 14},
+			replacement: "/* Привет, мир. */",
+		},
 	}
 
 	for _, tt := range testCases {

diff --git a/testdata/checkall/check/main.go b/testdata/checkall/check/main.go
@@ -83,6 +83,11 @@ func CgoExportedFunction(a, b int) int {
 	return a + b
 }
 
+// Кириллица FAIL
+func NonLatin() string {
+	return "привет, мир"
+}
+
 func noComment() {
 	cs := C.CString("Hello from stdio\n")
 	C.myprint(cs)

diff --git a/testdata/checkall/result/main.go b/testdata/checkall/result/main.go
@@ -83,6 +83,11 @@ func CgoExportedFunction(a, b int) int {
 	return a + b
 }
 
+// Кириллица FAIL.
+func NonLatin() string {
+	return "привет, мир"
+}
+
 func noComment() {
 	cs := C.CString("Hello from stdio\n")
 	C.myprint(cs)

diff --git a/testdata/default/check/main.go b/testdata/default/check/main.go
@@ -83,6 +83,11 @@ func CgoExportedFunction(a, b int) int {
 	return a + b
 }
 
+// Кириллица FAIL
+func NonLatin() string {
+	return "привет, мир"
+}
+
 func noComment() {
 	cs := C.CString("Hello from stdio\n")
 	C.myprint(cs)

diff --git a/testdata/default/result/main.go b/testdata/default/result/main.go
@@ -83,6 +83,11 @@ func CgoExportedFunction(a, b int) int {
 	return a + b
 }
 
+// Кириллица FAIL.
+func NonLatin() string {
+	return "привет, мир"
+}
+
 func noComment() {
 	cs := C.CString("Hello from stdio\n")
 	C.myprint(cs)