[CS2113-T10-4] ExpenseTracker #10

kq2003 · 2024-09-19T03:09:15Z

Expense tracker help those who had a hard time tracking their own expenses daily. It is optimized since it saved the inputs from the user and output them efficiently.

thoriritu · 2024-10-26T18:17:55Z

src/main/java/seedu/duke/ExpenseTracker.java

+    private Map<Category, Budget> budgets = new HashMap<>();
+    private boolean isautoResetEnabled;
+    private int lastResetMonth;
+


Consider separating the class for better readability and maintainability. Having different classes for Expense, Category, and Budget would be better.

thoriritu · 2024-10-26T18:18:59Z

src/main/java/seedu/duke/ExpenseTracker.java

+                break;
+            }
+        }
+        if (existingCategory == null) {


The logic to find an existing category is repeated in multiple methods (addExpense, setBudgetLimit). Consider refactoring this into a private helper method to reduce redundancy.

thoriritu · 2024-10-26T18:22:51Z

src/main/java/seedu/duke/Duke.java

+            double amount = 0;
+            String category = null;
+
+


Consider to add a check that ensures amounts are not negative in addExpense and setBudgetLimit.

thoriritu · 2024-10-26T18:28:33Z

src/test/java/seedu/duke/ExpenseTrackerTest.java

@@ -0,0 +1,149 @@
+package seedu.duke;


Consider adding more UTs.

Lucky-Yuan00 · 2024-10-30T04:26:58Z

docs/DeveloperGuide.md

+#### delete-expense
+![Delete Expense Sequence Diagram](diagrams/DeleteExpense.png)
+
+#### tag-expense


No comments here.

Lucky-Yuan00 · 2024-10-30T04:31:25Z

docs/DeveloperGuide.md

+![Add Expense Sequence Diagram](diagrams/AddExpense.png)
+
+#### add-category
+![Add Category Sequence Diagram](diagrams/AddCategory.png)


The return method should be dashed here.

Lucky-Yuan00 · 2024-10-30T04:41:23Z

docs/DeveloperGuide.md

+
+## Design & Implementation
+### Sequence Diagrams
+#### add-expense


Calling them themselves here is missing the activation bar.

Lucky-Yuan00 · 2024-10-30T04:49:50Z

docs/DeveloperGuide.md

+#### ExpenseTracker class
+![ExpenseTracker Class Diagram](diagrams/ExpenseTrackerclass.png)
+
+#### Duke class


You should use the open arrow here.

Lucky-Yuan00

A total of four questions were found and submitted.

crystal-bys

Overall, I think it is pretty well done, just need to check formatting. Great job!

crystal-bys · 2024-10-30T06:23:39Z

docs/DeveloperGuide.md

+<!-- @@author glenda-1506 -->
+| Version | As a... | I want to... | So that I can... |
+|---------|---------|--------------|------------------|
+| v1.0    | Budget-conscious user | Quickly log an expense using a typed command (e.g., add 50 groceries) | track my spending with easy input |
+| v1.0    | Budget-conscious user | View my budget for all categories | see how much I could spend |
+| v1.0    | Budget-conscious user | Set a monthly reset for my budget tracking | start each month fresh with my budgeting |
+| v1.0    | Budget planner | View all my expenses | monitor what I have been spending on |
+| v1.0    | Frequent user | Set a budget limit for each category (e.g., set budget 200 groceries) | limit my spending according to categories |
+| v1.0    | Frequent user | Delete an expense entry (e.g., delete 5) | quickly correct mistakes |
+| v1.0    | Frequent user | Categorize expenses (e.g., add category food) | customize my expense tracking to better manage my budget |


Sorry, this is difficult to view in the html site. I have seen the User Stories here and I think it works, but you may want to check on the formatting.

crystal-bys · 2024-10-30T06:28:01Z

docs/DeveloperGuide.md

+<!-- @@author mayfairmi6 -->
+| ID  | Requirement      | Description                                          | Rationale                                             |
+|-----|------------------|------------------------------------------------------|-------------------------------------------------------|
+| 1   | Responsiveness   | The system should respond to user commands within 2 seconds. | Ensures efficient interaction and enhances user satisfaction. |
+| 2   | Data Integrity   | The system must maintain accurate tracking and updating of financial entries. | Prevents discrepancies in financial reporting, ensuring reliability. |
+| 3   | User Error Handling | The system should provide clear error messages and support easy correction of user inputs. | Facilitates management of entries and reduces user frustration. |
+| 4   | Customizability  | Users should be able to easily add and modify expense categories. | Allows users to tailor the system to their specific needs. |
+| 5   | Automated Tasks  | Support automated budget resets at the start of each month. | Minimizes user effort in maintaining accurate monthly tracking. |
+| 6   | Accessibility    | The chat interface should be simple and intuitive.   | Ensures that all users can effectively interact with the system without extensive training. |


Similarly, the formatting of this is off.

crystal-bys · 2024-10-30T06:39:19Z

docs/DeveloperGuide.md

+![Add Expense Sequence Diagram](diagrams/AddExpense.png)
+
+#### add-category
+![Add Category Sequence Diagram](diagrams/AddCategory.png)


Is the activation bar for expense tracker supposed to end here? I believe the box should not go on like this.

crystal-bys · 2024-10-30T06:47:22Z

docs/DeveloperGuide.md

+![Add Category Sequence Diagram](diagrams/AddCategory.png)
+
+#### delete-expense
+![Delete Expense Sequence Diagram](diagrams/DeleteExpense.png)


Similarly for the other diagrams as well, for the arrows pointing left (for printing something) I believe they should be dotted as well (refer to the Week 10 notes)

jinzihan2002

Good start to the DG! The sequence diagrams could perhaps be improved by extracting out segments using reference frames to improve clarity, adding activation bars for self-invocations and using dashed arrows for method returns.

jinzihan2002 · 2024-10-30T05:38:06Z

docs/diagrams/ToggleAutoReset.puml

+    ExpenseTracker -> User : No reset needed
+end
+
+deactivate ExpenseTracker


First activation bar for ExpenseTracker does not seem to be deactivated, for now it seems unclear when the first bar ends. Perhaps there should be a second deactivate ExpenseTracker here?

jinzihan2002 · 2024-10-30T06:00:28Z

docs/diagrams/ViewBudget.png

Perhaps segments of the sequence diagram could use ref frames to be shown as separate, smaller sequence diagrams? This could help reduce clutter of the sequence diagram.

jinzihan2002 · 2024-10-30T09:26:58Z

docs/diagrams/ViewExpenses.puml

+    ExpenseTracker -> ExpenseTracker : Initialize expensesByCategory Map
+
+    loop Populate Expenses By Category
+        ExpenseTracker -> Expense : Get category for each expense
+        activate Expense
+        Expense --> ExpenseTracker : Return category
+        deactivate Expense
+
+        alt Category Exists
+            ExpenseTracker -> ExpenseTracker : Add expense to existing category list
+        else New Category
+            ExpenseTracker -> ExpenseTracker : Create new category list and add expense
+        end


Perhaps the Initialize expensesByCategory Map, Add expense to existing category list and Create new category list and add expense self-invocations should include activation bars for ExpenseTracker?

jinzihan2002 · 2024-10-30T11:08:19Z

docs/diagrams/expenseclass.png

For the Expense class, as the Category association has already been shown with the line, perhaps it can be omitted from the attributes under Expense?

CT9ARyan

LGTM 👍

CT9ARyan · 2024-11-01T16:39:50Z

docs/DeveloperGuide.md

+![Tag Expense Sequence Diagram](diagrams/TagExpense.png)
+
+#### set-budget
+![Set Budget Sequence Diagram](diagrams/SetBudget.png)


Should these return arrows here be dotted instead since they are returning from the method call?? I believe a solid return arrow means the current method is performing a callback to the caller. (i.e. calling another method from the caller)

CT9ARyan · 2024-11-01T16:50:17Z

docs/DeveloperGuide.md

+#### view-expenses
+![View Expenses Sequence Diagram](diagrams/ViewExpenses.png)
+
+#### toggle-reset


Shouldn't there be a return arrow from Duke to User for the input("toggle-reset") method?? The activation bar for that method just seems to end abruptly without returning anything.

CT9ARyan · 2024-11-01T17:21:46Z

docs/DeveloperGuide.md

+![View Expenses Sequence Diagram](diagrams/ViewExpenses.png)
+
+#### toggle-reset
+![Toggle Auto Reset Sequence Diagram](diagrams/ToggleAutoReset.png)


Would it be better if the frame tag is changed to opt instead since there is no "else" case??

CT9ARyan · 2024-11-01T17:45:53Z

docs/DeveloperGuide.md

+{List here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well.}
+
+## Design & Implementation
+### Sequence Diagrams


The following applies to ALL sequence diagrams:

According to the lecture notes, the UML notation for the sequence diagrams doesn't include the entity/object at the bottom of the lifeline.

To rectify this, maybe you could include hide footbox at the top of your .puml files of your sequence diagrams?? This should resolve this issue. :)

Refactor Storage class to save all data

Refactor method of storing data to resolve corruption in data files

…r code readability

Reorganise file and categories them into different packages

Remove redundant files and lines and refactor UI

Refactor User Guide based on the updated code

Refactor User Guide grammer

added javadoc for BudgetManager and budget class

Assertion for limit added

Bug resolve

Unused code added from CurrencyConverter iteration

Individual submission:PPP

thoriritu reviewed Oct 26, 2024

View reviewed changes

Lucky-Yuan00 reviewed Oct 30, 2024

View reviewed changes

crystal-bys reviewed Oct 30, 2024

View reviewed changes

jinzihan2002 reviewed Oct 30, 2024

View reviewed changes

CT9ARyan reviewed Nov 1, 2024

View reviewed changes

glenda-1506 and others added 24 commits November 10, 2024 15:36

Add line to resolve checkstyle error

c123596

Merge pull request #201 from glenda-1506/debugBug

081e9de

Refactor Storage class to save all data

Refactor method of storing data to resolve corruption in data files

6001904

Refactor code to resovle checkstyle errors

5976dea

Refactor EXPECTED.TXT to resolve checkstyle errors

fa51f02

Merge pull request #202 from glenda-1506/debugBug

da3652c

Refactor method of storing data to resolve corruption in data files

Reorganise file and categories them into different packages for bette…

9421db1

…r code readability

Merge pull request #205 from glenda-1506/codeOrganisation

cefc4be

Reorganise file and categories them into different packages

Remove redundant files and lines

6d3e62a

Remove redundant files and lines

a75100b

Comment out failed junit test case to resolve checkstyle error

37efeff

Refactor EXPECTED.TXT and length of separator

cc1d973

Comment out unused library import to resolve checkstyle error

91fc8b1

Merge pull request #207 from glenda-1506/codeOrganisation

1263bff

Remove redundant files and lines and refactor UI

Refactor quick start and command format notes based on the updated code

4d61303

Refactor typos in quick start

33c3f08

Remove ambiguity in the features by adding details

172a1e8

Refactor file names and folder names

9c988da

Remove toggle-reset feature

ed4e99f

Add view-category feature

c77df3f

Add delete-category feature

5a710a8

Refactor diagrams and outputs

ffab6c4

Merge pull request #208 from glenda-1506/userGuide

98acbb2

Refactor User Guide based on the updated code

Remove toggle-reset feature

0941e16

MayFairMI6 and others added 30 commits November 12, 2024 13:22

Update InputParser.java

f969229

Refactor User Guide grammer

6183643

Update InputParser.java

ad3a575

Merge pull request #248 from glenda-1506/userGuide

89f2729

Refactor User Guide grammer

added javadoc for BudgetManager and budget class

1d7994d

Merge branch 'master' of https://github.com/AY2425S1-CS2113-T10-4/tp

84ffa8d

Update InputParser.java

d1a596d

Update InputParser.java

c878f3a

fixed unused tag

292aa0c

Merge pull request #249 from kq2003/master

6907d1d

added javadoc for BudgetManager and budget class

Update InputParser.java

d421743

Update InputParser.java

23a7c2d

Update InputParser.java

fea79bc

Merge pull request #247 from MayFairMI6/bug-resolve

0bce696

Assertion for limit added

Update SpendSwiftTest.java

9513c44

Update SpendSwiftTest.java

00e464c

Update ExpenseManager.java

e02a3ca

Update SpendSwiftTest.java

3695b08

Update CategoryManager.java

2c52b6d

Update SpendSwiftTest.java

88cc525

Update SpendSwiftTest.java

970edf2

Create unused code

4a209c1

Delete MayFairMI6/unused code

6130126

Merge pull request #250 from MayFairMI6/bug-resolve

28c502d

Bug resolve

Create placeholder.txt

6351d3e

Add files via upload

6c7013f

Merge pull request #251 from MayFairMI6/bug-resolve

26dc739

Unused code added from CurrencyConverter iteration

Create mayfairmi6.md

5cafbde

Delete docs/team/AravindaPPP

85dd555

Merge pull request #252 from MayFairMI6/bug-resolve

e62cc5d

Individual submission:PPP

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113-T10-4] ExpenseTracker #10

[CS2113-T10-4] ExpenseTracker #10

kq2003 commented Sep 19, 2024

thoriritu Oct 26, 2024

thoriritu Oct 26, 2024

thoriritu Oct 26, 2024

thoriritu Oct 26, 2024

Lucky-Yuan00 Oct 30, 2024

Lucky-Yuan00 Oct 30, 2024

Lucky-Yuan00 Oct 30, 2024

Lucky-Yuan00 Oct 30, 2024

Lucky-Yuan00 left a comment

crystal-bys left a comment

crystal-bys Oct 30, 2024

crystal-bys Oct 30, 2024

crystal-bys Oct 30, 2024

crystal-bys Oct 30, 2024

jinzihan2002 left a comment

jinzihan2002 Oct 30, 2024

jinzihan2002 Oct 30, 2024

jinzihan2002 Oct 30, 2024

jinzihan2002 Oct 30, 2024

CT9ARyan left a comment

CT9ARyan Nov 1, 2024

CT9ARyan Nov 1, 2024

CT9ARyan Nov 1, 2024

CT9ARyan Nov 1, 2024

[CS2113-T10-4] ExpenseTracker #10

Are you sure you want to change the base?

[CS2113-T10-4] ExpenseTracker #10

Conversation

kq2003 commented Sep 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lucky-Yuan00 left a comment

Choose a reason for hiding this comment

crystal-bys left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jinzihan2002 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CT9ARyan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment