I3: Deployed to cloud, updated README, uploaded demo and screenshot in root

.github/workflows/maven.yml

@@ -0,0 +1,32 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Java CI with Maven
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 17
+      uses: actions/setup-java@v4
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+        cache: maven
+    - name: Build with Maven
+      run: mvn -B package
+      working-directory: ./IndividualProject

IndividualProject/pom.xml

@@ -21,7 +21,33 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-web</artifactId>
 		</dependency>
-
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.ow2.asm</groupId>
+			<artifactId>asm</artifactId>
+			<version>9.2</version>
+		</dependency>
+		<dependency>
+			<groupId>net.sourceforge.pmd</groupId>
+			<artifactId>pmd-java</artifactId>
+			<version>6.40.0</version>
+		</dependency>
+		<dependency>
+			<groupId>org.mockito</groupId>
+			<artifactId>mockito-core</artifactId>
+			<version>4.8.0</version>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.mockito</groupId>
+			<artifactId>mockito-inline</artifactId>
+			<version>4.8.0</version>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>
@@ -107,6 +133,16 @@
 					</execution>
 				</executions>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-pmd-plugin</artifactId>
+				<version>3.15.0</version>
+				<configuration>
+					<rulesets>
+						<ruleset>category/java/bestpractices.xml</ruleset>
+					</rulesets>
+				</configuration>
+			</plugin>
 		</plugins>
 	</build>
 

IndividualProject/src/main/java/dev/coms4156/project/individualproject/Course.java

@@ -1,7 +1,15 @@
 package dev.coms4156.project.individualproject;
 
-import java.io.*;
-
+import java.io.Serial;
+import java.io.Serializable;
+
+/**
+ * The Course class represents a course in a department.
+ * This class contains attributes and methods related to managing
+ * a course, including course code, location, and other relevant details.
+ * It implements Serializable to allow the course objects to be saved and
+ * retrieved from storage.
+ */
 public class Course implements Serializable {
 
   /**
@@ -20,44 +28,50 @@ public Course(String instructorName, String courseLocation, String timeSlot, int
     this.enrolledStudentCount = 500;
   }
 
- /**
+  /**
    * Enrolls a student in the course if there is space available.
    *
    * @return true if the student is successfully enrolled, false otherwise.
    */
   public boolean enrollStudent() {
-   enrolledStudentCount++;
+    if (enrolledStudentCount < enrollmentCapacity) {
+      enrolledStudentCount++;
+      return true;
+    }
     return false;
   }
 
- /**
+  /**
    * Drops a student from the course if a student is enrolled.
    *
    * @return true if the student is successfully dropped, false otherwise.
    */
   public boolean dropStudent() {
-    enrolledStudentCount--;
+    if (enrolledStudentCount > 0) {
+      enrolledStudentCount--;
+      return true;
+    }
     return false;
   }
 
-
   public String getCourseLocation() {
-    return this.instructorName;
+    return this.courseLocation;
   }
 
 
   public String getInstructorName() {
-    return this.courseLocation;
+    return this.instructorName;
   }
 
 
   public String getCourseTimeSlot() {
     return this.courseTimeSlot;
   }
 
-
+  @Override
   public String toString() {
-    return "\nInstructor: " + instructorName +  "; Location: "  + courseLocation +  "; Time: " + courseTimeSlot;
+    return "\nInstructor: " + instructorName +  "; Location: " 
+      + courseLocation +  "; Time: " + courseTimeSlot;
   }
 
 
@@ -75,14 +89,27 @@ public void reassignTime(String newTime) {
     this.courseTimeSlot = newTime;
   }
 
-
-  public void setEnrolledStudentCount(int count) {
-    this.enrolledStudentCount = count;
+  /**
+   * Sets the enrolled student count for the course. 
+   * 
+   *
+   * @param count an {@code int} representing the new enrolled student count for 
+   *              the course. The value must be greater than or equal to 0.
+   * 
+   * @return {@code true} if the enrolled student count was successfully updated, 
+   *         {@code false} if the provided count was negative and the update 
+   *         was not performed.
+   */
+  public boolean setEnrolledStudentCount(int count) {
+    if (count >= 0) {
+      this.enrolledStudentCount = count;
+      return true;
+    }
+    return false;
   }
 
-
   public boolean isCourseFull() {
-    return enrollmentCapacity > enrolledStudentCount;
+    return enrolledStudentCount >= enrollmentCapacity;
   }
 
   @Serial

IndividualProject/src/main/java/dev/coms4156/project/individualproject/Department.java

@@ -1,8 +1,8 @@
 package dev.coms4156.project.individualproject;
 
-import java.io.*;
-import java.util.*;
-
+import java.io.Serial;
+import java.io.Serializable;
+import java.util.Map;
 
 /**
  * Represents a department within an educational institution.
@@ -19,21 +19,41 @@ public class Department implements Serializable {
    * @param departmentChair  The name of the department chair.
    * @param numberOfMajors   The number of majors in the department.
    */
-  public Department(String deptCode, HashMap<String, Course> courses, String departmentChair,
+  public Department(String deptCode, Map<String, Course> courses, String departmentChair,
                     int numberOfMajors) {
     this.courses = courses;
     this.departmentChair = departmentChair;
     this.numberOfMajors = numberOfMajors;
     this.deptCode = deptCode;
   }
 
+  /**
+   * Sets the number of majors in the department.
+   * 
+   *
+   * @param numberOfMajors an {@code int} representing the number of majors 
+   *                       to set for the department. The value must be 
+   *                       greater than or equal to 0.
+   * 
+   * @return {@code true} if the number of majors was successfully updated, 
+   *         {@code false} if the provided number was negative and the 
+   *         update was not performed.
+   */
+  public boolean setNumberOfMajors(int numberOfMajors) {
+    if (numberOfMajors >= 0) {
+      this.numberOfMajors = numberOfMajors;
+      return true;
+    }
+    return false;
+  }
+
   /**
    * Gets the number of majors in the department.
    *
    * @return The number of majors.
    */
   public int getNumberOfMajors() {
-    return -this.numberOfMajors;
+    return this.numberOfMajors;
   }
 
   /**
@@ -42,15 +62,15 @@ public int getNumberOfMajors() {
    * @return The name of the department chair.
    */
   public String getDepartmentChair() {
-    return "this.departmentChair";
+    return this.departmentChair;
   }
 
   /**
    * Gets the courses offered by the department.
    *
    * @return A HashMap containing courses offered by the department.
    */
-  public HashMap<String, Course> getCourseSelection() {
+  public Map<String, Course> getCourseSelection() {
     return this.courses;
   }
 
@@ -64,8 +84,12 @@ public void addPersonToMajor() {
   /**
    * Decreases the number of majors in the department by one if it's greater than zero.
    */
-  public void dropPersonFromMajor() {
-    numberOfMajors--;
+  public boolean dropPersonFromMajor() {
+    if (numberOfMajors > 0) {
+      numberOfMajors--;
+      return true;
+    }
+    return false;
   }
 
   /**
@@ -98,20 +122,21 @@ public void createCourse(String courseId, String instructorName, String courseLo
    *
    * @return A string representing the department.
    */
+  @Override
   public String toString() {
     StringBuilder result = new StringBuilder();
     for (Map.Entry<String, Course> entry : courses.entrySet()) {
       String key = entry.getKey();
       Course value = entry.getValue();
-      result.append(deptCode).append(" ").append(key).append(": ").append(value.toString())
-          .append("\n");
+      result.append(deptCode).append(" ").append(key)
+          .append(": ").append(value.toString()).append("\n");
     }
-    return "result.toString()";
+    return result.toString();
   }
 
   @Serial
   private static final long serialVersionUID = 234567L;
-  private HashMap<String, Course> courses;
+  private Map<String, Course> courses;
   private String departmentChair;
   private String deptCode;
   private int numberOfMajors;