User guide, Developer guide updates and bugfixes

docs/DeveloperGuide.adoc

@@ -287,7 +287,7 @@ Each of <<Add Interviewee/Interviewer feature, add>>, <<Edit Interviewee/Intervi
 ==== Add Interviewee/Interviewer feature
 The `add` command feature essentially allows a user to add an `Interviewee` or `Interviewer` object to the underlying `IntervieweeList`
  or `InterviewerList` of `ModelManager`.
-Upon successful parsing of the `add` command arguments, an instance of `Interviewee`/`Interviewer` is created based on the `r/ROLE` prefix supplied,
+Upon successful parsing of the `add` command arguments, an instance of `Interviewee`/`Interviewer` is created based on the preamble supplied,
 which is added to its corresponding list in `ModelManager`.
 The underlying `UniquePersonList` of `IntervieweeList` and `InterviewerList` ensures
 that no duplicate entities are present at any time, checked by Interviewee#isSamePerson() and Interviewer#isSamePerson().
@@ -1049,9 +1049,9 @@ Please refer to the Add interviewees/interviewer section in the <<UserGuide#, us
 For simplicity, we refer to interviewees and interviewers as *entities* collectively.
 
 . Upon launching Scheduler, input the following command to add an interviewee:
-.. `add r/interviewee n/Ronald p/88888888 t/CAP5 t/dogLover f/School of Computing ep/JohnDoe@gmail.com ew/JohnDoe@u.nus.edu y/2018 d/Marketing s/20/09/2019 18:00-18:30`
+.. `add interviewee n/Ronald p/88888888 t/CAP5 t/dogLover f/School of Computing ep/JohnDoe@gmail.com ew/JohnDoe@u.nus.edu y/2 d/Marketing s/20/09/2019 18:00-18:30`
 . To add an interviewer, input the following command:
-.. `add r/interviewer n/Delilah p/98765432 ew/delilah@u.nus.edu d/Marketing s/20/09/2019 18:00-18:30`
+.. `add interviewer n/Delilah p/98765432 ew/delilah@u.nus.edu d/Marketing s/20/09/2019 18:00-18:30`
 . Expected: The Interviewees and Interviewers tab now reflects the newly added interviewee and interviewer, with each column in the tab corresponding to the various fields input.
 (i.e the column in the interviewees tab with header `name` now reflects `Ronald` as input by the user)
 . You can change the different prefix fields (e.g `n/Ronald`) to any valid value, as stated in the User Guide under the `add` command section.

src/main/java/seedu/scheduler/commons/core/Messages.java

@@ -11,8 +11,8 @@ public class Messages {
     public static final String MESSAGE_PERSONS_LISTED_OVERVIEW = "%1$d persons listed!";
     public static final String MESSAGE_CRITICAL_ERROR = "Internal Error!";
     public static final String MESSAGE_INVALID_YEAR_OF_STUDY = "Incorrect year of study format! "
-            + "The year of study must be a positive integer within the range [0, 2^31 - 1].\n"
+            + "The year of study must be a positive integer within the range [1, 5].\n"
             + "Examples:\n"
-            + "Correct: 2019\n"
+            + "Correct: 1\n"
             + "Incorrect: -1";
 }

src/main/java/seedu/scheduler/logic/commands/AddCommand.java

@@ -6,7 +6,6 @@
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_NUS_WORK_EMAIL;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_PERSONAL_EMAIL;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_PHONE;
-import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_ROLE;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_SLOT;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_TAG;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_YEAR_OF_STUDY;
@@ -25,7 +24,6 @@ public abstract class AddCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD
             + ": Adds an entity to the scheduler book. An entity can be an interviewee or interviewer.\n"
             + "Parameters to add interviewees:\n"
-            + PREFIX_ROLE + "interviewee "
             + PREFIX_NAME + "NAME "
             + PREFIX_PHONE + "PHONE "
             + PREFIX_FACULTY + "FACULTY "
@@ -36,16 +34,14 @@ public abstract class AddCommand extends Command {
             + PREFIX_SLOT + "SLOT... "
             + "[" + PREFIX_TAG + "TAG]... \n"
             + "Parameters to add interviewers:\n"
-            + PREFIX_ROLE + "interviewer "
             + PREFIX_NAME + "NAME "
             + PREFIX_PHONE + "PHONE "
             + PREFIX_NUS_WORK_EMAIL + "NUS_WORK_EMAIL "
             + PREFIX_DEPARTMENT + "DEPARTMENT "
             + PREFIX_SLOT + "SLOT... "
             + "[" + PREFIX_TAG + "TAG]... \n"
             + "Example (add interviewee):\n"
-            + COMMAND_WORD + " "
-            + PREFIX_ROLE + DefaultValues.DEFAULT_INTERVIEWEE_ROLE + " "
+            + COMMAND_WORD + " interviewee "
             + PREFIX_NAME + DefaultValues.DEFAULT_NAME + " "
             + PREFIX_PHONE + DefaultValues.DEFAULT_PHONE + " "
             + PREFIX_FACULTY + DefaultValues.DEFAULT_FACULTY + " "
@@ -56,8 +52,7 @@ public abstract class AddCommand extends Command {
             + PREFIX_SLOT + DefaultValues.DEFAULT_SLOT + " "
             + PREFIX_TAG + "friends\n"
             + "Example (add interviewer):\n"
-            + COMMAND_WORD + " "
-            + PREFIX_ROLE + DefaultValues.DEFAULT_INTERVIEWER_ROLE + " "
+            + COMMAND_WORD + " interviewer "
             + PREFIX_NAME + DefaultValues.DEFAULT_NAME + " "
             + PREFIX_PHONE + DefaultValues.DEFAULT_PHONE + " "
             + PREFIX_NUS_WORK_EMAIL + DefaultValues.DEFAULT_NUS_WORK_EMAIL + " "

src/main/java/seedu/scheduler/logic/commands/EditCommand.java

@@ -43,13 +43,13 @@ public abstract class EditCommand extends Command {
             + "[" + PREFIX_DEPARTMENT + "DEPARTMENT] "
             + "[" + PREFIX_SLOT + "SLOT]... "
             + "[" + PREFIX_TAG + "TAG]...\n"
-            + "Example (add interviewee):\n"
+            + "Example (edit interviewee):\n"
             + COMMAND_WORD + " John Doe "
             + PREFIX_ROLE + "interviewee "
             + PREFIX_PHONE + "91234567 "
             + PREFIX_FACULTY + "School of Computing "
-            + PREFIX_SLOT + "05/11/2019 18:00-19:00\n"
-            + "Example (add interviewer):\n"
+            + PREFIX_SLOT + "05/11/2019 18:30-19:00\n"
+            + "Example (edit interviewer):\n"
             + COMMAND_WORD + " John Doe "
             + PREFIX_ROLE + "interviewer "
             + PREFIX_PHONE + "91234567 "

src/main/java/seedu/scheduler/logic/parser/AddCommandParser.java

@@ -1,17 +1,17 @@
 package seedu.scheduler.logic.parser;
 
-import static seedu.scheduler.commons.core.Messages.MESSAGE_CRITICAL_ERROR;
 import static seedu.scheduler.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_DEPARTMENT;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_FACULTY;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_NAME;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_NUS_WORK_EMAIL;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_PERSONAL_EMAIL;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_PHONE;
-import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_ROLE;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_SLOT;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_TAG;
 import static seedu.scheduler.logic.parser.CliSyntax.PREFIX_YEAR_OF_STUDY;
+import static seedu.scheduler.model.person.RoleType.INTERVIEWEE;
+import static seedu.scheduler.model.person.RoleType.INTERVIEWER;
 
 import java.util.List;
 import java.util.Set;
@@ -30,8 +30,6 @@
 import seedu.scheduler.model.person.Interviewer;
 import seedu.scheduler.model.person.Name;
 import seedu.scheduler.model.person.Phone;
-import seedu.scheduler.model.person.Role;
-import seedu.scheduler.model.person.RoleType;
 import seedu.scheduler.model.person.Slot;
 import seedu.scheduler.model.tag.Tag;
 
@@ -46,43 +44,39 @@ public class AddCommandParser implements Parser<AddCommand> {
      * @throws ParseException if the user input does not conform the expected format
      */
     public AddCommand parse(String args) throws ParseException {
-        ArgumentMultimap argMultimap =
-                ArgumentTokenizer.tokenize(args, PREFIX_ROLE, PREFIX_NAME, PREFIX_PHONE, PREFIX_TAG,
+        ArgumentMultimap argMultimap = ArgumentTokenizer.tokenize(args, PREFIX_NAME, PREFIX_PHONE, PREFIX_TAG,
                         PREFIX_FACULTY, PREFIX_YEAR_OF_STUDY, PREFIX_DEPARTMENT, PREFIX_SLOT, PREFIX_PERSONAL_EMAIL,
                         PREFIX_NUS_WORK_EMAIL);
 
-        // common prefixes - present across interviewers and interviewees
-        if (!arePrefixesPresent(argMultimap, PREFIX_ROLE, PREFIX_NAME, PREFIX_PHONE)
-                || !argMultimap.getPreamble().isEmpty()) {
+        // parse the fields differently depending on the preamble.
+        if (argMultimap.getPreamble().isEmpty()) {
             throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
         }
 
-        Role role = ParserUtil.parseRole(argMultimap.getValue(PREFIX_ROLE).get());
-        Name name = ParserUtil.parseName(argMultimap.getValue(PREFIX_NAME).get());
-        Phone phone = ParserUtil.parsePhone(argMultimap.getValue(PREFIX_PHONE).get());
-        Set<Tag> tagList = ParserUtil.parseTags(argMultimap.getAllValues(PREFIX_TAG));
-
-        // hierarchical parsing
-        if (role.getRole().equals(RoleType.INTERVIEWEE)) {
-            return parseAddIntervieweeCommand(argMultimap, name, phone, tagList);
-        } else if (role.getRole().equals(RoleType.INTERVIEWER)) {
-            return parseAddInterviewerCommand(argMultimap, name, phone, tagList);
+        if (argMultimap.getPreamble().equals(INTERVIEWEE.toString().toLowerCase())) {
+            return parseAddIntervieweeCommand(args);
+        }
+        if (argMultimap.getPreamble().equals(INTERVIEWER.toString().toLowerCase())) {
+            return parseAddInterviewerCommand(args);
         }
 
-        // control flow should not reach here.
-        throw new AssertionError(MESSAGE_CRITICAL_ERROR);
+        throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
     }
 
     /**
      * Parses the argument multimap into an AddIntervieweeCommand.
      */
-    private AddIntervieweeCommand parseAddIntervieweeCommand(ArgumentMultimap argMultimap, Name name, Phone phone,
-                                                             Set<Tag> tagSet) throws ParseException {
-        if (!arePrefixesPresent(argMultimap, PREFIX_FACULTY, PREFIX_YEAR_OF_STUDY, PREFIX_FACULTY,
+    private AddIntervieweeCommand parseAddIntervieweeCommand(String args) throws ParseException {
+        ArgumentMultimap argMultimap = ArgumentTokenizer.tokenize(args, PREFIX_NAME, PREFIX_PHONE, PREFIX_TAG,
+                PREFIX_FACULTY, PREFIX_YEAR_OF_STUDY, PREFIX_DEPARTMENT, PREFIX_SLOT, PREFIX_PERSONAL_EMAIL,
+                PREFIX_NUS_WORK_EMAIL);
+        if (!arePrefixesPresent(argMultimap, PREFIX_NAME, PREFIX_PHONE, PREFIX_FACULTY, PREFIX_YEAR_OF_STUDY,
                 PREFIX_DEPARTMENT, PREFIX_SLOT, PREFIX_PERSONAL_EMAIL, PREFIX_NUS_WORK_EMAIL)) {
             throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
         }
         // Get all necessary fields from argMultimap
+        Name name = ParserUtil.parseName(argMultimap.getValue(PREFIX_NAME).get());
+        Phone phone = ParserUtil.parsePhone(argMultimap.getValue(PREFIX_PHONE).get());
         Faculty faculty = ParserUtil.parseFaculty(argMultimap.getValue(PREFIX_FACULTY).get());
         Integer yearOfStudy = ParserUtil.parseYearOfStudy(argMultimap.getValue(PREFIX_YEAR_OF_STUDY).get());
         List<Slot> availableTimeslots = ParserUtil.parseSlots(argMultimap.getAllValues(PREFIX_SLOT));
@@ -91,6 +85,7 @@ private AddIntervieweeCommand parseAddIntervieweeCommand(ArgumentMultimap argMul
         Emails emails = new Emails().addPersonalEmail(personalEmail).addNusEmail(nusWorkEmail);
         List<Department> departmentChoices =
                 ParserUtil.parseDepartments(argMultimap.getAllValues(PREFIX_DEPARTMENT));
+        Set<Tag> tagSet = ParserUtil.parseTags(argMultimap.getAllValues(PREFIX_TAG));
 
         // An interviewee should not be allocated the same timeslots.
         if (CollectionUtil.collectionHasDuplicate(availableTimeslots)) {
@@ -117,15 +112,21 @@ private AddIntervieweeCommand parseAddIntervieweeCommand(ArgumentMultimap argMul
     /**
      * Parses the argument multimap into an AddInterviewerCommand.
      */
-    private AddInterviewerCommand parseAddInterviewerCommand(ArgumentMultimap argMultimap, Name name, Phone phone,
-                                                             Set<Tag> tagSet) throws ParseException {
-        if (!arePrefixesPresent(argMultimap, PREFIX_DEPARTMENT, PREFIX_NUS_WORK_EMAIL, PREFIX_SLOT)) {
+    private AddInterviewerCommand parseAddInterviewerCommand(String args)
+            throws ParseException {
+        ArgumentMultimap argMultimap = ArgumentTokenizer.tokenize(args, PREFIX_NAME, PREFIX_PHONE, PREFIX_TAG,
+                PREFIX_DEPARTMENT, PREFIX_NUS_WORK_EMAIL, PREFIX_SLOT);
+        if (!arePrefixesPresent(argMultimap, PREFIX_NAME, PREFIX_PHONE, PREFIX_DEPARTMENT, PREFIX_NUS_WORK_EMAIL,
+                PREFIX_SLOT)) {
             throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
         }
         // Get all necessary values from argMultimap.
+        Name name = ParserUtil.parseName(argMultimap.getValue(PREFIX_NAME).get());
+        Phone phone = ParserUtil.parsePhone(argMultimap.getValue(PREFIX_PHONE).get());
         Department department = ParserUtil.parseDepartment(argMultimap.getValue(PREFIX_DEPARTMENT).get());
         Email nusWorkEmail = ParserUtil.parseEmail(argMultimap.getValue(PREFIX_NUS_WORK_EMAIL).get());
         List<Slot> availableTimeslots = ParserUtil.parseSlots(argMultimap.getAllValues(PREFIX_SLOT));
+        Set<Tag> tagSet = ParserUtil.parseTags(argMultimap.getAllValues(PREFIX_TAG));
 
         // An interviewer should not have the same availabilities.
         if (CollectionUtil.collectionHasDuplicate(availableTimeslots)) {

src/main/java/seedu/scheduler/logic/parser/ParserUtil.java

@@ -170,7 +170,7 @@ public static Integer parseYearOfStudy(String yearOfStudy) throws ParseException
         Integer value;
         try {
             value = Integer.parseUnsignedInt(trimmedYearOfStudy);
-            if (value < 0) {
+            if (value <= 0 || value > 5) {
                 throw new NumberFormatException();
             }
         } catch (NumberFormatException e) {

src/main/java/seedu/scheduler/model/person/DefaultValues.java

@@ -15,7 +15,7 @@ public class DefaultValues {
 
     // Person
     public static final Name DEFAULT_NAME = new Name("John Doe");
-    public static final Phone DEFAULT_PHONE = new Phone("88888888");
+    public static final Phone DEFAULT_PHONE = new Phone("91234567");
     public static final Set<Tag> DEFAULT_TAGS = new HashSet<>();
 
     // Interviewee
@@ -26,8 +26,8 @@ public class DefaultValues {
                 .addPersonalEmail(DEFAULT_PERSONAL_EMAIL)
                 .addNusEmail(DEFAULT_NUS_WORK_EMAIL);
     public static final Faculty DEFAULT_FACULTY = new Faculty("School of Computing");
-    public static final Integer DEFAULT_YEAR_OF_STUDY = 2019;
-    public static final Slot DEFAULT_SLOT = Slot.fromString("17/10/2019 13:00-14:00");
+    public static final Integer DEFAULT_YEAR_OF_STUDY = 1;
+    public static final Slot DEFAULT_SLOT = Slot.fromString("17/10/2019 13:30-14:00");
     public static final List<Department> DEFAULT_DEPARTMENTS = new ArrayList<>();
     public static final List<Slot> DEFAULT_TIMESLOTS = new ArrayList<>();
 

src/test/data/JsonSerializableIntervieweeListTest/typicalIntervieweeList.json

@@ -1,7 +1,7 @@
 {
     "interviewees" : [ {
         "faculty" : "Engineering",
-        "yearOfStudy" : 2019,
+        "yearOfStudy" : 1,
         "departmentChoices" : [ "Logistics" ],
         "availableTimeslots" : [ "03/03/2019 16:00-17:00" ],
         "emails": {
@@ -13,7 +13,7 @@
         "tagged" : [ "friends" ]
     }, {
         "faculty" : "Engineering",
-        "yearOfStudy" : 2019,
+        "yearOfStudy" : 1,
         "departmentChoices" : [ "Logistics" ],
         "availableTimeslots" : [ "03/03/2019 16:00-17:00" ],
         "emails": {
@@ -25,7 +25,7 @@
         "tagged" : [ "owesMoney", "friends" ]
     }, {
         "faculty" : "Engineering",
-        "yearOfStudy" : 2019,
+        "yearOfStudy" : 1,
         "departmentChoices" : [ "Logistics" ],
         "availableTimeslots" : [ "03/03/2019 16:00-17:00" ],
         "emails": {
@@ -37,7 +37,7 @@
         "tagged" : []
     }, {
         "faculty" : "Engineering",
-        "yearOfStudy" : 2019,
+        "yearOfStudy" : 1,
         "departmentChoices" : [ "Logistics" ],
         "availableTimeslots" : [ "03/03/2019 16:00-17:00" ],
         "emails": {
@@ -49,7 +49,7 @@
         "tagged" : [ "friends" ]
     }, {
         "faculty" : "Engineering",
-        "yearOfStudy" : 2019,
+        "yearOfStudy" : 1,
         "departmentChoices" : [ "Logistics" ],
         "availableTimeslots" : [ "03/03/2019 16:00-17:00" ],
         "emails": {
@@ -61,7 +61,7 @@
         "tagged" : []
     }, {
         "faculty" : "Engineering",
-        "yearOfStudy" : 2019,
+        "yearOfStudy" : 1,
         "departmentChoices" : [ "Logistics" ],
         "availableTimeslots" : [ "03/03/2019 16:00-17:00" ],
         "emails": {
@@ -73,7 +73,7 @@
         "tagged" : []
     }, {
         "faculty" : "Engineering",
-        "yearOfStudy" : 2019,
+        "yearOfStudy" : 1,
         "departmentChoices" : [ "Logistics" ],
         "availableTimeslots" : [ "03/03/2019 16:00-17:00" ],
         "emails": {

src/test/java/seedu/scheduler/logic/LogicManagerTest.java

@@ -7,9 +7,9 @@
 import static seedu.scheduler.logic.commands.CommandTestUtil.EMAIL_NUS_WORK_DESC_AMY;
 import static seedu.scheduler.logic.commands.CommandTestUtil.NAME_DESC_AMY;
 import static seedu.scheduler.logic.commands.CommandTestUtil.PHONE_DESC_AMY;
-import static seedu.scheduler.logic.commands.CommandTestUtil.ROLE_DESC_AMY_INTVR;
 import static seedu.scheduler.logic.commands.CommandTestUtil.SLOT_DESC_AMY;
 import static seedu.scheduler.logic.commands.CommandTestUtil.TAG_DESC_FRIEND;
+import static seedu.scheduler.logic.commands.CommandTestUtil.VALID_ROLE_AMY_INTVR;
 import static seedu.scheduler.testutil.Assert.assertThrows;
 import static seedu.scheduler.testutil.TypicalPersons.AMY_INTERVIEWER_MANUAL;
 
@@ -82,7 +82,7 @@ public void execute_storageThrowsIoException_throwsCommandException() {
         logic = new LogicManager(model, storage);
 
         // Execute add command
-        String addCommand = AddCommand.COMMAND_WORD + ROLE_DESC_AMY_INTVR + NAME_DESC_AMY + PHONE_DESC_AMY
+        String addCommand = AddCommand.COMMAND_WORD + " " + VALID_ROLE_AMY_INTVR + NAME_DESC_AMY + PHONE_DESC_AMY
                 + TAG_DESC_FRIEND + EMAIL_NUS_WORK_DESC_AMY + DEPARTMENT_DESC_AMY + SLOT_DESC_AMY;
         ModelManager expectedModel = new ModelManager();
         expectedModel.addInterviewer(AMY_INTERVIEWER_MANUAL);

src/test/java/seedu/scheduler/logic/commands/CommandTestUtil.java

@@ -45,8 +45,8 @@ public class CommandTestUtil {
     public static final String VALID_TAG_FRIEND = "friend";
     public static final String VALID_FACULTY_AMY = "School of Engineering";
     public static final String VALID_FACULTY_BOB = "School of Computing";
-    public static final String VALID_YEAR_OF_STUDY_AMY = "2019";
-    public static final String VALID_YEAR_OF_STUDY_BOB = "2020";
+    public static final String VALID_YEAR_OF_STUDY_AMY = "1";
+    public static final String VALID_YEAR_OF_STUDY_BOB = "2";
     public static final String VALID_DEPARTMENT_AMY = "Logistics";
     public static final String VALID_DEPARTMENT_BOB = "Marketing";
     public static final String VALID_SLOT_AMY = "17/10/2019 12:30-13:30";