nus-cs2113-AY2324S1 · ryan1604 · Oct 31, 2023 · Oct 31, 2023 · Oct 31, 2023 · Oct 31, 2023
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,4 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+data/
diff --git a/build.gradle b/build.gradle
@@ -12,6 +12,10 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
+    implementation group: 'com.googlecode.json-simple', name: 'json-simple', version: '1.1.1'
+    implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.0'
+    implementation group: 'org.knowm.xchart', name: 'xchart', version: '3.8.5'
+    implementation group: 'com.google.code.gson', name: 'gson', version: '2.10.1'
 }
 
 test {
@@ -29,7 +33,7 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.financialplanner.FinancialPlanner")
 }
 
 shadowJar {
@@ -43,4 +47,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -1,9 +1,10 @@
 # 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) |  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) |  Ryan Chua  | [Github](https://github.com/ryan1604) | [Portfolio](docs/team/ryanchua.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Neo Min Wei | [Github](https://github.com/NeoMinWei) | [Portfolio](docs/team/NeoMinWei.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Frederick  | [Github](https://github.com/) | [Portfolio](docs/team/frederick.md)
+
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -1,13 +1,304 @@
 # Developer Guide
 
+## Table of contents
+
+* [Acknowledgements](#acknowledgements)
+* [Design & implementation](#design--implementation)
+  * [Storage Component](#storage-component)
+    * [Design considerations](#design-considerations)
+  * [Visualization Feature](#visualization-feature-)
+    * [Class diagram](#class-diagram)
+    * [Sequence diagram](#sequence-diagram-)
+  * [Add Income/Expense Feature](#add-incomeexpense-feature)
+    * [Class Diagram](#add-incomeexpense-class-diagram)
+    * [Sequence Diagram](#add-incomeexpense-sequence-diagram)
+  * [Recurring Cashflow Feature](#recurring-cashflow-feature)
+    * [Class Diagram](#recurring-cashflow-class-diagram)
+    * [Sequence Diagrams](#recurring-cashflow-sequence-diagrams)
+  * [Budget Feature](#budget-feature)
+    * [Set and update budget](#set-and-update-budget)
+    * [Delete budget](#delete-budget)
+    * [Reset budget](#reset-budget)
+    * [View budget](#view-budget)
+  * [Product Scope](#product-scope)
+    * [Target user profile](#target-user-profile)
+    * [Value proposition](#value-proposition)
+  * [User Stories](#user-stories)
+  * [Non-Functional Requirements](#non-functional-requirements)
+  * [Glossary](#glossary)
+  * [Instructions for manual testing](#instructions-for-manual-testing)
+
 ## Acknowledgements
 
+**Xchart (A Simple Charting Library for Java)**
+- author: KNOWN
+- source: [https://knowm.org/open-source/xchart/](https://knowm.org/open-source/xchart/)
+
+**JSON Simple (simple Java toolkit for encoding and decoding JSON)**
+- author: Yidong Fang (Google Code)
+- source: [https://code.google.com/archive/p/json-simple/](https://code.google.com/archive/p/json-simple/)
+
+**Apache Common Langs 3**
+- author: Apache Commons
+- source: [https://commons.apache.org/proper/commons-lang/](https://commons.apache.org/proper/commons-lang/)
+
+**Alpha Vantage Stock Market API**
+- author: Alpha Vantage
+- source: [https://www.alphavantage.co/](https://www.alphavantage.co/)
+
+**Gson Java library**
+- author: Google
+- source: [https://github.com/google/gson](https://github.com/google/gson)
+
+**Financial Modeling Prep Stock API**
+- author: Financial Modeling Prep
+- source: https://site.financialmodelingprep.com/
+
+**round() method in Cashflow.java**
+  - author: mhadidg
+  - source: [https://stackoverflow.com/questions/2808535/round-a-double-to-2-decimal-places]()
+
+**capitalize() method in Cashflow.java**
+  - author: Nick Bolton
+  - source: [https://stackoverflow.com/questions/1892765/how-to-capitalize-the-first-character-of-each-word-in-a-string]()
+
+**DG adapted from**
+
+* [Addressbook-level3](https://github.com/se-edu/addressbook-level3)
+
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
 ## Design & implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+### Storage Component
+
+API: `Storage.java`
+
+![](images/Storage.png)
+
+* The storage component loads data from the saved text files when the application starts, and saves the data to the
+  text files when the application exits.
+* The storage class uses the static methods in LoadData and SaveData to load and save data respectively.
+* The `load` method in LoadData reads the `data.txt` file and loads any existing Income, Expense and Budget into the application.
+* The `save` method in SaveData saves all Incomes, Expenses and existing Budget into the `data.txt` file.
+
+#### Design considerations:
+
+* There are 2 main ways to implement the storage, one is to save the data after every command, and the other is to save 
+the data one upon exiting the program with the `exit` command.
+* Saving the data once upon exit (Currently implemented):
+  * Advantage: Better efficiency and performance of the program.
+  * Disadvantage: If the program crashes or exits incorrectly, data will not be saved.
+* Saving the data after every command:
+  * Advantage: Changes are saved after every command.
+  * Disadvantage: Executing command might slow down the program when there is a large amount of data to be saved.
+
+### Visualization Feature 
+
+This feature is implemented with the help of [XChart](https://knowm.org/open-source/xchart/), a simple charting library for Java by Knowm.
+
+By typing in the vis command with the appropriate arguments (`/s` and `/t`), users will be able to visualize their 
+income or expense using visualization tools (Piechart, Bar Chart or Radar Chart)
+
+Demo: 
+
+`vis /t expense /c pie`
+
+Output
+
+`Displaying piechart for expense`
+A message will be shown telling you that the chart is being displayed
+
+![](images/vis/visOutput.png)
+
+This feature was implemented with the help of three different classes.
+They are namely: Visualizer, Categorizer, VisCommand (Inherits from abstract Command Class)
+
+VisCommand's Role: 
+1) Read the parameters of the vis command entered by the user
+- `/t` Reads the type of cashflow that the user wants to visualize (income/expense)
+- `/c` Reads the type of visualization tools the user wants (piechart/barchart)
+
+2) Calls the Cateorgizer to sort cashflow (Income/Expense) according to type
+
+3) Calls the Visualizer to display the chart to the user
+
+Categorizer's Role: 
+
+According to the cashflow type (Income/Expense) arugment passed in, the Categorizer sorts the 
+specified cashflow entry according to type using a Hashmap which is returned and used by the Visualizer
+
+Visualizer's Role: 
+
+According to the chart type (Pie/Bar/Radar) argument and the Hashmap obtained from the categorizer passed in, 
+the visualizer displays the specified visualization chart by calling the charting library Xchart.
+
+### Class Diagram
+
+![](images/vis/visualisationClass.png)
+
+### Sequence Diagram 
+
+Overall 
+
+![](images/vis/visualisationSequence.png)
+
+Categorizer
+
+![](images/vis/categorizerSequence.png)
+
+Visualizer
+
+![](images/vis/visualizerSequence.png)
+
+### Add Income/Expense Feature
+
+The add income/expense command has 2 compulsory arguments `/t` and `/a` and 1 optional argument `/r`.
+
+Example:
+```
+add income /a 100 /t salary /r 30
+```
+Below are the steps that shows the implementation of add income/expense.
+
+#### Step 1
+The AddCashflowCommand instance calls addIncome() or addExpense(), depending on what `category` is initialised as.
+
+addIncome() or addExpense() instantiates an Income or Expense object respectively.
+
+Example:
+```
+switch (category) {
+        case INCOME:
+            cashflowList.addIncome(amount, incomeType, recur);
+            break;
+        case EXPENSE:
+            cashflowList.addExpense(amount, expenseType, recur);
+            break;
+        default:
+            ui.showMessage("Unidentified entry.");
+            break;
+        }
+```
+#### Step 2
+The instantiated income/expense then updates the overall balance through addIncomeValue() or addExpenseValue().
+
+The income/expense object is also added to the list in Cashflowlist which contains all incomes/expenses.
+#### Step 3
+The added income/expense is then displayed to the user through the Ui.
+
+#### Add Income/Expense Class Diagram
+Given below is the class diagram showing the class structure of the add income/expense mechanism:
+![](images/cashflow/CashflowClassDiagram.png)
+#### Add Income/Expense Sequence Diagram
+Given below is the sequence diagram showing the add income/expense mechanism:
+![](images/cashflow/AddCashflowSequence.png)
+### Recurring Cashflow Feature
+Cashflow refers to an income or expense.
+
+This feature is called from the user through the `/r` argument in add income/expense command.
+
+If a cashflow is set to be recurring, the program would add another entry of the same cashflow to the Financial Planner after a set period of time.
+
+Below are the steps that shows the implementation of the recurring cashflow feature.
+
+#### Step 1
+Once the cashflow is set to be recurring, its corresponding `Cashflow` object would store the date at which the cashflow was added to the Financial Planner.
+
+The `recur` variable in the object would also be instantiated according to the user's input.
+
+An additional `boolean` variable, `hasRecurred` is stored in the object and is set to `false` by default.
+
+Example:
+```
+public abstract class Cashflow {
+    protected int recur;
+    protected LocalDate date;
+    protected boolean hasRecurred;
+}
+```
+#### Step 2
+When the Financial Planner is started again in the future, the date of startup would be obtained from the system.
+
+After loading existing saved cashflows from data.txt, the program will check for cashflows that are set to be recurring and has not recurred.
+
+Example:
+```
+if (recur > 0 && !hasRecurred) {
+    ...            
+}
+```
+
+#### Step 3
+Once a cashflow matches the above criteria, the date of its next addition to the Financial Planner, `dateOfAddition`, would be determined.
+
+`dateOfAddition` would be compared to the current date, and if the current date is after or equal to `dateOfAddition`, an identical cashflow would be instantiated.
+
+This identical cashflow would then have its `date` variable set to `dateOfAddition`, then this cashflow would be added to a temporary list, `tempCashflowList`.
+
+The original cashflow would then have its `hasRecurred` variable be set to `true`.
+
+#### Step 4
+Each cashflow in `tempCashflowList` goes through **Step 3** again, so that multiple cashflows can be added if it has recurred more than once.
+
+Once the process is done, all cashflows in `tempCashflowList` are then added to the Financial Planner.
+
+The added cashflows are then displayed to the user.
+
+#### Recurring Cashflow Class Diagram
+Given below is the class diagram showing the class structure of the recurring cashflow mechanism:
+![](images/cashflow/RecurClassDiagram.png)
+#### Recurring Cashflow Sequence Diagrams
+Given below is the sequence diagram showing the recurring cashflow mechanism:
+![](images/cashflow/RecurSequence.png)
+![](images/cashflow/AddRecurringSequence.png)
+
+### Budget Feature
+
+This feature has 5 functions, `set`, `update`, `delete`, `reset`, and `view`.
+
+![](images/Budget.png)
+
+The BudgetCommand will execute the appropriate command and print through `Budget.java` and prints any message to the user through `Ui.java`.
+
+#### Set and update budget:
+
+Example:
+```
+budget set /b 500
+budget update /b 1000
+```
+The '/b' is followed by the budget amount. The first line will set the budget by calling `setBudget(500)` method in `Budget.java`.
+The second line updates the budget by adding or subtracting the difference between the initial and updated amount to the 
+initial and current budget. This is done through `updateBudget(500)` method in `Budget.java`. Both functions can be seen 
+in the diagram above
+
+#### Delete budget:
+
+![](images/deleteBudget.png)
+
+The budget will be deleted by setting the initial and current budget to 0 through the `deleteBudget()` method in `Budget.java`.
+
+Example: `budget delete`
+
+#### Reset budget:
+
+![](images/resetBudget.png)
+
+The budget will be reset by resetting the current budget to the initial budget through the `resetBudget()` method in `Budget.java`.
+
+Example: `budget reset`
+
+#### View budget:
+
+![](images/viewBudget.png)
+
+The current budget will be shown to the user through the `Ui`.
+
+Example: `budget view`
+
 
 ## Product scope
 ### Target user profile

diff --git a/docs/Style.puml b/docs/Style.puml
@@ -0,0 +1,5 @@
+!define LOGIC_COLOR #3333C4
+!define LOGIC_COLOR_T1 #7777DB
+!define LOGIC_COLOR_T2 #5252CE
+!define LOGIC_COLOR_T3 #1616B0
+!define LOGIC_COLOR_T4 #101086
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,3 +15,4 @@ bin/

		/text-ui-test/ACTUAL.TXT
		text-ui-test/EXPECTED-UNIX.TXT
		data/