compiler/go!: align initialisms with revive

Keep generated identifiers consistent with revive by recognizing ACL, SQL, XMPP, and plural IDs. Consumers regenerating fields containing these words must update references to the new Go names.

Author: AlexisMontagne

compiler/cpp/src/thrift/generate/t_go_generator.cc

@@ -501,7 +501,7 @@ void t_go_generator::fix_common_initialism(std::string& value, int i) const {
     std::string word = value.substr(i, wordLen);
     std::transform(word.begin(), word.end(), word.begin(), ::toupper);
     if (commonInitialisms.find(word) != commonInitialisms.end()) {
-      value.replace(i, word.length(), word);
+      value.replace(i, word.length(), word == "IDS" ? "IDs" : word);
     }
   }
 }
@@ -716,7 +716,8 @@ void t_go_generator::init_generator() {
   string target = module;
   package_dir_ = get_out_dir();
 
-  // This set is taken from https://github.com/golang/lint/blob/master/lint.go#L692
+  // This set is mirrored from https://github.com/mgechev/revive/blob/master/internal/rule/name.go.
+  commonInitialisms.insert("ACL");
   commonInitialisms.insert("API");
   commonInitialisms.insert("ASCII");
   commonInitialisms.insert("CPU");
@@ -728,6 +729,7 @@ void t_go_generator::init_generator() {
   commonInitialisms.insert("HTTP");
   commonInitialisms.insert("HTTPS");
   commonInitialisms.insert("ID");
+  commonInitialisms.insert("IDS");
   commonInitialisms.insert("IP");
   commonInitialisms.insert("JSON");
   commonInitialisms.insert("LHS");
@@ -737,6 +739,7 @@ void t_go_generator::init_generator() {
   commonInitialisms.insert("RPC");
   commonInitialisms.insert("SLA");
   commonInitialisms.insert("SMTP");
+  commonInitialisms.insert("SQL");
   commonInitialisms.insert("SSH");
   commonInitialisms.insert("TCP");
   commonInitialisms.insert("TLS");
@@ -750,6 +753,7 @@ void t_go_generator::init_generator() {
   commonInitialisms.insert("UTF8");
   commonInitialisms.insert("VM");
   commonInitialisms.insert("XML");
+  commonInitialisms.insert("XMPP");
   commonInitialisms.insert("XSRF");
   commonInitialisms.insert("XSS");
 

lib/go/test/InitialismsTest.thrift

@@ -20,5 +20,10 @@
 struct InitialismsTest {
     1: string user_id,
     2: string server_url,
-    3: string id, 
+    3: string id,
+    4: string acl,
+    5: string ids,
+    6: string sql,
+    7: string xmpp,
+    8: string user_ids,
 }

lib/go/test/tests/initialisms_test.go

@@ -47,6 +47,26 @@ func TestThatCommonInitialismsAreFixed(t *testing.T) {
 			name:          "ID",
 			haveFieldName: "ID",
 		},
+		{
+			name:          "ACL",
+			haveFieldName: "ACL",
+		},
+		{
+			name:          "IDs",
+			haveFieldName: "IDs",
+		},
+		{
+			name:          "SQL",
+			haveFieldName: "SQL",
+		},
+		{
+			name:          "XMPP",
+			haveFieldName: "XMPP",
+		},
+		{
+			name:          "UserIDs",
+			haveFieldName: "UserIDs",
+		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			_, ok := st.FieldByName(tc.haveFieldName)

lib/go/thrift/types/gocodegen/camelize.go

@@ -6,9 +6,10 @@ import (
 )
 
 // commonInitialisms is the set of well-known Go initialisms taken from
-// https://github.com/golang/lint/blob/master/lint.go#L692 and mirrored in
+// https://github.com/mgechev/revive/blob/master/internal/rule/name.go and mirrored in
 // compiler/cpp/src/thrift/generate/t_go_generator.cc.
 var commonInitialisms = map[string]struct{}{
+	"ACL":   {},
 	"API":   {},
 	"ASCII": {},
 	"CPU":   {},
@@ -20,6 +21,7 @@ var commonInitialisms = map[string]struct{}{
 	"HTTP":  {},
 	"HTTPS": {},
 	"ID":    {},
+	"IDS":   {},
 	"IP":    {},
 	"JSON":  {},
 	"LHS":   {},
@@ -29,6 +31,7 @@ var commonInitialisms = map[string]struct{}{
 	"RPC":   {},
 	"SLA":   {},
 	"SMTP":  {},
+	"SQL":   {},
 	"SSH":   {},
 	"TCP":   {},
 	"TLS":   {},
@@ -42,6 +45,7 @@ var commonInitialisms = map[string]struct{}{
 	"UTF8":  {},
 	"VM":    {},
 	"XML":   {},
+	"XMPP":  {},
 	"XSRF":  {},
 	"XSS":   {},
 }
@@ -129,6 +133,8 @@ func camelize(s string, public bool) string {
 			if i == 0 && !public {
 				// First word, private: keep fully lowercase.
 				b.WriteString(strings.ToLower(part))
+			} else if upper == "IDS" {
+				b.WriteString("IDs")
 			} else {
 				b.WriteString(upper)
 			}

lib/go/thrift/types/gocodegen/camelize_test.go

@@ -37,6 +37,16 @@ func TestPublicize(t *testing.T) {
 			have: "id",
 			want: "ID",
 		},
+		{
+			name: "plural IDs",
+			have: "user_ids",
+			want: "UserIDs",
+		},
+		{
+			name: "revive initialisms",
+			have: "acl_sql_xmpp",
+			want: "ACLSQLXMPP",
+		},
 		{
 			name: "trailing underscore ignored",
 			have: "foo_",
@@ -105,11 +115,21 @@ func TestPrivatize(t *testing.T) {
 			have: "id",
 			want: "id",
 		},
+		{
+			name: "plural IDs at start",
+			have: "ids_for_user",
+			want: "idsForUser",
+		},
 		{
 			name: "initialism only in second word",
 			have: "some_id",
 			want: "someID",
 		},
+		{
+			name: "plural IDs in second word",
+			have: "some_ids",
+			want: "someIDs",
+		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			assert.Equal(t, tc.want, Privatize(tc.have))