Tests, comments and createGame method

BackendTests/Services/GameServiceTests.cs

@@ -28,6 +28,32 @@ public class GameServiceTests
         });
     }
 
+    #region CreateAndJoin(IPlayer player, Queue<DirectionalPosition> spawns)
+
+    [Test]
+    public void CreateAndJoin_WhenEmpty()
+    {
+        var player = Players.Create("white");
+        var group = _service.CreateAndJoin(player, _spawns);
+
+        Assert.Multiple(() =>
+        {
+            Assert.That(group.Players, Has.Count.EqualTo(1));
+            Assert.That(group.NextPlayer, Is.EqualTo(player));
+            Assert.That(_service.Games, Has.Count.EqualTo(1));
+        });
+    }
+
+    [Test]
+    public void CreateAndJoin_SpawnsAreNotEqualToMaxPlayers()
+    {
+        var player = Players.Create("white");
+        _spawns.Dequeue();
+        Assert.Throws<ArgumentException>(() => _service.CreateAndJoin(player, _spawns));
+    }
+
+    #endregion
+
     #region JoinbyId(Guid id)
 
     [Test]
@@ -38,7 +64,7 @@ public class GameServiceTests
 
         Assert.Throws<GameNotFoundException>(() => _service.JoinById(Guid.NewGuid(), player));
     }
-    
+
     [Test]
     public void JoinById_WhenIdExists()
     {

pac-man-board-game/Exceptions/GameNotPlayableException.cs

@@ -0,0 +1,6 @@
+namespace pacMan.Exceptions;
+
+public class GameNotPlayableException : Exception
+{
+    public GameNotPlayableException(string message = "Game is not allowed to be played") : base(message) { }
+}

pac-man-board-game/Services/Game.cs

@@ -44,9 +44,15 @@ public class Game // TODO handle disconnects and reconnects
     public bool AddPlayer(IPlayer player)
     {
         if (Players.Count >= Rules.MaxPlayers || IsGameStarted) return false;
+        /* TODO remove above and uncomment below
+          if (Players.Count >= Rules.MaxPlayers)
+            throw new GameNotPlayableException("Game is full");
+        if (IsGameStarted)
+            throw new GameNotPlayableException("Game has already started");
+         */
 
         player.State = State.WaitingForPlayers;
-        if (Players.Exists(p => p.Name == player.Name)) return true;
+        if (Players.Exists(p => p.Name == player.Name)) return true; // TODO change to false
         Players.Add(player);
         if (player.PacMan.SpawnPosition is null) SetSpawn(player);
         return true;

pac-man-board-game/Services/GameService.cs

@@ -4,13 +4,20 @@ using pacMan.GameStuff.Items;
 
 namespace pacMan.Services;
 
+/// <summary>
+/// The GameService class provides functionality for managing games in a WebSocket environment. It inherits from the WebSocketService class.
+/// </summary>
 public class GameService : WebSocketService
 {
     public GameService(ILogger<GameService> logger) : base(logger) { }
 
+    /// <summary>
+    /// A thread-safe collection (SynchronizedCollection) of "Game" objects. Utilized for managing multiple game instances simultaneously.
+    /// It represents all the current games being managed by GameService. 
+    /// </summary>
     public SynchronizedCollection<Game> Games { get; } = new();
 
-    public event Func<ArraySegment<byte>, Task>? Connections; // TODO remove and use GameGroup
+    public event Func<ArraySegment<byte>, Task>? Connections; // TODO remove and use Game
 
     public void SendToAll(ArraySegment<byte> segment)
     {
@@ -34,12 +41,37 @@ public class GameService : WebSocketService
         return Games[index];
     }
 
+    /// <summary>
+    /// This method tries to find a game with the specified id, add a player to it and return the updated game.
+    /// </summary>
+    /// <param name="id">The unique id of the game the player wants to join</param>
+    /// <param name="player">The player instance that wants to join the game</param>
+    /// <returns>Returns the updated Game object after adding the player.</returns>
+    /// <exception cref="GameNotFoundException">Thrown if a game with the specified id cannot be found.</exception>
     public Game JoinById(Guid id, IPlayer player)
     {
         var game = Games.FirstOrDefault(g => g.Id == id) ?? throw new GameNotFoundException();
-        var added = game.AddPlayer(player);
+        game.AddPlayer(player);
 
-        if (!added) throw new ArgumentException("Game is full");
+        return game;
+    }
+
+
+    /// <summary>
+    /// Creates a new game and adds a player to it.
+    /// </summary>
+    /// <param name="player">The player instance that is going to join the new game.</param>
+    /// <param name="spawns">A collection of spawn points arranged in a directional queue.</param>
+    /// <returns>Returns the newly created Game object, with the player added to it.</returns>
+    /// <exception cref="ArgumentException">Thrown if the number of spawns is not equal to the maximum number of players set by the Rules.</exception>
+    public Game CreateAndJoin(IPlayer player, Queue<DirectionalPosition> spawns)
+    {
+        if (spawns.Count != Rules.MaxPlayers)
+            throw new ArgumentException($"The number of spawns must be equal to {Rules.MaxPlayers}.");
+
+        var game = new Game(spawns);
+        game.AddPlayer(player);
+        Games.Add(game);
 
         return game;
     }

pac-man-board-game/Services/WebSocketService.cs

@@ -4,6 +4,7 @@ using pacMan.Utils;
 
 namespace pacMan.Services;
 
+
 public class WebSocketService : IWebSocketService
 {
     protected readonly ILogger<WebSocketService> Logger;