nus-cs2113-AY2425S1 · Ridiculouswifi · Nov 2, 2024 · Nov 2, 2024 · Nov 2, 2024 · Nov 2, 2024
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ This product aims to streamline the tracking of internship applications for the
 
 **By using this tool, the user can:**
 
-**Store Important seedu.duke.Internship Information:** Users can input and store key details such as the role, company, duration, required skills, application deadlines, and any additional notes.
+**Store Important seedu.EasInternship.Internship Information:** Users can input and store key details such as the role, company, duration, required skills, application deadlines, and any additional notes.
 
 **Track Application Status:** Users can save the current status of their application (e.g., not applied, applied, interview scheduled, offer received) and update it as the application progresses.
 

diff --git a/build.gradle b/build.gradle
@@ -29,7 +29,7 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.EasInternship")
+    mainClass.set("seedu.EasInternship.EasInternship")
 }
 
 shadowJar {

diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -7,7 +7,7 @@
 ## Design & implementation
 
 1. [Design](#1-design)
-    1. [Architecture](#11-architecture)
+    1. [Architecture](#11-Architecture)
     2. [UI Component](#12-UI-component)
     3. [Logic Component](#13-logic-component)
     4. [Model Component](#14-model-component)
@@ -20,12 +20,12 @@
     5. [DeleteCommand Implementation](#deletecommand-implementation)
     6. [SortCommand Implementation](#sortcommand-implementation)
     7. [UpdateCommand Implementation](#updatecommand-implementation)
-    8. [RemoveCommand Implementation](#removecommand-implementation)
+    8. [RemoveCommand Implementation](#RemoveCommand-implementation)
 ---
 
 ## About the Product
 1. [Product Scope](#Product-Scope)
-   1. [Target User Profile](#Target-user-profile)
+   1. [Target User Profile](#Target-User-Profile)
    2. [Value Proposition](#Value-proposition)
 2. [User Stories](#User-Stories)
 3. [Non-Functional Requirements](#Non-Functional-Requirements)
@@ -195,13 +195,13 @@ The `SortCommand` class is responsible for sorting the internship listings based
    - `"duration"`: Sorts internships by duration (start and end dates).
    - `"deadline"`: Sorts internships by deadline.
    - `"skills"`: Sorts internships by the first skill in the skills list alphabetically.
-   - `"status"`: Sorts internships by status alphabetically.
+   - `"status"`: Sort internships by status, (application pending, application completed, accepted, rejected) with this ascending order. Within the same status, the order is sorted by role.
    - `"company"`: Sorts internships by company alphabetically.
    - `"role in favourite"`: Sorts internships in favourite by role alphabetically.
    - `"duration in favourite"`: Sorts internships in favourite by duration (start and end dates).
    - `"deadline in favourite"`: Sorts internships in favourite by deadline.
    - `"skills in favourite"`: Sorts internships in favourite by the first skill in the skills list alphabetically.
-   - `"status in favourite"`: Sorts internships in favourite by status alphabetically.
+   - `"status in favourite"`: Sort internships in favourite by status, (application pending, application completed, accepted, rejected) with this ascending order. Within the same status, the order is sorted by role.
    - `"company in favourite"`: Sorts internships in favourite by company alphabetically.
 - If the user provides an invalid sort option, the command returns an error and defaults to listing internships by ID.
 - **`getUsage()`**: Returns a string showing the correct usage of the `sort` command, including valid options like "alphabet", "deadline", "duration", "skills", and "status".
@@ -210,12 +210,12 @@ The `SortCommand` class is responsible for sorting the internship listings based
 1. The user enters `sort -role`, and the `execute` method sorts the internships by role alphabetically.
 2. The user enters `sort -duration`, and the internships are sorted by their start and end dates.
 3. The user enters `sort -skills`, and the internships are sorted by the first skill alphabetically.
-4. The user enters `sort -status`, and the internships are sorted by their status alphabetically.
+4. The user enters `sort -status`, and the internships are sorted by status, (application pending, application completed, accepted, rejected) with this ascending order. Within the same status, the order is sorted by role.
 5. The user enters `sort -deadline`, and the internships are sorted by each of their earliest deadline.
 6. The user enters `sort -company`, and the internships are sorted by their company alphabetically.
 7. The user enters `sort -role in favourite`, and the `execute` method sorts the internships in favourite by role.
 8. The user enters `sort -duration  in favourite`, and the internships in favourite are sorted by their start and end dates.
-9. The user enters `sort -skills in favourite`, and the internships in favourite are sorted by the first skill alphabetically.
+9. The user enters `sort -skills in favourite`, and the internships in favourite are sorted by status, (application pending, application completed, accepted, rejected) with this ascending order. Within the same status, the order is sorted by role.
 10. The user enters `sort -status in favourite`, and the internships in favourite are sorted by their status alphabetically.
 11. The user enters `sort -deadline in favourite`, and the internships in favourite are sorted by each of their earliest deadline.
 12. The user enters `sort -company in favourite`, and the internships in favourite are sorted by their company alphabetically.
@@ -332,8 +332,8 @@ The `RemoveCommand` class is responsible for removing the values within fields o
 The following sequence diagram shows how the `RemoveCommand` is executed:
 ![](UML/RemoveCommand_Sequence_Diagram.png)
 
-## Product scope
-### Target user profile
+## Product Scope
+### Target User Profile
 
 The target user profile for EasInternship includes:
 
@@ -350,7 +350,7 @@ For example, John is a Computer Engineering Junior with the following characteri
 
 These traits make John a suitable candidate to use EasInternship.
 
-### Value proposition
+### Value Proposition
 
 This product helps users streamline the process of tracking and managing their internship applications by allowing them to:
 

diff --git a/docs/UML/AddCommand.puml b/docs/UML/AddCommand.puml
@@ -1,5 +1,5 @@
 @startuml
-title ":AddCommand" Sequence Diagram
+title AddCommand Sequence Diagram
 hide footbox
 
 participant ":User"
@@ -15,43 +15,29 @@ activate ":AddCommand" #red
 activate ":uiCommand" #green
 ":AddCommand"->":AddCommand" : Initialize variables
 
-loop for each arg in args
-  ":AddCommand" -> ":AddCommand" : split arg into flag and data
-  alt flag == "role"
-    ":AddCommand" -> ":AddCommand": hasRole = true
+loop Process each argument in args
+  ":AddCommand" -> ":AddCommand" : process flag and data
+  alt flag is valid
     alt data is present
-      ":AddCommand"-> ":AddCommand": set role
+      ":AddCommand" -> ":AddCommand" : set data
     else
-      ":AddCommand" -> ":uiCommand": addInvalidFlag("role")
-    end
-  else flag -- "company"
-    ":AddCommand" -> ":AddCommand": hasCompany = true
-    alt data is present
-      ":AddCommand"->":AddCommand": set company
-    else
-      ":AddCommand"->":uiCommand": addInvalidFlag("company")
-    end
-  else flag == "from"
-        alt data is present
-            ":AddCommand" -> ":AddCommand": set startDate
-        else
-            ":AddCommand" -> ":uiCommand": addInvalidFlag("from")
-        end
-    else flag == "to"
-        alt data is present
-            ":AddCommand" -> ":AddCommand": set endDate
-        else
-            ":AddCommand" -> ":uiCommand": addInvalidFlag("to")
-        end
-    else
-        ":AddCommand" -> ":uiCommand": addInvalidFlag(flag)
+      ":AddCommand" -> ":uiCommand" : addInvalidFlag(flag)
+      activate ":uiCommand" #green
+      deactivate ":uiCommand"
     end
+  else
+    ":AddCommand" -> ":uiCommand" : addInvalidFlag(flag)
+    activate ":uiCommand" #green
+    deactivate ":uiCommand"
+  end
 end
 
 alt invalid flags found
   ":AddCommand"->":uiCommand": printInvalidFlags()
+  activate ":uiCommand" #green
+  deactivate ":uiCommand"
 else all required flags present
-  ":AddCommand" -> ":Internship": new ":Internship"(role, company, startDate, endDate)
+  ":AddCommand" -> ":Internship" **: new Internship(role, company, startDate, endDate)
   activate ":Internship" #blue
   ":AddCommand"-> ":InternshipList": addInternship(newInternship)
   activate ":InternshipList" #aquamarine

diff --git a/docs/UML/AddCommand_Sequence_Diagram.png b/docs/UML/AddCommand_Sequence_Diagram.png
diff --git a/docs/UML/Internship-Model_Component.png b/docs/UML/Internship-Model_Component.png
diff --git a/docs/UML/Internship.puml b/docs/UML/Internship.puml
@@ -2,34 +2,24 @@
 
 Title Model Component
 skinparam classAttributeIconSize 0
+hide circle
 class Internship {
-    - int id
-    - String role
-    - String company
-    - YearMonth startDate
-    - YearMonth endDate
-    - List<Deadline> deadlines
-    - ArrayList<String> skills
-    - String status
-
-    + Internship(String role, String company, String start, String end)
-    + void updateStatus(String userStatus) throws InvalidStatus
-    + int getId()
-    + String getRole()
-    + String getCompany()
-    + String getStartDate()
-    + String getEndDate()
-    + String getStatus()
-    + void setStartDate(String start) throws DateTimeParseException
-    + void setEndDate(String end) throws DateTimeParseException
-    + void addDeadline(String description, String date) throws DateTimeParseException
-    + List<Deadline> getDeadlines()
-    + void removeDeadline(String description)
-    + void clearDeadlines()
-    + String getSkills()
-    + void setSkills(String skills)
-    + void removeSkill(String skill) throws MissingValue
-    + String toString()
+    - id: int
+    - role: String
+    - company: String
+    - startDate: YearMonth
+    - endDate: YearMonth
+    - deadlines: List<Deadline>
+    - skills: ArrayList<String>
+    - status: String
+
+    + updateStatus(String userStatus): void
+    + setStartDate(String start): void
+    + setEndDate(String end): void
+    + addDeadline(String description, String date): void
+    + removeDeadline(String description): void
+    + setSkills(String skills): void
+    + removeSkill(String skill): void
 }
 
 
@@ -38,31 +28,20 @@ class InternshipList {
         - internships : ArrayList<Internship>
         - ui : UiInternshipList
 
-        + InternshipList()
-        + addInternship(internship : Internship) : void
-        + isWithinBounds(index : int) : boolean
-        + removeInternship(index : int) : void
-        + getInternship(index : int) : Internship
-        + updateField(index : int, field : String, value : String) : void
-        + listAllInternships() : void
-        + getAllInternships() : List<Internship>
-        + getSize() : int
-        - updateIds() : void
+        + addInternship(internship : Internship): void
+        + removeInternship(index : int): void
+        + updateField(index : int, field : String, value : String): void
+        + listAllInternships(): void
     }
 
 class Deadline {
         - internshipID : int
         - description : String
         - date : LocalDate
 
-        + Deadline(internshipID : int, description : String, date : String)
-        + getInternshipId() : int
         + setInternshipId(internshipId : int) : void
-        + getDescription() : String
         + setDescription(description : String) : void
         + setDate(date : String) : void
-        + getDate() : String
-        + toString() : String
     }
 
 InternshipList "1" --> "*" Internship

diff --git a/docs/UML/loadFromFile.png b/docs/UML/loadFromFile.png
diff --git a/docs/UML/loadFromFile.puml b/docs/UML/loadFromFile.puml
@@ -4,39 +4,63 @@ hide footbox
 participant ":User"
 participant ":EasInternship"
 participant ":Storage"
-participant ":InternshipList"
 participant ":Internship"
-participant ":FileReader"
+participant ":InternshipList"
 
 ":User"->":EasInternship": start program
 activate ":EasInternship" #green
-":EasInternship"->":InternshipList": new ":InternshipList"()
+":EasInternship"-->":InternshipList" **: create
 activate ":InternshipList" #aquamarine
+deactivate ":InternshipList"
 ":EasInternship"->":Storage": loadFromFile(internshipList)
 activate ":Storage" #orange
-":Storage"->":FileReader" :read(file)
-activate ":FileReader" #red
-":FileReader"-> ":Storage": data lines
 
 loop for each line in file
-    ":Storage"-> ":Internship" : new ":Internship"(role, company, startDate, endDate)
+
+    alt line starts with "FAVOURITES:"
+        ":Storage" -> ":Storage" : add favInternshipId to favouriteIds
+        activate ":Storage" #orange
+        return
+
+        end
+
+    ":Storage"-> ":Internship" **: new Internship(role, company, startDate, endDate)
     activate ":Internship" #blue
-    ":Internship"->":InternshipList": addInternship
+    ":Storage"->":InternshipList": addInternship(internship)
+    activate ":InternshipList" #aquamarine
+    deactivate ":InternshipList"
     ":Storage" -> ":Internship" :setSkills(skills)
+    activate ":Internship" #blue
+    deactivate ":Internship"
     ":Storage" -> ":Internship" : setStatus(status)
+    activate ":Internship" #blue
     deactivate ":Internship"
 
     ":Storage" -> ":Storage": parseDeadlines(deadlineString, internshipId)
-        activate ":Storage" #orange
+    activate ":Storage" #orange
+    return List<Deadline> loadedDeadlines
+    loop for deadline in loadedDeadlines
+        ":Storage" -> ":Internship" : addDeadline(description, date)
+        activate ":Internship" #blue
+        deactivate ":Internship"
+    end
 
-        ":Storage" -> ":Deadline": new Deadline (description, date)
-        activate ":Deadline" #purple
-        deactivate ":Deadline"
-        deactivate ":Storage"
+    loop for favInternshipId in favouriteIds
+        ":Storage" -> ":InternshipList" : getInternship(favInternshipId)
+        activate ":InternshipList" #aquamarine
+        ":InternshipList" --> ":Storage" : favInternship
+        deactivate ":InternshipList"
+        ":Storage" -> ":InternshipList" : add to favouriteInternships
+        activate ":InternshipList" #aquamarine
+        deactivate ":InternshipList"
+    end
 
-        ":Internship" -> ":Deadline" : addDeadline(deadline)
+        deactivate ":Storage"
+        deactivate ":Internship"
+        deactivate ":InternshipList"
 end
-deactivate ":FileReader"
 deactivate ":Storage"
+
+
 @enduml
 
diff --git a/docs/UML/saveToFile.puml b/docs/UML/saveToFile.puml
@@ -6,21 +6,20 @@ participant ":EasInternship"
 participant ":Storage"
 participant ":InternshipList"
 participant ":Internship"
-participant ":FileWriter"
 
 ":User" -> ":EasInternship": exit program
 activate ":EasInternship" #green
 ":EasInternship" -> ":Storage" : saveToFile(internshipList)
 activate ":Storage" #orange
 ":Storage" -> ":InternshipList" : getAllInternships()
 activate ":InternshipList" #aquamarine
-":InternshipList" -> ":Storage" : List<":Internship">
+":InternshipList" --> ":Storage" : List<":Internship">
 deactivate ":InternshipList"
 
 loop for each ":Internship"
 ":Storage"-> ":Internship" : get each attribute
 activate ":Internship" #blue
-":Internship" -> ":Storage" : List<Deadline>
+":Internship" --> ":Storage" : List<Deadline>
 deactivate ":Internship"
     loop for each Deadline
         ":Storage" -> Deadline : get each attribute
@@ -29,8 +28,5 @@ deactivate ":Internship"
     end
 end
 
-":Storage" -> ":FileWriter" : write(internship data)
-activate ":FileWriter" #red
-deactivate ":FileWriter"
 deactivate ":Storage"
 @enduml