From 97f9f3660bcf38ca117a3b55c7a74b7decd49e30 Mon Sep 17 00:00:00 2001 From: Kichiyaki Date: Thu, 6 May 2021 15:25:09 +0200 Subject: [PATCH] rename the utils package --- README.md | 2 +- cron/cron.go | 4 +-- cron/ennoblements.go | 10 +++--- cron/handler.go | 36 ++++++++++---------- cron/helpers.go | 4 +-- cron/message.go | 12 +++---- discord/coords_translation.go | 6 ++-- discord/observations.go | 4 +-- {utils => tw/twutil}/find_version_by_code.go | 2 +- {utils => tw/twutil}/tribalwars.go | 2 +- 10 files changed, 41 insertions(+), 41 deletions(-) rename {utils => tw/twutil}/find_version_by_code.go (94%) rename {utils => tw/twutil}/tribalwars.go (95%) diff --git a/README.md b/README.md index 37cf84c..2798a13 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Features: ## Development -**Required env variables to run this bot:** +**Required ENV variables:** ``` DB_USER=your_pgdb_user diff --git a/cron/cron.go b/cron/cron.go index 657d101..1c73297 100644 --- a/cron/cron.go +++ b/cron/cron.go @@ -39,8 +39,8 @@ func Attach(c *cron.Cron, cfg Config) { checkEnnoblements := trackDuration(log, h.checkEnnoblements, "checkEnnoblements") checkBotServers := trackDuration(log, h.checkBotServers, "checkBotServers") deleteClosedTribalWarsServers := trackDuration(log, - h.deleteClosedTribalWarsServers, - "deleteClosedTribalWarsServers") + h.deleteClosedTWServers, + "deleteClosedTWServers") updateBotStatus := trackDuration(log, h.updateBotStatus, "updateBotStatus") c.AddFunc("@every 1m", checkEnnoblements) c.AddFunc("@every 30m", checkBotServers) diff --git a/cron/ennoblements.go b/cron/ennoblements.go index 14f1d38..c970cd5 100644 --- a/cron/ennoblements.go +++ b/cron/ennoblements.go @@ -3,7 +3,7 @@ package cron import ( "github.com/tribalwarshelp/shared/tw/twmodel" - "github.com/tribalwarshelp/dcbot/utils" + "github.com/tribalwarshelp/dcbot/tw/twutil" ) type ennoblements []*twmodel.Ennoblement @@ -19,8 +19,8 @@ func (e ennoblements) getLastEnnoblement() *twmodel.Ennoblement { func (e ennoblements) getLostVillagesByTribe(tribeID int) ennoblements { filtered := ennoblements{} for _, ennoblement := range e { - if (!utils.IsPlayerTribeNil(ennoblement.NewOwner) && ennoblement.NewOwner.Tribe.ID == tribeID) || - utils.IsPlayerTribeNil(ennoblement.OldOwner) || + if (!twutil.IsPlayerTribeNil(ennoblement.NewOwner) && ennoblement.NewOwner.Tribe.ID == tribeID) || + twutil.IsPlayerTribeNil(ennoblement.OldOwner) || ennoblement.OldOwner.Tribe.ID != tribeID { continue } @@ -32,9 +32,9 @@ func (e ennoblements) getLostVillagesByTribe(tribeID int) ennoblements { func (e ennoblements) getConqueredVillagesByTribe(tribeID int, showInternals bool) ennoblements { filtered := ennoblements{} for _, ennoblement := range e { - if utils.IsPlayerTribeNil(ennoblement.NewOwner) || + if twutil.IsPlayerTribeNil(ennoblement.NewOwner) || ennoblement.NewOwner.Tribe.ID != tribeID || - (!showInternals && !utils.IsPlayerTribeNil(ennoblement.OldOwner) && ennoblement.OldOwner.Tribe.ID == tribeID) { + (!showInternals && !twutil.IsPlayerTribeNil(ennoblement.OldOwner) && ennoblement.OldOwner.Tribe.ID == tribeID) { continue } filtered = append(filtered, ennoblement) diff --git a/cron/handler.go b/cron/handler.go index a990eb5..0fa43d4 100644 --- a/cron/handler.go +++ b/cron/handler.go @@ -9,10 +9,11 @@ import ( "github.com/nicksnyder/go-i18n/v2/i18n" - "github.com/tribalwarshelp/dcbot/message" - "github.com/pkg/errors" + "github.com/tribalwarshelp/dcbot/message" + "github.com/tribalwarshelp/dcbot/tw/twutil" + "github.com/tribalwarshelp/golang-sdk/sdk" "github.com/tribalwarshelp/dcbot/discord" @@ -20,7 +21,6 @@ import ( "github.com/tribalwarshelp/dcbot/models" "github.com/tribalwarshelp/dcbot/observation" "github.com/tribalwarshelp/dcbot/server" - "github.com/tribalwarshelp/dcbot/utils" ) type handler struct { @@ -116,7 +116,7 @@ func (h *handler) loadVersions(servers []string) ([]*twmodel.Version, error) { Code: versionCodes, }) if err != nil { - return nil, errors.Wrap(err, "cannot load versions") + return nil, errors.Wrap(err, "couldn't load versions") } return versionList.Items, nil @@ -130,7 +130,7 @@ func (h *handler) checkEnnoblements() { } log. WithField("servers", servers). - Info("checkEnnoblements: loaded servers") + Info("checkEnnoblements: servers have been loaded") groups, total, err := h.groupRepo.Fetch(context.Background(), nil) if err != nil { @@ -139,7 +139,7 @@ func (h *handler) checkEnnoblements() { } log. WithField("numberOfGroups", total). - Info("checkEnnoblements: loaded groups") + Info("checkEnnoblements: groups have been loaded") versions, err := h.loadVersions(servers) if err != nil { @@ -148,13 +148,13 @@ func (h *handler) checkEnnoblements() { } log. WithField("numberOfVersions", len(versions)). - Info("checkEnnoblements: loaded versions") + Info("checkEnnoblements: versions have been loaded") ennoblementsByServerKey, err := h.loadEnnoblements(servers) if err != nil { log.Errorln("checkEnnoblements:", err) } - log.Info("checkEnnoblements: loaded ennoblements") + log.Info("checkEnnoblements: ennoblements have been loaded") for _, g := range groups { if g.ConqueredVillagesChannelID == "" && g.LostVillagesChannelID == "" { @@ -165,11 +165,11 @@ func (h *handler) checkEnnoblements() { conqueredVillagesMsg := &discord.MessageEmbed{} for _, obs := range g.Observations { enblmnts, ok := ennoblementsByServerKey[obs.Server] - version := utils.FindVersionByCode(versions, twmodel.VersionCodeFromServerKey(obs.Server)) + version := twutil.FindVersionByCode(versions, twmodel.VersionCodeFromServerKey(obs.Server)) if ok && version != nil && version.Host != "" { if g.LostVillagesChannelID != "" { for _, ennoblement := range enblmnts.getLostVillagesByTribe(obs.TribeID) { - if !utils.IsPlayerTribeNil(ennoblement.NewOwner) && + if !twutil.IsPlayerTribeNil(ennoblement.NewOwner) && g.Observations.Contains(obs.Server, ennoblement.NewOwner.Tribe.ID) { continue } @@ -186,7 +186,7 @@ func (h *handler) checkEnnoblements() { if g.ConqueredVillagesChannelID != "" { for _, ennoblement := range enblmnts.getConqueredVillagesByTribe(obs.TribeID, g.ShowInternals) { - isInTheSameGroup := !utils.IsPlayerTribeNil(ennoblement.OldOwner) && + isInTheSameGroup := !twutil.IsPlayerTribeNil(ennoblement.OldOwner) && g.Observations.Contains(obs.Server, ennoblement.OldOwner.Tribe.ID) if (!g.ShowInternals && isInTheSameGroup) || (!g.ShowEnnobledBarbarians && isBarbarian(ennoblement.OldOwner)) { @@ -267,27 +267,27 @@ func (h *handler) checkBotServers() { } else { log. WithField("numberOfDeletedServers", len(deleted)). - Info("checkBotServers: deleted servers") + Info("checkBotServers: some of the servers have been deleted") } } } -func (h *handler) deleteClosedTribalWarsServers() { +func (h *handler) deleteClosedTWServers() { servers, err := h.observationRepo.FetchServers(context.Background()) if err != nil { - log.Error("deleteClosedTribalWarsServers: " + err.Error()) + log.Error("deleteClosedTWServers: " + err.Error()) return } log. WithField("servers", servers). - Info("deleteClosedTribalWarsServers: loaded servers") + Info("deleteClosedTWServers: loaded servers") list, err := h.api.Server.Browse(0, 0, []string{"key ASC"}, &twmodel.ServerFilter{ Key: servers, Status: []twmodel.ServerStatus{twmodel.ServerStatusClosed}, }, nil) if err != nil { - log.Errorln("deleteClosedTribalWarsServers: " + err.Error()) + log.Errorln("deleteClosedTWServers: " + err.Error()) return } if list == nil || list.Items == nil { @@ -304,11 +304,11 @@ func (h *handler) deleteClosedTribalWarsServers() { Server: keys, }) if err != nil { - log.Errorln("deleteClosedTribalWarsServers: " + err.Error()) + log.Errorln("deleteClosedTWServers: " + err.Error()) } else { log. WithField("numberOfDeletedObservations", len(deleted)). - Infof("deleteClosedTribalWarsServers: deleted observations") + Infof("deleteClosedTWServers: some of the observations have been deleted") } } } diff --git a/cron/helpers.go b/cron/helpers.go index f27bfcf..a608dbb 100644 --- a/cron/helpers.go +++ b/cron/helpers.go @@ -5,11 +5,11 @@ import ( "github.com/tribalwarshelp/shared/tw/twmodel" "time" - "github.com/tribalwarshelp/dcbot/utils" + "github.com/tribalwarshelp/dcbot/tw/twutil" ) func isBarbarian(p *twmodel.Player) bool { - return utils.IsPlayerNil(p) || p.ID == 0 + return twutil.IsPlayerNil(p) || p.ID == 0 } func trackDuration(log *logrus.Entry, fn func(), fnName string) func() { diff --git a/cron/message.go b/cron/message.go index b1d7d35..1ec3b6d 100644 --- a/cron/message.go +++ b/cron/message.go @@ -7,7 +7,7 @@ import ( "github.com/tribalwarshelp/dcbot/discord" "github.com/tribalwarshelp/dcbot/message" - "github.com/tribalwarshelp/dcbot/utils" + "github.com/tribalwarshelp/dcbot/tw/twutil" ) type messageType string @@ -54,23 +54,23 @@ func newMessage(cfg newMessageConfig) checkEnnoblementsMsg { newOwnerTribeTag: "-", localizer: cfg.localizer, } - if !utils.IsVillageNil(cfg.ennoblement.Village) { + if !twutil.IsVillageNil(cfg.ennoblement.Village) { data.village = cfg.ennoblement.Village.FullName() data.villageURL = twurlbuilder.BuildVillageURL(cfg.server, cfg.host, cfg.ennoblement.Village.ID) } - if !utils.IsPlayerNil(cfg.ennoblement.OldOwner) { + if !twutil.IsPlayerNil(cfg.ennoblement.OldOwner) { data.oldOwnerName = cfg.ennoblement.OldOwner.Name data.oldOwnerURL = twurlbuilder.BuildPlayerURL(cfg.server, cfg.host, cfg.ennoblement.OldOwner.ID) } - if !utils.IsPlayerTribeNil(cfg.ennoblement.OldOwner) { + if !twutil.IsPlayerTribeNil(cfg.ennoblement.OldOwner) { data.oldOwnerTribeTag = cfg.ennoblement.OldOwner.Tribe.Tag data.oldOwnerTribeURL = twurlbuilder.BuildTribeURL(cfg.server, cfg.host, cfg.ennoblement.OldOwner.Tribe.ID) } - if !utils.IsPlayerNil(cfg.ennoblement.NewOwner) { + if !twutil.IsPlayerNil(cfg.ennoblement.NewOwner) { data.newOwnerName = cfg.ennoblement.NewOwner.Name data.newOwnerURL = twurlbuilder.BuildPlayerURL(cfg.server, cfg.host, cfg.ennoblement.NewOwner.ID) } - if !utils.IsPlayerTribeNil(cfg.ennoblement.NewOwner) { + if !twutil.IsPlayerTribeNil(cfg.ennoblement.NewOwner) { data.newOwnerTribeTag = cfg.ennoblement.NewOwner.Tribe.Tag data.newOwnerTribeURL = twurlbuilder.BuildTribeURL(cfg.server, cfg.host, cfg.ennoblement.NewOwner.Tribe.ID) } diff --git a/discord/coords_translation.go b/discord/coords_translation.go index 30b7156..7c99030 100644 --- a/discord/coords_translation.go +++ b/discord/coords_translation.go @@ -11,7 +11,7 @@ import ( "github.com/tribalwarshelp/golang-sdk/sdk" "github.com/tribalwarshelp/dcbot/message" - "github.com/tribalwarshelp/dcbot/utils" + "github.com/tribalwarshelp/dcbot/tw/twutil" ) const ( @@ -117,13 +117,13 @@ func (s *Session) translateCoords(ctx *commandCtx, m *discordgo.MessageCreate) { villageURL := twurlbuilder.BuildVillageURL(ctx.server.CoordsTranslation, version.Host, village.ID) playerName := "-" playerURL := "" - if !utils.IsPlayerNil(village.Player) { + if !twutil.IsPlayerNil(village.Player) { playerName = village.Player.Name playerURL = twurlbuilder.BuildPlayerURL(ctx.server.CoordsTranslation, version.Host, village.Player.ID) } tribeName := "-" tribeURL := "" - if !utils.IsPlayerTribeNil(village.Player) { + if !twutil.IsPlayerTribeNil(village.Player) { tribeName = village.Player.Tribe.Name tribeURL = twurlbuilder.BuildTribeURL(ctx.server.CoordsTranslation, version.Host, village.Player.Tribe.ID) } diff --git a/discord/observations.go b/discord/observations.go index c433d12..0381fe0 100644 --- a/discord/observations.go +++ b/discord/observations.go @@ -15,7 +15,7 @@ import ( "github.com/tribalwarshelp/dcbot/message" "github.com/tribalwarshelp/dcbot/models" - "github.com/tribalwarshelp/dcbot/utils" + "github.com/tribalwarshelp/dcbot/tw/twutil" ) const ( @@ -741,7 +741,7 @@ func (s *Session) handleObservationsCommand(ctx *commandCtx, m *discordgo.Messag if observation.Tribe != nil { tag = observation.Tribe.Tag } - version := utils.FindVersionByCode(versionList.Items, twmodel.VersionCodeFromServerKey(observation.Server)) + version := twutil.FindVersionByCode(versionList.Items, twmodel.VersionCodeFromServerKey(observation.Server)) tribeURL := "" if version != nil { tribeURL = twurlbuilder.BuildTribeURL(observation.Server, version.Host, observation.TribeID) diff --git a/utils/find_version_by_code.go b/tw/twutil/find_version_by_code.go similarity index 94% rename from utils/find_version_by_code.go rename to tw/twutil/find_version_by_code.go index 63fe64d..652e2b0 100644 --- a/utils/find_version_by_code.go +++ b/tw/twutil/find_version_by_code.go @@ -1,4 +1,4 @@ -package utils +package twutil import "github.com/tribalwarshelp/shared/tw/twmodel" diff --git a/utils/tribalwars.go b/tw/twutil/tribalwars.go similarity index 95% rename from utils/tribalwars.go rename to tw/twutil/tribalwars.go index ffd085d..bfbe8d4 100644 --- a/utils/tribalwars.go +++ b/tw/twutil/tribalwars.go @@ -1,4 +1,4 @@ -package utils +package twutil import ( "github.com/tribalwarshelp/shared/tw/twmodel"