+
+
+
+
{{ content }}
-
- + +* Words in `grey blocks (like these)` usually represent any of the following: + 1. Text used in commands, such as `add-developer` + 2. Keys on your keyboard like `Enter` + 3. File names such as `CodeContact.jar` +
+
+:bulb: This is a blue box. It can be used for additional tips or more useful information.
+
+
+
+:exclamation: This is a warning box. It can be used to give more details on the warnings and limitations of features.
+
+
+#### Command Formatting
+
+| Format | Explanation | Example |
+|----------------------------------------------|--------------------------------------------------------------------|------------------------------------|
+| words in `[UPPER_CASE]` with square brackets | parameter values that are supplied by the user | `add-developer n/NAME n/PHONE` |
+| Items with `…` after them | parameters that can be used multiple times (or omitted completely) | `add-developer [pr/PROJECT]...` |
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+
+
+-----------------------------------------------------------------------------------------------
+
+## **Navigating the Graphical User Interface (GUI)**
+CodeContact comes with a GUI to allow for nice visual feedback for our users. Here is a quick run-through
+of the different sections of our GUI, as well as some notes regarding the use of the GUI.
+### Quick Orientation
+
++ + +Here is a quick summary of each GUI component within CodeContact: + +| Name | Description | +|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Menu Bar | Contains dropdown menu options for the CodeContact application. | +| Command Box | Allows users to enter CodeContact commands. | +| Result Display | 1. Provides CLI-based feedback upon a user command.
2. Allows users to see if their command was successful or not.
3. Provides error messages to guide users on how to use CodeContact commands. | +| Tabs | Allows users to see different lists of information on clicking on the relevant tabs. The tabs will also automatically switch to the correct tab corresponding to the command executed. | +| Developers/Clients/Projects card | Displays a list of Developer, Client or Project Cards. This list can be manipulated through commands like `find` and `list`. | +| Deadlines progress | Displays the progress of deadlines for a certain project. | +| Deadline list with details | Displays the details of the deadline in a table form. | +| Re-sort | Click on the respective words, there will be a small black arrow that appears. You can press to resort the data eg. show date from furthest to nearest day. | + +### Notes on GUI +
+If you executed a `find` command in developer tab and switched to the client tab, when you return to the developer tab the find results will be cleared and
+the whole list of developers will be shown again. This is the intended behavior of CodeContact as we hope that this can save you the time
+from always needing to call the list command.
+
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+## **Quick start**
+
+1. Ensure you have Java `11` or above installed in your Computer.
+
+2. Download the latest `CodeContact.jar`.
+
+3. Copy the file to the folder you want to use as the _home folder_ for your CodeContact.
+
+4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar CodeContact.jar`
+ command to run the application.+ +5. A GUI similar to the below should appear in a few seconds. Note how the app might contain some sample data.
+  + +6. For new users, learn to use CodeContact through our [Tutorial](#codecontact-tutorial--for-new-users-). + +7. Refer to the [Features](#features) below for details of each command. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +## **CodeContact Tutorial (for new users)** + +This is a tutorial for **first-time** CodeContact users. + +1. Launch CodeContact. You may refer to the instructions [here](#quick-start). + * On launch, CodeContact will not contain any developer or client records. +2. You will be asked to **enter a password** to unlock CodeContact. + * Enter the command `unlock pw/Password123!` in the command box. + +3. You can **change the password** to unlock CodeContact. + * Enter the command `change-password pw/Password123! npw/
:bulb:
+You can always lock and unlock CodeContact using the `lock` and `unlock` commands.
+
+
+1. Let us try **adding a project** to our CodeContact.
+ * Enter the
+ command `add-project n/AndroidApp dr/App to allow for different juices to be ordered dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0 `.
+
+2. We can then **add a developer** to our CodeContact.
+ * Enter the
+ command `add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp s/4500 d/01-11-2023 g/johng rt/3`.
+ * Try adding more developers with different details for each parameter!
+ * Remember to add a new [project](#add-project--add-project) or [role](#add-roles) if you wish to add new developers with other roles and
+ project.
+
+3. We can also **add a client** to our CodeContact.
+ * Enter the
+ command `add-client n/Amy p/88765423 e/amy@example.com a/31, Clementi Ave 6, #03-12 r/Client pr/AndroidApp o/Google do/google.com`.
+ * Try adding more clients with different details for each parameter!
+ * Remember to add a new [project](#add-project--add-project) or [role](#add-roles) if you which to add new client with other roles and project.
+
+4. Let us try **editing the name** of a developer stored in CodeContact.
+ * Enter the command `edit-developer 1 n/Jhonny`.
+ * Try editing other parameters or developers and projects too!
+ * More details of what you can edit can be found [here](#edit).
+
+5. We can also easily **find** for information in CodeContact.
+ * Enter the command `find-developer n/John s/4500`.
+ * Try looking for other information and search with multiple parameters!
+ * More details of what you can find can be found [here](#find).
+
+6. You can always **show the full list** after finding in CodeContact.
+ * Enter the command `list-developer`, `list-client` or `list-project`.
+
+7. You can **delete developers, clients or projects** in CodeContact.
+ * Enter the command `delete-developer 3` to delete the 3rd developer in CodeContact.
+ * More details on how delete works can be found [here](#delete-developer--delete-developer).
+
+8. If you realise that you did not delete this developer, you can **undo** this action in CodeContact.
+ * Enter the command `undo` and it will revert your previous actions.
+
+9. If you realise you actually want it deleted, you can **redo** this action in CodeContact.
+ * Enter the command `redo` and it will redo your previous actions.
+
+Congratulations! You are now ready to use CodeContact!
+
+To view all our features, you may visit our [Features](#features) section.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+# **Features**
+
+| [Security Features](#security-features) | Locking Access to features | Unlocking Access to features | Changing personal password |
+|:--------------------------------------------|:--------------------------:|:----------------------------:|:-----------------------------------------------------:|
+| [Password Protection](#password-protection) | [`lock`](#lock-lock) | [`unlock`](#unlock-unlock) | [`change-password`](#change-password-change-password) |
+
+| [Management Features](#management-features) | Developer | Client | Project |
+|:----------------------------------------------------|:-------------------------------------------------------------------------:|:----------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------:|
+| [Adding new information](#add) | [`add-developer`](#add-developer--add-developer) | [`add-client`](#add-client--add-client) | [`add-project`](#add-project--add-project) |
+| [Deleting information](#delete) | [`delete-developer`](#delete-developer--delete-developer) | [`delete-client`](#delete-client--delete-client) | [`delete-project`](#delete-project--delete-project) |
+| [Editing information](#edit) | [`edit-developer`](#edit-developer-details--edit-developer) | [`edit-client`](#edit-client-details--edit-client) | [`edit-project`](#edit-project-details--edit-project) |
+| [Importing information](#import-information) | [`import-developer` ](#import-developers-import-developer) | [`import-client`](#import-clients-import-client) | - |
+| [Finding information](#find) | [`find-developer`](#find-developer-details) | [`find-client`](#find-client-details) | [`find-project`](#find-project-details), [`find-deadline`](#find-deadlines-find-deadline) |
+| [Listing information](#listing-information--list) | `list-developer` | `list-client` | `list-project` |
+| [Adding new role](#add-roles) | [`add-developer-role`](#add-developer-roles--add-developer-role) | [`add-client-role`](#add-client-roles--add-client-role) | - |
+| [Deleting role](#delete-roles) | [`delete-developer-role`](#delete-developer-roles--delete-developer-role) | [`delete-client-role`](#delete-client-roles--delete-client-role) | - |
+| [Marking Project Deadlies](#mark-project-deadlines) | - | - | [`mark-deadline`](#mark-deadline-as-done--mark-deadline), [`unmark-deadline`](#mark-deadline-as-undone--unmark-deadline) |
+
+| [Additional Features](#additional-features) | Finding Help | Clearing data | Exiting program |
+|:--------------------------------------------------|:---------------------------------------:|:-----------------------------------------------------:|:-------------------------------------------------:|
+| [Miscellaneous Features](#miscellaneous-features) | [View Help `help`](#viewing-help--help) | [Clear entries `clear`](#clearing-all-entries--clear) | [Exit program `exit`](#exiting-the-program--exit) |
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+## **Security Features**
+
+--------------------------------------------------------------------------------------------------------------------
+### Password Protection
+Project Managers have the ability to grant themselves exclusive access by denying access by others to CodeContact with a personal and customizable password.
+#### Lock : `lock`
+
+Locks the system by hiding all the information in the tabs on the GUI. It also disables parsing of commands
+except `unlock`, `help`, and `delete`.
+
+Format: `lock`
+
+When command succeeds, CLI shows:
+
+```
+Locked all data
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Unlock : `unlock`
+
+Unlocks the system by making all the information visible and allows all commands to be parsed.
+
+Format: `unlock pw/Password123!`
+
+* Default password is `Password123!`.
+* You are highly recommended to change to a different password.
+
+When command succeeds, CLI shows:
+
+```
+Unlocked all data
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Change password : `change-password`
+
+Allows for password to be changed, given the current password and new password matches criteria.
+
+Format: `change-password pw/CURRENT_PASSWORD npw/NEW_PASSWORD`
+
+* Password must be at least 8 characters long and contain at least one digit, one lowercase letter,
+ one uppercase letter, and one special character.
+
+Example of usage: `change-password pw/Password123! npw/NewPass987!`
+
+When command succeeds, CLI shows:
+
+```
+Password changed successfully.
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+## **Management Features**
+
+--------------------------------------------------------------------------------------------------------------------
+### **Add**
+
+--------------------------------------------------------------------------------------------------------------------
+#### Add developer : `add-developer`
+
+Adds a new developer to the address book.
+
+Format: `add-developer n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [d/DATE_JOINED] r/ROLE s/SALARY [pr/PROJECT_NAME]... g/GITHUB_ID rt/RATING`
+
+* Adds the developer with the given details to the address book.
+* Not specifying any `PROJECT_NAME` will add the developer without assigning them to any projects.
+* Not specifying the `DATE_JOINED` will automatically use today's date as the date joined.
+* `NAME` cannot be the same as another existing developer's name in the address book. Checks are case-insensitive.
+* If specified, `PROJECT_NAME` should be the exact name of an existing project.
+* Note that for `RATING` values that are not in increments of 0.5 (eg. 3.2 or 3.8 instead of 3.0 or 3.5), the decimal portion
+ may not be reflected as clearly in the coloured stars.
+
+Example of usage: `add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp pr/CustomWebsite s/4500 d/11-11-2023 g/johng rt/3`
+
+* Adds a new developer `John Doe` with the respective details, who is assigned to the projects `AndroidApp` and `CustomWebsite`,
+ given that they already exist in the address book.
+
+When command succeeds, CLI shows:
+
+```
+New developer added: John Doe;
+Phone: 98765432;
+Email: johnd@example.com;
+Address: 311, Clementi Ave 2, #02-25;
+Date Joined: 11-11-2023;
+Role: Developer;
+Salary: 4500;
+Projects: CustomWebsite AndroidApp
+```
+
+:bulb:
+Entered details of a developer incorrectly? You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Add client : `add-client`
+
+Adds a new client to the address book.
+
+Format: `add-client n/NAME p/PHONE e/EMAIL a/ADDRESS r/ROLE [pr/PROJECT]... o/ORGANISATION do/DOCUMENT`
+
+* Adds the client with the given details to the address book.
+* Not specifying any `PROJECT_NAME` will add the client without assigning them to any projects.
+* `NAME` cannot be the same as another existing client's name in the address book. Checks are case-insensitive.
+* If specified, `PROJECT_NAME` should be the exact name of an existing project.
+
+Example of usage: `add-client n/Jack Doe p/98765432 e/jackd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp pr/CustomWebsite o/Google do/google.com`
+
+* Adds a new client `Jack Doe` with the respective details, who is assigned to the projects `AndroidApp` and `CustomWebsite`,
+ given that they already exist in the address book.
+
+When command succeeds, CLI shows:
+
+```
+New client added: Jack Doe;
+Phone: 98765432;
+Email: jackd@example.com;
+Address: 311, Clementi Ave 2, #02-25;
+Organisation: Google;
+Role: Developer;
+Document: google.com;
+Projects: CustomWebsite AndroidApp
+```
+
+:bulb:
+Entered details of a client incorrectly? You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Add project : `add-project`
+
+Adds a new project to the address book.
+
+Format: `add-project n/NAME dr/DESCRIPTION [dl/DEADLINE_DATE,DEADLINE_DESCRIPTION,PRIORITY,IS_DONE]...`
+
+* Adds the project with the given details to the address book.
+* Not specifying any deadline will add the project without assigning deadlines to it.
+* `NAME` cannot be the same as another existing project's name in the address book. Checks are case-insensitive.
+
+Example of usage: `add-project n/JuiceApp dr/App to allow for different juices to be ordered dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0`
+
+* Adds a new project `JuiceApp` with the respective details.
+
+When command succeeds, CLI shows:
+
+```
+New project added: JuiceApp;
+Description: App to allow for different juices to be ordered;
+Deadlines:
+1. Design backend by: 19-12-2023, priority: HIGH (undone)
+2. Design frontend by: 25-12-2023, priority: MEDIUM (undone)
+```
+
+:bulb:
+Entered details of a project incorrectly? You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+### **Delete**
+
+--------------------------------------------------------------------------------------------------------------------
+#### Delete developer : `delete-developer`
+
+Deletes developer in the address book.
+
+Format: `delete-developer INDEX`
+
+Example of usage: `delete-developer 2`
+
+* Deletes second developer in the developer list from the developer list and from the address book.
+
+When command succeeds, CLI shows:
+
+```
+Deleted Developer: Bernice Yu;
+Phone: 99272758;
+Email: berniceyu@example.com;
+Address: Blk 30 Lorong 3 Serangoon Gardens, #07-18;
+Date Joined: 16-11-2020;
+Role: Developer;
+Salary: 6000;
+Projects: Appollo Orbital
+```
+if second developer in the list was Bernice Yu.
+
+:bulb:
+Deleted a wrong developer? You can always undo the action with the [`undo`](#undo) command!
+
+
+--------------------------------------------------------------------------------------------------------------------
+#### Delete client : `delete-client`
+
+Deletes client in the address book.
+
+Format: `delete-client INDEX`
+
+Example of usage: `delete-client 3`
+
+* Deletes third client in the client list from the client list and from the address book.
+
+When command succeeds, CLI shows:
+```
+Deleted Client: George Lim;
+Phone: 76543210;
+Email: george@example.com;
+Address: Blk 789 Woodlands Ave 6, #03-03;
+Organisation: MNO Company;
+Role: Developer;
+Document: https://www.mno.com/;
+Projects: CodeContact
+```
+if second client in the list was George Lim.
+
+:bulb:
+Deleted a wrong client? You can always undo the action with the [`undo`](#undo) command!
+
+
+--------------------------------------------------------------------------------------------------------------------
+#### Delete project : `delete-project`
+
+Deletes the details of an existing project in the address book and updates developer and client project details accordingly.
+
+Format: `delete-project INDEX`
+
+Example of usage: `delete-project 2`
+
+* Deletes second project in the project list from the project list and from the address book.
+* Deletes project from developers' and clients' project lists if they were assigned to this project.
+
+When command succeeds, CLI shows:
+```
+Deleted Project: TeamTrekker;
+Description: A team collaboration tool;
+Deadlines:
+1. Phase 2 by: 13-11-2021, priority: MEDIUM (undone)
+```
+if second project in the list was TeamTrekker.
+
+:bulb:
+Deleted a wrong project? You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+### **Edit**
+
+--------------------------------------------------------------------------------------------------------------------
+#### Edit developer details : `edit-developer`
+
+Edits the details of an existing developer in the address book.
+
+Format: `edit-developer INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME]... [g/GITHUB_ID] [rt/RATING]`
+
+* Edits the developer at the specified `INDEX` in the currently displayed developer list.
+* At least one of the optional fields must be provided.
+* Existing values will be updated to the input values.
+* When editing projects, the existing assigned projects of the developer will be removed i/e. adding of projects is not
+ cumulative.
+* You can remove all the developer's projects by typing `pr/` without specifying any project name after it.
+* `NAME` cannot be the same as another existing developer's name in the address book. Checks are case-insensitive.
+* You can, however, edit the casing of an existing developer's `NAME`.
+* `PROJECT_NAME` should be the exact name of an existing project.
+* Note that for `RATING` values that not in increments of 0.5 (eg. 3.2 or 3.8 instead of 3.0 or 3.5), the decimal portion
+ may not be reflected as clearly in the coloured stars.
+
+Example of usage: `edit-developer 2 p/98989898 pr/Project2 pr/Project3`
+
+* Edits `Amy`'s phone number to `98989898` and changes the projects assigned to her to `Project2` and `Project3`.
+
+When command succeeds, CLI shows:
+
+```
+Edited Developer: Amy
+Phone: 98989898
+Email: amy@u.nus.edu
+Address: NUS UTOWN
+Date Joined: 06-09-2023
+Role: Developer
+Salary: 6999
+Projects: Project3 Project2
+```
+
+:bulb:
+You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Edit client details : `edit-client`
+
+Edits the details of an existing client in the address book.
+
+Format: `edit-client INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [pr/PROJECT_NAME]... [o/ORGANISATION]`
+
+* Edits the client at the specified `INDEX` in the currently displayed client list.
+* At least one of the optional fields must be provided.
+* Existing values will be updated to the input values.
+* When editing projects, the existing assigned projects of the client will be removed i/e. adding of projects is not
+ cumulative.
+* You can remove all the client's projects by typing `pr/` without specifying any project name after it.
+* `NAME` cannot be the same as another existing client's name in the address book. Checks are case-insensitive.
+* You can, however, edit the casing of an existing client's `NAME`.
+* `PROJECT_NAME` should be the exact name of an existing project.
+
+Example of usage: `edit-client 3 e/bob@gmail.com`
+
+* Edits `Bob`'s email to `bob@gmail.com`.
+
+When command succeeds, CLI shows:
+
+```
+Edited Client: Bob;
+Phone: 87654321;
+Email: bob@gmail.com;
+Address: Blk 123 Banana Road;
+Organisation: Google;
+Document: google.com
+Projects: ProjectA
+```
+:bulb:
+You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Edit project details : `edit-project`
+
+Edits the details of an existing project in the address book.
+
+Format: `edit-project INDEX [dr/DESCRIPTION] [dl/DEADLINE]...`
+
+* Edits the project at the specified `INDEX` in the currently displayed project list.
+* At least one of the optional fields must be provided.
+* Existing values will be updated to the input values.
+* When editing deadlines, the existing deadlines will be removed ie. adding of projects is not cumulative.
+* You can remove all the current deadlines by typing `dl/` without specifying any deadline.
+* The name of a project cannot be edited.
+
+Example of usage: `edit-project 1 dl/19-12-2023,Design backend,HIGH,0`
+
+* Deletes existing project deadlines and adds new deadline `Design backend by: 19-12-2023, priority: HIGH (undone)`.
+
+When command succeeds, CLI shows:
+
+```
+Edited Project: JuiceApp;
+Description: Juice ordering app;
+Deadlines:
+1. Design backend by: 19-12-2023, priority: HIGH (undone)
+```
+:bulb:
+You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+### **Import**
+
+--------------------------------------------------------------------------------------------------------------------
+#### Import developers' details : `import-developer`
+
+Takes in a CSV file and populates the internal list of developers if the file is formatted correctly.
+
+Format: `import-developer [FILENAME]`
+
+* Note that the CSV file has to be in the same folder as the JAR file for the command to function correctly.
+* The CSV file has to strictly follow the column header names and order for the import to function appropriately.
+* The command will abort if any of the rows have invalid data format.
+* Example of valid CSV:
+
+```
+Name, Contact Number, Email, Address, Date Joined, Role, Salary, GithubId, Rating, Projects,,
+faiz,87654321,faiz@u.com,utown,12-12-2020,Developer,3333,Faizgit,5,AndroidApp,ProjectB,
+John,123456789,john@email.com,123 Main St,01-01-2021,Developer,4000,JohnDesigns,4,AndroidApp,ProjectB,
+Sarah,987654321,sarah@email.com,456 Elm St,05-10-2019,Developer,6000,SarahManager,5,AndroidApp,ProjectB,ProjectC
+Alex,555555555,alex@email.com,789 Oak St,03-01-2022,Developer,5500,AlexDev,4,AndroidApp,ProjectB,
+Emily,111111111,emily@email.com,321 Pine St,08-10-2018,Developer,4800,EmilyAnalyst,4,AndroidApp,ProjectB,
+Michael,999999999,michael@email.com,567 Birch St,06-03-2020,Developer,7000,MichaelEngineer,5,AndroidApp,ProjectB,
+```
+
+Example of usage: `import-developer developers.csv`
+
+* Imports `developers.csv` and adds a new developer for each row of data.
+
+When command succeeds, CLI shows:
+
+```
+New developer added: faiz;
+Phone: 87654321;
+Email: faiz@u.com;
+Address: utown;
+Date Joined: 12-12-2020;
+Role: Developer;
+Salary: 3333;
+Projects: ProjectB AndroidApp
+```
+
+for each developer successfully added.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Import clients' details : `import-client`
+
+Takes in a CSV file and populates the internal list of clients if the file is formatted correctly.
+
+Format: `import-client [FILENAME]`
+
+* Note that the CSV file has to be in the same folder as the JAR file for the command to function correctly.
+* The CSV file has to strictly follow the column header names and order for the import to function appropriately.
+* The command will abort if any of the rows have invalid data format
+* Example of valid CSV:
+
+```
+Name, Contact Number, Email, Address, Role, Organisation, Document, Projects,
+Mahi,87554321,mahi@u.com,utown,HR,Google,docs.google.com/abd,AndroidApp,ProjectB
+Jane,654321876,jane@email.com,456 Oak St,HR,Acme Corp,acme.com/docs,AndroidApp
+Robert,987123456,robert@email.com,789 Elm St,HR,Tech Solutions,techdocs.com/123
+Maria,321987654,maria@email.com,123 Maple St,HR,Innovate Inc,innovate.com/docs
+Chris,876543219,chris@email.com,567 Pine St,HR,Data Insights,datainsights.com/docs
+Laura,888555555,laura@email.com,101 Birch St,HR,Software Systems,software.com/docs
+```
+
+Example of usage: `import-client clients.csv`
+
+* Imports `clients.csv` and adds a new client for each row of data.
+
+When command succeeds, CLI shows:
+
+```
+New client added: Mahi;
+Phone: 87554321;
+Email: mahi@u.com;
+Address: utown;
+Organisation: Google;
+Role: HR;
+Document: docs.google.com/abd;
+Projects: ProjectB AndroidApp
+```
+
+for each client successfully added.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+### **Find**
+
+--------------------------------------------------------------------------------------------------------------------
+#### Find developer details : `find-developer`
+
+Finds the details of an existing developer in the address book.
+
+Format: `find-developer [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME] [g/GITHUB_ID] [rt/RATING]`
+
+* Finds for developers based on the attributes provided.
+* At least one of the optional fields must be provided.
+* Existing values will be compared to the input values, and the results will include any items that match the provided
+ criteria.
+* You can combine multiple attributes for a more specific search.
+* The search is case-insensitive, so you can use any case for the search criteria.
+
+Example of usage: `find-developer pr/2103T rt/5.0`
+
+* Prints developers in 2103/T project with a 5-star rating.
+
+When command succeeds, CLI shows:
+
+```
+This is the one developer with matching information.
+```
+
+followed by the matching developer's details in the GUI.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Find client details : `find-client`
+
+Finds the details of an existing client in the address book.
+
+Format: `find-client [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [o/ORGANISATION] [pr/PROJECT] [d/DOCUMENT]`
+
+* Finds for clients based on the attributes provided.
+* At least one of the optional fields must be provided.
+* Existing values will be compared to the input values, and the results will include any items that match the provided
+ criteria.
+* You can combine multiple attributes for a more specific search.
+* The search is case-insensitive, so you can use any case for the search criteria.
+
+Example of usage: `find-client o/Google r/Senior developer`
+
+* Prints clients from Google with the Senior developer role.
+
+When command succeeds, CLI shows:
+
+```
+These are the 2 clients with matching information.
+```
+
+followed by the matching clients' details in the GUI.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Find project details : `find-project`
+
+Finds the details of an existing project in the address book.
+
+Format: `find-project [pr/PROJECT_NAME] [dr/DESCRIPTION] [dl/DEADLINE]`
+
+* Finds for projects based on the attributes provided.
+* At least one of the optional fields must be provided.
+* Existing values will be compared to the input values, and the results will include any items that match the provided
+ criteria.
+* You can combine multiple attributes for a more specific search.
+* The search is case-insensitive, so you can use any case for the search criteria.
+
+Example of usage: `find-project pr/JuiceApp`
+
+* Print projects with the name JuiceApp.
+
+When command succeeds, CLI shows:
+
+```
+This is the one project with matching information.
+```
+followed by the matching project's details in the GUI.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Find deadlines : `find-deadline`
+
+Finds deadlines in project tab based on date and/or priority.
+
+Format: `find-deadline [d/DATE] [pri/PRIORITY]`
+
+* When finding deadlines based on `DATE`, the project tab displays deadlines due before or on the specified date.
+* When finding deadlines based on `PRIORITY`, only that priority (`HIGH`,`MEDIUM`, `LOW`) deadlines are shown.
+
+Example of usage: `find-deadline d/20-11-2023 pri/MEDIUM`
+
+* Shows deadlines due before or on `20-11-2023` and with `MEDIUM` priority.
+
+When command succeeds, CLI shows:
+
+```
+These are the 3 projects with matching information.
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+### **List**
+
+--------------------------------------------------------------------------------------------------------------------
+#### List information : `list`
+
+Shows a list of all developers in the address book.
+
+Format: `list-TYPE`
+
+* Lists the specific type of thing you are asking.
+
+Example of usage:`list-developer`
+
+* Lists all the developers.
+
+Acceptable parameters:
+
+* `developer` to list the developers
+* `client` to list the clients
+* `project` to list the projects
+
+When command succeeds, CLI shows:
+
+```
+Listed all developers
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+
+### **Add roles**
+
+--------------------------------------------------------------------------------------------------------------------
+#### Add developer roles : `add-developer-role`
+
+Adds new developer roles into the system.
+
+Format: `add-developer-role ROLE_NAME`
+
+* Adds the ROLE_NAME to list of developer roles.
+* There are 3 preset roles in the list of roles: `Frontend Developer`,`Backend Developer`,`Developer`.
+* You will not be able to add a developer to a role that does not exist in this list of developer roles.
+
+:exclamation: **Note** :This command is **not** case-sensitive, even if `Developer` is a role, `developer` can still be added.
+
+
+:bulb:
+If you wish to check what roles are there, you can key in `delete-developer-role `, `` should not be an existing role.
+
+
+Example of usage: `add-developer-role Tester`
+
+* Adds the Tester role to list of developer roles.
+* You can now add developers with Tester as their roles.
+
+When command succeeds, CLI shows:
+
+```
+New role for developer added: Tester
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Add client roles : `add-client-role`
+
+Adds new client roles into the system.
+
+Format: `add-client-role ROLE_NAME`
+
+* Adds the ROLE_NAME to list of client roles.
+* There are 4 preset roles in the list of roles: `HR`,`Manager`,`Developer`,`Client`.
+* You will not be able to add a client to a role that does not exist in this list of client roles.
+
+:exclamation: **Note** :This command is **not** case-sensitive, even if `HR` is a role, `hr` can still be added.
+
+
+:bulb:
+If you wish to check what roles are there, you can key in `delete-client-role `, `` should not be an existing role.
+
+
+Example of usage: `add-client-role Boss`
+
+* Adds the Boss role to list of developer roles.
+* You can now add clients with Boss as their roles.
+
+When command succeeds, CLI shows:
+
+```
+New role for client added: Boss
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+### **Delete roles**
+
+--------------------------------------------------------------------------------------------------------------------
+#### Delete developer roles : `delete-developer-role`
+
+Delete developer roles from the system.
+
+Format: `delete-developer-role ROLE_NAME`
+
+* Deletes the ROLE_NAME to list of developer roles.
+* There are 3 preset roles in the list of roles: `Frontend Developer`,`Backend Developer`,`Developer`. These roles
+ cannot be deleted.
+* You will not be able to delete a developer role if there are developers in the list with that role.
+
+Example of usage: `delete-developer-role UI Manager`
+
+* Deletes the UI Manager from the list of developer roles.
+* You can no longer add developers with UIDesigner as their roles.
+
+When command succeeds, CLI shows:
+
+```
+Role for developers deleted: UIDesigner
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Delete client roles : `delete-client-role`
+
+Delete client roles from the system.
+
+Format: `delete-client-role ROLE_NAME`
+
+* Deletes the ROLE_NAME to list of developer roles.
+* There are 4 preset roles in the list of roles: `HR`,`Manager`,`Developer`,`Client`. These roles cannot be deleted.
+* You will not be able to delete a client role if there are clients in the list with that role.
+
+Example of usage: `delete-client-role Boss`
+
+* Deletes the Boss from the list of developer roles.
+* You can no longer add clients with Boss as their roles.
+
+When command succeeds, CLI shows:
+
+```
+Role for clients deleted: Boss
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+
+### **Mark**
+
+--------------------------------------------------------------------------------------------------------------------
+#### Mark project deadline as done : `mark-deadline`
+
+Marks the indicated deadline for the project as done.
+
+Format: `mark-deadline PROJECT_INDEX DEADLINE_INDEX`
+
+* `PROJECT_INDEX` and `DEADLINE_INDEX` must be valid indexes of existing projects and deadlines.
+
+Example of usage: `mark-deadline 2 1`
+
+* Marks the 1st deadline of the 2nd project in the currently displayed project list as done.
+
+When command succeeds, CLI shows:
+
+```
+The deadline has been marked as completed!
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Mark project deadline as undone : `unmark-deadline`
+
+Marks the indicated deadline for the project as undone.
+
+Format: `unmark-deadline PROJECT_INDEX DEADLINE_INDEX`
+
+* `PROJECT_INDEX` and `DEADLINE_INDEX` must be valid indexes of existing projects and deadlines.
+
+Example of usage: `unmark-deadline 2 1`
+
+* Marks the 1st deadline of the 2nd project in the currently displayed project list as undone.
+
+When command succeeds, CLI shows:
+
+```
+The deadline has been marked as undone!
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+### **Undo**
+--------------------------------------------------------------------------------------------------------------------
+
+#### Undo : `undo`
+
+Undo the previous command you entered.
+
+Format: `undo`
+
+* Each time you type undo, you move back one stage.
+* If you made 5 changes, and you wish to undo, you can enter the command `undo` 5 times. The system will remind you when
+ you cannot undo anymore.
+* `undo` works for all `edit`, `add-TYPE` and `delete` commands.
+
+Example of usage: `undo`
+
+* You just deleted a new developer, and you wish to `undo`.
+
+When command succeeds, CLI shows:
+
+```
+Undo successful! The change below has been undone:
+Deleted Developer: Amy;
+Phone: 83566674;
+Email: amy@example.com;
+Address: 42, Clementi Ave 7, #02-2;
+Date Joined: 23-11-2023;
+Role: Frontend Developer;
+Salary: 5000;
+Projects: CustomWebsite AndroidApp
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Redo : `redo`
+
+Redo the previous command you undid.
+
+Format: `redo`
+
+* Each time you type redo, you move forward one stage.
+* You can only `redo` if you have `undo` before.
+* If you undid 5 changes, and you wish to redo, you can enter the command `redo` 5 times. The system will remind you when
+ you cannot redo anymore.
+* `redo` works for all `edit`, `add-TYPE` and `delete` commands.
+
+Example of usage:
+
+* You just `undo` delete developer, and you wish to `redo` to add it back.
+ When command succeeds, CLI shows:
+
+```
+Redo successful! The change below has been redone:
+Deleted Developer: Amy;
+Phone: 83566674;
+Email: amy@example.com;
+Address: 42, Clementi Ave 7, #02-2;
+Date Joined: 23-11-2023;
+Role: Frontend Developer;
+Salary: 5000;
+Projects: CustomWebsite AndroidApp
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+## **Additional Features**
+
+--------------------------------------------------------------------------------------------------------------------
+### **Miscellaneous Features**
+Listed below are some miscellaneous features that are available in CodeContact to improve your user experience.
+
+--------------------------------------------------------------------------------------------------------------------
+#### Viewing help : `help`
+
+Shows a message explaining how to access the help page.
+
+Format: `help`
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Clearing all entries : `clear`
+
+Clears all entries from the address book.
+
+Format: `clear`
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Exiting the program : `exit`
+
+Exits the program.
+
+Format: `exit`
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+### Feedback System `[coming in v2.0]`
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+# **FAQ**
+
+--------------------------------------------------------------------------------------------------------------------
+
+**Q**: How do I transfer my data to another Computer?+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains +the data of your previous CodeContact home folder. + +-------------------------------------------------------------------------------------------------------------------- + +**Q**: How can I launch CodeContact if the clicking on the JAR file does not work?
+**A**: There are two possible methods to launch CodeContact. +
+ +* Method 1: For users familiar with the command prompt + +1. Open the command prompt. +2. Navigate to the directory where the JAR file is located using cd [JAR file location]. +3. Type `java -jar CodeContact.jar` and press enter. +4. CodeContact should launch. +
+ +* Method 2: For users that wish to create a script to launch CodeContact (Recommended) + +1. Create a new text file. +2. Type the following into the text file: + `java -jar [JAR file location]/CodeContact.jar`. +3. Save the text file as CodeContact.bat (Windows) or CodeContact.sh (MacOS/Linux). +4. Change the admin settings of the script to allow it to run as a program: + * Windows: Right-click on the script and select Properties. Under General , check + the box that says Allow this file to run as a program. + * MacOS/Linux: Open the terminal and navigate to the directory where the script is + located. Type `chmod +x [script name]` and press enter (`chmod +x` changes + permissions of the script to allow it to be executed). +5. Double-click on the script to launch CodeContact. +6. CodeContact should launch. + +-------------------------------------------------------------------------------------------------------------------- + +**Q**: How can I check my java version?
+**A**: Open a command prompt and type `java -version`. If you do not have Java installed, you +can download it [here](https://www.oracle.com/java/technologies/downloads/#java11). + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +# **Known issues** + +1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only + the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the + application before running the application again. +2. **When tampering with the storage files**, if you tamper with the storage files leading to incorrect format, the application will not be able to + read the data and will throw an error. The remedy is to delete the `addressbook.json` file created by the application before + running the application again. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +# **Command summary** + +| Action | Format, Examples | +|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **lock** | `lock` | +| **unlock** | Format:
`unlock pw/PASSWORD`
Example:
`unlock pw/Password123!` | +| **change password** | Format:
`change-password pw/CURRENT_PASSWORD npw/NEW_PASSWORD`
Example:
`change-password pw/Password123! npw/Password123!` | +| **add developers** | Format:
`add-developer n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [d/DATE_JOINED] r/ROLE s/SALARY [pr/PROJECT_NAME]... g/GITHUB_ID rt/RATING`
Example:
`add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp pr/CustomWebsite s/4500 d/11-11-2023 g/johng rt/3`
| +| **add clients** | Format:
`add-client n/NAME p/PHONE e/EMAIL a/ADDRESS r/ROLE [pr/PROJECT]... o/ORGANISATION do/DOCUMENT`
Example:
`add-client n/Jack Doe p/98765432 e/jackd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp pr/CustomWebsite o/Google do/google.com`
| +| **add projects** | Format:
`add-project n/NAME dr/DESCRIPTION [dl/DEADLINE_DATE,DEADLINE_DESCRIPTION,PRIORITY,IS_DONE]...`
Example:
`add-project n/JuiceApp dr/App to allow for different juices to be ordered dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0`
| +| **edit developers** | Format:
`edit-developer INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME]... [g/GITHUB_ID] [rt/RATING]`
Example:
`edit-developer 2 p/98989898 pr/Project2 pr/Project3`
| +| **edit clients** | Format:
`edit-client INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME]... [g/GITHUB_ID] [rt/RATING]`
Example:
`edit-client 3 p/bob@gmail.com`
| +| **edit projects** | Format:
`edit-project INDEX [dr/DESCRIPTION] [dl/DEADLINE]...`
Example:
`edit-project 1 dl/Finish Feature-A by: 09-09-2023`
| +| **find developers** | Format:
`find-developer pr/
Example:
`find-developer pr/2103/T`
| +| **find clients** | Format:
`find-client n/
Example:
`find-client n/Amy`
| +| **find projects** | Format:
`find-project dr/description`
Example:
`find-project dr/school semester project`
| +| **find deadlines** | Format:
`find-deadline [d/DATE] [pri/PRIORITY]`
Example:
`find-deadline d/20-11-2023 pri/MEDIUM`
| +| **delete developer** | Format:
`delete-developer INDEX`
Example:
`delete-developer 1`
| +| **delete client** | Format:
`delete-client INDEX`
Example:
`delete-client 1`
| +| **delete project** | Format:
`delete-project INDEX`
Example:
`delete-project 1`
| +| **import developer** | Format:
`import-developer [FILENAME]`
Example:
`import-developer developers.csv`
| +| **import client** | Format:
`import-client [FILENAME]`
Example:
`import-client clients.csv`
| +| **add developer role** | Format:
`add-developer-role ROLE_NAME`
Example:
`add-developer-role UIDesigner`
| +| **add client role** | Format:
`add-client-role ROLE_NAME`
Example:
`add-client-role Boss`
| +| **delete developer role** | Format:
`delete-developer-role ROLE_NAME`
Example:
`delete-developer-role UIDesigner`
| +| **delete client role** | Format:
`delete-client-role ROLE_NAME`
Example:
`delete-client-role Boss`
| +| **list** | Format:
`list-developer`
`list-project`
`list-client` | +| **mark deadline** | Format:
`mark-deadline PROJECT_INDEX DEADLINE_INDEX`
Example:
`mark-deadline 2 1`
| +| **unmark deadline** | Format:
`unmark-deadline PROJECT_INDEX DEADLINE_INDEX`
Example:
`unmark-deadline 2 1`
| +| **undo** | `undo` | +| **redo** | `redo` | +| **clear** | `clear` | +| **exit** | `exit` | +| **help** | `help` | + +[Scroll back to Table of Contents](#table-of-contents) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 1c9514e966a..61ce4a3a287 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -2,58 +2,53 @@ layout: page title: About Us --- - We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg). -You can reach us at the email `seer[at]comp.nus.edu.sg` - -## Project team +You can reach us at the email `mahidharah@gmail.com` -### John Doe +## Project team T09-02 -
+### C Mahidharah Rajendran
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+
-* Role: Project Advisor
+[[portfolio](team/mahidharah.md)]
+[[github](https://github.com/Mahidharah)]
+[[Linkedin](https://www.linkedin.com/in/mahidharah/)]
-### Jane Doe
+* Role: Developer
-
+### Elizabeth Mao Zhi Min
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+
-* Role: Team Lead
-* Responsibilities: UI
+[[github](http://github.com/emzm2023)]
+[[portfolio](team/emzm2023.md)]
-### Johnny Doe
+### Wan Mingyu
-
+
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/mingyu-wan)]
+[[portfolio](team/mingyu-wan.md)]
* Role: Developer
-* Responsibilities: Data
-### Jean Doe
+### Mathan Chidambaranathan
-
+
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ncmathan)]
+[[portfolio](team/ncmathan.md)]
* Role: Developer
-* Responsibilities: Dev Ops + Threading
-### James Doe
+### Mohammed Waseem Malik
-
+
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/waseemingly)] [[portfolio](team/waseemingly.md)]
* Role: Developer
-* Responsibilities: UI
+* Responsibilities: Deliverables and deadlines
+
diff --git a/docs/Configuration.md b/docs/Configuration.md
index 13cf0faea16..fe118c75b24 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -3,4 +3,5 @@ layout: page
title: Configuration guide
---
-Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).
+Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the
+configuration file (default: `config.json`).
diff --git a/docs/DevOps.md b/docs/DevOps.md
index d2fd91a6001..a51254c2264 100644
--- a/docs/DevOps.md
+++ b/docs/DevOps.md
@@ -4,22 +4,22 @@ title: DevOps guide
---
* Table of Contents
-{:toc}
+ {:toc}
--------------------------------------------------------------------------------------------------------------------
## Build automation
-This project uses Gradle for **build automation and dependency management**. **You are recommended to read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.
-
+This project uses Gradle for **build automation and dependency management**. **You are recommended to
+read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.
Given below are how to use Gradle for some important project tasks.
-
* **`clean`**: Deletes the files created during the previous build tasks (e.g. files in the `build` folder).e.g. `./gradlew clean` -* **`shadowJar`**: Uses the ShadowJar plugin to creat a fat JAR file in the `build/lib` folder, *if the current file is outdated*.
+* **`shadowJar`**: Uses the ShadowJar plugin to creat a fat JAR file in the `build/lib` folder, *if the current file is + outdated*.
e.g. `./gradlew shadowJar`. * **`run`**: Builds and runs the application.
@@ -29,28 +29,39 @@ Given below are how to use Gradle for some important project tasks. **`checkstyleTest`**: Runs the code style check for the test code base. * **`test`**: Runs all tests. - * `./gradlew test` — Runs all tests - * `./gradlew clean test` — Cleans the project and runs tests + * `./gradlew test`— Runs all tests + * `./gradlew clean test`— Cleans the project and runs tests -------------------------------------------------------------------------------------------------------------------- ## Continuous integration (CI) -This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the `.github/workflows` folder). No further setting up required. +This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in +the `.github/workflows` folder). No further setting up required. ### Code coverage -As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your tests. +As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage +data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info +about the coverage of your tests. -However, because Codecov is known to run into intermittent problems (e.g., report upload fails) due to issues on the Codecov service side, the CI is configured to pass even if the Codecov task failed. Therefore, developers are advised to check the code coverage levels periodically and take corrective actions if the coverage level falls below desired levels. +However, because Codecov is known to run into intermittent problems (e.g., report upload fails) due to issues on the +Codecov service side, the CI is configured to pass even if the Codecov task failed. Therefore, developers are advised to +check the code coverage levels periodically and take corrective actions if the coverage level falls below desired +levels. -To enable Codecov for forks of this project, follow the steps given in [this se-edu guide](https://se-education.org/guides/tutorials/codecov.html). +To enable Codecov for forks of this project, follow the steps given +in [this se-edu guide](https://se-education.org/guides/tutorials/codecov.html). ### Repository-wide checks -In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements. +In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover +files used in the build process, these repository-wide checks cover all files in the repository. They check for +repository rules which are hard to enforce on development machines such as line ending requirements. -These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory: +These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such +as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root +directory: `./config/travis/run-checks.sh` @@ -58,12 +69,14 @@ Any warnings or errors will be printed out to the console. **If adding new checks:** -* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest. +* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will + automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do + the rest. * Check scripts should print out errors in the format `SEVERITY:FILENAME:LINE: MESSAGE` - * SEVERITY is either ERROR or WARN. - * FILENAME is the path to the file relative to the current directory. - * LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error. + * SEVERITY is either ERROR or WARN. + * FILENAME is the path to the file relative to the current directory. + * LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error. * Check scripts must exit with a non-zero exit code if any errors occur. @@ -73,7 +86,9 @@ Any warnings or errors will be printed out to the console. Here are the steps to create a new release. -1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). +1. Update the version number + in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`). 1. Tag the repo with the version number. e.g. `v0.1` -1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created. +1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you + created. diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 8a861859bfd..d783dea34cb 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -2,22 +2,56 @@ layout: page title: Developer Guide --- -* Table of Contents -{:toc} +## Table of Contents +* [Acknowledgements](#acknowledgements) +* [Setting up and getting started](#setting-up-and-getting-started) +* [Design](#design) + * [Architecture](#architecture) + * [UI Component](#ui-component) + * [Logic Component](#logic-component) + * [Model Component](#model-component) + * [Storage component](#storage-component) + * [Common Classes](#common-classes) +* [Implementation](#implementation) + * [Add Features (`add-developer`, `add-client`, `add-project`)](#add-features-add-developer-add-client-add-project) + * [Delete Features (`delete-developer`, `delete-client`)](#delete-features-delete-developer-delete-client) + * [Import Features (`import-developer`, `import-client`)](#import-feature-import-developer-import-client) + * [Find Features (`find-developer`, `find-client`, `find-project`)](#find-feature-find-developer-find-client-find-project) + * [Edit Features (`edit-developer`, `edit-client`, `edit-project`)](#edit-feature-edit-developer-edit-client-edit-project) + * [List Features (`list-developer`, `list-client`, `list-project`)](#list-feature-list-developer-list-client-list-project) + * [Undo/redo Features (`undo`, `redo`)](#undoredo-feature-undo-redo) + * [Add-role Feature (`add-developer-role`, `add-client-role`)](#add-role-feature-add-developer-role-add-client-role) + * [Delete-role Feature (`delete-developer-role`, `delete-client-role`)](#delete-role-feature-delete-developer-role-delete-client-role) + * [GUI Feature](#gui-feature) +* [Documentation, logging, testing, configuration, dev-ops](#documentation-logging-testing-configuration-dev-ops) +* [Appendix: Requirements](#appendix-requirements) + * [Product Scope](#project-scope) + * [User Stories](#user-stories) + * [Use Cases](#use-cases) + * [Non Functional Requirements](#non-functional-requirements) + * [Glossary](#glossary) +* [Appendix: Manual Testing](#appendix-manual-testing) +* [Appendix: Planned Enhancements](#appendix-planned-enhancements) +* [Appendix: Effort](#appendix-effort) -------------------------------------------------------------------------------------------------------------------- ## **Acknowledgements** +* Adapted from [AB3](https://se-education.org/addressbook-level3/) +* This project uses Ratings Bar from [ControlsFX](https://controlsfx.github.io/) -* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} +[Scroll back to Table of Contents](#table-of-contents) -------------------------------------------------------------------------------------------------------------------- -## **Setting up, getting started** +## **Setting up and getting started** -Refer to the guide [_Setting up and getting started_](SettingUp.md). +* Refer to the guide [Setting up and getting started](https://ay2324s1-cs2103t-t09-2.github.io/tp/SettingUp.html). + +[Scroll back to Table of Contents](#table-of-contents) -------------------------------------------------------------------------------------------------------------------- + ## **Design** @@ -27,38 +61,35 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md). ### Architecture -
-The ***Architecture Diagram*** given above explains the high-level design of the App.
+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.
+Given below is a quick overview of main components and how they interact with ea
**Main components of the architecture**
**`Main`** (consisting of classes [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java)) 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`**](#ui-component): The UI of the App.
-* [**`Logic`**](#logic-component): The command executor.
-* [**`Model`**](#model-component): Holds the data of the App in memory.
-* [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk.
+* The bulk of the app's work is done by the following four components:
+ * [**`UI`**](#ui-component): The UI of the App.
+ * [**`Logic`**](#logic-component): The command executor.
+ * [**`Model`**](#model-component): Holds the data of the App in memory.
+ * [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk.
[**`Commons`**](#common-classes) 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`.
+The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user issues the command `delete-developer 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.
+* 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.
@@ -66,22 +97,42 @@ For example, the `Logic` component defines its API in the `Logic.java` interface
The sections below give more details of each component.
+[Scroll back to Table of Contents](#table-of-contents)
### UI component
The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/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 consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `DeveloperListPanel`, `ClientListPanel`, `ProjectListPanel`, `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`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml)
The `UI` component,
+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 `Developer`, `Client`, `Project` objects residing in the Model.
+
+#### Main Window
-* 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`.
+The MainWindow houses all the components that make up the visual display of CodeContact. Its primary function is to listen to user input through the CommandBox, initiate the execution of the command, and display the result through the ResultDisplay and/or tabPane.
+The tabPane houses the DeveloperListPanel, ClientListPanel and ProjectListPanel, which are responsible for displaying the list of developers, clients and projects respectively. The MainWindow also houses the StatusBarFooter, which displays the current status of the application.
+
+Here is a table containing a brief description of the purpose of the smaller components within MainWindow
+
+| Component | Description |
+|-----------|-------------|
+| `CommandBox` | The CommandBox is where the user enters commands to be executed. |
+| `ResultDisplay` | The ResultDisplay displays the result of the command execution. |
+| `DeveloperListPanel`| The DeveloperListPanel displays the list of developers. |
+| `ClientListPanel` | The ClientListPanel displays the list of clients. |
+| `ProjectListPanel` | The ProjectListPanel displays the list of projects. |
+| `StatusBarFooter` | The StatusBarFooter displays the current status of the application. |
+| `HelpWindow` | Displays a help window containing a link to the User Guide. |
+
+[Scroll back to Table of Contents](#table-of-contents)
### Logic component
@@ -91,47 +142,50 @@ 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.
+The sequence diagram below illustrates the interactions within the `Logic` component, taking `execute("delete-client 1")` API call as an example.
-
+
:information_source: **Note:** The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
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.
-1. This results in a `Command` object (more precisely, an object of one of its subclasses e.g., `DeleteCommand`) which is executed by the `LogicManager`.
-1. The command can communicate with the `Model` when it is executed (e.g. to delete a person).
-1. The result of the command execution is encapsulated as a `CommandResult` object which is returned back from `Logic`.
+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., `DeleteDeveloperCommandParser`) 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., `DeleteDeveloperCommand`) which is executed by the `LogicManager`.
+3. The command can communicate with the `Model` when it is executed (e.g. to delete a developer).
+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.
+* 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., `AddProjectCommand`) which the `AddressBookParser` returns back as a `Command` object.
+* All `XYZCommandParser` classes (e.g., `AddDeveloperCommandParser`, `DeleteClientCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing.
+
+
### Model component
**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/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:information_source: **Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.
- +
+**Alternative 1:** +- Use a long chain of `if-else` conditions for each attribute. + - **Pros:** Explicit parsing logic for each attribute. + - **Cons:** Code becomes lengthy and hard to maintain. Adding a new attribute involves modifying the parsing logic, increasing the risk of errors. + +**Alternative 2 (current choice):** +- Use a map linking prefixes to their corresponding predicate constructors. + - **Pros:** Simplifies the parsing process. Adding a new attribute to search becomes as simple as adding a new entry in the map. + - **Cons:** A potential mismatch between the prefix and its predicate can lead to wrong results. + +Given the benefits of a more maintainable and scalable codebase, we've decided to go with the first alternative. Future enhancements might include fuzzy search. + + +[Scroll back to Table of Contents](#table-of-contents) + +### List Feature (`list-developer`, `list-client`, `list-project`) + +#### Implementation +The list command employs a structured approach where specific commands, such as `list-developer` or `list-client` +are associated with corresponding functionalities. This allows users to efficiently retrieve +information about developers, clients or projects by specifying the relevant prefix, streamlining the process of +generating targeted lists based on user input. + +Implemented operations include: +* `` here refers to developer, client or project
+* `AddressBookParser`: Interprets the user's input and calls the appropriate `ListCommand#execute()` to print the
+ relevant lists of data
+* `Model#updateFilteredList`: Update the list displayed in the UI to print all the existing developers
+ ,clients or projects.
+
+Given below is an example usage scenario and how the `list` mechanism behaves at each step:
+
+**Step 1.** The user used the `find` feature to search for something and the UI is only displaying some
+developers
+
+**Step 2.** To list all the developers, the user executes the command `list-developer`. `AddressBookParser`
+recognizes the `list-developer` command and calls the `ListDeveloperCommand`.
+
+**Step 3.** Next, the `ListDeveloperCommand#execute()` method that overides the abstract method `Command#execute()` gets
+activated.This `execute()` method calls the `Model#updateFilteredDeveloperList`, passing in the `Predicate`
+that has been set to true.
+
+**Step 4.** `Model#updateFilteredDeveloperList` then updates the list in the UI to print all the existing developers.
+
+The following sequence diagram provides an overview of how the find operation is executed
+
+
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+### Undo/redo Feature (`undo`, `redo`)
+
+#### Implementation - undo
+
+The proposed undo/redo mechanism is facilitated by `VersionedAddressBook`. It extends `AddressBook` with an undo/redo
+history, stored internally as an `addressBookStateList` and `currentStatePointer`. Customised to the functions of CodeContact to
+have a more helpful message and automatic tab switch, the history for messages and tabs are also stored internally as
+`successfulCommandMessages` and `tabIndex`.
+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.
@@ -166,212 +498,1108 @@ The proposed undo/redo mechanism is facilitated by `VersionedAddressBook`. It ex
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.
+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 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 2.** The user executes `delete-developer 5` command to delete the 5th developer in the address book. The `delete`
+command calls `Model#commitAddressBook()`, causing the modified state of the address book after the `delete-developer 5`
+command executes to be saved in the `addressBookStateList`. The successful command message and tab it switched to
+also saved into `successfulCommandMessages` and `tabIndex` respectively. The `currentStatePointer` is then 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 3.** The user executes `add-developer n/David …` to add a new developer. The `add` command also calls
+`Model#commitAddressBook()`, causing another modified address book state to be saved into the `addressBookStateList`,
+and another successful command message and tab switched saved into `successfulCommandMessages` and `tabIndex`.
-#### Design considerations:
+[Scroll back to Table of Contents](#table-of-contents)
-**Aspect: How undo & redo executes:**
+### Add-role Feature (`add-developer-role`, `add-client-role`)
-* **Alternative 1 (current choice):** Saves the entire address book.
+#### Implementation
+The add role command employs a structured approach where specific commands, such as `add-developer-role` or
+`add-client-role`are associated with corresponding functionalities. This allows users to efficiently add
+information about developers and clients. One of the validation checks when adding a developer or client is that this role
+added must exist. This is where users will need this command to add in the respective roles. This feature is facilitated
+with the `DeveloperRoles` and `ClientRoles` class which implements the following operations:
+
+* `DeveloperRoles#addDeveloperRole()` — Adds a developer role into the list of roles stored
+* `DeveloperRoles#saveDeveloperRoles()` — Saves the updated list of developer roles
+* `DeveloperRoles#loadDeveloperRoles()` — Loads the existing list of developer roles from file
+* `DeveloperRoles#isValidRole()` — Checks if this role being added exists already
+
+The classes are similar for `ClientRoles` but just that they are associated with the clients.
+
+Given below is an example usage scenario and how the `add-developer-role` mechanism behaves at each step:
+
+**Step 1.** The user launches the application. The list roles for developers and clients are loaded into a list or roles.
+
+**Step 2.** The user executes the command `add-developer-role Tester`. The application recognizes the `add-developer-role`
+and calls `AddDeveloperRoleCommandParser#parse()`.
+
+**Step 3.** The parser checks if the argument is an empty blank space and trims the input given, in this case ` Tester` is
+trimmed to `Tester` and calls `AddDeveloperRoleCommand`.
+
+**Step 4.** `AddDeveloperRoleCommand#execute()` checks if there is an existing role with the same name and creates
+a new developer role if there is no such role.
+
+
+
+
+
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+### Mark/unmark deadline Feature (`mark-deadline`, `unmark-deadline`)
+#### Implementation
+The mark and unmark deadline features are implemented using a secondary call to the `edit-project` command. As with
+the other commands, `mark-deadline` and `unmark-deadline` commands are first parsed to return `MarkDeadlineCommandParser`
+and `UnmarkDeadlineCommandParser` respectively. The parses similarly implement the `MarkDeadlineCommandParser#parse()`
+and `UnmarkDeadlineCommandParser#parse()` methods which return `MarkDeadlineCommand` and `UnmarkDeadlineCommand` objects
+respectively. However, in the execution of `MarkDeadlineCommand` and `UnmarkDeadlineCommand`, a new
+`EditProjectCommand` is created and subsequently executed, to get the `CommandResult`.
+
+Consequently, calling `mark-deadline` and `unmark-deadline` on a deadline of project is synonymous to editing the
+project to update the `isDone` status of the deadline.
+
+This is facilitated by the following methods:
+* `MarkDeadlineCommand#editProjectArgs()` — Formats each deadline in a list of String representations into a
+ String that will be used as the arguments parsed by an EditProjectCommandParser.
+* `Project#markDeadlineStringRep()` — Returns a list with each element being the String representation of the
+ respective deadline, with the deadline at the given index marked as done.
+* `Project#unmarkDeadlineStringRep()` — Returns a list with each element being the String representation of the
+ respective deadline, with the deadline at the given index marked as undone.
+
+Relevant checks are conducted at the `MarkDeadlineCommand#execute()` and `UnmarkDeadlineCommand#execute()` stages to
+ensure the index of the project and the edited deadline passed to the `EditProjectCommandParser` as arguments for the
+`EditProjectCommandParser#parse()` as arguments are valid.
+
+The following sequence diagram illustrates the interactions taking place in the `Logic` component when the command
+`mark-deadline 2 1` is called. The sequence reflects a successful command execution, assuming that the current state of
+the displayed project list has a project with the index `2` with at least `1` deadline.
+
+
+
+#### Design considerations
+**Aspect: Execution of command**
+* **Alternative 1**: Implement methods in `ModelManager` class that can directly change the `isDone` status of the deadlines
+ of a project based on the given project index and deadline index.
+ * Pros:
+ * More aligned with OOP principles.
+ * Mirrors sequence flow of other commands and can be implemented using current code architecture.
+ * Cons:
+ * Due to container structure of `Project` and `Deadline`, changing the status of deadlines needs to be done
+ through projects, so more methods need to be added to achieve this.
+ * Given the GUI display of project deadlines in a Javafx TableView, makes it more complicated for changes in
+ deadline status to be automatically reflected in the list of projects and deadlines displayed to the user.
+* **Alternative 2 (current choice)**: Implement execution by creating an `EditProjectCommandParser` and `EditProjectCommand`
+ that will replace the existing project entirely with a new one with the updated deadline being marked/unmarked.
+ * Pros:
+ * Fewer methods to implement, allows for more reuse.
+ * Editing the project with new deadlines will ensure that upon execution of the command, the updated project with
+ marked/unmarked deadline is displayed to the user on the app.
+ * Cons:
+ * Slightly more disorganised interactions within `Logic` component since have to go from parsing a command to
+ executing it, then parsing another command again and executing that command.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+### GUI Feature
+
+#### Switching tabs automatically
+
+When certain commands are executed, the UI will automatically switch to the relevant tab. For example, when the user
+executes `list-developer`, the UI will automatically switch to the `Developer` tab. This is implemented by specifying
+the `TabIndex` in the `CommandResult` returned in the `execute()` method of the relevant command.
+
+#### Clicking to switch tabs
+
+When the user clicks on a different tab, the `list` command will be executed to display the relevant list of information
+for the tab clicked. This is implemented by adding a listener to the `TabPane` in the `MainWindow` class. When the
+selected tab changes, the `list` command will be executed.
+
+
Steps 2a1-2a2 are repeated until the correct password is entered. +
Use case resumes from step 3. - Use case ends. +[Scroll back to Table of Contents](#table-of-contents) -* 3a. The given index is invalid. +#### **Use case:** UC2 - Change Password - * 3a1. AddressBook shows an error message. +**Preconditions:** +1. User is logged in - Use case resumes at step 2. +**Guarantees:** +1. The system password will be changed. -*{More to be added}* +**MSS** -### Non-Functional Requirements +1. User requests to change password with current password and new password as inputs. +2. System validates if user's new password fulfils the password criteria are correct. +3. System changes user's password. -1. Should work on any _mainstream OS_ as long as it has Java `11` or above 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. +Use case ends. -*{More to be added}* +**Extensions** -### Glossary +* 2a. The new password entered is blank or does not follow the format. + * 2a1. System informs user password entered does not follow the format. + * 2a2. User enters new password. +
Steps 2a1-2a2 are repeated until the correct password is entered. +
Use case resumes from step 3. +* 2b. The current password entered is incorrect. + * 2b1. System informs current password entered is incorrect. + * 2b2. User enters new password. +
Steps 2b1-2b2 are repeated until the correct password is entered. +
Use case resumes from step 3. +* 2c. The current password is same as new password. + * 2c1. System informs current password is same as new password. + * 2c2. User enters new password. +
Steps 2c1-2c2 are repeated until the new password is different. +
Use case resumes from step 3. -* **Mainstream OS**: Windows, Linux, Unix, OS-X -* **Private contact detail**: A contact detail that is not meant to be shared with others +[Scroll back to Table of Contents](#table-of-contents) --------------------------------------------------------------------------------------------------------------------- +#### **Use case:** UC3 - Add a developer -## **Appendix: Instructions for manual testing** +
Steps 4a1-4a2 are repeated until the data entered are correct. +
Use case resumes from step 5. + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC4 - Delete a developer +
Steps 4a1-4a2 are repeated until the data entered are correct. +
Use case resumes from step 5. + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC5 - Edit a developer +
Steps 4a1-4a2 are repeated until the data entered are correct. +
Use case resumes from step 5. -1. Saving window preferences +* 4b. The details entered are the same as the existing details. + * 4a1. System informs users the details the same. + * 4a2. User enters new details. +
Steps 4b1-4b2 are repeated until the data entered are correct. +
Use case resumes from step 5. - 1. Resize the window to an optimum size. Move the window to a different location. Close the window. +* 4c. The details violate certain validation check and is not allowed to change to these details. + * 4a1. System informs users why the details cannot be changed. + * 4a2. User enters new details. +
Steps 4c1-4c2 are repeated until the data entered are correct. +
Use case resumes from step 5. - 1. Re-launch the app by double-clicking the jar file.
- Expected: The most recent window size and location is retained. +[Scroll back to Table of Contents](#table-of-contents) -1. _{ more test cases … }_ +#### **Use case:** UC6 - Find a developer +
Steps 3a1-3a2 are repeated until the data entered are correct. +
Use case resumes from step 4. + +* 3b. The details entered are incorrect (eg. entering alphabets when finding by phone). + * Use case just continues to step 4 but will show that no developers are found in step 5. + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC7 - Undo + +**Preconditions:** User is logged in + +**Guarantees:** +1. The previous command will be undone. + +**MSS** + +1. User requests undo. +2. System checks if there were any changes before. +3. System reverts the change. +
Use case ends. + +**Extensions** -1. Deleting a person while all persons are being shown +* 3a. There are no changes before + * 3a1. System informs users they have reached the first step +
Use case ends + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC8 - Redo + +**Preconditions:** User is logged in + +**Guarantees:** +1. The previous command undone will be redone. + +**MSS** + +1. User requests redo. +2. System checks if there were anything undone changes before. +3. System redoes the change. +
Use case ends. + + + +**Extensions** + +* 3a. There are no undone changes before + * 3a1. System inform users they have reached the last step +
Use case ends + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC9 - Add developer role +
Steps 3a1-3a2 are repeated until the data entered is not empty +
Use case resumes from step 4. + +* 4a. User enters an existing role + * 4a1. System informs users this role exists + * 4a2. User enters new role +
Steps 4a1-4a2 are repeated until the data entered is not empty +
Use case resumes from step 5. + +[Scroll back to Table of Contents](#table-of-contents) + + + +#### **Use case:** UC10 - Delete developer role +
Steps 3a1-3a2 are repeated until the data entered is not empty +
Use case resumes from step 4. + +* 4a. User enters a role that some developer is still using + * 4a1. System informs users this role cannot be deleted as there are developers using + * 4a2. User enters correct role +
Steps 4a1-4a2 are repeated until the data entered is can be deleted +
Use case resumes from step 5. + +* 4b. User enters a role that doesn't exist + * 4b1. System informs users this role don't exist + * 4b2. User enters correct role +
Steps 4a1-4a2 are repeated until the data entered is can be deleted +
Use case resumes from step 5. + +* 4b. User enters a role that cannot be deleted + * 4b1. System informs users this role cannot be deleted as it is a pre-defined role + * 4b2. User enters correct role +
Steps 4a1-4a2 are repeated until the data entered can be deleted +
Use case resumes from step 5. + +[Scroll back to Table of Contents](#table-of-contents) + + + +#### **Use case:** UC11 - Mark Deadline + +**Preconditions:** User is logged in + +**Guarantees:** +1. A project deadline will be marked. + +**MSS** + +1. User requests to mark the deadline of a project. +2. System requests for the index of the project and the index of the deadline. +3. User enters relevant indexes. +4. System validates if user's inputs exists. +5. System marks the deadline as done. + +**Extensions** + +* 3a. User enters an empty index + * 3a1. System informs users indexes should not be empty and requests for the correct role + * 3a2. User enters new indexes +
Steps 3a1-3a2 are repeated until the data entered is not empty +
Use case resumes from step 4. + +* 4a. User enters an invalid index (i.e no project with such index or no deadline in project with this index) + * 4a1. System informs users indexes are invalid + * 4a2. User enters new indexes +
Steps 4a1-4a2 are repeated until the data entered is not empty +
Use case resumes from step 5. + [Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC12 - Unmark Deadline + +**Preconditions:** User is logged in + +**Guarantees:** +1. A project deadline will be unmarked. + +**MSS** + +1. User requests to unmark the deadline of a project. +2. System requests for the index of the project and the index of the deadline. +3. User enters relevant indexes. +4. System validates if user's inputs exists. +5. System marks the deadline as undone. + +**Extensions** + +* 3a. User enters an empty index + * 3a1. System informs users indexes should not be empty and requests for the correct role + * 3a2. User enters new indexes +
Steps 3a1-3a2 are repeated until the data entered is not empty +
Use case resumes from step 4. + +* 4a. User enters an invalid index (i.e no project with such index or no deadline in project with this index) + * 4a1. System informs users indexes are invalid + * 4a2. User enters new indexes +
Steps 4a1-4a2 are repeated until the data entered is not empty +
Use case resumes from step 5. + [Scroll back to Table of Contents](#table-of-contents) + + + +### Non-Functional Requirements + +#### System/Performance Requirements +* Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
+#### Reliability Requirements +* Should be able to handle failures and show relevant error messages (hardware/network failures) +* Should ensure that data is protected from corruption or loss +* Should be able to recover immediately after inaccurate/invalid commands
+#### Usability Requirements +* Should follow specific code design and usability guidelines +* The user interface shall follow a consistent design pattern and layout throughout the application. +* There shall be clear and intuitive pathways for accomplishing common tasks. +* Users shall receive informative feedback on their actions (e.g., success messages, error messages) + in a clear and user-friendly manner. +* Context-sensitive help and tooltips shall be available to assist users in understanding complex features. +* A comprehensive user manual or online documentation shall be provided to explain how to use the application.
+#### Process Requirements +* The project is expected to adhere to a schedule that completes a milestone set every two weeks. +* The project shall follow an iterative breadth-first development methodology +* Automated testing suits shall be maintained and run for each build +* Code review shall be conducted for all new code contribution, with at least one team member + reviewing each piece of code before it is merged +* All project source code shall be stored in a version control system (e.g., Git), + and commits should follow a consistent naming convention. +* Coding standards and style guidelines shall be defined and followed consistently by all development team members.
+ +[Scroll back to Table of Contents](#table-of-contents) + +### Glossary + +| Term | Definition | +|----------------------|-----------------------------------------------------------------------------------------------------------| +| AddressBook-Level3 | A project created by the SE-EDU initiative, which this project is based on. | +| App | An application created by the project. | +| API | An application programming interface. | +| Architecture Diagram | A diagram that explains the high-level design of the App. | +| Class diagram | A diagram that shows the classes of the App and the relationships between them. | +| CLI | Command Line Interface, for users to perform actions through typing commands. | +| CommandBox | A component of the UI that allows users to enter commands. | +| Commons | A collection of classes used by multiple other components. | +| Component | A modular part of the App that serves a specific function. | +| ContactDisplay | A component of the UI that displays contact information. | +| GUI | Graphical User Interface, a visual way for users to interact with a software program | +| Logic component | The component responsible for executing user commands. | +| Main | A class with two subclasses, Main and MainApp, that initializes and shuts down the components of the App. | +| MainWindow | The main window of the UI that houses all the UI components. | +| Model | The data model used by the App. | +| Navigability | A concept referring to instances of one class holding a reference to instances of another class. | +| PlantUML | A tool used to create diagrams. | +| ResultDisplay | A component of the UI that displays the results of commands. | +| Sequence Diagram | A diagram that shows the sequence of events between components. | +| UML | [Unified Modeling Language](https://en.wikipedia.org/wiki/Unified_Modeling_Language) | + + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +## **Appendix: Manual Testing** +Given below are some instructions to test the app manually. + +
+ Expected: Shows the GUI with a message prompting user to unlock to continue. +3. Enter the command `unlock pw/Password123!` in the command box.
+ Expected: Shows the unlocked GUI. + +### Lock +1. Test case: `lock`
+ Expected: All the information in the GUI has been hidden. The execution of all commands except `unlock`, `help`, and + `delete` have also been disabled. + +### Unlock +1. Test case: `unlock pw/Password123!`
+ Expected: Shows the unlocked GUI. +2. Test case: `unlock pw/abc`
+ Expected: GUI remains locked. Error details shown in the status message. + + + + +### Change password +1. Test case: `change-password pw/Password123! npw/Password321!`
+ Expected: Password is changed successfully. Command success status message shown. +2. Test case: `change-password pw/Password123! npw/abc`
+ Expected: Password is not changed. Error details shown in the status message. + +### Adding +#### Adding projects +1. Test case: `add-project n/JuiceApp dr/App to allow for different juices to be ordered + dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0`
+ Expected: New project with the name JuiceApp is created, provided there is no existing project with that name. + Command success status message shown. +2. Test case: `add-project n/JuiceApp dr/App to allow for different juices to be ordered + dl/invaliddeadline`
+ Expected: No project is added. Error details shown in the status message. + +#### Adding developers +1. Test case: `add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer + s/4500 d/11-11-2023 g/johng rt/3`
+ Expected: New developer with the name John Doe is created, provided there is no existing developer with that name. + Command success status message shown. +2. Test case: `add-developer n/John Does p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer + s/4500 d/11-11-2023 g/johng rt/6`
+ Expected: No developer is added. Error details shown in the status message. + +#### Adding clients +1. Prerequisites: Add a project with the name `AndroidApp` and another project with the name `CustomWebsite` before + testing. +2. Test case: `add-client n/Jack Doe p/98765432 e/jackd@example.com a/311, Clementi Ave 2, #02-25 r/Developer + pr/AndroidApp pr/CustomWebsite o/Google do/google.com`
+ Expected: New client with the name Jack Doe is created, provided there is no existing client with that name. + Command success status message shown. +3. Test case: `add-developer n/John Does p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer + pr/AndroidApp pr/CustomWebsite s/4500 d/11-11-2023 g/johng rt/6`
+ Expected: No developer is added. Error details shown in the status message. + +### Listing +1. Test case: `list-developer`
+ Expected: Lists all the developers. +2. Test case: `list-client`
+ Expected: Lists all the clients. +3. Test case: `list-project`
+ Expected: Lists all the projects. +4. Test case: `lists-project`
+ Expected: No change in GUI. Error details shown in the status message. + +### Deleting +#### Deleting projects +1. Prerequisites: List all projects using the `list-project` command. Ensure there is at least 1 project in the list. +2. Test case: `delete-project 1`
+ Expected: First project is deleted from the list. Command success status message shown. +3. Test case: `delete-project x` where `x` is an integer larger than the number of projects listed. + Expected: No change. Error details shown in the status message. + +#### Deleting developers +1. Prerequisites: List all developers using the `list-developer` command. Ensure there is at least 1 developer in the + list. +2. Test case: `delete-developer 1`
+ Expected: First developer is deleted from the list. Command success status message shown. +3. Test case: `delete-developer x` where `x` is an integer larger than the number of developers listed. + Expected: No change. Error details shown in the status message. + +#### Deleting clients +1. Prerequisites: List all clients using the `list-client` command. Ensure there is at least 1 client in the list. +2. Test case: `delete-client 1`
+ Expected: First client is deleted from the list. Command success status message shown. +3. Test case: `delete-client x` where `x` is an integer larger than the number of client listed. + Expected: No change. Error details shown in the status message. + +### Editing +#### Editing projects +1. Prerequisites: List all projects using the `list-project` command. Ensure there are at least 2 projects in the list. +2. Test case: `edit-project 1 dl/01-12-2023,Design backend,HIGH,0 dl/19-12-2023,Design frontend,HIGH,0`
+ Expected: First project in the list is successfully updated. Command success status message shown. +3. Test case: `edit-project 1 dr/update desc` + Expected: First project in the list is successfully updated. Command success status message shown. +4. Test case: `edit-project 2 dl/invaliddeadline` + Expected: Edit to the second project in the list is unsuccessful. Error details shown in the status message. + +#### Editing developers +1. Prerequisites: List all developers using the `list-developer` command. Ensure there are at least 2 clients in the + list. +2. Test case: `edit-developer 2 p/98989898`
+ Expected: Second developer in the list is successfully updated. Command success status message shown. +3. Test case: `edit-developer 1 s/-200`
+ Expected: Edit to the first developer in the list is unsuccessful. Error details shown in the status message. + +#### Editing clients +1. Prerequisites: List all clients using the `list-client` command. Ensure there is at least 1 client in the list. +2. Test case: `edit-client 1 p/98989898`
+ Expected: First client in the list is successfully updated. Command success status message shown. +3. Test case: `edit-developer 1 p/10`
+ Expected: No edit is made. Error details shown in the status message. + +### Importing information +#### Importing developers +1. Prerequisites: Create a CSV file populated with developer details in the correct format. Add the CSV file to the same + folder as JAR file of this app. +2. Test case: `import-developer developers.csv`
+ Expected: All developers with their details specified in the CSV are added, assuming the data in the file is in the + correct format. Command success status message shown. +3. Test case: `import-developer`
+ Expected: No developer is added. Error details shown in the status message. + +#### Importing clients +1. Prerequisites: Create a CSV file populated with client details in the correct format. Add the CSV file to the same + folder as JAR file of this app. +2. Test case: `import-client clients.csv`
+ Expected: All clients with their details specified in the CSV are added, assuming the data in the file is in the + correct format. Command success status message shown. +3. Test case: `import-client`
+ Expected: No client is added. Error details shown in the status message. + +### Undoing commands +For these tests, each test case has respective prerequisites that must be met before executing the test. +1. Prerequisites: Relaunch the app and unlock it with your password. Do NOT execute any other command after `unlock`. + 2. Test case: `undo`
+ Expected: Nothing is undone since no command has been executed yet. Error details shown in the status message. + +1. Prerequisites: Execute either an edit or delete command after unlocking the app. + 2. Test case: `undo`
+ Expected: The most recent command executed is undone. Command success status message shown. + +### Redoing commands +For these tests, each test case has respective prerequisites that must be met before executing the test. +1. Prerequisites: Relaunch the app and unlock it with your password. Do NOT execute any other command after `unlock`. +2. Test case: `redo`
+ Expected: Nothing is redone since no command has been executed yet. Error details shown in the status message. + +1. Prerequisites: Execute either an edit or delete command after unlocking the app, then execute the `undo` command. +2. Test case: `redo`
+ Expected: The changes from the recent `undo` command executed are reverted. Command success status message shown. + +### Adding roles +#### Adding Developer Roles +1. Test case: `add-developer-role UIDesigner`
+Expected: UIDesigner added as a role. Command status success message shown. +2. Test case: `add-developer-role Developer`
+Expected: No role added. Error details shows role cannot be added as it exists. +3. **Test Case 1 must be completed** `add-developer-role UIDesigner`
+Expected: No role added. Error details shows role cannot be added as it exists. + +#### Adding Client Roles +1. Test case: `add-client-role Tester`
+ Expected: Tester added as a role. Command status success message shown. +2. Test case: `add-client-role HR`
+ Expected: No role added. Error details shows role cannot be added as it exists. +3. **Test Case 1 must be completed** `add-developer-role Tester`
+ Expected: No role added. Error details shows role cannot be added as it exists. + + + +### Delete roles +#### Deleting Developer Roles +1. Prerequisite: role `UIDesigner` has been added in already (i.e. add in this role if it is after any of the test case) +2. Test case: `delete-developer-role UIDesigner`
+ Expected: UIDesigner deleted as a role. Command status success message shown. +3. Test case: assign the `UIDesigner` role to any developer, then execute `delete-developer-role UIDesigner`
+ Expected: No role deleted. Error details shows role cannot be deleted as there are developers using it. +4. Test case: `delete-developer-role Developer`
+ Expected: No role deleted. Error details shows role cannot be deleted as this is a pre-declared role. +5. Test case: **Test Case 1 must be completed** then execute `delete-developer-role UIDesigner`
+ Expected: No role deleted. Error details shows role cannot be deleted as it doesn't exist. + +#### Deleting Client Roles +1. Prerequisite: role `Tester` has been added in already (i.e. add in this role if it is after any of the test case) +2. Test case: `delete-client-role Tester`
+ Expected: Tester deleted as a role. Command status success message shown. +3. Test case: assign the `Tester` role to any client, then execute `delete-client-role Tester`
+ Expected: No role deleted. Error details shows role cannot be deleted as there are clients using it. +4. Test case: `delete-client-role HR`
+ Expected: No role deleted. Error details shows role cannot be deleted as this is a pre-declared role. +5. Test case: **Test Case 1 must be completed** then execute `delete-developer-role Tester`
+ Expected: No role deleted. Error details shows role cannot be deleted as it doesn't exist. + + + +### Finding +#### Finding projects +1. Prerequisites: List all projects using the `list-project` command. Multiple projects in the list. +2. Test case: `find-project pr/Laundry App`
+ Expected: Projects with the name, Laundry App, are shown on the list. Command success status message shown. +3. Test case: `find-developer Laundry App`
+ Expected: No search result due to error in format. No prefix provided before project name. Error details shown in the status message. + +#### Finding developers +1. Prerequisites: List all developers using the `list-developer` command. Multiple developers in the list. +2. Test case: `find-developer n/Alice`
+ Expected: Developers with the name, Alice, are shown on the list. Command success status message shown. +3. Test case: `find-developer Alice`
+ Expected: No search result due to error in format. No prefix provided before name. Error details shown in the status message. + +#### Finding clients +1. Prerequisites: List all clients using the `list-client` command. Multiple clients in the list. +2. Test case: `find-client o/Google`
+ Expected: Clients from the organisation, Google, are shown on the list. Command success status message shown. +3. Test case: `find-client Google`
+ Expected: No search result due to error in format. No prefix provided before organisation. Error details shown in the status message. + + + +### Marking project deadlines +#### Mark deadline as done +1. Prerequisites: List all projects using the `list-project` command. Multiple projects in the list. +2. Test case: `mark-deadline 1 2`
+ Expected: The second deadline of the first project in the currently displayed project list is marked as done. Command success status message shown. +3. Test case: `mark-deadline 1 x` where `x` is an integer larger than the number of deadlines for the project specified.
+ Expected: No change. Error details shown in the status message. + +#### Mark deadline as undone +1. Prerequisites: List all projects using the `list-project` command. Multiple projects in the list. +2. Test case: `unmark-deadline 1 2`
+ Expected: The second deadline of the first project in the currently displayed project list is marked as undone. Command success status message shown. +3. Test case: `unmark-deadline 1 x` where `x` is an integer larger than the number of deadlines for the project specified. + Expected: No change. Error details shown in the status message. + +### Exiting the app +1. After executing some commands, use the `exit` command to exit the app. +2. You can re-launch the app by double-clicking the jar file.
+ Expected: The application should load with any previous changes made during the previous running of the app. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +## **Appendix: Planned Enhancements** + +### Validation checks for duplicate fields in edit commands +**Current Behavior:** Two developers can have the same details (eg. address, phone number, email) as long as their name +is not the same. This program behaviour also exists for clients. +
+**Enhanced Behavior:** Validation checks should be conducted for email, contact number and address when adding or +editing developers or clients to make sure that no two developers or clients have repeated details since this is +unrealistic. + +### Validation checks for unedited fields in edit commands +**Current Behavior:** A developer, client, or project can be edited to have the exact same details as it currently has. +
+**Enhanced Behavior:** Validation checks should be conducted which notifies the user when they try to edit an existing +developer, client, or project, to have the exact same details as it currently has. This makes it more user-friendly as +if such an occurrence happens, it is likely that it was a mistake or typo in the command. + +### Case-sensitive validation checks for adding roles +**Current Behavior:** Two similar roles with different cases can both be added. `Developer` and `developer` can exist at the +same time.
+**Enhanced Behavior:** Two same words that are only differentiated by case should not be able to be added in as a role. + +### Deadlines cannot be any date +**Current Behavior:** Deadlines for projects can be any date such at year 0001.
+**Enhanced Behavior:** There should be a limit to the deadline line dates like 10-20 years before and after the current date. + +### Password Recovery +**Current Behavior:** If you forgot your password, there is no way to retrieve it
+**Enhanced Behavior:** Links the system to email or have verifications that allows users to reset their password. + +### Additional menu item for `import-developer` and `import-client` +**Current Behavior:** The import function is only available in CLI.
+**Enhanced Behavior:** A new menu item will be added under File called `Import developers` and `Import clients` +Clicking it will lead to a window to select the location of the respective file in csv format. +The backend implementation of logic follows the CLI implementation by creating a `ImportDeveloperCommand` or `ImportClientCommand` + +### Exporting data +**Current Behavior:** There is only import csv function and no options for export
+**Enhanced Behavior:** A new menu item will be added under File called `Export data` and clicking it will lead to a window +where users can select the location to save the files for Developers, Clients and Projects. The file will be saved in csv format. + +### Find Autocomplete +**Current Behavior:** While searching, users are not prompted for autocomplete suggestions. +**Enhanced Behavior:** Implement autocomplete suggestions as users type their search queries. This can help users avoid +typos and provide quick access to commonly used search terms. + +### Sort Results +**Current Behavior:** After each command, the list of contacts shown are based on the order the contact was added.
+**Enhanced Behavior:** Allow users to sort the search results based on different criteria such as name, date, or +priority. This provides users with more flexibility in organizing and viewing the search results. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. +## **Appendix: Effort** - 1. 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. +| Feature | AB3 | CodeContact | +|:---------------|:-----:|:-------------:| +| Effort | 10 | 30 | +| Lines of Code | 6k | +18k | - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. +The CodeContact project involved a significant effort to adapt the AddressBook-Level3 (AB3) application to a new domain of Developers, Clients and Projects in a Software Engineering setting. One of the major changes was the addition of three new models, Developer, Client and Project, which required modifying the existing data model and the associated logic components. Another significant change was the complete redesign of the user interface using JavaFX, which required a significant amount of time and effort to learn and implement. - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. +Firstly, although code was reused from AB3, a lot of it had to be refactored to fit our use case. We now had to deal with 3 entity types, Developer, Client and Project, which meant that the way we stored the information also had to change. Moreover, with more attributes for both `Developer` and `Client` classes, it also meant more effort in validating the inputs and writing high quality test cases for each attribute, an extremely time-consuming process. -1. _{ more test cases … }_ +The most significant challenge was implementing the logic for tabs within the user interface. Not only was it challenging to implement the tabs at the UI level, the integration of switching tabs based on the command executed was challenging as well. Careful and deliberate decisions were made for the action to take when switching tabs. For example, when switching to the `Developer` tab, the `list-developer` command is executed to show the list of developers. -### Saving data +Other challenges include the implementations of features that seem trivial on the surface level. Something that started as a validation check for valid developer and client roles, evolved to 4 commands allowing users to add and delete roles, and these roles had to be stored in separate files. This feature also affected the undo and redo commands, which had to explicitly check for commands involving roles as they are stored outside of `addressbook.json`. -1. Dealing with missing/corrupted data files +Due to limitations in the storage format in `addressbook.json`, we had to get creative in the way we store the associations between Developers, Clients and the projects they have been assigned to. We decided to store the associations in the `Developer` and `Client` classes themselves, which meant that we had to update the logic components to update the associations when a project is deleted. This was a significant change from AB3, which only had to deal with a single entity type. Other constraints had to be included such as not allowing names of Projects to be edited, and not allowing Developers and Clients to be assigned to Projects that do not exist. - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ +The effort required to implement the features in CodeContact was significantly more than AB3, which is reflected in the number of lines of code. However, the effort was well worth it as we were able to create a useful application that can be used by project managers to manage their projects and teams. -1. _{ more test cases … }_ +[Scroll back to Table of Contents](#table-of-contents) diff --git a/docs/Documentation.md b/docs/Documentation.md index 3e68ea364e7..0e33867d565 100644 --- a/docs/Documentation.md +++ b/docs/Documentation.md @@ -18,7 +18,7 @@ title: Documentation guide * Follow the [**_Google developer documentation style guide_**](https://developers.google.com/style). -* Also relevant is the [_[se-edu/guides] **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html) +* Also, relevant is the [_[se-edu/guides] **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html) **Diagrams:** diff --git a/docs/Logging.md b/docs/Logging.md index 5e4fb9bc217..26cbbb7d981 100644 --- a/docs/Logging.md +++ b/docs/Logging.md @@ -5,7 +5,10 @@ title: Logging guide * We are using `java.util.logging` package for logging. * The `LogsCenter` class is used to manage the logging levels and logging destinations. -* The `Logger` for a class can be obtained using `LogsCenter.getLogger(Class)` which will log messages according to the specified logging level. -* Log messages are output through the console and to a `.log` file. -* The output logging level can be controlled using the `logLevel` setting in the configuration file (See the [Configuration guide](Configuration.md) section). -* **When choosing a level for a log message**, follow the conventions given in [_[se-edu/guides] Java: Logging conventions_](https://se-education.org/guides/conventions/java/logging.html). +* The `Logger` for a class can be obtained using `LogsCenter.getLogger(Class)` which will log messages according to the + specified logging level. +* Log messages are output through the console and to a `.log` file. +* The output logging level can be controlled using the `logLevel` setting in the configuration file (See + the [Configuration guide](Configuration.md) section). +* **When choosing a level for a log message**, follow the conventions given in [_[se-edu/guides] Java: Logging + conventions_](https://se-education.org/guides/conventions/java/logging.html). diff --git a/docs/SettingUp.md b/docs/SettingUp.md index 275445bd551..2e8025d784a 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -4,8 +4,7 @@ title: Setting up and getting started --- * Table of Contents -{:toc} - + {:toc} -------------------------------------------------------------------------------------------------------------------- @@ -19,12 +18,17 @@ Follow the steps in the following guide precisely. Things will not work out if y First, **fork** this repo, and **clone** the fork into your computer. If you plan to use Intellij IDEA (highly recommended): -1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to to ensure Intellij is configured to use **JDK 11**. -1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA.
- :exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. + +1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the + JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to to ensure Intellij is configured to use **JDK 11 + **. +1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle + project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into + IDEA.
+ :exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. 1. **Verify the setup**: - 1. Run the `seedu.address.Main` and try a few commands. - 1. [Run the tests](Testing.md) to ensure they all pass. + 1. Run the `seedu.address.Main` and try a few commands. + 1. [Run the tests](Testing.md) to ensure they all pass. -------------------------------------------------------------------------------------------------------------------- @@ -32,24 +36,31 @@ If you plan to use Intellij IDEA (highly recommended): 1. **Configure the coding style** - If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match ours. + If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code + style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match + ours.
e.g. `seedu.address.commons.StringUtilTest` -1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).
+1. *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` -1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
+1. 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` diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 57437026c7b..0741c92bd34 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1,197 +1,1459 @@ --- layout: page -title: User Guide +title: CodeContact User Guide --- +------------------------------------------------------------------------------------- +## Welcome to CodeContact +{: .no_toc} -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. +***Taking charge of your PROject Management!*** + +Seamlessly integrate contact, client, and project management, simplifying access to coding-related contacts, +facilitating collaboration, and offering command-line efficiency for project managers. + +CodeContact is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still +having the benefits of a Graphical User Interface (GUI). If you can type fast, CodeContact can get your contact +management tasks done faster than traditional GUI apps. **CodeContact** aims to put the **P.R.O** in project management by enabling project managers to be: + > **1. Productive** + > **2. Reliable** + > **3. Organised** + +Here’s an overview of how CodeContact can help you streamline your project management processes. +* Store and edit information about developers and clients related to projects. +* Store and manage projects and their deadlines. +* Assign projects to developers and clients. + +If you are familiar with CodeContact, jump to our [**Table of Contents**](#table-of-contents) to find out what you are looking +for! + +If you are new here, you may start with learning [**How to navigate this guide**](#navigating-this-guide) and visit +the [**Quick Start**](#quick-start) guide to onboard onto CodeContact smoothly! + +------------------------------------------------------------------------------------- + + +------------------------------------------------------------------------------------- +### How can this guide help me? +{: .no_toc} + +If you are a new user, we hope to first inform you on how you can [get started](#quick-start) using CodeContact. + +As you use CodeContact, you may also have questions on how to perform certain actions within the +application. This guide thus contains a comprehensive list of [Features](#features) offered with CodeContact, as well as +explanations on when and how to use them. + +Further questions are also answered within a [FAQ](#faq) section below. + +Confused about the terms or formatting used in this guide? Learn how to **navigate this guide** [here](#navigating-this-guide). + +Confused about the visual display of CodeContact? Learn how to **navigate the user interface** of CodeContact +[here](#navigating-the-graphical-user-interface-gui). + +------------------------------------------------------------------------------------- + + + +## Table of Contents +{: .no_toc} * Table of Contents {:toc} + + + +# **Navigating this guide** + + +## ***Glossary*** +------------------------------------------------------------------------------------- +### **Definitions** + +| Term | Definition | +|---------------|----------------------------------------------------------------------------------------------------------------------------| +| Parameter | Parameters are specific details you would include about the developer/client/project.(eg. name, date joined, description). | +| Command | An input from the user that tells CodeContact to perform an action (i.e. add a client). | +| GUI | Graphical User Interface (GUI) represents the visual display of CodeContact that users can see. | +| GUI Component | A subsection of the Graphical User Interface. For more information on specific GUI components, refer to [this section](). | +| CLI | Command Line Interface (CLI) represents a text-based user interface to interact with the application. | +| Character | Any letter or symbol that is recognized by the computer, and can form a line of text (eg. `a` , `+` , `$` ). | +| JSON | [Javascript Object Notation](https://en.wikipedia.org/wiki/JSON) | +| JAR file | [Java Archive File](https://en.wikipedia.org/wiki/JAR_(file_format)) | +| CSV file | [Comma-separated Values File](https://en.wikipedia.org/wiki/Comma-separated_values) | + +[Scroll back to Table of Contents](#table-of-contents) + +------------------------------------------------------------------------------------- +### **Parameter Information** + +Within the tables below, you can find out more about the parameters that CodeContact supports. These parameters come in +handy when crafting commands in CodeContact. + +Here are some notes about these parameters. + +* Each parameter comes with **constraints**. These constraints detail the specific formats of text that + each parameter accepts as valid user input. + * Not following these constraints will **result in an error** when entering the command. + * Nonetheless, CodeContact will not stop working. Rather, a message will be provided to you on + how to correct your command. + +#### Common Parameters for Developers and Clients + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---------------------------------------------| +| `n/` | name of developer/client | alphanumeric characters and spaces, and it should not be blank | Tom Hanks, Elizabeth 2 | 成龍, 潔 いさぎ 世 よ 一 いち, Ganesh s/o Ravichandran | +| `p/` | phone number of developer/client | 8 numeric characters, and it should not be blank | 94566835 | 123, 432, 5678@ | +| `e/` | email of developer/client | alphanumeric characters, contains an @ and it should not be blank | amy@gmail.com | amy!gmail.com, amy$gmail | +| `a/` | address of developer/client | alphanumeric characters and spaces, and it should not be blank | 311, Clementi Ave 2, #02-25 | 成龍, 潔 いさぎ 世 よ 一 いち | +| `r/` | role of developer/client | alphabetical characters and spaces, and it should not be blank | Developer | 成龍, 潔 いさぎ 世 よ 一 いち | +| `pr/` | project name | alphanumeric characters and spaces, and it should not be blank, used in the context or Developer/Client when assigned to project(s) | CS2103T | 成龍, 潔 いさぎ 世 よ 一 いち | + +#### Developer Specific Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|----------|------------------------------|--------------------------------------------------------------------------------------------------|----------------|----------------------| +| `g/` | github username of developer | alphanumeric characters, follows github username convention and it should not be blank | johng, amy123 | g, y | +| `d/` | date joined of developer | numeric characters in dd-MM-yyyy format, should not be a future date, and it should not be blank | 11-11-2023 | 19-11-2024, 1/1/2023 | +| `s/` | salary of developer | positive integers of at least 4 digits, should not be blank | 5000 | 5000.0, 4321.32.22 | +| `rt/` | rating of developer | numeric characters between 0 to 5 | 5, 3.5 | -0, -1, 6 | + + + +#### Client Specific Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|-----------------------------|---------------------------------------------------------------------------------------------------|----------------|------------------| +| `o/` | organisation name of client | alphanumeric characters and spaces, and it should not be blank | Google | 谷歌 | +| `do/` | document link of client | alphanumeric characters and spaces, and it should not be blank, follows standard hyperlink format | google.com | 谷歌.com | + +#### Project Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|------------------------|----------------------------------------------------------------|-------------------------------------------------|------------------------------------| +| `n/` | name of project | alphanumeric characters and spaces, and it should not be blank | CodeContact, oribtal23, Team Trekker | 成龍, 潔 いさぎ 世 よ 一 いち | +| `dr/` | description of project | alphanumeric characters and spaces, and it should not be blank | App to allow for different juices to be ordered | 成龍, 潔 いさぎ 世 よ 一 いち | +| `dl/` | deadline of project | alphanumeric characters and spaces, and it should not be blank | 19-12-2023, Design backend, HIGH, 0 | 19.1.2023, 潔 いさぎ 世 よ 一 いち, NONE, 5 | +| `pri/` | priority of deadline | HIGH, MEDIUM, LOW | HIGH, MEDIUM, LOW | 5, 3.5, -1, high, M | + + +### **Format** +------------------------------------------------------------------------------------- +#### General Formatting +Here are the explanations behind the formatting we use through this guide.
+ +* Words in `grey blocks (like these)` usually represent any of the following: + 1. Text used in commands, such as `add-developer`. + 2. Keys on your keyboard like `Enter`. + 3. File names such as `CodeContact.jar`. +
+
+ + +**Here is a quick summary of each GUI component within CodeContact:** + +| Name | Description | +|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Menu Bar | Contains dropdown menu options for the CodeContact application. | +| Command Box | Allows users to enter CodeContact commands. | +| Result Display | 1. Provides CLI-based feedback upon a user command.
2. Allows users to see if their command was successful or not.
3. Provides error messages to guide users on how to use CodeContact commands. | +| Tabs | Allows users to see different lists of information on clicking on the relevant tabs. The tabs will also automatically switch to the correct tab corresponding to the command executed. | +| Developers/Clients/Projects card | Displays a list of Developer, Client or Project Cards. This list can be manipulated through commands like `find` and `list`. | +| Deadlines progress | Displays the progress of deadlines for a certain project. | +| Deadline list with details | Displays the details of the deadline in a table form. | +| Re-sort | Click on the respective words, there will be a small black arrow that appears. You can press to resort the data eg. show date from furthest to nearest day. | + +### Notes on GUI +
+ -1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.
- A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
+5. A GUI similar to the below should appear in a few seconds. Note how the app might contain some sample data.
 -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: - * `list` : Lists all contacts. +6. For new users, learn to use CodeContact through our [Tutorial](#codecontact-tutorial--for-new-users-). + + +7. Refer to the [Features](#features) below for details of each command. + + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. - * `delete 3` : Deletes the 3rd contact shown in the current list. - * `clear` : Deletes all contacts. +## ***CodeContact Tutorial (for new users)*** - * `exit` : Exits the app. +This is a tutorial for **first-time** CodeContact users. -1. Refer to the [Features](#features) below for details of each command. +1. Launch CodeContact. You may refer to the instructions [here](#quick-start). + * On launch, CodeContact will not contain any developer or client records. +
+ + +2. You will be asked to **enter a password** to unlock CodeContact. + * Enter the command `unlock pw/Password123!` in the command box. +
+ + +3. You can **change the password** to unlock CodeContact. + * Enter the command `change-password pw/Password123! npw/` in the command box.
+
+
+ + +2. We can then **add a developer** to our CodeContact. + * Enter the + command `add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp s/4500 d/01-11-2023 g/johng rt/3`. + * Try adding more developers with different details for each parameter! + * Remember to add a new [project](#add-project--add-project) or [role](#add-roles) if you wish to add new developers with other roles and + project. +
+ + +3. We can also **add a client** to our CodeContact. + * Enter the + command `add-client n/Amy p/88765423 e/amy@example.com a/31, Clementi Ave 6, #03-12 r/Client pr/AndroidApp o/Google do/google.com`. + * Try adding more clients with different details for each parameter! + * Remember to add a new [project](#add-project--add-project) or [role](#add-roles) if you which to add new client with other roles and project. +
+ + +4. Let us try **editing the name** of a developer stored in CodeContact. + * Enter the command `edit-developer 1 n/Jhonny`. + * Try editing other parameters or developers and projects too! + * More details of what you can edit can be found [here](#edit). +
+ + +5. We can also easily **find** for information in CodeContact. + * Enter the command `find-developer n/John s/4500`. + * Try looking for other information and search with multiple parameters! + * More details of what you can find can be found [here](#find). +
+ + +6. You can always **show the full list** after finding in CodeContact. + * Enter the command `list-developer`, `list-client` or `list-project`. +
+ + +7. You can **delete developers, clients or projects** in CodeContact. + * Enter the command `delete-developer 3` to delete the 3rd developer in CodeContact. + * More details on how delete works can be found [here](#delete-developer--delete-developer). +
+ + +8. If you realise that you did not delete this developer, you can **undo** this action in CodeContact. + * Enter the command `undo` and it will revert your previous actions. +
+ + +9. If you realise you actually want it deleted, you can **redo** this action in CodeContact. + * Enter the command `redo` and it will redo your previous actions. +
+ + +Congratulations! You are now ready to use CodeContact! + +To view all our features, you may visit our [Features](#features) section. + +[Scroll back to Table of Contents](#table-of-contents) -------------------------------------------------------------------------------------------------------------------- + -## Features +# **Features** + + +| [Security Features](#security-features) | Locking Access to features | Unlocking Access to features | Changing personal password | +|:--------------------------------------------|:--------------------------:|:----------------------------:|:-----------------------------------------------------:| +| [Password Protection](#password-protection) | [`lock`](#lock-lock) | [`unlock`](#unlock-unlock) | [`change-password`](#change-password-change-password) | + +| [Management Features](#management-features) | Developer | Client | Project | +|:----------------------------------------------------|:-------------------------------------------------------------------------:|:----------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------:| +| [Adding new information](#add) | [`add-developer`](#add-developer--add-developer) | [`add-client`](#add-client--add-client) | [`add-project`](#add-project--add-project) | +| [Deleting information](#delete) | [`delete-developer`](#delete-developer--delete-developer) | [`delete-client`](#delete-client--delete-client) | [`delete-project`](#delete-project--delete-project) | +| [Editing information](#edit) | [`edit-developer`](#edit-developer-details--edit-developer) | [`edit-client`](#edit-client-details--edit-client) | [`edit-project`](#edit-project-details--edit-project) | +| [Importing information](#import-information) | [`import-developer` ](#import-developers-import-developer) | [`import-client`](#import-clients-import-client) | - | +| [Finding information](#find) | [`find-developer`](#find-developer-details) | [`find-client`](#find-client-details) | [`find-project`](#find-project-details), [`find-deadline`](#find-deadlines-find-deadline) | +| [Listing information](#listing-information--list) | `list-developer` | `list-client` | `list-project` | +| [Adding new role](#add-roles) | [`add-developer-role`](#add-developer-roles--add-developer-role) | [`add-client-role`](#add-client-roles--add-client-role) | - | +| [Deleting role](#delete-roles) | [`delete-developer-role`](#delete-developer-roles--delete-developer-role) | [`delete-client-role`](#delete-client-roles--delete-client-role) | - | +| [Marking Project Deadlies](#mark-project-deadlines) | - | - | [`mark-deadline`](#mark-deadline-as-done--mark-deadline), [`unmark-deadline`](#mark-deadline-as-undone--unmark-deadline) | + +| [Additional Features](#additional-features) | Finding Help | Clearing data | Exiting program | +|:--------------------------------------------------|:---------------------------------------:|:-----------------------------------------------------:|:-------------------------------------------------:| +| [Miscellaneous Features](#miscellaneous-features) | [View Help `help`](#viewing-help--help) | [Clear entries `clear`](#clearing-all-entries--clear) | [Exit program `exit`](#exiting-the-program--exit) | + +-------------------------------------------------------------------------------------------------------------------- + + +## ***Security Features*** + +-------------------------------------------------------------------------------------------------------------------- +### **Password Protection** + +> **Grant yourself exclusive access and deny access by others to CodeContact with a personal and +> customizable password.** + + +#### Lock : `lock` + +> Locks the system and hides all the information, denying access to all information and commands +> except `unlock`, `help`, and `delete`. + +**Format:** `lock` + +**Example of usage:** `lock` + +When command succeeds, CLI shows: + +``` +Locked all data +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Unlock : `unlock` + +> Unlocks the system by granting access to all information and commands. + +**Format:** `unlock pw/CURRENT_PASSWORD` + +**Constraints:** +1. Only unlocks if password exactly matches the current password (which is the last set password). + * Note: The default password is `Password123!`. It is highly recommended to change to a different password with the [`change-password` command](#change-password--change-password). + +**Example of usage:** `unlock pw/Password123!` + +When command succeeds, CLI shows: +``` +Unlocked all data +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Change password : `change-password` + +> Changes the current password so that the password is kept personal. + +**Format:** `change-password pw/CURRENT_PASSWORD npw/NEW_PASSWORD` + +**Constraints:** +1. `CURRENT_PASSWORD` entered must exactly match the current password. + * Note: The default password is `Password123!`. + +2. `NEW_PASSWORD` must be at least 8 characters long and contain at least one digit, one lowercase letter, + one uppercase letter, and one special character. + +**Example of usage:** `change-password pw/Password123! npw/NewPass987!` + +When command succeeds, CLI shows: +``` +Password changed successfully. +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +## ***Management Features*** + +-------------------------------------------------------------------------------------------------------------------- +### **Add** +> **Your accessible command to easily add relevant project details into CodeContact.** -
- +
:information_source: Note: An alternative (arguably, a more OOP) model is given below. It has a `Project` list in the `AddressBook`, which `Developer`/`Client` references. This allows CodeContact to only require one `Project` object per unique `Project`, instead of each `Developer`/`Client` needing their own set of Strings holding the `Project` names.
+
+
### Storage component
@@ -146,19 +200,297 @@ The `Storage` component,
### Common classes
-Classes used by multiple components are in the `seedu.addressbook.commons` package.
+Classes used by multiple components are in the `seedu.address.commons` package.
+
+This section describes some noteworthy details on how certain features are implemented.
--------------------------------------------------------------------------------------------------------------------
+
-## **Implementation**
+## Implementation
-This section describes some noteworthy details on how certain features are implemented.
+### Add Features (`add-developer`, `add-client`, `add-project`)
+Example Uses:
+
+`add-developer n/Mahidharah p/81256788 e/aunus@nus.com a/Blk 88 Lorong 8 Serangoon Gardens, #08-88 r/Developer pr/Appollo pr/Orbital s/8880 d/20-10-2020 g/mahidharah88 rt/5.0`
+
+`add-client n/Mahidharah p/81256788 e/aunus@nus.com a/Blk 88 Lorong 8 Serangoon Gardens, #08-88 r/HR pr/Appollo pr/Orbital o/Google do/google.com`
+
+`add-project n/Tp dr/Team Project dl/19-12-2023,Design backend,HIGH,0 dl/21-12-2023,Design frontend,LOW,1`
+
+
+#### Intended Result
+Adds a developer, client or project to the address book, and adds them to the bottom of the list of exisitng developers, clients or projects respectively. The newly added developer, client or project will be displayed in the list of developers, clients or projects respectively.
+If the developer, client or project already exists in the address book, the command will not be allowed and an error will be thrown to alert user.
+
+#### Implementation
+Upon entry of the add-developer command for instance, an `AddDeveloperCommand` class is created. The `AddDeveloperCommand` class extends the abstract `Command` class and implements the `execute()` method. Upon execution of this method, a `Developer` object is added to the model’s list of developers if all the attributes provided are valid and a duplicate instance does not exist.
+A similar implementation is done for the add-client and add-project commands, where a `AddClientCommand` and `AddProjectCommand` class (which similarly extend the `Command` class) is created respectively to add a `Client` or `Project` object to the model’s list of clients or projects.
+
+Given below is an example usage scenario of how the add developer is executed step by step.
+
+**Step 1.** User launches the application and unlocks the application with the correct password.
+
+**Step 2.** User executes an add-developer command by entering `add-developer n/Mahidharah p/81256788 e/aunus@nus.com a/Blk 88 Lorong 8 Serangoon Gardens, #08-88 r/Developer pr/Appollo pr/Orbital s/8880 d/20-10-2020 g/mahidharah88 rt/5.0`
+
+**Step 3.** The developer is added to the model’s list of developers if valid.
+
+add-client and add-project commands are executed in a similar manner.
+
+The following sequence diagram illustrates how the add developer operation works
+
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+### Delete Features (`delete-developer`, `delete-client`)
+#### Intended Result
+Deletes a developer or client at the specified **one-based index** of list of currently existing/found developers or clients respectively, depending on the command. Users are able to delete any developers or clients in their respective lists. If an index larger than or equal to the size of the respective lists provided, the command will not be allowed and an error will be thrown to alert user.
+
+Example Uses:
+
+`delete-developer 3`
+
+`delete-client 2`
+
+
+#### Implementation
+Upon entry of the delete developer command for instance, a `DeleteDeveloperCommand` class is created. The `DeleteDeveloperCommand` class extends the abstract `Command` class and implements the `execute()` method. Upon execution of this method, the developer at specified **one-based index** is removed if the index provided is valid.
+
+Given below is an example usage scenario of how the delete developer command behaves at each step.
+
+**Step 1.** User launches the application and unlocks the application with the correct password.
+
+**Step 2.** User executes a delete-developer command by entering `delete-develoepr 1` to delete the developer at index 1 (one-based indexing)
+
+**Step 3.** The developer at this index is removed if the index provided is valid.
+
+A similar implementation is done for the delete-client command, where a `DeleteClientCommand`class (which similarly extend the `Command` class) is created respectively to delete a `Client` object from the model’s list of clients.
+
+The following sequence diagram illustrates how the delete developer operation works:
+
+
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+
+
+### Delete Project Feature (`delete-project`)
+#### Intended Result
+Deletes a project at the specified **one-based index** of list of currently existing/found projects. Users are able to delete any project in project lists. If an index larger than or equal to the size of the project list provided, the command will not be allowed and an error will be thrown to alert user.
+Additionally, if the project is assigned to a developer or client, the project will be removed from the developer or client's set of projects.
+
+Example Uses:
+
+`delete-project 2`
+
+#### Implementation
+Upon entry of the delete project command, a `DeleteProjectCommand` class is created. The `DeleteProjectCommand` class extends the abstract `Command` class and implements the `execute()` method. Upon execution of this method, the project at specified **one-based index** is removed if the index provided is valid.
+
+Given below is an example usage scenario of how the delete developer command behaves at each step.
+
+**Step 1.** User launches the application and unlocks the application with the correct password.
+
+**Step 2.** User executes a delete-project command by entering `delete-project 1` to delete the project at index 1 (one-based indexing)
+
+**Step 3.** The project at this index is removed if the index provided is valid. Developer and Client lists are iterated through and the project is removed from the respective project sets if the project is assigned to them.
+
+This is similar to delete-developer and delete-client commands, except that in the delete project method is called in the model, the project is also removed from the respective developer and client's project sets.
+The following sequence diagram illustrates how the delete-project operation works:
+
+
+
+#### Design considerations
+ 1. **Alternative 1:** Make the delete-project command call edit-developer and edit-client commands, both to update the project sets of the respective developers and clients.
+ * Pros: Easy to implement.
+ * Cons: May be less efficient as the edit-developer and edit-client commands will have to be called for each developer and client respectively.
+ * Edit command will have to retrieve client and developer project sets, iterate through each set to edit them accordingly and then pass the command, which will be retrieving information from the model to the logic component, which will complicate and potentially break abstractions originally in place.
+ 2. **Alternative 2:** Do not edit developer and client project sets
+ * Pros: No extra logic needed to be implemented.
+ * Cons: Information integrity is compromised as the project will still be assigned to the developer and client even after it is deleted, and this will affect other features such as find, and potentially future features.
+ 3. **Alternative 3 (current choice):** The delete project method in the model will iterate through developers and clients to make necessary changes to their project sets.
+ * Pros: Information integrity is maintained. Abstractions in place are not broken. Complies with implemented Validation checks.
+ * Cons: Implementation is hidden in the model component, and might not be intuitive in a glance in the logic component.
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+
+
+### Import Feature (`import-developer`, `import-client`)
+This feature will allow project managers to import existing spreadsheets of developer and client data in the specified format in CSV
+#### Implementation
+
+Upon entry of the import developer command, an `ImportDeveloperCommand` class is created. The `ImportDeveloperCommand` class extends the abstract `Command` class and implements the `execute()` method. Upon execution of this method, a list of `Developer` objects are added to the model’s list of developers if all the attributes provided are valid and a duplicate instance does not exist.
+
+Given below is an example usage scenario of how the import developer is executed step by step.
+
+**Step 1.** User launches the application
+
+**Step 2.** User inputs `import-developer developers.csv` to indicate path and filename of where the spreadsheet of developers is located.
+
+**Step 3.** The developers are added to the model’s list of developers if valid the column names are valid and each row of input is valid.
+
+The implementation follows likewise for clients.
+
+The following sequence diagram illustrates how the import developer operation works:
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+### Edit Feature (`edit-developer`, `edit-client`, `edit-project`)
+#### Implementation
+The original edit feature from AB-3 has been extended to account for the editing of projects and specific people - developers
+and clients. The edit command will be parsed to return 1 of 3 different commands, depending on the
+object to be edited.
+
+The `AddressBookParser` will return the respective parser for the command depending on the user input in accordance to the
+respective command words defined in `CliSyntax`. Namely,
+* `edit-developer` will return an `EditDeveloperCommandParser` that parses the user input and creates an `EditDeveloperCommand`
+* `edit-client` will return an `EditClientCommandParser` that parses the user input and creates an `EditClientCommand`
+* `edit-project` will return an `EditProjectCommandParser` that parses the user input and creates an `EditProjectCommand`
+
+Each instance of `EditDeveloperCommand`, `EditClientCommand`, and `EditProjectCommand` objects have 2 private fields:
+1. an instance of `Index` containing the index of the target object to edit in the currently displayed list, and
+2. an instance of `EditDeveloperDescriptor`, `EditClientDescriptor`, or `EditProjectDescriptor` respectively, which
+ contains the edited fields to update the target object with.
+
+Executing the command will replace the existing object in the current `model` with the new object with the edited fields.
+
+Other than extending the commands, parsers, and descriptors to account for `Developer`, `Client`, and `Project` separately,
+some changes to the sequence of interactions between the `Logic` and `Model` components were also made. When
+`EditDeveloperCommand` and `EditClientCommand` is executed with edits made to a `Project` assigned to a `Developer` or
+`Client`, it calls `Model#areProjectsValid()` to check whether there is an existing `Project` with that name.
+
+Given below is an example usage scenario where the user edits the projects assigned to a `Developer` using the `edit-developer`
+command.
+
+**Step 1.** User launches the application and unlocks the application with the correct password.
+
+**Step 2.** User executes an edit developer command by entering `edit-developer 1 pr/AppleApp` to edit the projects assigned
+to the developer at index 1 (one-based indexing) in the currently displayed developer list.
+
+**Step 3.** The developer at index 1 is edited to be assigned to the project `AppleApp` given that there is an existing
+project with the name `AppleApp` in the address book.
-### \[Proposed\] Undo/redo feature
+The sequence diagram below illustrates key interactions taking place in the `Logic` component when the command
+`edit-developer 1 pr/AppleApp` is called. A significant modification to take note off is the call to the
+`Model#areProjectsValid()` method. The sequence diagram below reflects a successful command execution.
-#### 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:
+The `edit-client` and `edit-project` commands are executed similarly, except project validation checks using the
+`Model#areProjectsValid()` method are not conducted for the latter.
+
+#### Design considerations
+**Aspect: Command syntax**
+* **Alternative 1 (current choice)**: Have separate commands for each `Developer`, `Client`, and `Project`. Executing the command
+automatically switches user to the respective tab.
+ * Pros: More specific and straightforward, allowed parameters in command are easier to navigate for users. More flexible
+ as do not need to be in respective tab to edit.
+ * Cons: More classes to create, user needs to type more.
+* **Alternative 2**: Have one general `edit` command. The edit will be made based on the current tab displayed.
+ * Pros: User as can be less specific when typing command.
+ * Cons: User needs to ensure that intended tab is open. Allowed parameters are less clearly defined, can lead to
+ confusion and mistakes.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+
+### Find Feature (`find-developer`, `find-client`, `find-project`)
+
+#### Implementation
+
+The find feature is facilitated by a map-based strategy, associating specific prefixes (e.g., "find-developer n/" or "find-client r/") with corresponding predicates, allowing dynamic generation of filtering criteria based on user input.
+
+
+
+Implemented operations include:
+- `FindCommandParser#parse()`: Interprets the user's input and generates the appropriate predicate to filter the list of developers or clients.
+- `Model#updateFilteredPersonList()`: Updates the list displayed in the UI based on the provided predicate.
+
+Given below is an example usage scenario and how the find mechanism behaves at each step:
+
+**Step 1.** The user launches the application. The list of developers and clients are displayed.
+
+**Step 2.** To filter developers by name, the user executes the command `find-developer n/ alice bob`. The application recognizes the "developer n/" prefix and uses the `NameContainsKeywordsPredicate` to generate a filtering criteria. The list in the UI is updated to only display developers named Alice or Bob.
+
+**Step 3.** Next, the user wants to find clients from a specific organisation. They use the command `find-client o/Google`. The "find-client o/" prefix maps to the `OrganisationContainsKeywordsPredicate` and filters clients associated with Google.
+
+**Step 4.** If the user provides an unrecognized prefix, e.g., `find-developer z/ alice`, an error message is displayed informing them of the correct command format.
+
+> :information_source: **Note:** The following sequence diagram provides an overview of how the find operation is executed:
+
+The following sequence diagram provides an overview of how the find operation is executed
+
+
+
+
+
+
+#### Design considerations
+**Aspect:** Implementation of the predicate map:
+**Alternative 1:** +- Use a long chain of `if-else` conditions for each attribute. + - **Pros:** Explicit parsing logic for each attribute. + - **Cons:** Code becomes lengthy and hard to maintain. Adding a new attribute involves modifying the parsing logic, increasing the risk of errors. + +**Alternative 2 (current choice):** +- Use a map linking prefixes to their corresponding predicate constructors. + - **Pros:** Simplifies the parsing process. Adding a new attribute to search becomes as simple as adding a new entry in the map. + - **Cons:** A potential mismatch between the prefix and its predicate can lead to wrong results. + +Given the benefits of a more maintainable and scalable codebase, we've decided to go with the first alternative. Future enhancements might include fuzzy search. + + +[Scroll back to Table of Contents](#table-of-contents) + +### List Feature (`list-developer`, `list-client`, `list-project`) + +#### Implementation +The list command employs a structured approach where specific commands, such as `list-developer` or `list-client` +are associated with corresponding functionalities. This allows users to efficiently retrieve +information about developers, clients or projects by specifying the relevant prefix, streamlining the process of +generating targeted lists based on user input. + +Implemented operations include: +* `
:information_source: **Note:** If a command fails its execution, it will not call `Model#commitAddressBook()`, so the address book state will not 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.
+**Step 4.** The user now decides that adding the developer 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.
-:information_source: **Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather
-than attempting to perform the undo.
-
-
-
The following sequence diagram shows how the undo operation works:
+
-
-
-:information_source: **Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
-
-
+[Scroll back to Table of Contents](#table-of-contents)
+#### Implementation - redo
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.
:information_source: **Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest address book state, then there are no undone AddressBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
-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 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.
+#### 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.
-The following activity diagram summarizes what happens when a user executes a new command:
+* **Alternative 2 (part of current choice):** Individual command knows how to undo/redo by itself.
+ * Pros: Will use less memory (e.g. for `delete`, just save the developer being deleted).
+ * Cons: We must ensure that the implementation of each individual command are correct.
+ * Due to a special parameter `role` having its own add and delete functions which are separated from the
+ model and not stored in address book, it uses alternative 2 whereby `undo` an `add-developer-role` will just
+ execute the `delete-developer-role function`. The process of this implementation had to be very careful just like
+ what the cons mentioned, a slight validation error can change the whole `undo` and `redo` feature.
-
-#### Design considerations:
+[Scroll back to Table of Contents](#table-of-contents)
-**Aspect: How undo & redo executes:**
+### Add-role Feature (`add-developer-role`, `add-client-role`)
-* **Alternative 1 (current choice):** Saves the entire address book.
+#### Implementation
+The add role command employs a structured approach where specific commands, such as `add-developer-role` or
+`add-client-role`are associated with corresponding functionalities. This allows users to efficiently add
+information about developers and clients. One of the validation checks when adding a developer or client is that this role
+added must exist. This is where users will need this command to add in the respective roles. This feature is facilitated
+with the `DeveloperRoles` and `ClientRoles` class which implements the following operations:
+
+* `DeveloperRoles#addDeveloperRole()` — Adds a developer role into the list of roles stored
+* `DeveloperRoles#saveDeveloperRoles()` — Saves the updated list of developer roles
+* `DeveloperRoles#loadDeveloperRoles()` — Loads the existing list of developer roles from file
+* `DeveloperRoles#isValidRole()` — Checks if this role being added exists already
+
+The classes are similar for `ClientRoles` but just that they are associated with the clients.
+
+Given below is an example usage scenario and how the `add-developer-role` mechanism behaves at each step:
+
+**Step 1.** The user launches the application. The list roles for developers and clients are loaded into a list or roles.
+
+**Step 2.** The user executes the command `add-developer-role Tester`. The application recognizes the `add-developer-role`
+and calls `AddDeveloperRoleCommandParser#parse()`.
+
+**Step 3.** The parser checks if the argument is an empty blank space and trims the input given, in this case ` Tester` is
+trimmed to `Tester` and calls `AddDeveloperRoleCommand`.
+
+**Step 4.** `AddDeveloperRoleCommand#execute()` checks if there is an existing role with the same name and creates
+a new developer role if there is no such role.
+
+
+
+ :exclamation: **Note:**
+Although no changes is made to the address book, this stage is still committed so that the success command
+message and tab index switched to can be changed, the currentPointer can also note that there is an action done here.
+
+ :exclamation: **Note:**
+This is not a case-sensitive feature. The command allows users to add `developer` even if `Developer` exists.
+
+The following sequence diagram shows how the Add-role operation works:
+
+
+#### Design considerations
+**Aspect: How add-role executes:**
+* **Alternative 1 (current choice):** Treat role as a variable, has a separate load and unload list
+ * Pros: Role can just be treated as an attributed that needs more validation checks
+ * Cons: Have to load and unload each time system relaunches, quite time and memory consuming
+
+* **Alternative 2:** Treating role like another person or project, adding roles are like adding projects
* Pros: Easy to implement.
- * Cons: May have performance issues in terms of memory usage.
+ * Cons: Roles would have to be implemented on the same level as developers, clients and projects which should not be case.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+
-* **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.
+### Delete-role Feature (`delete-developer-role`, `delete-client-role`)
+
+#### Implementation
+The add role command employs a structured approach where specific commands, such as `delete-developer-role` or
+`delete-client-role`are associated with corresponding functionalities. This allows users to efficiently delete
+information about developers and clients that they no longer need. The system helps you to check if there are any
+developers or clients in the list using this feature. If there is, the command will not be successfully executed.
+This feature is facilitated with the `DeveloperRoles` and `ClientRoles` class which implements the following operations:
+
+* `DeveloperRoles#deleteDeveloperRole()` — Deletes a developer role into the list of roles stored
+* `DeveloperRoles#saveDeveloperRoles()` — Saves the updated list of developer roles
+* `DeveloperRoles#loadDeveloperRoles()` — Loads the existing list of developer roles from file
+* `DeveloperRoles#isRemovableRole()` — Checks if this role can be deleted; It should not be a pre-determined role,
+ it should not be a non-existing role, it should not be a role that is in use.
+
+The classes are similar for `ClientRoles` but just that they are associated with the clients.
+
+Given below is an example usage scenario and how the `delete-developer-role` mechanism behaves at each step:
+
+**Step 1.** The user launches the application. The list roles for developers and clients are loaded into a list or roles.
+
+**Step 2.** The user executes the command `delete-developer-role Tester`. The application recognizes the `delete-developer-role`
+and calls `DeleteDeveloperRoleCommandParser#parse()`.
+
+**Step 3.** The parser checks if the argument is an empty blank space and trims the input given, in this case ` Tester` is
+trimmed to `Tester` and calls `DeleteDeveloperRoleCommand`.
+
+**Step 4.** `DeleteDeveloperRoleCommand#execute()` checks if this is a removable role and removes it from the list of roles
+if `DeveloperRoles#isRemovableRole()` returns true.
+
+
-_{more aspects and alternatives to be added}_
+ :exclamation: **Note:**
+Although no changes is made to the address book, this stage is still committed so that the success command
+message and tab index switched to can be changed, the currentPointer can also note that there is an action done here.
-### \[Proposed\] Data archiving
+The following sequence diagram shows how the Delete-role operation works:
+
-_{Explain here how the data archiving feature will be implemented}_
+The following activity diagram shows how the validation check `isRemovableRole()` works:+
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+### Mark/unmark deadline Feature (`mark-deadline`, `unmark-deadline`)
+#### Implementation
+The mark and unmark deadline features are implemented using a secondary call to the `edit-project` command. As with
+the other commands, `mark-deadline` and `unmark-deadline` commands are first parsed to return `MarkDeadlineCommandParser`
+and `UnmarkDeadlineCommandParser` respectively. The parses similarly implement the `MarkDeadlineCommandParser#parse()`
+and `UnmarkDeadlineCommandParser#parse()` methods which return `MarkDeadlineCommand` and `UnmarkDeadlineCommand` objects
+respectively. However, in the execution of `MarkDeadlineCommand` and `UnmarkDeadlineCommand`, a new
+`EditProjectCommand` is created and subsequently executed, to get the `CommandResult`.
+
+Consequently, calling `mark-deadline` and `unmark-deadline` on a deadline of project is synonymous to editing the
+project to update the `isDone` status of the deadline.
+
+This is facilitated by the following methods:
+* `MarkDeadlineCommand#editProjectArgs()` — Formats each deadline in a list of String representations into a
+ String that will be used as the arguments parsed by an EditProjectCommandParser.
+* `Project#markDeadlineStringRep()` — Returns a list with each element being the String representation of the
+ respective deadline, with the deadline at the given index marked as done.
+* `Project#unmarkDeadlineStringRep()` — Returns a list with each element being the String representation of the
+ respective deadline, with the deadline at the given index marked as undone.
+
+Relevant checks are conducted at the `MarkDeadlineCommand#execute()` and `UnmarkDeadlineCommand#execute()` stages to
+ensure the index of the project and the edited deadline passed to the `EditProjectCommandParser` as arguments for the
+`EditProjectCommandParser#parse()` as arguments are valid.
+
+The following sequence diagram illustrates the interactions taking place in the `Logic` component when the command
+`mark-deadline 2 1` is called. The sequence reflects a successful command execution, assuming that the current state of
+the displayed project list has a project with the index `2` with at least `1` deadline.
+
+
+
+#### Design considerations
+**Aspect: Execution of command**
+* **Alternative 1**: Implement methods in `ModelManager` class that can directly change the `isDone` status of the deadlines
+ of a project based on the given project index and deadline index.
+ * Pros:
+ * More aligned with OOP principles.
+ * Mirrors sequence flow of other commands and can be implemented using current code architecture.
+ * Cons:
+ * Due to container structure of `Project` and `Deadline`, changing the status of deadlines needs to be done
+ through projects, so more methods need to be added to achieve this.
+ * Given the GUI display of project deadlines in a Javafx TableView, makes it more complicated for changes in
+ deadline status to be automatically reflected in the list of projects and deadlines displayed to the user.
+* **Alternative 2 (current choice)**: Implement execution by creating an `EditProjectCommandParser` and `EditProjectCommand`
+ that will replace the existing project entirely with a new one with the updated deadline being marked/unmarked.
+ * Pros:
+ * Fewer methods to implement, allows for more reuse.
+ * Editing the project with new deadlines will ensure that upon execution of the command, the updated project with
+ marked/unmarked deadline is displayed to the user on the app.
+ * Cons:
+ * Slightly more disorganised interactions within `Logic` component since have to go from parsing a command to
+ executing it, then parsing another command again and executing that command.
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+### GUI Feature
+
+#### Switching tabs automatically
+
+When certain commands are executed, the UI will automatically switch to the relevant tab. For example, when the user
+executes `list-developer`, the UI will automatically switch to the `Developer` tab. This is implemented by specifying
+the `TabIndex` in the `CommandResult` returned in the `execute()` method of the relevant command.
+
+#### Clicking to switch tabs
+
+When the user clicks on a different tab, the `list` command will be executed to display the relevant list of information
+for the tab clicked. This is implemented by adding a listener to the `TabPane` in the `MainWindow` class. When the
+selected tab changes, the `list` command will be executed.
+
+:exclamation: **Note:**
+When the user clicks away from the tab showing the command result and then switches back to the tab, the tab will
+be updated to show the full list of information for that tab again.
+
+
+[Scroll back to Table of Contents](#table-of-contents)
--------------------------------------------------------------------------------------------------------------------
+
+
## **Documentation, logging, testing, configuration, dev-ops**
+* [Documentation guide](https://ay2324s1-cs2103t-t09-2.github.io/tp/Documentation.html)
+* [Testing guide](https://ay2324s1-cs2103t-t09-2.github.io/tp/Testing.html)
+* [Logging guide](https://ay2324s1-cs2103t-t09-2.github.io/tp/Logging.html)
+* [Configuration guide](https://ay2324s1-cs2103t-t09-2.github.io/tp/Configuration.html)
+* [DevOps guide](https://ay2324s1-cs2103t-t09-2.github.io/tp/DevOps.html)
-* [Documentation guide](Documentation.md)
-* [Testing guide](Testing.md)
-* [Logging guide](Logging.md)
-* [Configuration guide](Configuration.md)
-* [DevOps guide](DevOps.md)
+[Scroll back to Table of Contents](#table-of-contents)
--------------------------------------------------------------------------------------------------------------------
+
## **Appendix: Requirements**
-### Product scope
-
+### Project Scope
**Target user profile**:
-* has a need to manage a significant number of contacts
+* has a need to manage a significant number of colleague contacts internally
* prefer desktop apps over other types
* can type fast
* prefers typing to mouse interactions
* is reasonably comfortable using CLI apps
+* a project manager or someone with similar needs working within a software company
-**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
-
+**Value proposition**: CodeContact aims to seamlessly integrate contact, client, and project management, simplifying
+access to coding-related contacts, facilitating collaboration, and offering command-line efficiency for project
+managers.
### User stories
+Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely) - `*`
+
+| Priority | As a … | I want to … | So that I can… |
+|----------|-----------------|------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
+| `* * *` | project manager | add a list of Developers and their contact information | access contact details easily and quickly assemble teams for new projects |
+| `* * *` | project manager | add a list of Clients and their contact information | access client details easily and know who is related to what project. |
+| `* * *` | project manager | add a list of Projects and their details | access project details easily and see who is related to the project |
+| `* * *` | project manager | delete information about a Client or Developer and the project details will update accordingly | don't repeat deleting several time |
+| `* * *` | project manager | edit the the details of the Developers added in | constantly update the contact book |
+| `* * *` | project manager | edit the the details of the Clients added in | constantly update the contact book |
+| `* * *` | project manager | edit the the details of the Projects added in | constantly update any changes to the project |
+| `* * *` | project manager | find the the Developers according to any details they have | source for information related to developers easily |
+| `* * *` | project manager | find the the Clients according to any details they have | source for information related to clients easily |
+| `* * *` | project manager | find the the Projects according to any details they have | source for information related to projects easily |
+| `* * *` | project manager | list different groups of people according to the different commands | view projects, clients and developers can be as different lists |
+| `* * *` | project manager | switch between tabs for Developers, Clients and Projects | intuitively view the different data lists |
+| `* * *` | project manager | import data from a csv | transfer data from what i am using right now |
+| `* *` | project manager | add roles | only add people to existing roles in the system so that i do not assign people to random roles |
+| `* *` | project manager | delete roles | remove roles that i think are not useful anymore |
+| `* *` | project manager | undo actions | undo any mistakes i made |
+| `* *` | project manager | redo actions | redo anything i accidentally undid |
+| `* *` | project manager | lock all the data | keep all these data safe |
+| `* *` | project manager | unlock all the data | see all these data after locking it |
+| `* *` | project manager | change password | access these data without worrying data might be stolen |
+| `* *` | project manager | find by deadline | sort out information by deadline due |
+| `* *` | project manager | mark deadline | label out completed deadlines as done |
+| `* *` | project manager | unmark deadline | label out incomplete or reactivated deadlines as undone |
+| `* ` | project manager | send reminder emails to the developers when deadlines are nearing | it can remind them that work is due soon |
+| `* ` | project manager | give developers feedback directly from CodeContact | reviews can be autogenerated trough my ratings and i need to write a new review each time |
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+
-Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
+### Use cases
-| 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 person | |
-| `* * *` | user | delete a person | remove entries that I no longer need |
-| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list |
-| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident |
-| `*` | user with many persons in the address book | sort persons by name | locate a person easily |
+For all use cases below, we assume the following unless specified otherwise
-*{More to be added}*
+- The **System** is `CodeContact`
+- The **Actor** is the `user`
+- The following preconditions
+ - The `user` has launched the `CodeContact` application.
-### Use cases
+Furthermore, a lot of **use cases are similar when manipulating
+developers, clients and projects**. Therefore, to keep the developer guide concise, the
+use cases elaborated upon below are only detailed for developers. Nonetheless, they
+can be extrapolated for clients and projects too, without changes to the major details within
+the use case. Such associated pairs of use cases are listed in the table below.
+
+| **Use Case** | **Developer command** | **Client command** | **Project command** |
+|--------------|:----------------------|:------------------:|:-------------------:|
+| UC3 | Add a developer | Add a client | Add a project |
+| UC4 | Delete a developer | Delete a client | Delete a project |
+| UC5 | Edit a developer | Edit a client | Edit a project |
+| UC6 | Find a developer | Find a client | Find a project |
+| UC7 | Add developer role | Add client role | - |
+| UC8 | Delete developer role | Delete client role | - |
-(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise)
+#### **Use case:** UC1 - Unlock System
-**Use case: Delete a person**
+**Preconditions:**
+1. User is not logged in
+
+**Guarantees:**
+1. The system will be unlocked and all data will be shown.
**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
+1. User requests unlock system with the password.
+2. System validates if user's inputs are correct.
+3. System logs user in.
Use case ends.
**Extensions**
-* 2a. The list is empty.
+* 2a. The password entered is incorrect.
+ * 2a1. System informs user password entered is incorrect and shows the default password.
+ * 2a2. User enters password
+ Steps 2a1-2a2 are repeated until the correct password is entered. +
Use case resumes from step 3. - Use case ends. +[Scroll back to Table of Contents](#table-of-contents) -* 3a. The given index is invalid. +#### **Use case:** UC2 - Change Password - * 3a1. AddressBook shows an error message. +**Preconditions:** +1. User is logged in - Use case resumes at step 2. +**Guarantees:** +1. The system password will be changed. -*{More to be added}* +**MSS** -### Non-Functional Requirements +1. User requests to change password with current password and new password as inputs. +2. System validates if user's new password fulfils the password criteria are correct. +3. System changes user's password. -1. Should work on any _mainstream OS_ as long as it has Java `11` or above 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. +Use case ends. -*{More to be added}* +**Extensions** -### Glossary +* 2a. The new password entered is blank or does not follow the format. + * 2a1. System informs user password entered does not follow the format. + * 2a2. User enters new password. +
Steps 2a1-2a2 are repeated until the correct password is entered. +
Use case resumes from step 3. +* 2b. The current password entered is incorrect. + * 2b1. System informs current password entered is incorrect. + * 2b2. User enters new password. +
Steps 2b1-2b2 are repeated until the correct password is entered. +
Use case resumes from step 3. +* 2c. The current password is same as new password. + * 2c1. System informs current password is same as new password. + * 2c2. User enters new password. +
Steps 2c1-2c2 are repeated until the new password is different. +
Use case resumes from step 3. -* **Mainstream OS**: Windows, Linux, Unix, OS-X -* **Private contact detail**: A contact detail that is not meant to be shared with others +[Scroll back to Table of Contents](#table-of-contents) --------------------------------------------------------------------------------------------------------------------- +#### **Use case:** UC3 - Add a developer -## **Appendix: Instructions for manual testing** +
:exclamation: **Note:**
+Adding developers, clients and projects have very similar use cases, hence it will not be repeated
-Given below are instructions to test the app manually.
+**Preconditions:** User is logged in
-:information_source: **Note:** These instructions only provide a starting point for testers to work on;
-testers are expected to do more *exploratory* testing.
+**Guarantees:**
+1. A new developer will be added to the system after every successful addition
-
+**MSS**
+
+1. User requests to add a developer.
+2. System requests for the details of the developer.
+3. User enters the requested details in the required format.
+4. System validates if the user's inputs are valid.
+6. System adds the developer to the data.
+
+ Use case ends.
+
+**Extensions**
+
+* 4a. The given details are invalid or in an invalid format.
+ * 4a1. System informs users specifically which data is wrong.
+ * 4a2. User enters new data.
+ Steps 4a1-4a2 are repeated until the data entered are correct. +
Use case resumes from step 5. + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC4 - Delete a developer +
:exclamation: **Note:**
+Deleting developers, clients and projects have very similar use cases, hence it will not be repeated
-### Launch and shutdown
+**Preconditions:** User is logged in
+
-1. Initial launch
+**Guarantees:**
+1. A developer deleted from the system after every successful delete
- 1. Download the jar file and copy into an empty folder
+**MSS**
+
+1. User requests to delete a developer.
+2. System requests for the index of the developer.
+3. User enters the index of the developer.
+4. System validates if the index is valid.
+5. System deletes the developer to the data.
+
+ Use case ends.
+
+**Extensions**
+
+* 4a. The index entered is an invalid number or is not a number.
+ * 4a1. System requests for the correct index
+ * 4a2. User enters new index
+ Steps 4a1-4a2 are repeated until the data entered are correct. +
Use case resumes from step 5. + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC5 - Edit a developer +
:exclamation: **Note:**
+Editing developer, client and project have very similar use case, hence it will not be repeated
+
+**Preconditions:** User is logged in
+
+**Guarantees:**
+1. A developer's details are edit from the system after every successful edit
+
+**MSS**
+
+1. User requests to edit a developer.
+2. System requests for the the index of the developer and details of what they wish to change.
+3. User enters the index of the developer and changed details.
+4. System validates if index is valid and checks if details changed is valid.
+5. System edits the developer's data.
+
+ Use case ends.
+
+
+
+**Extensions**
- 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
+* 4a. The index entered is an invalid number or is not a number.
+ * 4a1. System requests for the correct index.
+ * 4a2. User enters new index.
+ Steps 4a1-4a2 are repeated until the data entered are correct. +
Use case resumes from step 5. -1. Saving window preferences +* 4b. The details entered are the same as the existing details. + * 4a1. System informs users the details the same. + * 4a2. User enters new details. +
Steps 4b1-4b2 are repeated until the data entered are correct. +
Use case resumes from step 5. - 1. Resize the window to an optimum size. Move the window to a different location. Close the window. +* 4c. The details violate certain validation check and is not allowed to change to these details. + * 4a1. System informs users why the details cannot be changed. + * 4a2. User enters new details. +
Steps 4c1-4c2 are repeated until the data entered are correct. +
Use case resumes from step 5. - 1. Re-launch the app by double-clicking the jar file.
- Expected: The most recent window size and location is retained. +[Scroll back to Table of Contents](#table-of-contents) -1. _{ more test cases … }_ +#### **Use case:** UC6 - Find a developer +
:exclamation: **Note:**
+Finding developer, client and project have very similar use case, hence it will not be repeated
-### Deleting a person
+**Preconditions:** User is logged in
+
+**Guarantees:**
+1. A developer is found according to the details entered.
+
+**MSS**
+
+1. User requests to find a developer.
+2. System requests for the details user wishes to find by.
+3. User enters the details they wish to find by.
+4. System searches for developers that matches the details.
+5. System shows the relevant developer's data.
+
+ Use case ends.
+
+**Extensions**
+
+* 3a. There are no details entered.
+ * 3a1. System informs users input cannot be empty.
+ * 3a2. User enters new details.
+ Steps 3a1-3a2 are repeated until the data entered are correct. +
Use case resumes from step 4. + +* 3b. The details entered are incorrect (eg. entering alphabets when finding by phone). + * Use case just continues to step 4 but will show that no developers are found in step 5. + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC7 - Undo + +**Preconditions:** User is logged in + +**Guarantees:** +1. The previous command will be undone. + +**MSS** + +1. User requests undo. +2. System checks if there were any changes before. +3. System reverts the change. +
Use case ends. + +**Extensions** -1. Deleting a person while all persons are being shown +* 3a. There are no changes before + * 3a1. System informs users they have reached the first step +
Use case ends + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC8 - Redo + +**Preconditions:** User is logged in + +**Guarantees:** +1. The previous command undone will be redone. + +**MSS** + +1. User requests redo. +2. System checks if there were anything undone changes before. +3. System redoes the change. +
Use case ends. + + + +**Extensions** + +* 3a. There are no undone changes before + * 3a1. System inform users they have reached the last step +
Use case ends + +[Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC9 - Add developer role +
:exclamation: **Note:**
+Adding developer roles and client roles works the same way, hence add client role use case will not be repeated
+
+**Preconditions:** User is logged in
+
+**Guarantees:**
+1. A new developer role will be added.
+
+**MSS**
+
+1. User requests to add a developer role.
+2. User enters the role they want to add.
+3. System validates if user's inputs are valid.
+4. System validates if user's inputs can be added.
+5. System adds the developer to the data.
+
+**Extensions**
+
+* 3a. User enters an empty role
+ * 3a1. System informs users role cannot be empty and requests for the correct role
+ * 3a2. User enters new role
+ Steps 3a1-3a2 are repeated until the data entered is not empty +
Use case resumes from step 4. + +* 4a. User enters an existing role + * 4a1. System informs users this role exists + * 4a2. User enters new role +
Steps 4a1-4a2 are repeated until the data entered is not empty +
Use case resumes from step 5. + +[Scroll back to Table of Contents](#table-of-contents) + + + +#### **Use case:** UC10 - Delete developer role +
:exclamation: **Note:**
+Deleting developer roles and client roles works the same way, hence deleting client role use case will not be repeated
+
+**Preconditions:** User is logged in
+
+**Guarantees:**
+1. A developer role will be deleted.
+
+**MSS**
+
+1. User requests to delete a developer role.
+2. User enters the role they want to delete.
+3. System validates if user's inputs are valid.
+4. System validates if user's input can be deleted.
+5. System adds the developer to the data.
+
+**Extensions**
+
+* 3a. User enters an empty role
+ * 3a1. System informs users role cannot be empty and requests for the correct role
+ * 3a2. User enters correct role
+ Steps 3a1-3a2 are repeated until the data entered is not empty +
Use case resumes from step 4. + +* 4a. User enters a role that some developer is still using + * 4a1. System informs users this role cannot be deleted as there are developers using + * 4a2. User enters correct role +
Steps 4a1-4a2 are repeated until the data entered is can be deleted +
Use case resumes from step 5. + +* 4b. User enters a role that doesn't exist + * 4b1. System informs users this role don't exist + * 4b2. User enters correct role +
Steps 4a1-4a2 are repeated until the data entered is can be deleted +
Use case resumes from step 5. + +* 4b. User enters a role that cannot be deleted + * 4b1. System informs users this role cannot be deleted as it is a pre-defined role + * 4b2. User enters correct role +
Steps 4a1-4a2 are repeated until the data entered can be deleted +
Use case resumes from step 5. + +[Scroll back to Table of Contents](#table-of-contents) + + + +#### **Use case:** UC11 - Mark Deadline + +**Preconditions:** User is logged in + +**Guarantees:** +1. A project deadline will be marked. + +**MSS** + +1. User requests to mark the deadline of a project. +2. System requests for the index of the project and the index of the deadline. +3. User enters relevant indexes. +4. System validates if user's inputs exists. +5. System marks the deadline as done. + +**Extensions** + +* 3a. User enters an empty index + * 3a1. System informs users indexes should not be empty and requests for the correct role + * 3a2. User enters new indexes +
Steps 3a1-3a2 are repeated until the data entered is not empty +
Use case resumes from step 4. + +* 4a. User enters an invalid index (i.e no project with such index or no deadline in project with this index) + * 4a1. System informs users indexes are invalid + * 4a2. User enters new indexes +
Steps 4a1-4a2 are repeated until the data entered is not empty +
Use case resumes from step 5. + [Scroll back to Table of Contents](#table-of-contents) + +#### **Use case:** UC12 - Unmark Deadline + +**Preconditions:** User is logged in + +**Guarantees:** +1. A project deadline will be unmarked. + +**MSS** + +1. User requests to unmark the deadline of a project. +2. System requests for the index of the project and the index of the deadline. +3. User enters relevant indexes. +4. System validates if user's inputs exists. +5. System marks the deadline as undone. + +**Extensions** + +* 3a. User enters an empty index + * 3a1. System informs users indexes should not be empty and requests for the correct role + * 3a2. User enters new indexes +
Steps 3a1-3a2 are repeated until the data entered is not empty +
Use case resumes from step 4. + +* 4a. User enters an invalid index (i.e no project with such index or no deadline in project with this index) + * 4a1. System informs users indexes are invalid + * 4a2. User enters new indexes +
Steps 4a1-4a2 are repeated until the data entered is not empty +
Use case resumes from step 5. + [Scroll back to Table of Contents](#table-of-contents) + + + +### Non-Functional Requirements + +#### System/Performance Requirements +* Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
+#### Reliability Requirements +* Should be able to handle failures and show relevant error messages (hardware/network failures) +* Should ensure that data is protected from corruption or loss +* Should be able to recover immediately after inaccurate/invalid commands
+#### Usability Requirements +* Should follow specific code design and usability guidelines +* The user interface shall follow a consistent design pattern and layout throughout the application. +* There shall be clear and intuitive pathways for accomplishing common tasks. +* Users shall receive informative feedback on their actions (e.g., success messages, error messages) + in a clear and user-friendly manner. +* Context-sensitive help and tooltips shall be available to assist users in understanding complex features. +* A comprehensive user manual or online documentation shall be provided to explain how to use the application.
+#### Process Requirements +* The project is expected to adhere to a schedule that completes a milestone set every two weeks. +* The project shall follow an iterative breadth-first development methodology +* Automated testing suits shall be maintained and run for each build +* Code review shall be conducted for all new code contribution, with at least one team member + reviewing each piece of code before it is merged +* All project source code shall be stored in a version control system (e.g., Git), + and commits should follow a consistent naming convention. +* Coding standards and style guidelines shall be defined and followed consistently by all development team members.
+ +[Scroll back to Table of Contents](#table-of-contents) + +### Glossary + +| Term | Definition | +|----------------------|-----------------------------------------------------------------------------------------------------------| +| AddressBook-Level3 | A project created by the SE-EDU initiative, which this project is based on. | +| App | An application created by the project. | +| API | An application programming interface. | +| Architecture Diagram | A diagram that explains the high-level design of the App. | +| Class diagram | A diagram that shows the classes of the App and the relationships between them. | +| CLI | Command Line Interface, for users to perform actions through typing commands. | +| CommandBox | A component of the UI that allows users to enter commands. | +| Commons | A collection of classes used by multiple other components. | +| Component | A modular part of the App that serves a specific function. | +| ContactDisplay | A component of the UI that displays contact information. | +| GUI | Graphical User Interface, a visual way for users to interact with a software program | +| Logic component | The component responsible for executing user commands. | +| Main | A class with two subclasses, Main and MainApp, that initializes and shuts down the components of the App. | +| MainWindow | The main window of the UI that houses all the UI components. | +| Model | The data model used by the App. | +| Navigability | A concept referring to instances of one class holding a reference to instances of another class. | +| PlantUML | A tool used to create diagrams. | +| ResultDisplay | A component of the UI that displays the results of commands. | +| Sequence Diagram | A diagram that shows the sequence of events between components. | +| UML | [Unified Modeling Language](https://en.wikipedia.org/wiki/Unified_Modeling_Language) | + + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +## **Appendix: Manual Testing** +Given below are some instructions to test the app manually. + +
:information_source: **Note:** These instructions are meant to provide a
+starting point for testers to work with, testers should do more *exploratory* testing.
+
+
+### Launching the app
+#### 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 message prompting user to unlock to continue. +3. Enter the command `unlock pw/Password123!` in the command box.
+ Expected: Shows the unlocked GUI. + +### Lock +1. Test case: `lock`
+ Expected: All the information in the GUI has been hidden. The execution of all commands except `unlock`, `help`, and + `delete` have also been disabled. + +### Unlock +1. Test case: `unlock pw/Password123!`
+ Expected: Shows the unlocked GUI. +2. Test case: `unlock pw/abc`
+ Expected: GUI remains locked. Error details shown in the status message. + + + + +### Change password +1. Test case: `change-password pw/Password123! npw/Password321!`
+ Expected: Password is changed successfully. Command success status message shown. +2. Test case: `change-password pw/Password123! npw/abc`
+ Expected: Password is not changed. Error details shown in the status message. + +### Adding +#### Adding projects +1. Test case: `add-project n/JuiceApp dr/App to allow for different juices to be ordered + dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0`
+ Expected: New project with the name JuiceApp is created, provided there is no existing project with that name. + Command success status message shown. +2. Test case: `add-project n/JuiceApp dr/App to allow for different juices to be ordered + dl/invaliddeadline`
+ Expected: No project is added. Error details shown in the status message. + +#### Adding developers +1. Test case: `add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer + s/4500 d/11-11-2023 g/johng rt/3`
+ Expected: New developer with the name John Doe is created, provided there is no existing developer with that name. + Command success status message shown. +2. Test case: `add-developer n/John Does p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer + s/4500 d/11-11-2023 g/johng rt/6`
+ Expected: No developer is added. Error details shown in the status message. + +#### Adding clients +1. Prerequisites: Add a project with the name `AndroidApp` and another project with the name `CustomWebsite` before + testing. +2. Test case: `add-client n/Jack Doe p/98765432 e/jackd@example.com a/311, Clementi Ave 2, #02-25 r/Developer + pr/AndroidApp pr/CustomWebsite o/Google do/google.com`
+ Expected: New client with the name Jack Doe is created, provided there is no existing client with that name. + Command success status message shown. +3. Test case: `add-developer n/John Does p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer + pr/AndroidApp pr/CustomWebsite s/4500 d/11-11-2023 g/johng rt/6`
+ Expected: No developer is added. Error details shown in the status message. + +### Listing +1. Test case: `list-developer`
+ Expected: Lists all the developers. +2. Test case: `list-client`
+ Expected: Lists all the clients. +3. Test case: `list-project`
+ Expected: Lists all the projects. +4. Test case: `lists-project`
+ Expected: No change in GUI. Error details shown in the status message. + +### Deleting +#### Deleting projects +1. Prerequisites: List all projects using the `list-project` command. Ensure there is at least 1 project in the list. +2. Test case: `delete-project 1`
+ Expected: First project is deleted from the list. Command success status message shown. +3. Test case: `delete-project x` where `x` is an integer larger than the number of projects listed. + Expected: No change. Error details shown in the status message. + +#### Deleting developers +1. Prerequisites: List all developers using the `list-developer` command. Ensure there is at least 1 developer in the + list. +2. Test case: `delete-developer 1`
+ Expected: First developer is deleted from the list. Command success status message shown. +3. Test case: `delete-developer x` where `x` is an integer larger than the number of developers listed. + Expected: No change. Error details shown in the status message. + +#### Deleting clients +1. Prerequisites: List all clients using the `list-client` command. Ensure there is at least 1 client in the list. +2. Test case: `delete-client 1`
+ Expected: First client is deleted from the list. Command success status message shown. +3. Test case: `delete-client x` where `x` is an integer larger than the number of client listed. + Expected: No change. Error details shown in the status message. + +### Editing +#### Editing projects +1. Prerequisites: List all projects using the `list-project` command. Ensure there are at least 2 projects in the list. +2. Test case: `edit-project 1 dl/01-12-2023,Design backend,HIGH,0 dl/19-12-2023,Design frontend,HIGH,0`
+ Expected: First project in the list is successfully updated. Command success status message shown. +3. Test case: `edit-project 1 dr/update desc` + Expected: First project in the list is successfully updated. Command success status message shown. +4. Test case: `edit-project 2 dl/invaliddeadline` + Expected: Edit to the second project in the list is unsuccessful. Error details shown in the status message. + +#### Editing developers +1. Prerequisites: List all developers using the `list-developer` command. Ensure there are at least 2 clients in the + list. +2. Test case: `edit-developer 2 p/98989898`
+ Expected: Second developer in the list is successfully updated. Command success status message shown. +3. Test case: `edit-developer 1 s/-200`
+ Expected: Edit to the first developer in the list is unsuccessful. Error details shown in the status message. + +#### Editing clients +1. Prerequisites: List all clients using the `list-client` command. Ensure there is at least 1 client in the list. +2. Test case: `edit-client 1 p/98989898`
+ Expected: First client in the list is successfully updated. Command success status message shown. +3. Test case: `edit-developer 1 p/10`
+ Expected: No edit is made. Error details shown in the status message. + +### Importing information +#### Importing developers +1. Prerequisites: Create a CSV file populated with developer details in the correct format. Add the CSV file to the same + folder as JAR file of this app. +2. Test case: `import-developer developers.csv`
+ Expected: All developers with their details specified in the CSV are added, assuming the data in the file is in the + correct format. Command success status message shown. +3. Test case: `import-developer`
+ Expected: No developer is added. Error details shown in the status message. + +#### Importing clients +1. Prerequisites: Create a CSV file populated with client details in the correct format. Add the CSV file to the same + folder as JAR file of this app. +2. Test case: `import-client clients.csv`
+ Expected: All clients with their details specified in the CSV are added, assuming the data in the file is in the + correct format. Command success status message shown. +3. Test case: `import-client`
+ Expected: No client is added. Error details shown in the status message. + +### Undoing commands +For these tests, each test case has respective prerequisites that must be met before executing the test. +1. Prerequisites: Relaunch the app and unlock it with your password. Do NOT execute any other command after `unlock`. + 2. Test case: `undo`
+ Expected: Nothing is undone since no command has been executed yet. Error details shown in the status message. + +1. Prerequisites: Execute either an edit or delete command after unlocking the app. + 2. Test case: `undo`
+ Expected: The most recent command executed is undone. Command success status message shown. + +### Redoing commands +For these tests, each test case has respective prerequisites that must be met before executing the test. +1. Prerequisites: Relaunch the app and unlock it with your password. Do NOT execute any other command after `unlock`. +2. Test case: `redo`
+ Expected: Nothing is redone since no command has been executed yet. Error details shown in the status message. + +1. Prerequisites: Execute either an edit or delete command after unlocking the app, then execute the `undo` command. +2. Test case: `redo`
+ Expected: The changes from the recent `undo` command executed are reverted. Command success status message shown. + +### Adding roles +#### Adding Developer Roles +1. Test case: `add-developer-role UIDesigner`
+Expected: UIDesigner added as a role. Command status success message shown. +2. Test case: `add-developer-role Developer`
+Expected: No role added. Error details shows role cannot be added as it exists. +3. **Test Case 1 must be completed** `add-developer-role UIDesigner`
+Expected: No role added. Error details shows role cannot be added as it exists. + +#### Adding Client Roles +1. Test case: `add-client-role Tester`
+ Expected: Tester added as a role. Command status success message shown. +2. Test case: `add-client-role HR`
+ Expected: No role added. Error details shows role cannot be added as it exists. +3. **Test Case 1 must be completed** `add-developer-role Tester`
+ Expected: No role added. Error details shows role cannot be added as it exists. + + + +### Delete roles +#### Deleting Developer Roles +1. Prerequisite: role `UIDesigner` has been added in already (i.e. add in this role if it is after any of the test case) +2. Test case: `delete-developer-role UIDesigner`
+ Expected: UIDesigner deleted as a role. Command status success message shown. +3. Test case: assign the `UIDesigner` role to any developer, then execute `delete-developer-role UIDesigner`
+ Expected: No role deleted. Error details shows role cannot be deleted as there are developers using it. +4. Test case: `delete-developer-role Developer`
+ Expected: No role deleted. Error details shows role cannot be deleted as this is a pre-declared role. +5. Test case: **Test Case 1 must be completed** then execute `delete-developer-role UIDesigner`
+ Expected: No role deleted. Error details shows role cannot be deleted as it doesn't exist. + +#### Deleting Client Roles +1. Prerequisite: role `Tester` has been added in already (i.e. add in this role if it is after any of the test case) +2. Test case: `delete-client-role Tester`
+ Expected: Tester deleted as a role. Command status success message shown. +3. Test case: assign the `Tester` role to any client, then execute `delete-client-role Tester`
+ Expected: No role deleted. Error details shows role cannot be deleted as there are clients using it. +4. Test case: `delete-client-role HR`
+ Expected: No role deleted. Error details shows role cannot be deleted as this is a pre-declared role. +5. Test case: **Test Case 1 must be completed** then execute `delete-developer-role Tester`
+ Expected: No role deleted. Error details shows role cannot be deleted as it doesn't exist. + + + +### Finding +#### Finding projects +1. Prerequisites: List all projects using the `list-project` command. Multiple projects in the list. +2. Test case: `find-project pr/Laundry App`
+ Expected: Projects with the name, Laundry App, are shown on the list. Command success status message shown. +3. Test case: `find-developer Laundry App`
+ Expected: No search result due to error in format. No prefix provided before project name. Error details shown in the status message. + +#### Finding developers +1. Prerequisites: List all developers using the `list-developer` command. Multiple developers in the list. +2. Test case: `find-developer n/Alice`
+ Expected: Developers with the name, Alice, are shown on the list. Command success status message shown. +3. Test case: `find-developer Alice`
+ Expected: No search result due to error in format. No prefix provided before name. Error details shown in the status message. + +#### Finding clients +1. Prerequisites: List all clients using the `list-client` command. Multiple clients in the list. +2. Test case: `find-client o/Google`
+ Expected: Clients from the organisation, Google, are shown on the list. Command success status message shown. +3. Test case: `find-client Google`
+ Expected: No search result due to error in format. No prefix provided before organisation. Error details shown in the status message. + + + +### Marking project deadlines +#### Mark deadline as done +1. Prerequisites: List all projects using the `list-project` command. Multiple projects in the list. +2. Test case: `mark-deadline 1 2`
+ Expected: The second deadline of the first project in the currently displayed project list is marked as done. Command success status message shown. +3. Test case: `mark-deadline 1 x` where `x` is an integer larger than the number of deadlines for the project specified.
+ Expected: No change. Error details shown in the status message. + +#### Mark deadline as undone +1. Prerequisites: List all projects using the `list-project` command. Multiple projects in the list. +2. Test case: `unmark-deadline 1 2`
+ Expected: The second deadline of the first project in the currently displayed project list is marked as undone. Command success status message shown. +3. Test case: `unmark-deadline 1 x` where `x` is an integer larger than the number of deadlines for the project specified. + Expected: No change. Error details shown in the status message. + +### Exiting the app +1. After executing some commands, use the `exit` command to exit the app. +2. You can re-launch the app by double-clicking the jar file.
+ Expected: The application should load with any previous changes made during the previous running of the app. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +## **Appendix: Planned Enhancements** + +### Validation checks for duplicate fields in edit commands +**Current Behavior:** Two developers can have the same details (eg. address, phone number, email) as long as their name +is not the same. This program behaviour also exists for clients. +
+**Enhanced Behavior:** Validation checks should be conducted for email, contact number and address when adding or +editing developers or clients to make sure that no two developers or clients have repeated details since this is +unrealistic. + +### Validation checks for unedited fields in edit commands +**Current Behavior:** A developer, client, or project can be edited to have the exact same details as it currently has. +
+**Enhanced Behavior:** Validation checks should be conducted which notifies the user when they try to edit an existing +developer, client, or project, to have the exact same details as it currently has. This makes it more user-friendly as +if such an occurrence happens, it is likely that it was a mistake or typo in the command. + +### Case-sensitive validation checks for adding roles +**Current Behavior:** Two similar roles with different cases can both be added. `Developer` and `developer` can exist at the +same time.
+**Enhanced Behavior:** Two same words that are only differentiated by case should not be able to be added in as a role. + +### Deadlines cannot be any date +**Current Behavior:** Deadlines for projects can be any date such at year 0001.
+**Enhanced Behavior:** There should be a limit to the deadline line dates like 10-20 years before and after the current date. + +### Password Recovery +**Current Behavior:** If you forgot your password, there is no way to retrieve it
+**Enhanced Behavior:** Links the system to email or have verifications that allows users to reset their password. + +### Additional menu item for `import-developer` and `import-client` +**Current Behavior:** The import function is only available in CLI.
+**Enhanced Behavior:** A new menu item will be added under File called `Import developers` and `Import clients` +Clicking it will lead to a window to select the location of the respective file in csv format. +The backend implementation of logic follows the CLI implementation by creating a `ImportDeveloperCommand` or `ImportClientCommand` + +### Exporting data +**Current Behavior:** There is only import csv function and no options for export
+**Enhanced Behavior:** A new menu item will be added under File called `Export data` and clicking it will lead to a window +where users can select the location to save the files for Developers, Clients and Projects. The file will be saved in csv format. + +### Find Autocomplete +**Current Behavior:** While searching, users are not prompted for autocomplete suggestions. +**Enhanced Behavior:** Implement autocomplete suggestions as users type their search queries. This can help users avoid +typos and provide quick access to commonly used search terms. + +### Sort Results +**Current Behavior:** After each command, the list of contacts shown are based on the order the contact was added.
+**Enhanced Behavior:** Allow users to sort the search results based on different criteria such as name, date, or +priority. This provides users with more flexibility in organizing and viewing the search results. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. +## **Appendix: Effort** - 1. 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. +| Feature | AB3 | CodeContact | +|:---------------|:-----:|:-------------:| +| Effort | 10 | 30 | +| Lines of Code | 6k | +18k | - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. +The CodeContact project involved a significant effort to adapt the AddressBook-Level3 (AB3) application to a new domain of Developers, Clients and Projects in a Software Engineering setting. One of the major changes was the addition of three new models, Developer, Client and Project, which required modifying the existing data model and the associated logic components. Another significant change was the complete redesign of the user interface using JavaFX, which required a significant amount of time and effort to learn and implement. - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. +Firstly, although code was reused from AB3, a lot of it had to be refactored to fit our use case. We now had to deal with 3 entity types, Developer, Client and Project, which meant that the way we stored the information also had to change. Moreover, with more attributes for both `Developer` and `Client` classes, it also meant more effort in validating the inputs and writing high quality test cases for each attribute, an extremely time-consuming process. -1. _{ more test cases … }_ +The most significant challenge was implementing the logic for tabs within the user interface. Not only was it challenging to implement the tabs at the UI level, the integration of switching tabs based on the command executed was challenging as well. Careful and deliberate decisions were made for the action to take when switching tabs. For example, when switching to the `Developer` tab, the `list-developer` command is executed to show the list of developers. -### Saving data +Other challenges include the implementations of features that seem trivial on the surface level. Something that started as a validation check for valid developer and client roles, evolved to 4 commands allowing users to add and delete roles, and these roles had to be stored in separate files. This feature also affected the undo and redo commands, which had to explicitly check for commands involving roles as they are stored outside of `addressbook.json`. -1. Dealing with missing/corrupted data files +Due to limitations in the storage format in `addressbook.json`, we had to get creative in the way we store the associations between Developers, Clients and the projects they have been assigned to. We decided to store the associations in the `Developer` and `Client` classes themselves, which meant that we had to update the logic components to update the associations when a project is deleted. This was a significant change from AB3, which only had to deal with a single entity type. Other constraints had to be included such as not allowing names of Projects to be edited, and not allowing Developers and Clients to be assigned to Projects that do not exist. - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ +The effort required to implement the features in CodeContact was significantly more than AB3, which is reflected in the number of lines of code. However, the effort was well worth it as we were able to create a useful application that can be used by project managers to manage their projects and teams. -1. _{ more test cases … }_ +[Scroll back to Table of Contents](#table-of-contents) diff --git a/docs/Documentation.md b/docs/Documentation.md index 3e68ea364e7..0e33867d565 100644 --- a/docs/Documentation.md +++ b/docs/Documentation.md @@ -18,7 +18,7 @@ title: Documentation guide * Follow the [**_Google developer documentation style guide_**](https://developers.google.com/style). -* Also relevant is the [_[se-edu/guides] **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html) +* Also, relevant is the [_[se-edu/guides] **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html) **Diagrams:** diff --git a/docs/Logging.md b/docs/Logging.md index 5e4fb9bc217..26cbbb7d981 100644 --- a/docs/Logging.md +++ b/docs/Logging.md @@ -5,7 +5,10 @@ title: Logging guide * We are using `java.util.logging` package for logging. * The `LogsCenter` class is used to manage the logging levels and logging destinations. -* The `Logger` for a class can be obtained using `LogsCenter.getLogger(Class)` which will log messages according to the specified logging level. -* Log messages are output through the console and to a `.log` file. -* The output logging level can be controlled using the `logLevel` setting in the configuration file (See the [Configuration guide](Configuration.md) section). -* **When choosing a level for a log message**, follow the conventions given in [_[se-edu/guides] Java: Logging conventions_](https://se-education.org/guides/conventions/java/logging.html). +* The `Logger` for a class can be obtained using `LogsCenter.getLogger(Class)` which will log messages according to the + specified logging level. +* Log messages are output through the console and to a `.log` file. +* The output logging level can be controlled using the `logLevel` setting in the configuration file (See + the [Configuration guide](Configuration.md) section). +* **When choosing a level for a log message**, follow the conventions given in [_[se-edu/guides] Java: Logging + conventions_](https://se-education.org/guides/conventions/java/logging.html). diff --git a/docs/SettingUp.md b/docs/SettingUp.md index 275445bd551..2e8025d784a 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -4,8 +4,7 @@ title: Setting up and getting started --- * Table of Contents -{:toc} - + {:toc} -------------------------------------------------------------------------------------------------------------------- @@ -19,12 +18,17 @@ Follow the steps in the following guide precisely. Things will not work out if y First, **fork** this repo, and **clone** the fork into your computer. If you plan to use Intellij IDEA (highly recommended): -1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to to ensure Intellij is configured to use **JDK 11**. -1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA.
- :exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. + +1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the + JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to to ensure Intellij is configured to use **JDK 11 + **. +1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle + project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into + IDEA.
+ :exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. 1. **Verify the setup**: - 1. Run the `seedu.address.Main` and try a few commands. - 1. [Run the tests](Testing.md) to ensure they all pass. + 1. Run the `seedu.address.Main` and try a few commands. + 1. [Run the tests](Testing.md) to ensure they all pass. -------------------------------------------------------------------------------------------------------------------- @@ -32,24 +36,31 @@ If you plan to use Intellij IDEA (highly recommended): 1. **Configure the coding style** - If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match ours. + If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code + style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match + ours.
:bulb: **Tip:**
- Optionally, you can follow the guide [_[se-edu/guides] Using Checkstyle_](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use the CheckStyle within IDEA e.g., to report problems _as_ you write code.
+ Optionally, you can follow the guide [_[se-edu/guides] Using
+ Checkstyle_](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use the CheckStyle within IDEA
+ e.g., to report problems _as_ you write code.
1. **Set up CI**
- This project comes with a GitHub Actions config files (in `.github/workflows` folder). When GitHub detects those files, it will run the CI for your project automatically at each push to the `master` branch or to any PR. No set up required.
+ This project comes with a GitHub Actions config files (in `.github/workflows` folder). When GitHub detects those
+ files, it will run the CI for your project automatically at each push to the `master` branch or to any PR. No set up
+ required.
1. **Learn the design**
- When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [AddressBook’s architecture](DeveloperGuide.md#architecture).
+ When you are ready to start coding, we recommend that you get some sense of the overall design by reading
+ about [AddressBook’s architecture](DeveloperGuide.md#architecture).
1. **Do the tutorials**
These tutorials will help you get acquainted with the codebase.
- * [Tracing code](tutorials/TracingCode.md)
- * [Adding a new command](tutorials/AddRemark.md)
- * [Removing fields](tutorials/RemovingFields.md)
+ * [Tracing code](tutorials/TracingCode.md)
+ * [Adding a new command](tutorials/AddRemark.md)
+ * [Removing fields](tutorials/RemovingFields.md)
diff --git a/docs/Testing.md b/docs/Testing.md
index 8a99e82438a..96e849b4b4d 100644
--- a/docs/Testing.md
+++ b/docs/Testing.md
@@ -4,7 +4,7 @@ title: Testing guide
---
* Table of Contents
-{:toc}
+ {:toc}
--------------------------------------------------------------------------------------------------------------------
@@ -13,11 +13,11 @@ title: Testing guide
There are two ways to run tests.
* **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'`
+ * 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 test` (Mac/Linux: `./gradlew clean test`)
+ * Open a console and run the command `gradlew clean test` (Mac/Linux: `./gradlew clean test`)
:link: **Link**: Read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html) to learn more about using Gradle.
@@ -30,7 +30,9 @@ This project has three types of tests:
1. *Unit tests* targeting the lowest level methods/classes.e.g. `seedu.address.commons.StringUtilTest` -1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).
+1. *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` -1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
+1. 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` diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 57437026c7b..0741c92bd34 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1,197 +1,1459 @@ --- layout: page -title: User Guide +title: CodeContact User Guide --- +------------------------------------------------------------------------------------- +## Welcome to CodeContact +{: .no_toc} -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. +***Taking charge of your PROject Management!*** + +Seamlessly integrate contact, client, and project management, simplifying access to coding-related contacts, +facilitating collaboration, and offering command-line efficiency for project managers. + +CodeContact is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still +having the benefits of a Graphical User Interface (GUI). If you can type fast, CodeContact can get your contact +management tasks done faster than traditional GUI apps. **CodeContact** aims to put the **P.R.O** in project management by enabling project managers to be: + > **1. Productive** + > **2. Reliable** + > **3. Organised** + +Here’s an overview of how CodeContact can help you streamline your project management processes. +* Store and edit information about developers and clients related to projects. +* Store and manage projects and their deadlines. +* Assign projects to developers and clients. + +If you are familiar with CodeContact, jump to our [**Table of Contents**](#table-of-contents) to find out what you are looking +for! + +If you are new here, you may start with learning [**How to navigate this guide**](#navigating-this-guide) and visit +the [**Quick Start**](#quick-start) guide to onboard onto CodeContact smoothly! + +------------------------------------------------------------------------------------- + + +------------------------------------------------------------------------------------- +### How can this guide help me? +{: .no_toc} + +If you are a new user, we hope to first inform you on how you can [get started](#quick-start) using CodeContact. + +As you use CodeContact, you may also have questions on how to perform certain actions within the +application. This guide thus contains a comprehensive list of [Features](#features) offered with CodeContact, as well as +explanations on when and how to use them. + +Further questions are also answered within a [FAQ](#faq) section below. + +Confused about the terms or formatting used in this guide? Learn how to **navigate this guide** [here](#navigating-this-guide). + +Confused about the visual display of CodeContact? Learn how to **navigate the user interface** of CodeContact +[here](#navigating-the-graphical-user-interface-gui). + +------------------------------------------------------------------------------------- + + + +## Table of Contents +{: .no_toc} * Table of Contents {:toc} + + + +# **Navigating this guide** + + +## ***Glossary*** +------------------------------------------------------------------------------------- +### **Definitions** + +| Term | Definition | +|---------------|----------------------------------------------------------------------------------------------------------------------------| +| Parameter | Parameters are specific details you would include about the developer/client/project.(eg. name, date joined, description). | +| Command | An input from the user that tells CodeContact to perform an action (i.e. add a client). | +| GUI | Graphical User Interface (GUI) represents the visual display of CodeContact that users can see. | +| GUI Component | A subsection of the Graphical User Interface. For more information on specific GUI components, refer to [this section](). | +| CLI | Command Line Interface (CLI) represents a text-based user interface to interact with the application. | +| Character | Any letter or symbol that is recognized by the computer, and can form a line of text (eg. `a` , `+` , `$` ). | +| JSON | [Javascript Object Notation](https://en.wikipedia.org/wiki/JSON) | +| JAR file | [Java Archive File](https://en.wikipedia.org/wiki/JAR_(file_format)) | +| CSV file | [Comma-separated Values File](https://en.wikipedia.org/wiki/Comma-separated_values) | + +[Scroll back to Table of Contents](#table-of-contents) + +------------------------------------------------------------------------------------- +### **Parameter Information** + +Within the tables below, you can find out more about the parameters that CodeContact supports. These parameters come in +handy when crafting commands in CodeContact. + +Here are some notes about these parameters. + +* Each parameter comes with **constraints**. These constraints detail the specific formats of text that + each parameter accepts as valid user input. + * Not following these constraints will **result in an error** when entering the command. + * Nonetheless, CodeContact will not stop working. Rather, a message will be provided to you on + how to correct your command. + +#### Common Parameters for Developers and Clients + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---------------------------------------------| +| `n/` | name of developer/client | alphanumeric characters and spaces, and it should not be blank | Tom Hanks, Elizabeth 2 | 成龍, 潔 いさぎ 世 よ 一 いち, Ganesh s/o Ravichandran | +| `p/` | phone number of developer/client | 8 numeric characters, and it should not be blank | 94566835 | 123, 432, 5678@ | +| `e/` | email of developer/client | alphanumeric characters, contains an @ and it should not be blank | amy@gmail.com | amy!gmail.com, amy$gmail | +| `a/` | address of developer/client | alphanumeric characters and spaces, and it should not be blank | 311, Clementi Ave 2, #02-25 | 成龍, 潔 いさぎ 世 よ 一 いち | +| `r/` | role of developer/client | alphabetical characters and spaces, and it should not be blank | Developer | 成龍, 潔 いさぎ 世 よ 一 いち | +| `pr/` | project name | alphanumeric characters and spaces, and it should not be blank, used in the context or Developer/Client when assigned to project(s) | CS2103T | 成龍, 潔 いさぎ 世 よ 一 いち | + +#### Developer Specific Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|----------|------------------------------|--------------------------------------------------------------------------------------------------|----------------|----------------------| +| `g/` | github username of developer | alphanumeric characters, follows github username convention and it should not be blank | johng, amy123 | g, y | +| `d/` | date joined of developer | numeric characters in dd-MM-yyyy format, should not be a future date, and it should not be blank | 11-11-2023 | 19-11-2024, 1/1/2023 | +| `s/` | salary of developer | positive integers of at least 4 digits, should not be blank | 5000 | 5000.0, 4321.32.22 | +| `rt/` | rating of developer | numeric characters between 0 to 5 | 5, 3.5 | -0, -1, 6 | + + + +#### Client Specific Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|-----------------------------|---------------------------------------------------------------------------------------------------|----------------|------------------| +| `o/` | organisation name of client | alphanumeric characters and spaces, and it should not be blank | Google | 谷歌 | +| `do/` | document link of client | alphanumeric characters and spaces, and it should not be blank, follows standard hyperlink format | google.com | 谷歌.com | + +#### Project Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|------------------------|----------------------------------------------------------------|-------------------------------------------------|------------------------------------| +| `n/` | name of project | alphanumeric characters and spaces, and it should not be blank | CodeContact, oribtal23, Team Trekker | 成龍, 潔 いさぎ 世 よ 一 いち | +| `dr/` | description of project | alphanumeric characters and spaces, and it should not be blank | App to allow for different juices to be ordered | 成龍, 潔 いさぎ 世 よ 一 いち | +| `dl/` | deadline of project | alphanumeric characters and spaces, and it should not be blank | 19-12-2023, Design backend, HIGH, 0 | 19.1.2023, 潔 いさぎ 世 よ 一 いち, NONE, 5 | +| `pri/` | priority of deadline | HIGH, MEDIUM, LOW | HIGH, MEDIUM, LOW | 5, 3.5, -1, high, M | + + +### **Format** +------------------------------------------------------------------------------------- +#### General Formatting +Here are the explanations behind the formatting we use through this guide.
+ +* Words in `grey blocks (like these)` usually represent any of the following: + 1. Text used in commands, such as `add-developer`. + 2. Keys on your keyboard like `Enter`. + 3. File names such as `CodeContact.jar`. +
+
+:bulb: This is a blue box. It can be used for additional tips or more useful information.
+
+
+
+:exclamation: This is a warning box. It can be used to give more details on the warnings and limitations of features.
+
+
+#### Command Formatting
+
+| Format | Explanation | Example |
+|----------------------------------------------|--------------------------------------------------------------------|------------------------------------|
+| words in `UPPER_CASE` | **compulsory** parameter values that are supplied by the user | `add-developer n/NAME p/PHONE` |
+| words in `[UPPER_CASE]` with square brackets | **optional** parameter values that are supplied by the user | `add-developer n/NAME p/PHONE [d/DATE_JOINED]` |
+| Items with `…` after them | parameters that can be used **multiple times** | `add-developer [pr/PROJECT]...` |
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+-----------------------------------------------------------------------------------------------
+
+
+## ***Navigating the Graphical User Interface (GUI)***
+CodeContact comes with a GUI to allow for nice visual feedback for our users. Here is a quick run-through
+of the different sections of our GUI, as well as some notes regarding the use of the GUI.
+### Quick Orientation
+
++ + +**Here is a quick summary of each GUI component within CodeContact:** + +| Name | Description | +|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Menu Bar | Contains dropdown menu options for the CodeContact application. | +| Command Box | Allows users to enter CodeContact commands. | +| Result Display | 1. Provides CLI-based feedback upon a user command.
2. Allows users to see if their command was successful or not.
3. Provides error messages to guide users on how to use CodeContact commands. | +| Tabs | Allows users to see different lists of information on clicking on the relevant tabs. The tabs will also automatically switch to the correct tab corresponding to the command executed. | +| Developers/Clients/Projects card | Displays a list of Developer, Client or Project Cards. This list can be manipulated through commands like `find` and `list`. | +| Deadlines progress | Displays the progress of deadlines for a certain project. | +| Deadline list with details | Displays the details of the deadline in a table form. | +| Re-sort | Click on the respective words, there will be a small black arrow that appears. You can press to resort the data eg. show date from furthest to nearest day. | + +### Notes on GUI +
+If you executed a `find` command in developer tab and switched to the client tab, when you return to the developer tab the find results will be cleared and
+the whole list of developers will be shown again. This is the intended behavior of CodeContact as we hope that this can save you the time
+from always needing to call the list command.
+
+
--------------------------------------------------------------------------------------------------------------------
+
-## Quick start
+## ***Quick start***
1. Ensure you have Java `11` or above installed in your Computer.
-1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).
-1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
+2. Download the latest `CodeContact.jar`.
+
+
+3. Copy the file to the folder you want to use as the _home folder_ for your CodeContact.
+
+
+4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar CodeContact.jar`
+ command to run the application.+ -1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.
- A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
+5. A GUI similar to the below should appear in a few seconds. Note how the app might contain some sample data.
 -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: - * `list` : Lists all contacts. +6. For new users, learn to use CodeContact through our [Tutorial](#codecontact-tutorial--for-new-users-). + + +7. Refer to the [Features](#features) below for details of each command. + + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. - * `delete 3` : Deletes the 3rd contact shown in the current list. - * `clear` : Deletes all contacts. +## ***CodeContact Tutorial (for new users)*** - * `exit` : Exits the app. +This is a tutorial for **first-time** CodeContact users. -1. Refer to the [Features](#features) below for details of each command. +1. Launch CodeContact. You may refer to the instructions [here](#quick-start). + * On launch, CodeContact will not contain any developer or client records. +
+ + +2. You will be asked to **enter a password** to unlock CodeContact. + * Enter the command `unlock pw/Password123!` in the command box. +
+ + +3. You can **change the password** to unlock CodeContact. + * Enter the command `change-password pw/Password123! npw/
:bulb:
+You can always lock and unlock CodeContact using the `lock` and `unlock` commands.
+
+
+1. Let us try **adding a project** to our CodeContact.
+ * Enter the
+ command `add-project n/AndroidApp dr/App to allow for different juices to be ordered dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0 `.
+ + + +2. We can then **add a developer** to our CodeContact. + * Enter the + command `add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp s/4500 d/01-11-2023 g/johng rt/3`. + * Try adding more developers with different details for each parameter! + * Remember to add a new [project](#add-project--add-project) or [role](#add-roles) if you wish to add new developers with other roles and + project. +
+ + +3. We can also **add a client** to our CodeContact. + * Enter the + command `add-client n/Amy p/88765423 e/amy@example.com a/31, Clementi Ave 6, #03-12 r/Client pr/AndroidApp o/Google do/google.com`. + * Try adding more clients with different details for each parameter! + * Remember to add a new [project](#add-project--add-project) or [role](#add-roles) if you which to add new client with other roles and project. +
+ + +4. Let us try **editing the name** of a developer stored in CodeContact. + * Enter the command `edit-developer 1 n/Jhonny`. + * Try editing other parameters or developers and projects too! + * More details of what you can edit can be found [here](#edit). +
+ + +5. We can also easily **find** for information in CodeContact. + * Enter the command `find-developer n/John s/4500`. + * Try looking for other information and search with multiple parameters! + * More details of what you can find can be found [here](#find). +
+ + +6. You can always **show the full list** after finding in CodeContact. + * Enter the command `list-developer`, `list-client` or `list-project`. +
+ + +7. You can **delete developers, clients or projects** in CodeContact. + * Enter the command `delete-developer 3` to delete the 3rd developer in CodeContact. + * More details on how delete works can be found [here](#delete-developer--delete-developer). +
+ + +8. If you realise that you did not delete this developer, you can **undo** this action in CodeContact. + * Enter the command `undo` and it will revert your previous actions. +
+ + +9. If you realise you actually want it deleted, you can **redo** this action in CodeContact. + * Enter the command `redo` and it will redo your previous actions. +
+ + +Congratulations! You are now ready to use CodeContact! + +To view all our features, you may visit our [Features](#features) section. + +[Scroll back to Table of Contents](#table-of-contents) -------------------------------------------------------------------------------------------------------------------- + -## Features +# **Features** + + +| [Security Features](#security-features) | Locking Access to features | Unlocking Access to features | Changing personal password | +|:--------------------------------------------|:--------------------------:|:----------------------------:|:-----------------------------------------------------:| +| [Password Protection](#password-protection) | [`lock`](#lock-lock) | [`unlock`](#unlock-unlock) | [`change-password`](#change-password-change-password) | + +| [Management Features](#management-features) | Developer | Client | Project | +|:----------------------------------------------------|:-------------------------------------------------------------------------:|:----------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------:| +| [Adding new information](#add) | [`add-developer`](#add-developer--add-developer) | [`add-client`](#add-client--add-client) | [`add-project`](#add-project--add-project) | +| [Deleting information](#delete) | [`delete-developer`](#delete-developer--delete-developer) | [`delete-client`](#delete-client--delete-client) | [`delete-project`](#delete-project--delete-project) | +| [Editing information](#edit) | [`edit-developer`](#edit-developer-details--edit-developer) | [`edit-client`](#edit-client-details--edit-client) | [`edit-project`](#edit-project-details--edit-project) | +| [Importing information](#import-information) | [`import-developer` ](#import-developers-import-developer) | [`import-client`](#import-clients-import-client) | - | +| [Finding information](#find) | [`find-developer`](#find-developer-details) | [`find-client`](#find-client-details) | [`find-project`](#find-project-details), [`find-deadline`](#find-deadlines-find-deadline) | +| [Listing information](#listing-information--list) | `list-developer` | `list-client` | `list-project` | +| [Adding new role](#add-roles) | [`add-developer-role`](#add-developer-roles--add-developer-role) | [`add-client-role`](#add-client-roles--add-client-role) | - | +| [Deleting role](#delete-roles) | [`delete-developer-role`](#delete-developer-roles--delete-developer-role) | [`delete-client-role`](#delete-client-roles--delete-client-role) | - | +| [Marking Project Deadlies](#mark-project-deadlines) | - | - | [`mark-deadline`](#mark-deadline-as-done--mark-deadline), [`unmark-deadline`](#mark-deadline-as-undone--unmark-deadline) | + +| [Additional Features](#additional-features) | Finding Help | Clearing data | Exiting program | +|:--------------------------------------------------|:---------------------------------------:|:-----------------------------------------------------:|:-------------------------------------------------:| +| [Miscellaneous Features](#miscellaneous-features) | [View Help `help`](#viewing-help--help) | [Clear entries `clear`](#clearing-all-entries--clear) | [Exit program `exit`](#exiting-the-program--exit) | + +-------------------------------------------------------------------------------------------------------------------- + + +## ***Security Features*** + +-------------------------------------------------------------------------------------------------------------------- +### **Password Protection** + +> **Grant yourself exclusive access and deny access by others to CodeContact with a personal and +> customizable password.** + + +#### Lock : `lock` + +> Locks the system and hides all the information, denying access to all information and commands +> except `unlock`, `help`, and `delete`. + +**Format:** `lock` + +**Example of usage:** `lock` + +When command succeeds, CLI shows: + +``` +Locked all data +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Unlock : `unlock` + +> Unlocks the system by granting access to all information and commands. + +**Format:** `unlock pw/CURRENT_PASSWORD` + +**Constraints:** +1. Only unlocks if password exactly matches the current password (which is the last set password). + * Note: The default password is `Password123!`. It is highly recommended to change to a different password with the [`change-password` command](#change-password--change-password). + +**Example of usage:** `unlock pw/Password123!` + +When command succeeds, CLI shows: +``` +Unlocked all data +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Change password : `change-password` + +> Changes the current password so that the password is kept personal. + +**Format:** `change-password pw/CURRENT_PASSWORD npw/NEW_PASSWORD` + +**Constraints:** +1. `CURRENT_PASSWORD` entered must exactly match the current password. + * Note: The default password is `Password123!`. + +2. `NEW_PASSWORD` must be at least 8 characters long and contain at least one digit, one lowercase letter, + one uppercase letter, and one special character. + +**Example of usage:** `change-password pw/Password123! npw/NewPass987!` + +When command succeeds, CLI shows: +``` +Password changed successfully. +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +## ***Management Features*** + +-------------------------------------------------------------------------------------------------------------------- +### **Add** +> **Your accessible command to easily add relevant project details into CodeContact.** -
-**:information_source: Notes about the command format:**
+#### Add developer : `add-developer` -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +> Adds a new developer to the address book with the entered details. -* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +**Format:** +`add-developer n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [d/DATE_JOINED] r/ROLE s/SALARY [pr/PROJECT_NAME]... g/GITHUB_ID rt/RATING` -* Items with `…` after them can be used multiple times including zero times.
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. +**Constraints:** +1. `NAME` cannot be the same as another existing developer's name in the address book. Checks are case-insensitive. +2. `PROJECT_NAME` should be the exact name of an existing project if specified. +If project to be assigned does not exist, consider [adding the project](#add-project--add-project) first! -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. +**Optional Fields:** + 1. `PROJECT_NAME` - if prefix pr/ is missing in the command, the added developer will not be assigned to any projects. -* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. + 2. `DATE_JOINED` - if prefix d/ is missing in the command, the added developer's date joined field will automatically reflect today's date. + + + +* Note that for `RATING` values that are not in increments of 0.5 (eg. 3.2 or 3.8 instead of 3.0 or 3.5), the decimal portion + may not be reflected as clearly in the coloured stars. + + +**Example of usage:** +`add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer +pr/AndroidApp pr/CustomWebsite s/4500 d/11-11-2023 g/johng rt/3` + + +* A new developer, `John Doe`, is added with the respective details. +* He is assigned to the projects `AndroidApp` and `CustomWebsite` (provided that these projects already exist in the address book). + + +When command succeeds, CLI shows: +``` +New developer added: John Doe; +Phone: 98765432; +Email: johnd@example.com; +Address: 311, Clementi Ave 2, #02-25; +Date Joined: 11-11-2023; +Role: Developer; +Salary: 4500; +Projects: CustomWebsite AndroidApp +``` + +
+#### Add developer : `add-developer` -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +> Adds a new developer to the address book with the entered details. -* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +**Format:** +`add-developer n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [d/DATE_JOINED] r/ROLE s/SALARY [pr/PROJECT_NAME]... g/GITHUB_ID rt/RATING` -* Items with `…` after them can be used multiple times including zero times.
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. +**Constraints:** +1. `NAME` cannot be the same as another existing developer's name in the address book. Checks are case-insensitive. +2. `PROJECT_NAME` should be the exact name of an existing project if specified. +If project to be assigned does not exist, consider [adding the project](#add-project--add-project) first! -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. +**Optional Fields:** + 1. `PROJECT_NAME` - if prefix pr/ is missing in the command, the added developer will not be assigned to any projects. -* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. + 2. `DATE_JOINED` - if prefix d/ is missing in the command, the added developer's date joined field will automatically reflect today's date. + + + +* Note that for `RATING` values that are not in increments of 0.5 (eg. 3.2 or 3.8 instead of 3.0 or 3.5), the decimal portion + may not be reflected as clearly in the coloured stars. + + +**Example of usage:** +`add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer +pr/AndroidApp pr/CustomWebsite s/4500 d/11-11-2023 g/johng rt/3` + + +* A new developer, `John Doe`, is added with the respective details. +* He is assigned to the projects `AndroidApp` and `CustomWebsite` (provided that these projects already exist in the address book). + + +When command succeeds, CLI shows: +``` +New developer added: John Doe; +Phone: 98765432; +Email: johnd@example.com; +Address: 311, Clementi Ave 2, #02-25; +Date Joined: 11-11-2023; +Role: Developer; +Salary: 4500; +Projects: CustomWebsite AndroidApp +``` + +
:bulb:
+Entered details of a developer incorrectly? You can always undo the action with the [`undo`](#undo) command!
-### Viewing help : `help`
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Add client : `add-client`
+
+> Adds a new client to the address book, with the entered details.
+
+**Format:**
+`add-client n/NAME p/PHONE e/EMAIL a/ADDRESS r/ROLE [pr/PROJECT]... o/ORGANISATION do/DOCUMENT`
-Shows a message explaning how to access the help page.
+**Constraints:**
+1. `NAME` cannot be the same as another existing client's name in the address book. Checks are case-insensitive.
-
+2. `PROJECT_NAME` should be the exact name of an existing project if specified.
+If project to be assigned does not exist, consider [adding the project](#add-project--add-project) first!
-Format: `help`
+**Optional Fields:**
+1. `PROJECT_NAME` - if prefix pr/ is missing in the command, the added developer will not be assigned to any projects.
+**Example of usage:**
+`add-client n/Jack Doe p/98765432 e/jackd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp pr/CustomWebsite o/Google do/google.com`
-### Adding a person: `add`
-Adds a person to the address book.
+* A new client, `Jack Doe`, is added with the respective details
+* He is assigned to the projects `AndroidApp` and `CustomWebsite` (provided that these projects already exist in the address book).
-Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
-:bulb: **Tip:**
-A person can have any number of tags (including 0)
+When command succeeds, CLI shows:
+
+```
+New client added: Jack Doe;
+Phone: 98765432;
+Email: jackd@example.com;
+Address: 311, Clementi Ave 2, #02-25;
+Organisation: Google;
+Role: Developer;
+Document: google.com;
+Projects: CustomWebsite AndroidApp
+```
+
+
-  +Example of valid CSV: -### Deleting a person : `delete` +``` +Name, Contact Number, Email, Address, Date Joined, Role, Salary, GithubId, Rating, Projects,, +faiz,87654321,faiz@u.com,utown,12-12-2020,Developer,3333,Faizgit,5,AndroidApp,ProjectB, +John,123456789,john@email.com,123 Main St,01-01-2021,Developer,4000,JohnDesigns,4,AndroidApp,ProjectB, +Sarah,987654321,sarah@email.com,456 Elm St,05-10-2019,Developer,6000,SarahManager,5,AndroidApp,ProjectB,ProjectC +Alex,555555555,alex@email.com,789 Oak St,03-01-2022,Developer,5500,AlexDev,4,AndroidApp,ProjectB, +Emily,111111111,emily@email.com,321 Pine St,08-10-2018,Developer,4800,EmilyAnalyst,4,AndroidApp,ProjectB, +Michael,999999999,michael@email.com,567 Birch St,06-03-2020,Developer,7000,MichaelEngineer,5,AndroidApp,ProjectB, +``` -Deletes the specified person from the address book. +**Example of usage:** `import-developer developers.csv` -Format: `delete INDEX` +Reads `developers.csv` and adds a new developer for each row of data. -* Deletes the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, … +When command succeeds, CLI shows: +``` +New developer added: faiz; +Phone: 87654321; +Email: faiz@u.com; +Address: utown; +Date Joined: 12-12-2020; +Role: Developer; +Salary: 3333; +Projects: ProjectB AndroidApp +``` +for each developer successfully added. -Examples: -* `list` followed by `delete 2` deletes the 2nd person in the address book. -* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. +[Scroll back to Table of Contents](#table-of-contents) -### Clearing all entries : `clear` +-------------------------------------------------------------------------------------------------------------------- +#### Import clients' details : `import-client` + +Reads a CSV file and populates the addressbook with the clients provided. + +**Command Format:** `import-client FILENAME` + +**Column Header Format (for CSV file):** `Name`, `Contact Number`, `Email`, `Address`, `Role`, `Organisation`, `Document`, `Projects` + + +**Constraints:** +1. The CSV file has to be in the same folder as the JAR file for the command to function correctly. + +2. The CSV file has to strictly follow the column header names and order (given in the example). + The entire command will abort if any of column headers do not follow the given format. -Clears all entries from the address book. +3. `NAME` and `PROJECT_NAME` fields for clients to be added via the import feature have the same constraints as the [`add-client` command](#add-client--add-client) constraints. The entire command will abort if any of the rows have invalid values that do not comply with given constraints. -Format: `clear` +**Optional Fields:** +While the `PROJECT` column header is compulsory, it is an optional fields, where values (corresponding to the client to be added) under this column can be empty. -### Exiting the program : `exit` +If values under the `PROJECT` column are empty, corresponding clients will be added with no projects assigned to them, like the [`add-client` command](#add-client--add-client). -Exits the program. -Format: `exit` +Example of valid CSV: +``` +Name, Contact Number, Email, Address, Role, Organisation, Document, Projects, +Mahi,87554321,mahi@u.com,utown,HR,Google,docs.google.com/abd,AndroidApp,ProjectB +Jane,654321876,jane@email.com,456 Oak St,HR,Acme Corp,acme.com/docs,AndroidApp +Robert,987123456,robert@email.com,789 Elm St,HR,Tech Solutions,techdocs.com/123 +Maria,321987654,maria@email.com,123 Maple St,HR,Innovate Inc,innovate.com/docs +Chris,876543219,chris@email.com,567 Pine St,HR,Data Insights,datainsights.com/docs +Laura,888555555,laura@email.com,101 Birch St,HR,Software Systems,software.com/docs +``` -### Saving the data +**Example of usage:** `import-client clients.csv` + +Reads `clients.csv` and adds a new client for each row of data. + +When command succeeds, CLI shows: + +``` +New client added: Mahi; +Phone: 87554321; +Email: mahi@u.com; +Address: utown; +Organisation: Google; +Role: HR; +Document: docs.google.com/abd; +Projects: ProjectB AndroidApp +``` + +for each client successfully added. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + -AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +### **Find** + +> **Your go-to command to quickly access precise information in CodeContact.** + + +#### Find developer details : `find-developer` + +> Finds the details of an existing developer in the address book. + +**Format:** +`find-developer [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] +[r/ROLE] [s/SALARY] [pr/PROJECT_NAME] [g/GITHUB_ID] [rt/RATING]` + +**Additional notes:** +* Finds for developers based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +**Example of usage:** +`find-developer pr/2103T rt/5.0` + +* Prints developers in 2103/T project with a 5-star rating. + +When command succeeds, CLI shows: + +``` +This is the one developer with matching information. +``` + + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Find client details : `find-client` + +> Finds the details of an existing client in the address book. + +**Format:** +`find-client [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [o/ORGANISATION] [pr/PROJECT] [d/DOCUMENT]` + +**Additional notes:** +* Finds for clients based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +**Example of usage:** +`find-client o/Google r/Senior developer` + +* Prints clients from Google with the Senior developer role. + +When command succeeds, CLI shows: + +``` +These are the 2 clients with matching information. +``` + + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Find project details : `find-project` -### Editing the data file +> Finds the details of an existing project in the address book. -AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. +**Format:** `find-project [pr/PROJECT_NAME] [dr/DESCRIPTION] [dl/DEADLINE]` -
:bulb:
+Entered details of a client incorrectly? You can always undo the action with the [`undo`](#undo) command!
-Examples:
-* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
-* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal`
+[Scroll back to Table of Contents](#table-of-contents)
-### Listing all persons : `list`
+--------------------------------------------------------------------------------------------------------------------
+#### Add project : `add-project`
-Shows a list of all persons in the address book.
+> Adds a new project and its relevant deadlines to the address book, with the entered details.
-Format: `list`
+**Format:**
+`add-project n/NAME dr/DESCRIPTION [dl/DEADLINE_DATE,DEADLINE_DESCRIPTION,PRIORITY,IS_DONE]...`
-### Editing a person : `edit`
+**Constraints:**
+1. `NAME` cannot be the same as another existing project's name in the address book. Checks are case-insensitive.
-Edits an existing person in the address book.
+**Optional Fields:**
+1. `DEADLINE` - if prefix dl/ is missing in the command, the added project will not have any deadlines assigned to it.
-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
+**Example of usage:**
+`add-project n/JuiceApp dr/App to allow for different juices to be ordered dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0`
-* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …
-* At least one of the optional fields must be provided.
+
+* A new project, `JuiceApp`, is added with the respective details.
+* Deadlines with the descriptions `Design backend` and `Design frontend` are created and assigned to the newly added project.
+
+
+When command succeeds, CLI shows:
+
+```
+New project added: JuiceApp;
+Description: App to allow for different juices to be ordered;
+Deadlines:
+1. Design backend by: 19-12-2023, priority: HIGH (undone)
+2. Design frontend by: 25-12-2023, priority: MEDIUM (undone)
+```
+
+:bulb:
+Entered details of a project incorrectly? You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+### **Delete**
+> **Your quick command to delete project details effectively into CodeContact.**
+
+
+#### Delete developer : `delete-developer`
+
+> Deletes developer in the address book and their respective list.
+
+**Format:** `delete-developer INDEX`
+
+**Constraints:**
+1. `INDEX` cannot be greater than the number of developers in the list.
+
+**Example of usage:** `delete-developer 2`
+
+When command succeeds, CLI shows:
+
+```
+Deleted Developer: Bernice Yu;
+Phone: 99272758;
+Email: berniceyu@example.com;
+Address: Blk 30 Lorong 3 Serangoon Gardens, #07-18;
+Date Joined: 16-11-2020;
+Role: Developer;
+Salary: 6000;
+Projects: Appollo Orbital
+```
+if second developer in the list was Bernice Yu.
+
+:bulb:
+Deleted a wrong developer? You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+#### Delete client : `delete-client`
+
+> Deletes client in the address book and their respective list.
+
+**Format:** `delete-client INDEX`
+
+**Constraints:**
+1. `INDEX` cannot be greater than the number of clients in the list.
+
+**Example of usage:** `delete-client 3`
+
+When command succeeds, CLI shows:
+```
+Deleted Client: George Lim;
+Phone: 76543210;
+Email: george@example.com;
+Address: Blk 789 Woodlands Ave 6, #03-03;
+Organisation: MNO Company;
+Role: Developer;
+Document: https://www.mno.com/;
+Projects: CodeContact
+```
+if second client in the list was George Lim.
+
+:bulb:
+Deleted a wrong client? You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+#### Delete project : `delete-project`
+
+> Deletes the details of an existing project in the address book and their respective list.
+> Updates developer and client project details accordingly.
+
+**Format:** `delete-project INDEX`
+
+**Constraints:**
+1. `INDEX` cannot be greater than the number of projects in the list.
+
+**Example of usage:** `delete-project 2`
+
+
+* Deletes second project in the project list from the project list and from the address book.
+* Deletes project from developers' and clients' project lists if they were assigned to this project.
+
+
+When command succeeds, CLI shows:
+```
+Deleted Project: TeamTrekker;
+Description: A team collaboration tool;
+Deadlines:
+1. Phase 2 by: 13-11-2021, priority: MEDIUM (undone)
+```
+if second project in the list was TeamTrekker.
+
+
+:exclamation: **Note**: This command deletes **project from developers' and clients' project lists** if they were assigned to this project.
+
+
+
+:bulb:
+Deleted a wrong project? You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+### **Edit**
+> **Your quick and accessible CodeContact command to edit your ever changing project details**
+
+
+#### Edit developer details : `edit-developer`
+
+> Edits the details of an existing developer in the address book.
+
+**Format:**
+`edit-developer INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME]... [g/GITHUB_ID] [rt/RATING]`
+
+**Constraints:**
+1. `NAME` cannot be the same as another existing developer's name in the address book. Checks are case-insensitive.
+ You can, however, edit the casing of an existing developer's `NAME`.
+2. `PROJECT_NAME` should be the exact name of an existing project.
+3. At least one of the optional fields must be provided.
+
+**Additional Notes:**
* Existing values will be updated to the input values.
-* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
-* You can remove all the person’s tags by typing `t/` without
- specifying any tags after it.
+* When editing projects, the existing assigned projects of the developer will be removed i/e. adding of projects is not
+ cumulative.
+* You can remove all the developer's projects by typing `pr/` without specifying any project name after it.
+* `RATING` values that not in increments of 0.5 (eg. 3.2 or 3.8 instead of 3.0 or 3.5), the decimal portion
+ may not be reflected as clearly in the coloured stars.
+
+**Example of usage:**
+`edit-developer 2 p/98989898 pr/Project2 pr/Project3`
+
+* Edits `Amy`'s phone number to `98989898` and changes the projects assigned to her to `Project2` and `Project3`.
+
+When command succeeds, CLI shows:
+
+```
+Edited Developer: Amy
+Phone: 98989898
+Email: amy@u.nus.edu
+Address: NUS UTOWN
+Date Joined: 06-09-2023
+Role: Developer
+Salary: 6999
+Projects: Project3 Project2
+```
+
+:bulb:
+You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Edit client details : `edit-client`
+
+> Edits the details of an existing client in the address book.
+
+**Format:**
+`edit-client INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [pr/PROJECT_NAME]... [o/ORGANISATION]`
+
+**Constraints:**
+1. `NAME` cannot be the same as another existing client's name in the address book. Checks are case-insensitive.
+ You can, however, edit the casing of an existing client's `NAME`.
+2. `PROJECT_NAME` should be the exact name of an existing project.
+3. At least one of the optional fields must be provided.
+
+**Additional Notes:**
+* Existing values will be updated to the input values.
+* When editing projects, the existing assigned projects of the client will be removed i/e. adding of projects is not
+ cumulative.
+* You can remove all the client's projects by typing `pr/` without specifying any project name after it.
+* `RATING` values that not in increments of 0.5 (eg. 3.2 or 3.8 instead of 3.0 or 3.5), the decimal portion
+ may not be reflected as clearly in the coloured stars.
+
+**Example of usage:**
+`edit-client 3 e/bob@gmail.com`
+
+* Edits `Bob`'s email to `bob@gmail.com`.
+
+When command succeeds, CLI shows:
+
+```
+Edited Client: Bob;
+Phone: 87654321;
+Email: bob@gmail.com;
+Address: Blk 123 Banana Road;
+Organisation: Google;
+Document: google.com
+Projects: ProjectA
+```
+:bulb:
+You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Edit project details : `edit-project`
+
+> Edits the details of an existing project in the address book.
+
+**Format:**
+`edit-project INDEX [dr/DESCRIPTION] [dl/DEADLINE]...`
+
+**Constraints:**
+1. The name of a project cannot be edited.
+2At least one of the optional fields must be provided.
+
+**Additional Notes:**
+* Existing values will be updated to the input values.
+* When editing deadlines, the existing deadlines will be removed ie. adding of projects is not cumulative.
+* You can remove all the current deadlines by typing `dl/` without specifying any deadline.
+
+**Example of usage:**
+`edit-project 1 dl/19-12-2023,Design backend,HIGH,0`
-Examples:
-* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively.
-* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
+* Deletes existing project deadlines and adds new deadline `Design backend by: 19-12-2023, priority: HIGH (undone)`.
-### Locating persons by name: `find`
+When command succeeds, CLI shows:
-Finds persons whose names contain any of the given keywords.
+```
+Edited Project: JuiceApp;
+Description: Juice ordering app;
+Deadlines:
+1. Design backend by: 19-12-2023, priority: HIGH (undone)
+```
+:bulb:
+You can always undo the action with the [`undo`](#undo) command!
+
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+### **Import**
+> **Your lightning-fast and reliable way of porting over existing project details into CodeContact.**
+
+
+#### Import developers' details : `import-developer`
+
+> Reads a CSV file and populates the addressbook with the developers provided.
+
+**Command Format:** `import-developer FILENAME`
+
+**Column Header Format (for CSV file):** `Name`, `Contact Number`, `Email`, `Address`, `Date Joined`, `Role`, `Salary`, `GithubId`, `Rating`, `Projects`
+
+**Constraints:**
+1. The CSV file has to be in the same folder as the JAR file for the command to function correctly.
+
+2. The CSV file has to strictly follow the column header names and order (given in the example).
+ The entire command will abort if any of column headers do not follow the given format.
+
+3. `NAME` and `PROJECT_NAME` fields for developers to be added via the import feature have the same constraints as the [`add-developer` command](#add-developer--add-developer) constraints.
+ The entire command will abort if any of the rows have invalid values that do not comply with given constraints.
+
+**Optional Fields:**
+While `PROJECT` and `DATE JOINED` column headers are compulsory, they are optional fields, where values (corresponding to the developer to be added) under these columns can be empty.
-Format: `find KEYWORD [MORE_KEYWORDS]`
+If values are empty, corresponding developers will be added with `DATE JOINED` automatically set to today and/or with no projects assigned to them, like the [`add-developer` command](#add-developer--add-developer).
-* The search is case-insensitive. e.g `hans` will match `Hans`
-* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
-* Only the name is searched.
-* Only full words will be matched e.g. `Han` will not match `Hans`
-* Persons matching at least one keyword will be returned (i.e. `OR` search).
- e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
-Examples:
-* `find John` returns `john` and `John Doe`
-* `find alex david` returns `Alex Yeoh`, `David Li`-  +Example of valid CSV: -### Deleting a person : `delete` +``` +Name, Contact Number, Email, Address, Date Joined, Role, Salary, GithubId, Rating, Projects,, +faiz,87654321,faiz@u.com,utown,12-12-2020,Developer,3333,Faizgit,5,AndroidApp,ProjectB, +John,123456789,john@email.com,123 Main St,01-01-2021,Developer,4000,JohnDesigns,4,AndroidApp,ProjectB, +Sarah,987654321,sarah@email.com,456 Elm St,05-10-2019,Developer,6000,SarahManager,5,AndroidApp,ProjectB,ProjectC +Alex,555555555,alex@email.com,789 Oak St,03-01-2022,Developer,5500,AlexDev,4,AndroidApp,ProjectB, +Emily,111111111,emily@email.com,321 Pine St,08-10-2018,Developer,4800,EmilyAnalyst,4,AndroidApp,ProjectB, +Michael,999999999,michael@email.com,567 Birch St,06-03-2020,Developer,7000,MichaelEngineer,5,AndroidApp,ProjectB, +``` -Deletes the specified person from the address book. +**Example of usage:** `import-developer developers.csv` -Format: `delete INDEX` +Reads `developers.csv` and adds a new developer for each row of data. -* Deletes the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, … +When command succeeds, CLI shows: +``` +New developer added: faiz; +Phone: 87654321; +Email: faiz@u.com; +Address: utown; +Date Joined: 12-12-2020; +Role: Developer; +Salary: 3333; +Projects: ProjectB AndroidApp +``` +for each developer successfully added. -Examples: -* `list` followed by `delete 2` deletes the 2nd person in the address book. -* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. +[Scroll back to Table of Contents](#table-of-contents) -### Clearing all entries : `clear` +-------------------------------------------------------------------------------------------------------------------- +#### Import clients' details : `import-client` + +Reads a CSV file and populates the addressbook with the clients provided. + +**Command Format:** `import-client FILENAME` + +**Column Header Format (for CSV file):** `Name`, `Contact Number`, `Email`, `Address`, `Role`, `Organisation`, `Document`, `Projects` + + +**Constraints:** +1. The CSV file has to be in the same folder as the JAR file for the command to function correctly. + +2. The CSV file has to strictly follow the column header names and order (given in the example). + The entire command will abort if any of column headers do not follow the given format. -Clears all entries from the address book. +3. `NAME` and `PROJECT_NAME` fields for clients to be added via the import feature have the same constraints as the [`add-client` command](#add-client--add-client) constraints. The entire command will abort if any of the rows have invalid values that do not comply with given constraints. -Format: `clear` +**Optional Fields:** +While the `PROJECT` column header is compulsory, it is an optional fields, where values (corresponding to the client to be added) under this column can be empty. -### Exiting the program : `exit` +If values under the `PROJECT` column are empty, corresponding clients will be added with no projects assigned to them, like the [`add-client` command](#add-client--add-client). -Exits the program. -Format: `exit` +Example of valid CSV: +``` +Name, Contact Number, Email, Address, Role, Organisation, Document, Projects, +Mahi,87554321,mahi@u.com,utown,HR,Google,docs.google.com/abd,AndroidApp,ProjectB +Jane,654321876,jane@email.com,456 Oak St,HR,Acme Corp,acme.com/docs,AndroidApp +Robert,987123456,robert@email.com,789 Elm St,HR,Tech Solutions,techdocs.com/123 +Maria,321987654,maria@email.com,123 Maple St,HR,Innovate Inc,innovate.com/docs +Chris,876543219,chris@email.com,567 Pine St,HR,Data Insights,datainsights.com/docs +Laura,888555555,laura@email.com,101 Birch St,HR,Software Systems,software.com/docs +``` -### Saving the data +**Example of usage:** `import-client clients.csv` + +Reads `clients.csv` and adds a new client for each row of data. + +When command succeeds, CLI shows: + +``` +New client added: Mahi; +Phone: 87554321; +Email: mahi@u.com; +Address: utown; +Organisation: Google; +Role: HR; +Document: docs.google.com/abd; +Projects: ProjectB AndroidApp +``` + +for each client successfully added. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + -AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +### **Find** + +> **Your go-to command to quickly access precise information in CodeContact.** + + +#### Find developer details : `find-developer` + +> Finds the details of an existing developer in the address book. + +**Format:** +`find-developer [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] +[r/ROLE] [s/SALARY] [pr/PROJECT_NAME] [g/GITHUB_ID] [rt/RATING]` + +**Additional notes:** +* Finds for developers based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +**Example of usage:** +`find-developer pr/2103T rt/5.0` + +* Prints developers in 2103/T project with a 5-star rating. + +When command succeeds, CLI shows: + +``` +This is the one developer with matching information. +``` + + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Find client details : `find-client` + +> Finds the details of an existing client in the address book. + +**Format:** +`find-client [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [o/ORGANISATION] [pr/PROJECT] [d/DOCUMENT]` + +**Additional notes:** +* Finds for clients based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +**Example of usage:** +`find-client o/Google r/Senior developer` + +* Prints clients from Google with the Senior developer role. + +When command succeeds, CLI shows: + +``` +These are the 2 clients with matching information. +``` + + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Find project details : `find-project` -### Editing the data file +> Finds the details of an existing project in the address book. -AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. +**Format:** `find-project [pr/PROJECT_NAME] [dr/DESCRIPTION] [dl/DEADLINE]` -
:exclamation: **Caution:**
-If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
+**Additional notes:**
+* Finds for projects based on the attributes provided.
+* At least one of the optional fields must be provided.
+* Existing values will be compared to the input values, and the results will include any items that match the provided
+ criteria.
+* You can combine multiple attributes for a more specific search.
+* The search is case-insensitive, so you can use any case for the search criteria.
+
+**Example of usage:** `find-project pr/JuiceApp`
+
+* Print projects with the name JuiceApp.
+
+When command succeeds, CLI shows:
+
+```
+This is the one project with matching information.
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Find deadlines : `find-deadline`
+
+> Finds deadlines in project tab based on date and/or priority.
+
+**Format:** `find-deadline [d/DATE] [pri/PRIORITY]`
+
+**Additional notes:**
+* When finding deadlines based on `DATE`, the project tab displays deadlines due before or on the specified date.
+* When finding deadlines based on `PRIORITY`, only that priority (`HIGH`,`MEDIUM`, `LOW`) deadlines are shown.
+
+**Example of usage:** `find-deadline d/20-11-2023 pri/MEDIUM`
+
+* Shows deadlines due before or on `20-11-2023` and with `MEDIUM` priority.
+
+When command succeeds, CLI shows:
+
+```
+These are the 3 projects with matching information.
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+### **List**
+> **Your command to view all relevant details in and your keyboard alternative to switching through tabs in CodeContact**
+
+
+#### List information : `list`
+
+> Shows a list of all developers in the address book.
+
+**Format:** `list-TYPE`
+
+* Lists the specific type of thing you are asking.
+
+**Example of usage:** `list-developer`
+
+* Lists all the developers.
+
+**Acceptable parameters**:
+
+* `developer` to list the developers
+* `client` to list the clients
+* `project` to list the projects
+
+When command succeeds, CLI shows:
+
+```
+Listed all developers
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+
+### **Add roles**
+> **Your command to take control of the type of roles available in CodeContact.**
+
+
+#### Add developer roles : `add-developer-role`
+
+> Adds new developer roles into the system.
+
+**Format:** `add-developer-role ROLE_NAME`
+
+**Additional notes:**
+* Adds the ROLE_NAME to list of developer roles.
+* There are 3 preset roles in the list of roles: `Frontend Developer`,`Backend Developer`,`Developer`.
+* You will not be able to add a developer to a role that does not exist in this list of developer roles.
+
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +**Format:** `add-client-role ROLE_NAME` + +**Additional notes:** +* Adds the ROLE_NAME to list of client roles. +* There are 4 preset roles in the list of roles: `HR`,`Manager`,`Developer`,`Client`. +* You will not be able to add a client to a role that does not exist in this list of client roles. +
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**List** | `list` -**Help** | `help` +``` +Undo successful! The change below has been undone: +Deleted Developer: Amy; +Phone: 83566674; +Email: amy@example.com; +Address: 42, Clementi Ave 7, #02-2; +Date Joined: 23-11-2023; +Role: Frontend Developer; +Salary: 5000; +Projects: CustomWebsite AndroidApp +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Redo : `redo` + +> Redo the previous command you undid. + +**Format:** `redo` + +**Additional notes:** +* Each time you type redo, you move forward one stage. +* You can only `redo` if you have `undo` before. +* If you undid 5 changes, and you wish to redo, you can enter the command `redo` 5 times. The system will remind you when + you cannot redo anymore. +* `redo` works for all `edit`, `add-TYPE` and `delete` commands. + +**Example of usage:** + +* You just `undo` delete developer, and you wish to `redo` to add it back. + When command succeeds, CLI shows: + +``` +Redo successful! The change below has been redone: +Deleted Developer: Amy; +Phone: 83566674; +Email: amy@example.com; +Address: 42, Clementi Ave 7, #02-2; +Date Joined: 23-11-2023; +Role: Frontend Developer; +Salary: 5000; +Projects: CustomWebsite AndroidApp +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +## ***Additional Features*** + +-------------------------------------------------------------------------------------------------------------------- +### **Miscellaneous Features** +> **Accessible features for you to navigate smoothly through CodeContact.** + + +#### Viewing help : `help` + +> Shows a message explaining how to access the help page. + +**Format:** `help` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Clearing all entries : `clear` + +> Clears all entries from the address book. + +**Format:** `clear` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Exiting the program : `exit` + +> Exits the program. + +**Format:** `exit` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + + +# **FAQ** + +-------------------------------------------------------------------------------------------------------------------- + +**Q**: How do I transfer my data to another Computer?
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains +the data of your previous CodeContact home folder. + + +**Q**: How can I launch CodeContact if the clicking on the JAR file does not work?
+**A**: There are two possible methods to launch CodeContact. +
+ +* Method 1: For users familiar with the command prompt + 1. Open the command prompt. + 2. Navigate to the directory where the JAR file is located using cd [JAR file location]. + 3. Type `java -jar CodeContact.jar` and press enter. + 4. CodeContact should launch. +
+ +* Method 2: For users that wish to create a script to launch CodeContact (Recommended) + + 1. Create a new text file. + 2. Type the following into the text file: + `java -jar [JAR file location]/CodeContact.jar`. + 3. Save the text file as CodeContact.bat (Windows) or CodeContact.sh (MacOS/Linux). + 4. Change the admin settings of the script to allow it to run as a program: + * Windows: Right-click on the script and select Properties. Under General , check + the box that says Allow this file to run as a program. + * MacOS/Linux: Open the terminal and navigate to the directory where the script is + located. Type `chmod +x [script name]` and press enter (`chmod +x` changes + permissions of the script to allow it to be executed). + 5. Double-click on the script to launch CodeContact. + 6. CodeContact should launch. + + +**Q**: How can I check my java version?
+**A**: Open a command prompt and type `java -version`. If you do not have Java installed, you +can download it [here](https://www.oracle.com/java/technologies/downloads/#java11). + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +# **Known issues** +-------------------------------------------------------------------------------------------------------------------- + +1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only + the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the + application before running the application again. +2. **When tampering with the storage files**, if you tamper with the storage files leading to incorrect format, the application will not be able to + read the data and will throw an error. The remedy is to delete the `addressbook.json` file created by the application before + running the application again. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +# **Command summary** + +| Action | Format, Examples | +|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **lock** | `lock` | +| **unlock** | Format:
`unlock pw/PASSWORD`
Example:
`unlock pw/Password123!` | +| **change password** | Format:
`change-password pw/CURRENT_PASSWORD npw/NEW_PASSWORD`
Example:
`change-password pw/Password123! npw/Password123!` | +| **add developers** | Format:
`add-developer n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [d/DATE_JOINED] r/ROLE s/SALARY [pr/PROJECT_NAME]... g/GITHUB_ID rt/RATING`
Example:
`add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp pr/CustomWebsite s/4500 d/11-11-2023 g/johng rt/3`
| +| **add clients** | Format:
`add-client n/NAME p/PHONE e/EMAIL a/ADDRESS r/ROLE [pr/PROJECT]... o/ORGANISATION do/DOCUMENT`
Example:
`add-client n/Jack Doe p/98765432 e/jackd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp pr/CustomWebsite o/Google do/google.com`
| +| **add projects** | Format:
`add-project n/NAME dr/DESCRIPTION [dl/DEADLINE_DATE,DEADLINE_DESCRIPTION,PRIORITY,IS_DONE]...`
Example:
`add-project n/JuiceApp dr/App to allow for different juices to be ordered dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0`
| +| **edit developers** | Format:
`edit-developer INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME]... [g/GITHUB_ID] [rt/RATING]`
Example:
`edit-developer 2 p/98989898 pr/Project2 pr/Project3`
| +| **edit clients** | Format:
`edit-client INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME]... [g/GITHUB_ID] [rt/RATING]`
Example:
`edit-client 3 p/bob@gmail.com`
| +| **edit projects** | Format:
`edit-project INDEX [dr/DESCRIPTION] [dl/DEADLINE]...`
Example:
`edit-project 1 dl/Finish Feature-A by: 09-09-2023`
| +| **find developers** | Format:
`find-developer pr/`
Example:
`find-developer pr/2103/T`
| +| **find clients** | Format:
`find-client n/`
Example:
`find-client n/Amy`
| +| **find projects** | Format:
`find-project dr/description`
Example:
`find-project dr/school semester project`
| +| **find deadlines** | Format:
`find-deadline [d/DATE] [pri/PRIORITY]`
Example:
`find-deadline d/20-11-2023 pri/MEDIUM`
| +| **delete developer** | Format:
`delete-developer INDEX`
Example:
`delete-developer 1`
| +| **delete client** | Format:
`delete-client INDEX`
Example:
`delete-client 1`
| +| **delete project** | Format:
`delete-project INDEX`
Example:
`delete-project 1`
| +| **import developer** | Format:
`import-developer [FILENAME]`
Example:
`import-developer developers.csv`
| +| **import client** | Format:
`import-client [FILENAME]`
Example:
`import-client clients.csv`
| +| **add developer role** | Format:
`add-developer-role ROLE_NAME`
Example:
`add-developer-role UIDesigner`
| +| **add client role** | Format:
`add-client-role ROLE_NAME`
Example:
`add-client-role Boss`
| +| **delete developer role** | Format:
`delete-developer-role ROLE_NAME`
Example:
`delete-developer-role UIDesigner`
| +| **delete client role** | Format:
`delete-client-role ROLE_NAME`
Example:
`delete-client-role Boss`
| +| **list** | Format:
`list-developer`
`list-project`
`list-client` | +| **mark deadline** | Format:
`mark-deadline PROJECT_INDEX DEADLINE_INDEX`
Example:
`mark-deadline 2 1`
| +| **unmark deadline** | Format:
`unmark-deadline PROJECT_INDEX DEADLINE_INDEX`
Example:
`unmark-deadline 2 1`
| +| **undo** | `undo` | +| **redo** | `redo` | +| **clear** | `clear` | +| **exit** | `exit` | +| **help** | `help` | + +[Scroll back to Table of Contents](#table-of-contents) diff --git a/docs/_config.yml b/docs/_config.yml index 6bd245d8f4e..fa18176cd0d 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,4 +1,4 @@ -title: "AB-3" +title: "CodeContact" theme: minima header_pages: @@ -8,7 +8,7 @@ header_pages: markdown: kramdown -repository: "se-edu/addressbook-level3" +repository: "AY2324S1-CS2103T-T09-2" github_icon: "images/github-icon.png" plugins: diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html index 8559a67ffad..fb531a17de3 100644 --- a/docs/_includes/custom-head.html +++ b/docs/_includes/custom-head.html @@ -1,6 +1,6 @@ {% comment %} - Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: +Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: - 1. Head over to https://realfavicongenerator.net/ to add your own favicons. - 2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. +1. Head over to https://realfavicongenerator.net/ to add your own favicons. +2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. {% endcomment %} diff --git a/docs/_includes/head.html b/docs/_includes/head.html index 83ac5326933..314465c01c9 100644 --- a/docs/_includes/head.html +++ b/docs/_includes/head.html @@ -1,12 +1,12 @@ - - - + + + - + - {%- include custom-head.html -%} + {%- include custom-head.html -%} -{{page.title}}
+ {{page.title}}
diff --git a/docs/_includes/header.html b/docs/_includes/header.html
index 33badcd4f99..7c91b6d8795 100644
--- a/docs/_includes/header.html
+++ b/docs/_includes/header.html
@@ -1,36 +1,36 @@
-
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index e092cd572e0..bd6d117a6e8 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -1,18 +1,18 @@
- {%- include head.html -%}
+{%- include head.html -%}
-
+
- {%- include header.html -%}
+{%- include header.html -%}
-
-
-
+
diff --git a/docs/_sass/minima/_base.scss b/docs/_sass/minima/_base.scss
index 0d3f6e80ced..7e040aa935b 100644
--- a/docs/_sass/minima/_base.scss
+++ b/docs/_sass/minima/_base.scss
@@ -288,7 +288,7 @@ table {
text-align: center;
}
.site-header:before {
- content: "AB-3";
+ content: "CC";
font-size: 32px;
}
}
diff --git a/docs/diagrams/AddDeveloperRoleSequenceDiagram.puml b/docs/diagrams/AddDeveloperRoleSequenceDiagram.puml
new file mode 100644
index 00000000000..861294bf0c8
--- /dev/null
+++ b/docs/diagrams/AddDeveloperRoleSequenceDiagram.puml
@@ -0,0 +1,87 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+ !include style.puml
+ skinparam ArrowFontStyle plain
+
+ box Logic LOGIC_COLOR_T1
+ participant ":LogicManager" as LogicManager LOGIC_COLOR
+ participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+ participant "d :AddDeveloperRoleCommandParser" as AddDeveloperRoleCommandParser LOGIC_COLOR
+ participant "d :AddDeveloperRoleCommand" as AddDeveloperRoleCommand LOGIC_COLOR
+ participant ":CommandResult" as CommandResult LOGIC_COLOR
+ end box
+
+ box Model MODEL_COLOR_T1
+ participant ":Model" as Model MODEL_COLOR
+ participant ":VersionedAddressBook" as VersionedAddressBook MODEL_COLOR
+ participant ":DeveloperRoles" as DeveloperRoles MODEL_COLOR
+ end box
+
+ [-> LogicManager : execute("add-developer-role Tester")
+ activate LogicManager
+
+ LogicManager -> AddressBookParser : parseCommand("add-developer-role Tester")
+ activate AddressBookParser
+
+ create AddDeveloperRoleCommandParser
+ AddressBookParser -> AddDeveloperRoleCommandParser
+ activate AddDeveloperRoleCommandParser
+
+ AddDeveloperRoleCommandParser --> AddressBookParser
+ deactivate AddDeveloperRoleCommandParser
+
+ AddressBookParser -> AddDeveloperRoleCommandParser : parse("Tester")
+ activate AddDeveloperRoleCommandParser
+
+ create AddDeveloperRoleCommand
+ AddDeveloperRoleCommandParser -> AddDeveloperRoleCommand
+ activate AddDeveloperRoleCommand
+
+ AddDeveloperRoleCommand --> AddDeveloperRoleCommandParser
+ deactivate AddDeveloperRoleCommand
+
+ AddDeveloperRoleCommandParser --> AddressBookParser
+ deactivate AddDeveloperRoleCommandParser
+
+ AddressBookParser --> LogicManager
+ deactivate AddressBookParser
+
+ LogicManager -> AddDeveloperRoleCommand : execute()
+ activate AddDeveloperRoleCommand
+
+ AddDeveloperRoleCommand -> DeveloperRoles : isValidRole("Tester")
+ activate DeveloperRoles
+
+ DeveloperRoles --> AddDeveloperRoleCommand : boolean true
+ deactivate DeveloperRoles
+
+ AddDeveloperRoleCommand -> DeveloperRoles : addDeveloperRole(new DeveloperRoles("Tester))
+ activate DeveloperRoles
+
+ DeveloperRoles -> DeveloperRoles : saveDeveloperRoles()
+ DeveloperRoles --> AddDeveloperRoleCommand
+
+ AddDeveloperRoleCommand -> Model : commitAddressBook(model, successMessage, TabIndex)
+ activate Model
+
+ Model -> VersionedAddressBook : commit()
+ activate VersionedAddressBook
+
+ VersionedAddressBook --> Model
+ deactivate VersionedAddressBook
+
+ Model --> AddDeveloperRoleCommand
+ deactivate Model
+
+ create CommandResult
+ AddDeveloperRoleCommand -> CommandResult
+ activate CommandResult
+
+ CommandResult --> AddDeveloperRoleCommand
+ deactivate CommandResult
+
+ AddDeveloperRoleCommand --> LogicManager : result
+ deactivate AddDeveloperRoleCommand
+
+@enduml
diff --git a/docs/diagrams/AddDeveloperSequenceDiagram.puml b/docs/diagrams/AddDeveloperSequenceDiagram.puml
new file mode 100644
index 00000000000..a4cf4f1b07d
--- /dev/null
+++ b/docs/diagrams/AddDeveloperSequenceDiagram.puml
@@ -0,0 +1,77 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":AddDeveloperCommandParser" as AddDeveloperCommandParser LOGIC_COLOR
+participant "a:AddDeveloperCommand" as AddDeveloperCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant ":Developer" as Developer USER_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("add-developer args")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("add-developer args")
+activate AddressBookParser
+
+create AddDeveloperCommandParser
+AddressBookParser -> AddDeveloperCommandParser
+activate AddDeveloperCommandParser
+
+AddDeveloperCommandParser --> AddressBookParser
+deactivate AddDeveloperCommandParser
+
+AddressBookParser -> AddDeveloperCommandParser : parse("args")
+activate AddDeveloperCommandParser
+
+create AddDeveloperCommand
+AddDeveloperCommandParser -> AddDeveloperCommand
+activate AddDeveloperCommand
+
+AddDeveloperCommand --> AddDeveloperCommandParser : a
+deactivate AddDeveloperCommand
+
+AddDeveloperCommandParser --> AddressBookParser : a
+deactivate AddDeveloperCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+AddDeveloperCommandParser -[hidden]-> AddressBookParser
+destroy AddDeveloperCommandParser
+
+AddressBookParser --> LogicManager : a
+deactivate AddressBookParser
+
+LogicManager -> AddDeveloperCommand : execute()
+activate AddDeveloperCommand
+
+create Developer
+AddDeveloperCommand -> Developer: new
+activate Developer
+
+Developer --> AddDeveloperCommand : developer
+deactivate Developer
+
+AddDeveloperCommand -> Model : addDeveloper(devleoper)
+activate Model
+
+Model --> AddDeveloperCommand
+deactivate Model
+
+create CommandResult
+AddDeveloperCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> AddDeveloperCommand
+deactivate CommandResult
+
+AddDeveloperCommand --> LogicManager : result
+deactivate AddDeveloperCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/ArchitectureSequenceDiagram.puml b/docs/diagrams/ArchitectureSequenceDiagram.puml
index 48b6cc4333c..d0ee59f4c70 100644
--- a/docs/diagrams/ArchitectureSequenceDiagram.puml
+++ b/docs/diagrams/ArchitectureSequenceDiagram.puml
@@ -8,13 +8,13 @@ Participant ":Logic" as logic LOGIC_COLOR
Participant ":Model" as model MODEL_COLOR
Participant ":Storage" as storage STORAGE_COLOR
-user -[USER_COLOR]> ui : "delete 1"
+user -[USER_COLOR]> ui : "delete-developer 1"
activate ui UI_COLOR
-ui -[UI_COLOR]> logic : execute("delete 1")
+ui -[UI_COLOR]> logic : execute("delete-developer 1")
activate logic LOGIC_COLOR
-logic -[LOGIC_COLOR]> model : deletePerson(p)
+logic -[LOGIC_COLOR]> model : deleteDeveloper(p)
activate model MODEL_COLOR
model -[MODEL_COLOR]-> logic
diff --git a/docs/diagrams/BetterModelClassDiagram.puml b/docs/diagrams/BetterModelClassDiagram.puml
index 598474a5c82..1220d1b8136 100644
--- a/docs/diagrams/BetterModelClassDiagram.puml
+++ b/docs/diagrams/BetterModelClassDiagram.puml
@@ -4,18 +4,19 @@ skinparam arrowThickness 1.1
skinparam arrowColor MODEL_COLOR
skinparam classBackgroundColor MODEL_COLOR
-AddressBook *-right-> "1" UniquePersonList
-AddressBook *-right-> "1" UniqueTagList
-UniqueTagList -[hidden]down- UniquePersonList
-UniqueTagList -[hidden]down- UniquePersonList
+AddressBook *-right-> "1" UniqueDeveloperList
+AddressBook *-right-> "1" UniqueProjectList
-UniqueTagList -right-> "*" Tag
-UniquePersonList -right-> Person
+UniqueProjectList -[hidden]down- UniqueDeveloperList
+UniqueProjectList -[hidden]down- UniqueDeveloperList
-Person -up-> "*" Tag
+UniqueProjectList -right-> "*" Project
+UniqueDeveloperList -right-> Developer
-Person *--> Name
-Person *--> Phone
-Person *--> Email
-Person *--> Address
+Developer -up-> "*" Project
+
+Developer *--> Name
+Developer *--> Phone
+Developer *--> Email
+Developer *--> Address
@enduml
diff --git a/docs/diagrams/DeleteClientSequenceDiagram.puml b/docs/diagrams/DeleteClientSequenceDiagram.puml
new file mode 100644
index 00000000000..21abf717ec8
--- /dev/null
+++ b/docs/diagrams/DeleteClientSequenceDiagram.puml
@@ -0,0 +1,69 @@
+@startuml
+!include Style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":DeleteClientCommandParser" as DeleteClientCommandParser LOGIC_COLOR
+participant "d:DeleteClientCommand" as DeleteClientCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("delete-client 1")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("delete-client 1")
+activate AddressBookParser
+
+create DeleteClientCommandParser
+AddressBookParser -> DeleteClientCommandParser
+activate DeleteClientCommandParser
+
+DeleteClientCommandParser --> AddressBookParser
+deactivate DeleteClientCommandParser
+
+AddressBookParser -> DeleteClientCommandParser : parse("1")
+activate DeleteClientCommandParser
+
+create DeleteClientCommand
+DeleteClientCommandParser -> DeleteClientCommand
+activate DeleteClientCommand
+
+DeleteClientCommand --> DeleteClientCommandParser : c
+deactivate DeleteClientCommand
+
+DeleteClientCommandParser --> AddressBookParser : c
+deactivate DeleteClientCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+DeleteClientCommandParser -[hidden]-> AddressBookParser
+destroy DeleteClientCommandParser
+
+AddressBookParser --> LogicManager : c
+deactivate AddressBookParser
+
+LogicManager -> DeleteClientCommand : execute()
+activate DeleteClientCommand
+
+DeleteClientCommand -> Model : deleteClient(1)
+activate Model
+
+Model --> DeleteClientCommand
+deactivate Model
+
+create CommandResult
+DeleteClientCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> DeleteClientCommand
+deactivate CommandResult
+
+DeleteClientCommand --> LogicManager : result
+deactivate DeleteClientCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/DeleteDeveloperRoleSequenceDiagram.puml b/docs/diagrams/DeleteDeveloperRoleSequenceDiagram.puml
new file mode 100644
index 00000000000..0319e46d543
--- /dev/null
+++ b/docs/diagrams/DeleteDeveloperRoleSequenceDiagram.puml
@@ -0,0 +1,87 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+ !include style.puml
+ skinparam ArrowFontStyle plain
+
+ box Logic LOGIC_COLOR_T1
+ participant ":LogicManager" as LogicManager LOGIC_COLOR
+ participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+ participant "d :DeleteDeveloperRoleCommandParser" as DeleteDeveloperRoleCommandParser LOGIC_COLOR
+ participant "d :DeleteDeveloperRoleCommand" as DeleteDeveloperRoleCommand LOGIC_COLOR
+ participant ":CommandResult" as CommandResult LOGIC_COLOR
+ end box
+
+ box Model MODEL_COLOR_T1
+ participant ":Model" as Model MODEL_COLOR
+ participant ":VersionedAddressBook" as VersionedAddressBook MODEL_COLOR
+ participant ":DeveloperRoles" as DeveloperRoles MODEL_COLOR
+ end box
+
+ [-> LogicManager : execute("delete-developer-role Tester")
+ activate LogicManager
+
+ LogicManager -> AddressBookParser : parseCommand("delete-developer-role Tester")
+ activate AddressBookParser
+
+ create DeleteDeveloperRoleCommandParser
+ AddressBookParser -> DeleteDeveloperRoleCommandParser
+ activate DeleteDeveloperRoleCommandParser
+
+ DeleteDeveloperRoleCommandParser --> AddressBookParser
+ deactivate DeleteDeveloperRoleCommandParser
+
+ AddressBookParser -> DeleteDeveloperRoleCommandParser : parse("Tester")
+ activate DeleteDeveloperRoleCommandParser
+
+ create DeleteDeveloperRoleCommand
+ DeleteDeveloperRoleCommandParser -> DeleteDeveloperRoleCommand
+ activate DeleteDeveloperRoleCommand
+
+ DeleteDeveloperRoleCommand --> DeleteDeveloperRoleCommandParser
+ deactivate DeleteDeveloperRoleCommand
+
+ DeleteDeveloperRoleCommandParser --> AddressBookParser
+ deactivate DeleteDeveloperRoleCommandParser
+
+ AddressBookParser --> LogicManager
+ deactivate AddressBookParser
+
+ LogicManager -> DeleteDeveloperRoleCommand : execute()
+ activate DeleteDeveloperRoleCommand
+
+ DeleteDeveloperRoleCommand -> DeveloperRoles : isRemovableRole("Tester")
+ activate DeveloperRoles
+
+ DeveloperRoles --> DeleteDeveloperRoleCommand : boolean true
+ deactivate DeveloperRoles
+
+ DeleteDeveloperRoleCommand -> DeveloperRoles : deleteDeveloperRole(new DeveloperRoles("Tester))
+ activate DeveloperRoles
+
+ DeveloperRoles -> DeveloperRoles : saveDeveloperRoles()
+ DeveloperRoles --> DeleteDeveloperRoleCommand
+
+ DeleteDeveloperRoleCommand -> Model : commitAddressBook(model, successMessage, TabIndex)
+ activate Model
+
+ Model -> VersionedAddressBook : commit()
+ activate VersionedAddressBook
+
+ VersionedAddressBook --> Model
+ deactivate VersionedAddressBook
+
+ Model --> DeleteDeveloperRoleCommand
+ deactivate Model
+
+ create CommandResult
+ DeleteDeveloperRoleCommand -> CommandResult
+ activate CommandResult
+
+ CommandResult --> DeleteDeveloperRoleCommand
+ deactivate CommandResult
+
+ DeleteDeveloperRoleCommand --> LogicManager : result
+ deactivate DeleteDeveloperRoleCommand
+
+@enduml
diff --git a/docs/diagrams/DeleteProjectSequenceDiagram.puml b/docs/diagrams/DeleteProjectSequenceDiagram.puml
new file mode 100644
index 00000000000..a064002e606
--- /dev/null
+++ b/docs/diagrams/DeleteProjectSequenceDiagram.puml
@@ -0,0 +1,92 @@
+@startuml
+!include Style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":DeleteProjectCommandParser" as DeleteProjectCommandParser LOGIC_COLOR
+participant "d:DeleteProjectCommand" as DeleteProjectCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":ModelManager" as Model MODEL_COLOR
+participant ":AddressBook" as AddressBook MODEL_COLOR
+participant ":UniqueProjectList" as UniqueProjectList MODEL_COLOR
+participant ":UniqueClientList" as UniqueClientList MODEL_COLOR
+participant ":UniqueDeveloperList" as UniqueDeveloperList MODEL_COLOR
+end box
+
+[-> LogicManager : execute("delete-project 2")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("delete-project 2")
+activate AddressBookParser
+
+create DeleteProjectCommandParser
+AddressBookParser -> DeleteProjectCommandParser
+activate DeleteProjectCommandParser
+
+DeleteProjectCommandParser --> AddressBookParser
+deactivate DeleteProjectCommandParser
+
+AddressBookParser -> DeleteProjectCommandParser : parse("2")
+activate DeleteProjectCommandParser
+
+create DeleteProjectCommand
+DeleteProjectCommandParser -> DeleteProjectCommand
+activate DeleteProjectCommand
+
+DeleteProjectCommand --> DeleteProjectCommandParser : d
+deactivate DeleteProjectCommand
+
+DeleteProjectCommandParser --> AddressBookParser : d
+deactivate DeleteProjectCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+DeleteProjectCommandParser -[hidden]-> AddressBookParser
+destroy DeleteProjectCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+
+LogicManager -> DeleteProjectCommand : execute()
+activate DeleteProjectCommand
+
+DeleteProjectCommand -> Model : deleteProject(2)
+activate Model
+
+Model -> AddressBook : removeProject(2)
+activate AddressBook
+
+AddressBook -> UniqueProjectList : remove(2)
+activate UniqueProjectList
+UniqueProjectList --> AddressBook
+deactivate UniqueProjectList
+AddressBook -> UniqueClientList : updateClientProjects("2")
+activate UniqueClientList
+UniqueClientList --> AddressBook
+deactivate UniqueClientList
+AddressBook -> UniqueDeveloperList : updateDeveloperProjects("2")
+activate UniqueDeveloperList
+UniqueDeveloperList --> AddressBook
+deactivate UniqueDeveloperList
+AddressBook --> Model
+deactivate AddressBook
+
+
+Model --> DeleteProjectCommand
+deactivate Model
+
+create CommandResult
+DeleteProjectCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> DeleteProjectCommand
+deactivate CommandResult
+
+DeleteProjectCommand --> LogicManager : result
+deactivate DeleteProjectCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/EditDeveloperSequenceDiagram.puml b/docs/diagrams/EditDeveloperSequenceDiagram.puml
new file mode 100644
index 00000000000..5b279d820a5
--- /dev/null
+++ b/docs/diagrams/EditDeveloperSequenceDiagram.puml
@@ -0,0 +1,76 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":EditDeveloperCommandParser" as EditDeveloperCommandParser LOGIC_COLOR
+participant "d:EditDeveloperCommand" as EditDeveloperCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("edit-developer 1 pr/AppleApp")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("edit-developer 1 pr/AppleApp")
+activate AddressBookParser
+
+create EditDeveloperCommandParser
+AddressBookParser -> EditDeveloperCommandParser
+activate EditDeveloperCommandParser
+
+EditDeveloperCommandParser --> AddressBookParser
+deactivate EditDeveloperCommandParser
+
+AddressBookParser -> EditDeveloperCommandParser : parse("1 pr/AppleApp")
+activate EditDeveloperCommandParser
+
+create EditDeveloperCommand
+EditDeveloperCommandParser -> EditDeveloperCommand
+activate EditDeveloperCommand
+
+EditDeveloperCommand --> EditDeveloperCommandParser : d
+deactivate EditDeveloperCommand
+
+EditDeveloperCommandParser --> AddressBookParser : d
+deactivate EditDeveloperCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+EditDeveloperCommandParser -[hidden]-> AddressBookParser
+destroy EditDeveloperCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+
+LogicManager -> EditDeveloperCommand : execute()
+activate EditDeveloperCommand
+
+EditDeveloperCommand -> Model : areProjectsValid(editedDeveloper)
+activate Model
+
+Model --> EditDeveloperCommand
+deactivate Model
+
+EditDeveloperCommand -> Model : setDeveloper(developerToEdit, editedDeveloper)
+activate Model
+
+Model --> EditDeveloperCommand
+deactivate Model
+
+create CommandResult
+EditDeveloperCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> EditDeveloperCommand
+deactivate CommandResult
+
+EditDeveloperCommand --> LogicManager : result
+deactivate EditDeveloperCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/FindDeveloperSequenceDiagram.puml b/docs/diagrams/FindDeveloperSequenceDiagram.puml
new file mode 100644
index 00000000000..f5e9dcd8735
--- /dev/null
+++ b/docs/diagrams/FindDeveloperSequenceDiagram.puml
@@ -0,0 +1,70 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":FindCommandParser" as FindCommandParser LOGIC_COLOR
+participant "d:FindCommand" as FindCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("find-developer n/Alice")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("find-developer n/Alice")
+activate AddressBookParser
+
+create FindCommandParser
+AddressBookParser -> FindCommandParser
+activate FindCommandParser
+
+FindCommandParser --> AddressBookParser
+deactivate FindCommandParser
+
+AddressBookParser -> FindCommandParser : parse("Alice")
+activate FindCommandParser
+
+create FindCommand
+FindCommandParser -> FindCommand
+activate FindCommand
+
+FindCommand --> FindCommandParser : d
+deactivate FindCommand
+
+FindCommandParser --> AddressBookParser : d
+deactivate FindCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+FindCommandParser -[hidden]-> AddressBookParser
+destroy FindCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+
+LogicManager -> FindCommand : execute()
+activate FindCommand
+
+FindCommand -> Model : FindDeveloper(1)
+activate Model
+
+Model --> FindCommand
+deactivate Model
+
+create CommandResult
+FindCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> FindCommand
+deactivate CommandResult
+
+FindCommand --> LogicManager : result
+deactivate FindCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/ImportDeveloperSequenceDiagram.puml b/docs/diagrams/ImportDeveloperSequenceDiagram.puml
new file mode 100644
index 00000000000..1c05d959616
--- /dev/null
+++ b/docs/diagrams/ImportDeveloperSequenceDiagram.puml
@@ -0,0 +1,84 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":ImportDeveloperCommandParser" as ImportDeveloperCommandParser LOGIC_COLOR
+participant "d:ImportDeveloperCommand" as ImportDeveloperCommand LOGIC_COLOR
+participant ":AddDeveloperCommand" as AddDeveloperCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute\n("import-developer\n developers.csv")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand\n("import-developer\n developers.csv")
+activate AddressBookParser
+
+create ImportDeveloperCommandParser
+AddressBookParser -> ImportDeveloperCommandParser
+activate ImportDeveloperCommandParser
+
+ImportDeveloperCommandParser --> AddressBookParser
+deactivate ImportDeveloperCommandParser
+
+AddressBookParser -> ImportDeveloperCommandParser : parse\n("Developers.csv")
+activate ImportDeveloperCommandParser
+
+create ImportDeveloperCommand
+ImportDeveloperCommandParser -> ImportDeveloperCommand
+activate ImportDeveloperCommand
+
+ImportDeveloperCommand --> ImportDeveloperCommandParser : d
+deactivate ImportDeveloperCommand
+
+ImportDeveloperCommandParser --> AddressBookParser : d
+deactivate ImportDeveloperCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+ImportDeveloperCommandParser -[hidden]-> AddressBookParser
+destroy ImportDeveloperCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+
+LogicManager -> ImportDeveloperCommand : execute()
+activate ImportDeveloperCommand
+loop for each row in csv
+ create AddDeveloperCommand
+ ImportDeveloperCommand -> AddDeveloperCommand
+ activate AddDeveloperCommand
+ AddDeveloperCommand --> ImportDeveloperCommand
+ deactivate AddDeveloperCommand
+ ImportDeveloperCommand -> AddDeveloperCommand : execute()
+ activate AddDeveloperCommand
+ AddDeveloperCommand -> Model : addDeveloper()
+ activate Model
+ Model --> AddDeveloperCommand
+ deactivate Model
+ create CommandResult
+ AddDeveloperCommand -> CommandResult
+ activate CommandResult
+ CommandResult --> AddDeveloperCommand
+ deactivate CommandResult
+ AddDeveloperCommand --> ImportDeveloperCommand : result
+ deactivate AddDeveloperCommand
+end
+
+create CommandResult
+ ImportDeveloperCommand -> CommandResult
+ activate CommandResult
+ CommandResult --> ImportDeveloperCommand
+ deactivate CommandResult
+
+ImportDeveloperCommand --> LogicManager : result
+deactivate ImportDeveloperCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/ListDeveloperCommand.puml b/docs/diagrams/ListDeveloperCommand.puml
new file mode 100644
index 00000000000..3c32aec9cd1
--- /dev/null
+++ b/docs/diagrams/ListDeveloperCommand.puml
@@ -0,0 +1,56 @@
+
+ @startuml
+ !include style.puml
+ skinparam ArrowFontStyle plain
+
+ box Logic LOGIC_COLOR_T1
+ participant ":LogicManager" as LogicManager LOGIC_COLOR
+ participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+ participant "d :ListDeveloperCommand" as ListDeveloperCommand LOGIC_COLOR
+ participant ":CommandResult" as CommandResult LOGIC_COLOR
+ end box
+
+ box Model MODEL_COLOR_T1
+ participant ":Model" as Model MODEL_COLOR
+ end box
+
+ [-> LogicManager : execute("list-developer")
+ activate LogicManager
+
+ LogicManager -> AddressBookParser : parseCommand("list-developer")
+ activate AddressBookParser
+
+ create ListDeveloperCommand
+ AddressBookParser -> ListDeveloperCommand
+ activate ListDeveloperCommand
+
+ ListDeveloperCommand --> AddressBookParser : d
+ deactivate ListDeveloperCommand
+
+ AddressBookParser --> LogicManager : d
+ deactivate AddressBookParser
+
+ LogicManager -> ListDeveloperCommand : execute()
+ activate ListDeveloperCommand
+
+ ListDeveloperCommand -> Model : updateFilteredDeveloperList(PREDICATE_SHOW_ALL_DEVELOPERS)
+ activate Model
+
+ Model --> ListDeveloperCommand
+ deactivate Model
+
+ create CommandResult
+ ListDeveloperCommand -> CommandResult
+ activate CommandResult
+
+ CommandResult --> ListDeveloperCommand
+ deactivate CommandResult
+
+ ListDeveloperCommand --> LogicManager : result
+ deactivate ListDeveloperCommand
+
+ [<--LogicManager
+ deactivate LogicManager
+
+ @enduml
+
diff --git a/docs/diagrams/MarkDeadlineSequenceDiagram.puml b/docs/diagrams/MarkDeadlineSequenceDiagram.puml
new file mode 100644
index 00000000000..4af6f64ed20
--- /dev/null
+++ b/docs/diagrams/MarkDeadlineSequenceDiagram.puml
@@ -0,0 +1,105 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":MarkDeadlineCommandParser" as MarkDeadlineCommandParser LOGIC_COLOR
+participant "d:MarkDeadlineCommand" as MarkDeadlineCommand LOGIC_COLOR
+participant ":EditProjectCommandParser" as EditProjectCommandParser LOGIC_COLOR
+participant "d:EditProjectCommand" as EditProjectCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("mark-deadline 1 2")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("mark-deadline 1 2")
+activate AddressBookParser
+
+create MarkDeadlineCommandParser
+AddressBookParser -> MarkDeadlineCommandParser
+activate MarkDeadlineCommandParser
+
+MarkDeadlineCommandParser --> AddressBookParser
+deactivate MarkDeadlineCommandParser
+
+AddressBookParser -> MarkDeadlineCommandParser : parse("1 2")
+activate MarkDeadlineCommandParser
+
+create MarkDeadlineCommand
+MarkDeadlineCommandParser -> MarkDeadlineCommand
+activate MarkDeadlineCommand
+
+MarkDeadlineCommand --> MarkDeadlineCommandParser : d
+deactivate MarkDeadlineCommand
+
+MarkDeadlineCommandParser --> AddressBookParser : d
+deactivate MarkDeadlineCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+MarkDeadlineCommandParser -[hidden]-> AddressBookParser
+destroy MarkDeadlineCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+
+LogicManager -> MarkDeadlineCommand : execute()
+activate MarkDeadlineCommand
+
+create EditProjectCommandParser
+MarkDeadlineCommand -> EditProjectCommandParser
+activate EditProjectCommandParser
+
+EditProjectCommandParser --> MarkDeadlineCommand
+deactivate EditProjectCommandParser
+
+MarkDeadlineCommand -> EditProjectCommandParser : parse("1 dl/19-12-2023,Design backend,HIGH,1")
+activate EditProjectCommandParser
+
+create EditProjectCommand
+EditProjectCommandParser -> EditProjectCommand
+activate EditProjectCommand
+
+EditProjectCommand --> EditProjectCommandParser : c
+deactivate EditProjectCommand
+
+EditProjectCommandParser --> MarkDeadlineCommand : c
+deactivate EditProjectCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+EditProjectCommandParser -[hidden]-> MarkDeadlineCommand
+destroy EditProjectCommandParser
+
+MarkDeadlineCommand -> EditProjectCommand : execute()
+activate EditProjectCommand
+
+EditProjectCommand -> Model : setProject(projectToEdit, editedProject)
+activate Model
+
+Model --> EditProjectCommand
+deactivate Model
+
+EditProjectCommand --> MarkDeadlineCommand
+deactivate EditProjectCommand
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+EditProjectCommand -[hidden]-> MarkDeadlineCommand
+destroy EditProjectCommand
+
+create CommandResult
+MarkDeadlineCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> MarkDeadlineCommand
+deactivate CommandResult
+
+MarkDeadlineCommand --> LogicManager : result
+deactivate MarkDeadlineCommand
+
+[<--LogicManager
+deactivate LogicManager
+
+@enduml
diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
index 0de5673070d..e1f9474b08c 100644
--- a/docs/diagrams/ModelClassDiagram.puml
+++ b/docs/diagrams/ModelClassDiagram.puml
@@ -11,18 +11,31 @@ Class "<>\nModel" as Model
Class AddressBook
Class ModelManager
Class UserPrefs
-
-Class UniquePersonList
-Class Person
-Class Address
-Class Email
-Class Name
-Class Phone
-Class Tag
+Package Person as PersonPackage <>{
+Package Developer as DeveloperPackage <>{
+Class UniqueDeveloperList
+Class Developer
+}
+Package Client as ClientPackage <>{
+Class UniqueClientList
+Class Client
+}
+}
+Package Project as ProjectPackage <>{
+Class UniqueProjectList
+Class Project
+}
+'Class Address
+''Class Email
+'Class Name
+'Class Phone
+'Class Tag
Class I #FFFFFF
}
+
+
Class HiddenOutside #FFFFFF
HiddenOutside ..> Model
@@ -35,20 +48,27 @@ ModelManager -left-> "1" AddressBook
ModelManager -right-> "1" UserPrefs
UserPrefs .up.|> ReadOnlyUserPrefs
-AddressBook *--> "1" UniquePersonList
-UniquePersonList --> "~* all" Person
-Person *--> Name
-Person *--> Phone
-Person *--> Email
-Person *--> Address
-Person *--> "*" Tag
+AddressBook *--> "1" UniqueDeveloperList
+UniqueDeveloperList --> "~* all" Developer
+AddressBook *--> "1" UniqueClientList
+UniqueClientList --> "~* all" Client
+AddressBook *--> "1" UniqueProjectList
+UniqueProjectList --> "~* all" Project
+'Person *--> Name
+'Person *--> Phone
+'Person *--> Email
+'Person *--> Address
+'Person *--> "*" Tag
-Person -[hidden]up--> I
-UniquePersonList -[hidden]right-> I
+Developer -[hidden]up--> I
+UniqueDeveloperList -[hidden]right-> I
+UniqueProjectList -[hidden]up-> UserPrefs
-Name -[hidden]right-> Phone
-Phone -[hidden]right-> Address
-Address -[hidden]right-> Email
+'Name -[hidden]right-> Phone
+'Phone -[hidden]right-> Address
+'Address -[hidden]right-> Email
-ModelManager --> "~* filtered" Person
+ModelManager --> "~* filtered Developers" Developer
+ModelManager --> "~* filtered Clients" Client
+ModelManager --> "~* filtered Projects" Project
@enduml
diff --git a/docs/diagrams/ModelClassDiagram2.puml b/docs/diagrams/ModelClassDiagram2.puml
new file mode 100644
index 00000000000..383e778d12d
--- /dev/null
+++ b/docs/diagrams/ModelClassDiagram2.puml
@@ -0,0 +1,74 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor MODEL_COLOR
+skinparam classBackgroundColor MODEL_COLOR
+
+Package Person as PersonPackage <>{
+Class Person
+
+
+Class Name
+Class Phone
+Class Email
+Class Address
+Class Projects
+
+Package Developer as DeveloperPackage <>{
+Class Developer
+
+Class Salary
+Class DateJoined
+Class GithubId
+Class Rating
+Class DeveloperRoles
+}
+Package Client as ClientPackage <>{
+Class Client
+
+Class Organisation
+Class Document
+Class ClientRoles
+}
+}
+
+Package Project as ProjectPackage <>{
+Class Project
+
+Class ProjectName
+Class ProjectDeadline
+Class ProjectDescription
+}
+
+Person *--> Name
+Person *--> Phone
+Person *--> Email
+Person *--> Address
+Person *-->"*"Projects
+
+Client -up-|> Person
+Developer -up-|> Person
+Developer -[hidden]up->Name
+Client -[hidden]up->Name
+
+Developer *-->Salary
+Developer *-->DateJoined
+Developer *-->GithubId
+Developer *-->Rating
+Developer *-->"*"DeveloperRoles
+
+Client *-->Organisation
+Client *-->Document
+Client *-->"*"ClientRoles
+
+Project -[hidden]up->Rating
+Project -[hidden]up->Document
+Project *-->ProjectName
+Project *-->ProjectDeadline
+Project *-->ProjectDescription
+
+'Name -[hidden]right-> Phone
+'Phone -[hidden]right-> Address
+'Address -[hidden]right-> Email
+
+@enduml
diff --git a/docs/diagrams/StorageClassDiagram.puml b/docs/diagrams/StorageClassDiagram.puml
index a821e06458c..4825beefc7e 100644
--- a/docs/diagrams/StorageClassDiagram.puml
+++ b/docs/diagrams/StorageClassDiagram.puml
@@ -18,8 +18,9 @@ package "AddressBook Storage" #F4F6F6{
Class "<>\nAddressBookStorage" as AddressBookStorage
Class JsonAddressBookStorage
Class JsonSerializableAddressBook
-Class JsonAdaptedPerson
-Class JsonAdaptedTag
+Class JsonAdaptedDeveloper
+Class JsonAdaptedClient
+Class JsonAdaptedProject
}
}
@@ -37,7 +38,8 @@ Storage -right-|> AddressBookStorage
JsonUserPrefsStorage .up.|> UserPrefsStorage
JsonAddressBookStorage .up.|> AddressBookStorage
JsonAddressBookStorage ..> JsonSerializableAddressBook
-JsonSerializableAddressBook --> "*" JsonAdaptedPerson
-JsonAdaptedPerson --> "*" JsonAdaptedTag
+JsonSerializableAddressBook --> "*" JsonAdaptedDeveloper
+JsonSerializableAddressBook --> "*" JsonAdaptedClient
+JsonSerializableAddressBook --> "*" JsonAdaptedProject
@enduml
diff --git a/docs/diagrams/UiClassDiagram.puml b/docs/diagrams/UiClassDiagram.puml
index 95473d5aa19..66371dea5cc 100644
--- a/docs/diagrams/UiClassDiagram.puml
+++ b/docs/diagrams/UiClassDiagram.puml
@@ -11,8 +11,12 @@ Class UiManager
Class MainWindow
Class HelpWindow
Class ResultDisplay
-Class PersonListPanel
-Class PersonCard
+Class DeveloperListPanel
+Class DeveloperCard
+Class ClientListPanel
+Class ClientCard
+Class ProjectListPanel
+Class ProjectCard
Class StatusBarFooter
Class CommandBox
}
@@ -32,26 +36,39 @@ UiManager .left.|> Ui
UiManager -down-> "1" MainWindow
MainWindow *-down-> "1" CommandBox
MainWindow *-down-> "1" ResultDisplay
-MainWindow *-down-> "1" PersonListPanel
+MainWindow *-down-> "1" DeveloperListPanel
+MainWindow *-down-> "1" ClientListPanel
+MainWindow *-down-> "1" ProjectListPanel
MainWindow *-down-> "1" StatusBarFooter
MainWindow --> "0..1" HelpWindow
-PersonListPanel -down-> "*" PersonCard
+
+DeveloperListPanel -down-> "*" DeveloperCard
+ClientListPanel -down-> "*" ClientCard
+ProjectListPanel -down-> "*" ProjectCard
MainWindow -left-|> UiPart
ResultDisplay --|> UiPart
CommandBox --|> UiPart
-PersonListPanel --|> UiPart
-PersonCard --|> UiPart
+DeveloperListPanel --|> UiPart
+DeveloperCard --|> UiPart
+ClientListPanel --|> UiPart
+ClientCard --|> UiPart
+ProjectListPanel --|> UiPart
+ProjectCard --|> UiPart
StatusBarFooter --|> UiPart
HelpWindow --|> UiPart
-PersonCard ..> Model
+DeveloperCard ..> Model
+ClientCard ..> Model
+ProjectCard ..> Model
UiManager -right-> Logic
MainWindow -left-> Logic
-PersonListPanel -[hidden]left- HelpWindow
+ProjectListPanel -[hidden]left- ClientListPanel
+ClientListPanel -[hidden]left- DeveloperListPanel
+DeveloperListPanel -[hidden]left- HelpWindow
HelpWindow -[hidden]left- CommandBox
CommandBox -[hidden]left- ResultDisplay
ResultDisplay -[hidden]left- StatusBarFooter
diff --git a/docs/diagrams/UndoRedoActivityDiagram.puml b/docs/diagrams/UndoRedoActivityDiagram.puml
new file mode 100644
index 00000000000..3ec83d497b3
--- /dev/null
+++ b/docs/diagrams/UndoRedoActivityDiagram.puml
@@ -0,0 +1,37 @@
+@startuml
+'https://plantuml.com/activity-diagram-beta
+
+start
+:undo
+:new page;
+if (Page.onSecurityCheck) then (true)
+ :Page.onInit();
+ if (isForward?) then (no)
+ :Process controls;
+ if (continue processing?) then (no)
+ stop
+ endif
+
+ if (isPost?) then (yes)
+ :Page.onPost();
+ else (no)
+ :Page.onGet();
+ endif
+ :Page.onRender();
+ endif
+else (false)
+endif
+
+if (do redirect?) then (yes)
+ :redirect process;
+else
+ if (do forward?) then (yes)
+ :Forward request;
+ else (no)
+ :Render page template;
+ endif
+endif
+
+stop
+
+@enduml
diff --git a/docs/diagrams/UndoSequenceDiagram.puml b/docs/diagrams/UndoSequenceDiagram.puml
index 87ff3e9237e..2f8a4cd0d56 100644
--- a/docs/diagrams/UndoSequenceDiagram.puml
+++ b/docs/diagrams/UndoSequenceDiagram.puml
@@ -37,7 +37,7 @@ activate Model
Model -> VersionedAddressBook : undo()
activate VersionedAddressBook
-VersionedAddressBook -> VersionedAddressBook :resetData(ReadOnlyAddressBook)
+VersionedAddressBook -> VersionedAddressBook :changeAddressBook(model)
VersionedAddressBook --> Model :
deactivate VersionedAddressBook
diff --git a/docs/diagrams/isRemovableRole.puml b/docs/diagrams/isRemovableRole.puml
new file mode 100644
index 00000000000..042c49335fc
--- /dev/null
+++ b/docs/diagrams/isRemovableRole.puml
@@ -0,0 +1,23 @@
+@startuml
+'https://plantuml.com/activity-diagram-beta
+
+start
+:get the full developer list;
+
+if (check is any developer using this role) then (there are developers using this role)
+ :throw developer still using error;
+ stop
+ endif
+ if (check is this role one of the pre-defined roles) then (is pre-defined role)
+ :throw cannot be deleted error;
+ stop
+ endif
+ if (check is this role in the list of existing roles) then (role does not exist)
+ :throw role does not exist error;
+ stop
+ endif
+ :delete role from existing list;
+ stop
+
+
+@enduml
diff --git a/docs/images/AddDeveloperRoleSequenceDiagram.png b/docs/images/AddDeveloperRoleSequenceDiagram.png
new file mode 100644
index 00000000000..b984caf89bd
Binary files /dev/null and b/docs/images/AddDeveloperRoleSequenceDiagram.png differ
diff --git a/docs/images/AddDeveloperSequenceDiagram.png b/docs/images/AddDeveloperSequenceDiagram.png
new file mode 100644
index 00000000000..67abbb4b76c
Binary files /dev/null and b/docs/images/AddDeveloperSequenceDiagram.png differ
diff --git a/docs/images/ArchitectureSequenceDiagram.png b/docs/images/ArchitectureSequenceDiagram.png
index 37ad06a2803..cd6d43395f6 100644
Binary files a/docs/images/ArchitectureSequenceDiagram.png and b/docs/images/ArchitectureSequenceDiagram.png differ
diff --git a/docs/images/BetterModelClassDiagram.png b/docs/images/BetterModelClassDiagram.png
index 02a42e35e76..5e8a8259b59 100644
Binary files a/docs/images/BetterModelClassDiagram.png and b/docs/images/BetterModelClassDiagram.png differ
diff --git a/docs/images/DeleteClientSequenceDiagram.png b/docs/images/DeleteClientSequenceDiagram.png
new file mode 100644
index 00000000000..be013156949
Binary files /dev/null and b/docs/images/DeleteClientSequenceDiagram.png differ
diff --git a/docs/images/DeleteDeveloperRoleSequenceDiagram.png b/docs/images/DeleteDeveloperRoleSequenceDiagram.png
new file mode 100644
index 00000000000..0b2209fc66a
Binary files /dev/null and b/docs/images/DeleteDeveloperRoleSequenceDiagram.png differ
diff --git a/docs/images/DeleteProjectSequenceDiagram.png b/docs/images/DeleteProjectSequenceDiagram.png
new file mode 100644
index 00000000000..397b8bf9c97
Binary files /dev/null and b/docs/images/DeleteProjectSequenceDiagram.png differ
diff --git a/docs/images/EditDeveloperSequenceDiagram.png b/docs/images/EditDeveloperSequenceDiagram.png
new file mode 100644
index 00000000000..baf790e3b57
Binary files /dev/null and b/docs/images/EditDeveloperSequenceDiagram.png differ
diff --git a/docs/images/FindDeveloperSequenceDiagram.png b/docs/images/FindDeveloperSequenceDiagram.png
new file mode 100644
index 00000000000..41b2db7d865
Binary files /dev/null and b/docs/images/FindDeveloperSequenceDiagram.png differ
diff --git a/docs/images/ImportDeveloperSequenceDiagram.png b/docs/images/ImportDeveloperSequenceDiagram.png
new file mode 100644
index 00000000000..747b30b89f0
Binary files /dev/null and b/docs/images/ImportDeveloperSequenceDiagram.png differ
diff --git a/docs/images/ListDeveloperSequenceDiagram.png b/docs/images/ListDeveloperSequenceDiagram.png
new file mode 100644
index 00000000000..2fea1533c48
Binary files /dev/null and b/docs/images/ListDeveloperSequenceDiagram.png differ
diff --git a/docs/images/MarkDeadlineSequenceDiagram.png b/docs/images/MarkDeadlineSequenceDiagram.png
new file mode 100644
index 00000000000..2fa29113637
Binary files /dev/null and b/docs/images/MarkDeadlineSequenceDiagram.png differ
diff --git a/docs/images/ModelClassDiagram.png b/docs/images/ModelClassDiagram.png
index a19fb1b4ac8..d6fcf8ca888 100644
Binary files a/docs/images/ModelClassDiagram.png and b/docs/images/ModelClassDiagram.png differ
diff --git a/docs/images/ModelClassDiagramB.png b/docs/images/ModelClassDiagramB.png
new file mode 100644
index 00000000000..71293661291
Binary files /dev/null and b/docs/images/ModelClassDiagramB.png differ
diff --git a/docs/images/StorageClassDiagram.png b/docs/images/StorageClassDiagram.png
index 18fa4d0d51f..fdb697a23f4 100644
Binary files a/docs/images/StorageClassDiagram.png and b/docs/images/StorageClassDiagram.png differ
diff --git a/docs/images/UG UI 1.png b/docs/images/UG UI 1.png
new file mode 100644
index 00000000000..cdd6eaba6fb
Binary files /dev/null and b/docs/images/UG UI 1.png differ
diff --git a/docs/images/UG UI 2.png b/docs/images/UG UI 2.png
new file mode 100644
index 00000000000..6d42b393f34
Binary files /dev/null and b/docs/images/UG UI 2.png differ
diff --git a/docs/images/Ui.png b/docs/images/Ui.png
index 5bd77847aa2..966ce0f4b22 100644
Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ
diff --git a/docs/images/UiClassDiagram.png b/docs/images/UiClassDiagram.png
index 11f06d68671..1df9e2c7fed 100644
Binary files a/docs/images/UiClassDiagram.png and b/docs/images/UiClassDiagram.png differ
diff --git a/docs/images/UndoSequenceDiagram.png b/docs/images/UndoSequenceDiagram.png
index c7a7e637266..4e23d7f95d6 100644
Binary files a/docs/images/UndoSequenceDiagram.png and b/docs/images/UndoSequenceDiagram.png differ
diff --git a/docs/images/addClientRole.png b/docs/images/addClientRole.png
new file mode 100644
index 00000000000..634a176cae5
Binary files /dev/null and b/docs/images/addClientRole.png differ
diff --git a/docs/images/addDeveloperRole.png b/docs/images/addDeveloperRole.png
new file mode 100644
index 00000000000..454ea666510
Binary files /dev/null and b/docs/images/addDeveloperRole.png differ
diff --git a/docs/images/companyProfile.png b/docs/images/companyProfile.png
new file mode 100644
index 00000000000..26108db205b
Binary files /dev/null and b/docs/images/companyProfile.png differ
diff --git a/docs/images/deleteClientRole.png b/docs/images/deleteClientRole.png
new file mode 100644
index 00000000000..e830a31b0c6
Binary files /dev/null and b/docs/images/deleteClientRole.png differ
diff --git a/docs/images/deleteClientRoleErr.png b/docs/images/deleteClientRoleErr.png
new file mode 100644
index 00000000000..df523a5407a
Binary files /dev/null and b/docs/images/deleteClientRoleErr.png differ
diff --git a/docs/images/deleteDeveloperRole.png b/docs/images/deleteDeveloperRole.png
new file mode 100644
index 00000000000..fde53ef6e66
Binary files /dev/null and b/docs/images/deleteDeveloperRole.png differ
diff --git a/docs/images/deleteDeveloperRoleErr.png b/docs/images/deleteDeveloperRoleErr.png
new file mode 100644
index 00000000000..84f4c57f71d
Binary files /dev/null and b/docs/images/deleteDeveloperRoleErr.png differ
diff --git a/docs/images/emzm2023.png b/docs/images/emzm2023.png
new file mode 100644
index 00000000000..b382803ed6a
Binary files /dev/null and b/docs/images/emzm2023.png differ
diff --git a/docs/images/isRemovableRole.png b/docs/images/isRemovableRole.png
new file mode 100644
index 00000000000..03640755a81
Binary files /dev/null and b/docs/images/isRemovableRole.png differ
diff --git a/docs/images/mahidharah.png b/docs/images/mahidharah.png
new file mode 100644
index 00000000000..f878cbc1d1e
Binary files /dev/null and b/docs/images/mahidharah.png differ
diff --git a/docs/images/mingyu-wan.png b/docs/images/mingyu-wan.png
new file mode 100644
index 00000000000..324eda9e630
Binary files /dev/null and b/docs/images/mingyu-wan.png differ
diff --git a/docs/images/ncmathan.png b/docs/images/ncmathan.png
new file mode 100644
index 00000000000..f6b7bffaf66
Binary files /dev/null and b/docs/images/ncmathan.png differ
diff --git a/docs/images/newEmployee.png b/docs/images/newEmployee.png
new file mode 100644
index 00000000000..60eed74a676
Binary files /dev/null and b/docs/images/newEmployee.png differ
diff --git a/docs/images/redo.png b/docs/images/redo.png
new file mode 100644
index 00000000000..629501e159e
Binary files /dev/null and b/docs/images/redo.png differ
diff --git a/docs/images/searchPicture.png b/docs/images/searchPicture.png
new file mode 100644
index 00000000000..36ab5782dc7
Binary files /dev/null and b/docs/images/searchPicture.png differ
diff --git a/docs/images/undo.png b/docs/images/undo.png
new file mode 100644
index 00000000000..f9094df86bf
Binary files /dev/null and b/docs/images/undo.png differ
diff --git a/docs/images/updateDetails.png b/docs/images/updateDetails.png
new file mode 100644
index 00000000000..349ffff5d64
Binary files /dev/null and b/docs/images/updateDetails.png differ
diff --git a/docs/images/waseemingly.png b/docs/images/waseemingly.png
new file mode 100644
index 00000000000..3f8a586b7de
Binary files /dev/null and b/docs/images/waseemingly.png differ
diff --git a/docs/index.md b/docs/index.md
index 7601dbaad0d..9e15e89b118 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,17 +1,17 @@
---
layout: page
-title: AddressBook Level-3
+title: CodeContact
---
-[](https://github.com/se-edu/addressbook-level3/actions)
-[](https://codecov.io/gh/se-edu/addressbook-level3)
+[](https://github.com/AY2324S1-CS2103T-T09-2/tp/actions)
+[](https://codecov.io/gh/AY2324S1-CS2103T-T09-2/tp/tree/master)
-**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+**CodeContact is a desktop application for managing your employee details in a software company.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
-* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
-* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
+* If you are interested in using CodeContact, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
+* If you are interested about developing CodeContact, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
**Acknowledgements**
diff --git a/docs/team/emzm2023.md b/docs/team/emzm2023.md
new file mode 100644
index 00000000000..4a4928a3c3a
--- /dev/null
+++ b/docs/team/emzm2023.md
@@ -0,0 +1,85 @@
+---
+layout: page
+title: Elizabeth's Project Portfolio Page
+---
+### Project: CodeContact
+
+CodeContact is a desktop address book solution for Software Engineering companies. The user interacts with it using a
+CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+
+Given below are my contributions to the project.
+
+* **New Feature**: `mark-deadline` and `unmark-deadline`
+ * What it does: Gives users the ability to mark project deadlines as done or undone.
+ * Justification: One basic job of project managers is to manage deadlines, so having a mark and unmark feature
+ allows them to update the status of the project and project deadlines accordingly.
+ * Highlights: Deadline fields had to be updated to ensure that an index is saved when a deadline for a project is
+ created. Further methods also had to be implemented to toggle the `isDone` status of a deadline between `true` and
+ `false`. Additional changes to the existing GUI were made to reflect deadline numbers to allow users to mark and
+ unmark deadlines according to the index. This involved adding a new column to the table of deadlines that displayed
+ deadline indexes.
+
+ + +* **Enhancement to existing features**: `edit-developer`, `edit-client`, `edit-project` + * What it does: Allows users to edit the fields of existing developers, clients, and projects. + * Justification: This gives project managers the flexibility and freedom to change and update the details if + necessary. Aside from keeping contact details accurate, this is also especially important as it allows for the + reassignment of developers to new projects and the updating of project deadlines after milestones. + * Highlights: Edits are done according to the object's index in the displayed list in the relevant tab. Making + edits to objects automatically switches the tab on the GUI to the relevant one. Various code changes to the existing + `edit` function had to be made to account for the different fields of the object to edit, as well as various + implemented restrictions on fields that could and could not be changed. The respective Parser and Command classes + were extended to account for each additional field, and thorough checks were implemented to ensure that users are + unable to access prefixes that are meant for other objects. +
+ +* **Enhancements to existing features**: + * Updated the GUI project table columns and CSS (Pull request #142) +
+ +* **Other significant code contributions**: + * Initially implemented edit command with behaviour varying in response to access rights, but undid changes due to + shift in project direction (Pull requests #59, #66) + * Implemented Project and Project relevant classes (eg. Deadline, Priority, Description) for use by team (Pull + request #73) + * Implemented project validation checks to ensure assigned projects exist in the address book (Pull request #159) + * Wrote additional tests for features to increase coverage (Pull request #249) +
+ +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=emzm2023&breakdown=true) +
+ +* **Project management (team-based tasks contributions)**: + * Set up project schedule tracking with milestones and issues for `v1.1` + * Updated Developer Guide with project notes for `v1.1` + * Add screenshots of UI and managed the collaboration group document for tutorial checks + * Create and release JAR file for `v1.3` and `v1.4` + * Assign labels and assignees to bug issues in post-PED +
+ + +* **Documentation Contributions**: + * User Guide Contributions: + * Added documentation for the features add, edit and mark/unmark deadline features + (Pull requests #104, #151, #163, #263) + * Created template format for other team members to follow for their portion of the User Guide (Pull request + #151) + * Did extensive cosmetic tweaks for standardisation and fixed bugs across entire UG (Pull requests #252, #279) + * Developer Guide Contributions: + * Added all user stories and several use cases for initial iteration, but undid changes due to shift in project + direction (Pull request #35) + * Added implementation details of the features `edit-developer`, `edit-client`, `edit-project`, `mark-deadline` + , and `unmark-deadline` (Pull requests #109, #263) + * Added instructions for manual testing in Appendix (Pull request #263) + * Added planned enhancements in Appendix (Pull request #263) + * Did extensive cosmetic tweaks for standardisation and fixed bugs across entire DG (Pull request #279) +
+ +* **Community (Review/mentoring contributions)**: + * Helped to modify add command parsers with part of my implementation for edit command parsers to ensure more + thorough and bug-free parsing of user inputs (Pull request #127) + * Conducted pull request reviews for team members (Pull request #238) + +* **Contributions beyond the project team**: + * Reported bugs and suggestions for other teams in the cohort diff --git a/docs/team/johndoe.md b/docs/team/johndoe.md deleted file mode 100644 index 773a07794e2..00000000000 --- a/docs/team/johndoe.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: page -title: John Doe's Project Portfolio Page ---- - -### Project: AddressBook Level 3 - -AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. - -Given below are my contributions to the project. - -* **New Feature**: Added the ability to undo/redo previous commands. - * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command. - * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them. - * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands. - * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}* - -* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys. - -* **Code contributed**: [RepoSense link]() - -* **Project management**: - * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub - -* **Enhancements to existing features**: - * Updated the GUI color scheme (Pull requests [\#33](), [\#34]()) - * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]()) - -* **Documentation**: - * User Guide: - * Added documentation for the features `delete` and `find` [\#72]() - * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]() - * Developer Guide: - * Added implementation details of the `delete` feature. - -* **Community**: - * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]() - * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]()) - * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]()) - * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]()) - -* **Tools**: - * Integrated a third party library (Natty) to the project ([\#42]()) - * Integrated a new Github plugin (CircleCI) to the team repo - -* _{you can add/remove categories in the list above}_ diff --git a/docs/team/mahidharah.md b/docs/team/mahidharah.md new file mode 100644 index 00000000000..bff12035e8a --- /dev/null +++ b/docs/team/mahidharah.md @@ -0,0 +1,74 @@ +--- +layout: page +title: Mahidharah's Project Portfolio Page +--- + +### Project: CodeContact + +CodeContact is a desktop app for managing contacts, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). +If you can type fast, CodeContact can get your contact management tasks done faster than traditional GUI apps. + +Our product helps seamlessly integrate contact, client, and project management, simplifying access to coding-related contacts, facilitating collaboration, and offering command-line efficiency for project managers. + +Given below are my contributions to the project. + + +* **New Feature 1**: `add-developer`, `add-client` & `add-project` + * What it does: Adds a developer/client/project to the address book, making sure input parameters are valid and potential duplicates are found, highlighted to the user and rejected. + * Justification: Decided to separate these as different commands instead of having a single `add` command to allow for more flexibility with parameters changes to these features in the future (from basic OOP principles). This also allows for more specific error messages to be displayed to users when they input invalid parameters, utilising polymorphism. + * Highlights: Allows specific optional fields (i.e Project deadline). Automatically switches tabs according to command. + + + +* **New Feature 2**: `delete-developer` & `delete-client` + * What it does: Deletes a developer/client from the address book. + * Justification: Decided to separate these as different commands instead of having a single `delete` command to allow for more flexibility with parameters changes to these features in the future (from basic OOP principles). This also allows for more specific error messages to be displayed to users when they input invalid parameters, utilising polymorphism. + * Highlights: Automatically switches tabs according to command. + + + +* **New Feature 3**: `delete-project` + * What it does: Deletes a project from the address book and accordingly removes it from the set of projects for all developers and clients. + * Justification: I decided to implement the feature such that it triggers updates on developers and clients with hopes that this feature will be a major quality of life improvement for project managers, enabling them to remove projects easily without having to edit the information for relevant clients and developers to maintain integrity of the data. + * Highlights: Automatically switches tabs according to command. This feature uses the iterator java class and its for each remaining method effectively to simplify code and ensure efficiency. + + +* **Enhancements to existing features**: + * Contributed to the GUI component of CodeContact by creating relevant classes and FXML files for developer and client cards (Pull request [\#79](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/79)) + * Ensured functional improvements use developer and client classes instead of person class (Pull request [\#79](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/79)) + * Edited SampleData to include sample developers, clients and projects for easy testing for teammates (Pull request [\#79](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/79)) + + +* **Testing**: + * Enabled test files to work for other team members and contributed greatly to testcode + * Wrote testcases for model, logic and storage, and edited necessary test utility files to account for functional developments of CodeContact, speciafically developer and client features (Pull request [\#216](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/216), [\#222](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/222), [\#236](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/236)) + * Wrote testcases for my functional contributions to Codecontact. (Pull request [\#216](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/216), [\#236](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/222), [\#236](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/236)) + + +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=Mahidharah&tabRepo=AY2324S1-CS2103T-T09-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false) + + +* **Project management(team-based tasks contributions)**: + * Responsible for the timely pivot of our team project in v1.2 after checking in with tutors and professors + * Spearheaded the pivot by suggesting a new idea and directing the team to a new project which effectively carried over previous functional contributions + * Actively contributed during team meetings and reminded team members of upcoming deadlines + + + +* **Documentation Contributions**: + * User Guide Contributions: + * Added documentation for the features `delete-developer`, `delete-client`, `delete-project`, `add-developer`, `add-client`, `add-project` + * Did cosmetic tweaks to existing documentation of feature list table + * Developer Guide Contributions: + * Added implementation details of the `delete` and `add` features + * Added PUML sequence diagrams for these implementations + + +* **Community (Review/mentoring contributions)**: + * PRs reviewed (with non-trivial review comments): [\#155](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/155), [\##219](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/219) + * Reported bugs and suggested ideal implementations for features for teammates + * Some parts of the delete-project feature I added was adopted by team members and classmates, for instance the following implementation of validation checks for projects + + +* **Tools**: + * Capitalised on GitHub copilot autocomplete features in creating testcases, enabling me to cover the most amount of functional code in testcases diff --git a/docs/team/mingyu-wan.md b/docs/team/mingyu-wan.md new file mode 100644 index 00000000000..91bbc1ec046 --- /dev/null +++ b/docs/team/mingyu-wan.md @@ -0,0 +1,76 @@ +--- +layout: page +title: Mingyu's Project Portfolio Page +--- + +### Project: CodeContact + +CodeContact is a desktop address book solution for Software Engineering companies. The user interacts with it using a +CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **New Feature 1**: `Undo` n `Redo` + * What it does:
Allows users to undo and redo their command easily. + * Justification:
This feature enhances user experience by allowing effortless reversal of previous actions, + providing convenience in scenarios where unintended changes are made. + * Highlights:
The undo and redo feature is unlimited, allowing users to revert all the way to their first or last command using + the simple `undo` or `redo` command, ensuring ease of use. + * Credits:
Inspired by the AB-3 developer guide, this feature employs a pointer to change the address book at each undo or redo command. + Additional validation checks were added for CodeContact's complexity. +
+ +* **New Feature 2**: `Adding roles ` + * What it does:
Allows users to add different roles. + * Justification:
This feature minimizes risks associated with incorrect role assignments by allowing explicit +definition and addition of developer or client roles. It ensures a standardized set of role names, +reducing the chance of mislabeling and improving searchability within CodeContact. + * Highlights:
The feature provides separate commands (add-developer-role and add-client-role) for adding developers and clients, +adding clarity to the role assignment process. A pre-added list of roles for clients and developers facilitates user adoption, and validation checks prevent the addition of repeated roles. + * Credits: N.A. +
+ +* **New Feature 3**: `Deleting roles ` + * What it does:
Allows users to delete different roles. + * Justification:
This CodeContact feature is crucial for user data management, enabling users to refine and update the list of roles. + Deleting roles is essential for maintaining a clean and relevant role structure, empowering users to adapt roles to evolving needs and ensuring accuracy in the address book. + * Highlights:
Separate commands (delete-developer-role and delete-client-role) cater to the unique needs of deleting developers and clients. + To prevent accidental deletion when roles are in use, the feature checks for active developers and clients before deletion. Users cannot delete pre-added roles from CodeContact. + * Credits: N.A. +
+ +* **Enhancements to existing features**: + * Modified list feature to work with our new tab and fields (Pull requests [\#113](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/113)) + * Fixed parts of the test cases to pass again (Pull requests [\#225](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/225)) + * Increased code coverage from `32.28%` to `38%` and from `48.9%` to `54.39%`.(Pull requests [\#250](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/250) + [\#241](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/241)) +
+ +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=mingyu&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=zoom&zA=mingyu-wan&zR=AY2324S1-CS2103T-T09-2%2Ftp%5Bmaster%5D&zACS=241.3&zS=2023-09-22&zFS=mingyu&zU=2023-11-10&zMG=false&zFTF=commit&zFGS=groupByRepos&zFR=false) +
+ +* **Project management(team-based tasks contributions)**: + * Managed releases `v1.1` - `v1.4` (4 releases) on GitHub + * Managed issues creating and some assigning throughout the milestones + * Managed the collaboration document and product demo submissions for tutorial +
+ +* **Documentation Contributions**: + * User Guide Contributions: + * Removed traces of AB-3: [\#50](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/50) + * Added documentation for the features `undo`,`redo`,`add-role` and `delete-role`: [\#160](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/160) + * Did cosmetic tweaks to existing documentation of features `list`: [\#160](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/160) + * Wrote the content for `tutorial`: [\#162](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/162) + * Modified and content and UI pictures for `Quick Start`: [\#162](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/162) + * Wrote the content for `Navigating the GUI` and `Format`: [\#242](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/242) + * Developer Guide Contributions: + * Added use case (abandoned due to a shift in project): [\#43](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/43) + * Reformatted entire DG format: [\#244](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/244) + * Wrote user stories and use case: [\#246](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/246) [\#247](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/247) + * Wrote implementations, sequence and activity diagrams for features i implemented: [\#246](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/246) + * Wrote in appendix: planned enhancements: [\#247](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/246) +
+ +* **Community (Review/mentoring contributions)**: + * Reported bugs and suggestions for other teams in the cohort +
diff --git a/docs/team/ncmathan.md b/docs/team/ncmathan.md new file mode 100644 index 00000000000..dc3af462895 --- /dev/null +++ b/docs/team/ncmathan.md @@ -0,0 +1,83 @@ +--- +layout: page +title: Mathan's Project Portfolio Page +--- + +### Project: CodeContact + +CodeContact is a desktop address book solution for Software Engineering companies. The user interacts with it using a +CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **New Feature 1**: `import-developer` and `import-client` + * What it does:
Gives users the ability to import developers and clients from a CSV file. + * Justification:
Allows users to easily import a large number of developers and clients into the address book. This + is especially useful for companies that have a large number of employees and those who are new to CodeContact porting over from other address book applications. + * Highlights:
The feature is able to handle a large number of developers and clients, and is able to handle + errors such as invalid CSV files and invalid data in the CSV file. + + +* **New Feature 2**: `lock` and `unlock` + * What it does:
Gives users the ability to lock and unlock the application. + * Justification:
Allows users to lock the application when they are away from their computer, preventing + unauthorised access to the application. This is especially useful since the information stored on the application contains personal data of developers and clients, that has to be kept secure. + * Highlights:
The password is stored in a hashed format, preventing anyone from accessing the password file to view it directly. The application is also locked when the user closes the application. + + +* **New Feature 3**: `change-password` + * What it does:
Gives users the ability to change their password. + * Justification:
Allows users to change their password when they feel that their password has been compromised. This is especially useful since the information stored on the application contains personal data of developers and clients, that has to be kept secure. + * Highlights:
The password is only changed if the current password is correct, new password follows the password requirements and the new password is different from the current password. + * Credits:[Password requirements] (https://support.kaspersky.com/KPC/1.0/en-US/183862.htm) + +* **New Feature 4**: `find-deadline` + * What it does:
Gives users the ability to filter deadlines by date and priority. + * Justification:
Allows users to easily find deadlines that are due before or on a certain date, or deadlines that are of a certain priority. This is especially useful for project managers who need to keep track of deadlines. + * Highlights:
The feature is able to handle a large number of deadlines, and is able to handle errors such as invalid dates and invalid priority. + * Credits: Followed a similar structure as storing filtered lists in `ModelManager` but one level lower at the individual project level to store filtered deadlines. + + + + +* **Enhancements to existing features**: + * Update Logic and Model for Person to Developer, Client and Project (Pull request [\#92](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/92)) + * Implemented Tab Functionality (Pull request [\#96](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/96)) + * Updated the GUI color scheme from Dark Theme to Light Theme(Pull requests [\#110](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/110)) + * Updated User Guide (Pull request [\#144](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/144), [\#161](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/161), [\#243](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/243), [\#254](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/254), [\#278](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/278)) + * Updated Developer Guide (Pull Request [\#254](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/254), [\#261](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/261), [\#278](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/278)) + * Add javadocs and fixed checkstyle errors (Pull request [\#219](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/219)) + * Fixed bugs (Pull request [\#226](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/226), [\#243](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/243)) + * Wrote additional tests for existing features to increase coverage from 41% to 43% (Pull requests [\#243](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/243)) + + +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&tabAuthor=ncmathan&tabRepo=AY2324S1-CS2103T-T09-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false) + + +* **Project management(team-based tasks contributions)**: + * Managed releases `v1.2`-`v1.3` (2 JAR releases) on GitHub + * Managed issues creating and some assigning throughout the milestones + * Managed the collaboration document and product demo submissions for tutorial + * Sorted the PE-D bugs into relevant catgegories + + +* **Documentation Contributions**: + * User Guide Contributions: + * Added documentation for the features `import-developer`, `import-client`, `lock`, `unlock`, `change-password` and `find-deadline` + * Did cosmetic tweaks to existing documentation including adding a Table of Contents for features + * Developer Guide Contributions: + * Added implementation details of the `import`, `GUI` features. + * Updated the architecture diagrams and sequence diagrams in the design section to reflect changes in CodeContact + * Added Glossary section + * Added Effort section + + +* **Community (Review/mentoring contributions)**: + * PRs reviewed (with non-trivial review comments): [\#219](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/219), [\#216](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/216)) + +* **Contributions beyond the project team:**: + * Provided suggestions to other teams on how to improve their project + + +* **Tools**: + * Integrated a third party library (ControlsFX) to the project diff --git a/docs/team/waseemingly.md b/docs/team/waseemingly.md new file mode 100644 index 00000000000..75ab43df92b --- /dev/null +++ b/docs/team/waseemingly.md @@ -0,0 +1,244 @@ +--- +layout: page +title: Waseem's Project Portfolio Page +--- + +### Project: CodeContact + +CodeContact is a desktop address book solution for Software Engineering companies. The user interacts with it using a +CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **New Feature**: Find + * What it does: Project managers can find for developers, clients and projects based on the specified attributes. + * Justification: This feature improves the product significantly as project managers might want to look out for + certain attributes in a developer before adding them to a new project, or sort clients based on their + organisation or even group projects according to their deadline. + * Highlights: This implementation was challenging as it required creating new predicates for each of the attributes + of the developers, clients and projects. The feature also allows for multi-level searching as project managers + can find based on multiple attributes at the same time. This allows for even more detailed searching. The find + feature then displayed the updated filtered list on the GUI. In addition, the find implementation was utilised + in the implementation of the delete feature as well. + +* **Enhancements to existing features**: + * Wrote additional tests for existing features to increase coverage. + + +* **Code contributed + **: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=waseemingly&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos) + + +* **Project management(team-based tasks contributions)**: + * Set up GitHub team repository and organisation and added team members to the developers team. + * Set up the project website + * Set up CodeCov to generate code coverage data and provides more information about coverage of our tests. + * Created and maintained issue tracker. + * Update AboutUs and Index pages. + + +* **Documentation Contributions**: + * User Guide Contributions: + * Added documentation for the features `find` [\#164]() + * Added the table for list of acceptable parameters. + * Added UI screenshots of the app to display examples of certain features. + * Developer Guide Contributions: + * Added implementation details of the `find` feature. + * Added planned enhancements for filter results and autocorrect search. + * Added manual testing cases for `find` and `mark project deadlines` features. + * README Contributions: + * Maintained README page of repository + + +* **Community (Review/mentoring contributions)**: + * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]() + +* **Contributions beyond the project team:**: + * Reported bugs and suggestions for other teams in the cohort. + +* **Contributions to the Developer Guide (Extracts)**: + +### Find Feature + +#### Implementation + +The find feature is facilitated by a map-based strategy, associating specific prefixes (e.g., "find-developer n/" or " +find-client r/") with corresponding predicates, allowing dynamic generation of filtering criteria based on user input. + +Implemented operations include: + +- `FindCommandParser#parse()`: Interprets the user's input and generates the appropriate predicate to filter the list of + developers or clients. +- `Model#updateFilteredPersonList()`: Updates the list displayed in the UI based on the provided predicate. + +Given below is an example usage scenario and how the find mechanism behaves at each step: + +**Step 1.** The user launches the application. The list of developers and clients are displayed. + +**Step 2.** To filter developers by name, the user executes the command `find-developer n/ alice bob`. The application +recognizes the "developer n/" prefix and uses the `NameContainsKeywordsPredicate` to generate a filtering criteria. The +list in the UI is updated to only display developers named Alice or Bob. + +**Step 3.** Next, the user wants to find clients from a specific organisation. They use the +command `find-client o/ Google`. The "find-client o/" prefix maps to the `OrganisationContainsKeywordsPredicate` and +filters clients associated with Google. + +**Step 4.** If the user provides an unrecognized prefix, e.g., `find-developer z/ alice`, an error message is displayed +informing them of the correct command format. + +> :information_source: **Note:** While the user can search by multiple keywords, each keyword maps to an entire word in +> the attributes. For example, searching for "Ali" will not return "Alice". + +The following sequence diagram provides an overview of how the find operation is executed: + +[Diagram would be inserted here illustrating the parsing of the command, identification of the appropriate predicate, and subsequent filtering of the list.] + +### Design Considerations: + +**Aspect:** Implementation of the predicate map: + +**Alternative 1 (current choice):** + +- Use a long chain of `if-else` conditions for each attribute. + - **Pros:** Explicit parsing logic for each attribute. + - **Cons:** Code becomes lengthy and hard to maintain. Adding a new attribute involves modifying the parsing logic, + increasing the risk of errors. + +**Alternative 2:** + +- Use a map linking prefixes to their corresponding predicate constructors. + - **Pros:** Simplifies the parsing process. Adding a new attribute to search becomes as simple as adding a new entry + in the map. + - **Cons:** A potential mismatch between the prefix and its predicate can lead to wrong results. + +Given the benefits of a more maintainable and scalable codebase, we've decided to go with the first alternative. Future +enhancements might include fuzzy search. + + +* **Contributions to the User Guide (Extracts)**: + +### Parameter Information + +Within the tables below, you can find out more about the parameters that CodeContact supports. These parameters come in +handy when crafting commands in CodeContact. + +Here are some notes about these parameters. + +* Each parameter comes with **constraints**. These constraints detail the specific formats of text that + each parameter accepts as valid user input. + * Not following these constraints will **result in an error** when entering the command. + *Nonetheless, CodeContact will not stop working. Rather, a message will be provided to you on + how to correct your command. + +#### Common Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|------------------------------------------|----------------------------------------------------------------|-----------------------------|---------------------------------------------| +| `n/` | name of developer/client/project | alphanumeric characters and spaces, and it should not be blank | Tom Hanks, Elizabeth 2 | 成龍, 潔 いさぎ 世 よ 一 いち, Ganesh s/o Ravichandran | +| `p/` | phone number of developer/client/project | numeric characters, and it should not be blank | 94566835 | | +| `e/` | email of developer/client/project | alphanumeric characters, and it should not be blank | amy@gmail.com | | +| `a/` | address of developer/client/project | alphanumeric characters and spaces, and it should not be blank | 311, Clementi Ave 2, #02-25 | | +| `r/` | role of developer/client/project | alphabetical characters and spaces, and it should not be blank | Developer | | +| `pr/` | project name of developer/client/project | alphanumeric characters and spaces, and it should not be blank | CS2103T | | + +#### Developer Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|------------------------------|--------------------------------------------------------------------------------|----------------|----------------------| +| `g/` | github username of developer | alphanumeric characters, and it should not be blank | johng, amy123 | | +| `d/` | date joined of developer | numeric characters in DD-MM-YYYY format, and it should not be blank | 19-11-2023 | 19/11/2023, 1/1/2023 | +| `s/` | salary of developer | numeric characters, and it should not be blank | 5000 | | +| `rt/` | rating of developer | numeric characters with 1 decimal place and spaces, and it should not be blank | 5.0, 3.5 | 5,3 | + +#### Client Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|-----------------------------|----------------------------------------------------------------|----------------|------------------| +| `o/` | organisation name of client | alphanumeric characters and spaces, and it should not be blank | Google | | +| `do/` | document name of client | alphanumeric characters and spaces, and it should not be blank | google.com | | + +#### Project Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|------------------------|---|---|--| +| `dr/` | description of project | alphanumeric characters and spaces, and it should not be blank | App to allow for +different juices to be ordered | | +| `dl/` | deadline of project | alphanumeric characters and spaces, and it should not be blank| 19-12-2023,Design +backend,HIGH,0 | | + + +----------------------------------------------------------------------------------------------- + +### Find + +#### Find developer details + +Finds the details of an existing developer in the address book. + +Format: `find-developer [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME] [gh/GITHUB_ID] [ra/RATING]` + +* Finds for developers based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +Example of usage: `find-developer pr/2103T rt/5.0` + +* Prints developers in 2103/T project with a 5-star rating. + +When command succeeds, CLI shows: + +``` +This is the one developer with matching information +``` +followed by the matching developer's details in the GUI. + +#### Find client details + +Finds the details of an existing client in the address book. + +Format: `find-client [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [o/ORGANISATION] [pr/PROJECT] [d/DOCUMENT]` + +* Finds for clients based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +Example of usage: `find-client o/Google r/Senior developer` + +* Prints clients from Google of the senior developer role + +When command succeeds, CLI shows: + +``` +These are the 2 clients with matching information +``` +followed by the matching clients' details in the GUI. + +#### Find project details + +Finds the details of an existing project in the address book. + +Format: `find-project [pr/PROJECT_NAME] [d/DESCRIPTION] [dl/DEADLINE]` + +* Finds for projects based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +Example of usage: `find-project pr/JuiceApp` + +* Print projects with the name 2103T project. + +When command succeeds, CLI shows: + +``` +This is the one project with matching information +``` +followed by the matching project's details in the GUI. diff --git a/docs/tutorials/AddRemark.md b/docs/tutorials/AddRemark.md index d98f38982e7..42067a48d91 100644 --- a/docs/tutorials/AddRemark.md +++ b/docs/tutorials/AddRemark.md @@ -3,22 +3,26 @@ layout: page title: "Tutorial: Adding a command" --- -Let's walk you through the implementation of a new command — `remark`. +Let's walk you through the implementation of a new command —`remark`. -This command allows users of the AddressBook application to add optional remarks to people in their address book and edit it if required. The command should have the following format: +This command allows users of the AddressBook application to add optional remarks to people in their address book and +edit it if required. The command should have the following format: `remark INDEX r/REMARK` (e.g., `remark 2 r/Likes baseball`) We’ll assume that you have already set up the development environment as outlined in the Developer’s Guide. - ## Create a new `remark` command -Looking in the `logic.command` package, you will notice that each existing command have their own class. All the commands inherit from the abstract class `Command` which means that they must override `execute()`. Each `Command` returns an instance of `CommandResult` upon success and `CommandResult#feedbackToUser` is printed to the `ResultDisplay`. +Looking in the `logic.command` package, you will notice that each existing command have their own class. All the +commands inherit from the abstract class `Command` which means that they must override `execute()`. Each `Command` +returns an instance of `CommandResult` upon success and `CommandResult#feedbackToUser` is printed to +the `ResultDisplay`. Let’s start by creating a new `RemarkCommand` class in the `src/main/java/seedu/address/logic/command` directory. -For now, let’s keep `RemarkCommand` as simple as possible and print some output. We accomplish that by returning a `CommandResult` with an accompanying message. +For now, let’s keep `RemarkCommand` as simple as possible and print some output. We accomplish that by returning +a `CommandResult` with an accompanying message. **`RemarkCommand.java`:** @@ -28,7 +32,7 @@ package seedu.address.logic.commands; import seedu.address.model.Model; /** - * Changes the remark of an existing person in the address book. + * Changes the remark of an existing developer in the address book. */ public class RemarkCommand extends Command { @@ -43,9 +47,12 @@ public class RemarkCommand extends Command { ### Hook `RemarkCommand` into the application -Now that we have our `RemarkCommand` ready to be executed, we need to update `AddressBookParser#parseCommand()` to recognize the `remark` keyword. Add the new command to the `switch` block by creating a new `case` that returns a new instance of `RemarkCommand`. +Now that we have our `RemarkCommand` ready to be executed, we need to update `AddressBookParser#parseCommand()` to +recognize the `remark` keyword. Add the new command to the `switch` block by creating a new `case` that returns a new +instance of `RemarkCommand`. -You can refer to the changes in this [diff](https://github.com/se-edu/addressbook-level3/commit/35eb7286f18a029d39cb7a29df8f172a001e4fd8#diff-399c284cb892c20b7c04a69116fcff6ccc0666c5230a1db8e4a9145def8fa4ee). +You can refer to the changes in +this [diff](https://github.com/se-edu/addressbook-level3/commit/35eb7286f18a029d39cb7a29df8f172a001e4fd8#diff-399c284cb892c20b7c04a69116fcff6ccc0666c5230a1db8e4a9145def8fa4ee). ### Run the application @@ -55,7 +62,9 @@ Run `Main#main` and try out your new `RemarkCommand`. If everything went well, y ## Change `RemarkCommand` to throw an exception -While we have successfully printed a message to `ResultDisplay`, the command does not do what it is supposed to do. Let’s change the command to throw a `CommandException` to accurately reflect that our command is still a work in progress. +While we have successfully printed a message to `ResultDisplay`, the command does not do what it is supposed to do. +Let’s change the command to throw a `CommandException` to accurately reflect that our command is still a work in +progress.  @@ -65,8 +74,8 @@ Following the convention in other commands, we add relevant messages as constant ``` java public static final String MESSAGE_USAGE = COMMAND_WORD - + ": Edits the remark of the person identified " - + "by the index number used in the last person listing. " + + ": Edits the remark of the developer identified " + + "by the index number used in the last developer listing. " + "Existing remark will be overwritten by the input.\n" + "Parameters: INDEX (must be a positive integer) " + "r/ [REMARK]\n" @@ -88,7 +97,9 @@ Let’s change `RemarkCommand` to parse input from the user. ### Make the command accept parameters -We start by modifying the constructor of `RemarkCommand` to accept an `Index` and a `String`. While we are at it, let’s change the error message to echo the values. While this is not a replacement for tests, it is an obvious way to tell if our code is functioning as intended. +We start by modifying the constructor of `RemarkCommand` to accept an `Index` and a `String`. While we are at it, let’s +change the error message to echo the values. While this is not a replacement for tests, it is an obvious way to tell if +our code is functioning as intended. ``` java import static seedu.address.commons.util.CollectionUtil.requireAllNonNull; @@ -101,8 +112,8 @@ public class RemarkCommand extends Command { private final String remark; /** - * @param index of the person in the filtered person list to edit the remark - * @param remark of the person to be updated to + * @param index of the developer in the filtered developer list to edit the remark + * @param remark of the developer to be updated to */ public RemarkCommand(Index index, String remark) { requireAllNonNull(index, remark); @@ -134,17 +145,21 @@ public class RemarkCommand extends Command { } ``` -Your code should look something like [this](https://github.com/se-edu/addressbook-level3/commit/dc6d5139d08f6403da0ec624ea32bd79a2ae0cbf#diff-a8e35af8f9c251525063fae36c9852922a7e7195763018eacec60f3a4d87c594) after you are done. +Your code should look something +like [this](https://github.com/se-edu/addressbook-level3/commit/dc6d5139d08f6403da0ec624ea32bd79a2ae0cbf#diff-a8e35af8f9c251525063fae36c9852922a7e7195763018eacec60f3a4d87c594) +after you are done. ### Parse user input Now let’s move on to writing a parser that will extract the index and remark from the input provided by the user. -Create a `RemarkCommandParser` class in the `seedu.address.logic.parser` package. The class must extend the `Parser` interface. +Create a `RemarkCommandParser` class in the `seedu.address.logic.parser` package. The class must extend the `Parser` +interface.  -Thankfully, `ArgumentTokenizer#tokenize()` makes it trivial to parse user input. Let’s take a look at the JavaDoc provided for the function to understand what it does. +Thankfully, `ArgumentTokenizer#tokenize()` makes it trivial to parse user input. Let’s take a look at the JavaDoc +provided for the function to understand what it does. **`ArgumentTokenizer.java`:** @@ -162,7 +177,9 @@ Thankfully, `ArgumentTokenizer#tokenize()` makes it trivial to parse user input. */ ``` -We can tell `ArgumentTokenizer#tokenize()` to look out for our new prefix `r/` and it will return us an instance of `ArgumentMultimap`. Now let’s find out what we need to do in order to obtain the Index and String that we need. Let’s look through `ArgumentMultimap` : +We can tell `ArgumentTokenizer#tokenize()` to look out for our new prefix `r/` and it will return us an instance +of `ArgumentMultimap`. Now let’s find out what we need to do in order to obtain the Index and String that we need. Let’s +look through `ArgumentMultimap` : **`ArgumentMultimap.java`:** @@ -177,7 +194,8 @@ public Optional getValue(Prefix prefix) {
}
```
-This appears to be what we need to get a String of the remark. But what about the Index? Let's take a quick peek at existing `Command` that uses an index to see how it is done.
+This appears to be what we need to get a String of the remark. But what about the Index? Let's take a quick peek at
+existing `Command` that uses an index to see how it is done.
**`DeleteCommandParser.java`:**
@@ -188,7 +206,8 @@ return new DeleteCommand(index);
There appears to be another utility class that obtains an `Index` from the input provided by the user.
-Now that we have the know-how to extract the data that we need from the user’s input, we can parse the user command and create a new instance of `RemarkCommand`, as given below.
+Now that we have the know-how to extract the data that we need from the user’s input, we can parse the user command and
+create a new instance of `RemarkCommand`, as given below.
**`RemarkCommandParser.java`:**
@@ -223,24 +242,33 @@ If you are stuck, check out the sample
## Add `Remark` to the model
-Now that we have all the information that we need, let’s lay the groundwork for propagating the remarks added into the in-memory storage of person data. We achieve that by working with the `Person` model. Each field in a Person is implemented as a separate class (e.g. a `Name` object represents the person’s name). That means we should add a `Remark` class so that we can use a `Remark` object to represent a remark given to a person.
+Now that we have all the information that we need, let’s lay the groundwork for propagating the remarks added into the
+in-memory storage of developer data. We achieve that by working with the `Person` model. Each field in a Person is
+implemented as a separate class (e.g. a `Name` object represents the developer’s name). That means we should add
+a `Remark` class so that we can use a `Remark` object to represent a remark given to a developer.
### Add a new `Remark` class
-Create a new `Remark` in `seedu.address.model.person`. Since a `Remark` is a field that is similar to `Address`, we can reuse a significant bit of code.
+Create a new `Remark` in `seedu.address.model.developer`. Since a `Remark` is a field that is similar to `Address`, we
+can reuse a significant bit of code.
-A copy-paste and search-replace later, you should have something like [this](https://github.com/se-edu/addressbook-level3/commit/4516e099699baa9e2d51801bd26f016d812dedcc#diff-41bb13c581e280c686198251ad6cc337cd5e27032772f06ed9bf7f1440995ece). Note how `Remark` has no constrains and thus does not require input
+A copy-paste and search-replace later, you should have something
+like [this](https://github.com/se-edu/addressbook-level3/commit/4516e099699baa9e2d51801bd26f016d812dedcc#diff-41bb13c581e280c686198251ad6cc337cd5e27032772f06ed9bf7f1440995ece).
+Note how `Remark` has no constrains and thus does not require input
validation.
### Make use of `Remark`
-Let’s change `RemarkCommand` and `RemarkCommandParser` to use the new `Remark` class instead of plain `String`. These should be relatively simple changes.
+Let’s change `RemarkCommand` and `RemarkCommandParser` to use the new `Remark` class instead of plain `String`. These
+should be relatively simple changes.
## Add a placeholder element for remark to the UI
-Without getting too deep into `fxml`, let’s go on a 5 minute adventure to get some placeholder text to show up for each person.
+Without getting too deep into `fxml`, let’s go on a 5 minute adventure to get some placeholder text to show up for each
+developer.
-Simply add the following to [`seedu.address.ui.PersonCard`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-639834f1e05afe2276a86372adf0fe5f69314642c2d93cfa543d614ce5a76688).
+Simply add the following
+to [`seedu.address.ui.DeveloperCard`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-639834f1e05afe2276a86372adf0fe5f69314642c2d93cfa543d614ce5a76688).
**`PersonCard.java`:**
@@ -249,10 +277,11 @@ Simply add the following to [`seedu.address.ui.PersonCard`](https://github.com/s
private Label remark;
```
+`@FXML` is an annotation that marks a private or protected field and makes it accessible to FXML. It might sound like
+Greek to you right now, don’t worry — we will get back to it later.
-`@FXML` is an annotation that marks a private or protected field and makes it accessible to FXML. It might sound like Greek to you right now, don’t worry — we will get back to it later.
-
-Then insert the following into [`main/resources/view/PersonListCard.fxml`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-d44c4f51c24f6253c277a2bb9bc440b8064d9c15ad7cb7ceda280bca032efce9).
+Then insert the following
+into [`main/resources/view/PersonListCard.fxml`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-d44c4f51c24f6253c277a2bb9bc440b8064d9c15ad7cb7ceda280bca032efce9).
**`PersonListCard.fxml`:**
@@ -270,11 +299,13 @@ Since `PersonCard` displays data from a `Person`, we need to update `Person` to
### Modify `Person`
-We change the constructor of `Person` to take a `Remark`. We will also need to define new fields and accessors accordingly to store our new addition.
+We change the constructor of `Person` to take a `Remark`. We will also need to define new fields and accessors
+accordingly to store our new addition.
### Update other usages of `Person`
-Unfortunately, a change to `Person` will cause other commands to break, you will have to modify these commands to use the updated `Person`!
+Unfortunately, a change to `Person` will cause other commands to break, you will have to modify these commands to use
+the updated `Person`!
-Note how the diagram shows only the execution flows _between_ the main components. That is, it does not show details of the execution path *inside* each component. By hiding those details, the diagram aims to inform the reader about the overall execution path of a command without overwhelming the reader with too much details. In this tutorial, you aim to find those omitted details so that you get a more in-depth understanding of how the code works.
+Note how the diagram shows only the execution flows _between_ the main components. That is, it does not show details of
+the execution path *inside* each component. By hiding those details, the diagram aims to inform the reader about the
+overall execution path of a command without overwhelming the reader with too much details. In this tutorial, you aim to
+find those omitted details so that you get a more in-depth understanding of how the code works.
Before we proceed, ensure that you have done the following:
+
1. Read the [*Architecture* section of the DG](../DeveloperGuide.md#architecture)
1. Set up the project in Intellij IDEA
1. Learn basic debugging features of Intellij IDEA
- * If you are using a different IDE, we'll leave it to you to figure out the equivalent feature to use in your IDE.
- * If you are not using an IDE, we'll let you figure out how to achieve the same using your coding toolchain.
+ * If you are using a different IDE, we'll leave it to you to figure out the equivalent feature to use in your IDE.
+ * If you are not using an IDE, we'll let you figure out how to achieve the same using your coding toolchain.
## Setting a breakpoint
-As you know, the first step of debugging is to put in a breakpoint where you want the debugger to pause the execution. For example, if you are trying to understand how the App starts up, you would put a breakpoint in the first statement of the `main` method.
+As you know, the first step of debugging is to put in a breakpoint where you want the debugger to pause the execution.
+For example, if you are trying to understand how the App starts up, you would put a breakpoint in the first statement of
+the `main` method.
-In our case, we would want to begin the tracing at the very point where the App start processing user input (i.e., somewhere in the UI component), and then trace through how the execution proceeds through the UI component. However, the execution path through a GUI is often somewhat obscure due to various *event-driven mechanisms* used by GUI frameworks, which happens to be the case here too. Therefore, let us put the breakpoint where the `UI` transfers control to the `Logic` component.
+In our case, we would want to begin the tracing at the very point where the App start processing user input (i.e.,
+somewhere in the UI component), and then trace through how the execution proceeds through the UI component. However, the
+execution path through a GUI is often somewhat obscure due to various *event-driven mechanisms* used by GUI frameworks,
+which happens to be the case here too. Therefore, let us put the breakpoint where the `UI` transfers control to
+the `Logic` component.
-According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method that belongs to the `Logic` component yields a promising candidate in `seedu.address.logic.Logic`.
+According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control
+to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method
+that belongs to the `Logic` component yields a promising candidate in `seedu.address.logic.Logic`.
-Next, let's find out which statement(s) in the `UI` code is calling this method, thus transferring control from the `UI` to the `Logic`.
+Next, let's find out which statement(s) in the `UI` code is calling this method, thus transferring control from the `UI`
+to the `Logic`.
- `CommandResult commandResult = logic.execute(commandText);` is the line that you end up at (i.e., the place where we put the breakpoint). + `CommandResult commandResult = logic.execute(commandText);` is the line that you end up at (i.e., the place where we + put the breakpoint). -1. We are interested in the `logic.execute(commandText)` portion of that line so let’s _Step in_ into that method call:
-  +1. We are interested in the `logic.execute(commandText)` portion of that line so let’s _Step in_ into that method + call:
+  -1. We end up in `LogicManager#execute()` (not `Logic#execute` -- but this is expected because we know the `execute()` method in the `Logic` interface is actually implemented by the `LogicManager` class). Let’s take a look at the body of the method. Given below is the same code, with additional explanatory comments. +1. We end up in `LogicManager#execute()` (not `Logic#execute` -- but this is expected because we know the `execute()` + method in the `Logic` interface is actually implemented by the `LogicManager` class). Let’s take a look at the body + of the method. Given below is the same code, with additional explanatory comments. **LogicManager\#execute().** @@ -136,12 +169,14 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [ } ``` -1. `LogicManager#execute()` appears to delegate most of the heavy lifting to other components. Let’s take a closer look at each one. +1. `LogicManager#execute()` appears to delegate most of the heavy lifting to other components. Let’s take a closer look + at each one. 1. _Step over_ the logging code since it is of no interest to us now.  -1. _Step into_ the line where user input in parsed from a String to a Command, which should bring you to the `AddressBookParser#parseCommand()` method (partial code given below): +1. _Step into_ the line where user input in parsed from a String to a Command, which should bring you to + the `AddressBookParser#parseCommand()` method (partial code given below): ``` java public Command parseCommand(String userInput) throws ParseException { ... @@ -150,12 +185,14 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [ ... ``` -1. _Step over_ the statements in that method until you reach the `switch` statement. The 'Variables' window now shows the value of both `commandWord` and `arguments`:
-  +1. _Step over_ the statements in that method until you reach the `switch` statement. The 'Variables' window now shows + the value of both `commandWord` and `arguments`:
+  1. We see that the value of `commandWord` is now `edit` but `arguments` is still not processed in any meaningful way. -1. Stepping through the `switch` block, we end up at a call to `EditCommandParser().parse()` as expected (because the command we typed is an edit command). +1. Stepping through the `switch` block, we end up at a call to `EditCommandParser().parse()` as expected (because the + command we typed is an edit command). ``` java ... @@ -164,93 +201,121 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [ ... ``` -1. Let’s see what `EditCommandParser#parse()` does by stepping into it. You might have to click the 'step into' button multiple times here because there are two method calls in that statement: `EditCommandParser()` and `parse()`. +1. Let’s see what `EditCommandParser#parse()` does by stepping into it. You might have to click the 'step into' button + multiple times here because there are two method calls in that statement: `EditCommandParser()` and `parse()`.
+1. The rest of the method seems to exhaustively check for the existence of each possible parameter of the `edit` command + and store any possible changes in an `EditPersonDescriptor`. Recall that we can verify the contents + of `editPersonDesciptor` through the 'Variables' window.
 -1. As you just traced through some code involved in parsing a command, you can take a look at this class diagram to see where the various parsing-related classes you encountered fit into the design of the `Logic` component. +1. As you just traced through some code involved in parsing a command, you can take a look at this class diagram to see + where the various parsing-related classes you encountered fit into the design of the `Logic` component.
1. Let’s continue stepping through until we return to `LogicManager#execute()`.
- The sequence diagram below shows the details of the execution path through the Logic component. Does the execution path you traced in the code so far match the diagram?
-  + The sequence diagram below shows the details of the execution path through the Logic component. Does the execution + path you traced in the code so far match the diagram?
+  -1. Now, step over until you read the statement that calls the `execute()` method of the `EditCommand` object received, and step into that `execute()` method (partial code given below): +1. Now, step over until you read the statement that calls the `execute()` method of the `EditCommand` object received, + and step into that `execute()` method (partial code given below): **`EditCommand#execute()`:** ``` java @Override public CommandResult execute(Model model) throws CommandException { ... - Person personToEdit = lastShownList.get(index.getZeroBased()); - Person editedPerson = createEditedPerson(personToEdit, editPersonDescriptor); - if (!personToEdit.isSamePerson(editedPerson) && model.hasPerson(editedPerson)) { + Person developerToEdit = lastShownList.get(index.getZeroBased()); + Person editedDeveloper = createEditedPerson(developerToEdit, editPersonDescriptor); + if (!developerToEdit.isSamePerson(editedDeveloper) && model.hasPerson(editedDeveloper)) { throw new CommandException(MESSAGE_DUPLICATE_PERSON); } - model.setPerson(personToEdit, editedPerson); + model.setPerson(developerToEdit, editedDeveloper); model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS); - return new CommandResult(String.format(MESSAGE_EDIT_PERSON_SUCCESS, editedPerson)); + return new CommandResult(String.format(MESSAGE_EDIT_PERSON_SUCCESS, editedDeveloper)); } ``` 1. As suspected, `command#execute()` does indeed make changes to the `model` object. Specifically, - * it uses the `setPerson()` method (defined in the interface `Model` and implemented in `ModelManager` as per the usual pattern) to update the person data. - * it uses the `updateFilteredPersonList` method to ask the `Model` to populate the 'filtered list' with _all_ persons.
- FYI, The 'filtered list' is the list of persons resulting from the most recent operation that will be shown to the user immediately after. For the `edit` command, we populate it with all the persons so that the user can see the edited person along with all other persons. If this was a `find` command, we would be setting that list to contain the search results instead.
- To provide some context, given below is the class diagram of the `Model` component. See if you can figure out where the 'filtered list' of persons is being tracked. -
- * :bulb: This may be a good time to read through the [`Model` component section of the DG](../DeveloperGuide.html#model-component) - -1. As you step through the rest of the statements in the `EditCommand#execute()` method, you'll see that it creates a `CommandResult` object (containing information about the result of the execution) and returns it.
- Advancing the debugger by one more step should take you back to the middle of the `LogicManager#execute()` method.
- -1. Given that you have already seen quite a few classes in the `Logic` component in action, see if you can identify in this partial class diagram some of the classes you've encountered so far, and see how they fit into the class structure of the `Logic` component: -
- * :bulb: This may be a good time to read through the [`Logic` component section of the DG](../DeveloperGuide.html#logic-component)
-
-1. Similar to before, you can step over/into statements in the `LogicManager#execute()` method to examine how the control is transferred to the `Storage` component and what happens inside that component.
+ * it uses the `setPerson()` method (defined in the interface `Model` and implemented in `ModelManager` as per the
+ usual pattern) to update the developer data.
+ * it uses the `updateFilteredPersonList` method to ask the `Model` to populate the 'filtered list' with _all_
+ developers.
+ FYI, The 'filtered list' is the list of developers resulting from the most recent operation that will be shown to + the user immediately after. For the `edit` command, we populate it with all the developers so that the user can + see the edited developer along with all other developers. If this was a `find` command, we would be setting that + list to contain the search results instead.
+ To provide some context, given below is the class diagram of the `Model` component. See if you can figure out + where the 'filtered list' of developers is being tracked. +
+ * :bulb: This may be a good time to read through + the [`Model` component section of the DG](../DeveloperGuide.html#model-component) + +1. As you step through the rest of the statements in the `EditCommand#execute()` method, you'll see that it creates + a `CommandResult` object (containing information about the result of the execution) and returns it.
+ Advancing the debugger by one more step should take you back to the middle of the `LogicManager#execute()` + method.
+ +1. Given that you have already seen quite a few classes in the `Logic` component in action, see if you can identify in + this partial class diagram some of the classes you've encountered so far, and see how they fit into the class + structure of the `Logic` component: +
+ * :bulb: This may be a good time to read through
+ the [`Logic` component section of the DG](../DeveloperGuide.html#logic-component)
+
+1. Similar to before, you can step over/into statements in the `LogicManager#execute()` method to examine how the
+ control is transferred to the `Storage` component and what happens inside that component.
+1. While you are stepping through the classes in the `Storage` component, here is the component's class diagram to help + you understand how those classes fit into the structure of the component.
- * :bulb: This may be a good time to read through the [`Storage` component section of the DG](../DeveloperGuide.html#storage-component)
+ * :bulb: This may be a good time to read through
+ the [`Storage` component section of the DG](../DeveloperGuide.html#storage-component)
-1. We can continue to step through until you reach the end of the `LogicManager#execute()` method and return to the `MainWindow#executeCommand()` method (the place where we put the original breakpoint).
+1. We can continue to step through until you reach the end of the `LogicManager#execute()` method and return to
+ the `MainWindow#executeCommand()` method (the place where we put the original breakpoint).
1. Stepping into `resultDisplay.setFeedbackToUser(commandResult.getFeedbackToUser());`, we end up in:
- **`ResultDisplay#setFeedbackToUser()`**
+ **`ResultDisplay#setFeedbackToUser()`**
``` java
public void setFeedbackToUser(String feedbackToUser) {
requireNonNull(feedbackToUser);
@@ -259,43 +324,45 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
```
1. Finally, you can step through until you reach the end of`MainWindow#executeCommand()`.
- :bulb: This may be a good time to read through the [`UI` component section of the DG](../DeveloperGuide.html#ui-component) - + :bulb: This may be a good time to read through + the [`UI` component section of the DG](../DeveloperGuide.html#ui-component) ## Conclusion -In this tutorial, we traced a valid edit command from raw user input to the result being displayed to the user. From this tutorial, you learned more about how the various components work together to produce a response to a user command. +In this tutorial, we traced a valid edit command from raw user input to the result being displayed to the user. From +this tutorial, you learned more about how the various components work together to produce a response to a user command. -Here are some quick questions you can try to answer based on your execution path tracing. In some cases, you can do further tracing for the given commands to find exactly what happens. +Here are some quick questions you can try to answer based on your execution path tracing. In some cases, you can do +further tracing for the given commands to find exactly what happens. -1. In this tutorial, we traced the "happy path" (i.e., no errors). What - do you think will happen if we traced the following commands - instead? What exceptions do you think will be thrown (if any), where - will the exceptions be thrown and where will they be handled? +1. In this tutorial, we traced the "happy path" (i.e., no errors). What + do you think will happen if we traced the following commands + instead? What exceptions do you think will be thrown (if any), where + will the exceptions be thrown and where will they be handled? - 1. `redit 1 n/Alice Yu` + 1. `redit 1 n/Alice Yu` - 2. `edit 0 n/Alice Yu` + 2. `edit 0 n/Alice Yu` - 3. `edit 1 n/Alex Yeoh` + 3. `edit 1 n/Alex Yeoh` - 4. `edit 1` + 4. `edit 1` - 5. `edit 1 n/アリス ユー` + 5. `edit 1 n/アリス ユー` - 6. `edit 1 t/one t/two t/three t/one` + 6. `edit 1 t/one t/two t/three t/one` -2. What components will you have to modify to perform the following - enhancements to the application? +2. What components will you have to modify to perform the following + enhancements to the application? - 1. Make command words case-insensitive + 1. Make command words case-insensitive - 2. Allow `delete` to remove more than one index at a time + 2. Allow `delete` to remove more than one index at a time - 3. Save the address book in the CSV format instead + 3. Save the address book in the CSV format instead - 4. Add a new command + 4. Add a new command - 5. Add a new field to `Person` + 5. Add a new field to `Person` - 6. Add a new entity to the address book + 6. Add a new entity to the address book diff --git a/gradle.properties b/gradle.properties index 40764dc1791..c75a9af3404 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,6 +1,5 @@ org.gradle.parallel=false org.gradle.jvmargs=-XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError -Xmx1024m -Dfile.encoding=utf-8 - # TODO: This is a workaround for a JDK11 bug which causes test coverage upload to fail. # Remove it when https://bugs.openjdk.java.net/browse/JDK-8221253 is fixed. systemProp.jdk.tls.client.protocols="TLSv1,TLSv1.1,TLSv1.2" diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index e708b1c023e..41d9927a4d4 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/src/main/java/seedu/address/AppParameters.java b/src/main/java/seedu/address/AppParameters.java index 3d603622d4e..0fc21bcdfb4 100644 --- a/src/main/java/seedu/address/AppParameters.java +++ b/src/main/java/seedu/address/AppParameters.java @@ -19,14 +19,6 @@ public class AppParameters { private Path configPath; - public Path getConfigPath() { - return configPath; - } - - public void setConfigPath(Path configPath) { - this.configPath = configPath; - } - /** * Parses the application command-line parameters. */ @@ -44,6 +36,14 @@ public static AppParameters parse(Application.Parameters parameters) { return appParameters; } + public Path getConfigPath() { + return configPath; + } + + public void setConfigPath(Path configPath) { + this.configPath = configPath; + } + @Override public boolean equals(Object other) { if (other == this) { diff --git a/src/main/java/seedu/address/Main.java b/src/main/java/seedu/address/Main.java index ec1b7958746..f14473af111 100644 --- a/src/main/java/seedu/address/Main.java +++ b/src/main/java/seedu/address/Main.java @@ -7,17 +7,17 @@ /** * The main entry point to the application. - * + *
+:exclamation: **Note** :This command is **not** case-sensitive, even if `Developer` is a role, `developer` can still be added.
-### Archiving data files `[coming in v2.0]`
+:bulb:
+If you wish to check what roles are there, you can key in `delete-developer-role `, `` should not be an existing role.
+
-_Details coming soon ..._
+**Example of usage:** `add-developer-role Tester`
+
+* Adds the Tester role to list of developer roles.
+* You can now add developers with Tester as their roles.
+
+When command succeeds, CLI shows:
+
+```
+New role for developer added: Tester
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
--------------------------------------------------------------------------------------------------------------------
+#### Add client roles : `add-client-role`
-## FAQ
+> Adds new client roles into the system.
-**Q**: How do I transfer my data to another Computer?-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +**Format:** `add-client-role ROLE_NAME` + +**Additional notes:** +* Adds the ROLE_NAME to list of client roles. +* There are 4 preset roles in the list of roles: `HR`,`Manager`,`Developer`,`Client`. +* You will not be able to add a client to a role that does not exist in this list of client roles. +
+:exclamation: **Note** :This command is **not** case-sensitive, even if `HR` is a role, `hr` can still be added.
+
+
+:bulb:
+If you wish to check what roles are there, you can key in `delete-client-role `, `` should not be an existing role.
+
+
+**Example of usage:** `add-client-role Boss`
+
+* Adds the Boss role to list of developer roles.
+* You can now add clients with Boss as their roles.
+
+When command succeeds, CLI shows:
+
+```
+New role for client added: Boss
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+### **Delete roles**
+
+> **Your command to remove unnecessary roles in CodeContact.**
+
+
+#### Delete developer roles : `delete-developer-role`
+
+> Delete developer roles from the system.
+
+**Format:** `delete-developer-role ROLE_NAME`
+
+**Additional notes:**
+* Deletes the ROLE_NAME to list of developer roles.
+* There are 3 preset roles in the list of roles: `Frontend Developer`,`Backend Developer`,`Developer`. These roles
+ cannot be deleted.
+* You will not be able to delete a developer role if there are developers in the list with that role.
+
+**Example of usage:** `delete-developer-role UI Manager`
+
+* Deletes the UI Manager from the list of developer roles.
+* You can no longer add developers with UIDesigner as their roles.
+
+When command succeeds, CLI shows:
+
+```
+Role for developers deleted: UIDesigner
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
--------------------------------------------------------------------------------------------------------------------
+#### Delete client roles : `delete-client-role`
+
+> Delete client roles from the system.
+
+**Format:** `delete-client-role ROLE_NAME`
+
+**Additional notes:**
+* Deletes the ROLE_NAME to list of developer roles.
+* There are 4 preset roles in the list of roles: `HR`,`Manager`,`Developer`,`Client`. These roles cannot be deleted.
+* You will not be able to delete a client role if there are clients in the list with that role.
+
+**Example of usage:** `delete-client-role Boss`
+
+* Deletes the Boss from the list of developer roles.
+* You can no longer add clients with Boss as their roles.
+
+When command succeeds, CLI shows:
-## Known issues
+```
+Role for clients deleted: Boss
+```
-1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.
+[Scroll back to Table of Contents](#table-of-contents)
--------------------------------------------------------------------------------------------------------------------
-## Command summary
+
+
+### **Mark**
+
+> **Your quick and reliable command to keep on track with your project deadlines in CodeContact.**
+
+
+#### Mark project deadline as done : `mark-deadline`
+
+> Marks the indicated deadline for the project as done.
+
+**Format:** `mark-deadline PROJECT_INDEX DEADLINE_INDEX`
+
+**Additional notes:**
+* `PROJECT_INDEX` and `DEADLINE_INDEX` must be valid indexes of existing projects and deadlines.
+
+**Example of usage:** `mark-deadline 2 1`
+
+* Marks the 1st deadline of the 2nd project in the currently displayed project list as done.
+
+When command succeeds, CLI shows:
+
+```
+The deadline has been marked as completed!
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+#### Mark project deadline as undone : `unmark-deadline`
+
+> Marks the indicated deadline for the project as undone.
+
+**Format:** `unmark-deadline PROJECT_INDEX DEADLINE_INDEX`
+
+**Additional notes:**
+* `PROJECT_INDEX` and `DEADLINE_INDEX` must be valid indexes of existing projects and deadlines.
+
+**Example of usage:** `unmark-deadline 2 1`
+
+* Marks the 1st deadline of the 2nd project in the currently displayed project list as undone.
+
+When command succeeds, CLI shows:
+
+```
+The deadline has been marked as undone!
+```
+
+[Scroll back to Table of Contents](#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------
+
+### **Undo**
+
+> **Your quick and hassle free command to revert changes in CodeContact.**
+
+
+#### Undo : `undo`
+
+> Undo the previous command you entered.
+
+**Format:** `undo`
+
+**Additional notes:**
+* Each time you type undo, you move back one stage.
+* If you made 5 changes, and you wish to undo, you can enter the command `undo` 5 times. The system will remind you when
+ you cannot undo anymore.
+* `undo` works for all `edit`, `add-TYPE` and `delete` commands.
+
+**Example of usage:** `undo`
+
+* You just deleted a new developer, and you wish to `undo`.
+
+When command succeeds, CLI shows:
-Action | Format, Examples
---------|------------------
-**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**List** | `list` -**Help** | `help` +``` +Undo successful! The change below has been undone: +Deleted Developer: Amy; +Phone: 83566674; +Email: amy@example.com; +Address: 42, Clementi Ave 7, #02-2; +Date Joined: 23-11-2023; +Role: Frontend Developer; +Salary: 5000; +Projects: CustomWebsite AndroidApp +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Redo : `redo` + +> Redo the previous command you undid. + +**Format:** `redo` + +**Additional notes:** +* Each time you type redo, you move forward one stage. +* You can only `redo` if you have `undo` before. +* If you undid 5 changes, and you wish to redo, you can enter the command `redo` 5 times. The system will remind you when + you cannot redo anymore. +* `redo` works for all `edit`, `add-TYPE` and `delete` commands. + +**Example of usage:** + +* You just `undo` delete developer, and you wish to `redo` to add it back. + When command succeeds, CLI shows: + +``` +Redo successful! The change below has been redone: +Deleted Developer: Amy; +Phone: 83566674; +Email: amy@example.com; +Address: 42, Clementi Ave 7, #02-2; +Date Joined: 23-11-2023; +Role: Frontend Developer; +Salary: 5000; +Projects: CustomWebsite AndroidApp +``` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +## ***Additional Features*** + +-------------------------------------------------------------------------------------------------------------------- +### **Miscellaneous Features** +> **Accessible features for you to navigate smoothly through CodeContact.** + + +#### Viewing help : `help` + +> Shows a message explaining how to access the help page. + +**Format:** `help` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Clearing all entries : `clear` + +> Clears all entries from the address book. + +**Format:** `clear` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- +#### Exiting the program : `exit` + +> Exits the program. + +**Format:** `exit` + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + + +# **FAQ** + +-------------------------------------------------------------------------------------------------------------------- + +**Q**: How do I transfer my data to another Computer?
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains +the data of your previous CodeContact home folder. + + +**Q**: How can I launch CodeContact if the clicking on the JAR file does not work?
+**A**: There are two possible methods to launch CodeContact. +
+ +* Method 1: For users familiar with the command prompt + 1. Open the command prompt. + 2. Navigate to the directory where the JAR file is located using cd [JAR file location]. + 3. Type `java -jar CodeContact.jar` and press enter. + 4. CodeContact should launch. +
+ +* Method 2: For users that wish to create a script to launch CodeContact (Recommended) + + 1. Create a new text file. + 2. Type the following into the text file: + `java -jar [JAR file location]/CodeContact.jar`. + 3. Save the text file as CodeContact.bat (Windows) or CodeContact.sh (MacOS/Linux). + 4. Change the admin settings of the script to allow it to run as a program: + * Windows: Right-click on the script and select Properties. Under General , check + the box that says Allow this file to run as a program. + * MacOS/Linux: Open the terminal and navigate to the directory where the script is + located. Type `chmod +x [script name]` and press enter (`chmod +x` changes + permissions of the script to allow it to be executed). + 5. Double-click on the script to launch CodeContact. + 6. CodeContact should launch. + + +**Q**: How can I check my java version?
+**A**: Open a command prompt and type `java -version`. If you do not have Java installed, you +can download it [here](https://www.oracle.com/java/technologies/downloads/#java11). + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +# **Known issues** +-------------------------------------------------------------------------------------------------------------------- + +1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only + the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the + application before running the application again. +2. **When tampering with the storage files**, if you tamper with the storage files leading to incorrect format, the application will not be able to + read the data and will throw an error. The remedy is to delete the `addressbook.json` file created by the application before + running the application again. + +[Scroll back to Table of Contents](#table-of-contents) + +-------------------------------------------------------------------------------------------------------------------- + + +# **Command summary** + +| Action | Format, Examples | +|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **lock** | `lock` | +| **unlock** | Format:
`unlock pw/PASSWORD`
Example:
`unlock pw/Password123!` | +| **change password** | Format:
`change-password pw/CURRENT_PASSWORD npw/NEW_PASSWORD`
Example:
`change-password pw/Password123! npw/Password123!` | +| **add developers** | Format:
`add-developer n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [d/DATE_JOINED] r/ROLE s/SALARY [pr/PROJECT_NAME]... g/GITHUB_ID rt/RATING`
Example:
`add-developer n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp pr/CustomWebsite s/4500 d/11-11-2023 g/johng rt/3`
| +| **add clients** | Format:
`add-client n/NAME p/PHONE e/EMAIL a/ADDRESS r/ROLE [pr/PROJECT]... o/ORGANISATION do/DOCUMENT`
Example:
`add-client n/Jack Doe p/98765432 e/jackd@example.com a/311, Clementi Ave 2, #02-25 r/Developer pr/AndroidApp pr/CustomWebsite o/Google do/google.com`
| +| **add projects** | Format:
`add-project n/NAME dr/DESCRIPTION [dl/DEADLINE_DATE,DEADLINE_DESCRIPTION,PRIORITY,IS_DONE]...`
Example:
`add-project n/JuiceApp dr/App to allow for different juices to be ordered dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0`
| +| **edit developers** | Format:
`edit-developer INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME]... [g/GITHUB_ID] [rt/RATING]`
Example:
`edit-developer 2 p/98989898 pr/Project2 pr/Project3`
| +| **edit clients** | Format:
`edit-client INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME]... [g/GITHUB_ID] [rt/RATING]`
Example:
`edit-client 3 p/bob@gmail.com`
| +| **edit projects** | Format:
`edit-project INDEX [dr/DESCRIPTION] [dl/DEADLINE]...`
Example:
`edit-project 1 dl/Finish Feature-A by: 09-09-2023`
| +| **find developers** | Format:
`find-developer pr/
Example:
`find-developer pr/2103/T`
| +| **find clients** | Format:
`find-client n/
Example:
`find-client n/Amy`
| +| **find projects** | Format:
`find-project dr/description`
Example:
`find-project dr/school semester project`
| +| **find deadlines** | Format:
`find-deadline [d/DATE] [pri/PRIORITY]`
Example:
`find-deadline d/20-11-2023 pri/MEDIUM`
| +| **delete developer** | Format:
`delete-developer INDEX`
Example:
`delete-developer 1`
| +| **delete client** | Format:
`delete-client INDEX`
Example:
`delete-client 1`
| +| **delete project** | Format:
`delete-project INDEX`
Example:
`delete-project 1`
| +| **import developer** | Format:
`import-developer [FILENAME]`
Example:
`import-developer developers.csv`
| +| **import client** | Format:
`import-client [FILENAME]`
Example:
`import-client clients.csv`
| +| **add developer role** | Format:
`add-developer-role ROLE_NAME`
Example:
`add-developer-role UIDesigner`
| +| **add client role** | Format:
`add-client-role ROLE_NAME`
Example:
`add-client-role Boss`
| +| **delete developer role** | Format:
`delete-developer-role ROLE_NAME`
Example:
`delete-developer-role UIDesigner`
| +| **delete client role** | Format:
`delete-client-role ROLE_NAME`
Example:
`delete-client-role Boss`
| +| **list** | Format:
`list-developer`
`list-project`
`list-client` | +| **mark deadline** | Format:
`mark-deadline PROJECT_INDEX DEADLINE_INDEX`
Example:
`mark-deadline 2 1`
| +| **unmark deadline** | Format:
`unmark-deadline PROJECT_INDEX DEADLINE_INDEX`
Example:
`unmark-deadline 2 1`
| +| **undo** | `undo` | +| **redo** | `redo` | +| **clear** | `clear` | +| **exit** | `exit` | +| **help** | `help` | + +[Scroll back to Table of Contents](#table-of-contents) diff --git a/docs/_config.yml b/docs/_config.yml index 6bd245d8f4e..fa18176cd0d 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,4 +1,4 @@ -title: "AB-3" +title: "CodeContact" theme: minima header_pages: @@ -8,7 +8,7 @@ header_pages: markdown: kramdown -repository: "se-edu/addressbook-level3" +repository: "AY2324S1-CS2103T-T09-2" github_icon: "images/github-icon.png" plugins: diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html index 8559a67ffad..fb531a17de3 100644 --- a/docs/_includes/custom-head.html +++ b/docs/_includes/custom-head.html @@ -1,6 +1,6 @@ {% comment %} - Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: +Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: - 1. Head over to https://realfavicongenerator.net/ to add your own favicons. - 2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. +1. Head over to https://realfavicongenerator.net/ to add your own favicons. +2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. {% endcomment %} diff --git a/docs/_includes/head.html b/docs/_includes/head.html index 83ac5326933..314465c01c9 100644 --- a/docs/_includes/head.html +++ b/docs/_includes/head.html @@ -1,12 +1,12 @@ - - - + + + - + - {%- include custom-head.html -%} + {%- include custom-head.html -%} -
- {%- assign default_paths = site.pages | map: "path" -%}
- {%- assign page_paths = site.header_pages | default: default_paths -%}
- {%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
- {{ site.title | escape }}
+
+ {%- assign default_paths = site.pages | map: "path" -%}
+ {%- assign page_paths = site.header_pages | default: default_paths -%}
+ {%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
+ {{ site.title | escape }}
- {%- if titles_size > 0 -%}
-
- {%- endif -%}
-
+
+ {%- for path in page_paths -%}
+ {%- assign my_page = site.pages | where: "path", path | first -%}
+ {%- if my_page.title -%}
+ {{ my_page.title | escape }}
+ {%- endif -%}
+ {%- endfor -%}
+ {%- if site.repository -%}
+
+ 
+
+ {%- endif -%}
+
+
+ {%- endif -%}
+ + + +* **Enhancement to existing features**: `edit-developer`, `edit-client`, `edit-project` + * What it does: Allows users to edit the fields of existing developers, clients, and projects. + * Justification: This gives project managers the flexibility and freedom to change and update the details if + necessary. Aside from keeping contact details accurate, this is also especially important as it allows for the + reassignment of developers to new projects and the updating of project deadlines after milestones. + * Highlights: Edits are done according to the object's index in the displayed list in the relevant tab. Making + edits to objects automatically switches the tab on the GUI to the relevant one. Various code changes to the existing + `edit` function had to be made to account for the different fields of the object to edit, as well as various + implemented restrictions on fields that could and could not be changed. The respective Parser and Command classes + were extended to account for each additional field, and thorough checks were implemented to ensure that users are + unable to access prefixes that are meant for other objects. +
+ +* **Enhancements to existing features**: + * Updated the GUI project table columns and CSS (Pull request #142) +
+ +* **Other significant code contributions**: + * Initially implemented edit command with behaviour varying in response to access rights, but undid changes due to + shift in project direction (Pull requests #59, #66) + * Implemented Project and Project relevant classes (eg. Deadline, Priority, Description) for use by team (Pull + request #73) + * Implemented project validation checks to ensure assigned projects exist in the address book (Pull request #159) + * Wrote additional tests for features to increase coverage (Pull request #249) +
+ +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=emzm2023&breakdown=true) +
+ +* **Project management (team-based tasks contributions)**: + * Set up project schedule tracking with milestones and issues for `v1.1` + * Updated Developer Guide with project notes for `v1.1` + * Add screenshots of UI and managed the collaboration group document for tutorial checks + * Create and release JAR file for `v1.3` and `v1.4` + * Assign labels and assignees to bug issues in post-PED +
+ + +* **Documentation Contributions**: + * User Guide Contributions: + * Added documentation for the features add, edit and mark/unmark deadline features + (Pull requests #104, #151, #163, #263) + * Created template format for other team members to follow for their portion of the User Guide (Pull request + #151) + * Did extensive cosmetic tweaks for standardisation and fixed bugs across entire UG (Pull requests #252, #279) + * Developer Guide Contributions: + * Added all user stories and several use cases for initial iteration, but undid changes due to shift in project + direction (Pull request #35) + * Added implementation details of the features `edit-developer`, `edit-client`, `edit-project`, `mark-deadline` + , and `unmark-deadline` (Pull requests #109, #263) + * Added instructions for manual testing in Appendix (Pull request #263) + * Added planned enhancements in Appendix (Pull request #263) + * Did extensive cosmetic tweaks for standardisation and fixed bugs across entire DG (Pull request #279) +
+ +* **Community (Review/mentoring contributions)**: + * Helped to modify add command parsers with part of my implementation for edit command parsers to ensure more + thorough and bug-free parsing of user inputs (Pull request #127) + * Conducted pull request reviews for team members (Pull request #238) + +* **Contributions beyond the project team**: + * Reported bugs and suggestions for other teams in the cohort diff --git a/docs/team/johndoe.md b/docs/team/johndoe.md deleted file mode 100644 index 773a07794e2..00000000000 --- a/docs/team/johndoe.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: page -title: John Doe's Project Portfolio Page ---- - -### Project: AddressBook Level 3 - -AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. - -Given below are my contributions to the project. - -* **New Feature**: Added the ability to undo/redo previous commands. - * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command. - * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them. - * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands. - * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}* - -* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys. - -* **Code contributed**: [RepoSense link]() - -* **Project management**: - * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub - -* **Enhancements to existing features**: - * Updated the GUI color scheme (Pull requests [\#33](), [\#34]()) - * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]()) - -* **Documentation**: - * User Guide: - * Added documentation for the features `delete` and `find` [\#72]() - * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]() - * Developer Guide: - * Added implementation details of the `delete` feature. - -* **Community**: - * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]() - * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]()) - * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]()) - * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]()) - -* **Tools**: - * Integrated a third party library (Natty) to the project ([\#42]()) - * Integrated a new Github plugin (CircleCI) to the team repo - -* _{you can add/remove categories in the list above}_ diff --git a/docs/team/mahidharah.md b/docs/team/mahidharah.md new file mode 100644 index 00000000000..bff12035e8a --- /dev/null +++ b/docs/team/mahidharah.md @@ -0,0 +1,74 @@ +--- +layout: page +title: Mahidharah's Project Portfolio Page +--- + +### Project: CodeContact + +CodeContact is a desktop app for managing contacts, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). +If you can type fast, CodeContact can get your contact management tasks done faster than traditional GUI apps. + +Our product helps seamlessly integrate contact, client, and project management, simplifying access to coding-related contacts, facilitating collaboration, and offering command-line efficiency for project managers. + +Given below are my contributions to the project. + + +* **New Feature 1**: `add-developer`, `add-client` & `add-project` + * What it does: Adds a developer/client/project to the address book, making sure input parameters are valid and potential duplicates are found, highlighted to the user and rejected. + * Justification: Decided to separate these as different commands instead of having a single `add` command to allow for more flexibility with parameters changes to these features in the future (from basic OOP principles). This also allows for more specific error messages to be displayed to users when they input invalid parameters, utilising polymorphism. + * Highlights: Allows specific optional fields (i.e Project deadline). Automatically switches tabs according to command. + + + +* **New Feature 2**: `delete-developer` & `delete-client` + * What it does: Deletes a developer/client from the address book. + * Justification: Decided to separate these as different commands instead of having a single `delete` command to allow for more flexibility with parameters changes to these features in the future (from basic OOP principles). This also allows for more specific error messages to be displayed to users when they input invalid parameters, utilising polymorphism. + * Highlights: Automatically switches tabs according to command. + + + +* **New Feature 3**: `delete-project` + * What it does: Deletes a project from the address book and accordingly removes it from the set of projects for all developers and clients. + * Justification: I decided to implement the feature such that it triggers updates on developers and clients with hopes that this feature will be a major quality of life improvement for project managers, enabling them to remove projects easily without having to edit the information for relevant clients and developers to maintain integrity of the data. + * Highlights: Automatically switches tabs according to command. This feature uses the iterator java class and its for each remaining method effectively to simplify code and ensure efficiency. + + +* **Enhancements to existing features**: + * Contributed to the GUI component of CodeContact by creating relevant classes and FXML files for developer and client cards (Pull request [\#79](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/79)) + * Ensured functional improvements use developer and client classes instead of person class (Pull request [\#79](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/79)) + * Edited SampleData to include sample developers, clients and projects for easy testing for teammates (Pull request [\#79](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/79)) + + +* **Testing**: + * Enabled test files to work for other team members and contributed greatly to testcode + * Wrote testcases for model, logic and storage, and edited necessary test utility files to account for functional developments of CodeContact, speciafically developer and client features (Pull request [\#216](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/216), [\#222](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/222), [\#236](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/236)) + * Wrote testcases for my functional contributions to Codecontact. (Pull request [\#216](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/216), [\#236](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/222), [\#236](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/236)) + + +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=Mahidharah&tabRepo=AY2324S1-CS2103T-T09-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false) + + +* **Project management(team-based tasks contributions)**: + * Responsible for the timely pivot of our team project in v1.2 after checking in with tutors and professors + * Spearheaded the pivot by suggesting a new idea and directing the team to a new project which effectively carried over previous functional contributions + * Actively contributed during team meetings and reminded team members of upcoming deadlines + + + +* **Documentation Contributions**: + * User Guide Contributions: + * Added documentation for the features `delete-developer`, `delete-client`, `delete-project`, `add-developer`, `add-client`, `add-project` + * Did cosmetic tweaks to existing documentation of feature list table + * Developer Guide Contributions: + * Added implementation details of the `delete` and `add` features + * Added PUML sequence diagrams for these implementations + + +* **Community (Review/mentoring contributions)**: + * PRs reviewed (with non-trivial review comments): [\#155](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/155), [\##219](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/219) + * Reported bugs and suggested ideal implementations for features for teammates + * Some parts of the delete-project feature I added was adopted by team members and classmates, for instance the following implementation of validation checks for projects + + +* **Tools**: + * Capitalised on GitHub copilot autocomplete features in creating testcases, enabling me to cover the most amount of functional code in testcases diff --git a/docs/team/mingyu-wan.md b/docs/team/mingyu-wan.md new file mode 100644 index 00000000000..91bbc1ec046 --- /dev/null +++ b/docs/team/mingyu-wan.md @@ -0,0 +1,76 @@ +--- +layout: page +title: Mingyu's Project Portfolio Page +--- + +### Project: CodeContact + +CodeContact is a desktop address book solution for Software Engineering companies. The user interacts with it using a +CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **New Feature 1**: `Undo` n `Redo` + * What it does:
Allows users to undo and redo their command easily. + * Justification:
This feature enhances user experience by allowing effortless reversal of previous actions, + providing convenience in scenarios where unintended changes are made. + * Highlights:
The undo and redo feature is unlimited, allowing users to revert all the way to their first or last command using + the simple `undo` or `redo` command, ensuring ease of use. + * Credits:
Inspired by the AB-3 developer guide, this feature employs a pointer to change the address book at each undo or redo command. + Additional validation checks were added for CodeContact's complexity. +
+ +* **New Feature 2**: `Adding roles ` + * What it does:
Allows users to add different roles. + * Justification:
This feature minimizes risks associated with incorrect role assignments by allowing explicit +definition and addition of developer or client roles. It ensures a standardized set of role names, +reducing the chance of mislabeling and improving searchability within CodeContact. + * Highlights:
The feature provides separate commands (add-developer-role and add-client-role) for adding developers and clients, +adding clarity to the role assignment process. A pre-added list of roles for clients and developers facilitates user adoption, and validation checks prevent the addition of repeated roles. + * Credits: N.A. +
+ +* **New Feature 3**: `Deleting roles ` + * What it does:
Allows users to delete different roles. + * Justification:
This CodeContact feature is crucial for user data management, enabling users to refine and update the list of roles. + Deleting roles is essential for maintaining a clean and relevant role structure, empowering users to adapt roles to evolving needs and ensuring accuracy in the address book. + * Highlights:
Separate commands (delete-developer-role and delete-client-role) cater to the unique needs of deleting developers and clients. + To prevent accidental deletion when roles are in use, the feature checks for active developers and clients before deletion. Users cannot delete pre-added roles from CodeContact. + * Credits: N.A. +
+ +* **Enhancements to existing features**: + * Modified list feature to work with our new tab and fields (Pull requests [\#113](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/113)) + * Fixed parts of the test cases to pass again (Pull requests [\#225](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/225)) + * Increased code coverage from `32.28%` to `38%` and from `48.9%` to `54.39%`.(Pull requests [\#250](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/250) + [\#241](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/241)) +
+ +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=mingyu&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=zoom&zA=mingyu-wan&zR=AY2324S1-CS2103T-T09-2%2Ftp%5Bmaster%5D&zACS=241.3&zS=2023-09-22&zFS=mingyu&zU=2023-11-10&zMG=false&zFTF=commit&zFGS=groupByRepos&zFR=false) +
+ +* **Project management(team-based tasks contributions)**: + * Managed releases `v1.1` - `v1.4` (4 releases) on GitHub + * Managed issues creating and some assigning throughout the milestones + * Managed the collaboration document and product demo submissions for tutorial +
+ +* **Documentation Contributions**: + * User Guide Contributions: + * Removed traces of AB-3: [\#50](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/50) + * Added documentation for the features `undo`,`redo`,`add-role` and `delete-role`: [\#160](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/160) + * Did cosmetic tweaks to existing documentation of features `list`: [\#160](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/160) + * Wrote the content for `tutorial`: [\#162](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/162) + * Modified and content and UI pictures for `Quick Start`: [\#162](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/162) + * Wrote the content for `Navigating the GUI` and `Format`: [\#242](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/242) + * Developer Guide Contributions: + * Added use case (abandoned due to a shift in project): [\#43](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/43) + * Reformatted entire DG format: [\#244](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/244) + * Wrote user stories and use case: [\#246](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/246) [\#247](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/247) + * Wrote implementations, sequence and activity diagrams for features i implemented: [\#246](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/246) + * Wrote in appendix: planned enhancements: [\#247](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/246) +
+ +* **Community (Review/mentoring contributions)**: + * Reported bugs and suggestions for other teams in the cohort +
diff --git a/docs/team/ncmathan.md b/docs/team/ncmathan.md new file mode 100644 index 00000000000..dc3af462895 --- /dev/null +++ b/docs/team/ncmathan.md @@ -0,0 +1,83 @@ +--- +layout: page +title: Mathan's Project Portfolio Page +--- + +### Project: CodeContact + +CodeContact is a desktop address book solution for Software Engineering companies. The user interacts with it using a +CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **New Feature 1**: `import-developer` and `import-client` + * What it does:
Gives users the ability to import developers and clients from a CSV file. + * Justification:
Allows users to easily import a large number of developers and clients into the address book. This + is especially useful for companies that have a large number of employees and those who are new to CodeContact porting over from other address book applications. + * Highlights:
The feature is able to handle a large number of developers and clients, and is able to handle + errors such as invalid CSV files and invalid data in the CSV file. + + +* **New Feature 2**: `lock` and `unlock` + * What it does:
Gives users the ability to lock and unlock the application. + * Justification:
Allows users to lock the application when they are away from their computer, preventing + unauthorised access to the application. This is especially useful since the information stored on the application contains personal data of developers and clients, that has to be kept secure. + * Highlights:
The password is stored in a hashed format, preventing anyone from accessing the password file to view it directly. The application is also locked when the user closes the application. + + +* **New Feature 3**: `change-password` + * What it does:
Gives users the ability to change their password. + * Justification:
Allows users to change their password when they feel that their password has been compromised. This is especially useful since the information stored on the application contains personal data of developers and clients, that has to be kept secure. + * Highlights:
The password is only changed if the current password is correct, new password follows the password requirements and the new password is different from the current password. + * Credits:[Password requirements] (https://support.kaspersky.com/KPC/1.0/en-US/183862.htm) + +* **New Feature 4**: `find-deadline` + * What it does:
Gives users the ability to filter deadlines by date and priority. + * Justification:
Allows users to easily find deadlines that are due before or on a certain date, or deadlines that are of a certain priority. This is especially useful for project managers who need to keep track of deadlines. + * Highlights:
The feature is able to handle a large number of deadlines, and is able to handle errors such as invalid dates and invalid priority. + * Credits: Followed a similar structure as storing filtered lists in `ModelManager` but one level lower at the individual project level to store filtered deadlines. + + + + +* **Enhancements to existing features**: + * Update Logic and Model for Person to Developer, Client and Project (Pull request [\#92](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/92)) + * Implemented Tab Functionality (Pull request [\#96](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/96)) + * Updated the GUI color scheme from Dark Theme to Light Theme(Pull requests [\#110](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/110)) + * Updated User Guide (Pull request [\#144](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/144), [\#161](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/161), [\#243](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/243), [\#254](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/254), [\#278](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/278)) + * Updated Developer Guide (Pull Request [\#254](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/254), [\#261](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/261), [\#278](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/278)) + * Add javadocs and fixed checkstyle errors (Pull request [\#219](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/219)) + * Fixed bugs (Pull request [\#226](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/226), [\#243](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/243)) + * Wrote additional tests for existing features to increase coverage from 41% to 43% (Pull requests [\#243](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/243)) + + +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&tabAuthor=ncmathan&tabRepo=AY2324S1-CS2103T-T09-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false) + + +* **Project management(team-based tasks contributions)**: + * Managed releases `v1.2`-`v1.3` (2 JAR releases) on GitHub + * Managed issues creating and some assigning throughout the milestones + * Managed the collaboration document and product demo submissions for tutorial + * Sorted the PE-D bugs into relevant catgegories + + +* **Documentation Contributions**: + * User Guide Contributions: + * Added documentation for the features `import-developer`, `import-client`, `lock`, `unlock`, `change-password` and `find-deadline` + * Did cosmetic tweaks to existing documentation including adding a Table of Contents for features + * Developer Guide Contributions: + * Added implementation details of the `import`, `GUI` features. + * Updated the architecture diagrams and sequence diagrams in the design section to reflect changes in CodeContact + * Added Glossary section + * Added Effort section + + +* **Community (Review/mentoring contributions)**: + * PRs reviewed (with non-trivial review comments): [\#219](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/219), [\#216](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/216)) + +* **Contributions beyond the project team:**: + * Provided suggestions to other teams on how to improve their project + + +* **Tools**: + * Integrated a third party library (ControlsFX) to the project diff --git a/docs/team/waseemingly.md b/docs/team/waseemingly.md new file mode 100644 index 00000000000..75ab43df92b --- /dev/null +++ b/docs/team/waseemingly.md @@ -0,0 +1,244 @@ +--- +layout: page +title: Waseem's Project Portfolio Page +--- + +### Project: CodeContact + +CodeContact is a desktop address book solution for Software Engineering companies. The user interacts with it using a +CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **New Feature**: Find + * What it does: Project managers can find for developers, clients and projects based on the specified attributes. + * Justification: This feature improves the product significantly as project managers might want to look out for + certain attributes in a developer before adding them to a new project, or sort clients based on their + organisation or even group projects according to their deadline. + * Highlights: This implementation was challenging as it required creating new predicates for each of the attributes + of the developers, clients and projects. The feature also allows for multi-level searching as project managers + can find based on multiple attributes at the same time. This allows for even more detailed searching. The find + feature then displayed the updated filtered list on the GUI. In addition, the find implementation was utilised + in the implementation of the delete feature as well. + +* **Enhancements to existing features**: + * Wrote additional tests for existing features to increase coverage. + + +* **Code contributed + **: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=waseemingly&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos) + + +* **Project management(team-based tasks contributions)**: + * Set up GitHub team repository and organisation and added team members to the developers team. + * Set up the project website + * Set up CodeCov to generate code coverage data and provides more information about coverage of our tests. + * Created and maintained issue tracker. + * Update AboutUs and Index pages. + + +* **Documentation Contributions**: + * User Guide Contributions: + * Added documentation for the features `find` [\#164]() + * Added the table for list of acceptable parameters. + * Added UI screenshots of the app to display examples of certain features. + * Developer Guide Contributions: + * Added implementation details of the `find` feature. + * Added planned enhancements for filter results and autocorrect search. + * Added manual testing cases for `find` and `mark project deadlines` features. + * README Contributions: + * Maintained README page of repository + + +* **Community (Review/mentoring contributions)**: + * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]() + +* **Contributions beyond the project team:**: + * Reported bugs and suggestions for other teams in the cohort. + +* **Contributions to the Developer Guide (Extracts)**: + +### Find Feature + +#### Implementation + +The find feature is facilitated by a map-based strategy, associating specific prefixes (e.g., "find-developer n/" or " +find-client r/") with corresponding predicates, allowing dynamic generation of filtering criteria based on user input. + +Implemented operations include: + +- `FindCommandParser#parse()`: Interprets the user's input and generates the appropriate predicate to filter the list of + developers or clients. +- `Model#updateFilteredPersonList()`: Updates the list displayed in the UI based on the provided predicate. + +Given below is an example usage scenario and how the find mechanism behaves at each step: + +**Step 1.** The user launches the application. The list of developers and clients are displayed. + +**Step 2.** To filter developers by name, the user executes the command `find-developer n/ alice bob`. The application +recognizes the "developer n/" prefix and uses the `NameContainsKeywordsPredicate` to generate a filtering criteria. The +list in the UI is updated to only display developers named Alice or Bob. + +**Step 3.** Next, the user wants to find clients from a specific organisation. They use the +command `find-client o/ Google`. The "find-client o/" prefix maps to the `OrganisationContainsKeywordsPredicate` and +filters clients associated with Google. + +**Step 4.** If the user provides an unrecognized prefix, e.g., `find-developer z/ alice`, an error message is displayed +informing them of the correct command format. + +> :information_source: **Note:** While the user can search by multiple keywords, each keyword maps to an entire word in +> the attributes. For example, searching for "Ali" will not return "Alice". + +The following sequence diagram provides an overview of how the find operation is executed: + +[Diagram would be inserted here illustrating the parsing of the command, identification of the appropriate predicate, and subsequent filtering of the list.] + +### Design Considerations: + +**Aspect:** Implementation of the predicate map: + +**Alternative 1 (current choice):** + +- Use a long chain of `if-else` conditions for each attribute. + - **Pros:** Explicit parsing logic for each attribute. + - **Cons:** Code becomes lengthy and hard to maintain. Adding a new attribute involves modifying the parsing logic, + increasing the risk of errors. + +**Alternative 2:** + +- Use a map linking prefixes to their corresponding predicate constructors. + - **Pros:** Simplifies the parsing process. Adding a new attribute to search becomes as simple as adding a new entry + in the map. + - **Cons:** A potential mismatch between the prefix and its predicate can lead to wrong results. + +Given the benefits of a more maintainable and scalable codebase, we've decided to go with the first alternative. Future +enhancements might include fuzzy search. + + +* **Contributions to the User Guide (Extracts)**: + +### Parameter Information + +Within the tables below, you can find out more about the parameters that CodeContact supports. These parameters come in +handy when crafting commands in CodeContact. + +Here are some notes about these parameters. + +* Each parameter comes with **constraints**. These constraints detail the specific formats of text that + each parameter accepts as valid user input. + * Not following these constraints will **result in an error** when entering the command. + *Nonetheless, CodeContact will not stop working. Rather, a message will be provided to you on + how to correct your command. + +#### Common Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|------------------------------------------|----------------------------------------------------------------|-----------------------------|---------------------------------------------| +| `n/` | name of developer/client/project | alphanumeric characters and spaces, and it should not be blank | Tom Hanks, Elizabeth 2 | 成龍, 潔 いさぎ 世 よ 一 いち, Ganesh s/o Ravichandran | +| `p/` | phone number of developer/client/project | numeric characters, and it should not be blank | 94566835 | | +| `e/` | email of developer/client/project | alphanumeric characters, and it should not be blank | amy@gmail.com | | +| `a/` | address of developer/client/project | alphanumeric characters and spaces, and it should not be blank | 311, Clementi Ave 2, #02-25 | | +| `r/` | role of developer/client/project | alphabetical characters and spaces, and it should not be blank | Developer | | +| `pr/` | project name of developer/client/project | alphanumeric characters and spaces, and it should not be blank | CS2103T | | + +#### Developer Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|------------------------------|--------------------------------------------------------------------------------|----------------|----------------------| +| `g/` | github username of developer | alphanumeric characters, and it should not be blank | johng, amy123 | | +| `d/` | date joined of developer | numeric characters in DD-MM-YYYY format, and it should not be blank | 19-11-2023 | 19/11/2023, 1/1/2023 | +| `s/` | salary of developer | numeric characters, and it should not be blank | 5000 | | +| `rt/` | rating of developer | numeric characters with 1 decimal place and spaces, and it should not be blank | 5.0, 3.5 | 5,3 | + +#### Client Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|-----------------------------|----------------------------------------------------------------|----------------|------------------| +| `o/` | organisation name of client | alphanumeric characters and spaces, and it should not be blank | Google | | +| `do/` | document name of client | alphanumeric characters and spaces, and it should not be blank | google.com | | + +#### Project Parameters + +| Parameter | Description | Constraints | Valid Examples | Invalid Examples | +|-----------|------------------------|---|---|--| +| `dr/` | description of project | alphanumeric characters and spaces, and it should not be blank | App to allow for +different juices to be ordered | | +| `dl/` | deadline of project | alphanumeric characters and spaces, and it should not be blank| 19-12-2023,Design +backend,HIGH,0 | | + + +----------------------------------------------------------------------------------------------- + +### Find + +#### Find developer details + +Finds the details of an existing developer in the address book. + +Format: `find-developer [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED] [r/ROLE] [s/SALARY] [pr/PROJECT_NAME] [gh/GITHUB_ID] [ra/RATING]` + +* Finds for developers based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +Example of usage: `find-developer pr/2103T rt/5.0` + +* Prints developers in 2103/T project with a 5-star rating. + +When command succeeds, CLI shows: + +``` +This is the one developer with matching information +``` +followed by the matching developer's details in the GUI. + +#### Find client details + +Finds the details of an existing client in the address book. + +Format: `find-client [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [o/ORGANISATION] [pr/PROJECT] [d/DOCUMENT]` + +* Finds for clients based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +Example of usage: `find-client o/Google r/Senior developer` + +* Prints clients from Google of the senior developer role + +When command succeeds, CLI shows: + +``` +These are the 2 clients with matching information +``` +followed by the matching clients' details in the GUI. + +#### Find project details + +Finds the details of an existing project in the address book. + +Format: `find-project [pr/PROJECT_NAME] [d/DESCRIPTION] [dl/DEADLINE]` + +* Finds for projects based on the attributes provided. +* At least one of the optional fields must be provided. +* Existing values will be compared to the input values, and the results will include any items that match the provided + criteria. +* You can combine multiple attributes for a more specific search. +* The search is case-insensitive, so you can use any case for the search criteria. + +Example of usage: `find-project pr/JuiceApp` + +* Print projects with the name 2103T project. + +When command succeeds, CLI shows: + +``` +This is the one project with matching information +``` +followed by the matching project's details in the GUI. diff --git a/docs/tutorials/AddRemark.md b/docs/tutorials/AddRemark.md index d98f38982e7..42067a48d91 100644 --- a/docs/tutorials/AddRemark.md +++ b/docs/tutorials/AddRemark.md @@ -3,22 +3,26 @@ layout: page title: "Tutorial: Adding a command" --- -Let's walk you through the implementation of a new command — `remark`. +Let's walk you through the implementation of a new command —`remark`. -This command allows users of the AddressBook application to add optional remarks to people in their address book and edit it if required. The command should have the following format: +This command allows users of the AddressBook application to add optional remarks to people in their address book and +edit it if required. The command should have the following format: `remark INDEX r/REMARK` (e.g., `remark 2 r/Likes baseball`) We’ll assume that you have already set up the development environment as outlined in the Developer’s Guide. - ## Create a new `remark` command -Looking in the `logic.command` package, you will notice that each existing command have their own class. All the commands inherit from the abstract class `Command` which means that they must override `execute()`. Each `Command` returns an instance of `CommandResult` upon success and `CommandResult#feedbackToUser` is printed to the `ResultDisplay`. +Looking in the `logic.command` package, you will notice that each existing command have their own class. All the +commands inherit from the abstract class `Command` which means that they must override `execute()`. Each `Command` +returns an instance of `CommandResult` upon success and `CommandResult#feedbackToUser` is printed to +the `ResultDisplay`. Let’s start by creating a new `RemarkCommand` class in the `src/main/java/seedu/address/logic/command` directory. -For now, let’s keep `RemarkCommand` as simple as possible and print some output. We accomplish that by returning a `CommandResult` with an accompanying message. +For now, let’s keep `RemarkCommand` as simple as possible and print some output. We accomplish that by returning +a `CommandResult` with an accompanying message. **`RemarkCommand.java`:** @@ -28,7 +32,7 @@ package seedu.address.logic.commands; import seedu.address.model.Model; /** - * Changes the remark of an existing person in the address book. + * Changes the remark of an existing developer in the address book. */ public class RemarkCommand extends Command { @@ -43,9 +47,12 @@ public class RemarkCommand extends Command { ### Hook `RemarkCommand` into the application -Now that we have our `RemarkCommand` ready to be executed, we need to update `AddressBookParser#parseCommand()` to recognize the `remark` keyword. Add the new command to the `switch` block by creating a new `case` that returns a new instance of `RemarkCommand`. +Now that we have our `RemarkCommand` ready to be executed, we need to update `AddressBookParser#parseCommand()` to +recognize the `remark` keyword. Add the new command to the `switch` block by creating a new `case` that returns a new +instance of `RemarkCommand`. -You can refer to the changes in this [diff](https://github.com/se-edu/addressbook-level3/commit/35eb7286f18a029d39cb7a29df8f172a001e4fd8#diff-399c284cb892c20b7c04a69116fcff6ccc0666c5230a1db8e4a9145def8fa4ee). +You can refer to the changes in +this [diff](https://github.com/se-edu/addressbook-level3/commit/35eb7286f18a029d39cb7a29df8f172a001e4fd8#diff-399c284cb892c20b7c04a69116fcff6ccc0666c5230a1db8e4a9145def8fa4ee). ### Run the application @@ -55,7 +62,9 @@ Run `Main#main` and try out your new `RemarkCommand`. If everything went well, y ## Change `RemarkCommand` to throw an exception -While we have successfully printed a message to `ResultDisplay`, the command does not do what it is supposed to do. Let’s change the command to throw a `CommandException` to accurately reflect that our command is still a work in progress. +While we have successfully printed a message to `ResultDisplay`, the command does not do what it is supposed to do. +Let’s change the command to throw a `CommandException` to accurately reflect that our command is still a work in +progress.  @@ -65,8 +74,8 @@ Following the convention in other commands, we add relevant messages as constant ``` java public static final String MESSAGE_USAGE = COMMAND_WORD - + ": Edits the remark of the person identified " - + "by the index number used in the last person listing. " + + ": Edits the remark of the developer identified " + + "by the index number used in the last developer listing. " + "Existing remark will be overwritten by the input.\n" + "Parameters: INDEX (must be a positive integer) " + "r/ [REMARK]\n" @@ -88,7 +97,9 @@ Let’s change `RemarkCommand` to parse input from the user. ### Make the command accept parameters -We start by modifying the constructor of `RemarkCommand` to accept an `Index` and a `String`. While we are at it, let’s change the error message to echo the values. While this is not a replacement for tests, it is an obvious way to tell if our code is functioning as intended. +We start by modifying the constructor of `RemarkCommand` to accept an `Index` and a `String`. While we are at it, let’s +change the error message to echo the values. While this is not a replacement for tests, it is an obvious way to tell if +our code is functioning as intended. ``` java import static seedu.address.commons.util.CollectionUtil.requireAllNonNull; @@ -101,8 +112,8 @@ public class RemarkCommand extends Command { private final String remark; /** - * @param index of the person in the filtered person list to edit the remark - * @param remark of the person to be updated to + * @param index of the developer in the filtered developer list to edit the remark + * @param remark of the developer to be updated to */ public RemarkCommand(Index index, String remark) { requireAllNonNull(index, remark); @@ -134,17 +145,21 @@ public class RemarkCommand extends Command { } ``` -Your code should look something like [this](https://github.com/se-edu/addressbook-level3/commit/dc6d5139d08f6403da0ec624ea32bd79a2ae0cbf#diff-a8e35af8f9c251525063fae36c9852922a7e7195763018eacec60f3a4d87c594) after you are done. +Your code should look something +like [this](https://github.com/se-edu/addressbook-level3/commit/dc6d5139d08f6403da0ec624ea32bd79a2ae0cbf#diff-a8e35af8f9c251525063fae36c9852922a7e7195763018eacec60f3a4d87c594) +after you are done. ### Parse user input Now let’s move on to writing a parser that will extract the index and remark from the input provided by the user. -Create a `RemarkCommandParser` class in the `seedu.address.logic.parser` package. The class must extend the `Parser` interface. +Create a `RemarkCommandParser` class in the `seedu.address.logic.parser` package. The class must extend the `Parser` +interface.  -Thankfully, `ArgumentTokenizer#tokenize()` makes it trivial to parse user input. Let’s take a look at the JavaDoc provided for the function to understand what it does. +Thankfully, `ArgumentTokenizer#tokenize()` makes it trivial to parse user input. Let’s take a look at the JavaDoc +provided for the function to understand what it does. **`ArgumentTokenizer.java`:** @@ -162,7 +177,9 @@ Thankfully, `ArgumentTokenizer#tokenize()` makes it trivial to parse user input. */ ``` -We can tell `ArgumentTokenizer#tokenize()` to look out for our new prefix `r/` and it will return us an instance of `ArgumentMultimap`. Now let’s find out what we need to do in order to obtain the Index and String that we need. Let’s look through `ArgumentMultimap` : +We can tell `ArgumentTokenizer#tokenize()` to look out for our new prefix `r/` and it will return us an instance +of `ArgumentMultimap`. Now let’s find out what we need to do in order to obtain the Index and String that we need. Let’s +look through `ArgumentMultimap` : **`ArgumentMultimap.java`:** @@ -177,7 +194,8 @@ public Optional
@@ -282,18 +313,20 @@ Unfortunately, a change to `Person` will cause other commands to break, you will
-Refer to [this commit](https://github.com/se-edu/addressbook-level3/commit/ce998c37e65b92d35c91d28c7822cd139c2c0a5c) and check that you have got everything in order!
-
+Refer to [this commit](https://github.com/se-edu/addressbook-level3/commit/ce998c37e65b92d35c91d28c7822cd139c2c0a5c) and
+check that you have got everything in order!
## Updating Storage
-AddressBook stores data by serializing `JsonAdaptedPerson` into `json` with the help of an external library — Jackson. Let’s update `JsonAdaptedPerson` to work with our new `Person`!
+AddressBook stores data by serializing `JsonAdaptedPerson` into `json` with the help of an external library — Jackson.
+Let’s update `JsonAdaptedPerson` to work with our new `Person`!
While the changes to code may be minimal, the test data will have to be updated as well.
-:exclamation: You must delete AddressBook’s storage file located at `/data/addressbook.json` before running it! Not doing so will cause AddressBook to default to an empty address book!
+:exclamation: You must delete AddressBook’s storage file located at `/data/addressbook.json` before running it! Not
+doing so will cause AddressBook to default to an empty address book!
@@ -304,14 +337,15 @@ to see what the changes entail.
Now that we have finalized the `Person` class and its dependencies, we can now bind the `Remark` field to the UI.
-Just add [this one line of code!](https://github.com/se-edu/addressbook-level3/commit/5b98fee11b6b3f5749b6b943c4f3bd3aa049b692)
+Just
+add [this one line of code!](https://github.com/se-edu/addressbook-level3/commit/5b98fee11b6b3f5749b6b943c4f3bd3aa049b692)
**`PersonCard.java`:**
``` java
-public PersonCard(Person person, int displayedIndex) {
+public PersonCard(Person developer, int displayedIndex) {
//...
- remark.setText(person.getRemark().value);
+ remark.setText(developer.getRemark().value);
}
```
@@ -319,11 +353,14 @@ public PersonCard(Person person, int displayedIndex) {
## Putting everything together
-After the previous step, we notice a peculiar regression — we went from displaying something to nothing at all. However, this is expected behavior as we are yet to update the `RemarkCommand` to make use of the code we've been adding in the last few steps.
+After the previous step, we notice a peculiar regression — we went from displaying something to nothing at all. However,
+this is expected behavior as we are yet to update the `RemarkCommand` to make use of the code we've been adding in the
+last few steps.
### Update `RemarkCommand` and `RemarkCommandParser`
-In this last step, we modify `RemarkCommand#execute()` to change the `Remark` of a `Person`. Since all fields in a `Person` are immutable, we create a new instance of a `Person` with the values that we want and
+In this last step, we modify `RemarkCommand#execute()` to change the `Remark` of a `Person`. Since all fields in
+a `Person` are immutable, we create a new instance of a `Person` with the values that we want and
save it with `Model#setPerson()`.
**`RemarkCommand.java`:**
@@ -341,25 +378,25 @@ save it with `Model#setPerson()`.
throw new CommandException(Messages.MESSAGE_INVALID_PERSON_DISPLAYED_INDEX);
}
- Person personToEdit = lastShownList.get(index.getZeroBased());
- Person editedPerson = new Person(
- personToEdit.getName(), personToEdit.getPhone(), personToEdit.getEmail(),
- personToEdit.getAddress(), remark, personToEdit.getTags());
+ Person developerToEdit = lastShownList.get(index.getZeroBased());
+ Person editedDeveloper = new Person(
+ developerToEdit.getName(), developerToEdit.getPhone(), developerToEdit.getEmail(),
+ developerToEdit.getAddress(), remark, developerToEdit.getTags());
- model.setPerson(personToEdit, editedPerson);
+ model.setPerson(developerToEdit, editedDeveloper);
model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);
- return new CommandResult(generateSuccessMessage(editedPerson));
+ return new CommandResult(generateSuccessMessage(editedDeveloper));
}
/**
* Generates a command execution success message based on whether
* the remark is added to or removed from
- * {@code personToEdit}.
+ * {@code developerToEdit}.
*/
- private String generateSuccessMessage(Person personToEdit) {
+ private String generateSuccessMessage(Person developerToEdit) {
String message = !remark.value.isEmpty() ? MESSAGE_ADD_REMARK_SUCCESS : MESSAGE_DELETE_REMARK_SUCCESS;
- return String.format(message, personToEdit);
+ return String.format(message, developerToEdit);
}
```
@@ -367,11 +404,16 @@ save it with `Model#setPerson()`.
## Writing tests
-Tests are crucial to ensuring that bugs don’t slip into the codebase unnoticed. This is especially true for large code bases where a change might lead to unintended behavior.
+Tests are crucial to ensuring that bugs don’t slip into the codebase unnoticed. This is especially true for large code
+bases where a change might lead to unintended behavior.
Let’s verify the correctness of our code by writing some tests!
-Of course you can simply add the test cases manually, like you've been doing all along this tutorial. The result would be like the test cases in [here](https://github.com/se-edu/addressbook-level3/commit/fac8f3fd855d55831ca0cc73313b5943d49d4d6e#diff-ff58f7c10338b34f76645df49b71ecb2bafaf7611b20e7ff59ebc98475538a01). Alternatively, you can get the help of IntelliJ to generate the skeletons of the test cases, as explained in the next section.
+Of course you can simply add the test cases manually, like you've been doing all along this tutorial. The result would
+be like the test cases
+in [here](https://github.com/se-edu/addressbook-level3/commit/fac8f3fd855d55831ca0cc73313b5943d49d4d6e#diff-ff58f7c10338b34f76645df49b71ecb2bafaf7611b20e7ff59ebc98475538a01).
+Alternatively, you can get the help of IntelliJ to generate the skeletons of the test cases, as explained in the next
+section.
### Automatically generating tests
@@ -380,7 +422,8 @@ The goal is to write effective and efficient tests to ensure that `RemarkCommand
The convention for test names is `methodName_testScenario_expectedResult`. An example would be
`execute_filteredList_success`.
-Let’s create a test for `RemarkCommand#execute()` to test that adding a remark works. On `IntelliJ IDEA` you can bring up the context menu and choose to `Go To` \> `Test` or use the appropriate keyboard shortcut.
+Let’s create a test for `RemarkCommand#execute()` to test that adding a remark works. On `IntelliJ IDEA` you can bring
+up the context menu and choose to `Go To` \> `Test` or use the appropriate keyboard shortcut.
@@ -390,9 +433,12 @@ Then, create a test for the `execute` method.
Following convention, let’s change the name of the generated method to `execute_addRemarkUnfilteredList_success`.
-Let’s use the utility functions provided in `CommandTestUtil`. The functions ensure that commands produce the expected `CommandResult` and output the correct message. In this case, `CommandTestUtil#assertCommandSuccess` is the best fit as we are testing that a `RemarkCommand` will successfully add a `Remark`.
+Let’s use the utility functions provided in `CommandTestUtil`. The functions ensure that commands produce the
+expected `CommandResult` and output the correct message. In this case, `CommandTestUtil#assertCommandSuccess` is the
+best fit as we are testing that a `RemarkCommand` will successfully add a `Remark`.
-You should end up with a test that looks something like [this](https://github.com/se-edu/addressbook-level3/commit/fac8f3fd855d55831ca0cc73313b5943d49d4d6e#diff-ff58f7c10338b34f76645df49b71ecb2bafaf7611b20e7ff59ebc98475538a01R36-R49).
+You should end up with a test that looks something
+like [this](https://github.com/se-edu/addressbook-level3/commit/fac8f3fd855d55831ca0cc73313b5943d49d4d6e#diff-ff58f7c10338b34f76645df49b71ecb2bafaf7611b20e7ff59ebc98475538a01R36-R49).
## Conclusion
diff --git a/docs/tutorials/RemovingFields.md b/docs/tutorials/RemovingFields.md
index f29169bc924..e4b39e0e39f 100644
--- a/docs/tutorials/RemovingFields.md
+++ b/docs/tutorials/RemovingFields.md
@@ -5,39 +5,52 @@ title: "Tutorial: Removing Fields"
> Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
>
-> — Antoine de Saint-Exupery
+> — Antoine de Saint-Exupery
When working on an existing code base, you will most likely find that some features that are no longer necessary.
-This tutorial aims to give you some practice on such a code 'removal' activity by removing the `address` field from `Person` class.
+This tutorial aims to give you some practice on such a code 'removal' activity by removing the `address` field
+from `Person` class.
-**If you have done the [Add `remark` command tutorial](AddRemark.html) already**, you should know where the code had to be updated to add the field `remark`. From that experience, you can deduce where the code needs to be changed to _remove_ that field too. The removing of the `address` field can be done similarly.
+**If you have done the [Add `remark` command tutorial](AddRemark.html) already**, you should know where the code had to
+be updated to add the field `remark`. From that experience, you can deduce where the code needs to be changed to
+_remove_ that field too. The removing of the `address` field can be done similarly.
-However, if you have no such prior knowledge, removing a field can take a quite a bit of detective work. This tutorial takes you through that process. **At least have a read even if you don't actually do the steps yourself.** +However, if you have no such prior knowledge, removing a field can take a quite a bit of detective work. This tutorial +takes you through that process. **At least have a read even if you don't actually do the steps yourself.**
-
* Table of Contents
-{:toc}
+ {:toc}
## Safely deleting `Address`
-IntelliJ IDEA provides a refactoring tool that can identify *most* parts of a removal easily. Let’s try to use it as much as we can.
+IntelliJ IDEA provides a refactoring tool that can identify *most* parts of a removal easily. Let’s try to use it as
+much as we can.
### Assisted refactoring
-The `address` field in `Person` is actually an instance of the `seedu.address.model.person.Address` class. Since removing the `Address` class will break the application, we start by identifying `Address`'s usages. This allows us to see code that depends on `Address` to function properly and edit them on a case-by-case basis. Right-click the `Address` class and select `Refactor` \> `Safe Delete` through the menu.
-* :bulb: To make things simpler, you can unselect the options `Search in comments and strings` and `Search for text occurrences`
+The `address` field in `Person` is actually an instance of the `seedu.address.model.developer.Address` class. Since
+removing the `Address` class will break the application, we start by identifying `Address`'s usages. This allows us to
+see code that depends on `Address` to function properly and edit them on a case-by-case basis. Right-click the `Address`
+class and select `Refactor` \> `Safe Delete` through the menu.
+
+* :bulb: To make things simpler, you can unselect the options `Search in comments and strings`
+ and `Search for text occurrences`
-Choose to `View Usages` and you should be presented with a list of `Safe Delete Conflicts`. These conflicts describe locations in which the `Address` class is used.
+Choose to `View Usages` and you should be presented with a list of `Safe Delete Conflicts`. These conflicts describe
+locations in which the `Address` class is used.
-Remove usages of `Address` by performing `Safe Delete`s on each entry i.e., double-click on the entry (which takes you to the code in concern, right-click on that entity, and choose `Refactor` -> `Safe delete` as before). You will need to exercise discretion when removing usages of `Address`. Functions like `ParserUtil#parseAddress()` can be safely removed but its usages must be removed as well. Other usages like in `EditPersonDescriptor` may require more careful inspection.
+Remove usages of `Address` by performing `Safe Delete`s on each entry i.e., double-click on the entry (which takes you
+to the code in concern, right-click on that entity, and choose `Refactor` -> `Safe delete` as before). You will need to
+exercise discretion when removing usages of `Address`. Functions like `ParserUtil#parseAddress()` can be safely removed
+but its usages must be removed as well. Other usages like in `EditPersonDescriptor` may require more careful inspection.
Let’s try removing references to `Address` in `EditPersonDescriptor`.
@@ -52,7 +65,8 @@ Let’s try removing references to `Address` in `EditPersonDescriptor`.
-However, if you have no such prior knowledge, removing a field can take a quite a bit of detective work. This tutorial takes you through that process. **At least have a read even if you don't actually do the steps yourself.** +However, if you have no such prior knowledge, removing a field can take a quite a bit of detective work. This tutorial +takes you through that process. **At least have a read even if you don't actually do the steps yourself.**
- :bulb: **Tip:** Removing usages may result in errors. Exercise discretion and fix them. For example, removing the `address` field from the `Person` class will require you to modify its constructor.
+ :bulb: **Tip:** Removing usages may result in errors. Exercise discretion and fix them. For example, removing
+ the `address` field from the `Person` class will require you to modify its constructor.
1. Repeat the steps for the remaining usages of `Address`
@@ -61,13 +75,17 @@ After you are done, verify that the application still works by compiling and run
### Manual refactoring
-Unfortunately, there are usages of `Address` that IntelliJ IDEA cannot identify. You can find them by searching for instances of the word `address` in your code (`Edit` \> `Find` \> `Find in path`).
+Unfortunately, there are usages of `Address` that IntelliJ IDEA cannot identify. You can find them by searching for
+instances of the word `address` in your code (`Edit` \> `Find` \> `Find in path`).
-Places of interest to look out for would be resources used by the application. `main/resources` contains images and `fxml` files used by the application and `test/resources` contains test data. For example, there is a `$address` in each `PersonCard` that has not been removed nor identified.
+Places of interest to look out for would be resources used by the application. `main/resources` contains images
+and `fxml` files used by the application and `test/resources` contains test data. For example, there is a `$address` in
+each `PersonCard` that has not been removed nor identified.
-A quick look at the `PersonCard` class and its `fxml` file quickly reveals why it slipped past the automated refactoring.
+A quick look at the `PersonCard` class and its `fxml` file quickly reveals why it slipped past the automated
+refactoring.
**`PersonCard.java`**
@@ -88,24 +106,29 @@ private Label address;
...
```
-After removing the `Label`, we can proceed to formally test our code. If everything went well, you should have most of your tests pass. Fix any remaining errors until the tests all pass.
+After removing the `Label`, we can proceed to formally test our code. If everything went well, you should have most of
+your tests pass. Fix any remaining errors until the tests all pass.
## Tidying up
-At this point, your application is working as intended and all your tests are passing. What’s left to do is to clean up references to `Address` in test data and documentation.
+At this point, your application is working as intended and all your tests are passing. What’s left to do is to clean up
+references to `Address` in test data and documentation.
-In `src/test/data/`, data meant for testing purposes are stored. While keeping the `address` field in the json files does not cause the tests to fail, it is not good practice to let cruft from old features accumulate.
+In `src/test/data/`, data meant for testing purposes are stored. While keeping the `address` field in the json files
+does not cause the tests to fail, it is not good practice to let cruft from old features accumulate.
**`invalidPersonAddressBook.json`:**
```json
{
- "persons": [ {
- "name": "Person with invalid name field: Ha!ns Mu@ster",
- "phone": "9482424",
- "email": "hans@example.com",
- "address": "4th street"
- } ]
+ "developers": [
+ {
+ "name": "Person with invalid name field: Ha!ns Mu@ster",
+ "phone": "9482424",
+ "email": "hans@example.com",
+ "address": "4th street"
+ }
+ ]
}
```
diff --git a/docs/tutorials/TracingCode.md b/docs/tutorials/TracingCode.md
index 4fb62a83ef6..3485a78b8f1 100644
--- a/docs/tutorials/TracingCode.md
+++ b/docs/tutorials/TracingCode.md
@@ -3,18 +3,23 @@ layout: page
title: "Tutorial: Tracing code"
---
-> Indeed, the ratio of time spent reading versus writing is well over 10 to 1. We are constantly reading old code as part of the effort to write new code. …\[Therefore,\] making it easy to read makes it easier to write.
+> Indeed, the ratio of time spent reading versus writing is well over 10 to 1. We are constantly reading old code as
+> part of the effort to write new code. …\[Therefore,\] making it easy to read makes it easier to write.
>
-> — Robert C. Martin Clean Code: A Handbook of Agile Software Craftsmanship
+> — Robert C. Martin Clean Code: A Handbook of Agile Software Craftsmanship
-When trying to understand an unfamiliar code base, one common strategy used is to trace some representative execution path through the code base. One easy way to trace an execution path is to use a debugger to step through the code. In this tutorial, you will be using the IntelliJ IDEA’s debugger to trace the execution path of a specific user command.
+When trying to understand an unfamiliar code base, one common strategy used is to trace some representative execution
+path through the code base. One easy way to trace an execution path is to use a debugger to step through the code. In
+this tutorial, you will be using the IntelliJ IDEA’s debugger to trace the execution path of a specific user command.
* Table of Contents
-{:toc}
+ {:toc}
## Before we start
-Before we jump into the code, it is useful to get an idea of the overall structure and the high-level behavior of the application. This is provided in the 'Architecture' section of the developer guide. In particular, the architecture diagram (reproduced below), tells us that the App consists of several components.
+Before we jump into the code, it is useful to get an idea of the overall structure and the high-level behavior of the
+application. This is provided in the 'Architecture' section of the developer guide. In particular, the architecture
+diagram (reproduced below), tells us that the App consists of several components.
@@ -22,33 +27,49 @@ It also has a sequence diagram (reproduced below) that tells us how a command pr
-Note how the diagram shows only the execution flows _between_ the main components. That is, it does not show details of the execution path *inside* each component. By hiding those details, the diagram aims to inform the reader about the overall execution path of a command without overwhelming the reader with too much details. In this tutorial, you aim to find those omitted details so that you get a more in-depth understanding of how the code works.
+Note how the diagram shows only the execution flows _between_ the main components. That is, it does not show details of
+the execution path *inside* each component. By hiding those details, the diagram aims to inform the reader about the
+overall execution path of a command without overwhelming the reader with too much details. In this tutorial, you aim to
+find those omitted details so that you get a more in-depth understanding of how the code works.
Before we proceed, ensure that you have done the following:
+
1. Read the [*Architecture* section of the DG](../DeveloperGuide.md#architecture)
1. Set up the project in Intellij IDEA
1. Learn basic debugging features of Intellij IDEA
- * If you are using a different IDE, we'll leave it to you to figure out the equivalent feature to use in your IDE.
- * If you are not using an IDE, we'll let you figure out how to achieve the same using your coding toolchain.
+ * If you are using a different IDE, we'll leave it to you to figure out the equivalent feature to use in your IDE.
+ * If you are not using an IDE, we'll let you figure out how to achieve the same using your coding toolchain.
## Setting a breakpoint
-As you know, the first step of debugging is to put in a breakpoint where you want the debugger to pause the execution. For example, if you are trying to understand how the App starts up, you would put a breakpoint in the first statement of the `main` method.
+As you know, the first step of debugging is to put in a breakpoint where you want the debugger to pause the execution.
+For example, if you are trying to understand how the App starts up, you would put a breakpoint in the first statement of
+the `main` method.
-In our case, we would want to begin the tracing at the very point where the App start processing user input (i.e., somewhere in the UI component), and then trace through how the execution proceeds through the UI component. However, the execution path through a GUI is often somewhat obscure due to various *event-driven mechanisms* used by GUI frameworks, which happens to be the case here too. Therefore, let us put the breakpoint where the `UI` transfers control to the `Logic` component.
+In our case, we would want to begin the tracing at the very point where the App start processing user input (i.e.,
+somewhere in the UI component), and then trace through how the execution proceeds through the UI component. However, the
+execution path through a GUI is often somewhat obscure due to various *event-driven mechanisms* used by GUI frameworks,
+which happens to be the case here too. Therefore, let us put the breakpoint where the `UI` transfers control to
+the `Logic` component.
-According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method that belongs to the `Logic` component yields a promising candidate in `seedu.address.logic.Logic`.
+According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control
+to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method
+that belongs to the `Logic` component yields a promising candidate in `seedu.address.logic.Logic`.
-:bulb: **Intellij Tip:** The ['**Search Everywhere**' feature](https://www.jetbrains.com/help/idea/searching-everywhere.html) can be used here. In particular, the '**Find Symbol**' ('Symbol' here refers to methods, variables, classes etc.) variant of that feature is quite useful here as we are looking for a _method_ named `execute`, not simply the text `execute`.
+:bulb: **Intellij Tip:** The ['**Search Everywhere
+**' feature](https://www.jetbrains.com/help/idea/searching-everywhere.html) can be used here. In particular, the '**Find
+Symbol**' ('Symbol' here refers to methods, variables, classes etc.) variant of that feature is quite useful here as we
+are looking for a _method_ named `execute`, not simply the text `execute`.
-A quick look at the `seedu.address.logic.Logic` (an extract given below) confirms that this indeed might be what we’re looking for.
+A quick look at the `seedu.address.logic.Logic` (an extract given below) confirms that this indeed might be what we’re
+looking for.
```java
public interface Logic {
@@ -65,31 +86,39 @@ public interface Logic {
```
But apparently, this is an interface, not a concrete implementation.
-That should be fine because the [Architecture section of the Developer Guide](../DeveloperGuide.html#architecture) tells us that components interact through interfaces. Here's the relevant diagram:
+That should be fine because the [Architecture section of the Developer Guide](../DeveloperGuide.html#architecture) tells
+us that components interact through interfaces. Here's the relevant diagram:
-Next, let's find out which statement(s) in the `UI` code is calling this method, thus transferring control from the `UI` to the `Logic`.
+Next, let's find out which statement(s) in the `UI` code is calling this method, thus transferring control from the `UI`
+to the `Logic`.
-:bulb: **Intellij Tip:** The ['**Find Usages**' feature](https://www.jetbrains.com/help/idea/find-highlight-usages.html#find-usages) can find from which parts of the code a class/method/variable is being used.
+:bulb: **Intellij Tip:** The ['**Find Usages
+**' feature](https://www.jetbrains.com/help/idea/find-highlight-usages.html#find-usages) can find from which parts of
+the code a class/method/variable is being used.
Bingo\! `MainWindow#executeCommand()` seems to be exactly what we’re looking for\!
-Now let’s set the breakpoint. First, double-click the item to reach the corresponding code. Once there, click on the left gutter to set a breakpoint, as shown below.
- 
+Now let’s set the breakpoint. First, double-click the item to reach the corresponding code. Once there, click on the
+left gutter to set a breakpoint, as shown below.
+
## Tracing the execution path
-Recall from the User Guide that the `edit` command has the format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` For this tutorial we will be issuing the command `edit 1 n/Alice Yeoh`.
+Recall from the User Guide that the `edit` command has the
+format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` For this tutorial we will be issuing the
+command `edit 1 n/Alice Yeoh`.
-:bulb: **Tip:** Over the course of the debugging session, you will encounter every major component in the application. Try to keep track of what happens inside the component and where the execution transfers to another component.
+:bulb: **Tip:** Over the course of the debugging session, you will encounter every major component in the application.
+Try to keep track of what happens inside the component and where the execution transfers to another component.
1. To start the debugging session, simply `Run` \> `Debug Main`
@@ -101,12 +130,16 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
1. Use the _Show execution point_ feature to jump to the line of code that we stopped at:
- `CommandResult commandResult = logic.execute(commandText);` is the line that you end up at (i.e., the place where we put the breakpoint). + `CommandResult commandResult = logic.execute(commandText);` is the line that you end up at (i.e., the place where we + put the breakpoint). -1. We are interested in the `logic.execute(commandText)` portion of that line so let’s _Step in_ into that method call:
-  +1. We are interested in the `logic.execute(commandText)` portion of that line so let’s _Step in_ into that method + call:
+  -1. We end up in `LogicManager#execute()` (not `Logic#execute` -- but this is expected because we know the `execute()` method in the `Logic` interface is actually implemented by the `LogicManager` class). Let’s take a look at the body of the method. Given below is the same code, with additional explanatory comments. +1. We end up in `LogicManager#execute()` (not `Logic#execute` -- but this is expected because we know the `execute()` + method in the `Logic` interface is actually implemented by the `LogicManager` class). Let’s take a look at the body + of the method. Given below is the same code, with additional explanatory comments. **LogicManager\#execute().** @@ -136,12 +169,14 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [ } ``` -1. `LogicManager#execute()` appears to delegate most of the heavy lifting to other components. Let’s take a closer look at each one. +1. `LogicManager#execute()` appears to delegate most of the heavy lifting to other components. Let’s take a closer look + at each one. 1. _Step over_ the logging code since it is of no interest to us now.  -1. _Step into_ the line where user input in parsed from a String to a Command, which should bring you to the `AddressBookParser#parseCommand()` method (partial code given below): +1. _Step into_ the line where user input in parsed from a String to a Command, which should bring you to + the `AddressBookParser#parseCommand()` method (partial code given below): ``` java public Command parseCommand(String userInput) throws ParseException { ... @@ -150,12 +185,14 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [ ... ``` -1. _Step over_ the statements in that method until you reach the `switch` statement. The 'Variables' window now shows the value of both `commandWord` and `arguments`:
-  +1. _Step over_ the statements in that method until you reach the `switch` statement. The 'Variables' window now shows + the value of both `commandWord` and `arguments`:
+  1. We see that the value of `commandWord` is now `edit` but `arguments` is still not processed in any meaningful way. -1. Stepping through the `switch` block, we end up at a call to `EditCommandParser().parse()` as expected (because the command we typed is an edit command). +1. Stepping through the `switch` block, we end up at a call to `EditCommandParser().parse()` as expected (because the + command we typed is an edit command). ``` java ... @@ -164,93 +201,121 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [ ... ``` -1. Let’s see what `EditCommandParser#parse()` does by stepping into it. You might have to click the 'step into' button multiple times here because there are two method calls in that statement: `EditCommandParser()` and `parse()`. +1. Let’s see what `EditCommandParser#parse()` does by stepping into it. You might have to click the 'step into' button + multiple times here because there are two method calls in that statement: `EditCommandParser()` and `parse()`.
:bulb: **Intellij Tip:** Sometimes, you might end up stepping into functions that are not of interest. Simply use the `step out` button to get out of them!
-1. Stepping through the method shows that it calls `ArgumentTokenizer#tokenize()` and `ParserUtil#parseIndex()` to obtain the arguments and index required.
+1. Stepping through the method shows that it calls `ArgumentTokenizer#tokenize()` and `ParserUtil#parseIndex()` to
+ obtain the arguments and index required.
-1. The rest of the method seems to exhaustively check for the existence of each possible parameter of the `edit` command and store any possible changes in an `EditPersonDescriptor`. Recall that we can verify the contents of `editPersonDesciptor` through the 'Variables' window.+1. The rest of the method seems to exhaustively check for the existence of each possible parameter of the `edit` command + and store any possible changes in an `EditPersonDescriptor`. Recall that we can verify the contents + of `editPersonDesciptor` through the 'Variables' window.
 -1. As you just traced through some code involved in parsing a command, you can take a look at this class diagram to see where the various parsing-related classes you encountered fit into the design of the `Logic` component. +1. As you just traced through some code involved in parsing a command, you can take a look at this class diagram to see + where the various parsing-related classes you encountered fit into the design of the `Logic` component.
1. Let’s continue stepping through until we return to `LogicManager#execute()`.
- The sequence diagram below shows the details of the execution path through the Logic component. Does the execution path you traced in the code so far match the diagram?-  + The sequence diagram below shows the details of the execution path through the Logic component. Does the execution + path you traced in the code so far match the diagram?
+  -1. Now, step over until you read the statement that calls the `execute()` method of the `EditCommand` object received, and step into that `execute()` method (partial code given below): +1. Now, step over until you read the statement that calls the `execute()` method of the `EditCommand` object received, + and step into that `execute()` method (partial code given below): **`EditCommand#execute()`:** ``` java @Override public CommandResult execute(Model model) throws CommandException { ... - Person personToEdit = lastShownList.get(index.getZeroBased()); - Person editedPerson = createEditedPerson(personToEdit, editPersonDescriptor); - if (!personToEdit.isSamePerson(editedPerson) && model.hasPerson(editedPerson)) { + Person developerToEdit = lastShownList.get(index.getZeroBased()); + Person editedDeveloper = createEditedPerson(developerToEdit, editPersonDescriptor); + if (!developerToEdit.isSamePerson(editedDeveloper) && model.hasPerson(editedDeveloper)) { throw new CommandException(MESSAGE_DUPLICATE_PERSON); } - model.setPerson(personToEdit, editedPerson); + model.setPerson(developerToEdit, editedDeveloper); model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS); - return new CommandResult(String.format(MESSAGE_EDIT_PERSON_SUCCESS, editedPerson)); + return new CommandResult(String.format(MESSAGE_EDIT_PERSON_SUCCESS, editedDeveloper)); } ``` 1. As suspected, `command#execute()` does indeed make changes to the `model` object. Specifically, - * it uses the `setPerson()` method (defined in the interface `Model` and implemented in `ModelManager` as per the usual pattern) to update the person data. - * it uses the `updateFilteredPersonList` method to ask the `Model` to populate the 'filtered list' with _all_ persons.
- FYI, The 'filtered list' is the list of persons resulting from the most recent operation that will be shown to the user immediately after. For the `edit` command, we populate it with all the persons so that the user can see the edited person along with all other persons. If this was a `find` command, we would be setting that list to contain the search results instead.
- To provide some context, given below is the class diagram of the `Model` component. See if you can figure out where the 'filtered list' of persons is being tracked. -
- * :bulb: This may be a good time to read through the [`Model` component section of the DG](../DeveloperGuide.html#model-component) - -1. As you step through the rest of the statements in the `EditCommand#execute()` method, you'll see that it creates a `CommandResult` object (containing information about the result of the execution) and returns it.
- Advancing the debugger by one more step should take you back to the middle of the `LogicManager#execute()` method.
- -1. Given that you have already seen quite a few classes in the `Logic` component in action, see if you can identify in this partial class diagram some of the classes you've encountered so far, and see how they fit into the class structure of the `Logic` component: -
- * :bulb: This may be a good time to read through the [`Logic` component section of the DG](../DeveloperGuide.html#logic-component)
-
-1. Similar to before, you can step over/into statements in the `LogicManager#execute()` method to examine how the control is transferred to the `Storage` component and what happens inside that component.
+ * it uses the `setPerson()` method (defined in the interface `Model` and implemented in `ModelManager` as per the
+ usual pattern) to update the developer data.
+ * it uses the `updateFilteredPersonList` method to ask the `Model` to populate the 'filtered list' with _all_
+ developers.+ FYI, The 'filtered list' is the list of developers resulting from the most recent operation that will be shown to + the user immediately after. For the `edit` command, we populate it with all the developers so that the user can + see the edited developer along with all other developers. If this was a `find` command, we would be setting that + list to contain the search results instead.
+ To provide some context, given below is the class diagram of the `Model` component. See if you can figure out + where the 'filtered list' of developers is being tracked. +
+ * :bulb: This may be a good time to read through + the [`Model` component section of the DG](../DeveloperGuide.html#model-component) + +1. As you step through the rest of the statements in the `EditCommand#execute()` method, you'll see that it creates + a `CommandResult` object (containing information about the result of the execution) and returns it.
+ Advancing the debugger by one more step should take you back to the middle of the `LogicManager#execute()` + method.
+ +1. Given that you have already seen quite a few classes in the `Logic` component in action, see if you can identify in + this partial class diagram some of the classes you've encountered so far, and see how they fit into the class + structure of the `Logic` component: +
+ * :bulb: This may be a good time to read through
+ the [`Logic` component section of the DG](../DeveloperGuide.html#logic-component)
+
+1. Similar to before, you can step over/into statements in the `LogicManager#execute()` method to examine how the
+ control is transferred to the `Storage` component and what happens inside that component.
:bulb: **Intellij Tip:** When trying to step into a statement such as `storage.saveAddressBook(model.getAddressBook())` which contains multiple method calls, Intellij will let you choose (by clicking) which one you want to step into.
-1. As you step through the code inside the `Storage` component, you will eventually arrive at the `JsonAddressBook#saveAddressBook()` method which calls the `JsonSerializableAddressBook` constructor, to create an object that can be _serialized_ (i.e., stored in storage medium) in JSON format. That constructor is given below (with added line breaks for easier readability):
+1. As you step through the code inside the `Storage` component, you will eventually arrive at
+ the `JsonAddressBook#saveAddressBook()` method which calls the `JsonSerializableAddressBook` constructor, to create
+ an object that can be _serialized_ (i.e., stored in storage medium) in JSON format. That constructor is given below (
+ with added line breaks for easier readability):
- **`JsonSerializableAddressBook` constructor:**
- ``` java
- /**
- * Converts a given {@code ReadOnlyAddressBook} into this class for Jackson use.
- *
- * @param source future changes to this will not affect the created
- * {@code JsonSerializableAddressBook}.
- */
- public JsonSerializableAddressBook(ReadOnlyAddressBook source) {
- persons.addAll(
- source.getPersonList()
- .stream()
- .map(JsonAdaptedPerson::new)
- .collect(Collectors.toList()));
- }
- ```
+ **`JsonSerializableAddressBook` constructor:**
+ ``` java
+ /**
+ * Converts a given {@code ReadOnlyAddressBook} into this class for Jackson use.
+ *
+ * @param source future changes to this will not affect the created
+ * {@code JsonSerializableAddressBook}.
+ */
+ public JsonSerializableAddressBook(ReadOnlyAddressBook source) {
+ developers.addAll(
+ source.getPersonList()
+ .stream()
+ .map(JsonAdaptedPerson::new)
+ .collect(Collectors.toList()));
+ }
+ ```
-1. It appears that a `JsonAdaptedPerson` is created for each `Person` and then added to the `JsonSerializableAddressBook`.
- This is because regular Java objects need to go through an _adaptation_ for them to be suitable to be saved in JSON format.
+1. It appears that a `JsonAdaptedPerson` is created for each `Person` and then added to
+ the `JsonSerializableAddressBook`.
+ This is because regular Java objects need to go through an _adaptation_ for them to be suitable to be saved in JSON
+ format.
-1. While you are stepping through the classes in the `Storage` component, here is the component's class diagram to help you understand how those classes fit into the structure of the component.+1. While you are stepping through the classes in the `Storage` component, here is the component's class diagram to help + you understand how those classes fit into the structure of the component.
- * :bulb: This may be a good time to read through the [`Storage` component section of the DG](../DeveloperGuide.html#storage-component)
+ * :bulb: This may be a good time to read through
+ the [`Storage` component section of the DG](../DeveloperGuide.html#storage-component)
-1. We can continue to step through until you reach the end of the `LogicManager#execute()` method and return to the `MainWindow#executeCommand()` method (the place where we put the original breakpoint).
+1. We can continue to step through until you reach the end of the `LogicManager#execute()` method and return to
+ the `MainWindow#executeCommand()` method (the place where we put the original breakpoint).
1. Stepping into `resultDisplay.setFeedbackToUser(commandResult.getFeedbackToUser());`, we end up in:
- **`ResultDisplay#setFeedbackToUser()`**
+ **`ResultDisplay#setFeedbackToUser()`**
``` java
public void setFeedbackToUser(String feedbackToUser) {
requireNonNull(feedbackToUser);
@@ -259,43 +324,45 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
```
1. Finally, you can step through until you reach the end of`MainWindow#executeCommand()`.- :bulb: This may be a good time to read through the [`UI` component section of the DG](../DeveloperGuide.html#ui-component) - + :bulb: This may be a good time to read through + the [`UI` component section of the DG](../DeveloperGuide.html#ui-component) ## Conclusion -In this tutorial, we traced a valid edit command from raw user input to the result being displayed to the user. From this tutorial, you learned more about how the various components work together to produce a response to a user command. +In this tutorial, we traced a valid edit command from raw user input to the result being displayed to the user. From +this tutorial, you learned more about how the various components work together to produce a response to a user command. -Here are some quick questions you can try to answer based on your execution path tracing. In some cases, you can do further tracing for the given commands to find exactly what happens. +Here are some quick questions you can try to answer based on your execution path tracing. In some cases, you can do +further tracing for the given commands to find exactly what happens. -1. In this tutorial, we traced the "happy path" (i.e., no errors). What - do you think will happen if we traced the following commands - instead? What exceptions do you think will be thrown (if any), where - will the exceptions be thrown and where will they be handled? +1. In this tutorial, we traced the "happy path" (i.e., no errors). What + do you think will happen if we traced the following commands + instead? What exceptions do you think will be thrown (if any), where + will the exceptions be thrown and where will they be handled? - 1. `redit 1 n/Alice Yu` + 1. `redit 1 n/Alice Yu` - 2. `edit 0 n/Alice Yu` + 2. `edit 0 n/Alice Yu` - 3. `edit 1 n/Alex Yeoh` + 3. `edit 1 n/Alex Yeoh` - 4. `edit 1` + 4. `edit 1` - 5. `edit 1 n/アリス ユー` + 5. `edit 1 n/アリス ユー` - 6. `edit 1 t/one t/two t/three t/one` + 6. `edit 1 t/one t/two t/three t/one` -2. What components will you have to modify to perform the following - enhancements to the application? +2. What components will you have to modify to perform the following + enhancements to the application? - 1. Make command words case-insensitive + 1. Make command words case-insensitive - 2. Allow `delete` to remove more than one index at a time + 2. Allow `delete` to remove more than one index at a time - 3. Save the address book in the CSV format instead + 3. Save the address book in the CSV format instead - 4. Add a new command + 4. Add a new command - 5. Add a new field to `Person` + 5. Add a new field to `Person` - 6. Add a new entity to the address book + 6. Add a new entity to the address book diff --git a/gradle.properties b/gradle.properties index 40764dc1791..c75a9af3404 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,6 +1,5 @@ org.gradle.parallel=false org.gradle.jvmargs=-XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError -Xmx1024m -Dfile.encoding=utf-8 - # TODO: This is a workaround for a JDK11 bug which causes test coverage upload to fail. # Remove it when https://bugs.openjdk.java.net/browse/JDK-8221253 is fixed. systemProp.jdk.tls.client.protocols="TLSv1,TLSv1.1,TLSv1.2" diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index e708b1c023e..41d9927a4d4 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/src/main/java/seedu/address/AppParameters.java b/src/main/java/seedu/address/AppParameters.java index 3d603622d4e..0fc21bcdfb4 100644 --- a/src/main/java/seedu/address/AppParameters.java +++ b/src/main/java/seedu/address/AppParameters.java @@ -19,14 +19,6 @@ public class AppParameters { private Path configPath; - public Path getConfigPath() { - return configPath; - } - - public void setConfigPath(Path configPath) { - this.configPath = configPath; - } - /** * Parses the application command-line parameters. */ @@ -44,6 +36,14 @@ public static AppParameters parse(Application.Parameters parameters) { return appParameters; } + public Path getConfigPath() { + return configPath; + } + + public void setConfigPath(Path configPath) { + this.configPath = configPath; + } + @Override public boolean equals(Object other) { if (other == this) { diff --git a/src/main/java/seedu/address/Main.java b/src/main/java/seedu/address/Main.java index ec1b7958746..f14473af111 100644 --- a/src/main/java/seedu/address/Main.java +++ b/src/main/java/seedu/address/Main.java @@ -7,17 +7,17 @@ /** * The main entry point to the application. - * + *
* This is a workaround for the following error when MainApp is made the * entry point of the application: - * - * Error: JavaFX runtime components are missing, and are required to run this application - * + *
+ * Error: JavaFX runtime components are missing, and are required to run this application + *
* The reason is that MainApp extends Application. In that case, the * LauncherHelper will check for the javafx.graphics module to be present * as a named module. We don't use JavaFX via the module system so it can't * find the javafx.graphics module, and so the launch is aborted. - * + *
* By having a separate main class (Main) that doesn't extend Application
* to be the entry point of the application, we avoid this issue.
*/
diff --git a/src/main/java/seedu/address/MainApp.java b/src/main/java/seedu/address/MainApp.java
index 3d6bd06d5af..77a90798a34 100644
--- a/src/main/java/seedu/address/MainApp.java
+++ b/src/main/java/seedu/address/MainApp.java
@@ -36,7 +36,7 @@
*/
public class MainApp extends Application {
- public static final Version VERSION = new Version(0, 2, 2, true);
+ public static final Version VERSION = new Version(1, 4, 0, true);
private static final Logger logger = LogsCenter.getLogger(MainApp.class);
diff --git a/src/main/java/seedu/address/commons/core/LogsCenter.java b/src/main/java/seedu/address/commons/core/LogsCenter.java
index 8cf8e15a0f0..b3cd9b0e3de 100644
--- a/src/main/java/seedu/address/commons/core/LogsCenter.java
+++ b/src/main/java/seedu/address/commons/core/LogsCenter.java
@@ -14,8 +14,8 @@
* Configures and manages loggers and handlers, including their logging level
* Named {@link Logger}s can be obtained from this class
* These loggers have been configured to output messages to the console and a {@code .log} file by default,
- * at the {@code INFO} level. A new {@code .log} file with a new numbering will be created after the log
- * file reaches 5MB big, up to a maximum of 5 files.
+ * at the {@code INFO} level. A new {@code .log} file with a new numbering will be created after the log
+ * file reaches 5MB big, up to a maximum of 5 files.
*/
public class LogsCenter {
private static final int MAX_FILE_COUNT = 5;
diff --git a/src/main/java/seedu/address/commons/core/Version.java b/src/main/java/seedu/address/commons/core/Version.java
index 491d24559b4..1e3c2882da9 100644
--- a/src/main/java/seedu/address/commons/core/Version.java
+++ b/src/main/java/seedu/address/commons/core/Version.java
@@ -32,24 +32,9 @@ public Version(int major, int minor, int patch, boolean isEarlyAccess) {
this.isEarlyAccess = isEarlyAccess;
}
- public int getMajor() {
- return major;
- }
-
- public int getMinor() {
- return minor;
- }
-
- public int getPatch() {
- return patch;
- }
-
- public boolean isEarlyAccess() {
- return isEarlyAccess;
- }
-
/**
* Parses a version number string in the format V1.2.3.
+ *
* @param versionString version number string
* @return a Version object
*/
@@ -67,6 +52,22 @@ public static Version fromString(String versionString) throws IllegalArgumentExc
versionMatcher.group(4) == null ? false : true);
}
+ public int getMajor() {
+ return major;
+ }
+
+ public int getMinor() {
+ return minor;
+ }
+
+ public int getPatch() {
+ return patch;
+ }
+
+ public boolean isEarlyAccess() {
+ return isEarlyAccess;
+ }
+
@JsonValue
public String toString() {
return String.format("V%d.%d.%d%s", major, minor, patch, isEarlyAccess ? "ea" : "");
diff --git a/src/main/java/seedu/address/commons/core/index/Index.java b/src/main/java/seedu/address/commons/core/index/Index.java
index dd170d8b68d..6b0d846b4c9 100644
--- a/src/main/java/seedu/address/commons/core/index/Index.java
+++ b/src/main/java/seedu/address/commons/core/index/Index.java
@@ -4,7 +4,7 @@
/**
* Represents a zero-based or one-based index.
- *
+ *
* {@code Index} should be used right from the start (when parsing in a new user input), so that if the current
* component wants to communicate with another component, it can send an {@code Index} to avoid having to know what
* base the other component is using for its index. However, after receiving the {@code Index}, that component can
@@ -25,14 +25,6 @@ private Index(int zeroBasedIndex) {
this.zeroBasedIndex = zeroBasedIndex;
}
- public int getZeroBased() {
- return zeroBasedIndex;
- }
-
- public int getOneBased() {
- return zeroBasedIndex + 1;
- }
-
/**
* Creates a new {@code Index} using a zero-based index.
*/
@@ -47,6 +39,14 @@ public static Index fromOneBased(int oneBasedIndex) {
return new Index(oneBasedIndex - 1);
}
+ public int getZeroBased() {
+ return zeroBasedIndex;
+ }
+
+ public int getOneBased() {
+ return zeroBasedIndex + 1;
+ }
+
@Override
public boolean equals(Object other) {
if (other == this) {
diff --git a/src/main/java/seedu/address/commons/exceptions/IllegalValueException.java b/src/main/java/seedu/address/commons/exceptions/IllegalValueException.java
index 19124db485c..651ce290208 100644
--- a/src/main/java/seedu/address/commons/exceptions/IllegalValueException.java
+++ b/src/main/java/seedu/address/commons/exceptions/IllegalValueException.java
@@ -13,7 +13,7 @@ public IllegalValueException(String message) {
/**
* @param message should contain relevant information on the failed constraint(s)
- * @param cause of the main exception
+ * @param cause of the main exception
*/
public IllegalValueException(String message, Throwable cause) {
super(message, cause);
diff --git a/src/main/java/seedu/address/commons/util/CollectionUtil.java b/src/main/java/seedu/address/commons/util/CollectionUtil.java
index eafe4dfd681..942edda97d7 100644
--- a/src/main/java/seedu/address/commons/util/CollectionUtil.java
+++ b/src/main/java/seedu/address/commons/util/CollectionUtil.java
@@ -12,7 +12,9 @@
*/
public class CollectionUtil {
- /** @see #requireAllNonNull(Collection) */
+ /**
+ * @see #requireAllNonNull(Collection)
+ */
public static void requireAllNonNull(Object... items) {
requireNonNull(items);
Stream.of(items).forEach(Objects::requireNonNull);
diff --git a/src/main/java/seedu/address/commons/util/FileUtil.java b/src/main/java/seedu/address/commons/util/FileUtil.java
index b1e2767cdd9..f811215474c 100644
--- a/src/main/java/seedu/address/commons/util/FileUtil.java
+++ b/src/main/java/seedu/address/commons/util/FileUtil.java
@@ -20,6 +20,7 @@ public static boolean isFileExists(Path file) {
/**
* Returns true if {@code path} can be converted into a {@code Path} via {@link Paths#get(String)},
* otherwise returns false.
+ *
* @param path A string representing the file path. Cannot be null.
*/
public static boolean isValidPath(String path) {
@@ -33,6 +34,7 @@ public static boolean isValidPath(String path) {
/**
* Creates a file if it does not exist along with its missing parent directories.
+ *
* @throws IOException if the file or directory cannot be created.
*/
public static void createIfMissing(Path file) throws IOException {
diff --git a/src/main/java/seedu/address/commons/util/JsonUtil.java b/src/main/java/seedu/address/commons/util/JsonUtil.java
index 100cb16c395..cc2d698adb0 100644
--- a/src/main/java/seedu/address/commons/util/JsonUtil.java
+++ b/src/main/java/seedu/address/commons/util/JsonUtil.java
@@ -52,7 +52,7 @@ static
* Returns null if there are no matches
- *
*/
private Level getLoggingLevel(String loggingLevelString) {
return Level.parse(loggingLevelString);
diff --git a/src/main/java/seedu/address/commons/util/StringUtil.java b/src/main/java/seedu/address/commons/util/StringUtil.java
index 61cc8c9a1cb..57ce6d91bfb 100644
--- a/src/main/java/seedu/address/commons/util/StringUtil.java
+++ b/src/main/java/seedu/address/commons/util/StringUtil.java
@@ -14,14 +14,15 @@ public class StringUtil {
/**
* Returns true if the {@code sentence} contains the {@code word}.
- * Ignores case, but a full word match is required.
- *
* E.g if {@code argsString} = "e/hip/900", {@code prefix} = "p/" and
* {@code fromIndex} = 0, this method returns -1 as there are no valid
* occurrences of "p/" with whitespace before it. However, if
@@ -82,7 +82,7 @@ private static int findPrefixPosition(String argsString, String prefix, int from
*
* @param argsString Arguments string of the form: {@code preamble
examples:
+ * Ignores case, but a full word match is required.
+ *
examples:
* containsWordIgnoreCase("ABc def", "abc") == true
* containsWordIgnoreCase("ABc def", "DEF") == true
* containsWordIgnoreCase("ABc def", "AB") == false //not a full word match
*
+ *
* @param sentence cannot be null
- * @param word cannot be null, cannot be empty, must be a single word
+ * @param word cannot be null, cannot be empty, must be a single word
*/
public static boolean containsWordIgnoreCase(String sentence, String word) {
requireNonNull(sentence);
@@ -38,6 +39,32 @@ public static boolean containsWordIgnoreCase(String sentence, String word) {
.anyMatch(preppedWord::equalsIgnoreCase);
}
+ /**
+ * Returns true if the {@code sentence} contains the {@code word} as a partial word match.
+ * Ignores case, and it matches the word even if it's only a part of a larger word.
+ *
examples:
+ * containsPartialWordIgnoreCase("ABc def", "abc") == true
+ * containsPartialWordIgnoreCase("ABc def", "DEF") == true
+ * containsPartialWordIgnoreCase("ABc def", "AB") == true
+ *
+ *
+ * @param sentence cannot be null
+ * @param word cannot be null, cannot be empty
+ */
+ public static boolean containsPartialWordIgnoreCase(String sentence, String word) {
+ requireNonNull(sentence);
+ requireNonNull(word);
+
+ String preppedWord = word.trim();
+ checkArgument(!preppedWord.isEmpty(), "Word parameter cannot be empty");
+
+ String preppedSentence = sentence;
+ String[] wordsInPreppedSentence = preppedSentence.split("\\s+");
+
+ return Arrays.stream(wordsInPreppedSentence)
+ .anyMatch(wordInSentence -> wordInSentence.toLowerCase().contains(preppedWord.toLowerCase()));
+ }
+
/**
* Returns a detailed message of the t, including the stack trace.
*/
@@ -53,6 +80,7 @@ public static String getDetails(Throwable t) {
* e.g. 1, 2, 3, ..., {@code Integer.MAX_VALUE}
* Will return false for any other non-null string input
* e.g. empty string, "-1", "0", "+1", and " 2 " (untrimmed), "3 0" (contains whitespace), "1 a" (contains letters)
+ *
* @throws NullPointerException if {@code s} is null.
*/
public static boolean isNonZeroUnsignedInteger(String s) {
diff --git a/src/main/java/seedu/address/commons/util/ToStringBuilder.java b/src/main/java/seedu/address/commons/util/ToStringBuilder.java
index d979b926734..9abdc755f39 100644
--- a/src/main/java/seedu/address/commons/util/ToStringBuilder.java
+++ b/src/main/java/seedu/address/commons/util/ToStringBuilder.java
@@ -30,7 +30,7 @@ public ToStringBuilder(Object object) {
/**
* Adds a field name/value pair to the output string.
*
- * @param fieldName The name of the field.
+ * @param fieldName The name of the field.
* @param fieldValue The value of the field.
* @return A reference to this {@code ToStringBuilder} object, allowing method calls to be chained.
*/
diff --git a/src/main/java/seedu/address/logic/Logic.java b/src/main/java/seedu/address/logic/Logic.java
index 92cd8fa605a..743149b250a 100644
--- a/src/main/java/seedu/address/logic/Logic.java
+++ b/src/main/java/seedu/address/logic/Logic.java
@@ -8,7 +8,8 @@
import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.logic.parser.exceptions.ParseException;
import seedu.address.model.ReadOnlyAddressBook;
-import seedu.address.model.person.Person;
+import seedu.address.model.client.Client;
+import seedu.address.model.developer.Developer;
/**
* API of the Logic component
@@ -16,10 +17,11 @@
public interface Logic {
/**
* Executes the command and returns the result.
+ *
* @param commandText The command as entered by the user.
* @return the result of the command execution.
* @throws CommandException If an error occurs during command execution.
- * @throws ParseException If an error occurs during parsing.
+ * @throws ParseException If an error occurs during parsing.
*/
CommandResult execute(String commandText) throws CommandException, ParseException;
@@ -30,8 +32,14 @@ public interface Logic {
*/
ReadOnlyAddressBook getAddressBook();
- /** Returns an unmodifiable view of the filtered list of persons */
- ObservableList
- * e.g. {@code some preamble text t/ 11.00 t/12.00 k/ m/ July} where prefixes are {@code t/ k/ m/}.
+ * e.g. {@code some preamble text t/ 11.00 t/12.00 k/ m/ July} where prefixes are {@code t/ k/ m/}.
* 1. An argument's value can be an empty string e.g. the value of {@code k/} in the above example.
* 2. Leading and trailing whitespaces of an argument value will be discarded.
* 3. An argument may be repeated and all its values will be accumulated e.g. the value of {@code t/}
- * in the above example.
+ * in the above example.
*/
public class ArgumentTokenizer {
@@ -21,7 +21,7 @@ public class ArgumentTokenizer {
*
* @param argsString Arguments string of the form: {@code preamble