Merge branch 'master' of https://github.com/AY2324S2-CS2103T-T08-3/tp …

…into bug-fix-2
AY2324S2-CS2103T-T08-3 · Apr 14, 2024 · 118d185 · 118d185
2 parents ab484dd + c3a3cb3
commit 118d185
Show file tree

Hide file tree

Showing 15 changed files with 174 additions and 56 deletions.
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -15,7 +15,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 [[homepage](https://github.com/ZHANGTIANYAO1)]
 [[github](https://github.com/ZHANGTIANYAO1)]
-[[portfolio](team/zhangtianyao.md)]
+[[portfolio](team/zhangtianyao1.md)]
 
 * Role: Project Advisor
 

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
@@ -24,6 +24,8 @@ Class Phone
 Class Salary
 Class Tag
 Class ProgammingLanguage
+Class JobDifficulty
+Class Priority
 
 Class I #FFFFFF
 }
@@ -50,6 +52,8 @@ Person *--> Info
 Person *--> CompanyName
 Person *--> Salary
 Person *--> InterviewTime
+Person *--> JobDifficulty
+Person *--> Priority
 Person *--> "*" Tag
 Person *-right-> "*" ProgammingLanguage
 

diff --git a/docs/images/ModelClassDiagram.png b/docs/images/ModelClassDiagram.png
diff --git a/docs/index.md b/docs/index.md
@@ -3,7 +3,7 @@ layout: page
 title: CCBOT
 ---
 
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions) 
+[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
 [![codecov](https://codecov.io/gh/AY2324S2-CS2103T-T08-3/tp/graph/badge.svg?token=0RG4SRDBHW)](https://codecov.io/gh/AY2324S2-CS2103T-T08-3/tp)
 
 

diff --git a/docs/team/zhangtianyao1.md b/docs/team/zhangtianyao1.md
@@ -0,0 +1,40 @@
+---
+layout: page
+title: Zhang Tianyao's Project Portfolio Page
+---
+
+### Project: CCBOT
+
+CCBOT is a desktop application for managing your job application details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+
+Given below are my contributions to the project.
+
+* **New Feature**: Added the ability to sort person list.
+    * What it does: allows the user to sort the person list by name, company name, job difficulty, priority, salary, and interview date.
+    * Justification: This feature improves the product significantly because a user can easily find the person he/she wants to check.
+    * 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.
+
+* **New Feature**: Added the job difficulty model.
+    * What it does: allows the program auto calculate the job difficulty based on the job description.
+    * Justification: This feature improves the product significantly because a user can easily identify the job difficulty.
+    * 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.
+
+* **Project management**:
+    * Managed releases `v1.2` - `v1.4` (4 releases) on GitHub
+
+* **Enhancements to existing features**:
+    * Add salary range to the person card (Pull requests [\#20]())
+    * Fix add command examples (Pull requests [\#35]())
+    * Add job difficulty comparator (Pull requests [\#69]())
+    * Add priority to person card (Pull requests [\#39]())
+
+* **Documentation**:
+    * User Guide:
+        * Added documentation for the features `sort` and `job difficulty` [\#93]() [\#86]()
+        * Added documentation for the constraints of the `add`, `edit` and `add resume` command [\#169]()
+    * Developer Guide:
+        * Added implementation details of the `sort` feature.
+          * Added implementation details of the `job difficulty` feature.[\#54]()
+        * Update UML diagrams. [\#37]()
+        * Add UML diagrams for `sort` command. [\#43]()
+
diff --git a/src/main/java/seedu/address/logic/Messages.java b/src/main/java/seedu/address/logic/Messages.java
@@ -37,7 +37,10 @@ public static String getErrorMessageForDuplicatePrefixes(Prefix... duplicatePref
      */
     public static String format(Person person) {
         final StringBuilder builder = new StringBuilder();
-        builder.append(person.getName())
+        builder.append("Company name: ")
+                .append(person.getCompanyName())
+                .append("; Name: ")
+                .append(person.getName())
                 .append("; Phone: ")
                 .append(person.getPhone())
                 .append("; Email: ")
@@ -49,6 +52,7 @@ public static String format(Person person) {
                 .append("; Salary: ")
                 .append(person.getSalary())
                 .append("$")
+                .append("; Info: ")
                 .append(person.getInfo())
                 .append("; Tags: ");
         person.getTags().forEach(builder::append);

diff --git a/src/main/java/seedu/address/logic/commands/FilterCommand.java b/src/main/java/seedu/address/logic/commands/FilterCommand.java
@@ -17,10 +17,10 @@ public abstract class FilterCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Filters the contact by various categories and "
             + "displays them as a list with index numbers.\n"
             + "Parameters:\n"
-            + "- " + COMMAND_WORD + PREFIX_TAG + "TAG [MORE TAG]...\n"
-            + "- " + COMMAND_WORD + PREFIX_SALARY + "SALARY_RANGE [MORE SALARY_RANGE]...\n"
-            + "- " + COMMAND_WORD + PREFIX_INTERVIEWTIME + "INTERVIEW_TIME_RANGE [MORE INTERVIEW_TIME_RANGE]...\n"
-            + "- " + COMMAND_WORD + PREFIX_PROGRAMMING_LANGUAGE
+            + "- " + PREFIX_TAG + "TAG [MORE TAG]...\n"
+            + "- " + PREFIX_SALARY + "SALARY_RANGE [MORE SALARY_RANGE]...\n"
+            + "- " + PREFIX_INTERVIEWTIME + "INTERVIEW_TIME_RANGE [MORE INTERVIEW_TIME_RANGE]...\n"
+            + "- " + PREFIX_PROGRAMMING_LANGUAGE
             + "PROGRAMMING_LANGUAGE [MORE PROGRAMMING_LANGUAGE]...\n"
             + "Example: " + COMMAND_WORD + " s/2000 5000-7000";
 }
diff --git a/src/main/java/seedu/address/logic/commands/FilterInterviewTimeCommand.java b/src/main/java/seedu/address/logic/commands/FilterInterviewTimeCommand.java
@@ -25,11 +25,13 @@ public class FilterInterviewTimeCommand extends FilterCommand {
             + "- from/INTERVIEW_TIME-INTERVIEW_TIME\n"
             + "Example:\n"
             + "- " + COMMAND_WORD + "before/020220241100 after/020220251100 from/030420240800-020520241100";
-    public static final String WRONG_INTERVIEW_TIME_RANGE_MESSAGE = "INTERVIEW_TIME_RANGE should be in the form of:\n"
-            + "before/INTERVIEW_TIME\nor\n"
-            + "after/INTERVIEW_TIME\nor\n"
-            + "from/INTERVIEW_TIME-INTERVIEW_TIME\n"
-            + "where INTERVIEW_TIME is in the form: " + InterviewTime.INTERVIEW_TIME_FORMAT
+    public static final String WRONG_INTERVIEW_TIME_RANGE_MESSAGE = "For INTERVIEW_TIME_RANGE starting with from/ :\n"
+            + " Format: from/INTERVIEW_TIME-INTERVIEW_TIME\n"
+            + " where:\n"
+            + "    1) There are no white spaces before and after '-'\n"
+            + "    2) The first INTERVIEW_TIME provided should be chronologically before or equal to the second "
+            + "INTERVIEW_TIME\n"
+            + "    3) INTERVIEW_TIME is in the form: " + InterviewTime.INTERVIEW_TIME_FORMAT
             + "\n Example: from/" + InterviewTime.EXAMPLE_INTERVIEW_TIME_FORMAT_1 + "-"
             + InterviewTime.EXAMPLE_INTERVIEW_TIME_FORMAT_2;
 

diff --git a/src/main/java/seedu/address/logic/commands/FindCommand.java b/src/main/java/seedu/address/logic/commands/FindCommand.java
@@ -36,6 +36,7 @@ public CommandResult execute(Model model) {
 
     @Override
     public boolean equals(Object other) {
+        assert 1 == 1;
         if (other == this) {
             return true;
         }

diff --git a/src/main/java/seedu/address/logic/parser/FilterInterviewTimeCommandParser.java b/src/main/java/seedu/address/logic/parser/FilterInterviewTimeCommandParser.java
@@ -67,6 +67,10 @@ private static List<List<InterviewTime>> handleFromInterviewTime(ArgumentMultima
                 for (String interviewTime : range) {
                     rangeTimes.add(ParserUtil.parseInterviewTime(interviewTime));
                 }
+                if (rangeTimes.get(1).isBefore(rangeTimes.get(0))) {
+                    throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT,
+                            FilterInterviewTimeCommand.WRONG_INTERVIEW_TIME_RANGE_MESSAGE));
+                }
                 interviewTimes.add(rangeTimes);
             }
         }

diff --git a/src/main/java/seedu/address/model/person/InterviewTime.java b/src/main/java/seedu/address/model/person/InterviewTime.java
@@ -75,10 +75,15 @@ public boolean isWithinInterviewTimeRange(List<InterviewTime> range) {
         } else if (before == null) {
             return this.dateTime.isAfter(after);
         } else {
-            return this.dateTime.isBefore(before) && this.dateTime.isAfter(after);
+            return (this.dateTime.isBefore(before) || this.dateTime.isEqual(before))
+                    && (this.dateTime.isAfter(after) || this.dateTime.isEqual(after));
         }
     }
 
+    public boolean isBefore(InterviewTime date) {
+        return this.dateTime.isBefore(date.getDateTime());
+    }
+
     @Override
     public String toString() {
         DateTimeFormatter beautify = DateTimeFormatter.ofPattern("MMMM dd, yyyy hh:mm a", Locale.ENGLISH);

diff --git a/src/main/java/seedu/address/model/person/Salary.java b/src/main/java/seedu/address/model/person/Salary.java
@@ -8,7 +8,7 @@
  * Represents a Person's salary in the address book.
  */
 public class Salary {
-    public static final String MESSAGE_CONSTRAINTS = "Salaries should only contain numbers, with range [0, 4294967295] "
+    public static final String MESSAGE_CONSTRAINTS = "Salaries should only contain numbers, with range [0, 2147483647] "
             + "or two pure digital numbers with '-' in between. "
             + "There's no space on either side of '-'."
             + "Both digital numbers should be within the range [0, 2147483647]";

diff --git a/src/main/java/seedu/address/model/util/SampleDataUtil.java b/src/main/java/seedu/address/model/util/SampleDataUtil.java
@@ -28,27 +28,27 @@ public static Person[] getSamplePersons() {
                     + "@example.com"),
                 new Address("Blk 30 Geylang Street 29, #06-40"),
                 new InterviewTime("121220221400"), new Salary("0"), new Info("Friend of boss"),
-                getTagSet("friends"), getProgrammingLanguageSet("Java"), 2),
+                getTagSet("friends"), getProgrammingLanguageSet("Java"), 0),
             new Person(new CompanyName("Google"), new Name("Bernice Yu"), new Phone("99272758"),
                     new Email("[email protected]"), new Address("Blk 30 Lorong 3 Serangoon Gardens, #07-18"),
                     new InterviewTime("121220221400"), new Salary("0"), new Info("Friend of boss"),
-                    getTagSet("colleagues", "friends"), getProgrammingLanguageSet("Java"), 2),
+                    getTagSet("colleagues", "friends"), getProgrammingLanguageSet("Java"), 1),
             new Person(new CompanyName("Google"), new Name("Charlotte Oliveiro"), new Phone("93210283"),
                     new Email("[email protected]"), new Address("Blk 11 Ang Mo Kio Street 74, #11-04"),
                     new InterviewTime("121220221400"), new Salary("0"), new Info("Friend of boss"),
                     getTagSet("neighbours"), getProgrammingLanguageSet("Java"), 2),
             new Person(new CompanyName("Google"), new Name("David Li"), new Phone("91031282"),
                     new Email("[email protected]"), new Address("Blk 436 Serangoon Gardens Street 26, #16-43"),
                     new InterviewTime("121220221400"), new Salary("0"), new Info("Friend of boss"),
-                    getTagSet("family"), getProgrammingLanguageSet("Java"), 2),
+                    getTagSet("family"), getProgrammingLanguageSet("Java"), 3),
             new Person(new CompanyName("Google"), new Name("Irfan Ibrahim"), new Phone("92492021"),
                     new Email("[email protected]"), new Address("Blk 47 Tampines Street 20, #17-35"),
                     new InterviewTime("121220221400"), new Salary("0"), new Info("Friend of boss"),
-                    getTagSet("classmates"), getProgrammingLanguageSet("Java"), 2),
+                    getTagSet("classmates"), getProgrammingLanguageSet("Java"), 4),
             new Person(new CompanyName("Amazon"), new Name("Roy Balakrishnan"), new Phone("92624417"),
                     new Email("[email protected]"), new Address("Blk 45 Aljunied Street 85, #11-31"),
                     new InterviewTime("121220221400"), new Salary("0"), new Info("Friend of boss"),
-                    getTagSet("colleagues"), getProgrammingLanguageSet("Java"), 2),
+                    getTagSet("colleagues"), getProgrammingLanguageSet("Java"), 0),
         };
     }
 

diff --git a/src/test/java/seedu/address/model/person/InterviewTimeTest.java b/src/test/java/seedu/address/model/person/InterviewTimeTest.java
@@ -29,6 +29,8 @@ public void testIsWithinInterviewTimeRange() {
         InterviewTime dateTimeAfterRange = new InterviewTime("121120271400");
         InterviewTime dateTimeBeforeRange = new InterviewTime("121120201400");
         InterviewTime dateTimeInRange = new InterviewTime("121120231400");
+        InterviewTime dateTimeEqualAfterDate = new InterviewTime("011120231400");
+        InterviewTime dateTimeEqualBeforeDate = new InterviewTime("121220240300");
 
         // Interview time ranges
         List<InterviewTime> wrongSize = Arrays.asList(null, null, null);
@@ -62,6 +64,10 @@ public void testIsWithinInterviewTimeRange() {
         assertTrue(dateTimeAfterRange.isWithinInterviewTimeRange(validAfter));
         assertTrue(dateTimeBeforeRange.isWithinInterviewTimeRange(validBefore));
         assertTrue(dateTimeInRange.isWithinInterviewTimeRange(validRange));
+        assertTrue(dateTimeEqualAfterDate.isWithinInterviewTimeRange(validRange));
+        assertTrue(dateTimeEqualBeforeDate.isWithinInterviewTimeRange(validRange));
+
+
 
     }
     @Test