[CS2113-T12-1] ChChing

.gitignore

@@ -15,3 +15,4 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+/data

build.gradle

@@ -10,6 +10,7 @@ repositories {
 }
 
 dependencies {
+    testImplementation('org.junit.platform:junit-platform-launcher:1.5.2')
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
 }
@@ -29,11 +30,11 @@ test {
 }
 
 application {
-    mainClass = "seedu.duke.Duke"
+    mainClass = "chching.ChChing"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "chching"
     archiveClassifier = null
 }
 
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

data/chching.txt

@@ -0,0 +1,6 @@
+I | tuition | 2023-12-12 | 500.00
+I | test | 2022-11-11 | 300.00
+I | test | 2023-12-12 | 500.00
+E | expense | transport | 2023-12-12 | 500.00
+E | tuition | test | 2023-12-24 | 350.50
+E | test | test | 2023-07-05 | 300.00

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+Display |          Name          |               Github Profile                | Portfolio 
+--------|:----------------------:|:-------------------------------------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) |    Nafis Azizi Riza    |  [Github](https://github.com/nafisazizir)   | [Portfolio](team/nafisazizir.md)
+![](https://via.placeholder.com/100.png?text=photo) |   Eng Chen Xi, Aviel   |    [Github](https://github.com/avielcx)     | [Portfolio](team/aviel.md)
+![](https://i.redd.it/lgjx3zalumy71.png) |     Pang Yan Ming      |  [Github](https://github.com/Rayleigh47/)   | [Portfolio](team/yanming.md)
+![](https://images.immediate.co.uk/production/volatile/sites/28/2019/02/4-things-parents-need-to-know-about-thomas-and-friends-tale-of-the-brave_60083-f74cd7b.jpg?quality=90&webp=true&resize=610,407) | Thomas Joseph Lee Alba |  [Github](https://github.com/thomasjlalba)  | [Portfolio](team/thomas.md)
+![](https://i.kym-cdn.com/photos/images/original/001/889/810/5c7) | Hung Hin Wang Clement  | [Github](https://github.com/hyperbola-bear) | [Portfolio](team/clement.md)

docs/DeveloperGuide.md

@@ -8,23 +8,119 @@
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+## Implementation
+
+### Record and RecordList  
+
+The main class in our program is the ```Record``` and ```RecordList``` abstract classes, in which ```Income```, ```Expense``` will inherit from ```Record``` and ```IncomeList``` and ```ExpenseList``` will inherit from ```RecordList```. Most commands will act on instances of the ```Income```, ```Expense```,```IncomeList``` and ```ExpenseList``` classes.  
+
+![Record Class](images/Record_RecordList_UML_class.png)
+
+### DeleteIncomeCommand 
+
+The proposed DeleteIncomeCommand mechanism is facilitated by ```System```, ```Incomes```, ```UI``` and ```ChChingException```.  
+The command receives the instruction from ```UI``` and will call the ```execute``` method.  
+If ```index <= 0```, the command will throw a new ChChingException and print ```"Zero/Negative index"```.  
+If ```index > incomes.size()```, the command will also throw a new ChChingException and print ```"The number is too big"```  
+Entering any of these optional lines will result in early termination of the command.  
+Or else, the command will continue to delete the entry at the particular index.  
+Afterwards, the ```execute()``` method will print ```"Income deleted, here is the updated list:"``` and prints the entries in the income list.
+
+![Record Class](images/DeleteIncomeCommand_sequence_diagram.png)
+
+### Target and TargetStorage
+
+The `Target` and `TargetStorage` class allows users to set a target for their ideal balance.
+
+![Target Class](images/Target_UML.png)
+
+### [Proposed] EditIncomeCommand/EditExpenseCommand
+The proposed edit income command is facilitated by `Parser`, `EditIncomeCommand`, `IncomeList`, while the proposed edit expense command is facilitated by `Parser`, `EditExpenseCommand` and `ExpenseList`. 
+
+Note that below highlights the implementation of the edit income command, with edit expense command following the same implementation.
+
+Given below is how the edit income mechanism works at each step:
+1. The user types in the command for edit income with the necessary arguments given to indicate which income record to edit and what fields to edit for the chosen income record.
+2. The line inputted by the user will then be parsed by `Parser`, where it will check if the input contains a valid index with valid fields to edit. If they are valid, it will return `EditIncomeCommand`. Else it will throw a `ChChingException` indicating an error in the input from the user.
+3. `EditIncomeCommand` will then perform its `execute` method, where for each field to be edited, it will call `editIncome` method from the `ExpenseList` class. This would then update the required income record accordingly.
+
+The following sequence diagram shows how the edit income command works:
+<br> ![edit income sequence diagram](images/EditIncomeCommand_sequence_diagram.png)
+
+The edit expense command works in a similar way, with its sequence diagram as shown:
+<br> ![edit expense sequence diagram](images/EditExpenseCommand_sequence_diagram.png)
+
+The following activity diagram summarises what happens when a user executes edit income command:
+<br> ![edit income activity diagram](images/EditIncomeCommand_activity_diagram.png)
+<br> Note that edit expense command produces the same activity diagram.
+
+**Design Considerations**
+<br>The following are the design alternatives we considered for edit income/expense command:
+
+* **Alternative 1 (current choice):** Edit only the specific fields indicated in the input arguments.
+    * Pros: Easier for the user to input an edit.
+    * Cons: May introduce more bugs.
+* **Alternative 2:** Edit to require user to rewrite all its fields.
+    * Pros: Easier to implement.
+    * Cons: Not any easier than having the user to just delete and add new expense/income.
+
+### ListExpenseCommand
+The listExpenseCommand is facilitated by ```Parser```, ```ListExpenseCommand``` and ```ExpenseList```.
+
+1. The user inputs the command top list expense. This input is handled by```Parser``` which returns the
+   ```listExpenseCommand``` if successful.
+2. ```ListExpenseCommand``` will then call its ```execute``` method
+   which makes use of ```System``` to print a new line ```"Expenses:"```.
+3. The ```expenseList``` method ```printExpenseList```
+   is called, which iterates through the expenseList, ```expenses``` and prints the index as well as a completed string of
+   expenses in ```expenses```.
+
+![ListExpenseCommand](images/ListExpenseCommand_Sequence_Diagram.png)
+### SetTargetCommand
+The setTargetCommand is facilitated by ```ChChing```, ```Parser```, ```TargetParser```, ```TargetStorage```.
+When the command receives to set target, the ```parse()``` method of the ```Parser``` object will read in the command and call the ```parseTarget()``` method from the TargetParser class 
+to instantiate a Target object and initializes a target value. Afterwards, ```parse()``` method calls the ```AddTargetCommand``` and  instantiate a ```SetTargetCommand``` object and returns to the ```Parser``` object.
+The ```Parser``` object then returns to ```ChChing```. ```ChChing``` object then runs the ```execute()``` method of the SetTargetCommand object. The method then calls the ```setTarget()``` method of the ```TargetStorage``` object to store the previously initialized ```Target``` object.
+
+![SetTargetCommand UML](images/SetTargetCommand.png)
+### SetCurrencyCommand
+The setCurrencyCommand is facilitated by ```System```, ```Selector```,  ```UI``` and ```ExpenseList```.
+The command receives the instruction from ```UI``` and will call the ```execute``` method.
+The ```execute()``` method in setCurrencyCommand will then call the ```containsCurrency(currency)``` method from ```Selector```.
+If the method returns false, which indicates that the currency is not available, the command will throw a new ChChingException and print ```"Currency not available"```.
+If the method returns true, the command will continue to set the currency in the selector hashmap to true.
+Afterwards, the ```execute()``` method will call the ```printSelector()``` method from ```Selector```.
+The ```printSelector()``` method will print all the available currencies in the selector hashmap.
+The selected currencies will be marked with a ```[X]``` and the unselected currencies will be marked with a ```[ ]```.
+
+![SetCurrencyCommand_sequence_diagram.png](images%2FSetCurrencyCommand_sequence_diagram.png)
 
 ## Product scope
+
 ### Target user profile
 
-{Describe the target user profile}
+Target users are people who are keen on improving their financial accountability
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+The value proposition of ChChing is its ability to track income and expenses on a daily basis.
 
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
-
+| Version | As a ...  | I want to ...                           | So that I can ...                                                                       |
+|---------|-----------|-----------------------------------------|-----------------------------------------------------------------------------------------|
+| v1.0    | new user  | see usage instructions                  | refer to them when I forget how to use the application                                  |
+| v1.0    | user      | add new expense to the records          | record all my expenses                                                                  |
+| v1.0    | user      | add new income to the records           | record all my incomes                                                                   |
+| v1.0    | user      | view all the records                    | refer to them when I forgot my expenses and incomes                                     |
+| v1.0    | user      | edit the records                        | modify/fix if the records is changed/wrong                                              |
+| v1.0    | user      | know current balance                    | aware how much money do I have left                                                     |
+| v2.0    | user      | edit my existing entries                | rectify or update any entries without having to enter another entry and delete an entry |
+| v2.0    | user      | find specific entries                   | refer to specific entries when necessary                                                |
+| v2.0    | foreigner | view my entries in a different currency | read my incomes and expenses in a currency I am familiar with                           |
+| v2.0    | user      | set a target for my balance             | improve my financial management                                                         |
+| v2.0    | user      | see the target i have set               | remind myself of my target                                                              |
+| v2.0    | user      | reset my income/expense lists or both   | have a fresh list                                                                       |
 ## Non-Functional Requirements
 
 {Give non-functional requirements}

docs/UserGuide.md

@@ -2,41 +2,168 @@
 
 ## Introduction
 
-{Give a product intro}
+ChChing is a desktop app for tracking spending, and it uses a Command Line Interface (CLI) for managing finances. If you are someone who needs a simple interface to get a better hold of your finances, this app is for you!
 
 ## Quick Start
 
-{Give steps to get started quickly}
-
 1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+2. Down the latest version of `ChChing` from [here](https://github.com/AY2223S2-CS2113-T12-1/tp/releases).
+3. Copy downloaded `ChChing.jar` file to the desired home folder of choice.
+4. Open a command terminal and `cd` into the folder mentioned in step 3.
+5. Type in the following to run the application:
+```
+java -jar ChChing.jar
+```
+6. If successful, the following greeting should appear:
+```
+    ____________________________________________________________
+    Hello! I'm ChChing.
+    What can I do for you?
+    ____________________________________________________________
+```
+7. Type in desired command to start using the program! List of commands are listed below
+
+## Features
+
+### Adding an entry: `add`
+Creates a new entry for expenses or income, with respective input formats.
+
+Format:
+<br>`add expense /c CATEGORY /de DESCRIPTION /da DATE /v VALUE`
+<br>`add income /de DESCRIPTION /da DATE /v VALUE`
+
+Use case:
+* Re-prompts user if any field is not provided properly.
+* VALUE will be stored as a positive float.
+* Format for DATE will be dd-MM-yyyy.
 
-## Features 
+Example of usage:
+<br>`add expense /c meal /de breakfast @Technoedge /da 22-03-2023 /v 3.50`
+<br>`add income /c salary /de salary /da 22-03-2023 /v 500`
 
-{Give detailed description of each feature}
+### Listing all expenses and incomes: `list`
+Shows a full list of both the expenses and incomes created by the user. Includes the index number, category, description, and value.
+<br> Can view list of expenses/incomes separately as well.
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+Format:
+<br> `list`
+<br> `list expense`
+<br> `list income`
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+### Updating an entry: `edit`
+Edit an existing expense/income that is currently in the list.
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+Format:
+<br> `edit expense /i INDEX [/c CATEGORY] [/de DESCRIPTION] [/da DATE] [/v VALUE]`
+<br> `edit income /i INDEX [de/DESCRIPTION] [da/DATE] [v/VALUE]`
+<br> where [] indicates optional fields.
 
-Example of usage: 
+Use case:
+* Edits the item at the specified INDEX, where INDEX is a positive integer.
+* At least one of the fields must be provided.
+* User inputs desired fields to be edited.
+* Existing values will be updated to the input values.
 
-`todo n/Write the rest of the User Guide d/next week`
+Example of usage:
+`edit expense /i 1 /de Lunch @Technoedge /v 5.20`
+`edit income /i 2 /da 12-12-2022 /v 100`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+### Finding an entry: `find`
+Find an existing expense/income that is currently in the list.
 
-## FAQ
+Format:
+<br> `find expense /c CATEGORY /de DESCRIPTION`
+<br> `find income /de DESCRIPTION`
 
-**Q**: How do I transfer my data to another computer? 
+Use case:
+* Shows user the entry that they are looking for.
 
-**A**: {your answer here}
+Example of usage:
+<br> `find expense /c Grocery /de Beef`
+<br> `find income /de Salary`
 
-## Command Summary
+### Showing the balance: `balance`
+Shows users the balance he has after calculating the difference of income and expense.
+
+Format:
+<br> `balance`
+
+### Deleting an entry: `delete`
+Remove an entry from the expense/income list.
+
+Format:
+<br> `delete expense /in INDEX`
+<br> `delete income /in INDEX`
+
+Use case:
+* INDEX is a positive integer.
+* Prompts user if index is out of bounds.
+
+Example of usage:
+<br>`delete expense /in 1`
+<br>`delete income /in 2`
+
+### Clear entire income list: `clear expense`
+Clear the entire list of incomes.
+
+Format:
+<br> `clear income`
+
+### Clear entire expense list: `clear income`
+Clear the entire list of expenses.
+
+Format:
+<br> `clear expense`
 
-{Give a 'cheat sheet' of commands here}
+### Clear entire both income and expense lists: `clear all`
+Clear the entire list of incomes and expenses.
+
+Format:
+<br> `clear all`
+### Set a target for balance of finances: `add target`
+Allows users to set a target for their balance.
+
+Format:
+<br> `add target /v VALUE`
+
+Use case:
+* VALUE is more than or equal to zero
+
+Example of usage:
+<br> `add target 350`
+### Finding balance of finances: `balance`
+Shows users the balance after calculating the difference between income and expenses and informs users on whether they have reached their target.
+
+Format:
+<br> `balance`
+
+### View help: `help`
+Shows basic commands executable by the program and the use format for the commands
+
+Format:
+<br> `help`
+
+### Saving and loading of data
+Record entries are saved in `data/chching.txt` file. This file is updated upon exit. 
+When reading from the file, entries for income and expenses are stored in their respective arrayList.
+
+## Command Summary
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+* Add Expense: `add expense /c CATEGORY /de DESCRIPTION /da DATE /v VALUE`
+* Add Income: `add income /de DESCRIPTION /da DATE /v VALUE`
+* List Records: `list`
+* List Expenses: `list expense`
+* List Incomes: `list income`
+* Edit income list: `edit income /i INDEX [/de DESCRIPTION] [/da DATE] [/v VALUE]`
+* Edit expense list: `edit expense /i INDEX [/c CATEGORY] [/de DESCRIPTION] [/da DATE] [/v VALUE]`
+* Find income entry: `find income /c CATEGORY /de DESCRIPTION`
+* Find expense entry: `find expense /c CATEGORY /de DESCRIPTION`
+* Delete Expense: `delete expense /in INDEX`
+* Delete Income: `delete income /in INDEX`
+* Clear income list: `clear income`
+* Clear expense list: `clear expense`
+* Clear both income and expense lists: `clear all`
+* Set Target: `add target /v Value`
+* Show Target: `show target`
+* Show Balance: `balance`
+* Show help: `help`

docs/_config.yml

@@ -0,0 +1,4 @@
+#Build Settings
+
+theme: minima
+markdown: GFM