By: Team CS2103-AY1819S1-T10-2 Since: Aug 2018 Licence: MIT

1. Setting up

1.1. Prerequisites

  1. JDK 9 or later

    JDK 10 on Windows will fail to run tests in headless mode due to a JavaFX bug. Windows developers are highly recommended to use JDK 9.

  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.2. 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.3. Verifying the setup

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

  2. Run the tests to ensure they all pass.

1.4. Configurations to do before writing code

1.4.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.4.2. Updating documentation to match your fork

After forking the repo, the documentation will still have the SE-EDU branding and refer to the se-edu/addressbook-level4 repo.

If you plan to develop this fork as a separate product (i.e. instead of contributing to se-edu/addressbook-level4), you should do the following:

  1. Configure the site-wide documentation settings in build.gradle, such as the site-name, to suit your own project.

  2. Replace the URL in the attribute repoURL in DeveloperGuide.adoc and UserGuide.adoc with the URL of your fork.

1.4.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.4.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

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.

  • Calendar: 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.

LogicComponentClassDiagram
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-patient n/John Doe.

SDforDeletePerson
Figure 3. Component interactions for delete-patient n/John Doe command (part 1)
Note how the Model simply raises a HealthBookChangedEvent when the HealthBook 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.

SDforDeletePersonEventHandling
Figure 4. Component interactions for delete-patient n/John Doe 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

UiClassDiagram
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, InformationPanel 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

LogicComponentClassDiagram
Figure 6. Structure of the Logic Component

API : Logic.java

  1. Logic uses the HealthBookParser 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-patient n/John Doe") API call.

DeletePersonSdForLogic
Figure 7. Interactions Inside the Logic Component for the delete-patient n/John Doe Command

2.4. Calendar component

CalendarComponentClassDiagram
Figure 8. Structure of the Calendar Component

API : GoogleCalendar.java

The Calendar,

  • uses Google Calendar API to access the users Google calendar to read and write information to their calendar.

  • stores the OAuth of users google calendar data in tokens folder.

2.5. Model component

ModelComponentClassDiagram
Figure 9. Structure of the Model Component

API : Model.java

The Model,

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

  • stores the HealthBook 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.6. Storage component

StorageComponentClassDiagram
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 HealthBook data in xml format and read it back.

2.7. 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. Register Patient Feature

3.1.1. Current Implementation

The register patient are facilitated by RegisterPatientCommand and RegisterPatientCommandParser. The Patient object is automatically tagged as Patient.

RegisterPatientSequenceDiagram
Figure 11. Register Patient Sequence Diagram

Patient model contains a List of upcoming appointment and List of past appointments. We implemented the patient model in this way to allow ease of addition of new upcoming appointment to the patient.

Step 1. The user types in register-patient in the command box followed by the parameters n/John Doe p/91234567 e/test@test.com a/123 Clementi Road

Command Exception will be thrown if any of the information is missing or invalid. All fields are mandatory.

Step 2. Upon hitting enter, the Patient will be created and added to the storage of the system

Patient is saved in the storage as person. However, when we retrieve the patient object from storage, it will be created as a patient as determined by their tag.

3.1.2. Design Considerations

Aspect: Data Structure of Upcoming and Past Appointments

  • Alternative 1 (Current Choice): Upcoming Appointments stored within a List and Past Appointments stored within a List. This allows the appointments to be compatible with the Observable List. Sorted list of appointments is not crucial to the implementation of the HealthBook. Hence, we chose to implement the data structure as a list instead.

    • Pros: Compatible and easily to implement with model and storage

    • Cons: List is not sorted

  • Alternative 2 (Alternative Choice): Upcoming Appointments stored within a PriorityQueue and Past Appointments stored within an ArrayList. This allows the appointments to be added in a non chronological order and automatically slotted in the correct position. Past appointments can also be iterated through easily when required.

    • Pros: Appointments can be added in a non chronological order.

    • Cons: Need to do parsing before passing to model and storage. Hard to manage.

3.2. Register Doctor Feature

3.2.1. Current Implementation

The register doctor are facilitated by RegisterDoctorCommand and RegisterDoctorCommandParser. The Doctor object is automatically tagged as Doctor.

RegisterDoctorSequenceDiagram
Figure 12. Register Doctor Sequence Diagram

Step 1. The user types in register-doctor in the command box followed by the parameters n/John Doe p/91234567 e/test@test.com a/123 Clementi Road

Command Exception will be thrown if any of the information is missing or invalid. All fields are mandatory.

Step 2. Upon hitting enter, a browser will be opened for user to login to google to register their Google Calendar.

GoogleLoginPage
Figure 13. Google Login Page

Step 3. Simultaneously, the Doctor will be created and added to the storage of the system. In the case that the user does not login to google, subsequent access to the HealthBook will be denied.

Login to Google Calendar is MANDATORY for registration of doctor. This is to facilitate the features that allows doctor to interact with the HealthBook. If no login is done, the HealthBook will not proceed.
Doctor is saved in the storage as person. However, when we retrieve the doctor object from storage, it will be created as a doctor as determined by their tag.

3.2.2. Design Considerations

Aspect: Presenting Google Calendar Login to Doctors

  • Alternative 1 (Current Choice): Implement Google Calendar login with a popped up browser.

    • Pros: Data transfer for the Google login to be simplified. No additional parsing will be required. In addition, the pop up of the browser will capture the users attention, decreasing the chance of user missing this login procedure.

    • Cons: Temporarily exits the application.

  • Alternative 2 (Alternative Choice): Implement Google Calendar login with the browser panel instead. Instead of having an additional browser, we load the login page into the Browser Panel. This will facilitate a seamless login for the login but user might miss the login compared to having a popped up browser.

    • Pros: Stays within the application.

    • Cons: User may miss the login which is mandatory, causing the application to not respond.

Aspect: Saving Doctor with respect to Google Login

  • Alternative 1 (Current Choice): Doctor object will not be created and application will not respond if login is unsuccessful. From the integration used for Google OAuth, it is mandatory for user to login before any process can continue. This function as our features is complimentary for our application as HealthBook will work at its best with the google calendar login.

    • Pros: No requirement to implement a new Google OAuth. Easy implementation.

    • Cons: Application may not respond if login is not done.

  • Alternative 2 (Alternative Choice): Allow doctor to still be created with or without the Google Login. Implement register-doctor to have Google Login as optional. However, subsequent calls of Calendar related functions will still prompt the user to login.

    • Pros: Flexible login feature.

    • Cons: Hard to implement. Need to recreate a Google OAuth system. Features of the HealthBook not utilized.

3.3. Delete Patient and Doctor Feature

3.3.1. Current Implementation

The delete patient and doctor features are facilitated by DeletePatientCommand and DeleteDoctorCommand. Both extends DeleteCommand such that it is able to delete a specific subclass of Person (i.e. Patient or Doctor) instead. Additionally, instead of deletion by index, deletion by name is used in this implementation.

DeletePatientSequenceDiagram
Figure 14. Delete Patient Sequence Diagram
DeleteDoctorSequenceDiagram
Figure 15. Delete Doctor Sequence Diagram

Step 1. The user types in delete-patient or delete-doctor in the command box followed by the parameters n/John Doe p/12345678

Step 2. Upon hitting enter, the Patient or Doctor will be removed from the system.

3.3.2. Design Considerations

Aspect: Algorithm to find Patient or Doctor to delete

  • Alternative 1 (Current choice): Loop through model.getFilteredPersonList() to find Patient or Doctor to delete

    • Pros: Easy to implement

    • Cons: If size of list grows unusually large (unusual because of our target audience), it may take awhile to retrieve the Patient or Doctor

  • Alternative 2: Use a Map that maps name to Patient or Doctor

    • Pros: Fast retrieval

    • Cons: Will have to change a lot of lines of code

3.4. View Patient and Doctor Feature

3.4.1. Current Implementation

The view patient and doctor features are facilitated by ViewPatientCommand and ViewDoctorCommand. This feature shows information of the person corresponding to the name specified.

ViewPatientSequenceDiagram
Figure 16. View Patient Sequence Diagram
ViewDoctorSequenceDiagram
Figure 17. View Doctor Sequence Diagram

Step 1. The user types in view-patient or view-doctor in the command box followed by the parameters n/John Doe

Step 2. Upon hitting enter, information of Patient or Doctor will be reflected on the main information panel

3.5. Filter Patient and Filter Doctor Feature

3.5.1. Current Implementation

This feature help to filter all patients/doctors in HealthBook

FilterPatientSequenceDiagram
Figure 18. Filter Patient Sequence Diagram

Step 1. The user types filter-patient or filter-doctor in the command box

Step 2. Upon hitting enter, all persons who are tagged as Patient or Doctor would appear on the panel

3.6. Add Appointment Feature

3.6.1. Current Implementation

The add appointment features are facilitated by AddAppointmentCommand. This feature allows user to add appointments in the HealthBook which will be added to the respective Patient and Doctor of the Appointment as well.

AddAppointmentSequenceDiagram
Figure 19. Add Appointment Sequence Diagram

Step 1. The user types in add-appointment in the command box followed by the parameters np/John Doe nd/Mary Jane d/2018-10-17 15:00

Step 2. Upon hitting enter, the Appointment will be added to the HealthBook, the Patient, and the Doctor and his/her Google calendar

3.7. Delete Appointment Feature

3.7.1. Current Implementation

The delete appointment features are facilitated by DeleteAppointmentCommand. This feature allows user to delete appointments in the HealthBook which will be deleted from the respective Patient and Doctor of the Appointment as well.

DeleteAppointmentSequenceDiagram
Figure 20. Delete Appointment Sequence Diagram

Step 1. The user types in delete-appointment in the command box followed by the appointment id 10000

Step 2. Upon hitting enter, the Appointment will be removed from the HealthBook, the Patient, and the Doctor and his/her Google calendar

3.8. Complete Appointment Feature

3.8.1. Current Implementation

The complete appointment features are facilitated by CompleteAppointmentCommand. This feature allows user to complete existing appointments that has already passed in the HealthBook which change the status of the Appointment from UPCOMING to COMPLETED.

CompleteAppointmentSequenceDiagram
Figure 21. Complete Appointment Sequence Diagram

Step 1. The user types in complete-appointment in the command box followed by the appointment id 10000

Step 2. Upon hitting enter, the status in the Appointment will be changed from UPCOMING to COMPLETED

3.9. Add Prescription Feature

3.9.1. Current Implementation

The add prescription feature is facilitated by AddPrescriptionCommand and AddPrescriptionCommandParser This command is implemented such that it is able to add a Prescription object for a specific Appointment specified by appointment id.

Since Appointment currently only stores Doctor and Patient as String, thus appointment with the updated prescription will be updated for both Doctor and Patient only if the appointment is upcoming and only updated for Patient if the appointment is completed.

AddPrescriptionSequenceDiagram
Figure 22. Add Prescription Sequence Diagram

Step 1. The user types add-prescription in the command box followed by the parameters APPOINTMENT_ID pn/MEDICINE_NAME pd/DOSAGE pc/CONSUMPTION_PER_DAY.

Step 2. Upon hitting enter, the Prescription will be created and added to the Appointment.

Exception will be thrown if a medicine of the same name already exists in appointment regardless of dosage and consumption per day.
Exception will be thrown if medicine that the patient is allergic to is added to the appointment.
Prescription can be added to both upcoming and completed appointments

3.9.2. Design considerations

Aspect: How to model Prescription

  • Alternative 1 (Current choice) : prescription is modelled by a Prescription object with 3 attributes medicineName , dosage and consumptionPerDay

  • Alternative 2 : Prescription object stores attributes medicineName as a String and dosage, consumptionPerDay as int.

3.10. Delete Prescription Feature

3.10.1. Current Implementation

The delete prescription is facilitated by DeletePrescriptionCommand and DeletePrescriptionCommandParser. This command is implemented such that it is able to delete a Prescription object for a specific `Appointment specified by appointment id.

DeletePrescriptionSequenceDiagram
Figure 23. Delete Prescription Sequence Diagram

Step 1. The user types delete-prescription in the command box followed by the parameters APPOINTMENT_ID pn/MEDICINE_NAME.

Step 2. Upon hitting enter, the Prescription will be deleted from the Appointment.

Exception will be thrown if medicine to be deleted does not exist in appointment.
Prescription can be deleted from both upcoming and completed appointments

3.11. Add Medical History Feature

3.11.1. Current Implementation

The add medical history feature is facilitated by AddMedicalHistoryCommand and AddMedicalHistoryCommandParser. This command is implemented such that it is able to add Allergy AND/OR Condition to MedicalHistory object for a specific Patient specified by name.

AddMedicalHistorySequenceDiagram
Figure 24. Add Medical History Sequence Diagram

Step 1. The user types in add-medical-history in the command box followed by the parameter n/John Doe al/penicillin,milk c/subhealthy,hyperglycemia

For multiple inputs in the same field, use comma , to separate. You can only omit either ALLERGY parameter or CONDITION parameter. Allergies and conditions should only contain alphanumeric characters and spaces, and they should not be blank.

Step 2. Upon hitting enter, the allergies AND/OR conditions of MedicalHistory will get added

Exception will be thrown if inputs for both field are blank.

3.11.2. Design Consideration

Aspect: The way to model MedicalHistory

  • Alternative 1 (Current choice): Model Allergy and Condition as classes. AddMedicalHistoryCommand contains ArrayLists of Allergy and Condition.

  • Alternative 2 : Treat allergy and condition as Strings. AddMedicalHistoryCommand contains two ArrayLists of String.

3.12. Delete Medical History Feature

3.12.1. Current Implementation

The delete medical history feature is facilitated by DeleteMedicalHistoryCommand and DeleteMedicalHistoryCommandParser. This command is implemented such that it is able to delete Allergy AND/OR Condition from MedicalHistory object for a specific Patient specified by name.

DeleteMedicalHistorySequenceDiagram
Figure 25. Delete Medical History Sequence Diagram

Step 1. The user types in delete-medical-history in the command box followed by the parameter n/John Doe al/penicillin,milk c/subhealthy,hyperglycemia

For multiple inputs in the same field, use comma , to separate. You can only omit either ALLERGY parameter or CONDITION parameter. Allergies and conditions should only contain alphanumeric characters and spaces, and they should not be blank.

Step 2. Upon hitting enter, the Allergy AND/OR Condition of MedicalHistory will get deleted

Exception will be thrown if inputs for both field are blank. Exception will be thrown if given input is not in the original medical history.
Aspect: The way to model MedicalHistory

  • Alternative 1 (Current choice): Model Allergy and Condition as classes. AddMedicalHistoryCommand contains ArrayLists of Allergy and Condition.

  • Alternative 2 : Treat allergy and condition as Strings. AddMedicalHistoryCommand contains two ArrayLists of String.

3.13. Remark Feature

3.13.1. Current Implementation

Remark command allows user to input any information into a Person object with no restrictions. If an input is empty, the previous existing remark is deleted. This command can only be called after person is created.

RemarkCommandSequenceDiagram
Figure 26. Remark Command Sequence Diagram

Step 1. The user types in remark in the command box followed by the parameters appointment_id r/some remark

Step 2. Upon hitting enter, the new remark will be visible in the Doctor/Patient’s contact. If input was empty, the previous remark will be deleted.

3.14. 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.15, “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.15. 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.

chrome save as pdf
Figure 27. Saving documentation as PDF files in Chrome

4.4. Site-wide Documentation Settings

The build.gradle file specifies some project-specific asciidoc attributes which affects how all documentation files within this project are rendered.

Attributes left unset in the build.gradle file will use their default value, if any.
Table 1. List of site-wide attributes
Attribute name Description Default value

site-name

The name of the website. If set, the name will be displayed near the top of the page.

not set

site-githuburl

URL to the site’s repository on GitHub. Setting this will add a "View on GitHub" link in the navigation bar.

not set

site-seedu

Define this attribute if the project is an official SE-EDU project. This will render the SE-EDU navigation bar at the top of the page, and add some SE-EDU-specific navigation items.

not set

4.5. Per-file Documentation Settings

Each .adoc file may also specify some file-specific asciidoc attributes which affects how the file is rendered.

Asciidoctor’s built-in attributes may be specified and used as well.

Attributes left unset in .adoc files will use their default value, if any.
Table 2. List of per-file attributes, excluding Asciidoctor’s built-in attributes
Attribute name Description Default value

site-section

Site section that the document belongs to. This will cause the associated item in the navigation bar to be highlighted. One of: UserGuide, DeveloperGuide, LearningOutcomes*, AboutUs, ContactUs

* Official SE-EDU projects only

not set

no-site-header

Set this attribute to remove the site navigation bar.

not set

4.6. Site Template

The files in docs/stylesheets are the CSS stylesheets of the site. You can modify them to change some properties of the site’s design.

The files in docs/templates controls the rendering of .adoc files into HTML5. These template files are written in a mixture of Ruby and Slim.

Modifying the template files in docs/templates requires some knowledge and experience with Ruby and Asciidoctor’s API. You should only modify them if you need greater control over the site’s layout than what stylesheets can provide. The SE-EDU team does not provide support for modified template files.

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, HelpWindow.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, HealthBook 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

    • Solution

      • Modify the switch statement in HealthBookParser#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 HealthBook, 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.5, “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 HealthBook.

    • Hints

      • The Model and the HealthBook 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 HealthBook and Person classes can be used to implement the tag removal logic. HealthBook allows you to update a person, and Person allows you to update the tags.

    • Solution

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

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

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

      • See this PR for the full solution.

Ui component

Scenario: You are in charge of ui. During a beta testing session, your team is observing how the users use your HealthBook 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

    getting started ui tag before

    After

    getting started ui tag 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

    getting started ui result before

    After

    getting started ui result after

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

    Before

    getting started ui status before

    After

    getting started ui status 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 HealthBook is updated.

    • 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 HealthBook to the cloud. However, the current implementation of the application constantly saves the HealthBook 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 HealthBook storage.

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

  1. Add a new method backupHealthBook(ReadOnlyHealthBook), so that the HealthBook can be saved in a fixed temporary location.

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 HealthBook, 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 Command. Upon execution, it should just throw an Exception.

  2. Modify HealthBookParser to accept a RemarkCommand.

Tests:

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

  2. Add new test method to HealthBookParserTest, 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 HealthBookParser 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 HealthBookParserTest 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 healthBook.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 invalidAndValidPersonHealthBook.xml, typicalPersonsHealthBook.xml, validHealthBook.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:

  • Clinic Receptionists

  • has a need to manage a significant number of appointments

  • has a need to keep track of history of patients, appointments and prescriptions

  • prefer desktop apps over other types

  • can type fast

  • prefers typing over mouse input

  • is reasonably comfortable using CLI apps

Value proposition: Our platform will allow the clinic receptionist to easily manage patient’s medical information and appointments with the doctors. This will allow appointments to be efficiently managed and information transfer to be more seamless.

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…​

* * *

receptionist

register accounts for patients or doctors

keep track of their appointments and other information

* * *

receptionist

delete an account for patients or doctors

remove accounts that are not in use or invalid

* * *

receptionist

view patient’s upcoming appointments, recent visits and follow-ups requests on the landing page

easily look through the patients information

* * *

receptionist

add prescription to patient after appointment

keep their latest completed appointment updated

* * *

receptionist

delete prescription to patient after appointment

remove any discrepancies found

* *

receptionist

edit prescription to patient after appointment

amend any discrepancies found

* * *

receptionist

check prescription provided by doctor

follow up with the patients if they wish to check their prescription

* * *

receptionist

add patient details (especially medical history) to patient’s profile

allow the doctors to find the patients records easily

* * *

receptionist

delete patient details (especially medical history) from patient’s profile

allow the doctors to find the most updated patients records

* * *

receptionist

view patient’s details prior to appointment

provide information to the doctor, allowing them to know the full extent of patient’s health condition

* * *

receptionist

remind a particular patient of their next appointment

prevent him/her from forgetting their appointments

* *

receptionist

remind all patients of their next appointment

prevent them from forgetting their appointments

* * *

receptionist

book an doctor’s appointment for patient

reserve an appointment with doctor for the patient

`* * `

receptionist

edit an doctor’s appointment for patient

edit a reserve slot for an appointment with doctor for the patient

* * *

receptionist

delete an doctor’s appointment for patient

remove a reserve slot for an appointment with doctor for the patient

Appendix D: Use Cases

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

Use case: Register Doctor

MSS

  1. User requests to register a Doctor into the HealthBook

  2. User enters relevant details specified by command

  3. HealthBook brings user to google log in page

  4. User enters google login details

  5. User closes google page and reopens HealthBook

  6. HealthBook registers the doctor.

    Use case ends.

Extensions

2a. User enters wrong format for command.

  • 2a1. HealthBook shows an error message.

    Use case resumes at step 2

2b. User enters a duplicate persons.

  • 2b1. HealthBook shows an error message.

    Use case resumes at step 2

3a. User closes google page without logging in.

  • 3a1. HealthBook will become unresponsive

  • 3a2. User closes and reopens Healthbook

    Use case restarts from step 1

Use case: Register Patient

MSS

  1. User requests to register a Patient into the HealthBook

  2. User enters relevant details specified by command

  3. HealthBook registers the patient.

    Use case ends.

Extensions

2a. User enters wrong format for command.

  • 2a1. Healthbook shows an error message.

    Use case resumes at step 2

2b. User enters a duplicate persons.

  • 2b1. Healthbook shows an error message.

    Use case resumes at step 2

Use case: Delete Doctor/Patient

MSS

  1. User requests to list persons

  2. HealthBook shows a list of persons

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

  4. HealthBook deletes the person

    Use case ends.

Extensions

  • 2a. The list is empty.

    Use case ends

  • 3a. User enters a name that belongs to multiple contacts with different phone numbers

    • 3a1. Healthbook shows an error message that prompts user to enter phone parameter.

      Use case resumes at step 2

  • 3b. User enters an invalid name and/or phone

    • 3b1. Healthbook shows an error message.

      Use case resumes at step 2

Use case: View person

MSS

  1. User requests to list persons

  2. HealthBook shows a list of persons

  3. User requests to view a specific person in list

  4. HealthBook shows the person

    Use case ends

Extensions

  • 2a. The list is empty.

    Use case ends

  • 3a. User enters a name that belongs to multiple contacts with different phone numbers

    • 3a1. Healthbook shows an error message that prompts user to enter phone parameter.

      Use case resumes at step 2

  • 3b. User enters an invalid name and/or phone

    • 3b1. Healthbook shows an error message.

      Use case resumes at step 2

Use case: List persons

MSS

  1. User requests to list persons

  2. HealthBook shows list of persons.

    Use case ends.

Use case: Filter Doctor/Patient

MSS

  1. User requests to filter doctors/patients

  2. HealthBook shows list of doctors/patients

    Use case ends.

Use case: Add Appointment

MSS

  1. User requests to list persons

  2. HealthBook shows a list of persons

  3. User requests to add an appointment to the HealthBook for a specific Doctor and Patient

  4. HealthBook adds the person

    Use case ends.

Extensions

  • 3a. The given Doctor and/or Patient name is has a duplicate contact with a different phone number.

    • 3a1. HealthBook shows an error and prompts user to input a phone number to differentiate.

      Use case resumes at step 2

  • 3b. User enters an invalid name and/or phone

    • 3b1. Healthbook shows an error message.

      Use case resumes at step 2

Use case: Delete Appointment

MSS

  1. User requests to list persons

  2. HealthBook shows a list of persons

  3. User requests to delete an appointment in the HealthBook for a specific appointmentId

  4. HealthBook deletes the appointment

    Use case ends.

Extensions

  • 3a. The given Id is invalid.

    • 3a1. HealthBook shows an error message.

      Use case resumes at step 2.

Use case: Complete Appointment

MSS

  1. User requests to list persons

  2. HealthBook shows a list of persons

  3. User requests to complete a specific appointment in the list

  4. HealthBook completes the appointment

Extensions

  • 2a. The list is empty.

    Use case ends.

  • 3a. The given Id is invalid.

    • 3a1. HealthBook shows an error message.

      Use case resumes at step 2.

Use case: Add Prescription

MSS

  1. User requests to list persons

  2. HealthBook shows a list of persons

  3. User requests to add a specific prescription to a specific appointment in the list

  4. HealthBook adds the prescription

Extensions

  • 3a. The given Id is invalid.

    • 3a1. HealthBook shows an error message.

      Use case resumes at step 2.

  • 3b. The given prescription’s medicine name already exists in HealthBook

    • 3b1. HealthBook shows an error message.

      Use case resumes at step 2.

  • 3c. The given patient is allergic to the given prescription’s medicine name.

    • 3c1. HealthBook shows an error message.

      Use case resumes at step 2.

Use case: Delete Prescription

MSS

  1. User requests to list persons

  2. HealthBook shows a list of persons

  3. User requests to delete a specific prescription from a specific appointment

  4. HealthBook deletes the prescription

    Use case ends.

Extensions

  • 2a. The list is empty.

    Use case ends.

  • 3a. The given id is invalid.

    • 3a1. HealthBook shows an error message.

      Use case resumes at step 2.

  • 3b. The given prescription is invalid.

    • 3b1. HealthBook shows an error message.

      Use case resumes at step 2.

Use case: Add Medical History

MSS

  1. User requests to list persons/filter-patients

  2. HealthBook shows a list of persons/patients

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

  4. HealthBook adds the medical history of the patient.

Extensions

  • 3a. The given Patient name has a duplicate contact with a different phone number.

    • 3a1. HealthBook shows an error and prompts user to input a phone number to differentiate.

      Use case resumes at step 2.

  • 3b. User enters an invalid name and/or phone

    • 3b1. Healthbook shows an error message.

      Use case resumes at step 2.

  • 3c. User enters a duplicate allergy/condition

    • 3c1. HealthBook shows an error message.

      Use case resumes at step 2.

Use case: Delete Medical History

MSS

  1. User requests to list persons/filter-patients

  2. HealthBook shows a list of persons/patients

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

  4. HealthBook deletes the medical history of the patient.

Extensions

  • 3a. The given Patient name has a duplicate contact with a different phone number.

    • 3a1. HealthBook shows an error and prompts user to input a phone number to differentiate.

      Use case resumes at step 2.

  • 3b. User enters an invalid name and/or phone

    • 3b1. Healthbook shows an error message.

      Use case resumes at step 2.

  • 3c. User enters an invalid allergy/ condition

    • 3c1. HealthBook shows an error message.

      Use case resumes at step 2.

Use case: Remark person

MSS

  1. User requests to list persons

  2. HealthBook shows a list of persons

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

  4. HealthBook adds/deletes the remark.

    Use case ends.

Extensions

  • 3a. The given Person name has a duplicate contact with a different phone number.

    • 3a1. HealthBook shows an error and prompts user to input a phone number to differentiate.

      Use case resumes at step 2.

  • 3b. User enters an invalid name and/or phone

    • 3b1. Healthbook 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 9 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. Requires internet access to carry out operations in the HealthBook

Appendix F: Glossary

Mainstream OS

Windows, Linux, Unix, OS-X

Receptionist

Target audience

Patient

Indirect target audience, patient whom visits the clinic

Doctor

Indirect target audience, doctor whom works at the clinic

Appointment

A date and time fixed for a patient to consult a doctor

Prescription

The medicine prescribed for the appointment

Medical History

Allergies and/or conditions that a patient may have

Appendix G: 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.

G.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.

G.2. Deleting a patient

  1. Deleting a patient

    1. Prerequisites: List all persons using the list command if filter-patient or filter-doctor has been called before.

    2. Test case: delete-patient n/John Doe
      Expected: Patient named John Doe deleted from the HealthBook, along with any appointments tied to him. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.

    3. Test case: delete-patient n/jlfsajfl
      Expected: No patient is deleted if no patient with such name exists. Error details shown in the status message. Status bar remains the same.

    4. Other incorrect delete commands to try: delete-patient
      Expected: Similar to previous.

G.3. Viewing a patient

  1. Viewing a patient

    1. Prerequisites: List all persons using the list command if filter-patient or filter-doctor has been called before.

    2. Test case: view-patient n/John Doe
      Expected: Information panel reflects information of John Doe from the HealthBook. Name of patient currently viewing is shown in the status message. Timestamp in the status bar is updated.

    3. Test case: view-patient n/jlfsajfl
      Expected: No patient is viewed if no patient with such name exists. Error details shown in the status message. Status bar remains the same.

    4. Other incorrect delete commands to try: view-patient
      Expected: Similar to previous.