Merge pull request #73 from Project516/master

Update

Author: Project516

README.md

@@ -62,7 +62,7 @@ Download the `archive.zip` from the [latest release](https://github.com/project5
 
 #### Requirements
 
-- Java 11 or higher
+- Java 17 or higher
 
 #### How to Run
 

app/build.gradle

@@ -27,7 +27,7 @@ testing {
         // Configure the built-in test suite
         test {
             // Use JUnit Jupiter test framework
-            useJUnitJupiter('5.14.0')
+            useJUnitJupiter('6.0.0')
         }
     }
 }
@@ -44,7 +44,7 @@ tasks.withType(JavaCompile) {
     // Changed from 8 to 11 to support TeaVM for web deployment.
     // TeaVM 0.10.2+ requires Java 11 as minimum target.
     // This change affects the minimum JRE required to run the JAR.
-    options.release.set(11)
+    options.release.set(17)
 }
 
 application {

app/src/main/java/io/github/project516/NumberGuessingGame/CheckGuess.java

@@ -17,6 +17,12 @@ void check(int guess) {
         }
     }
 
+    /**
+     * Validates the user's response to the "play again" prompt.
+     *
+     * @param input the user's input (0 to quit, 1 to continue)
+     * @throws IllegalArgumentException if the input is not 0 or 1
+     */
     void quit(int input) {
         // 0 is quit
         // 1 is continue

app/src/main/java/io/github/project516/NumberGuessingGame/NumberGuessingGame.java

@@ -1,6 +1,16 @@
 package io.github.project516.NumberGuessingGame;
 
+/**
+ * Console-based Number Guessing Game implementation. This class manages the console version of the
+ * game, handling the game loop, user interaction, and error recovery. It prompts the user to guess
+ * numbers and allows replaying the game.
+ */
 public class NumberGuessingGame {
+    /**
+     * Runs the console version of the Number Guessing Game. Initializes all game components,
+     * displays debug information, and manages the game loop. The user can play multiple rounds
+     * until they choose to quit.
+     */
     void run() {
         ScannerHelper scan = new ScannerHelper();
         DebugInfo debugInfo = new DebugInfo();

app/src/main/java/io/github/project516/NumberGuessingGame/ScannerHelper.java

@@ -29,6 +29,10 @@ String userName() {
         return scan.nextLine();
     }
 
+    /**
+     * Consumes the next token from the input stream. Used primarily for clearing invalid input
+     * after an exception occurs.
+     */
     void next() {
         scan.next();
     }

cheerpj.sh

@@ -1,36 +1,43 @@
 #!/bin/sh
 # Script to create a Debian package (.deb) for Number Guessing Game
+# This package can be installed on Debian-based Linux distributions (Ubuntu, Mint, etc.)
+# Usage: ./package-deb.sh
+# Output: numberguessinggame.deb
 
+# Exit immediately if any command fails
 set -e
 
 echo "Building Number Guessing Game Debian package..."
 
-# Clean up previous builds
+# Clean up any previous build artifacts
+echo "Cleaning up previous builds..."
 rm -rf debian-package/usr/share/games/numberguessinggame/*
 rm -f numberguessinggame.deb
 
-# Build the application
+# Build the application using Gradle
 echo "Building application..."
 
 gradle build
 
-# Copy the jar file
+# Copy the compiled JAR file to the package directory
 echo "Copying files to package directory..."
 cp app/build/libs/app.jar debian-package/usr/share/games/numberguessinggame/game.jar
 
-# Copy documentation
+# Copy documentation files
 cp README.md debian-package/usr/share/games/numberguessinggame/README.md
 cp LICENSE debian-package/usr/share/games/numberguessinggame/LICENSE
 
-# Set permissions
+# Set correct permissions for Debian package
+echo "Setting file permissions..."
 chmod 755 debian-package/DEBIAN
 chmod 755 debian-package/DEBIAN/postinst
 chmod 755 debian-package/usr/games/numberguessinggame
 
-# Build the .deb package
+# Build the .deb package using dpkg-deb
 echo "Building .deb package..."
 dpkg-deb --build debian-package numberguessinggame.deb
 
+# Display success message with installation instructions
 echo ""
 echo "✓ Debian package created: numberguessinggame.deb"
 echo ""

cheerpj/app.jar

@@ -1,6 +1,9 @@
 #!/bin/sh
 # Script to create a Linux package with bundled JRE for Number Guessing Game
+# This creates a self-contained package that doesn't require Java to be installed
+# Output: NumberGuessingGame-linux.tar.gz
 
+# Exit immediately if any command fails
 set -e
 
 echo "Building Number Guessing Game for Linux with bundled JRE..."
@@ -10,21 +13,21 @@ PACKAGE_NAME="NumberGuessingGame-linux"
 JRE_DIR="jre-linux"
 ADOPTIUM_BASE_URL="https://api.adoptium.net/v3/binary/latest/25/ga"
 
-# Clean up previous builds
+# Clean up any previous builds
 rm -rf ${PACKAGE_NAME}
 rm -rf ${JRE_DIR}
 rm -f ${PACKAGE_NAME}.tar.gz
 
-# Build the application
+# Build the application using Gradle
 echo "Building application..."
 ./gradlew build
 
-# Download JRE for Linux
+# Download JRE for Linux from Eclipse Adoptium
 echo "Downloading JRE for Linux..."
 mkdir -p ${JRE_DIR}
 curl -L "${ADOPTIUM_BASE_URL}/linux/x64/jre/hotspot/normal/eclipse?project=jdk" -o ${JRE_DIR}/jre-linux.tar.gz
 
-# Extract JRE
+# Extract the downloaded JRE
 echo "Extracting JRE..."
 cd ${JRE_DIR}
 tar -xzf jre-linux.tar.gz
@@ -38,11 +41,11 @@ cp app/build/libs/app.jar ${PACKAGE_NAME}/game.jar
 cp README.md ${PACKAGE_NAME}/README.txt
 cp LICENSE ${PACKAGE_NAME}/LICENSE
 
-# Copy JRE into package
+# Copy the JRE into the package
 echo "Copying JRE into package..."
 cp -r ${JRE_DIR}/${JRE_EXTRACTED} ${PACKAGE_NAME}/jre
 
-# Create run.sh that uses bundled JRE
+# Create a shell script that uses the bundled JRE
 cat > ${PACKAGE_NAME}/run.sh << 'EOF'
 #!/bin/sh
 
@@ -52,13 +55,14 @@ SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
 "${SCRIPT_DIR}/jre/bin/java" -jar "${SCRIPT_DIR}/game.jar"
 EOF
 
+# Make the run script executable
 chmod +x ${PACKAGE_NAME}/run.sh
 
-# Create the tar.gz archive
+# Create the final tar.gz archive
 echo "Creating tar.gz archive..."
 tar -czf ${PACKAGE_NAME}.tar.gz ${PACKAGE_NAME}/
 
-# Clean up
+# Clean up temporary directories
 rm -rf ${PACKAGE_NAME}
 rm -rf ${JRE_DIR}