PTCoach Developer Guide

---

Acknowledgements

{ list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }

---

Setting up, getting started

Refer to the guide Setting up and getting started.

---

Design

Architecture

The Architecture Diagram given above explains the high-level design of the App.

Given below is a quick overview of main components and how they interact with each other.

Main components of the architecture

Main (consisting of classes Main and MainApp) is in charge of the app launch and shut down.

• At app launch, it initializes the other components in the correct sequence, and connects them up with each other.
• At shut down, it shuts down the other components and invokes cleanup methods where necessary.

The bulk of the app's work is done by the following 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.

Commons represents a collection of classes used by multiple other components.

How the architecture components interact with each other

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

Each of the four main components (also shown in the diagram above),

• defines its API in an interface with the same name as the Component.
• implements its functionality using a concrete {Component Name}Manager class (which follows the corresponding API interface mentioned in the previous point.

For example, the Logic component defines its API in the Logic.java interface and implements its functionality using the LogicManager.java class which follows the Logic interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.

The sections below give more details of each component.

UI component

The API of this component is specified in Ui.java

The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, PersonListPanel, StatusBarFooter etc. All these, including the MainWindow, inherit from the abstract UiPart class which captures the commonalities between classes that represent parts of the visible GUI.

The UI component uses the 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.
• listens for changes to Model data so that the UI can be updated with the modified data.
• keeps a reference to the Logic component, because the UI relies on the Logic to execute commands.
• depends on some classes in the Model component, as it displays Person object residing in the Model.

Logic component

API : Logic.java

Here's a (partial) class diagram of the Logic component:

The sequence diagram below illustrates the interactions within the Logic component, taking execute("delete 1") API call as an example.

How the Logic component works:

1. When Logic is called upon to execute a command, it is passed to an AddressBookParser object which in turn creates a parser that matches the command (e.g., DeleteCommandParser) and uses it to parse the command.
2. This results in a Command object (more precisely, an object of one of its subclasses e.g., DeleteCommand) which is executed by the LogicManager.
3. The command can communicate with the Model when it is executed (e.g. to delete a person).
   Note that although this is shown as a single step in the diagram above (for simplicity), in the code it can take several interactions (between the command object and the Model) to achieve.
4. The result of the command execution is encapsulated as a CommandResult object which is returned back from Logic.

Here are the other classes in Logic (omitted from the class diagram above) that are used for parsing a user command:

How the parsing works:

• When called upon to parse a user command, the AddressBookParser class creates an XYZCommandParser (XYZ is a placeholder for the specific command name e.g., AddCommandParser) which uses the other classes shown above to parse the user command and create a XYZCommand object (e.g., AddCommand) which the AddressBookParser returns back as a Command object.
• All XYZCommandParser classes (e.g., AddCommandParser, DeleteCommandParser, ...) inherit from the Parser interface so that they can be treated similarly where possible e.g, during testing.

Model component

API : Model.java

The Model component,

• stores the address book data i.e., all Person objects (which are contained in a UniquePersonList object).
• stores the currently 'selected' Person objects (e.g., results of a search query) as a separate filtered list which is exposed to outsiders as 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.
• stores a UserPref object that represents the user’s preferences. This is exposed to the outside as a ReadOnlyUserPref objects.
• does not depend on any of the other three components (as the Model represents data entities of the domain, they should make sense on their own without depending on other components)

Storage component

API : Storage.java

The Storage component,

• can save both address book data and user preference data in JSON format, and read them back into corresponding objects.
• inherits from both AddressBookStorage and UserPrefStorage, which means it can be treated as either one (if only the functionality of only one is needed).
• depends on some classes in the Model component (because the Storage component's job is to save/retrieve objects that belong to the Model)

Common classes

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

---

Implementation

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

[Proposed] Undo/redo feature

Proposed Implementation

The proposed undo/redo mechanism is facilitated by VersionedAddressBook. It extends AddressBook with an undo/redo history, stored internally as an addressBookStateList and currentStatePointer. Additionally, it implements the following operations:

• VersionedAddressBook#commit() — Saves the current address book state in its history.
• VersionedAddressBook#undo() — Restores the previous address book state from its history.
• VersionedAddressBook#redo() — Restores a previously undone address book state from its history.

These operations are exposed in the Model interface as Model#commitAddressBook(), Model#undoAddressBook() and Model#redoAddressBook() respectively.

Given below is an example usage scenario and how the undo/redo mechanism behaves at each step.

Step 1. The user launches the application for the first time. The VersionedAddressBook will be initialized with the initial address book state, and the currentStatePointer pointing to that single address book state.

Step 2. The user executes delete 5 command to delete the 5th person in the address book. The delete command calls Model#commitAddressBook(), causing the modified state of the address book after the delete 5 command executes to be saved in the addressBookStateList, and the currentStatePointer is shifted to the newly inserted address book state.

Step 3. The user executes add n/David …​ to add a new person. The add command also calls Model#commitAddressBook(), causing another modified address book state to be saved into the addressBookStateList.

Step 4. The user now decides that adding the person was a mistake, and decides to undo that action by executing the undo command. The undo command will call Model#undoAddressBook(), which will shift the currentStatePointer once to the left, pointing it to the previous address book state, and restores the address book to that state.

The following sequence diagram shows how an undo operation goes through the Logic component:

Similarly, how an undo operation goes through the Model component is shown below:

The redo command does the opposite — it calls Model#redoAddressBook(), which shifts the currentStatePointer once to the right, pointing to the previously undone state, and restores the address book to that state.

Step 5. The user then decides to execute the command list. Commands that do not modify the address book, such as list, will usually not call Model#commitAddressBook(), Model#undoAddressBook() or Model#redoAddressBook(). Thus, the addressBookStateList remains unchanged.

Step 6. The user executes clear, which calls Model#commitAddressBook(). Since the currentStatePointer is not pointing at the end of the addressBookStateList, all address book states after the currentStatePointer will be purged. Reason: It no longer makes sense to redo the add n/David …​ command. This is the behavior that most modern desktop applications follow.

The following activity diagram summarizes what happens when a user executes a new command:

Design considerations:

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.

{more aspects and alternatives to be added}

[Proposed] Data archiving

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

---

Documentation, logging, testing, configuration, dev-ops

• Documentation guide
• Testing guide
• Logging guide
• Configuration guide
• DevOps guide

---

Appendix: Requirements

Product scope

Target user profile:

• Personal Trainers who manage a large client base and track client progress.
• Has a need to quickly access their contact details.
• Prefers a desktop app with an easy-to-use interface.
• Manages clients and their injuries efficiently.

Value proposition: Provides a centralized system for personal trainers to efficiently manage client contact details, track injury histories, and monitor training goals and skill progress, optimized for users who prefer a fast, keyboard-driven interface.

User stories

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

Use cases

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

Use case: UC1 - Add a client

MSS

1. Trainer requests to add a client.

2. PTCoach shows a success message.

   Use case ends.

Extensions

• 1a. The given details are invalid.

  • 1a1. PTCoach shows an error message.

    Use case ends.

• 1b. The given client exists.

  • 1b1. PTCoach shows an error message.

    Use case ends.

• 1c. The given command has an incorrect format.

  • 1c1. PTCoach shows an error message.

    Use case ends.

Use case: UC2 - Find a specific client

MSS

1. User requests to find a specific clients.

2. PTCoach shows list of all clients that match the person(s).

   Use case ends.

Extensions

• 1a. Trainer searches for an invalid name.

  • 1a1. PTCoach shows an error message.

    Use case ends.

• 1b. The given command has an incorrect format.

  • 1b1. PTCoach shows an error message.

    Use case ends.

• 2a. The list is empty.

  Use case ends.

Use case: UC3 - Edit a client

MSS

1. Trainer requests to edit a specific client.

2. PTCoach shows a success message.

   Use case ends.

Extensions

• 1a. Invalid index

  • 1a1. PTCoach shows an error message.

    Use case ends.

• 1b. Has missing parameters

  • 1b1. PTCoach shows an error message.

    Use case ends.

• 1c. No changes found

  • 1c1. PTCoach shows a success message.

    Use case ends.

• 1d. Incorrect format.

  • 1d1. PTCoach shows an error message.

    Use case ends.

Use case: UC4 - Delete a client

MSS

1. User requests to delete a specific client by index.

2. PTCoach deletes the client.

3. PTCoach shows a success message confirming the deletion.

   Use case ends

Extensions

• 1a. The list is empty.

  • 1a1. PTCoach shows an error message.

    Use case ends.

• 1b. The client does not exist.

  • 1b1. PTCoach shows an error message.

    Use case ends.

• 1c. The given command is in an incorrect format.

  • 1c1. PTCoach shows an error message.

    Use case ends.

Use case: UC5 - Launch the app via command line

MSS

1. User requests to launch the app via command line.

2. PTCoach launches.

   Use case ends.

Extensions

• 1a. The given command is in an incorrect format.

  Use case ends.

Use case: UC6 - List all clients

MSS

1. Trainer requests to view clients (optionally filtered by skill).

2. PTCoach shows a list of all clients.

3. PTCoach shows a list of clients matching the request.

   Use case ends.

Extensions

• 1a. The given command is in an incorrect format.

  • 1a1. PTCoach shows an error message.

    Use case ends.

• 2a. The list is empty.

  • 2a1. PTCoach shows a message indicating that the list is empty.

    Use case ends.

• 3a. No clients match the filter.

  • 3a1. PTCoach shows an empty list.

    Use case ends.

• 3b. Missing filter parameter

  • 3b1. PTCoach shows a message indicating that the parameter is empty.

    Use case ends.

Use case: UC7 - Read client details

MSS

1. Trainer requests to view a client’s details.

2. PTCoach displays the requested client data.

   Use case ends

Extensions

• 1a. The given details are invalid.

  • 1a1. PTCoach shows an error message.

    Use case ends.

• 1b. Client does not exist

  • 1b1. PTCoach shows an error message.

    Use case ends

• 1c. Trainer enters incorrect command format.

  • 1c1. PTCoach shows an error message.

    Use case ends.

Use case: UC8 - Navigate command history

MSS

1. Trainer presses the Up or Down arrow key.

2. PTCoach displays the corresponding command from the command history.

   Use case ends.

Extensions

• 1a. There are no previously entered commands.

  • 1a1. PTCoach does not display any command.

  Use case ends.

• 1b. Trainer presses Up when already at the oldest command.

  • 1b1. PTCoach keeps displaying the oldest command.

  Use case ends.

• 1c. Trainer presses Down when already at the most recent command.

  • 1c1. PTCoach displays an empty input field.

  Use case ends.

{More to be added}

Non-Functional Requirements

1. Should work on any mainstream OS (Windows, macOS and Linux) as long as it has Java 17 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 be usable by a novice who has never created a client address book before.
5. Should be able to return search results in under 3s.
6. Should store data locally only.
7. Should only be closed using the “exit” command or window close button or by killing the process.
8. Command input should not exceed 500 words.
9. Should only be opened through the command line.

{More to be added}

Glossary

• Personal Particulars: The set of information stored for each client, including:

  • Name
  • Contact Number
  • Address
  • Timeslot
  • Training Goals
  • Skill Level*
  • Progress Record*
  • Injury Status*

  * Optional particulars

• Field: A property of a person stored in the system

• Client: The person being added into the address book

• Trainer: The user of the program

• Duplicate clients: 2 Clients with the same phone number

• Timeslot: A field in a client which represents the timeslot allocated for training by the trainer

{More to be added}

---

Appendix: Instructions for manual testing

Given below are instructions to test the app manually.

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.

3. Exiting the application

   1. Test Case: exit
      Expected: The application closes.

   2. Click on the exit icon of the application Expected: The application closes.

Adding a person

1. Adding a person with all compulsory fields

   1. Prerequisites: The application is running normally.

   2. Test case: add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 t/Run 50km ts/mon:1,2
      Expected: A new person is added to the list. A success message is shown.

2. Adding a person with all fields

   1. Test case: add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 t/Run 50km ts/mon:1,2 i/Shoulder dislocation s/beginner pr/50
      Expected: A new person is added to the list with all provided details. A success message is shown.

3. Adding a duplicate person

   1. Prerequisites: A person with phone number 98765432 already exists.

   2. Test case: add n/Jane Doe p/98765432 e/janed@example.com a/Jane street t/Lift 100kg ts/tue:3
      Expected: No person is added. An error message is shown.

4. Adding a person with invalid fields

   1. Test case: add n/John Doe p/abc123 e/johnd@example.com a/John street t/Run 50km ts/mon:1,2
      Expected: No person is added. An error message is shown because the phone number is invalid

   2. Test case: add n/John Doe p/98765432 e/invalidEmail a/John street t/Run 50km ts/mon:1,2
      Expected: No person is added. An error message is shown because the email is invalid

   3. Test case: add n/John Doe p/98765432 e/johnd@example.com a/John street t/Run 50km ts/mon:13
      Expected: No person is added. An error message is shown because the timeslot is invalid

5. Adding a person with missing compulsory fields

   1. Test case: add n/John Doe p/98765432 e/johnd@example.com a/John street t/Run 50km
      Expected: No person is added. An error message is shown because the timeslot is missing.

   2. Test case: add n/John Doe p/98765432 e/johnd@example.com a/John street ts/mon:1,2
      Expected: No person is added. An error message is shown because the training goal is missing.

Listing persons

1. Listing all persons

   1. Test case: list
      Expected: All persons in the address book are shown.

2. Listing persons by skill filter

   1. Prerequisites: There are persons with different skill levels in the list.

   2. Test case: list s/beginner
      Expected: Only persons with skill level Beginner are shown.

   3. Test case: list s/expert
      Expected: Only persons with skill level Expert are shown.

   4. Test case: list s/beginner s/intermediate Expected: Only persons with skill level Beginner and Intermediate are shown.

3. Listing persons with no matching filter

   1. Test case: list s/beginner when there are no beginner clients
      Expected: An empty list is shown.

4. Listing persons with invalid filter

   1. Test case: list s/advanced Expected: The command is accepted but no client has the skill level Advanced. Hence, an empty list is shown.

   2. Test case: list s/beginer Expected: The command is accepted but no client has the skill level beginer. Hence, an empty list is shown. (note the beginer here has a typo error)

5. Listing persons with missing filter parameter

   1. Test case: list s/ Expected: An error message is shown because the skill filter is blank.

Editing a person

1. Editing a person with one field

   1. Prerequisites: List all persons using the list command. At least one person exists.

   2. Test case: edit 1 p/91234567
      Expected: The phone number of the 1st person is updated. A success message is shown.

2. Editing a person with multiple fields

   1. Test case: edit 1 e/johndoe@example.com t/Lift 100kg ts/fri:2,3 pr/70 s/intermediate
      Expected: The specified fields of the 1st person are updated. A success message is shown.

3. Editing a person with invalid index

   1. Prerequisites: List all persons using the list command. There is at least one person in the list and fewer than 999 persons in the list. Note: The index refers to the position shown in the displayed list and starts from 1.

   2. Test case: edit 0 p/91234567
      Expected: No person is edited. An error message is shown because index starts with 1 not 0.

   3. Test case: edit 999 p/91234567
      Expected: No person is edited. An error message is shown because index is out of range.

4. Editing a person with invalid values

   1. Test case: edit 1 p/abc123
      Expected: No person is edited. An error message is shown because phone number is invalid.

   2. Test case: edit 1 ts/mon:13
      Expected: No person is edited. An error message is shown because Timeslot is invalid.

   3. Test case: edit 1 s/advanced
      Expected: No person is edited. An error message is shown because skill is invalid.

5. Editing a person without providing fields

   1. Test case: edit 1
      Expected: No person is edited. An error message is shown.

Deleting a person

1. Deleting a person while all persons are being shown

   1. Prerequisites: List all persons using the list command. Multiple persons in the list.

   2. Test case: delete 1
      Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.

   3. Test case: delete 0
      Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.

   4. Other incorrect delete commands to try: delete, delete x, ... (where x is larger than the list size)
      Expected: Similar to previous.

Clearing all persons

1. Clearing the address book

   1. Prerequisites: List all persons using the list command. There are multiple persons in the address book.

   2. Test case: clear
      Expected: All persons are removed from the list. A success message is shown.

2. Clearing an already empty address book

   1. Prerequisites: The address book is empty.

   2. Test case: clear
      Expected: The list remains empty. A success message is shown.

Help command

1. Opening the help window

   1. Test case: help
      Expected: The help message appears.

2. Help with extra parameters

   1. Test case: help abc
      Expected: The help message appears.

Command history navigation

1. Navigating to previous commands

   1. Prerequisites: Enter several commands such as list, find John, and help.

   2. Press the Up arrow key once.
      Expected: The most recently entered command is shown in the command box.

   3. Press the Up arrow key again.
      Expected: The next earlier command is shown in the command box.

2. Navigating to newer commands

   1. Prerequisites: Use the Up arrow key at least once to move into command history.

   2. Press the Down arrow key once.
      Expected: A more recent command is shown in the command box.

3. Navigating when there is no command history

   1. Prerequisites: Fresh launch of the app without entering any command.

   2. Press the Up arrow key.
      Expected: No command is shown. The command box remains empty.

4. Navigating beyond the oldest command

   1. Prerequisites: There are previously entered commands.

   2. Repeatedly press the Up arrow key until the oldest command is shown.

   3. Press the Up arrow key again.
      Expected: The oldest command remains shown.

5. Navigating beyond the most recent command

   1. Prerequisites: Use the Up arrow key to navigate through command history.

   2. Repeatedly press the Down arrow key until the most recent position is reached.

   3. Press the Down arrow key again.
      Expected: The command box becomes empty.

Saving data

1. Saving data after add/edit/delete/clear

   1. Perform an add, edit, delete, or clear command.

   2. Close the application.

   3. Re-launch the application.
      Expected: The changes made previously are still present.

2. Dealing with missing data file

   1. Prerequisites: The data file [JAR file location]/data/addressbook.json does not exist.

   2. Launch the application.
      Expected: The application starts successfully with an empty list.

3. Dealing with corrupted data file

   1. Prerequisites: The data file [JAR file location]/data/addressbook.json contains invalid JSON.

   2. Launch the application.
      Expected: The application loads an empty list.