[CS2113-T16-1] FinanceIt

.github/workflows/gradle.yml

@@ -33,18 +33,18 @@ 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
+#      - 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

build.gradle

@@ -29,18 +29,19 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.financeit.Financeit"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "financeit"
     archiveClassifier = null
 }
 
 checkstyle {
     toolVersion = '8.23'
 }
 
-run{
+run {
     standardInput = System.in
+    enableAssertions = true
 }

data/LastRunDateTime.txt

@@ -0,0 +1 @@
+2020-10-29T17:57:11.457197300

data/backup/die lah_at.txt

@@ -0,0 +1 @@
+23;hahasdsd;-$43000.0;;Every month;Auto deduction;nothing

data/backup/die lah_gt.txt

@@ -0,0 +1,3 @@
+Expense;4500;JANUARY
+Income;5500;JANUARY
+Expense;6500;FEBRUARY

data/backup/die lah_mt.txt

@@ -0,0 +1 @@
+Ledger;2020-05-05

data/backup/names.txt

@@ -0,0 +1,3 @@
+
+die lah
+who are you

data/backup/who are you_at.txt

@@ -0,0 +1 @@
+23;hahasdsd;-$43000.0;;Every month;Auto deduction;nothing

data/backup/who are you_gt.txt

@@ -0,0 +1,3 @@
+Expense;4500;JANUARY
+Income;5500;JANUARY
+Expense;6500;FEBRUARY

data/backup/who are you_mt.txt

@@ -0,0 +1 @@
+Ledger;2020-05-05

data/info.txt

@@ -0,0 +1,6 @@
+Name: null
+Interest: 0.0%
+Cashback: 0.0%
+Cashback Cap: $0.0
+Notes: null
+

data/save.txt

@@ -0,0 +1 @@
+Ledger;2020-05-05

data/save1.txt

@@ -0,0 +1,3 @@
+Expense;4500;JANUARY
+Income;5500;JANUARY
+Expense;6500;FEBRUARY

data/save2.txt

@@ -0,0 +1,5 @@
+1;Water and electricity bills asdasda bbHGHH KJlksjdlks  ds KAJHKJHK dksjhkshfdk j;-$3409.0;;Every month;Manual payment;JKLHSKjhksdjhfk  ksjhdfskjdhf kjsh fkjsdhfksd skjfdshfkj shfksdjh fksdjf
+2;Tuition payment;;+$1500.0;Every month;Manual payment;No tuition for May
+23;hahasdsd;-$43000.0;;Every month;Auto deduction;nothing
+25;Spotify;-$25.0;;Every month;Auto deduction;Cancel if Infinite is no longer on Spotify
+30;LKK34**(*)))&yhR$@~~!1`;-$230.56789;;Every month;Auto deduction;

docs/AboutUs.md

@@ -2,7 +2,7 @@
 
 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) | Looi Kai Wen | [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)

docs/DraftDG.md

@@ -0,0 +1,61 @@
+### Feature 2: Recurring Tracker
+####Overview
+##### Recurring Tracker
+Recurring Tracker handles the creation, deletion and editing of recurring entries.
+
+Entries use the class ```RecurringEntry```, and are stored in the ```RecurringEntryList``` class.
+
+`RecurringEntry` has the following attributes:
+* `day` - The day which the transaction occurs
+* `description`
+* `entryType` - Can be `Constants.EntryType.INC` or `Constants.EntryType.INC` 
+depending on whether the entry is an income or expenditure respectively.
+* `amount`
+* `start` and `end` - Which months does the entry apply to. Set to 1 and 12 by 
+default (i.e. occurs every month)
+* `isAuto` - Indicates whether the entry is automatically deducted/credited from/to account, 
+or manually deducted/credited from/to account
+* `notes` - Any user-specified notes
+
+`RecurringTrackerList` extends ItemList, and supports the following methods on top of inherited methods
+* `addItem(Item)` - Override. Adds item and sorts according to the day in ascending order
+* `getEntriesFromDayXtoY` - Returns an ArrayList of all entries that fall between day X and Y 
+(provided by developer in the code, not by user). Mainly used for reminders
+
+##### Reminders
+Upon launching the program, the system date and time is recorded in `RunHistory`.
+
+The program then checks if there are any entries upcoming within 5 days from the current date, and prints the entries out
+as reminders.
+
+1. Main code calls `MenuPrinter#printReminders()`, which in turn calls 
+`ReminderListGenerator#generateListOfRemindersAsStrings()`. 
+1. `ReminderListGenerator` checks the current date, and calculates the day of month which is 5 days from current date.
+This is stored in `dayToRemindUntil`.
+1. `ReminderListGenerator` then checks if `dayToRemindUntil` is after the last day of the current month. If it is,
+then the reminder timeframe will overflow to the next month. 
+
+    For example:
+    * Current date is 29th October. There are 31 days in October. 5 days after today is 34th, 
+    which is beyond last day of October.
+    * Reminder timeframe will overflow to next month, until 3rd of November
+
+1. If it has overflown, set `isOverflowToNextMonth` to true. Subtract the last day of month from `dayToRemindUntil`.
+The new value of `dayToRemindUntil` is the day of next month that the reminder timeframe extends to.
+
+    For example:
+    * Continuing from example earlier, `dayToRemindUntil = 34`.
+    * `dayToRemindUntil -= NUM_DAYS_IN_OCT`, i.e. 34 - 31
+    * `dayToRemindUntil = 3`, representing that the reminder timeframe extends to 3rd of November
+1. `ReminderListGenerator` then grabs the entries within the reminder timeframe from the list of all recurring entries.
+    * If `isOverflowToNextMonth == true`, it will grab all entries from `currentDay` to `lastDayOfMonth` 
+    and all entries from `1` (1st day of next month) to `dayToRemindUntil`
+    * Else, it will simply grab all entries from `currentDay` to `dayToRemindUntil`
+
+1. Lastly, the list of entries will be converted to a formatted String to be displayed as reminders, and passed back
+to `MenuPrinter`, who will pass it to `UiManager` to print.
+
+The sequence diagram below shows how it works:
+
+![](uml_images/recurringtracker/images/reminderSeqDiagram.png)
+

docs/README.md

@@ -1,6 +1,7 @@
-# Duke
-
-{Give product intro here}
+# FinanceIt
+FinanceIt is an all-in-one desktop application that handles the finance tracking needs of university students who are 
+comfortable with a CLI interface. It includes 5 different finance tools, all of which take in typed commands from the 
+users to execute their respective functions.
 
 Useful links:
 * [User Guide](UserGuide.md)