+
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[email](e0693145@u.nus.edu)]
+[[LinkedIn](https://www.linkedin.com/in/yong-jing-goh-948605219/)]
+[[Github](https://github.com/gohyongjing)]
-* Role: Project Advisor
+- Role: Project Advisor
-### Jane Doe
+### See Yang Zhi
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[homepage](https://yangzhi.dev)]
+[[github](https://github.com/SeeYangZhi)]
+[[portfolio](team/seeyangzhi.md)]
-* Role: Team Lead
-* Responsibilities: UI
+- Role: Team Lead
+- Responsibilities:
+ - Scheduling and tracking
+ - In charge of defining, assigning, and tracking project tasks.
+ - Deliverables and deadlines
+ - Ensure project deliverables are done on time and in the right format.
+ - Documentation
+ - Responsible for the quality of various project documents.
-### Johnny Doe
+### Sean Lim
-
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/seanlim)] [[bsky](https://seanlkx.bsky.social/)]
-* Role: Developer
-* Responsibilities: Data
+- Role: In charge of `Model`, Code Quality
+- Responsibilities:
+ - Manage the models we will use for SpleetWaise.
+ - Code Reviews to uphold coding standards.
-### Jean Doe
+### Dong Qianbo
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/rollingpencil)]
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+- Role: In charge of `Storage`, Integration
+- Responsibilities:
+ - Ensure data format are consistent.
+ - In charge of versioning of the code, maintaining the code repository, and
+ integrating various parts of the software to create a whole.
-### James Doe
+### He Yiheng
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/Dino-Nuggies)]
-* Role: Developer
-* Responsibilities: UI
+- Current role: In charge of `Logic`
+- Responsibilities:
+ - Act as the gatekeeper of quality for `Logic` component
+
+### Gavin Sin
+
+
+
+[[github](http://github.com/gavinsin)]
+
+- Role: In charge of `UI`, Testing
+- Responsibilities: Manage the UI for SpleetWaise to ensure consistency. Code
+ Testing to ensure bug-free application.
diff --git a/docs/DevOps.md b/docs/DevOps.md
index d2fd91a6001..c6a45718444 100644
--- a/docs/DevOps.md
+++ b/docs/DevOps.md
@@ -8,18 +8,43 @@ title: DevOps guide
--------------------------------------------------------------------------------------------------------------------
-## Build automation
+## Code Formatting
+
+This project uses the [Java coding standard (basic)
+](https://se-education.org/guides/conventions/java/basic.html) and the Google Java style guide. The code style is
+enforced using Checkstyle. The checks are run as part of the CI process.
+
+Developers are recommended to import the [`Intellij IDEA code style XML`](/config/IntelliJ.xml) and [
+`Eclipse XML Profile`](/config/Eclipse.xml) from the `config` folder to IntelliJ IDEA to ensure that the code style is
+consistent across all developers after reformatting. Follow the following steps to import the code style settings:
+
+1. Navigate to `Settings/Preferences` -> `Editor` -> `Code Style` -> `Java`.
+2. Beside scheme, click on the gear icon and select `Import Scheme` -> `Intellij IDEA code style XML`.
+3. Select the `IntelliJ.xml` file from the `config` folder.
+4. Click `OK` to apply the code style.
+5. Beside scheme, click on the gear icon and select `Import Scheme` -> `Eclipse XML Profile`.
+6. Select the `Eclipse.xml` file from the `config` folder.
+7. Check `Current Scheme` and click `OK` to apply the code style.
+8. To reformat the code, press `Ctrl + Alt + L` on Windows or `Shift + Cmd + Option + L` on macOS – Ensure the option of
+ `Optimise Imports` is selected.
+9. If you are prompted with `Settings may be overridden by EditorConfig` in `Settings/Preferences` -> `Editor` ->
+ `Code Style`, click `disable`.
+
+\* If you are using a different IDE, you can refer to the respective IDE's documentation on how to import code style
+settings. But we recommend using IntelliJ IDEA for this project.
-This project uses Gradle for **build automation and dependency management**. **You are recommended to read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.
+## Build automation
+This project uses Gradle for **build automation and dependency management**. **You are recommended to
+read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.
Given below are how to use Gradle for some important project tasks.
-
* **`clean`**: Deletes the files created during the previous build tasks (e.g. files in the `build` folder).: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.
- -
-
-
+{% include DeveloperGuide/Design/model.md %}
### Storage component
-**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java)
-
-- -
-
-
-
-The `Storage` component,
-* can save both address book data and user preference data in JSON format, and read them back into corresponding objects.
-* inherits from both `AddressBookStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed).
-* depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`)
-
-### Common classes
-
-Classes used by multiple components are in the `seedu.address.commons` package.
+{% include DeveloperGuide/Design/storage.md %}
---------------------------------------------------------------------------------------------------------------------
+---
## **Implementation**
@@ -161,9 +63,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.
@@ -189,8 +91,7 @@ Step 4. The user now decides that adding the person was a mistake, and decides t
-:information_source: **Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather
-than attempting to perform the undo.
+
+ Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. -*{More to be added}* +2. Saving window preferences -### Use cases + 1. Resize the window to an optimum size. Move the window to a different location. Close the window. -(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise) + 2. Re-launch the app
+ Expected: The most recent window size and location is retained. -**Use case: Delete a person** +### Local GUI testing -**MSS** +The available gradle tasks are: guiTests, nonGuiTests, allTests. -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 +- guiTests: all tests under `systemtests` package +- nonGuiTests: all tests under `spleetwaise.address`, `spleetwaise.common`, `spleetwaise.transaction` packages +- allTests: guiTests and nonGuiTests, nonGuiTests will be run before guiTests - Use case ends. +As an example, you can run `gradle nonGuiTests` in the gradle terminal for all tests excluding GUI related tests. +You can navigate the gradle terminal by clicking on elephant icon _(Gradle)_ > terminal icon _(Execute Gradle tasks)_. -**Extensions** +### Adding a person -* 2a. The list is empty. +1. Adding a person while all persons are being shown - Use case ends. + 1. Prerequisites: List all persons using the list command. Multiple persons in the list. -* 3a. The given index is invalid. + 2. Test case: `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
+ Expected: Assuming no duplicates, a new contact named John Doe is added to the list. Details of the added contact shown in the status message. - * 3a1. AddressBook shows an error message. + 3. Test case: `add n/ p/ e/ a/`
+ Expected: No person is added. Error details shown in the status message. Status bar remains the same. - Use case resumes at step 2. + 4. Other incorrect add commands to try: `add n/John Doe`, `add p/98765432`, `add e/johnd@example.com`, `add a/John street, block 123, #01-01`
+ Expected: Similar to previous. -*{More to be added}* +### Editing a person -### Non-Functional Requirements +1. Editing a person while all persons are being shown -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. + 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. -*{More to be added}* + 2. Test case: `edit 1 n/Jane Doe`
+ Expected: Assuming no duplicates, first contact's name is changed to Jane Doe. Details of the edited contact shown in the status message. -### Glossary + 3. Test case: `edit 0 n/Jane Doe`
+ Expected: No person is edited. Error details shown in the status message. -* **Mainstream OS**: Windows, Linux, Unix, MacOS -* **Private contact detail**: A contact detail that is not meant to be shared with others + 4. Other incorrect edit commands to try: `edit`, `edit x n/Jane Doe` (where x is larger than the list size), + `edit 1`
+ Expected: Similar to previous. --------------------------------------------------------------------------------------------------------------------- +### Person Synchronization in transaction list -## **Appendix: Instructions for manual testing** +1. Ensuring person details changed are accurately reflected in all views and models. -Given below are instructions to test the app manually. + 1. Prerequisites: List all persons and transactions using the `list` and `listTxn` command. At least one person and one transaction with that person in the list. -
+ Expected: First contact's remark is updated to "Likes to swim". Details of the updated contact shown in the status message. Timestamp in the status bar is updated. + + 3. Test case: `remark 0 r/Likes to swim`
+ Expected: No person's remark is updated. Error details shown in the status message. Status bar remains the same. - 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. + 4. Other incorrect remark commands to try: `remark`, `remark x r/Likes to swim` (where x is larger than the list size)
+ Expected: Similar to previous. + +2. Deleting a remark for a person using the `remark` command while all persons are being shown -1. Saving window preferences + 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. - 1. Resize the window to an optimum size. Move the window to a different location. Close the window. + 2. Test case: `remark 1 r/`
+ Expected: First contact's remark is deleted. Details of the contact shown in the status message. - 1. Re-launch the app by double-clicking the jar file.
- Expected: The most recent window size and location is retained. + 3. Test case: `remark 1`
+ Expected: First contact's remark is deleted (shortcut for users intending to empty remark). Details of the contact shown in the status message. -1. _{ more test cases … }_ + 4. Test case: `remark 0 r/`
+ Expected: No person's remark is deleted. Error details shown in the status message. ### Deleting a person @@ -362,21 +268,150 @@ testers are expected to do more *exploratory* testing. 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + 2. Test case: `delete 1`
+ Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. + + 3. Test case: `delete 0`
+ Expected: No person is deleted. Error details shown in the status message. + + 4. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Adding a transaction + +1. Adding a transaction while all transactions are being shown with minimally 1 person in address book + + 1. Prerequisites: List all persons and transactions using the `list` and `listTxn` command. At least one person in the address book list and multiple transactions in the list + + 2. Test cases: `addTxn 1 amt/12.3 desc/John owes me for dinner`
+ Expected: Assuming no duplicates, a new transaction related to the person in the first index of the address book is added to the list along with description of it. The amount reflected in the transaction is displayed green in the transaction panel to signify that _the user_ is owed. The date of the transaction displays the current day. No categories to be displayed. Details of the added transaction is shown in the status message. + + 3. Test cases: `addTxn 1 amt/-12.3 desc/I owe John for dinner date/10102024`
+ Expected: Assuming no duplicates, a new transaction related to the person in the first index of the address book is added to the list along with description of it. The amount reflected in the transaction is displayed red in the transaction panel to signify that _the user_ owes. The date of the transaction displays `10 Oct 2024`. No categories to be displayed. Details of the added transaction is shown in the status message. + + 4. Test cases: `addTxn 1 amt/12.3 desc/John owes me for dinner cat/FOOD`
+ Expected: Assuming no duplicates, a new transaction related to the person in the first index of the address book is added to the list along with description of it. The amount reflected in the transaction is displayed green in the transaction panel to signify that you are owed. The date of the transaction displays the current day. Category of `FOOD` is displayed. Details of the added transaction is shown in the status message. + + 5. Test cases: `addTxn 1 amt/-12.3 desc/I owe John for dinner date/10102024` when identical transaction exists
+ Expected: No transaction is added. Error details shown in the status message with `Transaction already exists in the transaction book`. Status bar remains the same. + + 6. Test cases: `addTxn 0 amt/ desc/ date/ cat/`
+ Expected: No transaction is added. Error details shown in the status message. Status bar remains the same. + + 7. Other incorrect `addTxn` commands to try: `addTxn 1`, `addTxn amt/1.234`, `addTxn desc/dinner`, `addTxn date/10102024`, `addTxn cat/FOOD`
+ Expected: Similar to previous. + +### Marking a transaction as done + +1. Marking a transaction as done while all transactions are being shown. + + 1. Prerequisites: List all transactions using the `listTxn` command. One transaction is in the list. + + 2. Test cases: `markDone 1`
+ Expected: The first transaction is marked as done. A "done" icon appears next to the person's name for that transaction. Details of the updated transaction shown in the status message. + + 3. Test cases: `markDone 1` (Assumes transaction 1 is already marked)
+ Expected: No change in transaction status. The "done" icon remains. A status message confirms that the transaction is already marked. + + 4. Test cases: `markDone 0`
+ Expected: No transaction is marked. Error details shown in the status message. + + 5. Other incorrect `markDone` commands to try: `markDone`, `markDone x` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Reverting a done transaction back to undone + +1. Reverting a done transaction back to undone while all transactions are being shown. + + 1. Prerequisites: List all transactions using the `listTxn` command. One transaction is in the list. + + 2. Test cases: `markUndone 1`
+ Expected: The first transaction is reverted to undone. The existing "done" icon disappears for that transaction. Details of the updated transaction shown in the status message. + + 3. Test cases: `markUndone 1` (Assumes transaction 1 is already undone)
+ Expected: No change in transaction status. The transaction remains to have no "done" icon. A status message confirms that the transaction is already undone. + + 4. Test cases: `markUndone 0`
+ Expected: No transaction is marked. Error details shown in the status message. + + 5. Other incorrect `markUndone` commands to try: `markUndone`, `markUndone x` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Editing a transaction + +1. Editing a transaction while all persons are being shown + + 1. Prerequisites: List all persons and transactions using the `list` and `listTxn` command respectively. Multiple + persons in the list on the left pane. Multiple transactions in the list on the right pane. - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. + 2. Test case: `editTxn 1 amt/1.23`
+ Expected: Assuming no duplicates, first contact's amount is changed to $1.23. Details of the edited transaction shown in the status message. - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ 3. Test case: `editTxn 0 desc/Updated description`
+ Expected: No transaction is edited. Error details shown in the status message. + + 4. Other incorrect edit commands to try: `editTxn`, `edit x amt/1.23` (where x is larger than the list size), `editTxn 1`
Expected: Similar to previous. -1. _{ more test cases … }_ +### Filter Reuse in Transaction List + +1. Maintaining the current filter state when transactions are modified. + + 1. Prerequisites: List all transactions using the `listTxn` command. Apply a filter via `filterTxn` command to the list (e.g., filtering by description containing "mac"). + + 2. Test cases: `addTxn 1 amt/12.3 desc/John owes me for dinner`
+ Expected: The new transaction appears in the filtered list while preserving the existing filter. Details of the new transaction shown in the status message. + + 3. Test cases: `editTxn 1 d/happy meal at mac` (Assumes transaction 1 description is "KFC")
+ Expected: The updated transaction appears in the filtered list while preserving the existing filter. Details of the updated transaction shown in the status message. + + 4. Test cases: `editTxn 1 d/KFC` (Assumes transaction 1 description is "fries at mac")
+ Expected: The updated transaction disappears in the filtered list while preserving the existing filter. Details of the updated transaction shown in the status message. + + 5. Test cases: `markDone 1`, `markUndone 1` (Assumes transaction 1 description is "fries at mac")
+ Expected: The transaction done icon updated in the filtered list while preserving the existing filter. Details of the updated transaction shown in the status message. + +### Filtering the transaction list. + +1. Filtering the transaction list while all persons are being shown + + 1. Prerequisites: List all persons and transactions using the `list` and `listTxn` command respectively. Multiple + persons in the list on the left pane. Multiple transactions in the list on the right pane. + + 2. Test case: `filterTxn 1`
+ Expected: Transaction list will be filtered by the person corresponding to the displayed index 1 in the person + list. + + 3. Test case: `filterTxn 1 amt/1.23`
+ Expected: Transaction list will show transactions related to the person corresponding to the displayed index 1 + in the person list with amount $1.23. + + 4. Test case: `filterTxn 0`
+ Expected: Current displayed transaction list will remain the same. Error details shown in the status message. + + 5. Other incorrect edit commands to try: `filterTxn desc/`, `filterTxn x` (where x is larger than the list size), + `filterTxn amt/1.222`
+ Expected: Similar to previous. + +### Default Behavior on App Startup + +1. Verifying filter state upon app initialization. + + 1. Prerequisites: At least one done transaction and one undone transaction in the list. + + 2. Test cases: Initial Filter on App Startup
+ Expected: The list displays all transactions (both done and undone) by default when the app starts. ### Saving data 1. Dealing with missing/corrupted data files - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ + 1. Prerequisites: Multiple persons in `addressbook.json` and multiple transactions in `transactionbook.json` data files.
+ + 2. Test cases: Missing `name` field in `addressbook.json` data file
+ Simulation: Remove the `name` field from a person entry in the JSON file, then start the app.
+ Expected: The person is discarded and not loaded to the app, with log message `WARNING: Address book is possibly corrupted: Person's Name field is missing! Ignoring corrupted person.`. If the corrupted person has any related transactions in the transaction book, they will be discarded accordingly with log message `WARNING: Transaction book is possibly corrupted: Person with id [Person-ID] not found! Ignoring corrupted transactions.` - `[Person-ID]` will be the respective person ID of the corrupted person. -1. _{ more test cases … }_ + 3. Test cases: Missing `isDone` field in `transactionbook.json` data file
+ Simulation: Remove the `isDone` field from a transaction entry in the JSON file, then start the app.
+ Expected: The transaction loads as undone by default. Upon closing the app, the transaction is saved as undone in the JSON file. diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index bac5eb36d35..73be7b0a58a 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,48 +1,68 @@ GEM remote: https://rubygems.org/ specs: - activesupport (7.0.7.2) - concurrent-ruby (~> 1.0, >= 1.0.2) + activesupport (7.2.1.2) + base64 + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb i18n (>= 1.6, < 2) + logger (>= 1.4.2) minitest (>= 5.1) - tzinfo (~> 2.0) - addressable (2.8.4) - public_suffix (>= 2.0.2, < 6.0) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + base64 (0.2.0) + bigdecimal (3.1.8) coffee-script (2.4.1) coffee-script-source execjs - coffee-script-source (1.11.1) + coffee-script-source (1.12.2) colorator (1.1.0) commonmarker (0.23.10) - concurrent-ruby (1.2.2) - dnsruby (1.70.0) + concurrent-ruby (1.3.4) + connection_pool (2.4.1) + csv (3.3.0) + dnsruby (1.72.2) simpleidn (~> 0.2.1) + drb (2.2.1) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) ethon (0.16.0) ffi (>= 1.15.0) eventmachine (1.2.7) - eventmachine (1.2.7-x64-mingw32) - execjs (2.8.1) - faraday (2.7.5) - faraday-net_http (>= 2.0, < 3.1) - ruby2_keywords (>= 0.0.4) - faraday-net_http (3.0.2) - ffi (1.15.5) - ffi (1.15.5-x64-mingw32) + execjs (2.10.0) + faraday (2.12.0) + faraday-net_http (>= 2.0, < 3.4) + json + logger + faraday-net_http (3.3.0) + net-http + ffi (1.17.0-aarch64-linux-gnu) + ffi (1.17.0-aarch64-linux-musl) + ffi (1.17.0-arm-linux-gnu) + ffi (1.17.0-arm-linux-musl) + ffi (1.17.0-arm64-darwin) + ffi (1.17.0-x86-linux-gnu) + ffi (1.17.0-x86-linux-musl) + ffi (1.17.0-x86_64-darwin) + ffi (1.17.0-x86_64-linux-gnu) + ffi (1.17.0-x86_64-linux-musl) forwardable-extended (2.6.0) - gemoji (3.0.1) - github-pages (228) - github-pages-health-check (= 1.17.9) - jekyll (= 3.9.3) - jekyll-avatar (= 0.7.0) - jekyll-coffeescript (= 1.1.1) - jekyll-commonmark-ghpages (= 0.4.0) - jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.15.1) + gemoji (4.1.0) + github-pages (232) + github-pages-health-check (= 1.18.2) + jekyll (= 3.10.0) + jekyll-avatar (= 0.8.0) + jekyll-coffeescript (= 1.2.2) + jekyll-commonmark-ghpages (= 0.5.1) + jekyll-default-layout (= 0.1.5) + jekyll-feed (= 0.17.0) jekyll-gist (= 1.5.0) - jekyll-github-metadata (= 2.13.0) + jekyll-github-metadata (= 2.16.1) jekyll-include-cache (= 0.2.1) jekyll-mentions (= 1.6.0) jekyll-optional-front-matter (= 0.3.2) @@ -69,30 +89,32 @@ GEM jekyll-theme-tactile (= 0.2.0) jekyll-theme-time-machine (= 0.2.0) jekyll-titles-from-headings (= 0.5.3) - jemoji (= 0.12.0) - kramdown (= 2.3.2) + jemoji (= 0.13.0) + kramdown (= 2.4.0) kramdown-parser-gfm (= 1.1.0) liquid (= 4.0.4) mercenary (~> 0.3) minima (= 2.5.1) - nokogiri (>= 1.13.6, < 2.0) - rouge (= 3.26.0) + nokogiri (>= 1.16.2, < 2.0) + rouge (= 3.30.0) terminal-table (~> 1.4) - github-pages-health-check (1.17.9) + webrick (~> 1.8) + github-pages-health-check (1.18.2) addressable (~> 2.3) dnsruby (~> 1.60) - octokit (~> 4.0) - public_suffix (>= 3.0, < 5.0) + octokit (>= 4, < 8) + public_suffix (>= 3.0, < 6.0) typhoeus (~> 1.3) html-pipeline (2.14.3) activesupport (>= 2) nokogiri (>= 1.4) http_parser.rb (0.8.0) - i18n (1.14.1) + i18n (1.14.6) concurrent-ruby (~> 1.0) - jekyll (3.9.3) + jekyll (3.10.0) addressable (~> 2.4) colorator (~> 1.0) + csv (~> 3.0) em-websocket (~> 0.5) i18n (>= 0.7, < 2) jekyll-sass-converter (~> 1.0) @@ -103,27 +125,28 @@ GEM pathutil (~> 0.9) rouge (>= 1.7, < 4) safe_yaml (~> 1.0) - jekyll-avatar (0.7.0) + webrick (>= 1.0) + jekyll-avatar (0.8.0) jekyll (>= 3.0, < 5.0) - jekyll-coffeescript (1.1.1) + jekyll-coffeescript (1.2.2) coffee-script (~> 2.2) - coffee-script-source (~> 1.11.1) + coffee-script-source (~> 1.12) jekyll-commonmark (1.4.0) commonmarker (~> 0.22) - jekyll-commonmark-ghpages (0.4.0) - commonmarker (~> 0.23.7) - jekyll (~> 3.9.0) + jekyll-commonmark-ghpages (0.5.1) + commonmarker (>= 0.23.7, < 1.1.0) + jekyll (>= 3.9, < 4.0) jekyll-commonmark (~> 1.4.0) rouge (>= 2.0, < 5.0) - jekyll-default-layout (0.1.4) - jekyll (~> 3.0) - jekyll-feed (0.15.1) + jekyll-default-layout (0.1.5) + jekyll (>= 3.0, < 5.0) + jekyll-feed (0.17.0) jekyll (>= 3.7, < 5.0) jekyll-gist (1.5.0) octokit (~> 4.2) - jekyll-github-metadata (2.13.0) + jekyll-github-metadata (2.16.1) jekyll (>= 3.4, < 5.0) - octokit (~> 4.0, != 4.4.0) + octokit (>= 4, < 7, != 4.4.0) jekyll-include-cache (0.2.1) jekyll (>= 3.7, < 5.0) jekyll-mentions (1.6.0) @@ -194,42 +217,52 @@ GEM jekyll (>= 3.3, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - jemoji (0.12.0) - gemoji (~> 3.0) + jemoji (0.13.0) + gemoji (>= 3, < 5) html-pipeline (~> 2.2) jekyll (>= 3.0, < 5.0) - kramdown (2.3.2) + json (2.7.4) + kramdown (2.4.0) rexml kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) - listen (3.8.0) + listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) + logger (1.6.1) mercenary (0.3.6) - mini_portile2 (2.8.6) minima (2.5.1) jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) - minitest (5.19.0) - nokogiri (1.16.5) - mini_portile2 (~> 2.8.2) + minitest (5.25.1) + net-http (0.4.1) + uri + nokogiri (1.16.7-aarch64-linux) + racc (~> 1.4) + nokogiri (1.16.7-arm-linux) + racc (~> 1.4) + nokogiri (1.16.7-arm64-darwin) + racc (~> 1.4) + nokogiri (1.16.7-x86-linux) + racc (~> 1.4) + nokogiri (1.16.7-x86_64-darwin) + racc (~> 1.4) + nokogiri (1.16.7-x86_64-linux) racc (~> 1.4) octokit (4.25.1) faraday (>= 1, < 3) sawyer (~> 0.9) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (4.0.7) - racc (1.7.3) + public_suffix (5.1.1) + racc (1.8.1) rb-fsevent (0.11.2) - rb-inotify (0.10.1) + rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.3.6) - strscan - rouge (3.26.0) - ruby2_keywords (0.0.5) + rexml (3.3.9) + rouge (3.30.0) rubyzip (2.3.2) safe_yaml (1.0.5) sass (3.7.4) @@ -240,25 +273,33 @@ GEM sawyer (0.9.2) addressable (>= 2.3.5) faraday (>= 0.17.3, < 3) - simpleidn (0.2.1) - unf (~> 0.1.4) - strscan (3.1.0) + securerandom (0.3.1) + simpleidn (0.2.3) terminal-table (1.8.0) unicode-display_width (~> 1.1, >= 1.1.1) - typhoeus (1.4.0) + typhoeus (1.4.1) ethon (>= 0.9.0) tzinfo (2.0.6) concurrent-ruby (~> 1.0) - unf (0.1.4) - unf_ext - unf_ext (0.0.8.2) - unf_ext (0.0.8.2-x64-mingw32) unicode-display_width (1.8.0) - webrick (1.8.1) + uri (0.13.1) + webrick (1.8.2) PLATFORMS - ruby - x64-mingw32 + aarch64-linux + aarch64-linux-gnu + aarch64-linux-musl + arm-linux + arm-linux-gnu + arm-linux-musl + arm64-darwin + x86-linux + x86-linux-gnu + x86-linux-musl + x86_64-darwin + x86_64-linux + x86_64-linux-gnu + x86_64-linux-musl DEPENDENCIES github-pages @@ -266,4 +307,4 @@ DEPENDENCIES webrick BUNDLED WITH - 2.1.4 + 2.5.22 diff --git a/docs/SettingUp.md b/docs/SettingUp.md index 9f832a19674..e3677508b8d 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -6,7 +6,6 @@ title: Setting up and getting started * Table of Contents {:toc} - -------------------------------------------------------------------------------------------------------------------- ## Setting up the project in your computer @@ -19,12 +18,16 @@ Follow the steps in the following guide precisely. Things will not work out if y First, **fork** this repo, and **clone** the fork into your computer. If you plan to use Intellij IDEA (highly recommended): -1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to 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. **Verify the setup**: - 1. Run the `seedu.address.Main` and try a few commands. - 1. [Run the tests](Testing.md) to ensure they all pass. + +1. **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**. +2. **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. +3. **Verify the setup**: + 1. Run the `spleetwaise.commons.Main` and try a few commands. + 2. [Run the tests](Testing.md) to ensure they all pass. -------------------------------------------------------------------------------------------------------------------- @@ -32,24 +35,40 @@ If you plan to use Intellij IDEA (highly recommended): 1. **Configure the coding style** - If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match ours. + If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code + style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match + ours.
- e.g. `seedu.address.commons.StringUtilTest` + e.g. `spleetwaise.commons.util.StringUtilTest` 1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).
- e.g. `seedu.address.storage.StorageManagerTest` + e.g. `spleetwaise.commons.storage.StorageManagerTest` 1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
- e.g. `seedu.address.logic.LogicManagerTest` + e.g. `spleetwaise.commons.logic.LogicManagerTest` diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 84b4ddc4e40..874462407eb 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,7 +3,7 @@ layout: page title: User Guide --- -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. +SpleetWaise builds on [AddressBook Level 3 (AB3)](https://se-education.org/addressbook-level3/), **a desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still offering the benefits of a Graphical User Interface (GUI). Designed to streamline expense tracking for students, SpleetWaise makes it easy to record and monitor both personal and shared expenses with contacts saved in the address book. With features to keep track of balances with friends, it eliminates the confusion often associated with managing shared costs, providing a clear, organised view of who has owes what. If you can type fast, SpleetWaise lets you handle your contact and expense management tasks more efficiently than traditional GUI apps, offering students a stress-free way to manage their expenses and shared balances with contacts. * Table of Contents {:toc} @@ -14,28 +14,31 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo 1. Ensure you have Java `17` or above installed in your Computer. -1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases). +2. Download the latest `.jar` file from [here](https://github.com/AY2425S1-CS2103-F13-1/tp/releases). -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. +3. Copy the file to the folder you want to use as the _home folder_ for SpleetWaise. -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.
+4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar spleetwaise-[version].jar` + command to run the application (*replace `[version]` with the release version you chose, for example, 1.5).
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
 -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
+5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will + open the help window.
Some example commands you can try: - * `list` : Lists all contacts. + * `list` : Lists all contacts. - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. + * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` + to the Address Book. - * `delete 3` : Deletes the 3rd contact shown in the current list. + * `delete 3` : Deletes the 3rd contact shown in the current list. - * `clear` : Deletes all contacts. + * `clear` : Deletes all contacts. - * `exit` : Exits the app. + * `exit` : Exits the app. -1. Refer to the [Features](#features) below for details of each command. +6. Refer to the [Features](#features) below for details of each command. -------------------------------------------------------------------------------------------------------------------- @@ -57,57 +60,154 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo * Parameters can be in any order.
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
+* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be + ignored.
e.g. if the command specifies `help 123`, it will be interpreted as `help`. -* 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. +* 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`
-Shows a message explaning how to access the help page.
+Shows a message explaining how to access the help page.
Format: `help`
-
### Adding a person: `add`
Adds a person to the address book.
Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
+* The `NAME` input allows a wide variety of characters but has some restrictions. Below are examples of valid and invalid inputs.
+ * Valid inputs include those that contain **letters, numbers, spaces, and certain special characters** such as apostrophes (`'`), hyphens (`-`), periods (`.`), slashes (`/`), ampersands (`&`), quotation marks (`"`), and parentheses (`()`).
+ - `John Doe` (letters and space)
+ - `Betsy O'Connor` (apostrophe)
+ - `Jean-Luc` (hyphen)
+ - `J.P. Morgan` (period)
+ - `John s/o Tan` (slash)
+ - `Anne-Marie & Sons` (ampersand and hyphen)
+ - `John "Johnny" Doe` (quotation marks)
+ - `Richard (Rick) Roe` (parentheses)
+ * Invalid inputs include those that contain special characters such as `*`, `@`, `#`, `!`, `^`, `%`, `$`, or any characters from Arabic, or Latin scripts like `Æ` or Chinese characters.
+ - `peter*` (contains `*`)
+ - `john@doe` (contains `@`)
+ - `王小明` (non-Latin characters like Chinese)
+ - `X Æ A-12` (non-Latin characters like `Æ` or Arabic `عبد العزيز`)
+
+:information_source: **Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the undo.
@@ -228,14 +129,13 @@ The following activity diagram summarizes what happens when a user executes a ne
**Aspect: How undo & redo executes:**
-* **Alternative 1 (current choice):** Saves the entire address book.
- * Pros: Easy to implement.
- * Cons: May have performance issues in terms of memory usage.
+- **Alternative 1 (current choice):** Saves the entire address book.
+ - Pros: Easy to implement.
+ - Cons: May have performance issues in terms of memory usage.
-* **Alternative 2:** Individual command knows how to undo/redo by
- itself.
- * Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
- * Cons: We must ensure that the implementation of each individual command are correct.
+- **Alternative 2:** Individual command knows how to undo/redo by itself.
+ - Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
+ - Cons: We must ensure that the implementation of each individual command are correct.
_{more aspects and alternatives to be added}_
@@ -243,118 +143,124 @@ _{more aspects and alternatives to be added}_
_{Explain here how the data archiving feature will be implemented}_
-
---------------------------------------------------------------------------------------------------------------------
+---
## **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**
+{% include DeveloperGuide/Requirements/index.md %}
-### Product scope
+---
-**Target user profile**:
+## **Appendix: Instructions for manual testing**
-* 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
+Given below are instructions to test the app manually.
-**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
+
+:information_source: **Note:** These instructions only provide a starting point for testers to work on; testers are expected to do more *exploratory* testing.
+
+### Launch and shutdown
-### User stories
+1. Initial launch
-Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
+ 1. Download the jar file and copy into an empty folder
-| 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 |
+ 2. Launch the app+ Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. -*{More to be added}* +2. Saving window preferences -### Use cases + 1. Resize the window to an optimum size. Move the window to a different location. Close the window. -(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise) + 2. Re-launch the app
+ Expected: The most recent window size and location is retained. -**Use case: Delete a person** +### Local GUI testing -**MSS** +The available gradle tasks are: guiTests, nonGuiTests, allTests. -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 +- guiTests: all tests under `systemtests` package +- nonGuiTests: all tests under `spleetwaise.address`, `spleetwaise.common`, `spleetwaise.transaction` packages +- allTests: guiTests and nonGuiTests, nonGuiTests will be run before guiTests - Use case ends. +As an example, you can run `gradle nonGuiTests` in the gradle terminal for all tests excluding GUI related tests. +You can navigate the gradle terminal by clicking on elephant icon _(Gradle)_ > terminal icon _(Execute Gradle tasks)_. -**Extensions** +### Adding a person -* 2a. The list is empty. +1. Adding a person while all persons are being shown - Use case ends. + 1. Prerequisites: List all persons using the list command. Multiple persons in the list. -* 3a. The given index is invalid. + 2. Test case: `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
+ Expected: Assuming no duplicates, a new contact named John Doe is added to the list. Details of the added contact shown in the status message. - * 3a1. AddressBook shows an error message. + 3. Test case: `add n/ p/ e/ a/`
+ Expected: No person is added. Error details shown in the status message. Status bar remains the same. - Use case resumes at step 2. + 4. Other incorrect add commands to try: `add n/John Doe`, `add p/98765432`, `add e/johnd@example.com`, `add a/John street, block 123, #01-01`
+ Expected: Similar to previous. -*{More to be added}* +### Editing a person -### Non-Functional Requirements +1. Editing a person while all persons are being shown -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. + 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. -*{More to be added}* + 2. Test case: `edit 1 n/Jane Doe`
+ Expected: Assuming no duplicates, first contact's name is changed to Jane Doe. Details of the edited contact shown in the status message. -### Glossary + 3. Test case: `edit 0 n/Jane Doe`
+ Expected: No person is edited. Error details shown in the status message. -* **Mainstream OS**: Windows, Linux, Unix, MacOS -* **Private contact detail**: A contact detail that is not meant to be shared with others + 4. Other incorrect edit commands to try: `edit`, `edit x n/Jane Doe` (where x is larger than the list size), + `edit 1`
+ Expected: Similar to previous. --------------------------------------------------------------------------------------------------------------------- +### Person Synchronization in transaction list -## **Appendix: Instructions for manual testing** +1. Ensuring person details changed are accurately reflected in all views and models. -Given below are instructions to test the app manually. + 1. Prerequisites: List all persons and transactions using the `list` and `listTxn` command. At least one person and one transaction with that person in the list. -
:information_source: **Note:** These instructions only provide a starting point for testers to work on;
-testers are expected to do more *exploratory* testing.
+ 2. Test case: `edit 1 n/New Name` (where `New Name` is the updated name for the person)
+ Expected: The person's name updates in both the address and transaction lists and the UI (assuming no duplicates). -
+### Adding/deleting a remark for a person
-### Launch and shutdown
+1. Adding a remark for a person using the `remark` command while all persons are being shown
-1. Initial launch
+ 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list.
- 1. Download the jar file and copy into an empty folder
+ 2. Test case: `remark 1 r/Likes to swim`+ Expected: The person's name updates in both the address and transaction lists and the UI (assuming no duplicates). -
+ Expected: First contact's remark is updated to "Likes to swim". Details of the updated contact shown in the status message. Timestamp in the status bar is updated. + + 3. Test case: `remark 0 r/Likes to swim`
+ Expected: No person's remark is updated. Error details shown in the status message. Status bar remains the same. - 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. + 4. Other incorrect remark commands to try: `remark`, `remark x r/Likes to swim` (where x is larger than the list size)
+ Expected: Similar to previous. + +2. Deleting a remark for a person using the `remark` command while all persons are being shown -1. Saving window preferences + 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. - 1. Resize the window to an optimum size. Move the window to a different location. Close the window. + 2. Test case: `remark 1 r/`
+ Expected: First contact's remark is deleted. Details of the contact shown in the status message. - 1. Re-launch the app by double-clicking the jar file.
- Expected: The most recent window size and location is retained. + 3. Test case: `remark 1`
+ Expected: First contact's remark is deleted (shortcut for users intending to empty remark). Details of the contact shown in the status message. -1. _{ more test cases … }_ + 4. Test case: `remark 0 r/`
+ Expected: No person's remark is deleted. Error details shown in the status message. ### Deleting a person @@ -362,21 +268,150 @@ testers are expected to do more *exploratory* testing. 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + 2. Test case: `delete 1`
+ Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. + + 3. Test case: `delete 0`
+ Expected: No person is deleted. Error details shown in the status message. + + 4. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Adding a transaction + +1. Adding a transaction while all transactions are being shown with minimally 1 person in address book + + 1. Prerequisites: List all persons and transactions using the `list` and `listTxn` command. At least one person in the address book list and multiple transactions in the list + + 2. Test cases: `addTxn 1 amt/12.3 desc/John owes me for dinner`
+ Expected: Assuming no duplicates, a new transaction related to the person in the first index of the address book is added to the list along with description of it. The amount reflected in the transaction is displayed green in the transaction panel to signify that _the user_ is owed. The date of the transaction displays the current day. No categories to be displayed. Details of the added transaction is shown in the status message. + + 3. Test cases: `addTxn 1 amt/-12.3 desc/I owe John for dinner date/10102024`
+ Expected: Assuming no duplicates, a new transaction related to the person in the first index of the address book is added to the list along with description of it. The amount reflected in the transaction is displayed red in the transaction panel to signify that _the user_ owes. The date of the transaction displays `10 Oct 2024`. No categories to be displayed. Details of the added transaction is shown in the status message. + + 4. Test cases: `addTxn 1 amt/12.3 desc/John owes me for dinner cat/FOOD`
+ Expected: Assuming no duplicates, a new transaction related to the person in the first index of the address book is added to the list along with description of it. The amount reflected in the transaction is displayed green in the transaction panel to signify that you are owed. The date of the transaction displays the current day. Category of `FOOD` is displayed. Details of the added transaction is shown in the status message. + + 5. Test cases: `addTxn 1 amt/-12.3 desc/I owe John for dinner date/10102024` when identical transaction exists
+ Expected: No transaction is added. Error details shown in the status message with `Transaction already exists in the transaction book`. Status bar remains the same. + + 6. Test cases: `addTxn 0 amt/ desc/ date/ cat/`
+ Expected: No transaction is added. Error details shown in the status message. Status bar remains the same. + + 7. Other incorrect `addTxn` commands to try: `addTxn 1`, `addTxn amt/1.234`, `addTxn desc/dinner`, `addTxn date/10102024`, `addTxn cat/FOOD`
+ Expected: Similar to previous. + +### Marking a transaction as done + +1. Marking a transaction as done while all transactions are being shown. + + 1. Prerequisites: List all transactions using the `listTxn` command. One transaction is in the list. + + 2. Test cases: `markDone 1`
+ Expected: The first transaction is marked as done. A "done" icon appears next to the person's name for that transaction. Details of the updated transaction shown in the status message. + + 3. Test cases: `markDone 1` (Assumes transaction 1 is already marked)
+ Expected: No change in transaction status. The "done" icon remains. A status message confirms that the transaction is already marked. + + 4. Test cases: `markDone 0`
+ Expected: No transaction is marked. Error details shown in the status message. + + 5. Other incorrect `markDone` commands to try: `markDone`, `markDone x` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Reverting a done transaction back to undone + +1. Reverting a done transaction back to undone while all transactions are being shown. + + 1. Prerequisites: List all transactions using the `listTxn` command. One transaction is in the list. + + 2. Test cases: `markUndone 1`
+ Expected: The first transaction is reverted to undone. The existing "done" icon disappears for that transaction. Details of the updated transaction shown in the status message. + + 3. Test cases: `markUndone 1` (Assumes transaction 1 is already undone)
+ Expected: No change in transaction status. The transaction remains to have no "done" icon. A status message confirms that the transaction is already undone. + + 4. Test cases: `markUndone 0`
+ Expected: No transaction is marked. Error details shown in the status message. + + 5. Other incorrect `markUndone` commands to try: `markUndone`, `markUndone x` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Editing a transaction + +1. Editing a transaction while all persons are being shown + + 1. Prerequisites: List all persons and transactions using the `list` and `listTxn` command respectively. Multiple + persons in the list on the left pane. Multiple transactions in the list on the right pane. - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. + 2. Test case: `editTxn 1 amt/1.23`
+ Expected: Assuming no duplicates, first contact's amount is changed to $1.23. Details of the edited transaction shown in the status message. - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ 3. Test case: `editTxn 0 desc/Updated description`
+ Expected: No transaction is edited. Error details shown in the status message. + + 4. Other incorrect edit commands to try: `editTxn`, `edit x amt/1.23` (where x is larger than the list size), `editTxn 1`
Expected: Similar to previous. -1. _{ more test cases … }_ +### Filter Reuse in Transaction List + +1. Maintaining the current filter state when transactions are modified. + + 1. Prerequisites: List all transactions using the `listTxn` command. Apply a filter via `filterTxn` command to the list (e.g., filtering by description containing "mac"). + + 2. Test cases: `addTxn 1 amt/12.3 desc/John owes me for dinner`
+ Expected: The new transaction appears in the filtered list while preserving the existing filter. Details of the new transaction shown in the status message. + + 3. Test cases: `editTxn 1 d/happy meal at mac` (Assumes transaction 1 description is "KFC")
+ Expected: The updated transaction appears in the filtered list while preserving the existing filter. Details of the updated transaction shown in the status message. + + 4. Test cases: `editTxn 1 d/KFC` (Assumes transaction 1 description is "fries at mac")
+ Expected: The updated transaction disappears in the filtered list while preserving the existing filter. Details of the updated transaction shown in the status message. + + 5. Test cases: `markDone 1`, `markUndone 1` (Assumes transaction 1 description is "fries at mac")
+ Expected: The transaction done icon updated in the filtered list while preserving the existing filter. Details of the updated transaction shown in the status message. + +### Filtering the transaction list. + +1. Filtering the transaction list while all persons are being shown + + 1. Prerequisites: List all persons and transactions using the `list` and `listTxn` command respectively. Multiple + persons in the list on the left pane. Multiple transactions in the list on the right pane. + + 2. Test case: `filterTxn 1`
+ Expected: Transaction list will be filtered by the person corresponding to the displayed index 1 in the person + list. + + 3. Test case: `filterTxn 1 amt/1.23`
+ Expected: Transaction list will show transactions related to the person corresponding to the displayed index 1 + in the person list with amount $1.23. + + 4. Test case: `filterTxn 0`
+ Expected: Current displayed transaction list will remain the same. Error details shown in the status message. + + 5. Other incorrect edit commands to try: `filterTxn desc/`, `filterTxn x` (where x is larger than the list size), + `filterTxn amt/1.222`
+ Expected: Similar to previous. + +### Default Behavior on App Startup + +1. Verifying filter state upon app initialization. + + 1. Prerequisites: At least one done transaction and one undone transaction in the list. + + 2. Test cases: Initial Filter on App Startup
+ Expected: The list displays all transactions (both done and undone) by default when the app starts. ### Saving data 1. Dealing with missing/corrupted data files - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ + 1. Prerequisites: Multiple persons in `addressbook.json` and multiple transactions in `transactionbook.json` data files.
+ + 2. Test cases: Missing `name` field in `addressbook.json` data file
+ Simulation: Remove the `name` field from a person entry in the JSON file, then start the app.
+ Expected: The person is discarded and not loaded to the app, with log message `WARNING: Address book is possibly corrupted: Person's Name field is missing! Ignoring corrupted person.`. If the corrupted person has any related transactions in the transaction book, they will be discarded accordingly with log message `WARNING: Transaction book is possibly corrupted: Person with id [Person-ID] not found! Ignoring corrupted transactions.` - `[Person-ID]` will be the respective person ID of the corrupted person. -1. _{ more test cases … }_ + 3. Test cases: Missing `isDone` field in `transactionbook.json` data file
+ Simulation: Remove the `isDone` field from a transaction entry in the JSON file, then start the app.
+ Expected: The transaction loads as undone by default. Upon closing the app, the transaction is saved as undone in the JSON file. diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index bac5eb36d35..73be7b0a58a 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,48 +1,68 @@ GEM remote: https://rubygems.org/ specs: - activesupport (7.0.7.2) - concurrent-ruby (~> 1.0, >= 1.0.2) + activesupport (7.2.1.2) + base64 + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb i18n (>= 1.6, < 2) + logger (>= 1.4.2) minitest (>= 5.1) - tzinfo (~> 2.0) - addressable (2.8.4) - public_suffix (>= 2.0.2, < 6.0) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + base64 (0.2.0) + bigdecimal (3.1.8) coffee-script (2.4.1) coffee-script-source execjs - coffee-script-source (1.11.1) + coffee-script-source (1.12.2) colorator (1.1.0) commonmarker (0.23.10) - concurrent-ruby (1.2.2) - dnsruby (1.70.0) + concurrent-ruby (1.3.4) + connection_pool (2.4.1) + csv (3.3.0) + dnsruby (1.72.2) simpleidn (~> 0.2.1) + drb (2.2.1) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) ethon (0.16.0) ffi (>= 1.15.0) eventmachine (1.2.7) - eventmachine (1.2.7-x64-mingw32) - execjs (2.8.1) - faraday (2.7.5) - faraday-net_http (>= 2.0, < 3.1) - ruby2_keywords (>= 0.0.4) - faraday-net_http (3.0.2) - ffi (1.15.5) - ffi (1.15.5-x64-mingw32) + execjs (2.10.0) + faraday (2.12.0) + faraday-net_http (>= 2.0, < 3.4) + json + logger + faraday-net_http (3.3.0) + net-http + ffi (1.17.0-aarch64-linux-gnu) + ffi (1.17.0-aarch64-linux-musl) + ffi (1.17.0-arm-linux-gnu) + ffi (1.17.0-arm-linux-musl) + ffi (1.17.0-arm64-darwin) + ffi (1.17.0-x86-linux-gnu) + ffi (1.17.0-x86-linux-musl) + ffi (1.17.0-x86_64-darwin) + ffi (1.17.0-x86_64-linux-gnu) + ffi (1.17.0-x86_64-linux-musl) forwardable-extended (2.6.0) - gemoji (3.0.1) - github-pages (228) - github-pages-health-check (= 1.17.9) - jekyll (= 3.9.3) - jekyll-avatar (= 0.7.0) - jekyll-coffeescript (= 1.1.1) - jekyll-commonmark-ghpages (= 0.4.0) - jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.15.1) + gemoji (4.1.0) + github-pages (232) + github-pages-health-check (= 1.18.2) + jekyll (= 3.10.0) + jekyll-avatar (= 0.8.0) + jekyll-coffeescript (= 1.2.2) + jekyll-commonmark-ghpages (= 0.5.1) + jekyll-default-layout (= 0.1.5) + jekyll-feed (= 0.17.0) jekyll-gist (= 1.5.0) - jekyll-github-metadata (= 2.13.0) + jekyll-github-metadata (= 2.16.1) jekyll-include-cache (= 0.2.1) jekyll-mentions (= 1.6.0) jekyll-optional-front-matter (= 0.3.2) @@ -69,30 +89,32 @@ GEM jekyll-theme-tactile (= 0.2.0) jekyll-theme-time-machine (= 0.2.0) jekyll-titles-from-headings (= 0.5.3) - jemoji (= 0.12.0) - kramdown (= 2.3.2) + jemoji (= 0.13.0) + kramdown (= 2.4.0) kramdown-parser-gfm (= 1.1.0) liquid (= 4.0.4) mercenary (~> 0.3) minima (= 2.5.1) - nokogiri (>= 1.13.6, < 2.0) - rouge (= 3.26.0) + nokogiri (>= 1.16.2, < 2.0) + rouge (= 3.30.0) terminal-table (~> 1.4) - github-pages-health-check (1.17.9) + webrick (~> 1.8) + github-pages-health-check (1.18.2) addressable (~> 2.3) dnsruby (~> 1.60) - octokit (~> 4.0) - public_suffix (>= 3.0, < 5.0) + octokit (>= 4, < 8) + public_suffix (>= 3.0, < 6.0) typhoeus (~> 1.3) html-pipeline (2.14.3) activesupport (>= 2) nokogiri (>= 1.4) http_parser.rb (0.8.0) - i18n (1.14.1) + i18n (1.14.6) concurrent-ruby (~> 1.0) - jekyll (3.9.3) + jekyll (3.10.0) addressable (~> 2.4) colorator (~> 1.0) + csv (~> 3.0) em-websocket (~> 0.5) i18n (>= 0.7, < 2) jekyll-sass-converter (~> 1.0) @@ -103,27 +125,28 @@ GEM pathutil (~> 0.9) rouge (>= 1.7, < 4) safe_yaml (~> 1.0) - jekyll-avatar (0.7.0) + webrick (>= 1.0) + jekyll-avatar (0.8.0) jekyll (>= 3.0, < 5.0) - jekyll-coffeescript (1.1.1) + jekyll-coffeescript (1.2.2) coffee-script (~> 2.2) - coffee-script-source (~> 1.11.1) + coffee-script-source (~> 1.12) jekyll-commonmark (1.4.0) commonmarker (~> 0.22) - jekyll-commonmark-ghpages (0.4.0) - commonmarker (~> 0.23.7) - jekyll (~> 3.9.0) + jekyll-commonmark-ghpages (0.5.1) + commonmarker (>= 0.23.7, < 1.1.0) + jekyll (>= 3.9, < 4.0) jekyll-commonmark (~> 1.4.0) rouge (>= 2.0, < 5.0) - jekyll-default-layout (0.1.4) - jekyll (~> 3.0) - jekyll-feed (0.15.1) + jekyll-default-layout (0.1.5) + jekyll (>= 3.0, < 5.0) + jekyll-feed (0.17.0) jekyll (>= 3.7, < 5.0) jekyll-gist (1.5.0) octokit (~> 4.2) - jekyll-github-metadata (2.13.0) + jekyll-github-metadata (2.16.1) jekyll (>= 3.4, < 5.0) - octokit (~> 4.0, != 4.4.0) + octokit (>= 4, < 7, != 4.4.0) jekyll-include-cache (0.2.1) jekyll (>= 3.7, < 5.0) jekyll-mentions (1.6.0) @@ -194,42 +217,52 @@ GEM jekyll (>= 3.3, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - jemoji (0.12.0) - gemoji (~> 3.0) + jemoji (0.13.0) + gemoji (>= 3, < 5) html-pipeline (~> 2.2) jekyll (>= 3.0, < 5.0) - kramdown (2.3.2) + json (2.7.4) + kramdown (2.4.0) rexml kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) - listen (3.8.0) + listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) + logger (1.6.1) mercenary (0.3.6) - mini_portile2 (2.8.6) minima (2.5.1) jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) - minitest (5.19.0) - nokogiri (1.16.5) - mini_portile2 (~> 2.8.2) + minitest (5.25.1) + net-http (0.4.1) + uri + nokogiri (1.16.7-aarch64-linux) + racc (~> 1.4) + nokogiri (1.16.7-arm-linux) + racc (~> 1.4) + nokogiri (1.16.7-arm64-darwin) + racc (~> 1.4) + nokogiri (1.16.7-x86-linux) + racc (~> 1.4) + nokogiri (1.16.7-x86_64-darwin) + racc (~> 1.4) + nokogiri (1.16.7-x86_64-linux) racc (~> 1.4) octokit (4.25.1) faraday (>= 1, < 3) sawyer (~> 0.9) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (4.0.7) - racc (1.7.3) + public_suffix (5.1.1) + racc (1.8.1) rb-fsevent (0.11.2) - rb-inotify (0.10.1) + rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.3.6) - strscan - rouge (3.26.0) - ruby2_keywords (0.0.5) + rexml (3.3.9) + rouge (3.30.0) rubyzip (2.3.2) safe_yaml (1.0.5) sass (3.7.4) @@ -240,25 +273,33 @@ GEM sawyer (0.9.2) addressable (>= 2.3.5) faraday (>= 0.17.3, < 3) - simpleidn (0.2.1) - unf (~> 0.1.4) - strscan (3.1.0) + securerandom (0.3.1) + simpleidn (0.2.3) terminal-table (1.8.0) unicode-display_width (~> 1.1, >= 1.1.1) - typhoeus (1.4.0) + typhoeus (1.4.1) ethon (>= 0.9.0) tzinfo (2.0.6) concurrent-ruby (~> 1.0) - unf (0.1.4) - unf_ext - unf_ext (0.0.8.2) - unf_ext (0.0.8.2-x64-mingw32) unicode-display_width (1.8.0) - webrick (1.8.1) + uri (0.13.1) + webrick (1.8.2) PLATFORMS - ruby - x64-mingw32 + aarch64-linux + aarch64-linux-gnu + aarch64-linux-musl + arm-linux + arm-linux-gnu + arm-linux-musl + arm64-darwin + x86-linux + x86-linux-gnu + x86-linux-musl + x86_64-darwin + x86_64-linux + x86_64-linux-gnu + x86_64-linux-musl DEPENDENCIES github-pages @@ -266,4 +307,4 @@ DEPENDENCIES webrick BUNDLED WITH - 2.1.4 + 2.5.22 diff --git a/docs/SettingUp.md b/docs/SettingUp.md index 9f832a19674..e3677508b8d 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -6,7 +6,6 @@ title: Setting up and getting started * Table of Contents {:toc} - -------------------------------------------------------------------------------------------------------------------- ## Setting up the project in your computer @@ -19,12 +18,16 @@ Follow the steps in the following guide precisely. Things will not work out if y First, **fork** this repo, and **clone** the fork into your computer. If you plan to use Intellij IDEA (highly recommended): -1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to 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. **Verify the setup**: - 1. Run the `seedu.address.Main` and try a few commands. - 1. [Run the tests](Testing.md) to ensure they all pass. + +1. **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**. +2. **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. +3. **Verify the setup**: + 1. Run the `spleetwaise.commons.Main` and try a few commands. + 2. [Run the tests](Testing.md) to ensure they all pass. -------------------------------------------------------------------------------------------------------------------- @@ -32,24 +35,40 @@ If you plan to use Intellij IDEA (highly recommended): 1. **Configure the coding style** - If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match ours. + If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code + style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match + ours.
:bulb: **Tip:**
- Optionally, you can follow the guide [_[se-edu/guides] Using Checkstyle_](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use the CheckStyle within IDEA e.g., to report problems _as_ you write code.
+ Optionally, you can follow the guide [_[se-edu/guides] Using
+ Checkstyle_](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use the CheckStyle within IDEA
+ e.g., to report problems _as_ you write code.
-1. **Set up CI**
+2. **Git Workflow**
+ This project uses
+ the [Feature Branch Flow](https://nus-cs2103-ay2425s1.github.io/website/se-book-adapted/chapters/revisionControl.html#feature-branch-flow)
+ with rules set to protect the `master` branch. PRs are mandatory and at least 1 member requires review.
+
+ > Feature branches are branches being used to develop an individual story. They should be named "
+ > {issue-number}-{summary}" where "{issue-number}" is the issue number corresponding to the feature you are
+ > implementing and "{summary}" is a brief summary of the feature `formatted-like-this`.
+
+3. **Set up CI**
- This project comes with a GitHub Actions config files (in `.github/workflows` folder). When GitHub detects those files, it will run the CI for your project automatically at each push to the `master` branch or to any PR. No set up required.
+ This project comes with a GitHub Actions config files (in `.github/workflows` folder). When GitHub detects those
+ files, it will run the CI for your project automatically at each push to the `master` branch or to any PR. No set up
+ required.
-1. **Learn the design**
+4. **Learn the design**
- When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [AddressBook’s architecture](DeveloperGuide.md#architecture).
+ When you are ready to start coding, we recommend that you get some sense of the overall design by reading
+ about [Spleetwaise’s architecture](DeveloperGuide.md#architecture).
-1. **Do the tutorials**
+5. **Do the tutorials**
These tutorials will help you get acquainted with the codebase.
- * [Tracing code](tutorials/TracingCode.md)
- * [Adding a new command](tutorials/AddRemark.md)
- * [Removing fields](tutorials/RemovingFields.md)
+ * [Tracing code](tutorials/TracingCode.md)
+ * [Adding a new command](tutorials/AddRemark.md)
+ * [Removing fields](tutorials/RemovingFields.md)
diff --git a/docs/Testing.md b/docs/Testing.md
index 8a99e82438a..07d5a48e9fe 100644
--- a/docs/Testing.md
+++ b/docs/Testing.md
@@ -29,8 +29,8 @@ There are two ways to run tests.
This project has three types of tests:
1. *Unit tests* targeting the lowest level methods/classes.- e.g. `seedu.address.commons.StringUtilTest` + e.g. `spleetwaise.commons.util.StringUtilTest` 1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).
- e.g. `seedu.address.storage.StorageManagerTest` + e.g. `spleetwaise.commons.storage.StorageManagerTest` 1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
- e.g. `seedu.address.logic.LogicManagerTest` + e.g. `spleetwaise.commons.logic.LogicManagerTest` diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 84b4ddc4e40..874462407eb 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,7 +3,7 @@ layout: page title: User Guide --- -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. +SpleetWaise builds on [AddressBook Level 3 (AB3)](https://se-education.org/addressbook-level3/), **a desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still offering the benefits of a Graphical User Interface (GUI). Designed to streamline expense tracking for students, SpleetWaise makes it easy to record and monitor both personal and shared expenses with contacts saved in the address book. With features to keep track of balances with friends, it eliminates the confusion often associated with managing shared costs, providing a clear, organised view of who has owes what. If you can type fast, SpleetWaise lets you handle your contact and expense management tasks more efficiently than traditional GUI apps, offering students a stress-free way to manage their expenses and shared balances with contacts. * Table of Contents {:toc} @@ -14,28 +14,31 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo 1. Ensure you have Java `17` or above installed in your Computer. -1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases). +2. Download the latest `.jar` file from [here](https://github.com/AY2425S1-CS2103-F13-1/tp/releases). -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. +3. Copy the file to the folder you want to use as the _home folder_ for SpleetWaise. -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.
+4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar spleetwaise-[version].jar` + command to run the application (*replace `[version]` with the release version you chose, for example, 1.5).
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
 -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
+5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will + open the help window.
Some example commands you can try: - * `list` : Lists all contacts. + * `list` : Lists all contacts. - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. + * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` + to the Address Book. - * `delete 3` : Deletes the 3rd contact shown in the current list. + * `delete 3` : Deletes the 3rd contact shown in the current list. - * `clear` : Deletes all contacts. + * `clear` : Deletes all contacts. - * `exit` : Exits the app. + * `exit` : Exits the app. -1. Refer to the [Features](#features) below for details of each command. +6. Refer to the [Features](#features) below for details of each command. -------------------------------------------------------------------------------------------------------------------- @@ -57,57 +60,154 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo * Parameters can be in any order.
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
+* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be + ignored.
e.g. if the command specifies `help 123`, it will be interpreted as `help`. -* 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. +* 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. +
:bulb: **Tip:**
+A person with an Indian name containing "s/o" denoting "son of" can be added as `add n/John s/o Jason p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
+
+:bulb: **Tip:**
+A person with an Indian name containing "d/o" denoting "daughter of" can be added as `add n/Genevieve d/o Jason p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
+
:bulb: **Tip:**
A person can have any number of tags (including 0)
Examples:
+
* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal`
+### Adding a transaction: `addTxn`
+
+Adds a transaction to the transaction book.
+
+Format: `addTxn INDEX amt/AMOUNT desc/DESCRIPTION [date/DATE] [status/STATUS] [cat/CATEGORY]...`
+
+* The `INDEX` refers to the index of the person currently displayed in the address book panel (as we are adding the transaction related to the person).
+* The `AMOUNT` accepts a decimal number with up to 2 decimal places. A `-` symbol should be added before the number to indicate negative amount, indicating the transaction is one that the user owes the chosen person at the index.
+* The `DESCRIPTION` accepts a string of words with a limit of 120 characters.
+* The `DATE` accepts date formatted in the form `DDMMYYYY` i.e.`10102024`.
+* The `STATUS` accepts case-sensitive string that is either 'Done' or 'Not Done'.
+* The `CATEGORY` accepts non-empty strings that are alphanumeric with spaces. Category will be capitalised automatically.
+
+:exclamation: **Important:** Two identical Transactions with duplicated fields cannot be added into the transaction
+book. The duplicated fields refers to `INDEX`, `AMOUNT`, `DESCRIPTION`, and `DATE` fields where combined it should
+form a unique transaction.+> For consistency and to avoid redundancy, identical transactions with the same details across all fields will not be added to the transaction book. This ensures that each entry remains unique, preventing accidental duplicates and maintaining the clarity of transaction records. If a similar transaction occurs on a different occasion in the same day, we recommend users to tweak the desc field to reflect the specific context.
+> +> For example:
- `addTxn 1 amt/2.50 desc/sean owes me for morning latte`
- `addTxn 1 amt/2.50 desc/sean owes me for afternoon latte` + +:bulb: **Tip:** The index aligns with the address book including when it is filtered.
+:bulb: **Tip:** If the transaction happened on the current day, the date parameter can be omitted.
+:bulb: **Tip:** A person can have any number of categories (including 0)
+:bulb: **Tip:** Positive Amount Transaction indicates someone owes _the user_ an amount.
+:bulb: **Tip:** Negative Amount Transaction indicates _the user_ owes someone an amount.
+:bulb: **Tip:** Categories can be keyed in both lower and upper case without worrying about duplication as it will be capitalised automatically.
+:bulb: **Tip:** By default, a newly created transaction is set as undone - _e.g._ if the transaction is added as `addTxn 1 amt/12.3 desc/John owes me for dinner`, this transaction is not done, John still owes _the user_. + +Examples: + +* `addTxn 1 amt/12.3 desc/John owes me for dinner ` +* `addTxn 1 amt/-24.3 desc/I owe John for dinner date/10102024` +* `addTxn 1 amt/-24.3 desc/I owe John for dinner date/10102024 cat/FOOD` + ### Listing all persons : `list` Shows a list of all persons in the address book. Format: `list` +:bulb: **Tip:** This command can be used to reset the filter applied on the person list caused by a `find` command +operation. + +### Listing all transactions : `listTxn` + +Shows a list of all transactions in the transaction book. + +Format: `listTxn` + +:bulb: **Tip:** This command can be used to reset the filter applied on transaction list caused by a `fitlerTxn` +command operation. + ### Editing a person : `edit` Edits an existing person in the address 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/REMARK] [t/TAG]…` -* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, … +* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. + The index **must be a positive integer** 1, 2, 3, … * At least one of the optional fields must be provided. * Existing values will be updated to the input values. * When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. -* You can remove all the person’s tags by typing `t/` without - specifying any tags after it. +* You can remove all the person’s tags by typing `t/` without specifying any tags after it. +* You can remove the person’s remark by typing `r/` without specifying any remark after it. Examples: -* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively. -* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. + +* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` + and `johndoe@example.com` respectively. +* `edit 2 r/` Edits the 2nd person by deleting the remark. +* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. + +### Editing a transaction : `editTxn ` + +Edits an existing transaction in the transaction book. + +Format: `editTxn INDEX [p/PHONE_NUMBER] [amt/AMOUNT] [desc/DESCRIPTION] [date/DATE] [cat/CATEGORY]...` + +* Edits the transaction at the specified `INDEX`. The index refers to the index number shown in the displayed transaction list. + The index **must be a positive integer** 1, 2, 3, … +* At least one of the optional fields must be provided. +* Existing values will be updated to the input values. +* When editing categories, the existing categories of the transaction will be removed i.e adding of categories is not + cumulative. +* You can remove all the person’s categories by typing `cat/` without specifying any categories after it. +* When editing the person related to the transaction through specifying `[p/PHONE_NUMBER]`, the person with the input phone number must be in the address book. + +:bulb: **Tip:** Status can be edited via `markDone` or `markUndone` command. Support for editing status through `editTxn` may be considered by the devs in future releases. + +Examples: + +* `editTxn 1 p/92624417 desc/Hello world` Edits the 1st transaction to be related to the person with phone number `92624417` and edits the description of the 1st transaction to be `Hello world` (ensure that the phone number is valid, i.e. it exists in the address book). +* `editTxn 2 cat/` Edits the 2nd transaction by removing all existing categories. ### Locating persons by name: `find` @@ -123,10 +223,64 @@ Format: `find KEYWORD [MORE_KEYWORDS]` e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` Examples: + * `find John` returns `john` and `John Doe` * `find alex david` returns `Alex Yeoh`, `David Li`
 +### Filtering transactions: `filterTxn` + +Filter transactions with a any combination of the following parameters: +* the specified person identified by their index in the displayed person list +* and/or amount +* and/or description +* and/or date +* and/or status +* and/or positive/negative amount +* and/or category + +Format: `filterTxn [INDEX] [amt/AMOUNT] [desc/DESCRIPTION] [date/DATE] [status/STATUS] [amtsign/AMOUNT_SIGN] [cat/CATEGORY]` + +* The command requires at least one of the above optional prefixes to be provided. +* As more prefixes are provided, the filter becomes more specific. +* The `INDEX` refers to the index number shown in the displayed person list. + The index **must be a positive integer** 1, 2, 3, … +* The `AMOUNT` accepts a decimal number with up to 2 decimal places. A `-` symbol should be added before the number to indicate negative amount, indicating the transaction is one that the user owes the chosen person at the index. Results will display transactions with the exact amount if it exists. +* The `DATE` accepts date formatted in the form `DDMMYYYY` i.e.`10102024`. +* The `DESCRIPTION` accepts a string of words. + * The description filter is case-insensitive. e.g `hans` will match `Hans` +* The `STATUS` accepts either `Done` or `Not Done` to indicate filtering for transactions that are done or not done. +* The `AMOUNT_SIGN` accepts either `Pos` or `Neg` to indicate filtering for transactions with amount that are + positive or negative respectively. +* The `CATEGORY` accepts non-empty strings that are alphanumeric with spaces. Category will be capitalised automatically. + +Examples:
+ +* Given the example transaction book:
+  +* `filterTxn 1` returns all transactions with the person `Alex Yeoh`. Given that `1` is the index of `Alex Yeoh` in the displayed person list.
+  +* `filterTxn 2 amt/5.5` returns all transactions with the person `Bernice Yu` with amount `5.50`. Given that `2` is the index of `Bernice Yu` in the displayed person list.
+  + +### Adding/Deleting Remarks for a person : `remark` + +Add/Delete remarks for the specified person from the address book. + +Format: `remark INDEX r/REMARK` + +* Add/delete remarks for 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, … + +Examples: + +* `list` followed by `remark 2 r/remark for person 2` adds remarks for the 2nd person in the address book. +* `list` followed by `remark 1 r/` deletes the remarks for the 1st person in the address book. +* `find Betsy` followed by `remark 1 r/remark for betsy` adds remarks for the 1st person in the results of the `find` + command. +* `find Betsy` followed by `remark 1 r/` deletes the remarks for the 1st person in the results of the `find` command. + ### Deleting a person : `delete` Deletes the specified person from the address book. @@ -138,15 +292,76 @@ Format: `delete INDEX` * The index **must be a positive integer** 1, 2, 3, … Examples: + * `list` followed by `delete 2` deletes the 2nd person in the address book. * `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. -### Clearing all entries : `clear` +### Deleting a transaction : `deleteTxn` + +Deletes the specified transaction from the transaction book. + +Format: `deleteTxn INDEX` + +* Deletes the transaction at the specified `INDEX`. +* The `INDEX` refers to the index number shown in the displayed transaction list. +* The index **must be a positive integer** 1, 2, 3, … + +Examples: + +* `listTxn` followed by `delete 2` deletes the 2nd person in the address book. +* `filterTxn 1` followed by `delete 1` deletes the 1st transaction in the results of the `filterTxn` command. -Clears all entries from the address book. +### Clearing all entries of AddressBook and TransactionBook: `clear` + +Clears all entries from the address book and transaction book. Format: `clear` +### Clearing all entries of TransactionBook : `clearTxn` + +Clears all entries from the transaction book. + +Format: `clearTxn` + +### Marking a transaction as done : `markDone` + +Marks a specified transaction from the transaction book as done. + +Format: `markDone INDEX` + +* Marks a transaction at the specified `INDEX` as done. +* The index refers to the index number shown in the displayed transaction list. +* The index **must be a positive integer** 1, 2, 3, … + +
:bulb: **Tip:**
+If a transaction is marked as done, a done icon appears for the transaction in GUI.
+
+
+Examples:
+
+* `listTxn` followed by `markDone 2` marks the 2nd transaction in the transaction book as done.
+* If a done transaction is marked as done again, the transaction remains done.
+
+### Unmarking a transaction as done : `markUndone`
+
+Unmarks a specified transaction from the transaction book as undone.
+
+Format: `markUndone INDEX`
+
+* Unmarks a transaction at the specified `INDEX` as undone.
+* The index refers to the index number shown in the displayed transaction list.
+* The index **must be a positive integer** 1, 2, 3, …
+
+
+:bulb: **Tip:** By default, a new transaction is undone.
+:bulb: **Tip:** If a done transaction is marked as undone, the existing done icon for the transaction in GUI disappears. +
+
+Examples:
+
+* `listTxn` followed by `markUndone 2` unmarks the 2nd transaction in the transaction book as undone.
+* if an undone transaction is marked as undone again, the transaction remains undone.
+
### Exiting the program : `exit`
Exits the program.
@@ -155,15 +370,21 @@ Format: `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.
+AddressBook and Transaction 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.
+- AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`
+- TransactionBook data are saved automatically as a JSON file `[JAR file location]/data/transactionbook.json`
+- Advanced users are welcome to update data directly by editing that data file.
+:bulb: **Tip:** If a done transaction is marked as undone, the existing done icon for the transaction in GUI disappears. +
: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. +If changes to the data file make its format invalid, SpleetWaise will discard corrupted data and start as usual. To avoid data loss, it’s recommended to back up the file before making edits. Person and Transactions with invalid fields will be discarded before the application starts.
+Furthermore, certain edits can cause the AddressBook or TransactionBook 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. +Notably, if SpleetWaise encounter a person/transaction with an existing person/transaction ID in the +address/transaction book, it will be discarded. Similarly, if SpleetWaise encounter a transaction with the same +person ID, amount, date and description as an existing transaction in the transaction book, it will be discarded as +well.
### Archiving data files `[coming in v2.0]`
@@ -175,25 +396,40 @@ _Details coming soon ..._
## FAQ
**Q**: How do I transfer my data to another Computer?-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. +If changes to the data file make its format invalid, SpleetWaise will discard corrupted data and start as usual. To avoid data loss, it’s recommended to back up the file before making edits. Person and Transactions with invalid fields will be discarded before the application starts.
+Furthermore, certain edits can cause the AddressBook or TransactionBook 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. +Notably, if SpleetWaise encounter a person/transaction with an existing person/transaction ID in the +address/transaction book, it will be discarded. Similarly, if SpleetWaise encounter a transaction with the same +person ID, amount, date and description as an existing transaction in the transaction book, it will be discarded as +well.
-**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. +**A**: Install the app in the other computer and before launching the app, copy the `data` folder over to its home folder from your previous SpleetWaise home folder. -------------------------------------------------------------------------------------------------------------------- ## 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. +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 for Address Book + +| Action | Format, Examples | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [r/REMARK] [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 r/James is poor af, do not loan him money 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] [r/REMARK] [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` | +| **Remark** | `remark INDEX r/REMARK` | +| **Help** | `help` | -------------------------------------------------------------------------------------------------------------------- -## 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` +## Command Summary for Transactions + +| Action | Format, Examples | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Add** | `addTxn INDEX amt/AMOUNT desc/DESCRIPTION [date/DATE] [status/STATUS] [cat/CATEGORY]`
e.g., `addTxn 1 amt/9999999999.99 desc/Sean owes me a lot for a plot of land in sentosa date/10102024 status/Done cat/LOAN` | +| **Edit** | `editTxn INDEX [p/PHONE_NUMBER] [amt/AMOUNT] [desc/DESCRIPTION] [date/DATE] [cat/CATEGORY]`
e.g., `editTxn 1 p/99999999 amt/9999999999.99 desc/Sean owes me a lot for a plot of land in sentosa date/10102024 cat/LOAN` | +| **List** | `listTxn` | +| **Filter** | `filterTxn [INDEX] [amt/AMOUNT] [desc/DESCRIPTION] [date/DATE] [status/STATUS] [amtsign/AMOUNT_SIGN]`
e.g. `filterTxn 1` | +| **Clear** | `clearTxn` | +| **Mark Done** | `markDone INDEX`
e.g. `markDone 1` | +| **Mark Undone** | `markUndone INDEX`
e.g. `markUndone 1` | diff --git a/docs/_config.yml b/docs/_config.yml index 6bd245d8f4e..1b318ec46eb 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,4 +1,4 @@ -title: "AB-3" +title: "SpleetWaise" theme: minima header_pages: @@ -8,7 +8,7 @@ header_pages: markdown: kramdown -repository: "se-edu/addressbook-level3" +repository: "AY2425S1-CS2103-F13-1/tp" github_icon: "images/github-icon.png" plugins: diff --git a/docs/_includes/DeveloperGuide/Design/architecture.md b/docs/_includes/DeveloperGuide/Design/architecture.md new file mode 100644 index 00000000000..d81524fcb68 --- /dev/null +++ b/docs/_includes/DeveloperGuide/Design/architecture.md @@ -0,0 +1,58 @@ +
+
+The **_Architecture Diagram_** given above explains the high-level design of the App.
+
+> **Disclaimer:** Our team has decided to add the `spleetwaise.commons` package as a common package for classes
+> that are used by multiple components, in our case, `address` and `transaction`. This is an enhancement for
+> modularity on top of the original design of the AddressBook-Level3 project, which only have a `seedu.address`
+> package. The refactoring is almost 90% complete, and we are working on the remaining 10%.
+
+Given below is a quick overview of main components and how they interact with each other.
+
+**Main components of the architecture**
+
+The app consists of three packages: `address`, `transactions`, and `common`.
+
+- `common` is where the main application logic lives. It contains general classes that are used by multiple components in the app.
+- `address` contains classes related to address book.
+- `transactions` contains classes related to transactions.
+
+:information_source:
+**Package structure:**
+Packages follow this general package structure:
+- **`logic`**: Contains classes related to commands/command parsing.
+- **`model`**: Contains classes for representing data in the app.
+- **`storage`**: Contains classes related to reading and writing data from, and to storage.
+- **`ui`**: Contains classes related to the GUI of the app.
+
+
+**Main application**
+
+The entry-point to the app, **`Main`** (consisting of classes [`Main`](https://github.com/AY2425S1-CS2103-F13-1/tp/blob/master/src/main/java/spleetwaise/commons/Main.java) and [`MainApp`](https://github.com/AY2425S1-CS2103-F13-1/tp/blob/master/src/main/java/spleetwaise/commons/MainApp.java)), lives in the `common` package, and is in charge of managing the app's lifecycle.
+
+- At app launch, it initializes the other components in the correct sequence, and connects them up with each other.
+- At shut down, it shuts down the other components and invokes cleanup methods where necessary.
+
+The bulk of the app's work is done by the following four components:
+
+- [**`Ui`**](#ui-component): The UI of the App.
+- [**`Logic`**](#logic-component): The command executor.
+- [**`Model`**](#model-component): Holds the data of the App in memory.
+- [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk.
+
+**How the architecture components interact with each other**
+
+The _Sequence Diagram_ below shows how the components interact with each other for the scenario where the user issues the command `delete 1`.
+
++- **`logic`**: Contains classes related to commands/command parsing.
+- **`model`**: Contains classes for representing data in the app.
+- **`storage`**: Contains classes related to reading and writing data from, and to storage.
+- **`ui`**: Contains classes related to the GUI of the app.
+
+
+Each of the four main components (also shown in the diagram above),
+
+- defines its _API_ in an `interface` with the same name as the Component.
+- implements its functionality using a concrete `{Component Name}Manager` class (which follows the corresponding API `interface` mentioned in the previous point.
+
+For example, the `Logic` component defines its API in the `Logic.java` interface and implements its functionality using the `LogicManager.java` class which follows the `Logic` interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.
+
+
+
+The sections below give more details of each component.
diff --git a/docs/_includes/DeveloperGuide/Design/logic.md b/docs/_includes/DeveloperGuide/Design/logic.md
new file mode 100644
index 00000000000..a3605f3313c
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Design/logic.md
@@ -0,0 +1,41 @@
+**API** : [`Logic.java`](https://github.com/AY2425S1-CS2103-F13-1/tp/blob/master/src/main/java/spleetwaise/commons/logic/Logic.java)
+
+Here's a (partial) class diagram of the `Logic` component:
+
+
+
+The sequence diagram below illustrates the interactions within the `Logic` component, taking `execute("delete 1")` API call as an example.
+
+
+
+:information_source: **Note:** The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.
+
+
+#### Dual-parser setup
+How the `Logic` component works:
+
+1. When `Logic` is called upon to execute a command, it will first check whether the command is known by the `AddressBookParser`:
+
+ 1.1. **It is first passed to an `AddressBookParser` object which will attempt to parse it.** If there is a matching command, it creates a parser that matches the command (e.g., `DeleteCommandParser`) and uses it to parse the command.
+
+ 1.2. **If there is no matching command, `Logic` will try to parse it with a `TransactionParser`.** If there is a matching command, a similar thing happens as with `AddressBookParser`. The partial sequence diagram below illustrates this case clearly:
+
+ 
+
+2. This ultimately results in a non-null `Command` object (more precisely, an object of one of its subclasses e.g., `DeleteCommand`) which is executed by the `LogicManager`.
+
+3. The command can communicate with the `Model` when it is executed (e.g. to delete a person).+ + Note that although this is shown as a single step in the diagram above (for simplicity), in the code it can take several interactions (between the command object and the `Model`) to achieve. + +4. The result of the command execution is encapsulated as a `CommandResult` object which is returned back from `Logic`. + +Here are the other classes in `Logic` (omitted from the class diagram above) that are used for parsing a user command: + +
+
+How the parsing works:
+
+- When called upon to parse a user command, the `AddressBookParser` or `TransactionParser` class creates a respective `AbCommandParser` (`Ab` is a placeholder for some specific address book command name e.g., `AddCommandParser`), which uses the other classes shown above to parse the user command and create a `AbCommand` object (e.g., `AddCommand`) which the `AddressBookParser` returns back as a `Command` object. Likewise for `TransactionParser` and `TbCommand`s.
+
+- All `AbCommandParser` and `TbCommandParser` classes (e.g., `AddCommandParser`, `DeleteCommandParser`, ...) inherit from a common `Parser` interface so that they can be treated similarly where possible e.g, during testing.
diff --git a/docs/_includes/DeveloperGuide/Design/model.md b/docs/_includes/DeveloperGuide/Design/model.md
new file mode 100644
index 00000000000..9b9f3e0c802
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Design/model.md
@@ -0,0 +1,44 @@
+#### `AddressBookModel`
+
+**API** : [`AddressBookModel.java`](https://github.com/AY2425S1-CS2103-F13-1/tp/blob/master/src/main/java/spleetwaise/address/model/AddressBookModel.java)
+
+
+
+The `AddressBookModel` component:
+
+- stores the address book data i.e., all `Person` objects (which are contained in a `UniquePersonList` object).
+- stores the currently 'selected' `Person` objects (e.g., results of a search query) as a separate _filtered_ list which is exposed to outsiders as an unmodifiable `ObservableList:information_source: **Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.
+ +
+
+
+
+#### `TransactionBookModel`
+
+**API** : [`TransactionBookModel.java`](https://github.com/AY2425S1-CS2103-F13-1/tp/blob/master/src/main/java/spleetwaise/transaction/model/TransactionBookModel.java)
+
++ +
+
+
+
+- stores the transaction book data i.e., all `Transaction` objects (which are contained in a `ObservableList
+
+The `CommonModel` component:
+
+- stores a `UserPref` object that represents the user’s preferences. This is exposed to the outside as a `ReadOnlyUserPref` objects.
+
+#### `CommonModelManager`
+
+Singleton `CommonModel` class. The singleton instance of this class contains an instance of both `AddressBookModel` and `TransactionBookModel`. The singleton instance acts as a facade, exposing the APIs of both `AddressBookModel` and `TransactionBookModel`.
+
+Certain transaction-related features need access to data from both the address and transaction book from different areas of the codebase. For this reason, we decided to go with the `CommonModelManager` class design described above.
diff --git a/docs/_includes/DeveloperGuide/Design/storage.md b/docs/_includes/DeveloperGuide/Design/storage.md
new file mode 100644
index 00000000000..ef133d05de0
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Design/storage.md
@@ -0,0 +1,9 @@
+**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java)
+
+
+
+The `Storage` component,
+
+* can save address book data, transaction book data and user preference data in JSON format, and read them back into corresponding objects.
+* inherits from `AddressBookStorage`, `TransactionBookStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed).
+* depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`)
diff --git a/docs/_includes/DeveloperGuide/Design/ui.md b/docs/_includes/DeveloperGuide/Design/ui.md
new file mode 100644
index 00000000000..cb6da146759
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Design/ui.md
@@ -0,0 +1,13 @@
+The **API** of this component is specified in [`Ui.java`](https://github.com/AY2425S1-CS2103-F13-1/tp/blob/master/src/main/java/spleetwaise/commons/ui/Ui.java)
+
+
+
+The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.
+
+The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/AY2425S1-CS2103-F13-1/tp/blob/master/src/main/java/spleetwaise/commons/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/AY2425S1-CS2103-F13-1/tp/blob/master/src/main/resources/view/MainWindow.fxml)
+
+The `UI` component,
+
+- executes user commands using the `Logic` component.
+- listens for changes to `Model` data so that the UI can be updated with the modified data.
+- keeps a reference to the `Logic` component, because the `UI` relies on the `Logic` to execute commands.
diff --git a/docs/_includes/DeveloperGuide/Requirements/00_product_scope.md b/docs/_includes/DeveloperGuide/Requirements/00_product_scope.md
new file mode 100644
index 00000000000..c9be1dade9f
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Requirements/00_product_scope.md
@@ -0,0 +1,12 @@
+### Product scope
+
+**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
+- is a student with a need track the transactions made on a daily basis due to frequent splitting of bills with saved contacts
+
+**Value proposition**: Simplifies expense tracking for students, making it easy to split and manage shared costs with clarity and peace of mind.
diff --git a/docs/_includes/DeveloperGuide/Requirements/01_user_stories.md b/docs/_includes/DeveloperGuide/Requirements/01_user_stories.md
new file mode 100644
index 00000000000..5c75491be8d
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Requirements/01_user_stories.md
@@ -0,0 +1,24 @@
+### 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 |
+| `* * *` | user | mark and unmark expenses that are paid off/not paid | track which expenses have been settled |
+| `* * *` | user | see how much a specific contact owes | pay them back easily |
+| `*` | user living abroad | handle currency conversion | track expenses accurately when paying in different currencies |
+| `*` | user who frequently travels | tag expenses by event | manage and track costs associated with specific activities or trips |
+| `* * *` | user | view a summary of all expenses and balances | quickly see who owes what and who has overpaid |
+| `* *` | student tight on budget | set limits on certain categories | better manage my spendings |
+| `* *` | user | access frequently contacted people quickly | record a transaction in a short amount of time |
+| `* *` | user | create templates | add transactions quicker |
+| `* * *` | user | set up recurring transactions | automate my transactions |
+| `* * *` | student | generate a summary report of all expenses | share it with the group and settle payments |
+| `* *` | user | detect duplicate expenses | avoid accidentally double-tracking a payment |
+| `* *` | student managing multiple categories | tag expenses by category | organize and search for them easily later |
diff --git a/docs/_includes/DeveloperGuide/Requirements/02_use_cases.md b/docs/_includes/DeveloperGuide/Requirements/02_use_cases.md
new file mode 100644
index 00000000000..ddb423a2c44
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Requirements/02_use_cases.md
@@ -0,0 +1,101 @@
+### Use cases
+
+(For all use cases below, the **System** is `SpleetWaise` and the **Actor** is the `user`, unless specified
+otherwise)
+
+**UC01 - View Usage Instructions**
+
+Actor: New User
+
+**MSS**
+1. The new user clicks on "Help" at top bar of the application.
+2. The system displays usage instructions in a browser.
+3. The user reviews the instructions.
+
+**Extensions**
+- **2a.** The user can switch between different sections of the instructions (e.g., FAQs, How-to sections, etc.).
+
+---
+
+**UC02 - Add a New Person**
+
+**MSS**
+1. A user request to add a new person with required details (e.g., name, email, phone number, address).
+2. The system validates the input (e.g., checks for valid email format, non-empty fields).
+3. The system saves the new person to the address book and displays a success message.
+4. The new person is added to the list.
+
+**Extensions**
+- **4a.** The system detects an invalid email format or phone number.
+ - 4a1. The system shows an error message.
+ - 4a2. The user have to restart from step 1.
+
+---
+
+**UC03 - Delete a person**
+
+**MSS**
+1. A user requests to list persons
+2. The system shows a list of persons
+3. The user requests to delete a specific person in the list
+4. The system deletes the person
+
+**Extensions**
+- **2a.** The list is empty.
+ - 2a1. Use case ends.
+- **3a.** The given index is invalid.
+ - 3a1. AddressBook shows an error message.
+ - 3a2. Use case resumes at step 2.
+
+---
+
+**UC04 - Find a Person by Name**
+
+**MSS**
+1. A user requests to search for a person by first or last name.
+2. The system performs a search and displays matched person's details.
+
+**Extensions**
+- **2a.** The system finds no match.
+ - 2a1. The system displays a message indicating no results.
+ - 2a2. Use case ends.
+- **2b.** The system finds multiple people with identical first or last names.
+ - 2b1. The system displays the lists of found person along with a message for the user to specify which person.
+ - 2b2. The user specify which exact person within the list using index.
+ - 2b3. The system displays the specified person's details.
+ - 2b4. Use case ends.
+
+---
+
+**UC05 - Mark and Unmark Expenses**
+
+**MSS**
+1. A user requests to list expenses
+2. The system shows a list of expenses
+3. The user requests to mark or unmark the selected expense.
+4. The system updates the status of the expense.
+5. The system displays a success message indicating the change.
+
+---
+
+**UC06 - View Person's Owed Amount**
+
+**MSS**
+1. A user requests to list all person.
+2. The user requests to filter transaction by a specific person in the list
+3. The system displays how much the user owe to the selected person.
+
+---
+
+**UC07 - View Summary of Expenses and Balances**
+
+**MSS**
+1. A user chooses to view a summary of all expenses and balances.
+2. The system calculates the total expenses, balances, and individual amounts owed.
+3. The system displays the summary to the user in a tabular format.
+
+**Extensions**
+- **3a.** The user requests a filtered summary (e.g., by date or category).
+ - 3a1. The system filters the summary based on the user’s input.
+ - 3a2. Use case resumes from step 3.
+
diff --git a/docs/_includes/DeveloperGuide/Requirements/03_non_functional_requirements.md b/docs/_includes/DeveloperGuide/Requirements/03_non_functional_requirements.md
new file mode 100644
index 00000000000..8471bb192c3
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Requirements/03_non_functional_requirements.md
@@ -0,0 +1,15 @@
+### 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.
+4. There should be only one type of currency used in all transactions for MVP, defaulted to SGD.
+5. The parameters that related to amount of currency should be dominated in dollars with at most 2 decimal
+ places for cents, delimited by a decimal point (.).
+6. The current format of the JSON format should be compatible with previous version of the software.
+7. The product is used only for expense tracking and consolidation, no real world exchange of money will be carried
+ out.
+8. The user should be able to restore and use a backup save file as part of disaster recovery.
+9. The user should be able to save the save file on a portable device and continue to work on the save file on
+ another computer.
diff --git a/docs/_includes/DeveloperGuide/Requirements/04_glossary.md b/docs/_includes/DeveloperGuide/Requirements/04_glossary.md
new file mode 100644
index 00000000000..842d2ca9ddf
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Requirements/04_glossary.md
@@ -0,0 +1,11 @@
+### Glossary
+
+This Spleetwaise app is a _single-user_ application. Transactions and total balances are relative to _the user_.
+- **Mainstream OS**: Windows, Linux, Unix, macOS
+- **Private contact detail**: A contact detail that is not meant to be shared with others
+- **Transaction**: A Transaction represents a record of a financial interaction between _the user_ and another party (another contact).
+ - **Positive Amount** Transaction: Indicates someone owes _the user_ an amount.
+ - **Negative Amount** Transaction: Indicates _the user_ owes someone an amount.
+ - **Undone** Transaction: By default, a newly created transaction is set as undone - _e.g._ if the transaction is added as `addTxn 1 amt/12.3 desc/John owes me for dinner`, this transaction is not done, John still owes _the user_.
+ - **Done** Transaction: A completed transaction, referring to the previous _e.g._ once John has paid _the user_, he will mark the transaction as done.
+- **Total Balance**: Consists of the _the user_'s total income and total expenses over a period, reflected as "You are owed" and "You owe" in the GUI.
diff --git a/docs/_includes/DeveloperGuide/Requirements/index.md b/docs/_includes/DeveloperGuide/Requirements/index.md
new file mode 100644
index 00000000000..66175058196
--- /dev/null
+++ b/docs/_includes/DeveloperGuide/Requirements/index.md
@@ -0,0 +1,7 @@
+## **Appendix: Requirements**
+
+{% include DeveloperGuide/Requirements/00_product_scope.md %}
+{% include DeveloperGuide/Requirements/04_glossary.md %}
+{% include DeveloperGuide/Requirements/01_user_stories.md %}
+{% include DeveloperGuide/Requirements/02_use_cases.md %}
+{% include DeveloperGuide/Requirements/03_non_functional_requirements.md %}
diff --git a/docs/_sass/minima/_base.scss b/docs/_sass/minima/_base.scss
index 0d3f6e80ced..a4337948f47 100644
--- a/docs/_sass/minima/_base.scss
+++ b/docs/_sass/minima/_base.scss
@@ -288,7 +288,7 @@ table {
text-align: center;
}
.site-header:before {
- content: "AB-3";
+ content: "SpleetWaise";
font-size: 32px;
}
}
diff --git a/docs/diagrams/ArchitectureDiagram.puml b/docs/diagrams/ArchitectureDiagram.puml
index 4c5cf58212e..fc23b3ad491 100644
--- a/docs/diagrams/ArchitectureDiagram.puml
+++ b/docs/diagrams/ArchitectureDiagram.puml
@@ -4,30 +4,51 @@
!include