[CS2113-W12-2] Moolah Manager by wcwy · Pull Request #5 · nus-cs2113-AY2223S1/tp

wcwy · 2022-09-28T05:09:18Z

Financial bookkeeping via traditional mobile applications has always been a hassle due to the repetitive clicks needed to manage monetary transactions. With Moolah Manager, you will be encouraged to take ownership of managing your finances via a time-saving and efficient command-line (CLI) interface.

The main features of Moolah Manager include:

Managing records of monetary transactions
Gathering financial insights such as categorical savings and periodic expenditure
General budgeting and reminders about spending

Revert "commit"

xzynos

The developer guide is very well done. It is clear, concise, and the diagrams included helps the user to understand the program easily.

xzynos · 2022-10-26T03:10:01Z

+## Preface
+
+Moolah Manager is a desktop app for managing your finances, optimised for use via a Command Line Interface (CLI). Designed for people who are
+fast typists, it can help to process day-to-day transactions, namely your incomes and expenses. These can help you to see all your transactions
+and provide you with a valuable insight into your spending habits.
+
+This document is meant to assist potential users and developers in understanding how our program works.


The preface section gives a good introduction to your project!

Thanks a lot for your detailed feedback, Fang Jie! Our team appreciates it and will work towards the suggestions that you have provided to improve our developer guide.

xzynos · 2022-10-26T03:13:14Z

+### Architecture
+![Architecture Diagram](images/ArchitectureDiagram.png)
+The Architecture Diagram shown above explains the high-level design of Moolah Manager. 
+The `Duke` class contain the main method which holds the responsibility for the following:
+1. On application launch, it will initialise the `UI`, `Storage` and `Data` components. 
+2. During application execution, it will interact with `UI`, `Parser`, `Command` components 
+to execute the command entered by the users.
+3. On any exception caught, it will handle the exception and interact with the `UI` to display the error message.
+
+`Common` represents a collection of classes or enums used by multiple components.
+
+The rest of the application consists of six components:
+ - `UI`: The user interface of Moolah Manager
+ - `Parser`: Parser for user's entered command.
+ - `Command`: The command executor.
+ - `Data`: Holds the data of the application in memory.
+ - `Storage`: File I/O to store the data onto the hard disk.


The software architecture section provides a clear and easily understandable description of how the software is designed.

xzynos · 2022-10-26T03:16:41Z

+
+#### How the architecture components interact with each other
+The sequence diagram below shows how the components interact on command `budget b/1000`.
+![Architecture Interaction](images/ArchitectureSequenceDiagram.png)


Good use of notes to describe the limitations of the UML tool with regards to the lifeline.

xzynos · 2022-10-26T03:17:39Z

+1) `Add` - Adds an `Income` or `expense` type transaction into the list of transaction. [Add Command](#add-command)
+2) `Budget` - Adds an `Budget` into Moolah Manager, which sets the basis for financial tracking. [Budget Command](#budget-command)
+3) `Bye` - Exits Moolah Manager. [Bye Command](#bye-command)
+4) `Delete` - Deletes an `Income` or `expense` type transaction from the list of transaction. [Delete Command](#delete-command)
+5) `Edit` - Edits an `Income` or `expense` type transaction from the list of transaction. [Edit Command](#edit-command)
+6) `Find` - Searches for an `Income` or `expense` type transaction from the list of transaction given keywords. [Find Command](#find-command)
+7) `Help` - Outputs the usage of commands of Moolah Manager. [Help Command](#help-command)
+8) `List` - List all transactions. [List Command](#list-command)
+9) `Purge` - Deletes all transactions from the list of transaction. [Purge Command](#purge-command)
+10) `Stats` - View statistics on transactions based on the list of transactions in Moolah Manager. [Stats Command](#stats-command)


I believe the numbered list may not be rendered correctly on the site.

Indeed it is not rendered correctly, we will have to amend this. @brian-vb do note to update the numbering in markdown format (e.g. 1., 2., ...)

xzynos · 2022-10-26T03:21:26Z

+
+### Edit Command
+
+{Describe the implementation for the Edit Command}


Do add the description for Edit Command.

xzynos · 2022-10-26T03:25:21Z

-## Product scope
 ### Target user profile

 {Describe the target user profile}


Do add the description for your target user profile.

xzynos · 2022-10-26T03:26:12Z

-## Glossary
+## Appendix D: Glossary

 * *glossary item* - Definition


Do add definitions to your glossary to help the user understand the terms you've used.

xzynos · 2022-10-26T03:41:45Z

+help messages to the users.
+
+The structure of the application focusing on the help command is illustrated in the class diagram below:
+![Data Component Class Diagram](images/HelpClassDiagram.png)


I believe the HelpMessage class can be omitted and replaced with a note instead.

xzynos · 2022-10-26T03:45:52Z

+parsers are used to generate a command object with its accurate parameters according to the input from the UI. 
+
+The structure of the data component in Moolah Manager is illustrated in the class diagram below:
+![Data Component Class Diagram](images/ParserClassDiagram.png)


Do consider removing some functions in the ParameterParser class if they are not used to describe how the component works.

xzynos · 2022-10-26T03:51:02Z

+### Architecture
+![Architecture Diagram](images/ArchitectureDiagram.png)
+The Architecture Diagram shown above explains the high-level design of Moolah Manager. 
+The `Duke` class contain the main method which holds the responsibility for the following:


May I check if the name of the application is still Duke?

Yup @xzynos , the main class name for Moolah Manager will be Duke.

…on in StatsCommand

…ases

Add command cheat sheet to User Guide

Fixed Param Errors

Added guides for command format, help command and budget command

MIN_AMOUNT_VALUE is now correctly representing the minimum amount that a user can set for a transaction.

UG command format help budget

…ctions

…to fit time_insights

Edit Storage method header comments

…into chinHan-AddPPP

Updated PPP and UG.

Class Diagrams Revamp

…into chinHan-AddPPP

Update size of my diagrams

Fix storage date parse bug

Add missing tag for help message and rephrase unclear words used

DG changes for Edit and Delete

…yExpenditure

Final PPP Push

Fix minor sequence diagram issue pre-release

Fix DG outdated value

redders7 referenced this pull request in AY2223S1-CS2113-T18-1b/tp Oct 18, 2022

Merge pull request #5 from AY2223S1-CS2113-T18-1/revert-4-test

8669588

Revert "commit"

xzynos reviewed Oct 26, 2022

View reviewed changes

chinhan99 and others added 27 commits October 26, 2022 19:47

Update minimum transaction value

7ca0e1d

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-2/tp

9834d32

Update list description in Command Summary and Fix Arithmatic excepti…

543cf79

…on in StatsCommand

Update List description in Command Summary

ece5e2b

Update ListCommand COMMAND_PARAMETERS_INFO

f30ed74

Update test files and reformat lines in ListCommand

4945315

Update MIN_AMOUNT_VALUE

0285676

Update parser check on minimum amount for Transactions and add test c…

acb069d

…ases

Update parameter naming in command summary

23fbf53

Update Optional tag description for readability

16ee27c

Fix Stats Param Parser

7257f30

Fix Stats Bugs

e638d2c

Merge pull request #146 from chinhan99/chinHan-addUserGuide

e979550

Add command cheat sheet to User Guide

Merge pull request #148 from paullowse/paul-ParamParserFix

7be807b

Fixed Param Errors

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-2/tp

c00792f

Update UserGuide.md

3a1b745

Added guides for command format, help command and budget command

Change the value of MIN_AMOUNT_VALUE and update logic accordingly

40ebbee

MIN_AMOUNT_VALUE is now correctly representing the minimum amount that a user can set for a transaction.

Modify the wordings used in UG for clearer constraint description

164d89c

Change usage of "numerals" to "whole number" and move min-max constants

e962f2c

Changing the usage of "between ... and" as per @chinhan99 suggestion

ce1f507

Merge pull request #149 from wcwy/UG-commandFormat-help-budget

587f926

UG command format help budget

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-2/tp

e85b3ba

Add content for Introduction, Setting Up, List and Find Commands

d948865

Update EXPECTED.TXT to reflect the change for "at" to "on" for transa…

dbe9f9f

…ctions

Remove duplicated code in TransactionList class, amend existing code …

d8fd309

…to fit time_insights

Add figure to detail how to download the latest JAR file

b1d34f5

Amend the size of Figure 1

e0b3a91

chinhan99 and others added 30 commits November 6, 2022 19:47

Update budget exception comment

7b2c55b

Merge pull request #255 from chinhan99/chinHan-AddStorage

20bb817

Edit Storage method header comments

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-2/tp …

ba494d5

…into chinHan-AddPPP

Update PPP and UserGuide

58f4eb1

Merge pull request #256 from chinhan99/chinHan-AddPPP

cb8fb6d

Updated PPP and UG.

Class Diagrams Revamp

6c63e1d

Adjust width of images

2493f18

Merge pull request #257 from brian-vb/master

8003c7e

Class Diagrams Revamp

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-2/tp …

8b7b17f

…into chinHan-AddPPP

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-2/tp

faff453

Update size of my diagrams

f0a9976

Merge pull request #258 from chydarren/master

345afc3

Update size of my diagrams

Fix date strictness in Storage class

700fa7b

Merge pull request #259 from chinhan99/chinHan-FixStorage

4d52af9

Fix storage date parse bug

Add missing tag for help message and rephrase unclear words used

f29f12d

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-2/tp

19486ae

Merge pull request #260 from wcwy/Fix-minor-bug

5030223

Add missing tag for help message and rephrase unclear words used

Merge branch 'master' of https://github.com/AY2223S1-CS2113-W12-2/tp

8dd5d9f

Implemented sorted monthly expenditure using a sorted treemap

19ab06a

DG changes for Edit and Delete

a023fed

Remove redundant variables in declaring treemap

7bbdbca

Merge pull request #261 from brian-vb/master

e98c0bc

DG changes for Edit and Delete

Merge pull request #262 from chydarren/chuaHanYongDarren-SortedMonthl…

beb6f49

…yExpenditure

Final PPP Push

d0b20b4

Merge pull request #263 from brian-vb/master

de6f1c2

Final PPP Push

Fix minor sequence diagram issue pre-release

01f9ffd

Merge pull request #264 from wcwy/release-check-fix

8f0d0b3

Fix minor sequence diagram issue pre-release

Fix DG outdated value

761c7d9

Fix DG issues found

f8b8e75

Merge pull request #265 from wcwy/release-check-fix

38d26a6

Fix DG outdated value


		### Edit Command

		{Describe the implementation for the Edit Command}

Uh oh!

Conversation

wcwy commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xzynos left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

wcwy commented Sep 28, 2022 •

edited

Loading