Feature 7 - Tests and README

README.md

@@ -6,6 +6,7 @@
 
 Start up the program by running the `Main.java` class in the `src/main/java` directory.
 Upon launching the program, a welcome screen with two buttons, `Sign Up` and `Log In`, appears.
+**Note**: For the course enrolment use case, upon having a `InstructorUser` create a `Course`, the program would need to be closed and rerun so that the data files update accordingly.
 
 ![](resources/images/welcome_screen.png)
 
@@ -141,18 +142,21 @@ For at least one of these tasks, the student specifies the "target task(s)" and
 If more than one target task is specified and the target grades in the input differ, the output will be calculated using the right-most target grade.
 
 
-## Course Enrolment/Creation
+## Course Creation/Enrolment
 
 If the user clicks on the `Courses` button, the screen for course enrolment (`StudentUser` only) and course creation (`InstructorUser` only) will be displayed.
 On this screen, the user can either enrol in a course or create a course, depending on their type.
 
 **Course creation:**
 Upon clicking the `Create a Course` button, the instructor will be prompted to enter in the following text fields: the course name, the course instructor, and a task _(in future implementation they would be able to add more than one task)_.
 
-![](resources/images/course_creation_screen.png)
+![](resources/images/course_creation_empty_screen.png)
 
 If the instructor clicks the `Create` button, the program will check whether the course already exists in the CourseMap and if all required fields are filled out.
 If any of checks failed, an error message will pop up.
+
+![](resources/images/creation_exists_msg.png)
+
 Once successful, the `Course` will be added to the `CourseMap`, where its key is the course ID, a unique string made up of the concatenation of the course name and course instructor entered by the instructor themselves.
 After the program has completed the course creation, the success message will pop up.
 During the entire creation process, clicking the `Cancel` button will close the window without any searches performed.
@@ -164,4 +168,9 @@ If any of the checks failed, an error message would pop up.
 Once successful, the username of the students (which is their unique ID) will be added to the `students` parameter (which is an ArrayList of strings) of the `Course` entity associated with the course ID.
 Then, the tasks (ArrayList of strings from the `tasks` parameter in the `Course` entity) will be copied and appended to the student’s own task list.
 After the program has completed the course enrolment, the success message will pop up.
-During the entire enrolment process, clicking the `Cancel` button will close the window without any searches performed.
+
+![](resources/images/course_enrolment_sucess.png)
+
+![](resources/images/enrolment_success_message.png)
+
+During the entire enrolment process, clicking the `Cancel` button will close the window without any searches performed.

src/main/java/Main.java

@@ -93,11 +93,10 @@ public static void main(String[] args) throws IOException, ClassNotFoundExceptio
 
         // Adding in course enrolment use case
         CourseEnrolmentCourseDsGateway enrolCourse = new FileCourse("src/main/java/data/courses.ser");
-        CourseEnrolmentUserDsGateway enrolUser = new FileUser("src/main/java/data/users.ser");
         CourseEnrolmentTaskDsGateway enrolTasks = new FileTaskMap("src/main/java/data/TaskMap.txt");
         CourseEnrolmentOutputBoundary enrolmentPresenter = new CourseEnrolmentPresenter();
         CourseEnrolmentInputBoundary enrolmentInteractor = new CourseEnrolmentInteractor(
-                enrolUser, enrolCourse, enrolTasks, enrolmentPresenter);
+                enrolCourse, enrolTasks, enrolmentPresenter);
         CourseEnrolmentController enrolmentController = new CourseEnrolmentController(enrolmentInteractor);
 
         // Adding in logout use case

src/main/java/entities/Assignment.java

@@ -146,4 +146,12 @@ public void setPrepTimeScheduled(ArrayList<ArrayList<LocalDateTime>> prepTimeSch
     public LocalDateTime getDueDate() {
         return this.dueDate;
     }
+
+    /**
+     * For course enrolment use case
+     * @return a copy of the assignment
+     */
+    public Assignment getAssignmentCopy() {
+        return new Assignment(getTitle(), "", dueDate, weightage);
+    }
 }

src/main/java/entities/Course.java

@@ -46,7 +46,7 @@ public String getCourseID() {
     }
 
     public ArrayList<String> getStudents() {
-        return new ArrayList<>(this.students);
+        return students;
     }
 
     public ArrayList<String> getTasks() {

src/main/java/entities/TaskMap.java

@@ -2,6 +2,7 @@
 
 import java.io.Serializable;
 import java.util.HashMap;
+import java.util.Map;
 
 public class TaskMap implements Serializable {
     private static HashMap<String, Task> taskMap;
@@ -26,6 +27,11 @@ public static void addTask(String id, Task task) {
         taskMap.put(id, task);
     }
 
+    public static void addTasks(Map newTasks) {
+        taskMap.putAll(newTasks);
+
+    }
+
     /**
      * Remove a Task from the TaskMap.txt
      * @param id - the ID of the Task being removed
@@ -49,5 +55,4 @@ public static HashMap<String, Task> getTaskMap() {
     public static void setTaskMap(HashMap<String, Task> tasksMap) {
         taskMap = tasksMap;
     }
-
 }

src/main/java/entities/Test.java

@@ -174,4 +174,8 @@ public ArrayList<ArrayList<LocalDateTime>> getPrepTimeScheduled() {
     public void setPrepTimeScheduled(ArrayList<ArrayList<LocalDateTime>> prepTimeScheduled) {
         this.prepTimeScheduled = prepTimeScheduled;
     }
+
+    public Test getTestCopy() {
+        return new Test(getTitle(), "", startTime, endTime, weightage);
+    }
 }

src/main/java/screens/course_features/CourseEnrolmentController.java

@@ -8,9 +8,9 @@ public CourseEnrolmentController(CourseEnrolmentInputBoundary enrolmentGateway)
         this.enrolmentInput = enrolmentGateway;
     }
 
-    void enrol(String courseID, String instructorID, String studentID) {
+    void enrol(String courseID, String instructorID) {
         CourseEnrolmentRequestModel requestModel = new CourseEnrolmentRequestModel(
-                courseID, instructorID, studentID);
+                courseID, instructorID);
 
         enrolmentInput.enrol(requestModel);
     }

src/main/java/screens/course_features/CourseEnrolmentScreen.java

@@ -45,8 +45,8 @@ public CourseEnrolmentScreen(CourseEnrolmentController controller, JPanel screen
                 new JLabel("Enter course name"), courseName);
         LabelTextPanel courseInstructorInfo = new LabelTextPanel(
                 new JLabel("Enter instructor name"), courseInstructor);
-        LabelTextPanel studentIDInfo = new LabelTextPanel(
-                new JLabel("Enter your username"), studentID);
+//        LabelTextPanel studentIDInfo = new LabelTextPanel(
+//                new JLabel("Enter your username"), studentID);
 
         // buttons
         JButton cancel = new JButton("Cancel");
@@ -65,7 +65,6 @@ public CourseEnrolmentScreen(CourseEnrolmentController controller, JPanel screen
         this.add(title);
         this.add(courseNameInfo);
         this.add(courseInstructorInfo);
-        this.add(studentIDInfo);
         this.add(buttons);
     }
 
@@ -84,8 +83,10 @@ public void actionPerformed(ActionEvent evt) {
                 // add course tasks to Student's todolist
                 // add course id to Student's courses list
 
-                courseEnrolmentController.enrol(courseName.getText(), courseInstructor.getText(), studentID.getText());
-                JOptionPane.showMessageDialog(this, "Successfully enrolled in course. tasks added.");
+                courseEnrolmentController.enrol(courseName.getText(), courseInstructor.getText());
+                JOptionPane.showMessageDialog(this,
+                        "Successfully enrolled in course " + courseName.getText() + " with instructor" +
+                                courseInstructor.getText() + ". Check your to-do list for the course tasks!");
             } catch (Exception e) {
                 JOptionPane.showMessageDialog(this, e.getMessage());
             }

src/main/java/screens/login_registration/FileUser.java

@@ -1,18 +1,16 @@
 package screens.login_registration;
 
-import use_cases.course_features.course_enrolment_use_case.*;
 import use_cases.login_registration.login_usecase.*;
 import use_cases.login_registration.logout_usecase.*;
 import use_cases.login_registration.user_register_usecase.*;
 
 import java.io.*;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
 
-public class FileUser implements UserRegGateway, LoginGateway, LogoutGateway, CourseEnrolmentUserDsGateway {
+public class FileUser implements UserRegGateway, LoginGateway, LogoutGateway {
 
     private static HashMap<String, UserRegSaveRequest> accounts;
 
@@ -94,40 +92,4 @@ public String passOf(String name) {
     public Map<String, UserRegSaveRequest> getAccounts() {
         return accounts;
     }
-
-
-    /**
-     * For course enrolment use case (course tasks to do list gateway)
-     * Adds the course tasks to the student's to-do list
-     *
-     * @param studentID the username of the student whose parameters are being modified
-     * @param courseTasks the course task ids what will be added to the student's 'to do list' parameter
-     */
-    @Override
-    public void addTasksToTodolist(String studentID, ArrayList<String> courseTasks) throws IOException {
-        // casting to student save request
-        ((StudentSaveRequest) accounts.get(studentID)).getToDoList().addAll(courseTasks);
-        save();
-        // in interactor, update CurrentUser
-        // make a new StudentSaveRequest with CurrentUser
-        // call Gateway.save(StudentSaveRequest)
-    }
-
-    /**
-     * For course enrolment use case (course tasks to do list gateway)
-     * Adds the course id to the student's 'courses' parameter
-     * @param courseID the course the student enrolled in
-     * @param studentID the username of student enrolled
-     */
-    @Override
-    public void addCourseToStudent(String courseID, String studentID) throws IOException {
-        // casting to student save request
-        // initialize current
-//        StudentUser s = accounts.get(studentID);
-        ((StudentSaveRequest) accounts.get(studentID)).getCourses().add(courseID);
-        save();
-        // if adding
-//         StudentUser s = (StudentUser) CurrentUser.getCurrentUser()
-//         s.addCourse
-    }
 }

src/main/java/screens/task_management/FileTaskMap.java

@@ -7,6 +7,7 @@
 
 import java.io.*;
 import java.util.HashMap;
+import java.util.Map;
 
 public class FileTaskMap implements TaskMapGateway, CourseEnrolmentTaskDsGateway, ScheduleCTDSGateway {
     String path;
@@ -69,15 +70,27 @@ public boolean existsById(String id) {
      * @param taskId the unique id (key) of the task
      * @return task
      */
+
+    /**
+     * For course enrolment use case, get a Task based on task id
+     * @param taskId - the uniqueid of the task
+     */
     @Override
     public Task getTask(String taskId) {
         return taskMap.get(taskId);
     }
 
+    /**
+     * For course enrolment use case, added temporary map of new tasks to TaskMap
+     * @param newMap the temporary map of 'cloned' course tasks with student username in id
+     */
     @Override
     public void saveNewMaptoMap(HashMap<String, Task> newMap) {
-        taskMap.putAll(newMap);
-        save(taskMap);
+        for (Map.Entry<String, Task> entry: newMap.entrySet()) {
+            taskMap.put(entry.getKey(), entry.getValue());
+            save(taskMap);
+        }
+        TaskMap.setTaskMap(taskMap);
     }
 
     /**

src/main/java/screens/task_management/InMemoryTaskMap.java

@@ -1,14 +1,16 @@
 package screens.task_management;
 
 import entities.*;
+import use_cases.course_features.course_enrolment_use_case.*;
 import use_cases.task_management.read_write.*;
 
 import java.util.HashMap;
+import java.util.Map;
 
 /**
  * TaskMapGateway for testing purposes
  */
-public class InMemoryTaskMap implements TaskMapGateway {
+public class InMemoryTaskMap implements TaskMapGateway, CourseEnrolmentTaskDsGateway {
     HashMap<String, Task> taskMap = new HashMap<>();
 
     /**
@@ -37,4 +39,26 @@ public Object load() {
     public boolean existsById(String id) {
         return taskMap.containsKey(id);
     }
+
+    /**
+     * course enrolment use case (for interactor test)
+     * @param taskID the unique id of the task
+     */
+    @Override
+    public Task getTask(String taskID) {
+        return taskMap.get(taskID);
+    }
+
+    /**
+     * course enrolment use case (for interactor test)
+     * @param newMap the map of the "new" tasks (new key, same value)
+     */
+    @Override
+    public void saveNewMaptoMap(HashMap<String, Task> newMap) {
+        for (Map.Entry<String, Task> entry : newMap.entrySet()) {
+            taskMap.put(entry.getKey(), entry.getValue());
+            save(taskMap);
+        }
+        TaskMap.setTaskMap(taskMap);
+    }
 }

src/main/java/screens/task_management/task_creation_screens/assignment_creation_screens/InstructorAssignmentCreationScreen.java

@@ -93,7 +93,7 @@ public void actionPerformed(ActionEvent evt) {
 
                 // notify user of success and return to main screen
                 showMessageDialog(this, "Assignment Created Successfully");
-                screenLayout.show(screens, "StudentMain");
+                screenLayout.show(screens, "InstructorMain");
             } catch (Exception e) { // if anything goes wrong in the input (e.g. parsing error)
                 showMessageDialog(this, e.getMessage());
             }

src/main/java/use_cases/course_features/course_creation_use_case/CourseCreationRequestModel.java

@@ -45,12 +45,6 @@ public String getCourseID() {
     }
 
     public ArrayList<String> getTasks() {
-        // string from input will be like this: "task1,task2,task3"
-        // need to split into ["task1", "task2", "task3"]
-
-        String taskOneString = tasks.get(0); // only one element in arraylist
-        ArrayList<String> courseTasksSplit = new ArrayList<>();
-        Collections.addAll(courseTasksSplit, taskOneString.split(","));
-        return courseTasksSplit;
+        return tasks;
     }
 }

src/main/java/use_cases/course_features/course_enrolment_use_case/CourseEnrolmentCourseDsGateway.java

@@ -20,6 +20,6 @@ public interface CourseEnrolmentCourseDsGateway {
     boolean existsByCourseID(String courseIdentifier); // exact same name as CourseCreationDsGateway
     Course searchForCourse(String courseIdentifier);
     boolean existsStudentInCourse(String courseID, String studentIdentifier);
-    void saveStudentToCourse(String studentID, String courseID) throws IOException; // need to update data
+    void saveStudentToCourse(String studentID, String courseID) throws IOException;
     ArrayList<String> getCourseTasks(String courseIdentifier);
 }

src/main/java/use_cases/course_features/course_enrolment_use_case/CourseEnrolmentInputBoundary.java

@@ -2,6 +2,14 @@
 
 // Use case layer
 
+/**
+ * Input boundary interface
+ * Dependency inversion from controller to interactor
+ */
 public interface CourseEnrolmentInputBoundary {
+    /**
+     * the method in the use case interactor that does the entire enrolment process
+     * @param requestModel the request model (information inputted by user)
+     */
     void enrol(CourseEnrolmentRequestModel requestModel);
 }