refactor!: Rename enum member to BasePosition for better reflect its …

…purpose (#106)
MrDave1999 · Sep 22, 2024 · ccdfb26 · ccdfb26
1 parent bd1b0fd
commit ccdfb26
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/src/Application/Teams/Flags/Events/OnFlagAtBasePosition.cs b/src/Application/Teams/Flags/Events/OnFlagAtBasePosition.cs
@@ -5,7 +5,7 @@
 /// </summary>
 public class OnFlagAtBasePosition : IFlagEvent
 {
-    public FlagStatus FlagStatus => FlagStatus.InitialPosition;
+    public FlagStatus FlagStatus => FlagStatus.BasePosition;
 
     public void Handle(Team team, Player player)
     {

diff --git a/src/Application/Teams/Flags/FlagStatus.cs b/src/Application/Teams/Flags/FlagStatus.cs
@@ -3,9 +3,9 @@
 public enum FlagStatus
 {
     /// <summary>
-    /// Indicates that the flag is on its base.
+    /// Indicates that the flag is at the base position, where it is defended to prevent enemy capture.
     /// </summary>
-    InitialPosition,
+    BasePosition,
 
     /// <summary>
     /// Indicates that a player has captured the opposing team's flag from their base.

diff --git a/src/Application/Teams/Team.cs b/src/Application/Teams/Team.cs
@@ -125,7 +125,7 @@ public virtual FlagStatus GetFlagStatus(Player flagPicker)
                 return FlagStatus.Brought;
             }
 
-            return FlagStatus.InitialPosition;
+            return FlagStatus.BasePosition;
         }
 
         if (flagPicker.Team == (int)Id)
@@ -143,7 +143,7 @@ private class NoTeam : Team
     {
         public NoTeam() { }
         public override string GetAvailabilityMessage(bool entireMessage = true) => string.Empty;
-        public override FlagStatus GetFlagStatus(Player flagPicker) => FlagStatus.InitialPosition;
+        public override FlagStatus GetFlagStatus(Player flagPicker) => FlagStatus.BasePosition;
         public override string GetMembersAsText() => string.Empty;
         public override string GetScoreAsText() => string.Empty;
         public override bool IsFull() => false;

diff --git a/tests/Application.Tests/Teams/GetFlagStatusTests.cs b/tests/Application.Tests/Teams/GetFlagStatusTests.cs
@@ -102,12 +102,12 @@ public void GetFlagStatus_WhenPlayerFromBetaTeamBroughtTheFlagOfTheAlphaTeamToTh
     }
 
     [Test]
-    public void GetFlagStatus_WhenPlayerFromAlphaTeamAttemptsToCaptureTheFlagOfTheirTeamFromBase_ShouldReturnsInitialPositionStatus()
+    public void GetFlagStatus_WhenPlayerFromAlphaTeamAttemptsToCaptureTheFlagOfTheirTeamFromBase_ShouldReturnsBasePositionStatus()
     {
         // Arrange
         Team alphaTeam = Team.Alpha;
         var alphaTeamPlayer = new FakePlayer(id: 1, name: "Bob", team: alphaTeam.Id);
-        var expectedStatus = FlagStatus.InitialPosition;
+        var expectedStatus = FlagStatus.BasePosition;
 
         // Act
         FlagStatus actual = alphaTeam.GetFlagStatus(flagPicker: alphaTeamPlayer);
@@ -119,12 +119,12 @@ public void GetFlagStatus_WhenPlayerFromAlphaTeamAttemptsToCaptureTheFlagOfTheir
     }
 
     [Test]
-    public void GetFlagStatus_WhenPlayerFromBetaTeamAttemptsToCaptureTheFlagOfTheirTeamFromBase_ShouldReturnsInitialPositionStatus()
+    public void GetFlagStatus_WhenPlayerFromBetaTeamAttemptsToCaptureTheFlagOfTheirTeamFromBase_ShouldReturnsBasePositionStatus()
     {
         // Arrange
         Team betaTeam = Team.Beta;
         var betaTeamPlayer = new FakePlayer(id: 1, name: "Bob", team: betaTeam.Id);
-        var expectedStatus = FlagStatus.InitialPosition;
+        var expectedStatus = FlagStatus.BasePosition;
 
         // Act
         FlagStatus actual = betaTeam.GetFlagStatus(flagPicker: betaTeamPlayer);