+
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/gengyudong)]
+[[Portfolio](team/gengyudong.md)]
-* Role: Project Advisor
+* Role: Developer (Team Lead)
+* Responsibilities: Feature - Delete Contacts
-### Jane Doe
+### Glenn Liew Zi Yi
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/glennliew)]
+[[Portfolio](team/glennliew.md)]
-* Role: Team Lead
+* Role: Developer (Documentation)
* Responsibilities: UI
-### Johnny Doe
+### Hu Junjie
-
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[Github](http://github.com/grassheadd)] [[Portfolio](team/junjie.md)]
-* Role: Developer
+* Role: Developer (Code Quality)
* Responsibilities: Data
-### Jean Doe
+### Arulanandam James Beryl
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](https://github.com/jamesberyl)]
+[[Portfolio](team/jamesberyl.md)]
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Developer (Testing)
+* Responsibilities: Feature - Filter Contacts
-### James Doe
+### Wei Yan Min Oo
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/weiyanminoo)]
+[[Portfolio](team/weiyanminoo.md)]
-* Role: Developer
-* Responsibilities: UI
+* Role: Developer (Integration)
+* Responsibilities: Feature - Add Contacts
diff --git a/docs/Configuration.md b/docs/Configuration.md
index 13cf0faea16..32f6255f3b9 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -1,6 +1,8 @@
---
-layout: page
-title: Configuration guide
+ layout: default.md
+ title: "Configuration guide"
---
+# 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`).
diff --git a/docs/DevOps.md b/docs/DevOps.md
index d2fd91a6001..8228c845e86 100644
--- a/docs/DevOps.md
+++ b/docs/DevOps.md
@@ -1,12 +1,15 @@
---
-layout: page
-title: DevOps guide
+ layout: default.md
+ title: "DevOps guide"
+ pageNav: 3
---
-* Table of Contents
-{:toc}
+# DevOps guide
---------------------------------------------------------------------------------------------------------------------
+
+
+
+
+
+
+
+**API** : [`Model.java`](https://github.com/AY2425S2-CS2103T-F12-2/tp/blob/master/src/main/java/seedu/address/model/Model.java)
+[Model is the interface for the model component. It encapsulates the application's data structures and business logic, providing methods to access and modify contact, wedding and task data.]
+{{ page.alt_title | escape }}
-
- {{ content }}
-
-
-
- {{ content }}
-
- :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.
+
-
+**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.
-
++
+**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.-
++ +### 1. Creating a wedding + +The `AddWeddingCommand` allows users to create new wedding events within the application. This is essential for wedding planners to keep track of different wedding events they are managing. + +#### Implementation Details #### +The `AddWeddingCommand` is implemented by extending the base `Command` class. It uses prefixes such as `n/`, `d/`, and `l/`, specifying required data fields for weddingName, weddingDate, and weddingLocation respectively. Once the data fields are filled, a new Wedding is added. It implements the following operations: + + +* `execute(Model)` — Checks the current address book state by calling `model.hasWedding(toAdd)`, and throws a `CommandException` if a duplicate Wedding is found + +* `addWedding(wedding)` — Adds the Wedding to the wedding list. This operation is exposed in the Model interface as `Model#addWedding(Wedding)`. + +
+Given below is an example usage scenario of how the addition mechanism behaves when the user tries to add a wedding to the wedding list: + +
+ +Step 1. The user launches the application, with some contacts already added to the address book. + +Step 2. The user executes `addWedding` command with specific details (e.g., `addWedding n/John and Jane's Wedding d/20-Feb-2026 l/Marina Bay Sands`). The `AddWeddingCommand` will then call `execute()`, which checks whether there is a duplicate Wedding in the wedding list before calling `addWedding(Wedding)`. + +
+ +#### Design considerations: +**Aspect: How wedding IDs are generated:** + + +**Alternative 1 (current choice):** Automatically generate sequential wedding IDs (W1, W2, etc.) in the Wedding model. + +* Pros: Easier to implement and more intuitive for users. +* Cons: May have issues with ID conflicts if weddings are deleted and re-added. + +Alternative 2: Allow users to specify their own wedding IDs. + +* Pros: More flexibility for users to create meaningful identifiers. +* Cons: More complex to implement and potential for user errors with duplicate IDs. + +
+ +### 2. Deleting a wedding + +The `DeleteWeddingCommand` allows users to remove wedding events from the application. This is particularly useful for removing completed or canceled weddings. + +#### Implementation Details #### +The `DeleteWeddingCommand` is implemented by extending the base `Command` class. It takes a `WeddingId` parameter to identify which wedding to delete. It implements the following operations: + +* `execute(Model)` — Retrieves the wedding to delete using `model.getWeddingById(weddingId)`, throwing a `CommandException` if no matching wedding is found. +* `deleteWedding(weddingToDelete)` — Removes the Wedding from the wedding list. +* `removeTagFromAllContacts(tag)` — Removes the wedding tag from all contacts that were associated with the wedding. + +Given below is an example usage scenario of how the deletion mechanism behaves: + +
+ +Step 1. The user executes `deleteWedding W1` to delete the wedding with ID W1. + +Step 2. The `DeleteWeddingCommand` finds the wedding with ID W1 in the model and removes it. + +Step 3. The command also finds all contacts tagged with W1 and removes that tag from them, ensuring data consistency. + +#### Sequence Diagram ##### + +
+ +#### Design considerations: +**Aspect: How wedding deletion affects associated data:** + +**Alternative 1 (current choice):** Remove wedding tags from all contacts when a wedding is deleted. + +* Pros: Maintains data consistency and prevents orphaned tags. +* Cons: Slightly more complex implementation and slower deletion operation. + +Alternative 2: Keep the tags on contacts even when a wedding is deleted. + +* Pros: Simpler implementation and faster deletion. +* Cons: Results in orphaned tags that reference non-existent weddings. + +
+ +### 3. Tagging a contact to a wedding + +The `TagCommand` allows users to associate contacts with specific wedding events. This is essential for keeping track of which vendors and clients are associated with each wedding. + +#### Implementation Details ##### +The `TagCommand` is implemented by extending the base `Command` class. It takes an `Index` parameter to identify the contact and a `WeddingId` to identify the wedding. It implements the following operations: + +* `execute(Model)` — Retrieves the person at the specified index using `model.getFilteredPersonList()` and checks if the wedding exists. +* `tagPerson(person, tag)` — Associates the contact with the wedding by adding a tag. + +Given below is an example usage scenario: + + +Step 1. The user executes `tag 1 W1` to tag the first contact in the list to wedding W1. + +Step 2. The `TagCommand` retrieves the person at index 1 and creates a new tag with wedding ID W1. + +Step 3. The command adds this tag to the person's tag set, creating an association between the contact and the wedding. + +#### Sequence Diagram + +
+ +#### Design considerations: +**Aspect: How wedding-contact associations are stored:** + +**Alternative 1 (current choice):** Store the association as tags on Person objects. + +* Pros: Leverages existing tag functionality, making implementation simpler. +* Cons: Limited metadata can be stored about the association. + +Alternative 2: Create a separate association entity that links persons and weddings. + +* Pros: Could store additional information about the role in the wedding. +* Cons: More complex to implement and manage. + +
+ +### 4. Untagging a contact from a wedding + +The `UntagCommand` allows users to remove associations between contacts and weddings. This is useful when a vendor or client is no longer involved with a specific wedding. + +#### Implementation Details ##### +The `UntagCommand` is implemented similarly to the `TagCommand`. It takes an `Index` parameter to identify the contact and a `WeddingId` to identify the wedding to untag. It implements: + +* `execute(Model)` — Retrieves the person and checks if they have the specified wedding tag. +* `untagPerson(person, tag)` — Removes the wedding tag from the contact. + +Given below is an example usage scenario: + +Step 1. The user executes `untag 1 W1` to remove the association between the first contact and wedding W1. + +Step 2. The `UntagCommand` checks if the person has the W1 tag and removes it if present. + +#### Sequence Diagram +
+ +#### Design considerations: + +**Aspect: Handling non-existent tags in untag command:** + +**Alternative 1 (current choice):** Check if the tag exists before attempting to remove it. + +* Pros: Provides clear error messages to users. +* Cons: Requires additional checks in the command execution. + +Alternative 2: Silently ignore untag requests for non-existent tags. + +* Pros: Simpler implementation. +* Cons: Less informative for users, who might not realize the tag didn't exist. + +
+ +### 5. Adding a task to a wedding + +The `AddTaskCommand` allows users to add tasks to specific weddings. This helps wedding planners track what needs to be done for each wedding event. + +#### Implementation Details #### + +The `AddTaskCommand` extends the base `Command` class. It uses prefixes such as `w/` and `desc/` to specify the wedding ID and task description. It implements: + +* `execute(Model)` — Finds the wedding using `model.getFilteredWeddingList()` and a predicate. +* `addTask(task)` — Adds the new task to the wedding's task list. + +Given below is an example usage scenario: + +Step 1. The user executes addTask `w/W1 desc/Book photographer` to add a new task to wedding W1. + +Step 2. The `AddTaskCommand` finds wedding W1 and creates a new `WeddingTask` with the description. + +Step 3. The command adds this task to the wedding's task list. + +#### Sequence Diagram +
+ +#### Design considerations: + +**Aspect: Where tasks are stored:** + +**Alternative 1 (current choice):** Store tasks directly in the Wedding object. + +* Pros: Simplifies implementation and maintains clear ownership. +* Cons: Limited flexibility in sharing tasks across weddings. + +Alternative 2: Store tasks separately with references to weddings. + +* Pros: More flexible for potential future features like shared tasks. +* Cons: More complex data management. + +
+ +### 6. Deleting a task from a wedding + +The `DeleteTaskCommand` allows users to remove tasks from weddings. This is useful for removing completed tasks or tasks that are no longer relevant. + +#### Implementation Details #### + +The `DeleteTaskCommand` extends the base `Command` class. It uses prefixes `w/` for weddingID and `i/` for the task index. It implements: + +* `execute(Model)` — Finds the wedding and validates the task index. +* `removeTask(index)` — Removes the task at the specified index from the wedding's task list. + +Given below is an example usage scenario: + +Step 1. The user executes `deleteTask w/W1 i/2` to delete the second task from wedding W1. + +Step 2. The `DeleteTaskCommand` finds wedding W1 and removes the task at index 2 from its task list. + +#### Sequence Diagram +
+ +#### Design considerations: + +**Aspect: How task indices are handled:** + +**Alternative 1 (current choice):** Use 1-based indexing for users, converting to 0-based for internal operations. + +* Pros: More intuitive for users who typically count from 1. +* Cons: Requires index conversion in command execution. + +Alternative 2: Use 0-based indexing throughout the system. + +* Pros: Consistent with internal array indexing. +* Cons: Less intuitive for non-technical users. + +
+ +--- ### \[Proposed\] Undo/redo feature @@ -161,9 +469,9 @@ This section describes some noteworthy details on how certain features are imple The proposed undo/redo mechanism is facilitated by `VersionedAddressBook`. It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`. Additionally, it implements the following operations: -* `VersionedAddressBook#commit()` — Saves the current address book state in its history. -* `VersionedAddressBook#undo()` — Restores the previous address book state from its history. -* `VersionedAddressBook#redo()` — Restores a previously undone address book state from its history. +- `VersionedAddressBook#commit()` — Saves the current address book state in its history. +- `VersionedAddressBook#undo()` — Restores the previous address book state from its history. +- `VersionedAddressBook#redo()` — Restores a previously undone address book state from its history. These operations are exposed in the `Model` interface as `Model#commitAddressBook()`, `Model#undoAddressBook()` and `Model#redoAddressBook()` respectively. @@ -171,90 +479,93 @@ Given below is an example usage scenario and how the undo/redo mechanism behaves 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. - +
: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`.
+
-
+**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.
-
+: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
+
+
+**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 an undo operation goes through the `Logic` component:
-
+: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.
+
-
+**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.
+
+
Similarly, how an undo operation goes through the `Model` component is shown below:
-
+: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.
+
-
+**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.
-
+
+--------------------------------------------------------------------------------------------------------------------- -## **Documentation, logging, testing, configuration, dev-ops** +## **Documentation, Logging, Testing, Configuration, Dev-Ops** -* [Documentation guide](Documentation.md) -* [Testing guide](Testing.md) -* [Logging guide](Logging.md) -* [Configuration guide](Configuration.md) -* [DevOps guide](DevOps.md) +- [Documentation guide](Documentation.md) +- [Testing guide](Testing.md) +- [Logging guide](Logging.md) +- [Configuration guide](Configuration.md) +- [DevOps guide](DevOps.md) --------------------------------------------------------------------------------------------------------------------- +--- ## **Appendix: Requirements** @@ -262,82 +573,430 @@ _{Explain here how the data archiving feature will be implemented}_ **Target user profile**: -* has a need to manage a significant number of contacts -* prefer desktop apps over other types -* can type fast -* prefers typing to mouse interactions -* is reasonably comfortable using CLI apps - -**Value proposition**: manage contacts faster than a typical mouse/GUI driven app +- has a need to manage a significant number of contacts and weddings +- freelance wedding planners who need to manage contacts for multiple weddings +- wishes to centralise the management of contacts and weddings into one spot +- can type fast +- prefers typing to mouse interactions +- is reasonably comfortable using CLI apps +**Value proposition**: manage contacts and weddings faster than a typical mouse/GUI driven app ### User stories Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*` -| Priority | As a … | I want to … | So that I can… | -| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- | -| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App | -| `* * *` | user | add a new 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 | - -*{More to be added}* +| Priority | As a … | I want to … | So that I can… | +| -------- | ------- | --------------------------------------------------------------- | -------------------------------------------------------------- | +| `* * *` | user | add a client/vendor with their details | keep track of my contacts | +| `* * *` | user | delete a client/vendor's record | remove outdated or irrelevant clients/vendors | +| `* * *` | user | retrieve a client/vendor's record | view the details of my clients/vendors | +| `* * *` | user | update a client/vendor's detail | have the most updated information for my contacts | +| `* * *` | user | search for a client/vendor by name or wedding date | quickly find the relevant personnel for a wedding | +| `* * *` | user | add a wedding event with its details | keep track of the weddings that I am handling | +| `* * *` | user | view a list of wedding event with its details | view the details of the wedding | +| `* * *` | user | view a list of wedding events sorted in ascending order by date | have a clear picture of the upcoming weddings | +| `* * *` | user | delete a wedding event | remove outdated or irrelevant weddings | +| `* * *` | user | edit a wedding event | update the details of the wedding with the correct information | +| `* * *` | user | add a task to a wedding event | keep track of the tasks that need to be done for the wedding | +| `* * *` | user | delete a task from a wedding event | remove outdated or irrelevant tasks | +| `* * *` | user | tag vendors to specific weddings | know which vendors are handling which events | +| `* *` | user | view a summary of all my tasks related to a wedding | have a clear picture of what needs to be done | +| `* *` | user | filter according to roles / event | have a clear picture of who I need to liaise with for | +| `*` | user | mark and unmark my tasks related to a wedding | know which are the tasks that I have yet to complete | +| `*` | user | have a confirmation message before I add very similar contacts | avoid accidentally adding duplicate contacts | ### Use cases -(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise) +(For all use cases below, the **System** is `EasyWeds` and the **Actor** is the `User`, unless specified otherwise) -**Use case: Delete a person** +**Use case: UC01 - Add a Contact** **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 inputs the command to add contact +2. EasyWeds adds the new contact Use case ends. **Extensions** -* 2a. The list is empty. +- 2a. The field(s) is/are empty. + + - 2a1. An error message is shown. + + Use case ends. + +- 2b. The name of the new contact matches an existing contact in the list. + + - 2b1. An error message is shown. + + - 2b2. User has to confirm whether to add this duplicate contact. + + Use case ends. + +**Use case: UC02 - List Contacts** + +**MSS** + +1. User inputs the command to list contacts +2. EasyWeds shows the list of contacts + + Use case ends. + +**Extensions** + +- 2a. There are no contacts to show. Use case ends. -* 3a. The given index is invalid. +**Use case: UC03 - Delete a Contact** + +**MSS** + +1. User requests to list contacts (UC02) +2. EasyWeds shows a list of contacts +3. User requests to delete a specific contact +4. EasyWeds deletes the contact + + Use case ends. + +**Extensions** + +- 3a. The contact does not exist in the list. + + - 3a1. An error message is shown. + + Use case resumes at step 2. + +**Use case: UC04 - Edit a Contact** + +**MSS** + +1. User requests to list contacts (UC02) +2. EasyWeds shows a list of contacts +3. User requests to edit a specific contact in the list +4. EasyWeds edits the contact + + Use case ends. + +**Extensions** + +- 3a. The contact does not exist in the list. + + - 3a1. An error message is shown. - * 3a1. AddressBook shows an error message. + Use case resumes at step 2. - Use case resumes at step 2. +- 3b. The edited name is a duplicate of an existing name in the list. -*{More to be added}* + - 3b1. An error message is shown. + + Use case resumes at step 2. + +**Use case: UC05 - Search Contacts by Name** + +**MSS** + +1. User requests search for contacts that have a certain 'keyword' in their name +2. EasyWeds shows a list of contacts that matches the 'keyword' + + Use case ends. + +**Extensions** + +- 2a. No matching contact is found. + + - 2a1. An error message is shown. + + Use case ends. + +**Use case: UC06 - Search Contacts by Role** + +**MSS** + +1. User requests search for contacts that have a certain 'keyword' in their role +2. EasyWeds shows a list of contacts that matches the 'keyword' + + Use case ends. + +**Extensions** + +- 2a. No matching contact is found. + + - 2a1. An error message is shown. + + Use case ends. + +**Use case: UC07 - Add a Wedding Event** + +**MSS** + +1. User inputs the command to add wedding +2. EasyWeds adds the new wedding + + Use case ends. + +**Extensions** + +- 2a. The field(s) is/are empty. + + - 2a1. An error message is shown. + + Use case ends. + +- 2b. All the fields in the input match an existing wedding event in the list. + + - 2b1. An error message is shown. + + Use case ends. + +**Use case: UC08 - View Wedding Events by Wedding Date** + +**MSS** + +1. User inputs the command to list wedding events sorted from earliest to latest date +2. EasyWeds shows the list of wedding events + + Use case ends. + +**Extensions** + +- 2a. There are no wedding events to show. + + Use case ends. + +**Use case: UC09 - View Wedding Events by Wedding ID** + +**MSS** + +1. User inputs the command to list wedding events sorted by wedding ID +2. EasyWeds shows the list of wedding events + + Use case ends. + +**Extensions** + +- 2a. There are no wedding events to show. + + Use case ends. + +**Use case: UC10 - Delete a Wedding Event** + +**MSS** + +1. User requests to list wedding events (UC08) +2. EasyWeds shows a list of wedding events +3. User requests to delete a specific wedding event +4. EasyWeds deletes the wedding event + + Use case ends. + +**Extensions** + +- 3a. The wedding event does not exist in the list. + + - 3a1. An error message is shown. + + Use case resumes at step 2. + +**Use case: UC11 - Edit a Wedding Event** + +**MSS** + +1. User requests to list wedding events (UC08) +2. EasyWeds shows a list of wedding events +3. User requests to edit a specific wedding event in the list +4. EasyWeds edits the wedding event + + Use case ends. + +**Extensions** + +- 3a. The wedding event does not exist in the list. + + - 3a1. An error message is shown. + + Use case resumes at step 2. + +- 3b. The edited wedding name, date and location is a duplicate of an existing wedding event in the list. + + - 3b1. An error message is shown. + + Use case resumes at step 2. + +**Use case: UC12 - Tag Contacts to Wedding Events** + +**MSS** + +1. User inputs the command to tag a contact to a wedding event +2. EasyWeds adds the tag for the wedding event to the contact specified + + Use case ends. + +**Extensions** + +- 2a. The contact does not exist. + + - 2a1. An error message is shown. + + Use case ends. + +- 2b. The wedding does not exist. + + - 2b1. An error message is shown. + + Use case ends. + +**Use case: UC13 - Untag Contact from Wedding Event** + +**MSS** + +1. User inputs the command to untag a contact from a wedding event +2. EasyWeds removes the tag for the wedding event from the contact specified + + Use case ends. + +**Extensions** + +- 2a. The contact does not exist. + + - 2a1. An error message is shown. + + Use case ends + +- 2b. The wedding does not exist. + + - 2b1. An error message is shown. + + Use case ends. + +- 2c. The wedding specified is not tagged to this contact. + + - 2c1. An error message is shown. + + Use case ends. + +**Use case: UC14 - Filter Contacts** + +**MSS** + +1. User requests filtering contacts that are tagged to a certain wedding event +2. EasyWeds shows a list of contacts that contain the tag + + Use case ends. + +**Extensions** + +- 2a. The wedding does not exist. + + - 2a1. An error message is shown. + + Use case ends. + +- 2b. There are no contacts tagged to the wedding. + + - 2b1. An error message is shown. + + Use case ends. + +**Use case: UC15 - Add a Task to a Wedding** + +**MSS** + +1. User inputs the command to add a task to a specific wedding +2. EasyWeds adds the task to the wedding + + Use case ends. + +**Extensions** + +- 2a. The wedding does not exist. + + - 2a1. An error message is shown. + + Use case ends. + +**Use case: UC16 - Delete a Task from a Wedding** + +**MSS** + +1. User inputs the command to delete a task from a specific wedding +2. EasyWeds deletes the task from the wedding + + Use case ends. + +**Extensions** + +- 2a. The wedding does not exist. + + - 2a1. An error message is shown. + + Use case ends. + +- 2b. The task index is invalid. + + - 2b1. An error message is shown. + + Use case ends. + +**Use case: UC17 - Clear Contact Book** + +**MSS** + +1. User inputs the command to clear the contact book +2. EasyWeds asks for confirmation +3. User confirms the action +4. EasyWeds clears all contacts + + Use case ends. + +**Extensions** + +- 2a. The contact book is already empty. + + - 2a1. EasyWeds clears the contact book without asking for confirmation. + + Use case ends. + +- 3a. User does not confirm the action. + + - 3a1. The clear operation is cancelled. + + Use case ends. ### Non-Functional Requirements 1. Should work on any _mainstream OS_ as long as it has Java `17` 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. - -*{More to be added}* +4. The system should respond to user commands within 2 seconds, even under peak load conditions. +5. The application should handle errors gracefully, providing clear and helpful error messages. +6. Adhere to a consistent coding style with comprehensive inline documentation and JavaDocs. +7. User interface should be intuitive and accessible +8. Candidate data should be stored securely, ensuring unauthorized users cannot access sensitive information. +9. Data should not be lost between each session and be persistently stored. ### Glossary -* **Mainstream OS**: Windows, Linux, Unix, MacOS -* **Private contact detail**: A contact detail that is not meant to be shared with others +- **Mainstream OS**: Windows, Linux, Unix, MacOS +- **MSS**: Main Success Scenario which describes the most straightforward interaction for a given use case, which assumes nothing goes wrong +- **JSON**: JavaScript Object Notation, a lightweight data-interchange format +- **Client**: A person who hires a wedding planner to organise their wedding. Clients in EasyWeds are individuals or couples whose event details are tracked within the system +- **Vendor**: A service provider involved in the wedding, such as florists, caterers, photographers. Vendors in EasyWeds are linked to events and are categorised based on their service types --------------------------------------------------------------------------------------------------------------------- +--- ## **Appendix: Instructions for manual testing** Given below are instructions to test the app manually. -
:information_source: **Note:** These instructions only provide a starting point for testers to work on;
-testers are expected to do more *exploratory* testing.
+
-
+**Note:** These instructions only provide a starting point for testers to work on;
+testers are expected to do more _exploratory_ testing.
+
+
### Launch and shutdown
@@ -352,9 +1011,8 @@ testers are expected to do more *exploratory* testing.
1. Resize the window to an optimum size. Move the window to a different location. Close the window.
1. Re-launch the app by double-clicking the jar file.- Expected: The most recent window size and location is retained. + Expected: The most recent window size and location is retained. -1. _{ more test cases … }_ ### Deleting a person @@ -371,12 +1029,127 @@ testers are expected to do more *exploratory* testing. 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
Expected: Similar to previous. -1. _{ more test cases … }_ +1. _{ This is a non-exhaustive list }_ ### Saving data 1. Dealing with missing/corrupted data files - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ + 1. Close the app. Delete the file named `addressbook.json` in the same folder as the jar file. + + 1. Re-launch the app by double-clicking the jar file.
+ Expected: The app starts with an empty address book. The status message shows that the data file is missing or corrupted. + + 1. Close the app. Replace the file named `addressbook.json` with a new file containing the string `invalid data`. + + 1. Re-launch the app by double-clicking the jar file.
+ Expected: The app starts with an empty address book. The status message shows that the data file is missing or corrupted. + +## **Appendix: Effort** + +### Project Scope and Difficulty +This project was much more tedious than the Address Book (AB3) reference project. +While AB3 deals exclusively with one entity type (Persons), our project, EasyWeds, expands its scope by incorporating multiple entities, Weddings and tasks, and establishing links between them. +This broader scope required a more robust data model and detailed planning for application logic, especially for actions that involve managing interdependencies. + +**Key challenges included:** + +- **Entity Linking:** Establish reliable relationships between contacts, weddings, and tasks. +- **Testing and Coverage:** Ensuring such a complex system is thoroughly tested. +- **Communication:** Coordinating clear communications among team members with differing perspectives, methodologies, and schedules. + +**Effort Involved:** + +Overall, this project required roughly 2 times the effort of AB3, primarily due to the additional complexity and volume of content implemented. + +- **Enhanced Wedding Management System ★★★** + - Complete redesign of the underlying data model to support multiple wedding events with various associated data points. + - Created new data models for Wedding, WeddingTask, and associated classes. + - Implemented a unique ID system for weddings to ensure consistent referencing. + - Developed validation logic for wedding dates to ensure they are valid and in the future. + - Designed and implemented a tagging system to associate contacts with specific weddings. + - Added specialized commands for wedding management (addWedding, editWedding, deleteWedding). + + +- **Task Management System ★★** + - Designed a task model that supports descriptions and completion status. + - Integrated tasks directly into the wedding model for natural organization. + - Created specialized commands for task operations (addTask, listTask, mark, unmark, deleteTask). + - Implemented validation to ensure tasks are associated with valid weddings. + + +- **Enhanced Contact Management ★★★** + - Extended the Person model to include role information essential for wedding planning. + - Implemented a robust tagging system to associate contacts with multiple weddings. + - Created specialized filtering mechanisms to view contacts by wedding or role. + - Improved the contact display to show relevant wedding associations. + + +- **UI Enhancements ★★** + - Created a split-panel design to show both weddings and contacts simultaneously. + - Implemented a detailed view for wedding tasks and related information. + - Added visual indicators for tagged relationships between contacts and weddings. + - Designed a comprehensive output display for command results. + + +- **Storage Component Expansion ★★** + - Extended the JSON storage format to include wedding and task data. + - Implemented bidirectional references for weddings and contacts. + - Ensured data integrity during save/load operations. + - Added validation to handle potential data corruption scenarios. + + +- **Comprehensive Testing ★★★** + - Created extensive integration tests for wedding-contact relationships. + - Developed unit tests for all new commands and features. + - Conducted manual testing sessions for complex workflows. + - Implemented edge case testing for data validation. + + +**Accomplishments:** + +Despite the challenges, our team successfully: +- Implemented a robust data model that effectively manages the relationships between contacts, weddings, and tasks. +- Developed a comprehensive set of commands that allow users to interact with the system in a meaningful way. +- Ensured that the application is thoroughly tested, with a high level of code coverage. +- Added significant new functionality, including the ability to add, delete, and edit contacts, weddings, and tasks, and tag people to different weddings. + +**Library Usage and Reuse:** +Critical libraries played a key role in streamlining our work: +- **JUnit 5:** Extensively used for unit testing, improving code quality and reducing testing time by an estimated 15-20% compared to writing tests from scratch. +- **JavaFX:** Employed to build the Graphical User Interface (GUI), significantly accelerating the implementation process. + +## **Appendix: Planned Enhancements** +Team size: 5 + +The following planned enhancements target future improvements for EasyWeds. Each enhancement describes a feature gap in the current system and outlines the proposed solution along with the expected benefits. This section lists enhancements that focus on advancing wedding task management and overall user experience. + +### 1. Integrate Task Deadlines +- **Feature Gap**: Wedding tasks currently lack deadline functionality, which limits the ability to prioritize and track upcoming work. +- **Proposed Fix**: Add deadlines to each wedding task, enabling users to assign due dates and times. +- **Expected Outcome**: Improved task management with clear deadlines, leading to better prioritization and timely completion of tasks. + +### 2. Advanced Task Filtering and Sorting by Deadline +- **Feature Gap**: Users are currently unable to quickly identify urgent tasks since the task list lacks filtering and sorting by deadline. +- **Proposed Fix**: Enhance the task management interface to include options for filtering and sorting wedding tasks based on their assigned deadlines. +- **Expected Outcome**: Faster identification of high-priority tasks and improved workflow through better visual organization. + +### 3. Support for Non-Latin Characters in Names +- **Feature Gap**: Currently, only alphanumeric Latin characters are allowed for the name field, which may exclude users whose names include non-Latin characters (e.g.,Chinese, Arabic). +- **Proposed Fix**: Revise the validation rules for the name field to accept non-Latin characters while maintaining data integrity. This could involve updating the regex patterns and ensuring compatibility with the rest of the system. +- **Expected Outcome**: Increased inclusivity and usability for international users, allowing a more diverse range of names to be stored accurately within EasyWeds. + +### 4. Expanded Search Capabilities +- **Feature Gap**: The current search functionality only supports exact keyword matching, which may lead to difficulties when users mistype names or use abbreviations. +- **Proposed Fix**: Implement a fuzzy search algorithm and support for partial matches, so that slight misspellings or incomplete queries still return relevant results. +- **Expected Outcome**: Users will experience more forgiving and intuitive search behavior, making it easier to locate contacts and events even with minor input errors. + +### 5. Batch Tag/Untag Contacts +- **Feature Gap**: Currently, users must tag or untag contacts to weddings one by one. For large weddings with many vendors and clients, this process is time-consuming and inefficient. +- **Proposed Fix**: Implement a batch tagging system that allows users to select multiple contacts and tag or untag them to a wedding in a single command. +- **Expected Outcome**: Wedding planners will experience a significant reduction in administrative overhead, leading to a more efficient workflow when managing contacts for large events. -1. _{ more test cases … }_ +### 6. Better Wedding ID handling after deletion +- **Feature Gap**: When a wedding is deleted, its ID is not reused, which results in non-sequential wedding IDs (e.g., W1, W3, W4). This inconsistency can confuse users and wastes available identifiers. +- **Proposed Fix**: Implement proper wedding ID management that either reuses IDs from deleted weddings for new entries, or provides an optional command to renumber/reindex all wedding IDs sequentially.\ +- **Expected Outcome**: Wedding IDs will be managed more effectively, eliminating gaps and providing users with a clear and organized identifier sequence for all weddings. diff --git a/docs/Documentation.md b/docs/Documentation.md index 3e68ea364e7..082e652d947 100644 --- a/docs/Documentation.md +++ b/docs/Documentation.md @@ -1,29 +1,21 @@ --- -layout: page -title: Documentation guide + layout: default.md + title: "Documentation guide" + pageNav: 3 --- -**Setting up and maintaining the project website:** - -* We use [**Jekyll**](https://jekyllrb.com/) to manage documentation. -* The `docs/` folder is used for documentation. -* To learn how set it up and maintain the project website, follow the guide [_[se-edu/guides] **Using Jekyll for project documentation**_](https://se-education.org/guides/tutorials/jekyll.html). -* Note these points when adapting the documentation to a different project/product: - * The 'Site-wide settings' section of the page linked above has information on how to update site-wide elements such as the top navigation bar. - * :bulb: In addition to updating content files, you might have to update the config files `docs\_config.yml` and `docs\_sass\minima\_base.scss` (which contains a reference to `AB-3` that comes into play when converting documentation pages to PDF format). -* If you are using Intellij for editing documentation files, you can consider enabling 'soft wrapping' for `*.md` files, as explained in [_[se-edu/guides] **Intellij IDEA: Useful settings**_](https://se-education.org/guides/tutorials/intellijUsefulSettings.html#enabling-soft-wrapping) +# Documentation Guide +* We use [**MarkBind**](https://markbind.org/) to manage documentation. +* The `docs/` folder contains the source files for the documentation website. +* To learn how set it up and maintain the project website, follow the guide [[se-edu/guides] Working with Forked MarkBind sites](https://se-education.org/guides/tutorials/markbind-forked-sites.html) for project documentation. **Style guidance:** * 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:** - -* See the [_[se-edu/guides] **Using PlantUML**_](https://se-education.org/guides/tutorials/plantUml.html) -**Converting a document to the PDF format:** +**Converting to PDF** -* See the guide [_[se-edu/guides] **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html) +* See the guide [_se-edu/guides **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html). diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index c8385d85874..00000000000 --- a/docs/Gemfile +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -source "https://rubygems.org" - -git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } - -gem 'jekyll' -gem 'github-pages', group: :jekyll_plugins -gem 'wdm', '~> 0.1.0' if Gem.win_platform? -gem 'webrick' diff --git a/docs/Logging.md b/docs/Logging.md index 5e4fb9bc217..589644ad5c6 100644 --- a/docs/Logging.md +++ b/docs/Logging.md @@ -1,8 +1,10 @@ --- -layout: page -title: Logging guide + layout: default.md + title: "Logging guide" --- +# 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. diff --git a/docs/SettingUp.md b/docs/SettingUp.md index aef33ec72fd..5e8b9d11991 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -1,27 +1,33 @@ --- -layout: page -title: Setting up and getting started + layout: default.md + title: "Setting up and getting started" + pageNav: 3 --- -* Table of Contents -{:toc} +# Setting up and getting started + +
:exclamation: **Caution:**
+
+**Caution:**
Follow the steps in the following guide precisely. Things will not work out if you deviate in some steps.
-
+
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 ensure Intellij is configured to use **JDK 17**.
-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. **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. +
:bulb: **Tip:**
+
+ **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.
-
+
1. **Set up CI**
diff --git a/docs/Testing.md b/docs/Testing.md
index 8a99e82438a..78ddc57e670 100644
--- a/docs/Testing.md
+++ b/docs/Testing.md
@@ -1,12 +1,15 @@
---
-layout: page
-title: Testing guide
+ layout: default.md
+ title: "Testing guide"
+ pageNav: 3
---
-* Table of Contents
-{:toc}
+# Testing guide
---------------------------------------------------------------------------------------------------------------------
+
+: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.
-
++ +## About EasyWeds + +EasyWeds is a **desktop app designed for freelance wedding planners juggling multiple weddings**. You can use EasyWeds to streamline planning by centralising vendor and client information and keeping every wedding detail organised. If you are adept at typing, EasyWeds empowers you to access and update your planning data swiftly. + +Here are EasyWeds' main features: +#### Enhanced Contact Management +
+ Choose the installation package depending on your device: [Mac](https://se-education.org/guides/tutorials/javaInstallationMac.html), [Windows](https://se-education.org/guides/tutorials/javaInstallationWindows.html) or [Linux](https://se-education.org/guides/tutorials/javaInstallationLinux.html) + +
+ +  + +6. 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: -* Table of Contents -{:toc} + * `list`: Lists all persons and wedding events. --------------------------------------------------------------------------------------------------------------------- + * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 r/Photographer`: Adds a contact named `John Doe` to the contact book in EasyWeds. -## Quick start + * `delete 3`: Deletes the 3rd contact shown in the current list. -1. Ensure you have Java `17` or above installed in your Computer.
- **Mac users:** Ensure you have the precise JDK version prescribed [here](https://se-education.org/guides/tutorials/javaInstallationMac.html). + * `clear`: Deletes entire contact book (both persons and wedding events). -1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases). + * `exit`: Exits the app. -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. +7. Refer to the [Features](#features) below for details of each command. -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.
-  +
- Some example commands you can try: +**Tip:** Refer to [FAQ](#faq) for help on setting up. +
- * `delete 3` : Deletes the 3rd contact shown in the current list. +## Layout +When you launch EasyWeds, EasyWeds appears on your screen as a Graphical User Interface, or GUI. Let’s look at the layout of the different components of EasyWeds. - * `clear` : Deletes all contacts. +EasyWed’s GUI consists of a single main window, as well as the Help Window. The main window consists of four components: - * `exit` : Exits the app. +1. Command Input +1. Output Box +1. List of Persons +1. List of Weddings -1. Refer to the [Features](#features) below for details of each command. --------------------------------------------------------------------------------------------------------------------- +The following picture of the main window shows the four components, numbered accordingly: + + + +Besides the main window, EasyWeds also has the Help Window. It is not part of the main GUI and is only shown after a [Help Command](#viewing-help-help) is run. + + ## Features -
+
+
+**Notes about the command format:**
-**:information_source: Notes about the command format:**
+* Press 'TAB' to auto-complete the command you are typing in the command box.
+ e.g. if you type `ad` and press 'TAB', it will auto-complete to `add` and if you press it again it will auto-complete to `addWedding` and if you press it again it will auto-complete to `addTask`. * 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`. * 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`. - -* 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. + e.g `edit 1 n/NAME [r/ROLE]` can be used as `edit 1 n/John Doe r/Florist` or as `edit 1 n/John Doe`. * 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. @@ -62,139 +174,753 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo e.g. if the command specifies `help 123`, it will be interpreted as `help`. * 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. -
+
+
+--- {.border-secondary}
+
+-**:information_source: Notes about the command format:**
+* Press 'TAB' to auto-complete the command you are typing in the command box.
+ e.g. if you type `ad` and press 'TAB', it will auto-complete to `add` and if you press it again it will auto-complete to `addWedding` and if you press it again it will auto-complete to `addTask`. * 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`. * 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`. - -* 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. + e.g `edit 1 n/NAME [r/ROLE]` can be used as `edit 1 n/John Doe r/Florist` or as `edit 1 n/John Doe`. * 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. @@ -62,139 +174,753 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo e.g. if the command specifies `help 123`, it will be interpreted as `help`. * 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. -
-### Viewing help : `help` +## Getting Help +
-Shows a message explaning how to access the help page. +### Viewing help: `help` - +Shows a message explaining how to access the help page. Format: `help` +
-### Adding a person: `add`
+:bulb: **Tip:**
-A person can have any number of tags (including 0)
-
+## Managing Contacts
++ +### Adding a Person: `add` + +Adds a person to the contact book. + +Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS r/ROLE` + +
-Shows a list of all persons in the address book. +``` +add n/Betsy Crowe r/Florist e/betsycrowe@example.com a/Blk 321 Clementi West St 1 p/12345678 +``` +This command adds a person named `Betsy Crowe` with the role `Florist`, email `betsycrowe@example.com`, address `Blk 321 Clementi West St 1`, and phone number `12345678`. +
-### Editing a person : `edit` +### Editing a Person: `edit` -Edits an existing person in the address book. +Edits an existing person in the contact book. -Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` +Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [r/ROLE]` + +
+ +``` +edit 2 n/Betsy Crower r/photographer +``` +This command edits the name and the role of the 2nd person to be `Betsy Crower` and `photographer` respectively. +
+ +``` +find Betsy +``` +``` +delete 1 +``` +This command deletes the 1st person in the results of the `find` command. +
-  +``` +find John +``` +This command returns `john` and `John Doe` -### Deleting a person : `delete` +
-Deletes the specified person from the address book. +``` +find florist +``` +This command returns all Persons with the role of `florist` -Format: `delete INDEX` +
-* 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, … +``` +find alex david +``` +This command returns `Alex Yeoh`, `David Li` (Refer to the image below) + +
+ + + +
+ +### Adding a Wedding Event: `addWedding` + +Adds a wedding event to the contact book. + +Format: `addWedding n/NAME d/DATE l/LOCATION` + +
+ +### Editing a Wedding Event: `editWedding` + +Edits an existing wedding event in the contact book. + +Format: `editWedding WEDDING_ID [n/NAME] [d/DATE] [l/LOCATION]` + +
+ +``` +editWedding W2 n/John & Jane's Wedding +``` +This command edits the name of the 2nd wedding event to be `John & Jane's Wedding`. +
+ + +
+ +### Sorting all Wedding Events by increasing Wedding ID: `sortWID` + +Shows a list of all wedding events in the contact book sorted by increasing Wedding ID. + +Format: `sortWID` + +
+ +### Sorting all Wedding Events by earliest Date: `sortWDate` + +Shows a list of all wedding events in the contact book sorted by date, from earliest to latest. + +Format: `sortWDate` + + + +## Managing Wedding Tasks +
+ +### Adding a Wedding Task: `addTask` + +Adds a new task to a specified wedding event. + +Format: `addTask w/WEDDING_ID desc/TASK_DESCRIPTION` + +
+ +### Listing all Wedding Tasks: `listTask` + +Shows a list of all tasks of a specified wedding event in the output box. + +Format: `listTask w/WEDDING_ID` + +
+ + +
+ +### Marking a Wedding Task: `mark` + +Marks a specified task of a specified wedding event as completed. + +Format: `mark w/WEDDING_ID i/TASK_INDEX` + +
+ + +
+ +### Unmarking a Wedding Task: `unmark` + +Marks a specified task of a specified wedding as not completed. + +Format: `unmark w/WEDDING_ID i/TASK_INDEX` + +
+ +### Deleting a Wedding Task: `deleteTask` + +Deletes the specified task from a specified wedding event. + +Format: `deleteTask w/WEDDING_ID i/TASK_INDEX` + +
+ +### Tagging a Person to a Wedding: `tag` + +Tags an existing contact to an existing wedding event. + +Format: `tag INDEX WEDDING_ID` + +
+ +``` +tag 1 W2 +``` +This command tags the first person to the wedding event `W2`. Now the first person will be tagged to both `W1` and `W2`. (Refer to the image below) + +
+ + +
+ +### Filtering Contacts: `filter` + +Filters contacts related to a specified wedding ID. + +Format: `filter WEDDING_ID` + +
+ + +
+ +### Listing all Persons and Wedding Events: `list` -### Clearing all entries : `clear` +Shows a list of all persons and weddings in the contact book. -Clears all entries from the address book. +Format: `list` + +
+ +### Clearing all entries: `clear` + +Clears all entries from the contact book. Format: `clear` -### Exiting the program : `exit` +
### Saving the data -AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +EasyWeds data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. + +
### Editing the data file -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. +EasyWeds 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. -
: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.
-Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. -
+-Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. -
+As much as you are able to manually edit the details of contacts and wedding events, you are strongly advised against editing the weddingIDs in the data file as this will very likely cause the application to behave in unexpected ways. + +If your changes to the data file make its format invalid, EasyWeds 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.
+ +Furthermore, certain edits can cause EasyWeds to behave in unexpected ways (e.g. if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. +
+ +## Exiting the program +
-### Archiving data files `[coming in v2.0]` +### Exiting the program: `exit` -_Details coming soon ..._ +Exits the program. + +Format: `exit` + +[Back to content page](#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 AddressBook home folder. +
+
+
+
+"What is considered as a duplicate name?"
+
+
+
+
+
+* If there is a Person with the name `Alex Yeoh` in the contacts (Refer to the image below), the following will be flagged out:
+ * `Alex Yeoh` (exactly the same)
+ * `alexyeoh` (no capitalization)
+ * `AlexYeoh` (extra spacing)
+ * `Alexyeoh` (combination of the 2)
+* In such a case, the potential duplicate is spotted and the User will need to confirm if he wants to add this Person or make a change to the input
+
+
+
+
+
+
+
+--- {.border-secondary}
+
+
+
+
+
+"How do I make a confirmation or cancellation of my previous command?"
+
+
+
+
+
+Once you receive the warning message, you can choose to either:
+1. Confirm - Use 'Ctrl / Command + A' to select the whole input text and press 'Delete / Backspace' to clear the input box. Afterwards, input the command `y` which will add this Person into the contact list.
+2. Cancel - Edit the current input in your input box. Once no duplicates are detected, when you press 'Enter', this Person will be added into the contact list.
+
+
+
+
+
+--- {.border-secondary}
---------------------------------------------------------------------------------------------------------------------
+## 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. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window. --------------------------------------------------------------------------------------------------------------------- + ## Command summary -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` +| Action | Format, Examples | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Add Person** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS r/ROLE…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 r/Photographer` | +| **Edit Person** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [r/ROLE]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` | +| **Delete Person** | `delete INDEX`
e.g., `delete 3` | +| **Find Person** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` | +| **Add Wedding** | `addWedding n/NAME d/DATE l/LOCATION`
e.g., `addWedding n/John and Jane's Wedding d/20-Feb-2026 l/Marina Bay Sands` | +| **Edit Wedding** | `editWedding WEDDING_ID [n/NAME] [d/DATE] [l/LOCATION]`
e.g., `editWedding W1 d/20-Feb-2026 l/Marina Bay Sands` | +| **Delete Wedding** | `deleteWedding WEDDING_ID`
e.g., `deleteWedding W1` | +| **Sort Wedding List by Id** | `sortWID` | +| **Sort Wedding List by Date** | `sortWDate` | +| **Add Task to a Wedding** | `addTask w/WEDDING_ID desc/TASK_DESCRIPTION`
e.g., `addTask w/W1 desc/Book florist` | +| **List Tasks of a Wedding** | `listTask w/WEDDING_ID`
e.g., `listTask w/W1` | +| **Mark Task as Complete** | `mark w/WEDDING_ID i/TASK_INDEX`
e.g., `mark w/W1 i/1` | +| **Mark Task as Incomplete** | `unmark w/WEDDING_ID i/TASK_INDEX`
e.g., `unmark w/W1 i/1` | +| **Delete Task in a Wedding** | `deleteTask w/WEDDING_ID i/TASK_INDEX`
e.g., `deleteTask w/W1 i/1` | +| **Tag Wedding to a Person** | `tag INDEX WEDDING_ID`
e.g., `tag 1 W1` | +| **Untag Person from a Wedding** | `untag INDEX WEDDING_ID`
e.g., `untag 1 W1` | +| **Filter Details of a Wedding** | `filter WEDDING_ID`
e.g., `filter W4` | +| **List All Contacts & Weddings** | `list` | +| **Clear All Content** | `clear` | +| **Exit EasyWeds** | `exit` | | diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 6bd245d8f4e..00000000000 --- a/docs/_config.yml +++ /dev/null @@ -1,15 +0,0 @@ -title: "AB-3" -theme: minima - -header_pages: - - UserGuide.md - - DeveloperGuide.md - - AboutUs.md - -markdown: kramdown - -repository: "se-edu/addressbook-level3" -github_icon: "images/github-icon.png" - -plugins: - - jemoji diff --git a/docs/_data/projects.yml b/docs/_data/projects.yml deleted file mode 100644 index 8f3e50cb601..00000000000 --- a/docs/_data/projects.yml +++ /dev/null @@ -1,23 +0,0 @@ -- name: "AB-1" - url: https://se-edu.github.io/addressbook-level1 - -- name: "AB-2" - url: https://se-edu.github.io/addressbook-level2 - -- name: "AB-3" - url: https://se-edu.github.io/addressbook-level3 - -- name: "AB-4" - url: https://se-edu.github.io/addressbook-level4 - -- name: "Duke" - url: https://se-edu.github.io/duke - -- name: "Collate" - url: https://se-edu.github.io/collate - -- name: "Book" - url: https://se-edu.github.io/se-book - -- name: "Resources" - url: https://se-edu.github.io/resources diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html deleted file mode 100644 index 8559a67ffad..00000000000 --- a/docs/_includes/custom-head.html +++ /dev/null @@ -1,6 +0,0 @@ -{% comment %} - 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. -{% endcomment %} diff --git a/docs/_includes/head.html b/docs/_includes/head.html deleted file mode 100644 index 83ac5326933..00000000000 --- a/docs/_includes/head.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - {%- 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 }}
-
- {%- if titles_size > 0 -%}
-
- {%- endif -%}
-
-{{ page.title | escape }}
-
- {{ content }}
-
-
-
+
+
+
+
diff --git a/docs/_markbind/variables.json b/docs/_markbind/variables.json
new file mode 100644
index 00000000000..9d89eb0358b
--- /dev/null
+++ b/docs/_markbind/variables.json
@@ -0,0 +1,3 @@
+{
+ "jsonVariableExample": "Your variables can be defined here as well"
+}
diff --git a/docs/_markbind/variables.md b/docs/_markbind/variables.md
new file mode 100644
index 00000000000..89ae5318fa4
--- /dev/null
+++ b/docs/_markbind/variables.md
@@ -0,0 +1,4 @@
+
+ {{ content }}
+
+
+ This method first checks if the person already exists in the address book. + * If a duplicate is detected and this is not a force add, it returns a {@code CommandResult} + * containing a duplicate warning message along with a flag indicating that confirmation is required. + * The UI should then prompt the user and, upon confirmation, re-execute this command in force mode.
+ * + * @param model {@code Model} which the command should operate on. + * @return the result of command execution. + * @throws CommandException if an error occurs during execution. + */ @Override public CommandResult execute(Model model) throws CommandException { requireNonNull(model); - if (model.hasPerson(toAdd)) { - throw new CommandException(MESSAGE_DUPLICATE_PERSON); + if (!isForced && model.hasPerson(toAdd)) { + // In normal mode, if a duplicate exists, store this command and signal confirmation required. + ConfirmationManager.getInstance().setPendingCommand(this); + return new CommandResult(MESSAGE_DUPLICATE_PERSON, false, false, true); } - model.addPerson(toAdd); + if (isForced) { + // Force mode: bypass duplicate check. + model.forceAddPerson(toAdd); + } else { + // Normal mode: add person normally. + model.addPerson(toAdd); + } return new CommandResult(String.format(MESSAGE_SUCCESS, Messages.format(toAdd))); } + @Override + public ForceableCommand createForceCommand() { + return new AddCommand(toAdd, true); + } + @Override public boolean equals(Object other) { if (other == this) { @@ -72,13 +115,14 @@ public boolean equals(Object other) { } AddCommand otherAddCommand = (AddCommand) other; - return toAdd.equals(otherAddCommand.toAdd); + return toAdd.equals(otherAddCommand.toAdd) && isForced == otherAddCommand.isForced; } @Override public String toString() { return new ToStringBuilder(this) .add("toAdd", toAdd) + .add("isForced", isForced) .toString(); } } diff --git a/src/main/java/seedu/address/logic/commands/AddTaskCommand.java b/src/main/java/seedu/address/logic/commands/AddTaskCommand.java new file mode 100644 index 00000000000..22080a1f59a --- /dev/null +++ b/src/main/java/seedu/address/logic/commands/AddTaskCommand.java @@ -0,0 +1,65 @@ +package seedu.address.logic.commands; + +import static java.util.Objects.requireNonNull; + +import seedu.address.logic.Messages; +import seedu.address.logic.commands.exceptions.CommandException; +import seedu.address.model.Model; +import seedu.address.model.wedding.Wedding; +import seedu.address.model.wedding.WeddingId; +import seedu.address.model.wedding.WeddingTask; + +/** + * Adds a new task to a specific wedding identified by a Wedding ID. + */ +public class AddTaskCommand extends Command { + + public static final String COMMAND_WORD = "addTask"; + + public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a task to a specified wedding.\n" + + "Parameters: w/WEDDING_ID desc/TASK_DESCRIPTION\n" + + "Example: " + COMMAND_WORD + " w/W1 desc/Book photographer"; + + public static final String MESSAGE_SUCCESS = "New task added to wedding %1$s:\n%2$s"; + public static final String MESSAGE_INVALID_FORMAT = "Invalid command format. " + MESSAGE_USAGE; + + private final WeddingId weddingId; + private final String taskDescription; + + /** + * Creates an AddTaskCommand to add a task with the specified description to the specified wedding ID. + */ + public AddTaskCommand(WeddingId weddingId, String taskDescription) { + requireNonNull(weddingId); + requireNonNull(taskDescription); + this.weddingId = weddingId; + this.taskDescription = taskDescription; + } + + @Override + public CommandResult execute(Model model) throws CommandException { + requireNonNull(model); + + Wedding wedding = model.getFilteredWeddingList().stream() + .filter(w -> w.getWeddingId().equals(weddingId)) + .findFirst() + .orElseThrow(() -> new CommandException(String.format(Messages.MESSAGE_WEDDING_NOT_FOUND, + weddingId.value))); + + WeddingTask newTask = new WeddingTask(taskDescription); + wedding.addTask(newTask); + return new CommandResult(String.format(MESSAGE_SUCCESS, weddingId.value, newTask), false, false, false, true); + } + + @Override + public boolean equals(Object other) { + if (other == this) { + return true; + } + if (!(other instanceof AddTaskCommand)) { + return false; + } + AddTaskCommand c = (AddTaskCommand) other; + return weddingId.equals(c.weddingId) && taskDescription.equals(c.taskDescription); + } +} diff --git a/src/main/java/seedu/address/logic/commands/AddWeddingCommand.java b/src/main/java/seedu/address/logic/commands/AddWeddingCommand.java new file mode 100644 index 00000000000..762f127783f --- /dev/null +++ b/src/main/java/seedu/address/logic/commands/AddWeddingCommand.java @@ -0,0 +1,53 @@ +package seedu.address.logic.commands; + +import static java.util.Objects.requireNonNull; + +import seedu.address.logic.commands.exceptions.CommandException; +import seedu.address.model.Model; +import seedu.address.model.wedding.Wedding; + +/** + * Adds a Wedding event to the contact book. + */ +public class AddWeddingCommand extends Command { + + public static final String COMMAND_WORD = "addWedding"; + + public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a wedding to the contact book. " + + "Parameters: " + + "n/NAME d/DATE l/LOCATION\n" + + "Example: " + COMMAND_WORD + " n/John & Jane's Wedding d/20-Feb-2026 l/Grand Ballroom"; + + public static final String MESSAGE_SUCCESS = "New wedding added: %1$s"; + + public static final String MESSAGE_DUPLICATE_WEDDING = "This wedding already exists in the contact book"; + + private final Wedding toAdd; + + /** + * Creates an AddWeddingCommand to add the specified {@code Wedding}. + */ + public AddWeddingCommand(Wedding wedding) { + requireNonNull(wedding); + toAdd = wedding; + } + + @Override + public CommandResult execute(Model model) throws CommandException { + requireNonNull(model); + + if (model.hasWedding(toAdd)) { + throw new CommandException(MESSAGE_DUPLICATE_WEDDING); + } + + model.addWedding(toAdd); + return new CommandResult(String.format(MESSAGE_SUCCESS, toAdd)); + } + + @Override + public boolean equals(Object other) { + return other == this + || (other instanceof AddWeddingCommand + && toAdd.equals(((AddWeddingCommand) other).toAdd)); + } +} diff --git a/src/main/java/seedu/address/logic/commands/ClearCommand.java b/src/main/java/seedu/address/logic/commands/ClearCommand.java index 9c86b1fa6e4..6d5165c6121 100644 --- a/src/main/java/seedu/address/logic/commands/ClearCommand.java +++ b/src/main/java/seedu/address/logic/commands/ClearCommand.java @@ -6,18 +6,90 @@ import seedu.address.model.Model; /** - * Clears the address book. + * Clears the contact book. + *+ * In normal mode, if the address book is not empty, the command will signal that confirmation is required + * to avoid accidental clearing. The command is stored in the ConfirmationManager so that it can be re-executed + * in force mode if the user confirms. + *
*/ -public class ClearCommand extends Command { +public class ClearCommand extends Command implements ForceableCommand { public static final String COMMAND_WORD = "clear"; - public static final String MESSAGE_SUCCESS = "Address book has been cleared!"; + public static final String MESSAGE_SUCCESS = "Contact book has been cleared!"; + public static final String MESSAGE_CONFIRMATION_REQUIRED = + "WARNING: You are about to clear the contact book.\n" + + "If you wish to proceed, use 'Ctrl / Command + A' and press 'Delete / Backspace' to clear the input box\n" + + "and input 'y' to confirm.\n" + + "Else, edit your input directly and press 'Enter'. "; + private final boolean isForced; + /** + * Creates a ClearCommand in normal mode. + */ + public ClearCommand() { + this(false); + } + + /** + * Creates a ClearCommand with the specified mode. + * + * @param isForced If true, the confirmation requirement is bypassed. + */ + public ClearCommand(boolean isForced) { + requireNonNull(isForced); + this.isForced = isForced; + } + + /** + * Executes the clear command. + *+ * In normal mode, if the address book is not empty, this method stores this command in the ConfirmationManager + * and returns a CommandResult indicating that confirmation is required. + * In force mode (or if the address book is already empty), it clears the address book immediately. + *
+ * + * @param model {@code Model} which the command should operate on. + * @return the result of command execution. + */ @Override public CommandResult execute(Model model) { requireNonNull(model); + // Check if the address book is not empty + if (!isForced && !model.getAddressBook().getPersonList().isEmpty()) { + ConfirmationManager.getInstance().setPendingCommand(this); + return new CommandResult(MESSAGE_CONFIRMATION_REQUIRED, false, false, true); + } + // If force mode or if the address book is empty, proceed to clear it. model.setAddressBook(new AddressBook()); return new CommandResult(MESSAGE_SUCCESS); } + + /** + * Creates and returns a forced version of this command. + * + * @return a new ClearCommand with the force flag set to true. + */ + @Override + public ForceableCommand createForceCommand() { + return new ClearCommand(true); + } + + @Override + public boolean equals(Object other) { + if (other == this) { + return true; + } + if (!(other instanceof ClearCommand)) { + return false; + } + ClearCommand otherClear = (ClearCommand) other; + return isForced == otherClear.isForced; + } + + @Override + public String toString() { + return getClass().getCanonicalName() + "{isForced=" + isForced + "}"; + } } diff --git a/src/main/java/seedu/address/logic/commands/CommandResult.java b/src/main/java/seedu/address/logic/commands/CommandResult.java index 249b6072d0d..3d20ffa3d59 100644 --- a/src/main/java/seedu/address/logic/commands/CommandResult.java +++ b/src/main/java/seedu/address/logic/commands/CommandResult.java @@ -19,13 +19,35 @@ public class CommandResult { /** The application should exit. */ private final boolean exit; + private boolean refreshUI; + + /** + * Indicates whether this command result requires further user confirmation. + * For example, this flag can be set when a duplicate person is detected, + * and the UI must prompt the user to confirm the operation. + */ + private final boolean requiresConfirmation; + /** * Constructs a {@code CommandResult} with the specified fields. */ - public CommandResult(String feedbackToUser, boolean showHelp, boolean exit) { + public CommandResult(String feedbackToUser, boolean showHelp, boolean exit, boolean requiresConfirmation) { + this.feedbackToUser = requireNonNull(feedbackToUser); + this.showHelp = showHelp; + this.exit = exit; + this.requiresConfirmation = requiresConfirmation; + } + + /** + * Constructs a {@code CommandResult} with the specified fields. + */ + public CommandResult(String feedbackToUser, boolean showHelp, + boolean exit, boolean requiresConfirmation, boolean refreshUI) { this.feedbackToUser = requireNonNull(feedbackToUser); this.showHelp = showHelp; this.exit = exit; + this.requiresConfirmation = requiresConfirmation; + this.refreshUI = refreshUI; } /** @@ -33,7 +55,7 @@ public CommandResult(String feedbackToUser, boolean showHelp, boolean exit) { * and other fields set to their default value. */ public CommandResult(String feedbackToUser) { - this(feedbackToUser, false, false); + this(feedbackToUser, false, false, false); } public String getFeedbackToUser() { @@ -48,6 +70,23 @@ public boolean isExit() { return exit; } + /** + * Returns true if this CommandResult indicates that further user confirmation is required. + * + * @return {@code true} if user confirmation is required; {@code false} otherwise. + */ + public boolean isRequiresConfirmation() { + return requiresConfirmation; + } + + /** + * Returns if this CommandResult indicates that the UI should be refreshed. + * @return {@code true} if UI should be refreshed; {@code false} otherwise. + */ + public boolean isRefreshUI() { + return refreshUI; + } + @Override public boolean equals(Object other) { if (other == this) { @@ -62,12 +101,13 @@ public boolean equals(Object other) { CommandResult otherCommandResult = (CommandResult) other; return feedbackToUser.equals(otherCommandResult.feedbackToUser) && showHelp == otherCommandResult.showHelp - && exit == otherCommandResult.exit; + && exit == otherCommandResult.exit + && requiresConfirmation == otherCommandResult.requiresConfirmation; } @Override public int hashCode() { - return Objects.hash(feedbackToUser, showHelp, exit); + return Objects.hash(feedbackToUser, showHelp, exit, requiresConfirmation); } @Override @@ -76,7 +116,7 @@ public String toString() { .add("feedbackToUser", feedbackToUser) .add("showHelp", showHelp) .add("exit", exit) + .add("requiresConfirmation", requiresConfirmation) .toString(); } - } diff --git a/src/main/java/seedu/address/logic/commands/ConfirmCommand.java b/src/main/java/seedu/address/logic/commands/ConfirmCommand.java new file mode 100644 index 00000000000..c128c15c0d6 --- /dev/null +++ b/src/main/java/seedu/address/logic/commands/ConfirmCommand.java @@ -0,0 +1,33 @@ +package seedu.address.logic.commands; + +import seedu.address.logic.commands.exceptions.CommandException; +import seedu.address.model.Model; + +/** + * Re-executes the pending command in force mode after user confirmation. + */ +public class ConfirmCommand extends Command { + + public static final String COMMAND_WORD = "y"; + + @Override + public CommandResult execute(Model model) throws CommandException { + // Retrieve the pending command that required confirmation. + Command pendingCommand = ConfirmationManager.getInstance().getPendingCommand(); + if (pendingCommand == null) { + throw new CommandException("No pending command to confirm."); + } + if (!(pendingCommand instanceof ForceableCommand)) { + throw new CommandException("Pending command cannot be forced."); + } + ForceableCommand forceable = (ForceableCommand) pendingCommand; + // Clear the pending command so that it's not executed twice. + ConfirmationManager.getInstance().clearPendingCommand(); + return ((Command) forceable.createForceCommand()).execute(model); + } + + @Override + public boolean equals(Object other) { + return other instanceof ConfirmCommand; + } +} diff --git a/src/main/java/seedu/address/logic/commands/ConfirmationManager.java b/src/main/java/seedu/address/logic/commands/ConfirmationManager.java new file mode 100644 index 00000000000..3959462dbf2 --- /dev/null +++ b/src/main/java/seedu/address/logic/commands/ConfirmationManager.java @@ -0,0 +1,48 @@ +package seedu.address.logic.commands; + +/** + * A singleton that manages the pending command requiring confirmation. + */ +public class ConfirmationManager { + private static ConfirmationManager instance; + private Command pendingCommand; + + private ConfirmationManager() {} + + /** + * Returns the singleton instance of ConfirmationManager. + * + * @return the ConfirmationManager instance. + */ + public static ConfirmationManager getInstance() { + if (instance == null) { + instance = new ConfirmationManager(); + } + return instance; + } + + /** + * Sets the pending command that requires user confirmation. + * + * @param command The command to store. + */ + public void setPendingCommand(Command command) { + this.pendingCommand = command; + } + + /** + * Returns the currently pending command. + * + * @return the pending command, or null if none. + */ + public Command getPendingCommand() { + return pendingCommand; + } + + /** + * Clears the stored pending command. + */ + public void clearPendingCommand() { + this.pendingCommand = null; + } +} diff --git a/src/main/java/seedu/address/logic/commands/DeleteCommand.java b/src/main/java/seedu/address/logic/commands/DeleteCommand.java index 1135ac19b74..ce2bf78cbf0 100644 --- a/src/main/java/seedu/address/logic/commands/DeleteCommand.java +++ b/src/main/java/seedu/address/logic/commands/DeleteCommand.java @@ -12,7 +12,7 @@ import seedu.address.model.person.Person; /** - * Deletes a person identified using it's displayed index from the address book. + * Deletes a person identified using it's displayed index from the contact book. */ public class DeleteCommand extends Command { diff --git a/src/main/java/seedu/address/logic/commands/DeleteTaskCommand.java b/src/main/java/seedu/address/logic/commands/DeleteTaskCommand.java new file mode 100644 index 00000000000..570cf0dffcd --- /dev/null +++ b/src/main/java/seedu/address/logic/commands/DeleteTaskCommand.java @@ -0,0 +1,70 @@ +package seedu.address.logic.commands; + +import static java.util.Objects.requireNonNull; + +import seedu.address.logic.Messages; +import seedu.address.logic.commands.exceptions.CommandException; +import seedu.address.model.Model; +import seedu.address.model.wedding.Wedding; +import seedu.address.model.wedding.WeddingId; +import seedu.address.model.wedding.WeddingTask; + +/** + * Deletes a task to a specific wedding identified by a Wedding ID. + */ +public class DeleteTaskCommand extends Command { + + public static final String COMMAND_WORD = "deleteTask"; + + public static final String MESSAGE_USAGE = COMMAND_WORD + ": Deletes a task from a specified wedding.\n" + + "Parameters: w/WEDDING_ID i/TASK_INDEX\n" + + "Example: " + COMMAND_WORD + " w/W1 i/2"; + + public static final String MESSAGE_SUCCESS = "Deleted task from wedding %1$s:\n%2$s"; + public static final String MESSAGE_INVALID_TASK_INDEX = "Invalid task index for wedding %1$s."; + + private final WeddingId weddingId; + private final int taskIndex; + + /** + * Constructs a DeleteTaskCommand to remove the specified task from the given wedding. + * + * @param weddingId The ID of the wedding from which the task will be deleted. + * @param taskIndex The 1-based index of the task to delete. + */ + public DeleteTaskCommand(WeddingId weddingId, int taskIndex) { + this.weddingId = weddingId; + this.taskIndex = taskIndex; + } + + @Override + public CommandResult execute(Model model) throws CommandException { + requireNonNull(model); + + Wedding wedding = model.getFilteredWeddingList().stream() + .filter(w -> w.getWeddingId().equals(weddingId)) + .findFirst() + .orElseThrow(() -> new CommandException(String.format(Messages.MESSAGE_WEDDING_NOT_FOUND, + weddingId.value))); + + try { + WeddingTask removed = wedding.removeTask(taskIndex - 1); + return new CommandResult(String.format(MESSAGE_SUCCESS, weddingId.value, removed), + false, false, false, true); + } catch (IndexOutOfBoundsException e) { + throw new CommandException(String.format(MESSAGE_INVALID_TASK_INDEX, weddingId.value)); + } + } + + @Override + public boolean equals(Object other) { + if (other == this) { + return true; + } + if (!(other instanceof DeleteTaskCommand)) { + return false; + } + DeleteTaskCommand c = (DeleteTaskCommand) other; + return weddingId.equals(c.weddingId) && taskIndex == c.taskIndex; + } +} diff --git a/src/main/java/seedu/address/logic/commands/DeleteWeddingCommand.java b/src/main/java/seedu/address/logic/commands/DeleteWeddingCommand.java new file mode 100644 index 00000000000..60b47fb9681 --- /dev/null +++ b/src/main/java/seedu/address/logic/commands/DeleteWeddingCommand.java @@ -0,0 +1,83 @@ +package seedu.address.logic.commands; + +import static java.util.Objects.requireNonNull; + +import seedu.address.logic.Messages; +import seedu.address.logic.commands.exceptions.CommandException; +import seedu.address.model.Model; +import seedu.address.model.tag.Tag; +import seedu.address.model.wedding.Wedding; +import seedu.address.model.wedding.WeddingId; + + + +/** + * Deletes a Wedding event from the contact book. + */ +public class DeleteWeddingCommand extends Command { + + public static final String COMMAND_WORD = "deleteWedding"; + + public static final String MESSAGE_USAGE = COMMAND_WORD + ": Deletes a wedding from the contact book. " + + "Parameters: WEDDING_ID\n" + + "Example: " + COMMAND_WORD + " W1"; + + public static final String MESSAGE_SUCCESS = "Deleted wedding: %1$s"; + + private final WeddingId weddingId; + + /** + * Creates a DeleteWeddingCommand to delete the specified {@code Wedding}. + */ + public DeleteWeddingCommand(WeddingId weddingId) { + requireNonNull(weddingId); + this.weddingId = weddingId; + } + + /** + * Executes the command and deletes the specified {@code Wedding}. + * + * @param model {@code Model} which the command should operate on. + * @return A {@code CommandResult} representing the result of the deletion. + * @throws CommandException If the specified {@code Wedding} does not exist. + */ + @Override + public CommandResult execute(Model model) throws CommandException { + requireNonNull(model); + + Wedding weddingToDelete = model.getWeddingById(weddingId); + + if (weddingToDelete == null) { + throw new CommandException(String.format(Messages.MESSAGE_WEDDING_NOT_FOUND, weddingId.value)); + } + + boolean isFiltered = model.getFilteredWeddingList().size() < model.getAddressBook().getWeddingList().size(); + + model.deleteWedding(weddingToDelete); + + Tag tagToDelete = new Tag(weddingId); + model.removeTagFromAllContacts(tagToDelete); + + // If a filter was applied, show blank lists, otherwise, show full lists. + if (isFiltered) { + model.updateFilteredWeddingList(w -> false); + model.updateFilteredPersonList(p -> false); + } else { + model.updateFilteredWeddingList(w -> true); + model.updateFilteredPersonList(p -> true); + } + + return new CommandResult(String.format(MESSAGE_SUCCESS, weddingToDelete)); + } + + /** + * Returns true if both DeleteWeddingCommands have the same wedding id. + * @param other The other object to compare to. + */ + @Override + public boolean equals(Object other) { + return other == this + || (other instanceof DeleteWeddingCommand + && weddingId.equals(((DeleteWeddingCommand) other).weddingId)); + } +} diff --git a/src/main/java/seedu/address/logic/commands/EditCommand.java b/src/main/java/seedu/address/logic/commands/EditCommand.java index 4b581c7331e..6b0e4ef95d8 100644 --- a/src/main/java/seedu/address/logic/commands/EditCommand.java +++ b/src/main/java/seedu/address/logic/commands/EditCommand.java @@ -5,15 +5,12 @@ import static seedu.address.logic.parser.CliSyntax.PREFIX_EMAIL; import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME; import static seedu.address.logic.parser.CliSyntax.PREFIX_PHONE; -import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG; +import static seedu.address.logic.parser.CliSyntax.PREFIX_ROLE; import static seedu.address.model.Model.PREDICATE_SHOW_ALL_PERSONS; -import java.util.Collections; -import java.util.HashSet; import java.util.List; import java.util.Objects; import java.util.Optional; -import java.util.Set; import seedu.address.commons.core.index.Index; import seedu.address.commons.util.CollectionUtil; @@ -26,12 +23,12 @@ import seedu.address.model.person.Name; import seedu.address.model.person.Person; import seedu.address.model.person.Phone; -import seedu.address.model.tag.Tag; +import seedu.address.model.person.Role; /** - * Edits the details of an existing person in the address book. + * Edits the details of an existing person in the contact book. */ -public class EditCommand extends Command { +public class EditCommand extends Command implements ForceableCommand { public static final String COMMAND_WORD = "edit"; @@ -42,29 +39,47 @@ public class EditCommand extends Command { + "[" + PREFIX_NAME + "NAME] " + "[" + PREFIX_PHONE + "PHONE] " + "[" + PREFIX_EMAIL + "EMAIL] " + + "[" + PREFIX_ROLE + "ROLE] " + "[" + PREFIX_ADDRESS + "ADDRESS] " - + "[" + PREFIX_TAG + "TAG]...\n" + "Example: " + COMMAND_WORD + " 1 " + PREFIX_PHONE + "91234567 " + PREFIX_EMAIL + "johndoe@example.com"; public static final String MESSAGE_EDIT_PERSON_SUCCESS = "Edited Person: %1$s"; public static final String MESSAGE_NOT_EDITED = "At least one field to edit must be provided."; - public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book."; + public static final String MESSAGE_NO_CHANGES = + "No changes detected. Your input is exactly the same as the existing values."; + public static final String MESSAGE_DUPLICATE_PERSON = + "WARNING: This person may already exist in the contact book.\n" + + "If you wish to proceed, use 'Ctrl / Command + A' and press 'Delete / Backspace' to clear the input box\n" + + "and input 'y' to confirm.\n" + + "Else, edit your input directly and press 'Enter'. "; private final Index index; private final EditPersonDescriptor editPersonDescriptor; + private final boolean isForced; /** + * Constructs an EditCommand in normal mode. + */ + public EditCommand(Index index, EditPersonDescriptor editPersonDescriptor) { + this(index, editPersonDescriptor, false); + } + + /** + * Constructs an EditCommand with the specified mode. + * * @param index of the person in the filtered person list to edit * @param editPersonDescriptor details to edit the person with + * @param isForced flag indicating that duplicate checks are bypassed (force mode) */ - public EditCommand(Index index, EditPersonDescriptor editPersonDescriptor) { + public EditCommand(Index index, EditPersonDescriptor editPersonDescriptor, boolean isForced) { requireNonNull(index); requireNonNull(editPersonDescriptor); this.index = index; this.editPersonDescriptor = new EditPersonDescriptor(editPersonDescriptor); + this.isForced = isForced; } @Override @@ -79,8 +94,22 @@ public CommandResult execute(Model model) throws CommandException { Person personToEdit = lastShownList.get(index.getZeroBased()); Person editedPerson = createEditedPerson(personToEdit, editPersonDescriptor); + // If no effective changes are made, signal that the input is exactly the same. + if (personToEdit.equals(editedPerson)) { + throw new CommandException(MESSAGE_NO_CHANGES); + } + + // If the edited person is not the same as the original and a duplicate exists: if (!personToEdit.isSamePerson(editedPerson) && model.hasPerson(editedPerson)) { - throw new CommandException(MESSAGE_DUPLICATE_PERSON); + if (!isForced) { + ConfirmationManager.getInstance().setPendingCommand(this); + return new CommandResult(MESSAGE_DUPLICATE_PERSON, false, false, true); + } else { + // Force mode: bypass duplicate check by calling forceSetPerson. + model.forceSetPerson(personToEdit, editedPerson); + model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS); + return new CommandResult(String.format(MESSAGE_EDIT_PERSON_SUCCESS, Messages.format(editedPerson))); + } } model.setPerson(personToEdit, editedPerson); @@ -98,10 +127,15 @@ private static Person createEditedPerson(Person personToEdit, EditPersonDescript Name updatedName = editPersonDescriptor.getName().orElse(personToEdit.getName()); Phone updatedPhone = editPersonDescriptor.getPhone().orElse(personToEdit.getPhone()); Email updatedEmail = editPersonDescriptor.getEmail().orElse(personToEdit.getEmail()); + Role updatedRole = editPersonDescriptor.getRole().orElse(personToEdit.getRole()); Address updatedAddress = editPersonDescriptor.getAddress().orElse(personToEdit.getAddress()); - Set* 3. An argument may be repeated and all its values will be accumulated e.g. the value of {@code t/} * in the above example.
+ * + *
This updated version supports escaping prefixes. For instance, if a user inputs:
+ *
+ * The ConfirmCommand does not accept any arguments. If the user input is not empty,
+ * a ParseException is thrown.
+ *
+ * When loading data, forced duplicates are allowed so that previously forced duplicate entries are preserved.
+ *
+ * This method bypasses duplicate checks. It locates the person in the internal list and
+ * replaces the record with {@code editedPerson}. If the target is not found, a
+ * {@code PersonNotFoundException} is thrown.
+ *
+ * The command text is executed and the resulting CommandResult is checked.
+ * If the command does not require confirmation, the input field is cleared.
+ * Otherwise, the user's input is preserved so that they can edit or confirm.
+ * addWedding n/John & Jane \d/ Wedding d/30-Apr-2026 l/MBS
+ *
then the "\d/" will be treated as literal text (producing "d/") and will not be interpreted as a new prefix.
*/
public class ArgumentTokenizer {
@@ -60,19 +64,26 @@ private static List