[CS2113-W12-2] FindOurSEP

.github/workflows/gradle.yml

@@ -45,6 +45,8 @@ jobs:
 
       - name: Perform IO redirection test (Windows)
         if: always() && runner.os == 'Windows'
-        working-directory:  ${{ github.workspace }}/text-ui-test
+        working-directory: ${{ github.workspace }}/text-ui-test
         shell: cmd
-        run: runtest.bat
+        run: |
+          set JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF-8
+          runtest.bat

.gitignore

@@ -15,3 +15,6 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+
+*class

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# FindOurSEP project template
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 

build.gradle

@@ -10,8 +10,18 @@ repositories {
 }
 
 dependencies {
+    // JUnit dependencies for testing
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
+
+    // AsciiTable dependencies for formatting tables
+    implementation group: 'de.vandermeer', name: 'asciitable', version: '0.3.2'
+
+    // https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.18.0'
+
+    // https://mvnrepository.com/artifact/com.opencsv/opencsv
+    implementation group: 'com.opencsv', name: 'opencsv', version: '5.9'
 }
 
 test {
@@ -29,11 +39,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("findoursep.FindOurSEP")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("FindOurSEP")
     archiveClassifier.set("")
 }
 

docs/AboutUs.md

@@ -1,9 +1,9 @@
-# About us
+# About Us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+Display | Name  | Github Profile | Portfolio 
+--------|:-----:|:--------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) | Isaac | [Github](https://github.com/isaacsaw25)
+![](https://picsum.photos/seed/picsum/200/300) | Lee Hao Zhe | [Github](https://github.com/ehz0ah)
+![](https://via.placeholder.com/100.png?text=Photo) | Xiong Xinzhuang | [Github](https://github.com/ThisisXXZ)
+![](https://via.placeholder.com/100.png?text=Photo) | Paul Tham | [Github](https://github.com/paulktham)
+![](https://via.placeholder.com/100.png?text=Photo) | Anderson Lim | [Github](https://github.com/Holy-An)

docs/DeveloperGuide.md

@@ -1,8 +1,48 @@
 # Developer Guide
 
+## Table of Contents
+- [Acknowledgements](#Acknowledgements)
+- [Installation](#installation)
+
+
 ## Acknowledgements
 
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+This project utilizes the following dependencies:
+
+- [JUnit 5.10.0](https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-api/5.10.0) for testing.
+- [AsciiTable 0.3.2](https://mvnrepository.com/artifact/de.vandermeer/asciitable/0.3.2) for formatting tables.
+- [Jackson Databind 2.18.0](https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind/2.18.0) for JSON processing.
+- [OpenCSV 5.9](https://mvnrepository.com/artifact/com.opencsv/opencsv/5.9) for CSV parsing.
+
+Many thanks to the developers and maintainers of these libraries for their incredible work. Their efforts have significantly contributed to the success of this project.
+
+## Installation
+
+To get started with this project, follow these steps:
+
+### Prerequisites
+
+- Java 17
+- Download the latest `.jar` from [here](https://github.com/AY2425S1-CS2113-W12-2/tp/releases/tag/v1.0).
+
+### Steps
+
+1. **Copy the `.jar` file:**
+    - Move the downloaded `.jar` file into a designated folder on your computer.
+
+2. **Prepare your data file:**
+    - If you want to parse a file (.CSV, .JSON, .TXT) containing student data, ensure you have the absolute path ready for that file.
+
+3. **Run the `.jar` file:**
+    - Open a terminal.
+    - Navigate (`cd`) to the folder containing the `.jar` file.
+    - Execute the `.jar` file using the following command:
+      ```shell
+      java -jar FindOurSEP.jar
+      ```
+
+
+🎉 Congratulations! You’re all set to dive into the wonders of this project. Enjoy the ride!
 
 ## Design & implementation
 

src/main/java/allocator/Allocator.java

@@ -0,0 +1,64 @@
+package allocator;
+
+import student.Student;
+import studentlist.StudentList;
+import university.University;
+import university.UniversityRepository;
+
+import java.util.Set;
+
+import exceptions.SEPException;
+
+import java.util.HashSet;
+
+public class Allocator {
+
+    private static double minimumGPA = 0;
+    private StudentList studentList;
+
+
+    public Allocator(StudentList studentList) {
+        this.studentList = new StudentList(studentList);  // don't want to modify the original list
+    }
+
+    /*
+     * setMinimumGPA reuses a helper function found in studentList
+     * The helper function validateGPA reads a string and ensures that the GPA is a valid one
+     * Valid referring to the GPA being within the right values of 0.0 to 5.0
+     * It then returns a float which we use to set the minimumGPA variable
+     */
+
+    public void setMinimumGPA(String stringGpa) throws SEPException {
+        Set<String> errorMessages = new HashSet<>();
+
+        float gpa = studentList.validateGpa(stringGpa, errorMessages);
+
+        if (!errorMessages.isEmpty()) {
+            throw new SEPException(String.join("\n", errorMessages));
+        }
+
+        //Setting the static minimum GPA criteria to the input
+        minimumGPA = gpa;
+    }
+
+    public double getMinimumGPA(){
+        return minimumGPA;
+    }
+
+    public StudentList allocate() {
+        studentList.sortStudentsByGPA();
+        for (Student student : studentList.getList()) {
+            for (int uni : student.getUniPreferences()) {
+                University university = UniversityRepository.getUniversityByIndex(uni);
+                if (university.getSpotsLeft() > 0 && student.getGpa() >= minimumGPA) {
+                    university.removeASpot();
+                    student.setAllocatedUniversity(uni);
+                    student.setSuccessfullyAllocated(true);
+                    break;
+                }
+            }
+        }
+        studentList.sortStudentsById();
+        return studentList;
+    }
+}

src/main/java/command/AddCommand.java

@@ -0,0 +1,30 @@
+package command;
+
+import exceptions.SEPException;
+
+import student.Student;
+import studentlist.StudentList;
+import ui.UI;
+
+public class AddCommand extends Command {
+    private String input;
+    private UI ui;
+
+    public AddCommand(StudentList studentList, String input, UI ui) {
+        super(studentList);
+        this.input = input;
+        this.ui = ui;
+    }
+
+    @Override
+    public void run() {
+        try {
+            Student newStudent = super.studentList.makeStudent(this.input);
+            super.studentList.addStudent(newStudent);
+            ui.printResponse("Added " + newStudent.getId() + " successfully.\n" +
+                    "There are " + studentList.getNumStudents() + " student(s) in the list.");
+        } catch (SEPException e) {
+            ui.printResponse(e.getMessage());
+        }
+    }
+}

src/main/java/command/AllocateCommand.java

@@ -0,0 +1,56 @@
+package command;
+
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+
+import allocator.Allocator;
+import studentlist.StudentList;
+import ui.UI;
+
+public class AllocateCommand extends Command {
+    private Allocator allocator;
+    private UI ui;
+    private ExecutorService executor = Executors.newFixedThreadPool(2); // Create a thread pool
+
+    public AllocateCommand(StudentList studentList, UI ui) {
+        super(studentList);
+        this.ui = ui;
+        this.allocator = new Allocator(studentList);
+    }
+
+    @Override
+    public void run() {
+        try {
+            // Submit the allocation task
+            Future<StudentList> allocationTask = executor.submit(() -> {
+                return allocator.allocate();
+            });
+
+            // Submit the loading message task
+            Future<?> loadingTask = executor.submit(() -> {
+                while (!allocationTask.isDone()) {
+                    this.ui.printAllocatingMessage();
+                }
+            });
+
+            // Check periodically if the allocation is done
+            while (!allocationTask.isDone()) {
+                Thread.sleep(100); // Small delay to avoid busy-waiting
+            }
+
+            // Interrupt the loading task once allocation is done
+            loadingTask.cancel(true);
+
+            // Retrieve the result of the allocation task
+            this.studentList.setStudentList(allocationTask.get());
+
+            // Shut down the executor service
+            executor.shutdown();
+
+        } catch (InterruptedException | ExecutionException e) {
+            e.printStackTrace();
+        }
+    }
+}

src/main/java/command/Command.java

@@ -0,0 +1,21 @@
+package command;
+
+import studentlist.StudentList;
+
+/**
+ * An abstract class representing a command that can be executed by the application.
+ * Subclasses should override the run() method to provide the implementation of the
+ * command.
+ */
+public abstract class Command {
+    protected StudentList studentList;
+
+    public Command(StudentList studentList) {
+        this.studentList = studentList;
+    }
+
+    /**
+     * Executes the command.
+     */
+    public abstract void run();
+}

src/main/java/command/CriteriaCommand.java

@@ -0,0 +1,35 @@
+package command;
+
+import allocator.Allocator;
+import exceptions.SEPException;
+import studentlist.StudentList;
+import ui.UI;
+
+public class CriteriaCommand extends Command {
+    private String input;
+    private UI ui;
+    private Allocator allocator;
+
+    public CriteriaCommand (StudentList studentList,String input, UI ui) {
+        super(studentList);
+        this.input = input;
+        this.ui = ui;
+        this.allocator = new Allocator(studentList);
+    }
+
+    /*
+     * Takes the input and sends the second part of the input into the setMinimumGPA function in allocator
+     */
+
+    @Override
+    public void run() {
+        try{
+            String[] parts = input.split(" ");
+            allocator.setMinimumGPA(parts[1]);
+            ui.printResponse("Minimum requirement of GPA set to " + parts[1] + " successfully.");
+        } catch (SEPException e) {
+            ui.printResponse(e.getMessage());
+        }
+    }
+
+}

src/main/java/command/DeleteCommand.java

@@ -0,0 +1,27 @@
+package command;
+
+import exceptions.SEPException;
+import studentlist.StudentList;
+import ui.UI;
+
+public class DeleteCommand extends Command {
+    private String input;
+    private UI ui;
+
+    public DeleteCommand(StudentList studentList, String input, UI ui) {
+        super(studentList);
+        this.input = input;
+        this.ui = ui;
+    }
+
+    @Override
+    public void run() {
+        try {
+            super.studentList.deleteStudent(this.input);
+            ui.printResponse("Removed student, " + studentList.getNumStudents() + " student(s) left");
+        } catch (SEPException e) {
+            ui.printResponse(e.getMessage());
+        }
+
+    }
+}

src/main/java/command/ExitCommand.java

@@ -0,0 +1,18 @@
+package command;
+
+import studentlist.StudentList;
+import ui.UI;
+
+public class ExitCommand extends Command {
+    private UI ui;
+
+    public ExitCommand(StudentList studentList, UI ui) {
+        super(studentList);
+        this.ui = ui;
+    }
+
+    @Override
+    public void run() {
+        this.ui.cleanupAndExit();
+    }
+}