[CS2113-W14-3] FinanceBuddy

.gitignore

@@ -15,3 +15,10 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+.vscode/
+
+data/
+data/FinancialList.txt
+data/Budget.txt
+META-INF/MANIFEST.MF

build.gradle

@@ -43,4 +43,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) | Juven Lim Heng Yi | [Github](https://github.com/Littleme1032) | [Portfolio](team/juvenlim.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Verity Lim     |   [Github](https://github.com/kestryix)   | [Portfolio](team/kestryix.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   Lim Kong Kiat   | [Github](https://github.com/limkongkiat)  | [Portfolio](team/limkongkiat.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Tsou Teng Yuan   |   [Github](https://github.com/tsoudibi)   | [Portfolio](team/tengyuantsou.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Cheng Tze Yong   |   [Github](https://github.com/ctzeyong)   | [Portfolio](team/ctzeyong.md)
+

docs/README.md

@@ -1,6 +1,8 @@
-# Duke
+# Finance Buddy
 
-{Give product intro here}
+Finance Buddy is a software that allows university students to log their daily expenditures
+to help manage their budgets. Users can add, delete and edit expenditure logs into the app as
+well as list out all their logged transactions
 
 Useful links:
 * [User Guide](UserGuide.md)

docs/UML/CommandInheritance.puml

@@ -0,0 +1,44 @@
+@startuml
+
+abstract class Command {
+    {abstract}+execute() : void
+}
+
+class SeeAllEntriesCommand {
+}
+
+class SeeAllExpensesCommand {
+}
+
+class SeeAllIncomesCommand {
+}
+
+class AddExpenseCommand {
+}
+
+class AddIncomeCommand {
+}
+
+class DeleteCommand {
+}
+
+class EditEntryCommand {
+}
+
+class ExitCommand {
+}
+
+class HelpCommand {
+}
+
+Command <|-- SeeAllEntriesCommand
+SeeAllEntriesCommand <|-- SeeAllExpensesCommand
+SeeAllEntriesCommand <|-- SeeAllIncomesCommand
+Command <|-- AddExpenseCommand
+Command <|-- AddIncomeCommand
+Command <|-- DeleteCommand
+Command <|-- EditEntryCommand
+Command <|-- ExitCommand
+Command <|-- HelpCommand
+
+@enduml

docs/UML/DeleteCommandSequenceDiagram.puml

@@ -0,0 +1,44 @@
+@startuml
+actor User
+participant "Logic" as L
+participant "DeleteCommand" as DC
+participant "FinancialList" as FL
+participant "BudgetLogic" as B
+participant "Storage" as ST
+
+User -> L: Enters "delete [INDEX] [/to ENDINDEX]"
+activate L
+
+alt Single Entry Deletion
+    L -> DC: Create DeleteCommand for INDEX
+    activate DC
+    DC -> FL: Remove entry at INDEX
+    deactivate DC
+    opt If entry is an Expense
+        L -> B: Update budget balance
+    end
+else Range Deletion
+    loop For each entry in range [INDEX, ENDINDEX]
+        L -> FL: Remove entry at current index
+        opt If entry is an Expense
+            L -> B: Update budget balance
+        end
+    end
+else Delete Last Amended
+    L -> FL: Remove last amended transaction
+    opt If entry is an Expense
+        L -> B: Update budget balance
+    end
+else Delete All
+    L -> FL: Clear all entries
+    opt If expenses are cleared
+        L -> B: Reset budget balance
+    end
+end
+
+L -> ST: Update storage with FinancialList and BudgetLogic
+ST --> L: Acknowledge update completion
+
+L -> User: Display confirmation message
+deactivate L
+@enduml

docs/UML/FinancialEntryClass.puml

@@ -0,0 +1,27 @@
+@startuml
+abstract class FinancialEntry {
+    - double amount
+    - LocalDate date
+    - String description
+    + getAmount() : double
+    + getDescription() : String
+    + getDate() : LocalDate
+    + setAmount(double newAmount)
+    + setDescription(String newDescription)
+    + setDate(LocalDate newDate)
+}
+
+class Income {
+    + toString() : String
+    + toStorageString() : String
+}
+
+class Expense {
+    + toString() : String
+    + toStorageString() : String
+}
+
+FinancialEntry <|-- Income
+FinancialEntry <|-- Expense
+
+@enduml

docs/UML/FinancialEntrySequence.puml

@@ -0,0 +1,67 @@
+@startuml
+skinparam sequenceMessageAlign center
+skinparam responseMessageBelowArrow true
+
+
+participant "FinancialList" as list
+participant "FinancialEntry" as entry
+participant "Income" as income
+participant "Expense" as expense
+
+== Add Entry ==
+activate list
+list -> list : shouldDecrementIndex(entry, index)
+loop while shouldDecrementIndex == true
+    list -> entry : getDate()
+    list -> entry : getDate() for previous entry
+    return date
+end
+list -> entry : add(insertIndex, entry)
+list -> list : updateCategoryTotal(entry)
+alt entry instanceof Income
+    list -> income : instanceof?
+    return isIncome
+    list -> list : updateCategoryTotal(Income)
+else entry instanceof Expense
+    list -> expense : instanceof?
+    return isExpense
+    list -> list : updateCategoryTotal(Expense)
+end
+deactivate list
+
+== Delete Entry ==
+list -> list : deleteEntry(index)
+activate list
+list -> entry : remove(index)
+return
+deactivate list
+
+== Edit Entry ==
+list -> list : getEntry(index)
+activate list
+list -> entry : setAmount(newAmount)
+deactivate list
+entry -> entry : setDescription(newDescription)
+entry -> entry : setDate(newDate)
+alt entry instanceof Income
+    entry -> income : setCategory(newCategory as Income.Category)
+    return
+else entry instanceof Expense
+    entry -> expense : setCategory(newCategory as Expense.Category)
+    return
+end
+
+== View Entry ==
+list -> list : getEntry(index)
+activate list
+list -> entry : toString()
+deactivate list
+alt entry instanceof Income
+    entry -> income : toString()
+    return incomeString
+else entry instanceof Expense
+    entry -> expense : toString()
+    return expenseString
+end
+
+@enduml

docs/UML/FinancialListAndFinancialEntry.puml

@@ -0,0 +1,43 @@
+
+@startuml
+abstract class FinancialEntry {
+    - String description
+    - double amount
+    - LocalDate date
+    {abstract} + getCategory() : Enum<>
+}
+
+class FinancialList {
+    - ArrayList<FinancialEntry> entries
+    - Map<Expense.Category, Double> totalExpenseByCategory
+    - Map<Income.Category, Double> totalIncomeByCategory
+    + FinancialList()
+    + addEntry(FinancialEntry entry) : void
+    + deleteEntry(int index) : void
+    + editEntry(int index, double amount, String description, LocalDate date, Enum<?> category) : void
+    + getEntry(int index) : FinancialEntry
+    + getEntryCount() : int
+    + getTotalExpenseByCategory() : Map<Expense.Category, Double>
+    + getTotalIncomeByCategory() : Map<Income.Category, Double>
+    + getHighestExpenseCategory() : Map.Entry<Expense.Category, Double>
+    + getHighestIncomeCategory() : Map.Entry<Income.Category, Double>
+    + clearCategoryTotals() : void
+}
+
+class Income {
+    - Category category
+    + Income(double amount, String description, LocalDate date, Category category)
+    + getCategory() : Income.Category
+}
+
+class Expense {
+    - Category category
+    + Expense(double amount, String description, LocalDate date, Category category)
+    + getCategory() : Expense.Category
+}
+
+FinancialList "1" --> "*" FinancialEntry
+FinancialEntry <|-- Income
+FinancialEntry <|-- Expense
+
+@enduml

docs/UML/LogicSequence.puml

@@ -0,0 +1,42 @@
+@startuml
+actor User
+User -> Logic : editEntry(commandArguments)
+activate Logic
+
+Logic -> Logic : parseIndex(commandArguments.get("argument"))
+Logic -> FinancialList : getEntry(index - 1)
+activate FinancialList
+FinancialList --> Logic : FinancialEntry (entry)
+deactivate FinancialList
+
+Logic -> Logic : parseAmountOrDefault(commandArguments.get("/a"), entry.getAmount())
+Logic -> Logic : parseDateOrDefault(commandArguments.get("/d"), entry.getDate())
+
+alt entry is Expense
+    Logic -> Logic : updateExpenseBalance(entry, amount, date)
+    Logic -> BudgetLogic : changeBalanceFromExpense(entry.getAmount(), entry.getDate())
+    activate BudgetLogic
+    BudgetLogic --> Logic : balance updated
+    deactivate BudgetLogic
+    Logic -> BudgetLogic : changeBalanceFromExpenseString(-amount, date)
+    activate BudgetLogic
+    BudgetLogic --> Logic : balance updated
+    deactivate BudgetLogic
+end
+
+Logic -> Logic : getCategoryFromInput(commandArguments, entry)
+alt category specified
+    Logic -> Logic : parseCategory(categoryStr, entry)
+end
+@enduml
+
+@startuml
+Logic -> EditEntryCommand ** : new EditEntryCommand(index, amount, description, date, category)
+
+ref over EditEntryCommand : Run command
+EditEntryCommand --> Logic : Command successfully executed
+
+
+Logic --> User : Entry edited successfully
+deactivate Logic
+@enduml

docs/UML/SeeAllEntriesExecution.puml

@@ -0,0 +1,69 @@
+@startuml
+skinparam sequenceMessageAlign center
+skinparam responseMessageBelowArrow true
+
+participant ":SeeAllEntriesCommand" as cmd
+participant "financialList:FinancialList" as list
+participant ":FinancialEntry" as entry
+
+
+
+
+cmd -> list : clear Category totals
+activate list
+return
+
+cmd -> list : getEntryCount()
+activate list
+return financialListEntryCount
+
+loop i < financialListEntryCount
+    cmd -> list : getEntry(i)
+    activate list
+    return entry
+
+    cmd -> cmd : shouldBeIncluded(entry)
+    activate cmd
+    return decision to include entry
+
+    opt entry should be included
+        cmd -> cmd : increment this.entryCount
+        activate cmd
+        return
+
+        cmd -> entry : toString()
+        activate entry
+        return entryString
+        cmd -> cmd : append to entryList
+        activate cmd
+        return
+
+        cmd -> cmd : add/substract amount from net cashflow
+        activate cmd
+        return
+        cmd -> list : update total expense/income in category
+        activate list
+        return
+    end
+end
+
+alt this.entryCount == 0
+    cmd -> cmd : print no entry message
+        activate cmd
+        return
+else else
+    cmd -> cmd: print entryList with net cashflow
+        activate cmd
+        return
+    cmd -> list : getHighestExpenseCategory()
+    activate list
+    return highestExpenseCategory
+    cmd -> list : getHighestIncomeCategory()
+    activate list
+    return highestIncomeCategory
+    cmd --> cmd: print Highest Expense/Income category and amount spent/earned
+    activate cmd
+    return
+end
+
+@enduml