[CS2113-T14-3] MyLedger

.github/workflows/gradle.yml

@@ -33,18 +33,3 @@ jobs:
       - 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

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "java.debug.settings.onBuildFailureProceed": true
+}

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.myledger.MyLedger
+

README.md

@@ -1,5 +1,3 @@
-# Duke project template
-
 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.
 
 ## Setting up in Intellij

build.gradle

@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -2,8 +2,10 @@
 
 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)
+
+![](https://media.licdn.com/dms/image/D5603AQFoLJj5VasfWw/profile-displayphoto-shrink_400_400/0/1665324716061?e=1683158400&v=beta&t=OXy8Oh26Bm-xSxVVFL2wdqlkH9SheVixmyDufg936b4) | Lee Zhi Xuan | [Github](https://github.com/itszhixuan) | [Portfolio](https://github.com/itszhixuan)
+![](image.png) | Leo Zheng Rui, Darren | [Github](https://github.com/dsicol) | [Portfolio](https://github.com/dsicol)
+![](https://via.placeholder.com/100.png?text=Photo) | Leonardo Ong Dingchao | [Github](https://github.com/Chick3nBoy) | [Portfolio](docs/team/leonardoOng.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Tan Tze Loong | [Github](https://github.com/TzeLoong) | [Portfolio](docs/team/TzeLoong.md)
+
+

docs/README.md

@@ -1,6 +1,11 @@
-# Duke
+# MyLedger
 
-{Give product intro here}
+<p align="center">
+    <img src="team/images/MyLedger.jpeg" width="30%">
+</p>
+
+MyLedger is a desktop app for managing finances, designed for university students studying locally or on exchange. It is optimized for use via a Command Line Interface (CLI). For students that can type fast, MyLedger can help them record and classify their transactions into categories. Students can expect to get an overview of their transactions at a glance,
+which helps them to monitor their budget and expenses more effciently.
 
 Useful links:
 * [User Guide](UserGuide.md)

docs/team/chick3nboy.md

@@ -0,0 +1,39 @@
+# Leonardo Ong Dingchao - Project Portfolio Page
+
+## Overview
+MyLedger is a desktop app for managing finances, designed for university students studying locally or on exchange. It is optimized for use via a Command Line Interface (CLI). For students that can type fast, MyLedger can help them record and monitor their budget and expenses, managing their transactions more effciently.
+
+### Summary of Contributions
+#### Main Features Implemented:
+
+1. Storage for MyLedger
+   - **What it does** : Processes the list of expenditures in MyLedger, updating the text file with the save information after every command, and initializing the list
+   when MyLedger begins running.
+   - **Justification**: This allows the program to remember past user inputs, making MyLedger a more effective ledger.
+   - **Highlights**: This feature is an essential part of MyLedger, as the programme being unable to store past entries defeats the purpose of a ledger.
+   The challenge of the implementation came in the form of having to account for how to store the different types of expenditures, with some expenditures having more fields than others, as well as account for how to deal with a corrupted save file.
+
+2. View command
+   - **What it does**: `ViewTypeCommand` and `ViewDateCommand` with the command `viewtype` and `viewdate` shows the user a filtered list of expenditures that have a specific command or date, as well as tallying the total amount of the expenditures filtered by the list.
+   - **Justification**: With MyLedger being an app that allows users to monitor their budget and expenses, this feature allows the user to more effiently track their expenditures of each type or date.
+   - **Highlights**: Implementing `ViewTypeCommand` was more challenging compared to `ViewDateCommand`. `ViewDateCommand` could be done by comparing the input LocalDate with the LocalDate attribute stored within each expenditure, whereas for `ViewTypeCommand` the expenditure type does not have an attribute allocated to it, and a getType method, which returns a different string based on expenditure type, was needed for comparison. 
+
+3. Currency feature
+   - **What it does**: A new class containing the currency values of the countries with universities partnered with NUS based on SGD. `showrates` is a command that lists out all these curries values and the List and View commands have been added with a currency field, that allows the user to output the expenditure amount in the desired currency. 
+   - **Justification**: This implementation value adds MyLedger in making the app more convenient for exchange students studying in NUS, giving them a gauge on how much their expenditure is in their home currency.
+   - **Highlights**: Initially we proposed using an API to constantly update the currencies values of the feature, however considering the large amounts of potential bugs and requiring internet connection, we decided the app would benefit more from being concise and using a constant value that servers as a rough gauge. The challenges faced when implementing this feature comes from all of the methods involved in printing an expenditure already using the toString method without a currency field, and changing the toString to include that field would introduce further issues, thus a new method that functions similarly to toString had to be implemented.
+
+#### Code Contributed: [RepoSense Link](https://nus-cs2113-ay2223s2.github.io/tp-dashboard/?search=Chick3nBoy&sort=totalCommits%20dsc&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2023-02-17&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=Chick3nBoy&tabRepo=AY2223S2-CS2113-T14-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
+
+#### Documentation: 
+1. User Guide:
+   - Added instructions for Quick Start
+
+2. Developer Guide
+   - Added architecture diagram and documentation. 
+   - Added documentation and sequence diagram for `Storage`, `View Command`, and `Currency`
+
+#### Team-based Tasks
+1. Attended and contributed to weekly discussions
+2. PR reviewed with non-trivial review comments [#18](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/18) , [#41](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/41) , [#134](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/134), [#145](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/145)
+3. Non-trivial bug fixes: [#28](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/28/commits)

docs/team/dsicol.md

@@ -0,0 +1,65 @@
+# Leo Zheng Rui, Darren - Project Portfolio Page
+
+## Overview
+
+MyLedger is a desktop app for managing finances, designed for university students in the National University of Singapore (NUS), studying locally or on exchange. It is optimized for use via a Command Line Interface (CLI). For students that can type fast, MyLedger can help them record and classify their transactions into categories. This helps them to monitor their budget and expenses more efficiently.
+
+### Summary of Contributions
+#### Main Features Implemented:
+
+**The expenditure package**
+   - **What it does** : Contains all the classes and operations for the fixed expenditure types and expenditure list.
+   - **Justification**: The fixed expenditures in the program can be instantiated as real world expenditure, and kept track of in the application's expenditure list. Since the application aims to help users add and to manage expenditures, the package of classes forms the core of MyLedger.
+   - **Highlights**: This feature sets the direction of MyLedger. Thus, deciding the attributes of each class played an important role in setting the trajectory of the application; brainstorming the important information the target user would need in their expenditure record.
+
+**The Command Classes for all fixed expenditure types**
+   - **What it does**: Contains all the command classes for the fixed expenditure types and to display expenditure list. Additionally, the `CommandResult.java`class displays to the user the result of the command after each successful execution.
+   - **Justification**: With the help of MyLedger's parsing unit, the user's input are broken down and fed into their respective command class. The execution of these command classes produces the user's desired outcome (i.e. adding an academic expenditure into the current expenditure list).
+   - **Highlights**: The implementation of the command classes requires good coordination with the implementor of the parsing class as they would need information on how each expenditure command is instantiated; it was done well.
+<div style="page-break-after: always;"></div>
+**The Sort Command**
+   - **What it does**: Sorts the expenditure list in ascending or descending amount, or from the latest or earliest dates. 
+   - **Justification**: This allows users to sort their expenditures to gain better insight to manage them; to rank the expenditures that spent the most/least money, or ones that have added the most recently/earliest.
+   - **Highlights**: The feature will change the order of the expenditure list for future reference. This is done to improve user experience while navigating the sorted list after calling the command.
+
+**The repeating date of the Accommodation and Tuition Expenditures**
+   - **What it does**: The `AccommodationExpenditure` and `TuitionExpenditure` takes in a date of repeat. Whether or not the aforementioned expenditures have been marked beforehand, this feature ensures the the expenditures are unmarked after 1 full year.
+   - **Justification**: The `AccommodationExpenditure` and `TuitionExpenditure` are lump sum payments and must be paid within a period of time. The nature of these expenditures are repeating and thus, users can trust MyLedger to unmark the aforementioned expenditures to serve as an annual reminder.
+   - **Highlights**: This was a challenging feature as `LocalDate` is used extensively to compare the dates. Additionally, the method must be ran for the check to be ran, thus this is implemented in the main loop logic of the program. After a year has passed, the program will retain the day and month values of the repeat date, and increment the year. This will only run once every year and only ran after the specified date is reached or passed.
+
+**Fix save file reading related bugs**
+   - **What it does**: The save file stores all expenditures from the most recent expenditure list.
+   - **Justification**: Upon corruption of the save file, the program oringally crashes. With the fixes, only individual corrupted expenditures are deleted, uncorrupted expenditures can still be loaded.
+   - **Highlights**: Considering all possible combinations for corruption was challenging. Now the save file reading complies with the input rules defined by the application.
+
+#### Code Contributed: [RepoSense Link](https://nus-cs2113-ay2223s2.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2023-02-17&tabOpen=true&tabType=authorship&tabAuthor=dsicol&tabRepo=AY2223S2-CS2113-T14-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
+
+<div style="page-break-after: always;"></div>
+
+#### Project Management:
+1. Milestones:
+   - Managed all milestones: `v1.0`, `v2.0` and `v2.1`.
+   - Managed all releases: `v1.0`, `v2.0` and `v2.1` (3 releases) on github.
+
+#### Enhancement to existing features:
+1. Enhancements:
+   - Improved `AccommodationExpenditure` and `TuitionExpenditure` to be unmarked 1 year after setting it. This is due to the repeating nature of these expenditures. (Pull request [#132](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/132))
+   - Wrote additional tests for the command classes to increase test coverage (Pull request [#40](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/40)).
+   - Fix save file reading bugs (Pull request [#145](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/145), [#153](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/153)).
+
+#### Documentation: 
+1. User Guide:
+   - Added the MyLedger command summary: [#68](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/68/files#diff-b50feaf9240709b6b02fb9584696b012c2a69feeba89e409952cc2f401f373fb)
+   - Added user guide for `mark`, `unmark`, `set`, `check`, `list`, `find`, `sort`, `viewtype` and `viewdate`: [#78](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/78)
+
+2. Developer Guide
+   - Added documentation and class diagram for **Expenditure categories**.
+   - Added documentation and sequence diagram for `repeatDate` process.
+   - Added documentation and class diagram for **Command component**.
+   - Added documentation and sequence diagram for **Add expenditure command** in the **Command List** section.
+   - Added documentation and explanations for the `SortCommand`.
+
+#### Team-based Tasks
+1. Initiated, led, and contributed to weekly discussions.
+2. PR reviewed with non-trivial review comments [#22](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/22), [#151](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/151), [#144](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/144), [#167](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/167)
+3. Non-trivial bug fixes: [#127](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/127), [#145](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/145), [#153](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/153)

docs/team/itszhixuan.md

@@ -0,0 +1,42 @@
+# Lee Zhi Xuan - Project Portfolio Page
+
+## Overview
+MyLedger is a desktop app for managing finances, designed for university students studying locally or on exchange. It is optimized for use via a Command Line Interface (CLI). For students that can type fast, MyLedger can help them record and monitor their budget and expenses, managing their transactions more effciently.
+
+### Summary of Contributions
+#### Main Features Implemented:
+
+1. Parser for each command
+   - **What it does** : Processes the inputs made by the user and converts it into its respective `Command` object for further processing. 
+   - **Justification**: This allows the program to interact with the user by understand the user inputs made.
+   - **Highlights**: This enhancement is required for all subsequent enhancements, which required extensive testing to prevent errors when reading inputs. To reduce duplicate code, each specific parse class will call on `ParseIndividualValue` to efficiently parse all input parameters and commands from a user.
+         The implementation was challenging as each parsing action required a specific command class that had to inherit from `Command` and adhere to its guidelines. Also as previously mentioned, the challenge was also to consider all possible inputs that might result in our application not working.
+
+2. Comparing budget with expenditures
+   - **What it does**: `SetBudgetCommand` with the command `set` allows the user to input a positive numerical value that is not 0 that indicates their existing budget. `CheckBudgetCommand` with the command word `check` will then compare the budget with the sum of all expenditures made by the user. Output will display the current financial status compared to their budget. User can also compare budget with optional filters such as expenditure type, which would provide a better insight to expenditures under a certain category.
+   - **Justification**: With MyLedger being an app that allows users to monitor their budget and expenses, this will bridge the two together and provide insights on their current financial status with their budget.
+   - **Highlights**: The challenge of comparing budget with all expenditures is having to consider the user inputs and different expenses. `Borrow` and `lend` are not considered official expenditures and would still require to be paid back, while other factors such as `marked` will also affect the total expenditure used to compare with their budget. The message output should also provide enough insights into their financial status. Separately, the expenditure types are optional parameters from the user, which provided a different challenge of having to accept optional inputs and inputs with just the `check` function.
+
+3. Duplicate Command
+   - **What it does**: Duplicates existing inputs in the list.
+   - **Justification**: For repeated expenditures, it reduces the hassle of having to input all expenditure parameters again
+   - **Highlights**: This enhancement provides an alternative way to create similar expenditures. Implementing this functionality requires reading the data on the txt.file and subsequently writing on it.
+
+#### Code Contributed: [RepoSense Link](https://nus-cs2113-ay2223s2.github.io/tp-dashboard/?search=itszhixuan&sort=totalCommits%20dsc&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2023-02-17&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=itszhixuan&tabRepo=AY2223S2-CS2113-T14-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
+
+#### Documentation: 
+1. User Guide:
+   - Added instructions for Quick Start
+   - Adding documentation for new features under list and check for v2.1
+
+2. Developer Guide
+   - Added documentation and sequence diagram for `Parser` 
+   - Added sequence diagram for `check`
+   - Added user stories
+   - Added all possible instructions for instructors to manual test
+
+#### Team-based Tasks
+1. Attended and contributed to weekly discussions
+2. PR reviewed with non-trivial review comments [#30](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/30)
+, [#40](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/40) , [#49](https://github.com/AY2223S2-CS2113-T14-3/tp/pull/49)
+3. Non-trivial bug fixes: [#90](https://github.com/AY2223S2-CS2113-T14-3/tp/issues/90)