DeveloperGuide.adoc

HR+ Developer Guide

By: Team W14-B3      Since: Jan 2018      Licence: MIT

• 1. Setting up
  • 1.1. Setting up the project in your computer
  • 1.2. Verifying the setup
  • 1.3. Configurations to do before writing code
• 2. Design
  • 2.1. Architecture
  • 2.2. UI component
  • 2.3. Logic component
  • 2.4. Model component
  • 2.5. Storage component
  • 2.6. Common classes
• 3. Implementation
  • 3.1. Rate Command
  • 3.2. Sort Command
  • 3.3. Undo/Redo feature
  • 3.4. Find Command
  • 3.5. Filter Command
  • 3.6. Interview Command
  • 3.7. User Interface
  • 3.8. [Proposed] Data Encryption
  • 3.9. Logging
  • 3.10. Configuration
• 4. Documentation
  • 4.1. Editing Documentation
  • 4.2. Publishing Documentation
  • 4.3. Converting Documentation to PDF format
• 5. Testing
  • 5.1. Running Tests
  • 5.2. Types of tests
  • 5.3. Troubleshooting Testing
• 6. Dev Ops
  • 6.1. Build Automation
  • 6.2. Continuous Integration
  • 6.3. Coverage Reporting
  • 6.4. Documentation Previews
  • 6.5. Making a Release
  • 6.6. Managing Dependencies
• Appendix A: Suggested Programming Tasks to Get Started
  • A.1. Improving each component
  • A.2. Creating a new command: remark
• Appendix B: Product Scope
• Appendix C: User Stories
• Appendix D: Use Cases
  • D.1. Use case: Add person
  • D.2. Use case: Find person by name
  • D.3. Use case: Find person by some letters
  • D.4. Use case: Filter a person by field
  • D.5. Use case: Add resume
  • D.6. Use case: Add profile picture
  • D.7. Use case: Add rating
  • D.8. Use case: Add remark
  • D.9. Use case: Add interview date
• Appendix E: Non Functional Requirements
• Appendix F: Glossary
• Appendix G: Product Survey
• Appendix H: Instructions for Manual Testing
  • H.1. Launch and Shutdown
  • H.2. Adding a student
  • H.3. Showing info panel or resume
  • H.4. Scheduling an interview
  • H.5. Rating a student
  • H.6. Editing a rating
  • H.7. Deleting a rating
  • H.8. Sorting the students list
  • H.9. Updating status of a student
  • H.10. Filtering according to multiple fields
  • H.11. Finding every field of the student
  • H.12. Finding specific field of the student

1. Setting up

1. JDK 1.8.0_60 or later

   ℹ️	Having any Java 8 version is not enough. This app will not work with earlier versions of Java 8.

2. IntelliJ IDE

   ℹ️	IntelliJ by default has Gradle and JavaFx plugins installed. Do not disable them. If you have disabled them, go to File > Settings > Plugins to re-enable them.

1.1. Setting up the project in your computer

1. Fork this repo, and clone the fork to your computer

2. Open IntelliJ (if you are not in the welcome screen, click File > Close Project to close the existing project dialog first)

3. Set up the correct JDK version for Gradle

   1. Click Configure > Project Defaults > Project Structure

   2. Click New…​ and find the directory of the JDK

4. Click Import Project

5. Locate the build.gradle file and select it. Click OK

6. Click Open as Project

7. Click OK to accept the default settings

8. Open a console and run the command gradlew processResources (Mac/Linux: ./gradlew processResources). It should finish with the BUILD SUCCESSFUL message.
   This will generate all resources required by the application and tests.

1.2. Verifying the setup

1. Run the seedu.address.MainApp and try a few commands

2. Run the tests to ensure they all pass.

1.3. Configurations to do before writing code

1.3.1. Configuring the coding style

This project follows oss-generic coding standards. IntelliJ’s default style is mostly compliant with ours but it uses a different import order from ours. To rectify,

1. Go to File > Settings…​ (Windows/Linux), or IntelliJ IDEA > Preferences…​ (macOS)

2. Select Editor > Code Style > Java

3. Click on the Imports tab to set the order

   • For Class count to use import with '*' and Names count to use static import with '*': Set to 999 to prevent IntelliJ from contracting the import statements

   • For Import Layout: The order is import static all other imports, import java.*, import javax.*, import org.*, import com.*, import all other imports. Add a <blank line> between each import

Optionally, you can follow the UsingCheckstyle.adoc document to configure Intellij to check style-compliance as you write code.

1.3.2. Updating documentation to match your fork

After forking the repo, links in the documentation will still point to the se-edu/addressbook-level4 repo. If you plan to develop this as a separate product (i.e. instead of contributing to the se-edu/addressbook-level4) , you should replace the URL in the variable repoURL in DeveloperGuide.adoc and UserGuide.adoc with the URL of your fork.

1.3.3. Setting up CI

Set up Travis to perform Continuous Integration (CI) for your fork. See UsingTravis.adoc to learn how to set it up.

After setting up Travis, you can optionally set up coverage reporting for your team fork (see UsingCoveralls.adoc).

ℹ️	Coverage reporting could be useful for a team repository that hosts the final version but it is not that useful for your personal fork.

Optionally, you can set up AppVeyor as a second CI (see UsingAppVeyor.adoc).

ℹ️	Having both Travis and AppVeyor ensures your App works on both Unix-based platforms and Windows-based platforms (Travis is Unix-based and AppVeyor is Windows-based)

1.3.4. Getting started with coding

When you are ready to start coding,

1. Get some sense of the overall design by reading Section 2.1, “Architecture”.

2. Take a look at Appendix A, Suggested Programming Tasks to Get Started.

2. Design

2.1. Architecture

Figure 1. Architecture Diagram

The Architecture Diagram given above explains the high-level design of the App. Given below is a quick overview of each component.

💡	The .pptx files used to create diagrams in this document can be found in the diagrams folder. To update a diagram, modify the diagram in the pptx file, select the objects of the diagram, and choose Save as picture.

Main has only one class called MainApp. It is responsible for,

• At app launch: Initializes the components in the correct sequence, and connects them up with each other.

• At shut down: Shuts down the components and invokes cleanup method where necessary.

Commons represents a collection of classes used by multiple other components. Two of those classes play important roles at the architecture level.

• EventsCenter : This class (written using Google’s Event Bus library) is used by components to communicate with other components using events (i.e. a form of Event Driven design)

• LogsCenter : Used by many classes to write log messages to the App’s log file.

The rest of the App consists of four components.

• UI: The UI of the App.

• Logic: The command executor.

• Model: Holds the data of the App in-memory.

• Storage: Reads data from, and writes data to, the hard disk.

Each of the four components

• Defines its API in an interface with the same name as the Component.

• Exposes its functionality using a {Component Name}Manager class.

For example, the Logic component (see the class diagram given below) defines it’s API in the Logic.java interface and exposes its functionality using the LogicManager.java class.

Figure 2. Class Diagram of the Logic Component

Events-Driven nature of the design

The Sequence Diagram below shows how the components interact for the scenario where the user issues the command delete 1.

Figure 3. Component interactions for delete 1 command (part 1)

ℹ️	Note how the Model simply raises a AddressBookChangedEvent when the Address Book data are changed, instead of asking the Storage to save the updates to the hard disk.

The diagram below shows how the EventsCenter reacts to that event, which eventually results in the updates being saved to the hard disk and the status bar of the UI being updated to reflect the 'Last Updated' time.

Figure 4. Component interactions for delete 1 command (part 2)

ℹ️	Note how the event is propagated through the EventsCenter to the Storage and UI without Model having to be coupled to either of them. This is an example of how this Event Driven approach helps us reduce direct coupling between components.

The sections below give more details of each component.

2.2. UI component

Figure 5. Structure of the UI Component

API : Ui.java

The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, PersonListPanel, StatusBarFooter, BrowserPanel etc. All these, including the MainWindow, inherit from the abstract UiPart class.

The UI component uses JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml

The UI component,

• Executes user commands using the Logic component.

• Binds itself to some data in the Model so that the UI can auto-update when data in the Model change.

• Responds to events raised from various parts of the App and updates the UI accordingly.

2.3. Logic component

Figure 6. Structure of the Logic Component

Figure 7. Structure of Commands in the Logic Component. This diagram shows finer details concerning XYZCommand and Command in Figure 6, “Structure of the Logic Component”

API : Logic.java

1. Logic uses the AddressBookParser class to parse the user command.

2. This results in a Command object which is executed by the LogicManager.

3. The command execution can affect the Model (e.g. adding a person) and/or raise events.

4. The result of the command execution is encapsulated as a CommandResult object which is passed back to the Ui.

Given below is the Sequence Diagram for interactions within the Logic component for the execute("delete 1") API call.

Figure 8. Interactions Inside the Logic Component for the delete 1 Command

2.4. Model component

Figure 9. Structure of the Model Component

API : Model.java

The Model,

• stores a UserPref object that represents the user’s preferences.

• stores the Address Book data.

• exposes an unmodifiable ObservableList<Person> that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.

• does not depend on any of the other three components.

2.5. Storage component

Figure 10. Structure of the Storage Component

API : Storage.java

The Storage component,

• can save UserPref objects in json format and read it back.

• can save the Address Book data in xml format and read it back.

2.6. Common classes

Classes used by multiple components are in the seedu.addressbook.commons package.

3. Implementation

This section describes some noteworthy details on how certain features are implemented.

3.1. Rate Command

3.1.1. Current Implementation

The rate command allows Talent Acquisition Specialists to evaluate candidates' performance in interviews against four specific criteria, namely technical skills, communication skills, problem solving skills and experience. The format of this command is rate INDEX t/TECHNICAL SKILLS SCORE c/COMMUNICATINO SKILLS SCORE p/PROBLEM SOLVING SKILLS SCORE e/EXPERIENCE SCORE.

In our current implementation, the rate command inherits from the UndoableCommand class. Two components, Logic and Model, are involved in the execution of this command. The Logic component is responsible for parsing user inputs while the Model component deals with updating of filtered person list.

Below is a sequence diagram that illustrates how these two components interact when the rate command is executed:

Figure 3.1.1.1 Sequence diagram to illustrate component interactions for the rate command

As shown above, execution of the rate command comprises the following steps:

1. LogicManager invokes parseCommand method of AddressbookParser, taking user inputs as arguments.

2. During the parseCommand method call, an instance of RateCommandParser will be created when the keyword "rate" is matched. RateCommandParser then extracts the remaining user inputs and a RateCommand instance r will be returned provided that the format of user’s input is correct.

3. LogicManager then calls executeUndoableCommand of the RateCommand, r, instantiated in step 2. Another component, Model, will be involved as the RateCommand requests to update the rating scores of the person.

4. The Model component gets the filtered persons list and replaces Person p1 with Person p2 which is identical to p2 except rating scores. A CommandResult will be generated and returned to LogicManager.

3.1.2. Design Considerations

Aspect: Implementation of adding and editing rating scores

• Alternative 1 (current choice): Implement a new command class RateCommand that supports adding rating scores and RatingEditCommand to handle editing of rating scores

  • Pros: Results in more customisable commands that can be easily modified to support more prefixes and additional rating criteria

  • Cons: Complicates the system as users need to familiarise themselves with more commands

• Alternative 2: Extend the original EditCommand to allow it to add and modify rating scores of a student

  • Pros: Minimises the number of commands users have to remember to execute tasks, making the application more user-friendly

  • Cons: Requires substantial changes to EditCommandParser and hence harder to implement

3.2. Sort Command

3.2.1. Current Implementation

The sort command supports the listing of students in HR+ based on GPA, name or overall rating in ascending or descending order as specified by the user. The format of this sort command is sort FIELD o/SORT ORDER.

As sorting is not undoable, this command inherits from the Command class instead of the UndoableCommand class. The sorting mechanism is mainly facilitated by Logic and ModelManager. SortCommandParser residing in LogicManager processes user inputs and creates a corresponding SortCommand. ModelManager will then invoke appropriate sorting methods in UniquePersonList.

The following sequence diagrams depict the interactions between LogicManager and ModelManager when a user issues a request for sorting:

Figure 3.2.1.1 Sequence diagrams for execution of sort command

As seen from the sequence diagram above, LogicManager and ModelManager interact in the following way:

1. When a user keys in sort gpa o/desc, LogicManager calls method parser in AddressBookParser.

2. SortCommandParser is instantiated. If the user input is of the correct format, a SortCommand will be successfully created and returned back to LogicManager. Suppose the inputs are not valid or the format of the command is invalid, an exception will be thrown and users will see an error message.

3. LogicManager proceeds to invoke execute method of SortCommand.

4. ModelManager is in charge of sorting the list of persons through calling relevant methods provided in AddressBook and UniquePersonList according to the field to be sorted by.

Currently, HR+ only allows users to sort the list of students by selected fields in ascending or descending order. This is achieved by encapsulating acceptable sorting orders and fields into SortOrder and SortField of the type enum respectively.

In order to make Person objects comparable, additional methods need to be implemented in the Person class to compare different Person objects based on GPA, name and rating scores. The following code snippet demonstrates how these methods are implemented:

/**
 * Compares the overall ratings of two {@code Person} objects.
 * @param p1
 * @param p2
 * @return 1 if p1 has a higher overall rating, 0 if p1 and p2 have equal overall rating and -1 otherwise.
 */
public static int compareByOverallRating(Person p1, Person p2) {
    return Double.compare(p1.getRating().getOverallScore(),
            p2.getRating().getOverallScore());
}

To sort the list based on a particular field, we used the sort method from Java’s Collections library. An example usage is shown below:

/**
 * Sorts the list based on GPA in ascending order
 */
public void sortPersonsGradePointAverageAsc() {
    Collections.sort(internalList, Person::compareByGradePointAverage);
}

/**
 * Sorts the list based on GPA in descending order
 */
public void sortPersonsGradePointAverageDesc() {
    Collections.sort(internalList, Person::compareByGradePointAverage);
    Collections.reverse(internalList);
}

3.2.2. Design Considerations

3.2.3. Aspect: Implementation of SortCommand

• Alternative 1 (current choice): Implement a more generic SortCommand that sorts the list of students based on parameters supplied by the user

  • Pros: It is easier to modify SortCommand to support more fields to be sorted by.

  • Cons: It restricts the format of sort command to be the same and is thus less flexible.

• Alternative 2: Use separate commands for each possible field, such as gpa-sort, rating-sort and name-sort commands

  • Pros: It allows developers to specify different command formats. For example, users might not need to specify the sorting order explicitly. rating-sort and gpa-sort can have default sorting order to be descending while results from name-sort can be in ascending order.

  • Cons: It increases the number of commands in HR+ and might be less user-friendly as users need to familiarise themselves with more commands.

3.3. Undo/Redo feature

3.3.1. Current Implementation

The undo/redo mechanism is facilitated by an UndoRedoStack, which resides inside LogicManager. It supports undoing and redoing of commands that modifies the state of the address book (e.g. add, edit). Such commands will inherit from UndoableCommand.

UndoRedoStack only deals with UndoableCommands. Commands that cannot be undone will inherit from Command instead. The following diagram shows the inheritance diagram for commands:

As you can see from the diagram, UndoableCommand adds an extra layer between the abstract Command class and concrete commands that can be undone, such as the DeleteCommand. Note that extra tasks need to be done when executing a command in an undoable way, such as saving the state of the address book before execution. UndoableCommand contains the high-level algorithm for those extra tasks while the child classes implements the details of how to execute the specific command. Note that this technique of putting the high-level algorithm in the parent class and lower-level steps of the algorithm in child classes is also known as the template pattern.

Commands that are not undoable are implemented this way:

public class ListCommand extends Command {
    @Override
    public CommandResult execute() {
        // ... list logic ...
    }
}

With the extra layer, the commands that are undoable are implemented this way:

public abstract class UndoableCommand extends Command {
    @Override
    public CommandResult execute() {
        // ... undo logic ...

        executeUndoableCommand();
    }
}

public class DeleteCommand extends UndoableCommand {
    @Override
    public CommandResult executeUndoableCommand() {
        // ... delete logic ...
    }
}

Suppose that the user has just launched the application. The UndoRedoStack will be empty at the beginning.

The user executes a new UndoableCommand, delete 5, to delete the 5th person in the address book. The current state of the address book is saved before the delete 5 command executes. The delete 5 command will then be pushed onto the undoStack (the current state is saved together with the command).

As the user continues to use the program, more commands are added into the undoStack. For example, the user may execute add n/David …​ to add a new person.

ℹ️	If a command fails its execution, it will not be pushed to the UndoRedoStack at all.

The user now decides that adding the person was a mistake, and decides to undo that action using undo.

We will pop the most recent command out of the undoStack and push it back to the redoStack. We will restore the address book to the state before the add command executed.

ℹ️	If the undoStack is empty, then there are no other commands left to be undone, and an Exception will be thrown when popping the undoStack.

The following sequence diagram shows how the undo operation works:

The redo does the exact opposite (pops from redoStack, push to undoStack, and restores the address book to the state after the command is executed).

ℹ️	If the redoStack is empty, then there are no other commands left to be redone, and an Exception will be thrown when popping the redoStack.

The user now decides to execute a new command, clear. As before, clear will be pushed into the undoStack. This time the redoStack is no longer empty. It will be purged as it no longer make sense to redo the add n/David command (this is the behavior that most modern desktop applications follow).

Commands that are not undoable are not added into the undoStack. For example, list, which inherits from Command rather than UndoableCommand, will not be added after execution:

The following activity diagram summarize what happens inside the UndoRedoStack when a user executes a new command:

3.3.2. Design Considerations

Aspect: Implementation of UndoableCommand

• Alternative 1 (current choice): Add a new abstract method executeUndoableCommand()

  • Pros: We will not lose any undone/redone functionality as it is now part of the default behaviour. Classes that deal with Command do not have to know that executeUndoableCommand() exist.

  • Cons: Hard for new developers to understand the template pattern.

• Alternative 2: Just override execute()

  • Pros: Does not involve the template pattern, easier for new developers to understand.

  • Cons: Classes that inherit from UndoableCommand must remember to call super.execute(), or lose the ability to undo/redo.

Aspect: How undo & redo executes

• Alternative 1 (current choice): Saves the entire address book.

  • Pros: Easy to implement.

  • Cons: May have performance issues in terms of memory usage.

• Alternative 2: Individual command knows how to undo/redo by itself.

  • Pros: Will use less memory (e.g. for delete, just save the person being deleted).

  • Cons: We must ensure that the implementation of each individual command are correct.

Aspect: Type of commands that can be undone/redone

• Alternative 1 (current choice): Only include commands that modifies the address book (add, clear, edit).

  • Pros: We only revert changes that are hard to change back (the view can easily be re-modified as no data are * lost).

  • Cons: User might think that undo also applies when the list is modified (undoing filtering for example), * only to realize that it does not do that, after executing undo.

• Alternative 2: Include all commands.

  • Pros: Might be more intuitive for the user.

  • Cons: User have no way of skipping such commands if he or she just want to reset the state of the address * book and not the view. Additional Info: See our discussion here.

Aspect: Data structure to support the undo/redo commands

• Alternative 1 (current choice): Use separate stack for undo and redo

  • Pros: Easy to understand for new Computer Science student undergraduates to understand, who are likely to be * the new incoming developers of our project.

  • Cons: Logic is duplicated twice. For example, when a new command is executed, we must remember to update * both HistoryManager and UndoRedoStack.

• Alternative 2: Use HistoryManager for undo/redo

  • Pros: We do not need to maintain a separate stack, and just reuse what is already in the codebase.

  • Cons: Requires dealing with commands that have already been undone: We must remember to skip these commands. Violates Single Responsibility Principle and Separation of Concerns as HistoryManager now needs to do two * different things.

3.4. Find Command

3.4.1. Current Implementation

The find command is facilitated by an AllPredicate class, which composes of predicates that determine the fields that are supported. Each field has its own set of predicates that determine the types of search patterns the user can perform. Search results of the keywords are stored in FindResults, which is a singleton pattern class.

The following diagram, Figure 3.4.1.1 shows the composition of the AllPredicate class and the relationship between FindResults:

Figure 3.4.1.1 Composition of AllPredicate class

The following code snippet shows an example of one type of predicate:

public boolean test(Person person) {
    return keywords.stream()
            .anyMatch(keyword -> FindResults.getInstance()
                    .containsWordIgnoreCase(person.getName().fullName, keyword,
                    commandPrefix)
                || keywords.stream()
                    .anyMatch(fuzzyKeyword ->
                    FindResults.getInstance().containsFuzzyMatchIgnoreCase(
                            person.getName().fullName, fuzzyKeyword, commandPrefix,
                            FindCommand.LEVENSHTEIN_DISTANCE_THRESHOLD)));
}

The following sequence diagrams, Figure 3.4.1.2 and Figure 3.4.1.3 shows how the find command works:

Figure 3.4.1.2 Sequence diagram of find command (1st part)

Figure 3.4.1.3 Sequence diagram of find command (2nd part)

The execution of the find command comprises the following steps:

1. LogicManager invokes parseCommand method of AddressbookParser, taking user inputs as arguments.

2. AddressbookParser calls the parse method of FindCommandParser to parse the arguments and return a FindCommand object.

3. FindCommandParser calls the parseFindArgs method of FindUtil , which calls either the parseAllPredicates or parseSelectedPredicates method from PredicateUtil depending on whether the argument starts with a prefix.

4. The FindCommand object is initialized with a combined Predicate<Person> object.

5. The FindCommand object calls the method updateFilteredPersonList with the Predicate<Person> object.

The following code snippets show how methods formOrPredicate and formAndPredicate are implemented:

public final Predicate<Person> formOrPredicate(Predicate<Person>... predicates) {
    return Stream.of(predicates).filter(Objects::nonNull)
            .reduce(condition -> false, Predicate::or);
}

public final Predicate<Person> formAndPredicate(Predicate<Person>... predicates) {
    return Stream.of(predicates).filter(Objects::nonNull)
            .reduce(condition -> true, Predicate::and);
}

The following sequence diagram, Figure 3.4.1.4, shows how the Logic component retrieves search results from FindResults without interference from the Model component:

Figure 3.4.1.4 Component interactions for find command

ℹ️	Note how results are retrieved from FindResults. It is important to have FindResults as a singleton pattern class as there should only be one instance of search results for every search performed by the find command.

The following activity diagram, Figure 3.4.1.5 summarizes what happens when an user executes the find command:

Figure 3.4.1.5 Activity diagram when user executes find command

3.4.2. Design Considerations

3.4.3. Aspect: Implementation of find command

• Alternative 1 (current choice): Each field has its own field predicate composing of the predicates corresponding to the search pattern. The AllPredicate class is used to manage all these field predicates.

  • Pros: It is easy for new developers to understand. New developers can test each predicate easily, resulting in the debugging process to be smoother. They can also add or remove new predicates of each field easily as all predicates all grouped separately. This choice also adheres to Single Responsibility Principle (SRP) and Separation of Concerns (SoC).

  • Cons: It results in a lot of classes to be created. Although there is increased cohesion, there is also increased coupling. Furthermore, this choice also violates Open-Closed Principle (OCP).

• Alternative 2: Merge all predicates into one class

  • Pros: It is easy for new developers to manage this command. This choice also reduces the amount of code written significantly.

  • Cons: It is difficult to test existing and new predicates. This choice decreases cohesion although it decreases coupling.

3.4.4. Aspect: Implementation of Levenshtein distance threshold

• Alternative 1 (current choice): Set a private static constant

  • Pros: It does not involve user intervention to set the threshold. It also decreases the chances of an increase in false positives should the user set a high threshold.

  • Cons: It does not allow users to set their desired threshold. Some users might need specific threshold to suit their needs

• Alternative 2: Allow users to set their own threshold

  • Pros: It caters to more users with specific preferences.

  • Cons: It results in more implementation and tests to be written.

3.5. Filter Command

3.5.1. Current Implementation

Filter Command is supported by an FilterCommand class. It supports the advanced filtering of multiple fields such as ExpectedGraduationYear. Filter commands can supports both filtering by keyword and filtering by range, if the field has natural ordering.

Filter command currently only filters ExpectedGraduationYear but will support more fields in the subsequent weeks.

Filter command interact with Model and UI in the following way:

1. FilterCommandParser parses the user inputs into a wholesome Predicate<Person>.

2. This predicate will be used to instantiate the FilterCommand

3. Upon execution of the filter command, the UI will be updated by imposing the new predicate to the FilteredList in the ModelManager class.

Below is the sequence diagram of filter command.

3.5.2. Design Considerations

Aspect: Implementation of FilterCommandParser

• Alternative 1 (current choice): FilterCommandParser breaks down user input according to prefix and pass to different methods in FilterUtil to generate respective Predicate<Person>, after which it unions these Predicate.

  • Pros: This appoach breaks down the parsing process into multiple classes and each class is responsible for single duty. This makes debugging easier.

  • Cons: New developers may find it hard to understand the design pattern.

• Alternative 2: Puts actual parsing in FilterCommandParser class.

  • Pros: It reduces number of classes used and is easier for new developers to understand.

  • Cons: It violates single responsibility principle. FilterCommandParser will have too many distinct functionalities such as

    • breaking down user input by prefix

    • breaking down user’s predicate for each prefix

    • creating FilterRange objects to record down each range specified in the predicate

    • creating Predicate from FilterRange

    • unioning these Predicate

Aspect: Implementation of range tracker: FilterRange<E>

• Alternative 1 (current choice): All user input will either be in form of ToBeFilteredClassPrefix/singletonValue, lowerRange - higherRange. Both singleton value and range will be parsed into a FilterRange<ToBeFilteredClass>.

  • Pros: It ensures the user input is valid since FilterRange<E> can call E.isValid() to check. This ensures the integrity of Predicate later.

  • Cons: New developers may find it hard to understand the design pattern.

• Alternative 2 (current choice): All parsing of singleton or ranged values will be handled by some methods in FilterUtil.

  • Pros: New developers will find it easier to understand the design pattern.

  • Cons: It will be messy to handle both singletona dn ranged values in one method. It also adds the complexity of FilterUtil class.

Aspect: FilterCommand behaviour

• Alternative 1 (current choice): Predicates in the same field will be ORed together. Predicates in the different field will be ANDed together.

  • Pros: For the same field, the user can have more flexibility in selecting the desired values. For the different field, the predicates are in logical conjunction to make the filter more restrictive. This follows the natural way of human thinking.

  • Cons: The developers may be confused about the OR/AND rule at first.

• Alternative 2: Everything will be ORed together.

  • Pros: It is an easier logical pattern for developers to understand.

  • Cons: It is user unfriendly. The only way for user to filter the persons who is in Computer Science, graduating in 2020 and has a GPA greater than 4.6 is to use 3 filter commands.

3.6. Interview Command

3.6.1. Current Implementation

The interview command allows Talent Acquisition Specialists to schedule an interview for candidates. The format of this command is interview INDEX DATE_TIME_EXPRESSION.

This command make use of Natty, a natural language date parser library written in Java. When given a date expression, it will apply standard language recognition and translation techniques to produce LocalDateTime which represents the result.

In our current implementation, the interview command inherits from the UndoableCommand class. Two components, Logic and Model, are involved in the execution of this command. The Logic component is responsible for parsing user inputs while the Model component deals with updating of filtered person list.

Below is a sequence diagram that illustrates how these two components interact when the interview command is executed:

Figure 3.6.1.1 Sequence diagram to illustrate component interactions for the interview command

As shown above, execution of the interview command comprises the following steps:

1. LogicManager invokes parseCommand method of AddressbookParser, taking user inputs as arguments.

2. During the parseCommand method call, an instance of InterviewCommandParser will be created when the keyword "interview" is matched. InterviewCommandParser then extracts the remaining user inputs and a InterviewCommand instance i will be returned provided that the format of user’s input is correct.

3. LogicManager then calls executeUndoableCommand of the InterviewCommand, i, instantiated in step 2. Another component, Model, will be involved as the InterviewCommand requests to update the interview date of the person.

4. The Model component gets the filtered persons list and replaces Person p1 with Person p2 which is identical to p2 except interview date. A CommandResult will be generated and returned to LogicManager.

3.6.2. Design Considerations

Aspect: Usage of natural language parser

• Alternative 1 (current choice): Use the natural language parser library by Natty to specify date and time

  • Pros: Users are able to enter the date and time in more natural tone without looking at calendar (For example, schedule an interview next Friday at 3pm)

  • Cons: Natural language parser doesn’t have 100% reliability due to the complexity of human language

• Alternative 2: Use the typical DD/MM/YYYY HH:MM format to specify date and time

  • Pros: Users are able to specify the date and time precisely

  • Cons: Users have to be certain on the date and time, which have to refer to the calendar at the same time

Aspect: Implementation of scheduling and editing interview date

• Alternative 1 (current choice): Implement a new command class InterviewCommand that supports both scheduling and editing of interview date.

  • Pros: Results in more customisable and modular command that can be easily modified

  • Cons: Complicates the system as users need to familiarise themselves with more commands

• Alternative 2: Extend the original EditCommand to allow it to schedule and modify interview date of a candidate

  • Pros: Minimises the number of commands users have to remember to execute tasks, making the application more user-friendly

  • Cons: Requires substantial changes to EditCommandParser and hence harder to implement

3.7. User Interface

Our user interface is specially designed to maximise HR+’s usability and improve user experience. We take into account minor details and ensure that data is presented clearly so that it appeals to our users.

The following sections discuss the different aspects we have considered to make sure HR+ follows industry standards in user interface design. Our implementation follows Material Design principles created by a leading technology company Google.

3.7.1. Responsive Design

Responsive design is an approach to provide optimal viewing experience of an application regardless of the screen size of the user’s device. To incorporate responsive design into HR+, we use AnchorPane , a built-in JavaFX container component, to support relative positioning for all four directions (left, right, top and down) between parent and child components.

All UI components have a minimum size requirement. Therefore, every container component in HR+ has a minWidth property.

Besides AnchorPane , we also set a listener on the size of InfoPanel - a panel that displays detailed information about a student in HR+. The following code snippets illustrate how this listener is implemented:

// SPLIT_MIN_WIDTH is a constant to define when to trigger the merge

infoPaneWrapper.widthProperty().addListener((obs, old, newValue) -> {
    int width = newValue.intValue();
    if (width >= SPLIT_MIN_WIDTH) {
        // Split into two parts
    } else {
        // Merge into one part
    }
});

When a user runs HR+ on a device with a bigger screen size, the InfoPanel will be split into two parts. The left panel will display student’s information while the right panel shows the student’s rating scores and a View resume button. The figure below (Figure 3.7.1.1) shows an example of our interface on devices with larger screens:

Figure 3.7.1.1 InfoPanel on devices with larger screens

On the other hand, if the device has a smaller screen size, the two components of InfoPanel will collapse into one. The student’s information is on top of the student’s ratings. ScrollPane in InfoPanel allows the user to scroll through the single merged panel. The figure below (Figure 3.7.1.2) shows our sample interface on devices with smaller screens:

Figure 3.7.1.2 InfoPanel on devices with smaller screens

3.7.2. Consistency

Consistency is another principle that is important in life and in design. Not only it brings up the professional feel and look, users will feel that the app is more reliable and robust. Besides that, it is easier for users to get started as the app follows a consistent pattern.

In order to follow this principle, we have used consistent color, layout and also fonts throughout the whole app. It will be discussed the in details below:

Color

The primary color in HR+ is blue, with 10 shades of blue in the figure illustrated below (Figure 3.7.2.1). Other than the primary color, different shades of grey are also being used to show the level of significance of an information. Besides that, the colors that are being used are harmonized such that it brings up an unified feeling while users are using the app.

Figure 3.7.2.1 10 shades of blue used in HR+

Layout

The spacing and layout inside HR+ is consistent and balanced. We make good use of spacing to achieve grouping of elements so that legibility is improved. This allow users to have a sense of which information are relevant to each other.

For example, it is easy to separate between the applicant’s information, contact information and interview information at a glance without the need of boxes. Examples are shown in the figure below (Figure 3.7.2.2)

Figure 3.7.2.2 Grouping with spacing

Fonts

The font family that is being used is Roboto. It follows a natural width that allows text to be read more fluently. Moreover, this font featured 6 different weights (thin, light, regular, medium, bold and black) which will allow text to be represented depending on the different level of importance. All different weights are shown in the figure below. (Figure 3.7.2.3)

Figure 3.7.2.3 Different weights of Roboto font

Important information is usually shown with a higher weight whereas trivial information is shown with a lower weight. This allow users to skim through the information to process data easily. The fonts are stored in resources/fonts folder and embedded into the packaged app so that it can be loaded on all devices.

3.7.3. Familiarity

Familiarity is another aspect that is useful when designing an app. It can reduce the cognitive load of a user so that users will not feel overwhelmed by the information that is being displayed.

In HR+, icons are used to represent some of the fields. For example, stars are used to represent average rating of an applicant in the PersonCard list on the left (Figure 3.7.3.1, pointed with red arrow).

Figure 3.7.3.1 Rating icon in PersonCard

Besides that, contact information fields such as e-mail, address and mobile phone number uses a familiar icon. (Figure 3.7.3.2)

Figure 3.7.3.2 Contact information icons in InfoPanel

3.7.4. Visual Feedback

Visual Feedback is also essential for users to identify the current state of the app. This is because user might get interrupted while using the app and have to resume the session at any time.

In HR+, when an applicant is selected in the PersonCard list on the left panel, it will be highlighted in blue border and shadow so that users know who they are currently selecting. (Figure 3.7.4.1)

Figure 3.7.4.1 Highlighting of selected PersonCard

Besides that, there is an indication when a panel is selected. This allows users to traverse between panel using keyboard only. (Figure 3.7.4.2)

Figure 3.7.4.2 Highlighting of selected Panel

Moreover, when a command entered in CommandBox is invalid, the text color will be changed into red to indicate that there is an error in the command itself. (Figure 3.7.4.3)

Figure 3.7.4.3 Invalid command indicator

3.8. [Proposed] Data Encryption

{Explain here how the data encryption feature will be implemented}

3.9. Logging

We are using java.util.logging package for logging. The LogsCenter class is used to manage the logging levels and logging destinations.

• The logging level can be controlled using the logLevel setting in the configuration file (See Section 3.10, “Configuration”)

• The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level

• Currently log messages are output through: Console and to a .log file.

Logging Levels

• SEVERE : Critical problem detected which may possibly cause the termination of the application

• WARNING : Can continue, but with caution

• INFO : Information showing the noteworthy actions by the App

• FINE : Details that is not usually noteworthy but may be useful in debugging e.g. print the actual list instead of just its size

3.10. Configuration

Certain properties of the application can be controlled (e.g App name, logging level) through the configuration file (default: config.json).

4. Documentation

We use asciidoc for writing documentation.

ℹ️	We chose asciidoc over Markdown because asciidoc, although a bit more complex than Markdown, provides more flexibility in formatting.

4.1. Editing Documentation

See UsingGradle.adoc to learn how to render .adoc files locally to preview the end result of your edits. Alternatively, you can download the AsciiDoc plugin for IntelliJ, which allows you to preview the changes you have made to your .adoc files in real-time.

4.2. Publishing Documentation

See UsingTravis.adoc to learn how to deploy GitHub Pages using Travis.

4.3. Converting Documentation to PDF format

We use Google Chrome for converting documentation to PDF format, as Chrome’s PDF engine preserves hyperlinks used in webpages.

Here are the steps to convert the project documentation files to PDF format.

1. Follow the instructions in UsingGradle.adoc to convert the AsciiDoc files in the docs/ directory to HTML format.

2. Go to your generated HTML files in the build/docs folder, right click on them and select Open with → Google Chrome.

3. Within Chrome, click on the Print option in Chrome’s menu.

4. Set the destination to Save as PDF, then click Save to save a copy of the file in PDF format. For best results, use the settings indicated in the screenshot below.

Figure 11. Saving documentation as PDF files in Chrome

5. Testing

5.1. Running Tests

There are three ways to run tests.

💡	The most reliable way to run tests is the 3rd one. The first two methods might fail some GUI tests due to platform/resolution-specific idiosyncrasies.

Method 1: Using IntelliJ JUnit test runner

• To run all tests, right-click on the src/test/java folder and choose Run 'All Tests'

• To run a subset of tests, you can right-click on a test package, test class, or a test and choose Run 'ABC'

Method 2: Using Gradle

• Open a console and run the command gradlew clean allTests (Mac/Linux: ./gradlew clean allTests)

ℹ️	See UsingGradle.adoc for more info on how to run tests using Gradle.

Method 3: Using Gradle (headless)

Thanks to the TestFX library we use, our GUI tests can be run in the headless mode. In the headless mode, GUI tests do not show up on the screen. That means the developer can do other things on the Computer while the tests are running.

To run tests in headless mode, open a console and run the command gradlew clean headless allTests (Mac/Linux: ./gradlew clean headless allTests)

5.2. Types of tests

We have two types of tests:

1. GUI Tests - These are tests involving the GUI. They include,

   1. System Tests that test the entire App by simulating user actions on the GUI. These are in the systemtests package.

   2. Unit tests that test the individual components. These are in seedu.address.ui package.

2. Non-GUI Tests - These are tests not involving the GUI. They include,

   1. Unit tests targeting the lowest level methods/classes.
      e.g. seedu.address.commons.StringUtilTest

   2. Integration tests that are checking the integration of multiple code units (those code units are assumed to be working).
      e.g. seedu.address.storage.StorageManagerTest

   3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
      e.g. seedu.address.logic.LogicManagerTest

5.3. Troubleshooting Testing

Problem: HelpWindowTest fails with a NullPointerException.

• Reason: One of its dependencies, UserGuide.html in src/main/resources/docs is missing.

• Solution: Execute Gradle task processResources.

6. Dev Ops

6.1. Build Automation

See UsingGradle.adoc to learn how to use Gradle for build automation.

6.2. Continuous Integration

We use Travis CI and AppVeyor to perform Continuous Integration on our projects. See UsingTravis.adoc and UsingAppVeyor.adoc for more details.

6.3. Coverage Reporting

We use Coveralls to track the code coverage of our projects. See UsingCoveralls.adoc for more details.

6.4. Documentation Previews

When a pull request has changes to asciidoc files, you can use Netlify to see a preview of how the HTML version of those asciidoc files will look like when the pull request is merged. See UsingNetlify.adoc for more details.

6.5. Making a Release

Here are the steps to create a new release.

1. Update the version number in MainApp.java.

2. Generate a JAR file using Gradle.

3. Tag the repo with the version number. e.g. v0.1

4. Create a new release using GitHub and upload the JAR file you created.

6.6. Managing Dependencies

A project often depends on third-party libraries. For example, Address Book depends on the Jackson library for XML parsing. Managing these dependencies can be automated using Gradle. For example, Gradle can download the dependencies automatically, which is better than these alternatives.
a. Include those libraries in the repo (this bloats the repo size)
b. Require developers to download those libraries manually (this creates extra work for developers)

Appendix A: Suggested Programming Tasks to Get Started

Suggested path for new programmers:

1. First, add small local-impact (i.e. the impact of the change does not go beyond the component) enhancements to one component at a time. Some suggestions are given in Section A.1, “Improving each component”.

2. Next, add a feature that touches multiple components to learn how to implement an end-to-end feature across all components. Section A.2, “Creating a new command: remark” explains how to go about adding such a feature.

A.1. Improving each component

Each individual exercise in this section is component-based (i.e. you would not need to modify the other components to get it to work).

Logic component

Scenario: You are in charge of logic. During dog-fooding, your team realize that it is troublesome for the user to type the whole command in order to execute a command. Your team devise some strategies to help cut down the amount of typing necessary, and one of the suggestions was to implement aliases for the command words. Your job is to implement such aliases.

💡	Do take a look at Section 2.3, “Logic component” before attempting to modify the Logic component.

1. Add a shorthand equivalent alias for each of the individual commands. For example, besides typing clear, the user can also type c to remove all persons in the list.

   • Hints

     • Just like we store each individual command word constant COMMAND_WORD inside *Command.java (e.g. FindCommand#COMMAND_WORD, DeleteCommand#COMMAND_WORD), you need a new constant for aliases as well (e.g. FindCommand#COMMAND_ALIAS).

     • AddressBookParser is responsible for analyzing command words.

   • Solution

     • Modify the switch statement in AddressBookParser#parseCommand(String) such that both the proper command word and alias can be used to execute the same intended command.

     • Add new tests for each of the aliases that you have added.

     • Update the user guide to document the new aliases.

     • See this PR for the full solution.

Model component

Scenario: You are in charge of model. One day, the logic-in-charge approaches you for help. He wants to implement a command such that the user is able to remove a particular tag from everyone in the address book, but the model API does not support such a functionality at the moment. Your job is to implement an API method, so that your teammate can use your API to implement his command.

💡	Do take a look at Section 2.4, “Model component” before attempting to modify the Model component.

1. Add a removeTag(Tag) method. The specified tag will be removed from everyone in the address book.

   • Hints

     • The Model and the AddressBook API need to be updated.

     • Think about how you can use SLAP to design the method. Where should we place the main logic of deleting tags?

     • Find out which of the existing API methods in AddressBook and Person classes can be used to implement the tag removal logic. AddressBook allows you to update a person, and Person allows you to update the tags.

   • Solution

     • Implement a removeTag(Tag) method in AddressBook. Loop through each person, and remove the tag from each person.

     • Add a new API method deleteTag(Tag) in ModelManager. Your ModelManager should call AddressBook#removeTag(Tag).

     • Add new tests for each of the new public methods that you have added.

     • See this PR for the full solution.

       • The current codebase has a flaw in tags management. Tags no longer in use by anyone may still exist on the AddressBook. This may cause some tests to fail. See issue #753 for more information about this flaw.

       • The solution PR has a temporary fix for the flaw mentioned above in its first commit.

Ui component

Scenario: You are in charge of ui. During a beta testing session, your team is observing how the users use your address book application. You realize that one of the users occasionally tries to delete non-existent tags from a contact, because the tags all look the same visually, and the user got confused. Another user made a typing mistake in his command, but did not realize he had done so because the error message wasn’t prominent enough. A third user keeps scrolling down the list, because he keeps forgetting the index of the last person in the list. Your job is to implement improvements to the UI to solve all these problems.

💡	Do take a look at Section 2.2, “UI component” before attempting to modify the UI component.

1. Use different colors for different tags inside person cards. For example, friends tags can be all in brown, and colleagues tags can be all in yellow.

   Before

   

   After

   

   • Hints

     • The tag labels are created inside the PersonCard constructor (new Label(tag.tagName)). JavaFX’s Label class allows you to modify the style of each Label, such as changing its color.

     • Use the .css attribute -fx-background-color to add a color.

     • You may wish to modify DarkTheme.css to include some pre-defined colors using css, especially if you have experience with web-based css.

   • Solution

     • You can modify the existing test methods for PersonCard 's to include testing the tag’s color as well.

     • See this PR for the full solution.

       • The PR uses the hash code of the tag names to generate a color. This is deliberately designed to ensure consistent colors each time the application runs. You may wish to expand on this design to include additional features, such as allowing users to set their own tag colors, and directly saving the colors to storage, so that tags retain their colors even if the hash code algorithm changes.

2. Modify NewResultAvailableEvent such that ResultDisplay can show a different style on error (currently it shows the same regardless of errors).

   Before

   

   After

   

   • Hints

     • NewResultAvailableEvent is raised by CommandBox which also knows whether the result is a success or failure, and is caught by ResultDisplay which is where we want to change the style to.

     • Refer to CommandBox for an example on how to display an error.

   • Solution

     • Modify NewResultAvailableEvent 's constructor so that users of the event can indicate whether an error has occurred.

     • Modify ResultDisplay#handleNewResultAvailableEvent(NewResultAvailableEvent) to react to this event appropriately.

     • You can write two different kinds of tests to ensure that the functionality works:

       • The unit tests for ResultDisplay can be modified to include verification of the color.

       • The system tests AddressBookSystemTest#assertCommandBoxShowsDefaultStyle() and AddressBookSystemTest#assertCommandBoxShowsErrorStyle() to include verification for ResultDisplay as well.

     • See this PR for the full solution.

       • Do read the commits one at a time if you feel overwhelmed.

3. Modify the StatusBarFooter to show the total number of people in the address book.

   Before

   

   After

   

   • Hints

     • StatusBarFooter.fxml will need a new StatusBar. Be sure to set the GridPane.columnIndex properly for each StatusBar to avoid misalignment!

     • StatusBarFooter needs to initialize the status bar on application start, and to update it accordingly whenever the address book is updated.

   • Solution

     • Modify the constructor of StatusBarFooter to take in the number of persons when the application just started.

     • Use StatusBarFooter#handleAddressBookChangedEvent(AddressBookChangedEvent) to update the number of persons whenever there are new changes to the addressbook.

     • For tests, modify StatusBarFooterHandle by adding a state-saving functionality for the total number of people status, just like what we did for save location and sync status.

     • For system tests, modify AddressBookSystemTest to also verify the new total number of persons status bar.

     • See this PR for the full solution.

Storage component

Scenario: You are in charge of storage. For your next project milestone, your team plans to implement a new feature of saving the address book to the cloud. However, the current implementation of the application constantly saves the address book after the execution of each command, which is not ideal if the user is working on limited internet connection. Your team decided that the application should instead save the changes to a temporary local backup file first, and only upload to the cloud after the user closes the application. Your job is to implement a backup API for the address book storage.

💡	Do take a look at Section 2.5, “Storage component” before attempting to modify the Storage component.

1. Add a new method backupAddressBook(ReadOnlyAddressBook), so that the address book can be saved in a fixed temporary location.

   • Hint

     • Add the API method in AddressBookStorage interface.

     • Implement the logic in StorageManager and XmlAddressBookStorage class.

   • Solution

     • See this PR for the full solution.

A.2. Creating a new command: remark

By creating this command, you will get a chance to learn how to implement a feature end-to-end, touching all major components of the app.

Scenario: You are a software maintainer for addressbook, as the former developer team has moved on to new projects. The current users of your application have a list of new feature requests that they hope the software will eventually have. The most popular request is to allow adding additional comments/notes about a particular contact, by providing a flexible remark field for each contact, rather than relying on tags alone. After designing the specification for the remark command, you are convinced that this feature is worth implementing. Your job is to implement the remark command.

A.2.1. Description

Edits the remark for a person specified in the INDEX.
Format: remark INDEX r/[REMARK]

Examples:

• remark 1 r/Likes to drink coffee.
  Edits the remark for the first person to Likes to drink coffee.

• remark 1 r/
  Removes the remark for the first person.

A.2.2. Step-by-step Instructions

[Step 1] Logic: Teach the app to accept 'remark' which does nothing

Let’s start by teaching the application how to parse a remark command. We will add the logic of remark later.

Main:

1. Add a RemarkCommand that extends UndoableCommand. Upon execution, it should just throw an Exception.

2. Modify AddressBookParser to accept a RemarkCommand.

Tests:

1. Add RemarkCommandTest that tests that executeUndoableCommand() throws an Exception.

2. Add new test method to AddressBookParserTest, which tests that typing "remark" returns an instance of RemarkCommand.

[Step 2] Logic: Teach the app to accept 'remark' arguments

Let’s teach the application to parse arguments that our remark command will accept. E.g. 1 r/Likes to drink coffee.

Main:

1. Modify RemarkCommand to take in an Index and String and print those two parameters as the error message.

2. Add RemarkCommandParser that knows how to parse two arguments, one index and one with prefix 'r/'.

3. Modify AddressBookParser to use the newly implemented RemarkCommandParser.

Tests:

1. Modify RemarkCommandTest to test the RemarkCommand#equals() method.

2. Add RemarkCommandParserTest that tests different boundary values for RemarkCommandParser.

3. Modify AddressBookParserTest to test that the correct command is generated according to the user input.

[Step 3] Ui: Add a placeholder for remark in PersonCard

Let’s add a placeholder on all our PersonCard s to display a remark for each person later.

Main:

1. Add a Label with any random text inside PersonListCard.fxml.

2. Add FXML annotation in PersonCard to tie the variable to the actual label.

Tests:

1. Modify PersonCardHandle so that future tests can read the contents of the remark label.

[Step 4] Model: Add Remark class

We have to properly encapsulate the remark in our Person class. Instead of just using a String, let’s follow the conventional class structure that the codebase already uses by adding a Remark class.

Main:

1. Add Remark to model component (you can copy from Address, remove the regex and change the names accordingly).

2. Modify RemarkCommand to now take in a Remark instead of a String.

Tests:

1. Add test for Remark, to test the Remark#equals() method.

[Step 5] Model: Modify Person to support a Remark field

Now we have the Remark class, we need to actually use it inside Person.

Main:

1. Add getRemark() in Person.

2. You may assume that the user will not be able to use the add and edit commands to modify the remarks field (i.e. the person will be created without a remark).

3. Modify SampleDataUtil to add remarks for the sample data (delete your addressBook.xml so that the application will load the sample data when you launch it.)

[Step 6] Storage: Add Remark field to XmlAdaptedPerson class

We now have Remark s for Person s, but they will be gone when we exit the application. Let’s modify XmlAdaptedPerson to include a Remark field so that it will be saved.

Main:

1. Add a new Xml field for Remark.

Tests:

1. Fix invalidAndValidPersonAddressBook.xml, typicalPersonsAddressBook.xml, validAddressBook.xml etc., such that the XML tests will not fail due to a missing <remark> element.

[Step 6b] Test: Add withRemark() for PersonBuilder

Since Person can now have a Remark, we should add a helper method to PersonBuilder, so that users are able to create remarks when building a Person.

Tests:

1. Add a new method withRemark() for PersonBuilder. This method will create a new Remark for the person that it is currently building.

2. Try and use the method on any sample Person in TypicalPersons.

[Step 7] Ui: Connect Remark field to PersonCard

Our remark label in PersonCard is still a placeholder. Let’s bring it to life by binding it with the actual remark field.

Main:

1. Modify PersonCard's constructor to bind the Remark field to the Person 's remark.

Tests:

1. Modify GuiTestAssert#assertCardDisplaysPerson(…​) so that it will compare the now-functioning remark label.

[Step 8] Logic: Implement RemarkCommand#execute() logic

We now have everything set up…​ but we still can’t modify the remarks. Let’s finish it up by adding in actual logic for our remark command.

Main:

1. Replace the logic in RemarkCommand#execute() (that currently just throws an Exception), with the actual logic to modify the remarks of a person.

Tests:

1. Update RemarkCommandTest to test that the execute() logic works.

A.2.3. Full Solution

See this PR for the step-by-step solution.

Appendix B: Product Scope

Target user profile:

• campus recruiters that have a need to manage a significant number of student contacts

• prefer desktop apps over other types

• can type fast

• prefers typing over mouse input

• is reasonably comfortable using CLI apps

• need to keep track of interviews scheduled

• want to evaluate students' performance after interviews to decide who to hire

Value proposition: offers an open source solution to the recruiting process, enables campus recruiters to find the best-fitting candidates easily and allows them to manage student contacts faster than a typical mouse/GUI driven app.

Feature contribution:

1. Ang Yee Chin

   • Major Feature: UI Scheme

     • Revamps the interface to make it more intuitive and clean

     • Makes the design responsive so that the application page looks good on devices with any screen size

     • Integrates a PDF viewer to display applicants' resumes

     • Adds a calendar that displays scheduled interviews

   • Minor Features:

     • Adds a comments field that allows recruiters to provide additional information

     • Creates radar graphs to help visualise applicants' performance in interviews

     • Adds a profile picture field for applicants

2. Ke Xiaowen

   • Major Feature: Rating

     • Rates an applicant based on technical, communication, problem solving skills and experience after an interview

     • Allows editing of rating scores

     • Supports deletion of ratings

     • Displays overall ratings for rated applicants

     • Offers keyboard shortcuts to auto-fill prefixes

   • Minor Features:

     • Adds a job applied field for applicants

     • Adds a university field for applicants

3. Ma Hongqiang

   • Major Feature: Filter

     • Supports filtering based on the current view of listed persons

     • Allows users to filter fields whose values are either finite or have natural ordering

     • Supports filtering multiple fields at the same time

   • Minor Features:

     • Adds a expected graduation year field for applicants

     • Adds a resume field for applicants

4. Tan Heng Yeow

   • Major Feature: Find

     • Allows users to find all fields that match the exact keyword input

     • Supports finding all fields that contains the keyword input

     • Supports finding all fields that start with the keyword input

     • Supports finding all fields that end with the keyword input

     • Adds a fuzzy find function that enables users to find all fields that are a fuzzy match of the keyword input

   • Minor Features:

     • Adds a major field for applicants

     • Adds a cGPA field for applicants

Appendix C: User Stories

Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

Priority	As a …​	I want to …​	So that I can…​
* * *	new user	see usage instructions	refer to instructions when I forget how to use the App
* * *	user	add a new student	manage details of students, schedule interviews and track job offers.
* * *	user	delete a student	remove entries that I no longer need
* * *	user	find a student by name	locate details of students without having to go through the entire list
* * *	user	find a student by some characters	locate details of students without having to remember his/her full name
* * *	user	filter a student by fields	locate details of students in a more optimized view
* * *	user	add profile photo of a student	recognize the student easily
* * *	user	add a student’s expected graduation date	gauge how far along the student is in his/her degree
* * *	user	add a student’s interview date	keep track of interviews scheduled
* * *	user	add a student’s resume	view the competency of the student
* * *	user	edit a student’s status	indicate whether students are still being considered or rejected
* * *	user	add a remark	update additional information about the student
* * *	user	add a rating	evaluate the performance of the student after an interview
* * *	user	sort students according to their interview performance	decide on the best-fitting students
* * *	user	add tags for students	categorise the students better
* * *	user	delete students with a particular tag	remove groups of student contacts that I no longer need
* * *	user	undo my previous command	Restore the data to its previous state before the command was executed
* * *	user	redo the previously undone command	Reverse the most recent undo command
* *	user	view all interviews scheduled in a calendar	have a overview of all interviews arranged
* *	user	send mass emails to successful/unsuccessful candidates	make recruitment easier
* *	user	have syntax highlight for my commands	check my command easily and spot errors faster
* *	user	change colour scheme of the interface	customise it according to my preferences
* *	user who values efficiency	see a list of suggested commands when I key in the command	select the command I want without having to type out the entire command
* *	user	hide private contact details by default	minimize chance of someone else seeing them by accident
*	user	visualise a student’s performance using a radar graph	easily understand his/her performance
*	user with many persons in the address book	sort persons by name	locate a person easily
*	careless user	auto-correct typos in my command	save time checking the command manually
*	cautious user	encrypt student’s data stored	ensure sensitive information will not leak out
*	user	send and receive emails within the application	save time switching between different applications

Appendix D: Use Cases

(For all use cases below, the System is the AddressBook and the Actor is the user, unless specified otherwise)

Use case: Delete person

MSS

1. User requests to list persons

2. AddressBook shows a list of persons

3. User requests to delete a specific person in the list

4. AddressBook deletes the person

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

D.1. Use case: Add person

MSS

1. User requests to add a new person in the list

2. AddressBook adds the new person into the address book.

   Use case ends.

Extensions

• 1a. The command is invalid

  Use case ends.

D.2. Use case: Find person by name

MSS

1. User enters the command with the keyword as the name

2. AddressBook shows the list of persons with the keyword

   Use case ends.

Extensions

• 1a. The keyword is not found in the list of persons

  Use case ends.

D.3. Use case: Find person by some letters

MSS

1. User enters the command with the some letters as the name

2. AddressBook shows the list of persons with fields containing the letters

   Use case ends.

Extensions

• 1a. There is no such letter found in the list of persons.

  Use case ends.

D.4. Use case: Filter a person by field

MSS

1. User requests to filter a list of persons that matches the filter

2. AddressBook shows the list of persons that matches the filter

   Use case ends.

Extensions

• 1a. The filter condition is invalid

  Use case ends.

D.5. Use case: Add resume

MSS

1. User requests to list persons

2. AddressBook shows a list of persons

3. User requests to add a resume to the person in the list

4. AddressBook adds a resume to the person

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

D.6. Use case: Add profile picture

MSS

1. User requests to list persons

2. AddressBook shows a list of persons

3. User requests to add a profile picture to a specific person in the list

4. AddressBook adds a profile picture to the person in the list

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

• 3b. The given path to the image is invalid.

  • 3b1. AddressBook shows an error message.

    Use case resumes at step 2.

D.7. Use case: Add rating

MSS

1. User requests to list persons

2. AddressBook shows a list of persons

3. User requests to add a rating to the specific person in the list

4. AddressBook adds a rating to the person

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

D.8. Use case: Add remark

MSS

1. User requests to list persons

2. AddressBook shows a list of persons

3. User requests to add a remark to the person in the list

4. AddressBook adds a remark to the person

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

D.9. Use case: Add interview date

MSS

1. User requests to list persons

2. AddressBook shows a list of persons

3. User requests to add an interview date to the person in the list

4. AddressBook adds an interview date to the person

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

Appendix E: Non Functional Requirements

1. Should work on any mainstream OS as long as it has Java 1.8.0_60 or higher installed.

2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.

3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.

4. Should follow Java coding standards/styles.

5. Should work on both 32-bit and 64-bit environments.

6. Should work without access to the internet.

7. Should work without external software.

Appendix F: Glossary

Mainstream OS

Windows, Linux, Unix, OS-X

Private contact detail

A contact detail that is not meant to be shared with others

Rating

A score given to a student by interviewers based on areas such as technical competency, leadership quality, communication skills and ability to work well in a team

Status

Indicates a student’s current state within the hiring process - new, in-review, interview, offered, rejected or withdrawn

Fields

Refer to the student’s attributes, including name, phone, address, email, expected graduation year, GPA, interview date, university, major, position applied, profile photo, salutation, status, rating and remark. Some of these fields are mandatory while optional fields can be updated later.

Appendix G: Product Survey

Product Name

Author: …​

Pros:

• …​

• …​

Cons:

• …​

• …​

Appendix H: Instructions for Manual Testing

Given below are instructions to test the app manually.

ℹ️	These instructions only provide a starting point for testers to work on; testers are expected to do more exploratory testing.

H.1. Launch and Shutdown

1. Initial launch

   1. Download the jar file and copy into an empty folder

   2. Double-click the jar file
      Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

2. Saving window preferences

   1. Resize the window to an optimum size. Move the window to a different location. Close the window.

   2. Re-launch the app by double-clicking the jar file.
      Expected: The most recent window size and location is retained.

H.2. Adding a student

1. Adding a student into HR+

   1. Prerequisites: No student contact in HR+ has the same name, phone number, email, address, university, expected graduation year, major and grade point average as the student contacts to be added.

   2. Command: add n/Damith p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 u/NUS y/2018 m/Computer Science g/2.74 j/Software Developer c/Extraordinary Regex skill
      Expected: A student named Damith with the above particulars will be added into HR+. The student will be shown in the persons list panel.

   3. Add a resume pdf file named resume.pdf to the same folder as the jar file. It also must be valid PDF and smaller than 1MB.
      Add an image named image.jpg to the same folder as the jar file. It also must be valid image file and smaller than 1MB.
      Command: add n/Irene Bae p/83627133 e/[email protected] a/341, Woodlands Drive 20, #22-15 u/SNU y/2020 m/Computer Engineering g/4.87 j/Software Tester r/resume.pdf i/image.jpg
      Expected: A student named Irene is added with the above particulars. A resume and a profile image will be added.

H.3. Showing info panel or resume

1. Showing either student info or resume in the right panel

   1. Prerequisites: A student is selected using the select command. The student selected has a resume added into HR+.

   2. Command: show resume
      Expected: The resume of the student is displayed when it is available. Command: show info
      Expected: The information of the student is displayed in the right panel.

H.4. Scheduling an interview

Scheduling an interview for a student

1. Command: interview 1 next Friday at 3pm
   Expected: The interview date of the 1st person will be scheduled on next Friday at 3pm.

2. Command: interview 2 Mar 14 2pm
   Expected: The interview of the 2nd person will be scheduled on 14 March at 2pm.

H.5. Rating a student

1. Adding rating scores to a student without ratings

   1. Prerequisites: Student at index 2 must not have ratings yet.

   2. Command: rate 2 t/3.45 c/4.5 p/3.25 e/4
select 2
      Expected: Ratings of the second person updated to the above scores. Overall rating is updated to 3.8.

H.6. Editing a rating

1. Editing rating scores assigned to a student whom you have already rated

   1. Prerequisites: Student at index 2 must have rating scores assigned already.

   2. Command: rating-edit 2 t/4.2
select 2
      Expected: Technical skills score of the second student is updated to 4.2.

H.7. Deleting a rating

1. Deleting rating scores assigned to a student whom you have already rated

   1. Prerequisites: Student at index 2 must have rating scores assigned already.

   2. Command: rating-delete 2
      Expected: Rating scores of the second student is cleared.

H.8. Sorting the students list

1. Sorting the list of students in the left panel according to some order

   1. Command: sort rating o/desc
      Expected: List of students in the left panel are arranged based on their overall rating in descending order.

   2. Command: sort name o/asc
      Expected: List of students in the left panel are listed in alphabetical order with cases ignored.

H.9. Updating status of a student

1. Updating the status of a student from the list of status

   1. Command: status 1 2
      Expected: Student at index 2 has its status changed to 1st round interview.

H.10. Filtering according to multiple fields

1. Filtering the list of students according to multiple fields

   1. Command: filter y/2019 r/3.5-4.5
      Expected: The student list now only contains students with 2019 as their expected graduation year and with overall rating score between 3.5 to 4.5, inclusive.

H.11. Finding every field of the student

1. Finding the list of students with any fields that match the search keyword according to the search support stated in the User Guide.

   1. Command find bernice, charlot
      Expected: The student list now displays students Bernice Yu and Charlotte Oliveiro with reference to the sample data provided.

H.12. Finding specific field of the student

1. Finding the list of students with chosen fields that match the search keyword according to the search support stated in the User Guide.

   1. Command find e/[email protected], [email protected] j/Software p/87438807
      Expected: The student list now displays student Alex Yeoh with reference to the sample data provided.