feature 7 course creation + course enrolment + tasks to tasklist use cases

build.gradle

@@ -9,6 +9,7 @@ repositories {
 dependencies {
     implementation 'junit:junit:4.13.1'
     testImplementation('org.junit.jupiter:junit-jupiter:5.6.0')
+    testImplementation 'org.testng:testng:7.1.0'
 }
 
 test {

src/main/java/course_creation_use_case/CourseCreationDsGateway.java

@@ -0,0 +1,15 @@
+package course_creation_use_case;
+
+// Use case layer
+
+/*
+Notes:
+- the methods the repo needs to implement for the interactor to do its job
+ */
+
+public interface CourseCreationDsGateway {
+    // checks if the course is already in the course map by its unique id
+    boolean existsByCourseID(String courseIdentifier);
+
+    void saveCourse(CourseCreationRequestModel requestModel);
+}

src/main/java/course_creation_use_case/CourseCreationInputBoundary.java

@@ -0,0 +1,15 @@
+package course_creation_use_case;
+
+// Use case layer
+
+
+/*
+Notes:
+- the public interface for calling the use case
+- boundaries are interfaces
+- input boundary is between the controller and use case
+ */
+
+public interface CourseCreationInputBoundary {
+    CourseCreationResponseModel create(CourseCreationRequestModel requestModel);
+}

src/main/java/course_creation_use_case/CourseCreationInteractor.java

@@ -0,0 +1,53 @@
+package course_creation_use_case;
+
+// Use case layer
+
+import entities.*;
+
+public class CourseCreationInteractor implements CourseCreationInputBoundary {
+    final CourseCreationDsGateway courseCreationDSGateway;
+    final CourseCreationPresenter courseCreationPresenter;
+    final CourseMap courseMap;
+
+    public CourseCreationInteractor(CourseCreationDsGateway courseCreationDSGateway, CourseCreationPresenter courseCreationPresenter,
+                                    CourseMap courseMap) {
+        this.courseCreationDSGateway = courseCreationDSGateway;
+        this.courseCreationPresenter = courseCreationPresenter;
+        this.courseMap = courseMap;
+    }
+
+    /**
+     * Creates the task in the request model and returns the corresponding response model
+     * @param requestModel the input from the instructor
+     */
+    @Override
+    public CourseCreationResponseModel create(CourseCreationRequestModel requestModel) {
+
+        // At least one field left blank
+        if (requestModel.getCourseName().equals("") || requestModel.getCourseInstructor().equals("") || requestModel.getTasks().isEmpty()) {
+            return courseCreationPresenter.prepareFailView("Please fill in all required information.");
+        }
+
+        // Note: Jonathan - no need to check the type of User, students and instructors
+        // would have different views because they are in different use cases
+        // checks whether the course id is already in the CourseMap (course already exists)
+        if (courseCreationDSGateway.existsByCourseID(requestModel.getCourseID())) {
+            return courseCreationPresenter.prepareFailView("Course already exists.");
+        }
+
+        // checks passed; course can be created
+
+        // create a new course
+        Course course = new Course(requestModel.getCourseName(), requestModel.getCourseInstructor(), requestModel.getTasks());
+        CourseMap.addCourse(requestModel.getCourseID(), course);
+
+        // course successfully created and saved
+        CourseCreationRequestModel courseCreationModel = new CourseCreationRequestModel(course.getCourseName(), course.getCourseInstructor(), course.getTasks());
+        courseCreationDSGateway.saveCourse(courseCreationModel);
+
+        // course sent to presenter
+        CourseCreationResponseModel courseResponseModel = new CourseCreationResponseModel(
+                course.getCourseID(), course.getTasks());
+        return courseCreationPresenter.prepareSuccessView(courseResponseModel);
+    }
+}

src/main/java/course_creation_use_case/CourseCreationPresenter.java

@@ -0,0 +1,18 @@
+package course_creation_use_case;
+
+// Use case layer
+
+public interface CourseCreationPresenter {
+
+    /**
+     * Alerts user that course creation is successful (no existing course)
+     * @param newCourse the output from the program
+     */
+    CourseCreationResponseModel prepareSuccessView(CourseCreationResponseModel newCourse);
+
+    /**
+     * Alerts user that course creation attempted failed
+     * @param error the output from the program
+     */
+    CourseCreationResponseModel prepareFailView(String error);
+}

src/main/java/course_creation_use_case/CourseCreationRequestModel.java

@@ -0,0 +1,63 @@
+package course_creation_use_case;
+
+// Use case layer
+
+/*
+ Notes:
+- requests what is needed for its input data (what person in front of computer enters)
+- do NOT depend on anything NOR have any references to Entity objects: violates SRP
+ */
+
+
+import java.util.ArrayList;
+
+public class CourseCreationRequestModel {
+    private String courseName;
+    private String courseInstructor;
+    private final String courseID;
+    private ArrayList<String> tasks;
+
+    /**
+     * Creates a request model with the given input
+     * @param courseName the name of the course
+     * @param courseInstructor the instructor of the course
+     * @param tasks the task(s) associated with the course
+     */
+    public CourseCreationRequestModel(String courseName, String courseInstructor, ArrayList<String> tasks) {
+        this.courseName = courseName;
+        this.courseInstructor = courseInstructor;
+        this.courseID = courseName + courseInstructor;
+        this.tasks = tasks;
+    }
+
+    public String getCourseName() {
+        return courseName;
+    }
+
+    public void setCourseName() {
+
+        this.courseName = courseName;
+    }
+
+    public String getCourseInstructor() {
+        return courseInstructor;
+    }
+
+    public void setCourseInstructor() {
+
+        this.courseInstructor = courseInstructor;
+    }
+
+    public String getCourseID() {
+        return courseID;
+    }
+
+    public ArrayList<String> getTasks() {
+
+        return tasks;
+    }
+
+    public void setTasks() {
+        this.tasks = tasks;
+    }
+}

src/main/java/course_creation_use_case/CourseCreationResponseModel.java

@@ -0,0 +1,41 @@
+package course_creation_use_case;
+
+import java.util.ArrayList;
+
+// Use case layer
+
+/*
+Notes:
+- the output data produced; returns the response as the output
+- does NOT depend on anything NOR should have any references to Entity objects: violates SRP
+ */
+
+public class CourseCreationResponseModel {
+    String courseID;
+    ArrayList<String> tasks;
+
+    /**
+     * Creates a response model for course creation use case
+     * @param courseID the unique id of the course being created
+     * @param tasks the task(s) associated with the course being created
+     */
+    public CourseCreationResponseModel(String courseID, ArrayList<String> tasks) {
+        this.courseID = courseID;
+        this.tasks = tasks;
+    }
+    public String getCourseID() {
+        return courseID;
+    }
+    public void setCourseID() {
+        this.courseID = courseID;
+    }
+    public ArrayList<String> getTasks() {
+        return tasks;
+    }
+
+    // i don't think this is needed
+    public void setTasks() {
+        this.tasks = tasks;
+    }
+}
+

src/main/java/course_enrolment_use_case/CourseEnrolmentDsGateway.java

@@ -0,0 +1,11 @@
+package course_enrolment_use_case;
+
+// Use case layer
+
+public interface CourseEnrolmentDsGateway {
+    // checks if student is in the course through the students argument of the Course
+    // object (value) from the course id (key)
+    boolean existsByStudent(String studentIdentifier);
+
+    void saveStudent(CourseEnrolmentRequestModel requestModel);
+}

src/main/java/course_enrolment_use_case/CourseEnrolmentInputBoundary.java

@@ -0,0 +1,7 @@
+package course_enrolment_use_case;
+
+// Use case layer
+
+public interface CourseEnrolmentInputBoundary {
+    CourseEnrolmentResponseModel create(CourseEnrolmentRequestModel requestModel);
+}

src/main/java/course_enrolment_use_case/CourseEnrolmentInteractor.java

@@ -0,0 +1,65 @@
+package course_enrolment_use_case;
+
+
+// Use case layer
+
+import entities.*;
+
+public class CourseEnrolmentInteractor implements CourseEnrolmentInputBoundary {
+    final CourseEnrolmentDsGateway courseEnrolmentDsGateway;
+    final CourseEnrolmentPresenter courseEnrolmentPresenter;
+    final CourseMap courseMap;
+    final String studentID;
+
+    public CourseEnrolmentInteractor(CourseEnrolmentDsGateway courseEnrolmentDsGateway, CourseEnrolmentPresenter courseEnrolmentPresenter,
+                                     CourseMap courseMap, String studentID) {
+        this.courseEnrolmentDsGateway = courseEnrolmentDsGateway;
+        this.courseEnrolmentPresenter = courseEnrolmentPresenter;
+        this.courseMap = courseMap;
+        this.studentID = studentID;
+    }
+
+    /**
+     * Executes task in the request model and returns the corresponding response model
+     * @param requestModel the input from the student user
+     */
+    @Override
+    public CourseEnrolmentResponseModel create(CourseEnrolmentRequestModel requestModel) {
+
+        // At least one field left blank
+        if (requestModel.getCourseName().equals("") || requestModel.getCourseInstructor().equals("")
+        || requestModel.getStudentID().equals("")) {
+            return courseEnrolmentPresenter.prepareFailView("Please fill in all required information." );
+        }
+
+        // checks if given course id is in the map of existing courses
+        if (CourseMap.findCourse(requestModel.getCourseID()) == null) {
+            return courseEnrolmentPresenter.prepareFailView("Entered information does not correspond to an existing course.");
+        }
+
+        // checks whether the student is already enrolled in the course
+        // CourseMap is courseid : Course object
+        // with course id, find its corresponding Course value, go to its students parameter, and search through that :)
+
+        // to do
+//        if (CourseMap.value(requestModel.getCourseID()).contains(courseEnrolmentDsGateway.existsByStudent(requestModel.getStudentID()))) {
+//            return courseEnrolmentPresenter.prepareFailView("Already enrolled in course.");
+//        }
+
+        // checks passed; student id can be added to course's students parameter
+
+        // get the student's id (their username)
+        String enrolledStudent = requestModel.getStudentID();
+        // to do: add the student id to the associated courses' task parameter
+        // .getStudentId.add.......
+
+        // course edits updated
+        // to do: need a 'updateCourse' method?
+
+        // sent to presenter
+        // to do: fix this
+        CourseEnrolmentResponseModel enrolmentResponseModel =
+                new CourseEnrolmentResponseModel(enrolledStudent.toLowerCase());
+        return courseEnrolmentPresenter.prepareSuccessView(enrolmentResponseModel);
+    }
+}

src/main/java/course_enrolment_use_case/CourseEnrolmentPresenter.java

@@ -0,0 +1,19 @@
+package course_enrolment_use_case;
+
+// Use case layer
+
+
+public interface CourseEnrolmentPresenter {
+
+    /**
+     * Alerts student user that course enrolment is successful
+     * @param newStudent output from the program (the student user that is enrolled in the course)
+     */
+    CourseEnrolmentResponseModel prepareSuccessView(CourseEnrolmentResponseModel newStudent);
+
+    /**
+     * Alerts student user that course enrolment attempt failed
+     * @param error the output from the program
+     */
+    CourseEnrolmentResponseModel prepareFailView(String error);
+}

src/main/java/course_enrolment_use_case/CourseEnrolmentRequestModel.java

@@ -0,0 +1,45 @@
+package course_enrolment_use_case;
+
+// Use case layer
+
+public class CourseEnrolmentRequestModel {
+    private String courseName;
+    private String courseInstructor;
+    private final String courseID;
+    private final String studentID;
+
+    public CourseEnrolmentRequestModel(String courseName, String courseInstructor,
+                                       String studentID) {
+        this.courseName = courseName;
+        this.courseInstructor = courseInstructor;
+        this.courseID = courseName + courseInstructor;
+        this.studentID = studentID;
+    }
+
+    /**
+     * Change getters to public?
+     */
+    public String getCourseName() {
+        return courseName;
+    }
+
+    public void setCourseName() {
+        this.courseName = courseName;
+    }
+
+    public String getCourseInstructor() {
+        return courseInstructor;
+    }
+
+    public void setCourseInstructor() {
+        this.courseInstructor = courseInstructor;
+    }
+
+    public String getCourseID() {
+        return courseID;
+    }
+
+    public String getStudentID() {
+        return studentID;
+    }
+}

src/main/java/course_enrolment_use_case/CourseEnrolmentResponseModel.java

@@ -0,0 +1,27 @@
+package course_enrolment_use_case;
+
+import java.util.ArrayList;
+
+public class CourseEnrolmentResponseModel {
+    String studentID;
+//    ArrayList<String> tasks; // not sure if this goes here
+
+
+    /**
+     * The info that is stored in the database
+     * The CourseMap will only be storing the IDs of enrolled StudentUsers
+     * @param studentID the ID corresponding to the StudentUser
+     */
+    public CourseEnrolmentResponseModel(String studentID) {
+        this.studentID = studentID;
+//        this.tasks = tasks;
+    }
+
+    public String getStudentID() {
+        return studentID;
+    }
+
+//    public ArrayList<String> getTasks() {
+//        return tasks;
+//    }
+}