New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation and add test cases #159
Update documentation and add test cases #159
Conversation
docs/team/tohcejasmine.adoc
Outdated
3. **Enhancement**: added *stats* component | ||
** _What it does:_ allows the user to set budgets (with option of making it more specific to a type of spending). Budgets can be set retrospectively, or in the future, in addition to those that are ongoing in present time. | ||
** _Justification:_ This feature adds an additional dimension to the feature aside from the passive recording of financial activities. User can now set goals (in the form of budgets) and the application will tabulate the total amount spent so far for the user. | ||
** _Highlights:_ This enhancement is able to notify the user immediately when a budget is close to exceeding or has exceeded. How much of the budget is spent is also visually depicted in the form of a progress bar. The colours of text and numbers change depending on the status of the budget. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might want to consider:
"The enhancement includes a progress bar that indicates the level of spending and the portion of budget spent. The enhancement is notifies the student instantaneously when spending is close to exceeding or has exceeded the given budget. Moreover, colours of text and numbers change depending on the status of the budget which aids in visual feedback to the student user.
docs/team/tohcejasmine.adoc
Outdated
** _Justification:_ This feature adds an additional dimension to the feature aside from the passive recording of financial activities. User can now set goals (in the form of budgets) and the application will tabulate the total amount spent so far for the user. | ||
** _Highlights:_ This enhancement is able to notify the user immediately when a budget is close to exceeding or has exceeded. How much of the budget is spent is also visually depicted in the form of a progress bar. The colours of text and numbers change depending on the status of the budget. | ||
3. Added *stats* component | ||
** _What it does:_ Display various graphical summaries of finances depending on combination of attributes specified (attribute to group by and type of statistic). Attributes by which entries can be grouped are their entry type (spend, income, borrow, lend), transaction method, place of spending, category tagged with. There are 2 types of statistic which can be viewed, the total amount spend in that group (in the form of a pie chart) and the number of log entries in that group (in the form of a bar chart). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's quite difficult to understand this part haha
Display various graphical summaries of finances depending on the combination of attributes specified (attribute to group by and type of statistic). Entries can be grouped by their entry type (i.e. spend, income, borrow, lend), transaction method, place of spending, category tagged. There are 2 types of statistics which can be viewed, the total amount spent in that group (in the form of a pie chart) and the number of log entries in that group (in the form of a bar chart).
@@ -121,12 +121,9 @@ public LogEntry toModelType() throws IllegalValueException { | |||
LendLogEntry newLogEntry = new LendLogEntry(modelAmount, modelTransactionDate, | |||
modelDescription, modelTransactionMethod, modelLogEntryCategories, modelPerson); | |||
|
|||
if (!isRepaid.equals("true") && !isRepaid.equals("false")) { | |||
if (isRepaid == null || (!isRepaid.equals("true") && !isRepaid.equals("false"))) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do you use .equals string comparison when you could directly use the boolean?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the isRepaid is a string type, you might have to convert it into a boolean type.
null, VALID_REPAID_DATE); | ||
String expectedMessage = "Field 'isValid' is in wrong format, should either be true or false!"; | ||
assertThrows(IllegalValueException.class, expectedMessage, log::toModelType); | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job! Looks like you spent A LOT of time! Keep up the good work! haha
Closes #35, closes #105