Merge remote-tracking branch 'upstream/master'

tsulim · Apr 14, 2024 · 8eb712a · 8eb712a
2 parents 2c1ae30 + 1ba7fce
commit 8eb712a
Show file tree

Hide file tree

Showing 16 changed files with 264 additions and 227 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
diff --git a/docs/diagrams/SortActivityDiagram.puml b/docs/diagrams/SortActivityDiagram.puml
@@ -6,18 +6,22 @@ start
 :User enters a sort command;
 
 
-if() then ([attributes are not sortable])
-    :get person from list;
-        while (have person to compare)
-            while(attribute value with the next person in the list are equal or no more attributes)
-                :use next attribute to check;
-            endwhile
-            if() then ([person smaller])
-                :shift front;
-            else([person bigger])
-                :shift back;
+if() then ([attributes are sortable])
+    if () then ([list is not empty])
+        repeat
+            :get next person in list
+            and adds to sorted list;
+            :compare with persons in sorted list;
+            if () then ([person smaller])
+                :shift up;
+            else if () then ([person same])
+            else (                             [person bigger])
+                :shift down;
             endif
-        endwhile
+        repeat while () is ([have next person to sort]) not ([no more person to sort])
+
+    else ([list is empty])
+    endif
     :Shows sorted person list;
 else([any attribute is not sortable])
     :displays Sort Usage message;

diff --git a/docs/images/SortActivityDiagram.png b/docs/images/SortActivityDiagram.png
diff --git a/docs/images/afterCorruptDataFile.png b/docs/images/afterCorruptDataFile.png
diff --git a/docs/images/afterCorruptDataFileResult.png b/docs/images/afterCorruptDataFileResult.png
diff --git a/docs/images/afterValidModificationToDataFile.png b/docs/images/afterValidModificationToDataFile.png
diff --git a/docs/images/afterValidModificationToDataFileResult.png b/docs/images/afterValidModificationToDataFileResult.png
diff --git a/docs/images/beforeCorruptDataFile.png b/docs/images/beforeCorruptDataFile.png
diff --git a/docs/images/beforeCorruptDataFileResult.png b/docs/images/beforeCorruptDataFileResult.png
diff --git a/docs/images/beforeValidModificationToDataFileResult.png b/docs/images/beforeValidModificationToDataFileResult.png
diff --git a/docs/team/tsulim.md b/docs/team/tsulim.md
@@ -9,38 +9,23 @@ StaffConnect offers convenience and peace of mind to a struggling student with m
 
 Given below are my contributions to the project.
 
-* **New Feature**: Added the ability to undo/redo previous commands.
-  * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
-  * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
-  * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
-  * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*
+* **New Feature**: Added a `fav` and `unfav` command that allows the user to set contacts as Favourite, prioritizing them at the top of the list.
+  * What it does: allows the user to set selected contact as favourite. Preceding `unfav` commands can be reversed by using the redo command.
+  * Justification: This feature improves the product significantly because a user can view contacts that they prioritize at the top without the need to search below, bringing them more conveniences.
 
-* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
-
-* **Code contributed**: [RepoSense link]()
+* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s2.github.io/tp-dashboard/?search=tsulim&sort=groupTitle%20dsc&sortWithin=title&since=2024-02-23&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false&tabOpen=true&tabType=authorship&tabAuthor=tsulim&tabRepo=AY2324S2-CS2103-F08-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
 
 * **Project management**:
   * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
 
-* **Enhancements to existing features**:
-  * Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
-  * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())
-
 * **Documentation**:
   * User Guide:
-    * Added documentation for the features `delete` and `find` [\#72]()
-    * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
+    * Added documentation for the features `fav` and `unfav`: [\#140](https://github.com/AY2324S2-CS2103-F08-3/tp/pull/140), [\#165](https://github.com/AY2324S2-CS2103-F08-3/tp/pull/165), [\#237](https://github.com/AY2324S2-CS2103-F08-3/tp/pull/237)
   * Developer Guide:
-    * Added implementation details of the `delete` feature.
+    * Added implementation details of the `fav`/`unfav` feature: [\#151](https://github.com/AY2324S2-CS2103-F08-3/tp/pull/151), [\#165](https://github.com/AY2324S2-CS2103-F08-3/tp/pull/165)
 
 * **Community**:
-  * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
-  * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
-  * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
-  * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())
-
-* **Tools**:
-  * Integrated a third party library (Natty) to the project ([\#42]())
-  * Integrated a new Github plugin (CircleCI) to the team repo
+  * PRs reviewed (with non-trivial review comments): [\#32](https://github.com/AY2324S2-CS2103-F08-3/tp/pull/32), [\#104](https://github.com/AY2324S2-CS2103-F08-3/tp/pull/104)
+  * Reported bugs and suggestions for other teams in the module (examples: [1](https://github.com/AY2324S2-CS2103T-T10-1/tp/issues/368))
 
 * _{you can add/remove categories in the list above}_
diff --git a/src/main/java/staffconnect/logic/Messages.java b/src/main/java/staffconnect/logic/Messages.java
@@ -44,9 +44,9 @@ public static String format(Person person) {
                 .append("; Phone: ")
                 .append(person.getPhone())
                 .append("; Email: ")
-                .append(person.getFaculty())
-                .append("; Faculty: ")
                 .append(person.getEmail())
+                .append("; Faculty: ")
+                .append(person.getFaculty())
                 .append("; Venue: ")
                 .append(person.getVenue())
                 .append("; Module: ")

diff --git a/src/main/java/staffconnect/logic/commands/SortCommand.java b/src/main/java/staffconnect/logic/commands/SortCommand.java
@@ -26,7 +26,7 @@ public class SortCommand extends Command {
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Sort all persons by the attribute specified "
             + "and displays them as a list with index numbers.\n"
-            + "Parameters: [ATTRIBUTE]\n"
+            + "Parameters: "
             + "[" + PREFIX_NAME + "] "
             + "[" + PREFIX_PHONE + "] "
             + "[" + PREFIX_MODULE + "] "

diff --git a/src/main/java/staffconnect/model/person/Faculty.java b/src/main/java/staffconnect/model/person/Faculty.java
@@ -26,9 +26,8 @@ public enum FacultyName {
         CONTINUING_AND_LIFELONG_EDUCATION("School of Continuing and Lifelong Education",
                 "Continuing and Lifelong Education", "SCALE"),
         DENTISTRY("Faculty of Dentistry", "Dentistry"),
-        DESIGN_AND_ENVIRONMENT("School of Design and Environment", "Design and Environment", "SDE"),
+        DESIGN_AND_ENGINEERING("College of Design and Engineering", "Design and Engineering", "CDE"),
         DUKE_NUS_MEDICAL_SCHOOL("Duke-NUS Medical School", "Duke-NUS"),
-        ENGINEERING("Faculty of Engineering", "Engineering", "FoE"),
         INTEGRATIVE_SCIENCES_AND_ENGINEERING("Integrative Sciences and Engineering", "ISEP"),
         LAW("Faculty of Law", "Law"),
         MEDICINE("Yong Loo Lin School of Medicine", "Medicine", "School of Medicine"),

diff --git a/src/test/java/staffconnect/model/person/predicates/PersonHasFacultyPredicateTest.java b/src/test/java/staffconnect/model/person/predicates/PersonHasFacultyPredicateTest.java
@@ -58,7 +58,7 @@ public void test_personDoesNotHaveFaculty_returnsFalse() {
 
     @Test
     public void toStringMethod() {
-        Faculty faculty = new Faculty("Engineering");
+        Faculty faculty = new Faculty("CDE");
         PersonHasFacultyPredicate predicate = new PersonHasFacultyPredicate(faculty);
 
         String expected = PersonHasFacultyPredicate.class.getCanonicalName() + "{faculty=" + faculty + "}";