[CS2113-T13-2] Expense Tracker

.github/workflows/gradle.yml

@@ -31,20 +31,4 @@ jobs:
           java-package: jdk+fx
 
       - name: Build and check with Gradle
-        run: ./gradlew check
-
-      - name: Perform IO redirection test (*NIX)
-        if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (MacOS)
-        if: always() && runner.os == 'macOS'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (Windows)
-        if: always() && runner.os == 'Windows'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        shell: cmd
-        run: runtest.bat
+        run: ./gradlew check

CONTRIBUTORS.md

@@ -1,9 +1,10 @@
 # Contributors
 
-Display | Name | Github Profile | Homepage
----|:---:|:---:|:---:
-![](https://avatars0.githubusercontent.com/u/22460123?s=100) | Jeffry Lum | [Github](https://github.com/j-lum/) | [Homepage](https://se.kasugano.moe)
-![](https://avatars0.githubusercontent.com/u/1673303?s=100) | Damith C. Rajapakse | [Github](https://github.com/damithc/) | [Homepage](https://www.comp.nus.edu.sg/~damithch/)
+| Display                                                    |        Name         |            Github Profile             |                      Homepage                      |
+|------------------------------------------------------------|:-------------------:|:-------------------------------------:|:--------------------------------------------------:|
+| ![](https://media.licdn.com/dms/image/C5603AQECXBzH5HvYew/profile-displayphoto-shrink_800_800/0/1654775943351?e=1683763200&v=beta&t=2H6AN8qbcm5b9uCpDSRhNNOm2qgv4mn21XY2f1QisEM)) |   Bui Phuong Nam    |  [Github](https://github.com/j-lum/)  |        [Homepage](https://github.com/arsdorintbp2003)         |
+| ![](https://avatars0.githubusercontent.com/u/1673303?s=100) | Damith C. Rajapakse | [Github](https://github.com/damithc/) | [Homepage](https://www.comp.nus.edu.sg/~damithch/) |
+
 # I would like to join this list. How can I help the project
 
 For more information, please refer to our [contributor's guide](https://oss-generic.github.io/process/).

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.Duke
+

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# Duke project T13-2
 
 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

@@ -12,6 +12,11 @@ repositories {
 dependencies {
     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'
+
+    // https://mvnrepository.com/artifact/org.json/json
+    implementation 'org.json:json:20220924'
+
+    implementation 'org.threeten:threeten-extra:1.7.2'
 }
 
 test {
@@ -43,4 +48,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

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) |   FanZixian    |    [Github](https://github.com/FanZixian)    |   [Portfolio](docs/team/fanzixian.md)    |
+| ![](https://via.placeholder.com/100.png?text=Photo) | GohJinWeiAaron |    [Github](https://github.com/GohJW)        | [Portfolio](docs/team/gohjinweiaaron.md) |
+| ![](https://via.placeholder.com/100.png?text=Photo) | Zhang Zhitong  |  [Github](https://github.com/Zhang-Zhitong)  |  [Portfolio](docs/team/zhangzhitong.md)  |
+|                                                     |     Ju Can     |     [Github](https://github.com/ju-can)      |                                          |
+| ![](https://via.placeholder.com/100.png?text=Photo) | Bui Phuong Nam | [Github](https://github.com/arsdorintbp2003) |  [Porfolio](docs/team/BuiPhuongNam.md)   |
+

docs/DeveloperGuide.md

@@ -4,30 +4,87 @@
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
+* [JSON-java](https://github.com/stleary/JSON-java)
+* [three-ten-extra](https://www.threeten.org/threeten-extra/)
+* * Requesting and Parsing of data from API into Java
+* https://www.youtube.com/watch?v=lDEfoSwyYFg
 ## Design & implementation
-
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+## Design
+![](diagrams/Overall.png)
+Our main `Duke` class is responsible for the instantiation and launch of our application.  
+Our overall project design is split into 5 components, `command`, `common`,`data`, `storage` and `parser`.
+ - `command`: The command executor.
+ - `data`: Holds data and data structures of our application.
+ - `parser`: Reads data from the user input and parses it into an 'executable' command.
+ - `common`: Holds mainly static data that is used by multiple components.
+ - `storage`: Handles the reading and storing of our data.
+
+## Implementation
+### 'Add' feature
+This mechanism is facilitated by `CommandAdd`, which extends `Command`, as well as `ParserAdd`. `ParserAdd` parses the 
+user input into a string of words `parsedInput[]` which `CommandAdd` then stores internally. `CommandAdd` also stores an 
+internal reference to the list of expenses `expenseList` to be added to.
+
+`CommandAdd` implements the following operations:
+ - `CommandAdd#execute()` -- Instantiates the `Expense` object with the parsed inputs and adds it to `expenseList`
+ - `CommandAdd#roundInput(amount)` -- Rounds the expense amount to 2 decimal places. 
+
+`ParserAdd` implements the following operations:
+ - `ParserAdd#parseInput(userInput)` -- Parses the user input into an array of strings for `CommandAdd` to read.
+ - `ParserAdd#checkType(input)` -- Checks the type of the input corresponding to its index.
+ - `ParserAdd#substringIndex(type)` -- Returns the substring index of the start of the user input.
+
+The `CommandAdd#execute()` operation is exposed in the main `Duke` class, while the operations in `ParserAdd` are
+exposed in the `Parser` class.
 
+Given below is an example usage of the feature.
+![](./diagrams/AddFeature.png)
+
+Step 1. The user executes `add amt/24 t/02-02-2012` as the `userInput` to add a new `Expense` into the the list of 
+expenses. `Duke` calls `Parser#extractCommandKeyword(userInput)` to parse the input and determines that the `add` command is called.
+
+Step 2. `Duke` instantiates a new `CommandAdd` and calls `CommandAdd#execute()`, which in turn calls 
+`Parser#extractAddParameters(userInput)` and `ExpenseList#getExpenseList()`.
+
+Step 3. `Parser#extractAddParameters(userInput)` then calls `ParserAdd#parseInput(userInput)` and returns the parsed 
+input as a string of words `parsedInput[]`.
+
+Step 4. `CommandAdd#execute` instantiates a new `Expense` object with the returned `parsedInput[]` and adds it to
+`expenseList`.
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+- People who want to keep track of their expenses easily
+- Users who travel overseas often and want to keep track of their expenses throughout their travels
 
 ### Value proposition
 
 {Describe the value proposition: what problem does it solve?}
+- Our expense tracker is a simple program that allows users to track their expenses
+- With simple commands and ease of use, users are able to use our tracker with little to no experience.
 
 ## 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 | add a new entry for my expenses        | -                                                                |
+| v1.0    | user | delete entries                         | -                                                                |
+| v1.0    | user | add expenses with dates                | track how much I spend each day                                  |
+| v1.0    | user | add expenses of different categories   | keep track of what I spend on                                    |
+| v1.0    | user | see all my past expenses               | plan my budget accordingly                                       |
+| v2.0    | user | add expenses with specified currencies | know the exact amount I spent in different currencies            |
+| v2.0    | user | sort my expenses by category/date      | better keep track of my expenses through either date or category |
+| v2.0    | user | -                                      | -                                                                |
+| v2.0    | user | -                                      | -                                                                |
+
 
 ## Non-Functional Requirements
 
 {Give non-functional requirements}
+* Expense tracker should function with or without an internet connection.
+* Expense tracker should work even on days where the forex market is closed
 
 ## Glossary
 

docs/UserGuide.md

@@ -6,37 +6,155 @@
 
 ## 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).
+1. Down the latest version of `Duke` from [here](https://github.com/AY2223S2-CS2113-T13-2/tp/releases).
+1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar Duke.jar` command to run the application.
+1. Enter your name when prompted in the command box and press enter.
+1. Type the command in the command box and press Enter to execute it.
+   Some example commands you can try:
 
-## Features 
+   * `add amt/100 t/15-03-2023`: Add an expense entry with a value of SGD100.0 and a date of 15th March 2023 to the expense list.
+   * `list`: List all expenses in the expense list.
+   * `delete 1`: Delete the first entry in the expense list.
+   * `sort D`: Sort the expenses by date.
+   * `category food`: Find all expenses with food category.
 
-{Give detailed description of each feature}
+## Features
 
-### Adding a todo: `todo`
+### Adding an expense: `add`
 Adds a new item to the list of todo items.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+Format: `add amt/EXPENSE_AMOUNT t/TIME [cat/EXPENSE_DESCRIPTION] [cur/EXPENSE_CURRENCY]`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+* The `TIME` must be in the DD-MM-YYYY format.
+* The `EXPENSE_AMOUNT` must be an integer or decimal number.  
+* The `EXPENSE_DESCRIPTION` can be any word or phrase that does not contain the backdash symbol`/` or whitespace symbol.
+* The `EXPENSE_CURRENCY` has 22 currencies to choose from. If the input currency is not found in the list of currencies
+available, the currency will default to SGD.
+* The command parameters may be entered in any order. If multiple of the same parameter type is inputted, such as in 
+`add amt/10 amt/100 t/11-11-2023` only the first parameter `amt/10` of its kind is used.
 
-Example of usage: 
+Example of usage:
 
-`todo n/Write the rest of the User Guide d/next week`
+`add amt/10 t/11-11-2022`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+`add amt/9.5 t/01-11-2022 cat/food cur/USD`
 
-## FAQ
+Expected output:
+
+```
+____________________________________________________________
+The following expense is successfully added:
+SGD10.00 cat:uncategorized date:11/11/2022
+Now you have 1 expense in the list.
+____________________________________________________________
+```
+```
+____________________________________________________________
+The following expense is successfully added:
+    USD9.50 cat:food date:01/11/2022
+Now you have 2 expenses in the list.
+____________________________________________________________
+```
+
+
+### Listing all expenses: `list`
+List all tracked expenses in the expense list.
+
+Format: `list`
+
+* Will display `Sorry, there are no expenses tracked currently.` if expense list is empty.
+
+Example of usage:
+
+`list`
+
+
+### Deleting an expense entry: `delete`
+Delete expense entry with index X in the expense list.
+
+Format: `delete INDEX`
+
+* INDEX is entry number INDEX in the expense list displayed with `list' command, following base-1 indexing.
+* Will display `Invalid expense index. Please try again.` if INDEX is greater than number of items in the list.
+
+Example of usage:
+
+`delete 1`
+
+`delete 7`
+
+### Calculating total expenses: `total`
+Calculates the total expenses in the expense list in `SGD`.
+
+Format `total`
+
+* Whenever an entry is added into the expense list, the exchange rate for the date before the input date is recorded. As
+exchange rate data is unavailable on weekends and public holidays, the exchange rate of the previous working day is
+taken instead.
+* If no internet access is available, a preset exchange rate is taken instead.
+
+Example of usage:
+
+`total`
 
-**Q**: How do I transfer my data to another computer? 
+Expected output:
+```
+____________________________________________________________
+Your total expenses add up to:
+    SGD23.41
+____________________________________________________________
+```
+
+### Sorting all current expenses: `sort`
+Soring all current expenses in the expense list based on sortBy criteria.
+
+Format: `delete SORTBY`
+
+* SORTBY represents the criteria the user want to sort their expenses list and display by.
+* If user wants to sort the expenses list by Date, he/she should enter "D".
+* If user wants to sort the expenses list by Category through alphabet order, he/she should enter "C".
+
+Example of usage:
+
+`sort D`
+
+`sort C`
+
+### Obtaining expenses: `category`
+Obtain all the expenses with specified category, also obtain the category set to tell user what categories exist now.
+
+Format: `category CATEGORY`
+
+* CATEGORY represents the category that user want.
+* If the category doesn't belong to the categories that user have entered before, it will tell the user to switch to another one.
+* The method also will tell user how many categories they have, and also what are these categories,
+* so as to better help them with futuer obtaining purpose
+
+Example of usage:
+
+`category food`
+
+`category clothes`
+
+
+### Exiting the program: `exit`
+Exits the programn without saving expense list.
+
+Format: `exit`
+
+Example of usage:
+
+`exit`
+
+
+## FAQ
 
-**A**: {your answer here}
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+* Add expense `amt/EXPENSE_AMOUNT t/TIME cat/EXPENSE_DESCRIPTION`
+* List all expenses `list`
+* Delete entry X in list `delete X`
+* List total `total`

docs/diagrams/AddFeature.puml

@@ -0,0 +1,41 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+box 'Add'
+participant ":Duke" as Duke
+participant "parser:Parser" as Parser
+participant "parserAdd:ParserAdd" as ParserAdd
+participant "expenseList:ExpenseList" as ExpenseList
+participant ":CommandAdd" as CommandAdd
+ -> Duke: input
+Activate Duke
+Duke -> Parser: extractCommandKeyword(input)
+Activate Parser
+Parser --> Duke
+Deactivate Parser
+Duke -> CommandAdd**:
+Activate CommandAdd
+CommandAdd --> Duke
+Deactivate CommandAdd
+Duke -> CommandAdd: execute()
+Activate CommandAdd
+CommandAdd -> Parser: extractAddParameters(input)
+Activate Parser
+Parser -> ParserAdd: parseInput(input)
+Activate ParserAdd
+ParserAdd --> Parser: parsedInput
+Deactivate ParserAdd
+Parser --> CommandAdd: parsedInput
+Deactivate Parser
+CommandAdd -> ExpenseList: getExpenseList()
+Activate ExpenseList
+ExpenseList --> CommandAdd: expenseList
+Deactivate ExpenseList
+CommandAdd -> ExpenseList: add(Expense)
+Activate ExpenseList
+ExpenseList --> CommandAdd
+Deactivate ExpenseList
+CommandAdd --> Duke
+Deactivate CommandAdd
+Destroy CommandAdd
+@enduml