Merge pull request #38 from varnika1402/master

Update UG & DG
AY2223S2-CS2113-W13-4 · Mar 31, 2023 · b917536 · b917536
2 parents 35ab4b4 + ed65bee
commit b917536
Show file tree

Hide file tree

Showing 3 changed files with 91 additions and 19 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -5,8 +5,10 @@
 + [Acknowledgements](#acknowledgements)
 + [Design](#design)
     * [Architecture](#architecture)
+    * [Parser Component](#parser-component)
     * [UI Component](#ui-component)
     * [Storage Component](#storage-component)
+    * [ExpenseManager Component](#expensemanager-component)
 + [Implementation](#implementation)
 + [Product Scope](#product-scope)
     * [Target User Profile](#target-user-profile)
@@ -92,20 +94,23 @@ create and track their budgets to prevent overspending and adjusting their expen
 
 ## User Stories
 
-| Version | As a ...         | I want to ...                                       | So that I can ...                                                                     |
-|---------|------------------|-----------------------------------------------------|---------------------------------------------------------------------------------------|
-| v1.0    | budgeted student | set a budget limit from which expenses are deducted | track my expenses and avoid overrunning my budget                                     |
-| v1.0    | new user         | add expenses                                        | plan my my expenditure based on the remaining budget                                  |
-| v1.0    | forgetful user   | view my expenses                                    | remove incorrect or outdated entries from my transaction history                      |
-| v1.0    | careless user    | edit my expenses                                    | modify or correct the entries in my transaction history                               |
-| v1.0    | careless user    | delete my expenses                                  | remove incorrect or outdated entries from my transaction history                      |
-| v1.0    | responsible user | sort my expenses by date, name or amount            | have a clear timeline of how my budget has changed from the past to now               |
-| v1.0    | responsible user | add future payments                                 | budget accordingly based on expenses that will happen later on                        |
-| v1.0    | careless user    | edit future payments                                | modify or correct the entries of my upcoming expenses                                 |
-| v1.0    | careless user    | delete future payments                              | remove incorrect entries from my upcoming expenses                                    |
-| v1.0    | responsible user | view upcoming expenses within a period              | stay informed of the upcoming expenses within that time period and budget accordingly |
-| v1.0    | responsible user | pay future payments                                 | complete future payments and add the expenses to transaction history                  |
-| v1.0    | responsible user | remain informed of the remaining budget             | complete my future payments by managing other expenses                                |
+| Version | As a ...              | I want to ...                                       | So that I can ...                                                                      |
+|---------|-----------------------|-----------------------------------------------------|----------------------------------------------------------------------------------------|
+| v1.0    | budgeted student      | set a budget limit from which expenses are deducted | track my expenses and avoid overrunning my budget                                      |
+| v1.0    | new user              | add expenses                                        | plan my my expenditure based on the remaining budget                                   |
+| v1.0    | forgetful user        | view my expenses                                    | remove incorrect or outdated entries from my transaction history                       |
+| v1.0    | careless user         | edit my expenses                                    | modify or correct the entries in my transaction history                                |
+| v1.0    | careless user         | delete my expenses                                  | remove incorrect or outdated entries from my transaction history                       |
+| v1.0    | responsible user      | sort my expenses by date, name or amount            | have a clear timeline of how my budget has changed from the past to now                |
+| v1.0    | responsible user      | add future payments                                 | budget accordingly based on expenses that will happen later on                         |
+| v1.0    | careless user         | edit future payments                                | modify or correct the entries of my upcoming expenses                                  |
+| v1.0    | careless user         | delete future payments                              | remove incorrect entries from my upcoming expenses                                     |
+| v1.0    | responsible user      | view upcoming expenses within a period              | stay informed of the upcoming expenses within that time period and budget accordingly  |
+| v1.0    | responsible user      | pay future payments                                 | complete future payments and add the expenses to transaction history                   |
+| v1.0    | responsible user      | remain informed of the remaining budget             | complete my future payments by managing other expenses                                 |
+| v2.0    | responsible user      | view my expenditure across different categories     | see which category is taking up the most budget                                        |
+| v2.0    | international student | use the app in my home currency                     | conveniently make calculations                                                         |
+| v2.0    | responsible user      | filter expenses by price                            | easily check which expenses cost more than $X amount, which can help with my budgeting |
 
 ## Non-Functional Requirements
 
@@ -274,6 +279,46 @@ insufficient.
    `pay 1`\
    Expected: Terminal shows successful message. The paid future expense is added to list of past expenses.
 
+### Currency
+
+#### Set currency
+
+1. Prerequisites:
+    - Ensure that a valid currency symbol is entered
+2. Test case:
+   `set currency USD`\
+   Expected: Terminal shows successful message. 
+
+#### Get currency
+
+Test case:
+`get currency`\
+Expected: Terminal shows the currently set currency.
+
+### List expenditure by category
+
+Test case:
+`list expenditure by category`\
+Expected: Terminal displays the total expenditure across all categories.
+
+### Filter expenses
+
+#### Expenses above an amount
+1. Prerequisites:
+    - Ensure all fields are entered
+
+2. Test case:
+   `expenses above $/150`\
+   Expected: Terminal displays all expenses of amount greater than the entered amount.
+
+#### Expenses below an amount
+1. Prerequisites:
+    - Ensure all fields are entered
+
+2. Test case:
+   `expenses below $/2000`\
+   Expected: Terminal displays all expenses of amount lower than the entered amount.
+
 ### Shutdown
 
 After the testing is done, type the command `bye` to exit the program\

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -10,8 +10,11 @@ Money Master is a Command Line Interface (CLI) based desktop application which w
     + [Edit Expense: `edit expense`](#edit-expense--edit-expense)
     + [Delete Expense: `delete expense`](#delete-expense--delete-expense)
     + [Set Balance: `set balance`](#set-balance--set-balance)
-    + [List Expenses `list expenses`](#list-expenses--list-expenses)
-    + [Check Balance `check balance`](#check-balance--check-balance)
+    + [List Expenses: `list expenses`](#list-expenses--list-expenses)
+    + [List Expenditure by Category: `list expenditure by category`](#list-expenditure-by-category--list-expenditure-by-category)
+    + [Filter Expenses `expenses above` / `expenses below`](#)
+    + [Check Balance: `check balance`](#check-balance--check-balance)
+    + [Currency: `set currency` / `get currency`](#currency--set-currency--get-currency)
     + [Add Future Expense: `add future expense`](#add-expense--add-future-expense)
     + [Edit Future Expense: `edit future expense`](#edit-expense--edit-future-expense)
     + [Delete Future Expense: `delete future expense`](#delete-future-expense--delete-future-expense)
@@ -44,7 +47,7 @@ Run the command followed by choosing what to sort the expenses by
 * By Name
 * By Price
 ---
-### `set currency` / `get currency`
+### Currency: `set currency` / `get currency`
 Set/get the currency used by the app
 #### Usage:
 ```
@@ -71,7 +74,27 @@ Noted. I've removed this expense:
 Spent $150.0 on book in the Others category on 2023-02-01
 --------------------------------------------------------------------------------
 ```
+### List Expenditure by Category: `list expenditure by category`
+Lists the total expenditure across different categories.
 
+**Format:** `list expenditure by category`
+
+**Example:**
+
+`list expenditure by category`
+
+**Expected outcome:**
+```
+--------------------------------------------------------------------------------
+Food & Drinks - $100.0
+Others - $0.0
+Investments - $0.0
+Transportation - $0.0
+Communication & Technology - $2000.0
+Shopping - $0.0
+Life & Entertainment - $0.0
+--------------------------------------------------------------------------------
+```
 
 ## FAQ
 
@@ -86,7 +109,11 @@ Spent $150.0 on book in the Others category on 2023-02-01
 * Delete expense `delete expense id/EXPENSE_ID`
 * Set balance `set balance $/AMOUNT`
 * List expenses `list expenses`
+* List expenditure across categories `list expenditure by category`
+* Filter expenses by amount `expenses above $/AMOUNT` / `expenses below $/AMOUNT`
 * Check balance `check balance`
+* Set currency `set currency CURRENCY_SYMBOL`
+* Get currency `get currency`
 * Add future expense `add future expense NAME $/AMOUNT d/DATE`
 * Edit future expense `edit future expense id/EXPENSE_ID in/"AMOUNT/DATE/CATEGORY"`
 * Delete future expense `delete future expense id/EXPENSE_ID`

diff --git a/src/main/java/seedu/duke/Ui.java b/src/main/java/seedu/duke/Ui.java
@@ -13,8 +13,9 @@ public static void printInstructions() {
         System.out.println("delete expense +  id/\"expense id\" to delete an expense");
         System.out.println("set balance +  $/\"amount\" to set your balance");
         System.out.println("list expenses to list all past expenses");
+        System.out.println("list expenditure by category to list total expenditure on each category");
         System.out.println("expenses above + $/\"amount\" to see all expenses above amount");
-        System.out.println("expenses above + $/\"amount\" to see all expenses below amount");
+        System.out.println("expenses below + $/\"amount\" to see all expenses below amount");
         System.out.println("check balance to check the remaining balance");
         System.out.println("set currency {CURRENCY_SYMBOL} to set the app to your desired currency");
         System.out.println("get currency to get the currently set currency");
@@ -25,7 +26,6 @@ public static void printInstructions() {
         System.out.println("list future expenses to list all future expenses");
         System.out.println("check upcoming expenses to list all future expenses within an upcoming time period");
         System.out.println("pay \"id\" to pay for a future expense and move it to the list of past expenses");
-        System.out.println("list expenditure by category to list total expenditure on each category");
         System.out.println("bye to exit the program");
     }