[CS2113-W12-2] CashLeh

.gitignore

@@ -14,4 +14,3 @@ src/main/resources/docs/
 bin/
 
 /text-ui-test/ACTUAL.TXT
-text-ui-test/EXPECTED-UNIX.TXT

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: cashleh.CashLeh
+

build.gradle

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

data/testUser.txt

@@ -0,0 +1,4 @@
+[I] Income: Salary (Amount: 2000.0, Date: 31/10/2023)
+[I] Income: Bonus (Amount: 500.0, Date: 31/10/2023)
+[E] Expense: Groceries (Amount: 100.0, Date: 31/10/2023)
+[E] Expense: Utilities (Amount: 150.0, Date: 31/10/2023)

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) |     Ming Chun     | [Github](https://github.com/mcmc101001) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Shan YuXuan    | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Daniel Pappalardo | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   Benedict Chan   | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |      Kai Ning      | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)

docs/DeveloperGuide.md

@@ -2,37 +2,186 @@
 
 ## Acknowledgements
 
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+Referred to https://se-education.org/addressbook-level3/DeveloperGuide.html when drafting the DG
 
 ## Design & implementation
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Architecture
 
+![](./images/architeture.png)
+
+The Architecture Diagram given above explains the high-level design of the App.
+
+The **User** sends command which is processed by Input
+
+**Input**: Receives user input string, processes it and sends to CashLeh main app
+
+**CashLeh**: main app
+
+**UI**: Responsible for the printing onto CLI
+
+**Parser**: Process the input string and calls respective methods
+
+**FileStorage**: Reads data from, and writes data to file
+
+### How the architecture components interact with each other
+
+![](./images/main_example.png)
+
+The Sequence Diagram above shows how the components interact with each other when the user enters a command
+
+### Budget Handler
+
+![](./images/budget.png)
+
+### String Tokenizer
+
+The String Tokenizer assists in the parsing of user input. It is used to split the user input into a hashmap according to the delimiter/prefix of each command. This allows the developer to more easily customize the commands and add new commands without having to worry about the parsing of the user input.
+
+> **Example**:\
+> `addIncome money /amt 1000 /date 2021-10-10` with prefixes array `{"addIncome", "/amt", "/date"}` will be tokenized into a hash map with the following key-value pairs:\
+> `addIncome: money`\
+> `amt: 1000`\
+> `date: 2021-10-10`
+
+Delimiters can also be specified as optional by adding ":optional" to the end. This allows the user to omit the prefix when entering the command.
+
+#### Implementation
+
+The tokenize function is implemented by the StringTokenizer class. It takes in the user input and the prefixes array and returns a hashmap of the user input.
+
+![](./images/stringTokenizer.png)
+
+**Step 1**\
+Check if all necessary prefixes are present in the user input. If not, throw an exception.
+
+**Step 2**\
+Generate list of PrefixWithPosition (containing the prefix/delimiter and the position in the string) for the delimiters in the user input
+
+**Step 3**\
+Sort the list of PrefixWithPosition by position in order to get the prefixes in the correct order
+
+**Step 4**\
+Create a hashmap of the user input by splitting the string using the prefixes' positions and adding the key-value pairs to the hashmap
+
+### Transaction Filter
+The filter function assists in filtering both expenses and incomes according to the specified criterion from user's input.
+
+#### Implementation
+![](./images/FilterTransaction.png)
+
+**Step 1**\
+The filterBy() method is called, returning a FindParser object
+
+**Step 2**\
+A FilterTransaction object is constructed, with the FindParser object as one of its parameters
+
+**Step 3**\
+From the expenseStatement and incomeStatement, the financialStatement is constructed. 
+
+**Step 4**\
+Execution of the FilterTransaction class calls method findTransaction(), which prints expenses and incomes that match the provided criterion
+
+### File Storage
+
+The FileStorage class in the CashLeh? application facilitates the reading and writing of financial transaction data to and from a file. It simplifies the process of managing user data, making it easily accessible and modifiable through the following methods:
+
+#### Reading Data
+![](./images/readFromFile.png)
+
+**Step 1**\
+The `readFromFile` method checks if the specified file exists. If not, it creates an empty file with the user's name as the file path
+
+**Step 2**\
+After ensuring the file exists, the method parses the data by reading each line from the file. It distinguishes between income and expense transactions based on a type identifier
+
+**Step 3**\
+For each transaction line, the method validates the format. It checks if essential details like transaction type, description, amount, and date are present. If any information is missing or the format is corrupted, a `CashLehFileCorruptedException` is thrown
+
+**Step 4**\
+Valid transactions are used to create `Income` or `Expense` objects, depending on their type. These objects are added to the provided `IncomeStatement` and `ExpenseStatement` to populate the financial data.
+
+#### Writing Data
+![](./images/writeToFile.png)
+
+**Step 1**\
+The `writeToFile` method opens the file corresponding to the user's name  and prepares to write the financial data into the file
+
+**Step 2**\
+The method iterates over the transactions stored in the `IncomeStatement` and `ExpenseStatement` objects to collect the data
+
+**Step 3**\
+For each transaction, the method writes data in a specific format. This includes the type identifier ('I' for income and 'E' for expenses) and transaction details, ensuring structured and organized data for future retrieval
+
+**Step 4**\
+If errors occur during the write process, such as file writing issues or issues with regards to obtaining the transaction information, the method throws a `CashLehWriteToFileException`
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+* CashLeh? is a CLI program 
+* It is designed to work for a single user
+* CashLeh?'s target audience mainly comprises younger working adults and students who have limited incomes and need to 
+carefully plan out their expenses and account for their earnings
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+CashLeh? is a financial tracker made specifically for working adults who have just began to earn their first salaries
+and wages and might need some support finding the correct spending balance. College students and young workers often
+struggle with their countless expenses ranging from rent, utilities, groceries and food, tax etc. CashLeh?, though
+very simple and intuitive, is supposed to make the process of financial management seamless for them and help them avoid
+unnecessary expenses.
 
 ## 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              | be able to add my incomes and earnings             | easily manage them and obtain access to an overview                            |
+|v1.0| user              | be able to delete my incomes and earnings          | correct any mistakes and errors                              |
+|v1.0| user              | be able to view the sum of my incomes              | be fully aware of my income situation and manage my money                               |
+|v1.0| user              | be able to view the list  of all incomes           | be able to view the entire history of incomes                             |
+|v1.0| user              | be able to add my expenses and spendings             | easily manage them and obtain access to an overview                            |
+|v1.0| user              | be able to delete my expenses and spendings          | correct any mistakes and errors                              |
+|v1.0| user              | be able to view the sum of my expenses              | be fully aware of my expense situation and manage my money                               |
+|v1.0| user              | be able to view the list  of all expenses           | be able to view the entire history of expenses         
+|v2.0| user              | be able to view both incomes and expenses together | have an overview of my net financial situation                           |
+|v2.0| parsimonious user | be able to set an overall budget                   | have an upper limit for my relative expenses                            |
+|v2.0| user              | be able to view my budget                          | view my financial situation and organise myself                              |
+|v2.0| user              | be able to delete my previously set budget         | not care about an upper limit or eventually set a new budget                          |
+|v2.0| user              | be able to label categories of each income         | can know which category the income belongs to                                  |
+|v2.0| user              | be able to label categories of each expense        | can know which category the expense belongs to                                  |
+|v2.0| user              | be able to filter my transactions                  | better understand my financial history and easily access information |
 
 ## Non-Functional Requirements
 
-{Give non-functional requirements}
+1. Should work on any mainstream OS as long as it has Java 11 or above installed.
+2. The application should be easy to use for first-time users
 
 ## Glossary
 
-* *glossary item* - Definition
+* *Mainstream OS*: Windows, Linux, Unix, OS-X
 
 ## Instructions for manual testing
 
-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+### Launch and shutdown
+
+#### 1. Initial launch
+
+1. Download the jar file and copy it into an empty folder
+2. Open the terminal and run the command `java javac- Cashleh.jar`
+3. CashLeh? should launch and you can start interacting with the application
+
+### Refer to user guide for commands
+
+## Proposed implementations of future features
+
+* Create periodic income and expenses (subscription fees, salaty etc.)
+* View sum of income and expenses base on specified time range
+* Password protection when starting app
+* Able to reset password
+* More personal information in addition to name (location, age, etc.)
+* Tutorial/guide to use the app
+* Able to set preferred currency, all transaction to be converted accordingly
+* Able to change description, amount, date, and categories of transactions
+* Able to view the transaction information in graphs and charts for visualisation

docs/README.md

@@ -1,6 +1,6 @@
 # Duke
 
-{Give product intro here}
+CashLeh? is a CLI application mainly supporting working adults and students who struggle with managing finances (ranging from one-time and recurring expenses, to rent, utilities, interest rates and more). It allows them to track both their earnings and spending habits in a seamless way to have a neat overview of their financial situation.
 
 Useful links:
 * [User Guide](UserGuide.md)