[CS2113T-T10-4] MindMyMoney #10

GlendonNotGlen · 2022-03-03T02:16:40Z

MindMyMoney is a Command-Line application that allows users to track their spending

Musfirahe0556596

Great diagrams drawn! Some issues to consider!

Musfirahe0556596 · 2022-03-31T01:18:02Z

docs/DeveloperGuide.md

+#### Current Implementation
+The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure
+to the list.  
+![add_command_sequence_diagram](images/Add_Command_Sequence_Diagram.png)  


Perhaps there should be an activation bar on the call to the AddCommandInputTest#test(...) method as shown in the screenshot?:

the return values should include the data type e.g. category: String

This applies to all the return value

Would it be possible to enter the objectName:Datatype format for the return types?

Musfirahe0556596 · 2022-03-31T01:19:23Z

docs/DeveloperGuide.md

+4. During the execution, `Addcommand.execute` will parse through user input to obtain the `EXPENDITURE`, `CATEGORY`,
+   `DESCRIPTION`, `AMOUNT` and `TIME` fields.
+5. The `Addcommand` object instantiates a new `Expenditure` object with the aforementioned 5 fields and adds them


Perhaps there should be another line to describe what the AddCommandInputTest#test(...) method does?

Musfirahe0556596 · 2022-03-31T01:26:30Z

docs/DeveloperGuide.md

+To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data
+that is actionable for the users.
+
+![calculate_command_sequence_diagram](images/gif_loading.gif)


Unsure if the gif is supposed to be an indication of 'to be updated' as here it states that the picture is supposed to be a sequence diagram, but no sequence diagram is shown xD.

Musfirahe0556596 · 2022-03-31T01:29:37Z

docs/DeveloperGuide.md

+### Command component 
+The source can be found in [command](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/command)
+
+![command_diagram](images/command_diagram.png)


This diagram is understandable as it shows the different commands available but perhaps an improvement that could be done is to add in the abstract method execute() also to show that all command types have this method in their own classes?

Musfirahe0556596 · 2022-03-31T01:35:25Z

docs/DeveloperGuide.md

+The Sequence Diagram below shows an example of how the components interact with each other for the scenario 
+where the user issues the command`add shoes 100`.
+
+![sequence_diagram](images/sequence_diagram.png)


Excellent diagram that shows a high-level overview of how the application works. Colouring to differentiate the different components are also good!

For the sequence diagram, shouldn't the user go to :MMM with thecommand add shoes before the :Ui?
The sequence feels a bit off here

I think they are trying to illustrate that the user enters the command through :UI, which is then sent to :MMM to handle, which will then parse and do the rest of the sequence.

tuan0369 · 2022-03-31T01:16:37Z

docs/DeveloperGuide.md

+<br/>
+
+### UI component
+The source code can be found in [Ui.java](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/Ui.java)


I like how you guys include the link for source code in the DG

tuan0369 · 2022-03-31T01:21:53Z

docs/DeveloperGuide.md


-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Architecture
+![architecture diagram](images/architecture_diagram.png)


The architecture diagram does not have to connection between Parser and Commands, while the command diagram indicates otherwise.

tuan0369 · 2022-03-31T01:26:40Z

docs/DeveloperGuide.md

+### Command component 
+The source can be found in [command](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/command)
+
+![command_diagram](images/command_diagram.png)


The activation bar in the sequence diagram for the Command:AddCommand is too long

tuan0369 · 2022-03-31T01:28:47Z

docs/DeveloperGuide.md

+To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data
+that is actionable for the users.
+
+![calculate_command_sequence_diagram](images/gif_loading.gif)


I do not know why you guys put loading gif here but I think it should be a sequence diagram

I thought it was intended but just curious why haha

Also curious about the loading gif! Is it a picture that was not rendered?

tuan0369 · 2022-03-31T01:41:59Z

docs/DeveloperGuide.md

+  * Pros: Easily implemented with lesser lines of code as the code is minimalist
+  * Cons: JUnit testing would require I/O redirection prior to checking the output matches expectations
+
+![list_command_sequence_diagram](images/List_Command_Sequence_Diagram.png)

 ## Product scope
 ### Target user profile


There is no information in the product scope, non-functional requirement, glossary and instruction for manual testing sections.

wraineflores

DG peer review

wraineflores · 2022-03-31T01:16:18Z

docs/DeveloperGuide.md

@@ -4,10 +4,150 @@

 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}


There is no overview summary of what the software is all about

wraineflores · 2022-03-31T01:19:06Z

docs/DeveloperGuide.md

+<br/>
+
+### UI component
+The source code can be found in [Ui.java](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/Ui.java)


It's good that there's a source code hyperlink to the Github website

wraineflores · 2022-03-31T01:21:21Z

docs/DeveloperGuide.md

+![parser_diagram](images/parser_diagram.png)
+<br/> Fig 4 - Parser Diagram
+
+The Parser component consists of a`Parser`, `Functions`, `ExpenditureList` and `Expenditure`class


The labeling of figures may be better if placed above the diagram itself.
Why is the Function class separate from the Parser Class?

wraineflores · 2022-03-31T01:26:03Z

docs/DeveloperGuide.md

+  * Pros: Easily implemented with lesser lines of code as the code is minimalist
+  * Cons: JUnit testing would require I/O redirection prior to checking the output matches expectations
+
+![list_command_sequence_diagram](images/List_Command_Sequence_Diagram.png)

 ## Product scope
 ### Target user profile


Target User is unknown so it is unclear who this software is for

wraineflores · 2022-03-31T01:29:36Z

docs/DeveloperGuide.md

+To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data
+that is actionable for the users.
+
+![calculate_command_sequence_diagram](images/gif_loading.gif)


Calculate command sequence diagram is not loading maybe because it is a .gif instead of a .png image

wraineflores · 2022-03-31T01:39:57Z

docs/DeveloperGuide.md

+![sequence_diagram](images/sequence_diagram.png)
+<br/> Fig 2 - Sequence Diagram
+
+The sections below give more details for each component.


There is no termination, loop, opt, etc. in the sequence diagram

ibrahimisramos

Good job team!

ibrahimisramos · 2022-03-31T03:36:56Z

docs/DeveloperGuide.md

+The Sequence Diagram below shows an example of how the components interact with each other for the scenario 
+where the user issues the command`add shoes 100`.
+
+![sequence_diagram](images/sequence_diagram.png)


For the sequence diagram, shouldn't the user go to :MMM with thecommand add shoes before the :Ui?
The sequence feels a bit off here

ibrahimisramos · 2022-03-31T03:39:09Z

docs/DeveloperGuide.md

+The source can be found in [`command`](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/command)
+
+![command_diagram](images/command_diagram.png)  
+Fig 5 - Command Class Diagram


Might want to centralise the "figure 5". I took a while to find it

ibrahimisramos · 2022-03-31T03:40:28Z

docs/DeveloperGuide.md

+#### Current Implementation
+The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure
+to the list.  
+![add_command_sequence_diagram](images/Add_Command_Sequence_Diagram.png)  


the return values should include the data type e.g. category: String

ibrahimisramos · 2022-03-31T03:40:54Z

docs/DeveloperGuide.md

+#### Current Implementation
+The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure
+to the list.  
+![add_command_sequence_diagram](images/Add_Command_Sequence_Diagram.png)  


This applies to all the return value

ibrahimisramos · 2022-03-31T03:41:54Z

docs/DeveloperGuide.md

+To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data
+that is actionable for the users.
+
+![calculate_command_sequence_diagram](images/gif_loading.gif)


I thought it was intended but just curious why haha

ibrahimisramos · 2022-03-31T03:43:04Z

docs/DeveloperGuide.md

+The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure
+to the list.  
+
+![add_expenditure_command_sequence_diagram](images/Add_Expenditure_Command_Sequence_Diagram.png)  


for the print added expenditure, should it be calling the print()/equivilent print method?

ibrahimisramos · 2022-03-31T03:44:04Z

docs/DeveloperGuide.md

+**Value proposition**
+Manage finances containing multiple payment methods faster than a typical mouse/GUI driven app.
+
+### User Stories

 |Version| As a ... | I want to ... | So that I can ...|
 |--------|----------|---------------|------------------|
 |v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
 |v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|


Might want to add more of the user stories, feels like the app has very limited features

FTang21

Overall really good DeveloperGuide! Good job

FTang21 · 2022-04-01T02:24:29Z

docs/DeveloperGuide.md

+
+The sequence diagram below shows the interactions of when an `AddCommand` is parsed.  
+
+![add_command_sequence_diagram](images/Add_Command_Sequence_Diagram.png)  


Shouldn't the return arrow be outside of the alt frame?

FTang21 · 2022-04-01T02:29:10Z

docs/DeveloperGuide.md

+### Command component 
+The source can be found in [`command`](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/command)
+
+![command_diagram](images/command_diagram.png)  


Should this the lines from Parse to the Commands be dashed? I'm not sure if this a dependency as Parser is creating Commands

FTang21 · 2022-04-01T02:35:17Z

docs/DeveloperGuide.md

+The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure
+to the list.  
+
+![add_expenditure_command_sequence_diagram](images/Add_Expenditure_Command_Sequence_Diagram.png)  


I believe your `print added expenditure` self call is missing the activation bar. Similarly, in your addCreditCard() sequence diagram you seem to be missing the `print added credit card` activation bar.

FTang21 · 2022-04-01T02:38:03Z

docs/DeveloperGuide.md

+**Value proposition**
+Manage finances containing multiple payment methods faster than a typical mouse/GUI driven app.
+
+### User Stories

 |Version| As a ... | I want to ... | So that I can ...|
 |--------|----------|---------------|------------------|
 |v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
 |v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|


Like ibrahimisramos stated, adding more user stories would be good. It would also tell others what features you focus based on the user stories you looked at or plan to look at.

FTang21 · 2022-04-01T02:43:21Z

docs/DeveloperGuide.md

+The Sequence Diagram below shows an example of how the components interact with each other for the scenario 
+where the user issues the command`add shoes 100`.
+
+![sequence_diagram](images/sequence_diagram.png)


No critique here, just a really nice diagram sequence that details the architecture of your program!

mathanmahe

Looks good. It's a very informative developer guide with a few areas for improvement,

mathanmahe · 2022-04-01T02:22:11Z

docs/DeveloperGuide.md

+The Sequence Diagram below shows an example of how the components interact with each other for the scenario 
+where the user issues the command`add shoes 100`.
+
+![sequence_diagram](images/sequence_diagram.png)


I think they are trying to illustrate that the user enters the command through :UI, which is then sent to :MMM to handle, which will then parse and do the rest of the sequence.

mathanmahe · 2022-04-01T02:23:55Z

docs/DeveloperGuide.md

+The Sequence Diagram below shows an example of how the components interact with each other for the scenario 
+where the user issues the command`add shoes 100`.
+
+![sequence_diagram](images/sequence_diagram.png)


Good use of color schemes to make the sequence and architecture diagrams more visually appealing and easy to follow through!

mathanmahe · 2022-04-01T02:35:52Z

docs/DeveloperGuide.md

+### Parser component
+The source code can be found in [`Parser.java`](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/Parser.java)
+
+![parser_diagram](images/parser_diagram.png)


Would it be possible to clarify this diagram? It is a bit confusing because a package named Parser is used. But the code architecture does not have a package named parser. Would it be possible to rename it to a more suitable name like ExpenditureTracker? Because it houses not only parser, but also the other aspects like the ExpenditureList, Functions as well as Parser

mathanmahe · 2022-04-01T02:39:40Z

docs/DeveloperGuide.md

+#### Current Implementation
+The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure
+to the list.  
+![add_command_sequence_diagram](images/Add_Command_Sequence_Diagram.png)  


Would it be possible to enter the objectName:Datatype format for the return types?

mathanmahe · 2022-04-01T02:42:01Z

docs/DeveloperGuide.md

+**Value proposition**
+Manage finances containing multiple payment methods faster than a typical mouse/GUI driven app.
+
+### User Stories


Would it be possible to add more user stories that could cover what kind of users the features are intended for?

mathanmahe · 2022-04-01T02:44:21Z

docs/DeveloperGuide.md

+To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data
+that is actionable for the users.
+
+![calculate_command_sequence_diagram](images/gif_loading.gif)


Also curious about the loading gif! Is it a picture that was not rendered?

mathanmahe · 2022-04-01T02:45:38Z

docs/DeveloperGuide.md


-* *glossary item* - Definition
+* Mainstream OS: Windows, Linux, Unix, OS-X  

 ## Instructions for manual testing



Kindly do add instructions for manual testing of the features so a new developer can understand how to test these features. You can include positive and negative test cases, expected outcomes.

Add Kit Han PPP

Update PPP

Update AboutUs Portfolio link

Sean tests

Sean-PPP

Sean ppp

Sean-PPP pic changes

DG edits

Add CalculateInputCommand sequence diagrams Refactor and shift helper methods to helper class

# Conflicts: # docs/DeveloperGuide.md # docs/puml/AddExpenditureCommandSequenceDiagram.puml # src/main/java/seedu/mindmymoney/command/AddCommand.java

Fix add command where invalid input crashes program

# Conflicts: # docs/images/AddCreditCardSequenceDiagram.png # docs/images/AddExpenditureSequenceDiagram.png

Standardise sequence and class diag format

fix line

fix regex

Sean bugs lessthan 1hr to deadline

Add validators for reading save file

fixed bug of startwith

…into kitHan-setMaxIncomeAmount

change dan face

Kit han set max income amount

change dan face pt 2

Minor changes to command classes

Musfirahe0556596 reviewed Mar 31, 2022

View reviewed changes

tuan0369 reviewed Mar 31, 2022

View reviewed changes

wraineflores reviewed Mar 31, 2022

View reviewed changes

ibrahimisramos reviewed Mar 31, 2022

View reviewed changes

FTang21 reviewed Apr 1, 2022

View reviewed changes

mathanmahe approved these changes Apr 1, 2022

View reviewed changes

khseah and others added 24 commits April 6, 2022 23:29

Merge pull request #167 from khseah/kitHan-PPP

fdac841

Add Kit Han PPP

Update DG

3ff0fcf

Merge pull request #168 from khseah/kitHan-PPP

e38f14a

Update PPP

Update AboutUs Portfolio link

f77529c

Merge pull request #169 from khseah/kitHan-PPP

72d17df

Update AboutUs Portfolio link

del cmd

611e752

update cmd

7eed2d4

Merge pull request #170 from SeanHoWB/Sean-Tests

c3c2e6a

Sean tests

Sean-PPP

6644c47

Merge pull request #171 from SeanHoWB/Sean-PPP

88cfcbe

Sean-PPP

Sean-PPP fixes

22c5876

Sean-PPP fixes

77ac1e0

Merge pull request #172 from SeanHoWB/Sean-PPP

0790f9a

Sean ppp

Sean-PPP pic changes

7246438

Merge pull request #173 from SeanHoWB/Sean-PPP

d2f8a44

Sean-PPP pic changes

DG edits

62f1f78

DG edits

f25c6a9

Merge pull request #174 from SeanHoWB/Sean-DG_edits

5d4960a

DG edits

Add Storage and Command class diagrams

a6dfe65

Add CalculateInputCommand sequence diagrams Refactor and shift helper methods to helper class

Merge branch 'master' into Branch-Add_DG

ed9afd3

# Conflicts: # docs/DeveloperGuide.md # docs/puml/AddExpenditureCommandSequenceDiagram.puml # src/main/java/seedu/mindmymoney/command/AddCommand.java

Fix coding standards

0182680

formatted the print to screens to 2dp

ebe295b

fixes

9d2c1df

Fix comments

e481b5b

Fix add command where invalid input crashes program

limjierui and others added 30 commits April 11, 2022 22:12

Fix diagrams

3902b93

Merge branch 'master' into Branch-StandardiseDGDiag

e0af824

# Conflicts: # docs/images/AddCreditCardSequenceDiagram.png # docs/images/AddExpenditureSequenceDiagram.png

fix some bugs

07e3175

Merge pull request #234 from limjierui/Branch-StandardiseDGDiag

6970464

Standardise sequence and class diag format

Merge pull request #238 from SeanHoWB/Sean-Bugs-1hr-to-deadline

0635adf

fix line

fix regex

b120b8b

Merge pull request #239 from SeanHoWB/Sean-Bugs-lessthan-1hr-to-deadline

4e6ac67

fix regex

fix 1mil

4e1d5ab

fixed ug to match 1 mil

97148f1

Add max_income limit

1547db2

Merge branch 'master' into kitHan-setMaxIncomeAmount

9682b77

Merge branch 'master' into validate-saved-info

7f9cfe9

fixed ug to match 1 mil

7434f2f

Migrate PropertyList to data package

ce44a7d

Merge pull request #240 from SeanHoWB/Sean-Bugs-lessthan-1hr-to-deadline

98424f7

Sean bugs lessthan 1hr to deadline

fixed bug of startwith

9b38e82

Merge pull request #232 from danbaterisna/validate-saved-info

65efa25

Add validators for reading save file

Merge pull request #242 from SeanHoWB/Sean-Bugs-lessthan-1hr-to-deadline

06f73e4

fixed bug of startwith

Check for invalid income amount

f107049

change dan face

fd2615f

Merge branch 'master' of https://github.com/AY2122S2-CS2113T-T10-4/tp …

7e08a0d

…into kitHan-setMaxIncomeAmount

change dan face

f873874

Merge pull request #243 from SeanHoWB/Sean-Bugs-lessthan-1hr-to-deadline

bc323ea

change dan face

Merge pull request #241 from khseah/kitHan-setMaxIncomeAmount

1b7eaa6

Kit han set max income amount

change dan face pt 2

ab65695

Merge pull request #244 from SeanHoWB/Sean-help_me

fb96c07

change dan face pt 2

Minor changes to command classes

02c51ee

Merge pull request #245 from limjierui/Branch-LastChanges

79b63c0

Minor changes to command classes

Rename GlendonNotGlen.md to glendonnotglen.md

796c151

Update AboutUs.md

2de331c

		@@ -4,10 +4,150 @@

		{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}


		The sequence diagram below shows the interactions of when an `AddCommand` is parsed.

		![add_command_sequence_diagram](images/Add_Command_Sequence_Diagram.png)

[CS2113T-T10-4] MindMyMoney #10

Are you sure you want to change the base?

[CS2113T-T10-4] MindMyMoney #10

Conversation

GlendonNotGlen commented Mar 3, 2022

Musfirahe0556596 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Musfirahe0556596 Mar 31, 2022 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wraineflores 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ibrahimisramos 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FTang21 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

Choose a reason for hiding this comment

mathanmahe 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Musfirahe0556596 Mar 31, 2022 •

edited

Loading