Pass template values in a struct rather than as individual arguments

This makes it easier to add more template strings in the future without changing the function signature

Author: ddworken

src/keybaseca/bot/bot.go

@@ -150,11 +150,17 @@ func isConfiguredTeam(conf config.Config, teamName string, channelName string) b
 	return false
 }
 
-func buildAnnouncement(template, username, currentTeam string, teams []string) string {
+type AnnouncementTemplateValues struct {
+	Username    string
+	CurrentTeam string
+	Teams       []string
+}
+
+func buildAnnouncement(template string, values AnnouncementTemplateValues) string {
 	replacements := map[string]string{
-		"{USERNAME}":     username,
-		"{CURRENT_TEAM}": currentTeam,
-		"{TEAMS}":        strings.Join(teams, ", "),
+		"{USERNAME}":     values.Username,
+		"{CURRENT_TEAM}": values.CurrentTeam,
+		"{TEAMS}":        strings.Join(values.Teams, ", "),
 	}
 
 	templatedMessage := template
@@ -171,7 +177,10 @@ func sendAnnouncementMessage(conf config.Config, kbc *kbchat.API) error {
 		return nil
 	}
 	for _, team := range conf.GetTeams() {
-		announcement := buildAnnouncement(conf.GetAnnouncement(), kbc.GetUsername(), team, conf.GetTeams())
+		announcement := buildAnnouncement(conf.GetAnnouncement(),
+			AnnouncementTemplateValues{Username: kbc.GetUsername(),
+				CurrentTeam: team,
+				Teams:       conf.GetTeams()})
 
 		var channel *string
 		_, err := kbc.SendMessageByTeamName(team, announcement, channel)

src/keybaseca/bot/bot_test.go

@@ -7,16 +7,18 @@ import (
 )
 
 func TestBuildAnnouncement(t *testing.T) {
+	values := AnnouncementTemplateValues{Username: "my_username", CurrentTeam: "my_cur_team", Teams: []string{"my_team1", "my_team2"}}
+
 	require.Equal(t, "",
-		buildAnnouncement("", "my_username", "my_cur_team", []string{"my_team1", "my_team2"}))
+		buildAnnouncement("", values))
 	require.Equal(t, "no templates",
-		buildAnnouncement("no templates", "my_username", "my_cur_team", []string{"my_team1", "my_team2"}))
+		buildAnnouncement("no templates", values))
 	require.Equal(t, "repeated my_username my_username my_username",
-		buildAnnouncement("repeated {USERNAME} {USERNAME} {USERNAME}", "my_username", "my_cur_team", []string{"my_team1", "my_team2"}))
+		buildAnnouncement("repeated {USERNAME} {USERNAME} {USERNAME}", values))
 	require.Equal(t, "all my_username my_cur_team my_team1, my_team2",
-		buildAnnouncement("all {USERNAME} {CURRENT_TEAM} {TEAMS}", "my_username", "my_cur_team", []string{"my_team1", "my_team2"}))
+		buildAnnouncement("all {USERNAME} {CURRENT_TEAM} {TEAMS}", values))
 	require.Equal(t, "bogus {FOO}",
-		buildAnnouncement("bogus {FOO}", "my_username", "my_cur_team", []string{"my_team1", "my_team2"}))
+		buildAnnouncement("bogus {FOO}", values))
 	require.Equal(t, "double-is-not-escape {my_username}",
-		buildAnnouncement("double-is-not-escape {{USERNAME}}", "my_username", "my_cur_team", []string{"my_team1", "my_team2"}))
+		buildAnnouncement("double-is-not-escape {{USERNAME}}", values))
 }