[CS2113-W14-1] W14G1 (WIAGI)

.gitignore

@@ -3,15 +3,30 @@
 /out/
 /*.iml
 
+*.class
+password.txt
+
 # Gradle build files
 /.gradle/
 /build/
 src/main/resources/docs/
 
+*.class
+password.txt
+
 # MacOS custom attributes files created by Finder
 .DS_Store
 *.iml
 bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+text-ui-test/incomes.txt
+text-ui-test/password.txt
+text-ui-test/spendings.txt
+
+**/MANIFEST.MF
+
+/password.txt
+incomes.txt
+spendings.txt

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# WIAGI
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.wiagi.Wiagi")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("wiagi")
     archiveClassifier.set("")
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

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)
+Name     |             Github Profile              | Portfolio 
+------------:|:---------------------------------------:|:---------:
+Weng Hong   | [Github](https://github.com/wongwh2002) | [Portfolio](docs/team/weng.md)
+Nigel Yeo    | [Github](https://github.com/NigelYeoTW) | [Portfolio](docs/team/NigelYeo.md)
+Wen Xi   |   [Github](https://github.com/wx-03)    | [Portfolio](docs/team/wenxi.md)
+Ryan Harwood   |   [Github](https://github.com/rharwo)   | [Portfolio](docs/team/ryanharwood.md)
+Tan Ping Hui |   [Github](https://github.com/TPH777)   | [Portfolio](docs/team/tanpinghui.md)

docs/DeveloperGuide.md

@@ -2,12 +2,153 @@
 
 ## Acknowledgements
 
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the
+original source as well}
+
+[Original Source](https://github.com/nus-cs2113-AY2425S1/tp)
 
 ## Design & implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+## Overall Class Diagram
+![overallClass.jpg](./Diagrams/overallClass.jpg)
+On a high level, whenever Wiagi is started, it will load SpendingList and IncomeList from Storage if it exists, else, 
+new lists would be created
+Wiagi then takes in user input via the UI class, then parse and executes the command through the parser class.
+The related output is printed through the UI class.
+At the end of the run, or when the user exits the application, Wiagi will save the lists.
+
+### Storage
+To load data from previous session:
+Within Wiagi constructor, Storage class is constructed, which will load and initialise incomes, spendings and
+password by de-serialising the text at their distinct file paths. Wiagi will then initialise it incomes and spendings
+based on the member in the Storage class.
+![storageLoad.png](./Diagrams/storageLoad.png)
+
+To save data for current session:
+After the command bye is sent by the user, incomes and spendings will be serialised and overwrite texts in
+their distinct file paths.
+![storageSave.png](./Diagrams/storageSave.png)
+
+### adding of new entry
+![addCommandSequence.jpg](./Diagrams/addCommandSequence.jpg)
+To add new entries, user will have to input the related commands.
+Wiagi will then parse the command to the AddCommand class.
+The AddCommand class will then validate the user's input and add the input to IncomeList or SpendingList
+
+### deleting of entry, editing of entry
+The commands are similar where there would be a parsing of command to each of its individual classes.
+A similar validation process takes place and actions would be made on IncomeList or SpendingList accordingly
+(deleting entry from list for delete and editing of entry from list for edit)
+
+### Recurrence Component
+
+#### Motivation behind the component:</br>
++ Allows the user to set specific expenditure and incomes as recurring events to increase efficiency when using the
+  application
++ Users may have differing frequencies for recurring events thus application gives them a few common options
+
+Illustrated below is the class diagram for the Recurrence Component:</br>
+</br>
+<img src="./Diagrams/recurrenceClassDiagram.png" alt="recurrenceClassDiagram" width="800"/>
+</br>
+</br>
+Illustrated below is the sequence diagram of the Recurrence Component: </br>
+</br>
+<img src="./Diagrams/recurrenceSequenceDiagram.png" alt="recurrenceSequenceDiagram" width="700"/>
+</br>
+For the reference fragment of 'load from storage', refer to [Storage component](#storage). </br>
+For the reference fragment of 'add recurring entry', refer to 
+[checkIncomeRecurrence / checkSpendingRecurrence](#checkincomerecurrence--checkspendingrecurrence-method) method. </br>
+
+
+#### How the Recurrence Component works:</br>
++ Upon running the application by the user, `Storage` component will load the `IncomeList` and `SpendingList` members of
+`Wiagi` to retrieve past data.
++ Both list are then iterated through. Each member of the list is parsed through `Parser` which returns the type of 
+recurrence it is (eg. `DailyRecurrence`, `null`) which is encapsulated as a `Recurrence` object.
++ If `Recurrence` is not `null` (ie. a recurring entry), it checks the entry and adds to the `SpendingList` and 
+`IncomeList` if needed. </br>
+
+#### Implementation:
+#### Recurrence class
+The `Recurrence` class is a abstract class that provides the interface for checking `Income` and `Spending` and adding 
+recurring entries into the list. </br>
+The following are the abstract methods defined: </br>
++ `checkSpendingRecurrence`
++ `checkIncomeRecurrence`
+
+The following are child classes of `Recurrence`:
++ `DailyRecurrence`: Handles entries labelled as daily recurring events
++ `MonthlyRecurrence`: Handles entries labelled as monthly recurring events
++ `YearlyRecurrence`: Handles entries labelled as yearly recurring events
+
+##### parseRecurrence method
+Class: `Parser` </br>
+Method Signature: </br>
+```
+public static Recurrence parseRecurrence(Type entry)
+```
+Functionality: </br>
+1. Takes in child class of `Type` (ie. `Spending`, `Income`)
+2. Matches the `reccurenceFrequency` attribute with switch case to determine which `Recurrence` child to return
+3. Returns `DaillyRecurrence`, `MonthlyRecurrence`, `YearlyRecurrence` or `null`(If not a recurring entry).
+
+##### checkIncomeRecurrence / checkSpendingRecurrence method
+Class: `DailyRecurrence`, `MonthlyRecurrence`, `YearlyRecurrence` </br>
+Method Signature: </br>
+```
+@Override
+public void checkIncomeRecurrence(Income recurringIncome, IncomeList incomes)
+@Override
+public void checkSpendingRecurrence(Spending recurringSpending, SpendingList spendings)
+```
+Below illustrates the functionality of the checkIncomeRecurrence method through a sequence diagram </br>
+</br>
+<img src="./Diagrams/addRecurrenceEntry.png" alt="addRecurrenceEntry" width="700"/> </br>
+Note that recurrence frequency is either 1 day (daily), 1 month (monthly) or 1 year (yearly). </br>
+Since checkSpendingRecurrence method follows the same sequence as checkIncomeRecurrence method, the diagram is omitted 
+for brevity.
+
+Functionality: </br>
+1. Checks `lastRecurred` attribute of `recurringIncome`/`recurringSpending` against the current date via `LocalDate.now`
+2. According to the type of recurrence, check if enough time has passed between the 2 dates
+3. Adds additional recurring entries into the `IncomeList`/`SpendingList` if needed.
+
+##### updateRecurrence method
+Class: `SpendingList`, `IncomeList` </br>
+Method Signature:
+```
+public static Recurrence parseRecurrence(Type entry)
+```
+Functionality: </br>
+1. Loops through its list and calls upon `Parser#parseRecurrence` to determine type of `Recurrence`
+2. Calls upon `Recurrence#checkSpendingRecurrence` or `Recurrence#checkIncomeRecurrence` to update list if the new 
+recurring entry is supposed to be added
+
+#### Here are some things to take note:
++ Entries are only added when user logs in, which is not determinable, thus many additional entries may be added at once
+(eg. user last logged in 4 days ago with one daily recurring entry in the list. When the user logs in, 4 days of entries
+will be backlogged and added). List is thus also sorted by date after recurrence is done.
++ Additional entries added by `Recurrence` are being set to not recurring events to prevent double recurring entries
+added in the future
++ Recurring entries stores `dayOfRecurrence` to counter varying days in months. Below is a example scenario: 
+  + Monthly recurring entry dated at 31st August
+  + Since September ends on the 30th, recurring entry is added on the 30 September and `lastRecurred` is stored as 
+  30th September
+  + `dayOfRecurrence` is used to track the real date of recurrence since the day will be overwritten
+
+### Budgets
+Daily, monthly, and yearly spending totals are calculated everytime a ListCommand is received. This is done by
+iterating through each of the spendings stored in SpendingList and comparing their dates to the respective daily,
+monthly, and yearly dates.
+
+### Deleting an entry
+The user deletes an entry by sending a delete command which specifies the index of the income/spending to be deleted. 
+The income or spending will be deleted from its corresponding list using its index. 
+
+
 
 ## Product scope
 ### Target user profile
@@ -19,11 +160,106 @@
 {Describe the value proposition: what problem does it solve?}
 
 ## User Stories
+Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *
+
+| Priority | As a ... | I want to ...                                        | So that I can ...                                |
+|----------|----------|------------------------------------------------------|--------------------------------------------------|
+| ***      | user     | start and close the application                      | use it only when needed                          |
+| ***      | user     | add my financial transactions                        | track the flow of my money                       |
+| ***      | user     | categorise my entries as income and spendings        | better understand my financials                  |
+| ***      | user     | add income and expenditure categories                | see my overall net gain or loss                  |
+| ***      | user     | see all my spendings                                 | know what I spent on                             |
+| ***      | user     | delete my entries                                    | correct my mistakes                              |
+| ***      | user     | have a password to my account                        | protect my account information                   |
+| **       | user     | edit my incomes and spendings                        | correct my mistakes                              |
+| **       | user     | categorise my expenses                               | see what I spend on                              |
+| **       | user     | categorise my incomes                                | see where my savings come from                   |
+| **       | user     | read the amount of money left in my allocated budget | gauge how much to spend for the remaining period |
+| **       | user     | set expenses and incomes as recurring                | do not need to manually add them each time       |
+| **       | Student  | set budgets for each category of expense             | make better financial decisions                  |
+| *        | user     | be alerted when I overspend my budget                | try to curb my spendings                         |
+
+
+## Use cases
+
+### Use case: Add an Entry
+
+**Adding an income entry with optional input for date and tag**
+
+**MSS**
+
+1. User inputs to add income with description, amount, date, and tag.
+2. Wiagi adds the income to the income list.
+3. If the date is not provided, Wiagi will use the current date.
+4. If the tag is not provided, Wiagi will use the default tag (Empty String).
+5. Wiagi will display a message to the user that the income has been added.
+
+Use case ends.
+
+**Extensions**
+1. User enters invalid input.
+   1. If the user inputs invalid formatting, Wiagi will display an error message.
+   2. If the user inputs an invalid amount, Wiagi will display an error message.
+   3. If the user inputs an invalid date, Wiagi will display an error message.
+
+   Use case restarts at step 1.
+
+### Use case: Delete an Entry
+
+**Deleting an income or spending from the list**
+
+**MSS**
+
+1. User requests to list all incomes
+2. Wiagi shows a list of all incomes
+3. User takes note of the index of the income to delete and requests to delete the entry
+by specifying the index
+4. Wiagi deletes the entry
+
+Use case ends.
+
+**Extensions**
+- 1a. The list is empty. 
+<br>Use case ends. 
+- 3a. The given index is invalid.
+  - 3a1. Wiagi displays an error message.
+<br>Use case restarts at step 1.
+
+
+### Use case: Listing all Entries
+**MSS**
+1. User requests to list all entries.
+2. Wiagi shows a list of all incomes and spendings, including optional parameters such as tags.
+
+Use case ends.
+**Extensions**
+1. The list is empty.
+    - 1a. Wiagi displays incomes and spendings without entries (equal to 0).
+
+Use case of listing all spendings, incomes, tags is similar, omitted for brevity.
+
+
+### Use Case: Edit an Entry
+**Editing an existing income or spending entry**
+
+**MSS**
+
+1. User requests to list all incomes or spendings.
+2. Wiagi shows a list of all incomes or spendings.
+3. User takes note of the index of the entry to edit and requests to edit the entry by specifying the index and new details.
+4. Wiagi updates the entry with the new details.
+5. Wiagi displays a message to the user that the entry has been updated.
 
-|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|
+Use case ends.  
+**Extensions**
+1. The list is empty.
+<br>Use case ends.
+2. The given index is invalid.
+    - 2a. Wiagi displays an error message.
+    Use case restarts at step 1.
+3. The new details are invalid.
+    - 3a. Wiagi displays an error message.
+    Use case restarts at step 1.
 
 ## Non-Functional Requirements