[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)  |
+| ![](https://via.placeholder.com/100.png?text=Photo)  |     Ju Can     |     [Github](https://github.com/ju-can)      |     [Portfolio](docs/team/jucan.md)      |
+| ![](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,148 @@
 
 {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`.
+
+### "Delete" feature
+
+This mechanism is facilitated by `CommandDelete`, which extends `Command`. It makes use of the output from `Parser`,
+which takes in the user input as string and returns the index of the expense to be deleted, and the `CommandDelete`
+proceeds to remove the respective expense from the list of expenses stored in `expenseList`.
+
+`CommandDelete` implements the following operation:
+- `CommandDelete#execute()` -- Removes expense based on the index specified by user.
+
+`Parser` implements the following operation:
+- `Parser#extractIndex(userInput)` -- Extracts the index of the expense to be deleted, as specified by the user.
+
+The `CommandDelete#execute()` operation is exposed in the main `Duke` class. The `Parser#extractIndex(userInput)`
+is exposed in the `parser` class.
+
+Given below is an example usage scenario and how the 'delete' mechanism behaves at each step.
+
+![](./diagrams/DeleteFeature.png)
+
+Step 1. The user executes `delete 1` command to delete the 1st expense in the expense list. `Duke#run()` calls
+`Parser#extractCommandKeyword(userInput)` to parse the input and determine that the `delete` command is called.
+
+Step 2. `Duke` instantiates a new `CommandDelete` and calls `CommandDelete#execute()`, which then calls
+`expenseList.getExpenseList()` and `parser.extractIndex(input)`.
+
+Step 3. `CommandDelete#execute()` removes the expense at index specified by the user.
+
+### Monthly Overview
+
+This mechanism is facilitated by `CommandOverview`, which extends `Command`. It makes use of output from `Parser`
+to extract `month` and `year` from user input. It then calls on `Monthly Overview` if both `month` and 'year' 
+are not null, which makes use of `MonthFilter` to filter out expenses in that specific month and returns sum by 
+category sorted in descending order before printing out the final overview in the intended format.
+
+Given below is the sequence diagram to explain how the 'monthly overview' mechanism behaves.
+![](diagrams/MonthlyOverview.png)
+
+
+### 'Total' feature
+This mechanism is facilitated by `CommandTotal`.
+
+`CommandTotal` implements the following operations:
+- `CommandTotal#calculateTotal()` -- Iterates through the given expense list and calculates the total expenses from its amount and currency exchange rate.
+- `CommandTotal#getTotal()` -- Returns the total in 2 decimal places.
+
+
+Displayed below is a part of the class diagram for `CommandTotal`.
+![](diagrams/TotalFeature.png)
+Give below is an example usage of the feature.
+
+Step 1. The user executes `total`. Duke calls on `CommandTotal#execute()` to calculate the total expenses, which in turn calls
+`expenseList#getExpenseList()` to retrieve the expense list.
+
+Step 2. The expense list is iterated through and `total` is obtained by summing the product of each expenseAmount and rate.
 
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+- has a need to manage daily expenses
+- travels overseas often and want to keep track of their expenses throughout their travels in different currencies
+- prefer desktop apps over other types
+- can type fast
+- prefers typing to mouse interactions
+- is reasonably comfortable using CLI apps
 
 ### 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 specific expenses                                    | -                                                                                        |
+| 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              | save all expenses added                                     | -                                                                                        |
+| 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 in Singapore | see my total spending in SGD                                | -                                                                                        |
+| v2.0    | user in Singapore | see an overview of my expenses in a particular month in SGD | understand what categories I like to spend on and better plan my spending in the future. |                                                                                        |
+
 
 ## 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