Add tests for the profile class (#15)

* Add integration test for the profile

* Add documentation and improve Component usage

* More documentation and update compareTo method

* Add a test case for the compareTo method

* More documentation

Author: theEvilReaper

src/main/java/net/theevilreaper/bounce/profile/BounceProfile.java

@@ -9,9 +9,18 @@
 import net.theevilreaper.bounce.jump.PlayerJumpTask;
 import net.theevilreaper.bounce.util.GameMessages;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.Objects;
 
+/**
+ * The {@link BounceProfile} class represents a player's profile during the game period.
+ * It stores the player's score, kills, deaths, and manages the player's jump task.
+ *
+ * @author theEvilReaper
+ * @version 1.0.0
+ * @since 0.1.0
+ */
 public final class BounceProfile implements Comparable<BounceProfile> {
 
     private final Player player;
@@ -22,23 +31,45 @@ public final class BounceProfile implements Comparable<BounceProfile> {
     private PlayerJumpTask jumpRunnable;
     private long firstReachTimestamp;
 
+    /**
+     * Constructs a new BounceProfile for the specified player.
+     *
+     * @param player the player associated with this profile
+     */
     public BounceProfile(@NotNull Player player) {
         this.player = player;
         this.points = 0;
     }
 
+    /**
+     * Registers a jump runnable for the player's profile.
+     * This runnable will be executed when the player jumps.
+     *
+     * @param pushData the push data containing information about the jump
+     */
     public void registerJumpRunnable(@NotNull PushData pushData) {
         this.jumpRunnable = new PlayerJumpTask(player, pushData);
     }
 
-    public void setLastDamager(Player paramPlayer) {
+    /**
+     * Sets the last player who damaged this profile's player.
+     *
+     * @param paramPlayer the player who last damaged this profile's player
+     */
+    public void setLastDamager(@NotNull Player paramPlayer) {
         this.lastDamager = paramPlayer;
     }
 
+    /**
+     * Increments the kill count for this profile.
+     */
     public void addKill() {
         ++kills;
     }
 
+    /**
+     * Increments the death count for this profile.
+     */
     public void addDeath() {
         ++deaths;
     }
@@ -54,6 +85,11 @@ public int hashCode() {
         return Objects.hashCode(player);
     }
 
+    /**
+     * Adds points to the profile's score and updates the scoreboard.
+     *
+     * @param paramPoints the number of points to add
+     */
     public void addPoints(int paramPoints) {
         points += paramPoints;
         firstReachTimestamp = System.nanoTime();
@@ -62,6 +98,11 @@ public void addPoints(int paramPoints) {
         player.sendActionBar(GameMessages.getCoinComponent(paramPoints, true));
     }
 
+    /**
+     * Removes points from the profile's score.
+     *
+     * @param paramPoints the number of points to remove
+     */
     public void removePoints(int paramPoints) {
         addDeath();
         if (points > 0) {
@@ -71,53 +112,80 @@ public void removePoints(int paramPoints) {
         }
     }
 
+    /**
+     * Sends the round statistics to the player.
+     *
+     * @param winner true if the player won the round, false otherwise
+     */
     public void sendStats(boolean winner) {
         Component message = GameMessages.STATS_LINE
                 .append(Component.newline())
                 .append(Component.text("Round statistics", NamedTextColor.YELLOW))
                 .append(Component.newline())
-                .append(Component.text("Win: ", NamedTextColor.GRAY))
-                .append(Component.text(winner ? "✔" : "✘", winner ? NamedTextColor.GREEN : NamedTextColor.RED))
+                .append(Component.text("Win: ", NamedTextColor.GRAY)
+                        .append(Component.text(winner ? "✔" : "✘", winner ? NamedTextColor.GREEN : NamedTextColor.RED)))
                 .append(Component.newline())
                 .append(Component.text("Points: ", NamedTextColor.GRAY)
                         .append(Component.text(points, NamedTextColor.RED)))
                 .append(Component.newline())
                 .append(Component.text("Kills: ", NamedTextColor.GRAY)
                         .append(Component.text(kills, NamedTextColor.RED)))
                 .append(Component.newline())
-                .append(Component.text("Tode: ", NamedTextColor.GRAY)
+                .append(Component.text("Deaths: ", NamedTextColor.GRAY)
                         .append(Component.text(deaths, NamedTextColor.RED)))
                 .append(Component.newline())
                 .append(GameMessages.STATS_LINE);
 
-        this.player.sendActionBar(message);
+        this.player.sendMessage(message);
     }
 
     @Override
     public int compareTo(@NotNull BounceProfile other) {
-        int pointComparison = Integer.compare(other.points, this.points); // Descending by points
+        System.out.println("" + this.points + " vs " + other.points);
+        int pointComparison = Integer.compare(this.points, other.points); // Descending by points
         if (pointComparison != 0) return pointComparison;
 
         return Long.compare(this.firstReachTimestamp, other.firstReachTimestamp); // Ascending by timestamp
     }
 
+    /**
+     * Updates the scoreboard for this profile's player.
+     */
     private void updateScoreboard() {
         EventDispatcher.call(new ScoreUpdateEvent(player, points));
     }
 
+    /**
+     * Resets the last damager of this profile.
+     */
     public void resetDamager() {
         this.lastDamager = null;
     }
 
+    /**
+     * Returns the player associated with this profile.
+     *
+     * @return the player
+     */
     public Player getPlayer() {
         return player;
     }
 
+    /**
+     * Returns the jump runnable associated with this profile's player.
+     *
+     * @return the jump runnable, or null if it has not been registered
+     */
     public PlayerJumpTask getJumpRunnable() {
         return jumpRunnable;
     }
 
-    public Player getLastDamager() {
+    /**
+     * Returns the last player who damaged this profile's player.
+     *
+     * @return the last damager, or null if no player has damaged this profile's player
+     */
+    public @Nullable Player getLastDamager() {
         return lastDamager;
     }
 }