[CS2113T-T12-3] Stonks XD by KZQ1999 · Pull Request #33 · nus-cs2113-AY2122S1/tp

KZQ1999 · 2021-09-30T04:22:49Z

Stonks XD is an expense tracker that help computing students manage their finances and provide reminders and advice regarding their spending. It is optimized for CLI users so that frequent tasks can be done faster by typing in commands.

datn02

Pretty nice project. But you could also focus more on the overall aesthetic of the DG.

datn02 · 2021-10-28T01:10:55Z

+The image below illustrates the sequence diagram in the context of listing methods
+which includes listExpense, listIncome and listFind.
+
+
+![Untitled Diagram drawio (2)](https://user-images.githubusercontent.com/69465661/138629733-63b2a115-5405-4af5-8a74-4d18f51c8f96.png)


Isn't the return arrows in the alt block be more like a square instead of a triangle?

datn02 · 2021-10-28T01:13:23Z

+![](Architecture.drawio.png)
+
+The __Architecture Diagram__ above explains the high-level design of the StonksXD app.
+Given below is a quick overview of the main components of the application and how they interact with each other:


This could look like a class diagram with the arrows and the box contains multiple sections. Maybe you should change it to another representation method to avoid confusion

datn02 · 2021-10-28T01:16:24Z

+The image below shows the sequence diagram of how the `AddExpenseCommand` class is used and the other classes involved with it as well.
+
+![img_2.png](AddExpenseCommandSD.drawio.PNG)


Is this part to be added? It doesn't show up on the github page

datn02 · 2021-10-28T01:19:59Z

+- ####_Adding Income/ Expense entries_
+  1. Test Case: `add_ex d/DESCRIPTION a/AMOUNT c/CATEGORY`. </p>
+     Expected : Adds an expense item to the list. Displays confirmation message with timestamp.


This part shows the hashtags (#) on the Github page. Is this intentional?

datn02 · 2021-10-28T01:26:45Z

+`StonksXD` is the main class of the app. It has 2 main functions: 
+1. Upon opening the app, it loads saved data by calling `DataManager`. Before closing the app, it calls `DataManager` again to save data.
+2. Runs a loop receiving new user input from `Ui` and passing it to `Parser`.
+
+`StonksXD` &rarr; `DataManager`
+
+`Ui` &rarr; `StonksXD` &rarr; `Parser`
+
+<br>
+
+`Parser` is the class responsible for interpreting the user input. 
+It ensures the appropriate input format, and passes the input data to the appropriate command.
+
+`StonksXD` &rarr; `Parser` &rarr; `Command`


Maybe you could provide a class diagram to show how those components interact with each other
Similar comments for other components description

arraysius

The developer guide has been well written and clear for the most part. Some sections require more explanation or updated diagrams to reduce reader confusion.

arraysius · 2021-10-28T02:09:35Z

 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Architecture
+
+![](Architecture.drawio.png)


While looking at the architecture diagram, it is not entirely clear what the arrows and their directions mean between components. Maybe a note can be placed to explain the what the arrows and the direction mean.

The 3-way arrow between Command, Financial Tracker and Budget Manager gave me the first impression that all 3 can interaction with one another. But the explanation below says
Parser → Command ↔ FinancialTracker
Parser → Command ↔ BudgetManager
Maybe two separate arrows can be used to display that Financial Tracker and BudgetManager are does not interact with one another directly.

arraysius · 2021-10-28T02:19:50Z

+<br>
+
+Below is a sequence diagram of the Budget component when `handleBudget` is executed:
+![](BudgetComponent.drawio.png)


The getLimit() method sounds like it should return a value back to BudgetManager. It might be a drawing bug where the return was left out. If not, maybe a better method name can be used.

arraysius · 2021-10-28T02:26:47Z

+
+The image below illustrates the sequence diagram in the context of saving data into `StonksXD_Entries.csv`.
+
+![img_4.png](SavingFeatureSD.drawio.png)


I assume that write(data:String) is void method. I think that if there is no return value, the return line can be drawn but the return word is not required.

The lifeline should not exceed past the destruction symbol. Maybe the image can be edited to erase the extended lifeline or have a note to explain the limitation of the drawing and that it should not exceed.

silinche · 2021-10-28T08:54:54Z

+which includes listExpense, listIncome and listFind.
+
+
+![Untitled Diagram drawio (2)](https://user-images.githubusercontent.com/69465661/138629733-63b2a115-5405-4af5-8a74-4d18f51c8f96.png)


Should the return arrow here be square to adhere to the convention in class?

silinche · 2021-10-28T08:58:31Z

+
+<br>
+
+Below is a sequence diagram of the Budget component when `handleBudget` is executed:


Apart from the return missing, perhaps the diagram is a bit complex and should be split into ref?

In the budget component diagram, no return signs for all methods. It is better to add them to show that the method is done and it is returned to the previous layer?

oneScotch · 2021-10-28T14:33:49Z

+
+<br>
+
+Below is a sequence diagram of the Budget component when `handleBudget` is executed:


In the budget component diagram, no return signs for all methods. It is better to add them to show that the method is done and it is returned to the previous layer?

oneScotch · 2021-10-28T14:44:03Z

+
+<br>
+
+Below is a sequence diagram of the Budget component when `handleBudget` is executed:


Perhaps the Xbudget class lifeline should not extend the opt frame? Since it is created only in opt and should be executed after it

ThaddeusLim99

Overall a very good effort so far. Needs some standardisation and correcting for sequence diagrams. Use of sequence and class diagrams are quite relevant. Explainations are generally not too long and thus not very difficult to understand.

ThaddeusLim99 · 2021-10-29T04:07:45Z

+Snippets of code from Baeldung’s guide to unit testing of system.out.println() with junit were used.

-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+Source: https://www.baeldung.com/java-testing-system-out-println


Perhaps the links could be hyperlinks instead for users to access them more easily?

ThaddeusLim99 · 2021-10-29T04:10:08Z

+which includes listExpense, listIncome and listFind.
+
+
+![Untitled Diagram drawio (2)](https://user-images.githubusercontent.com/69465661/138629733-63b2a115-5405-4af5-8a74-4d18f51c8f96.png)


The comment on isExpense() could be clearer. maybe resize it box to become bigger?

ThaddeusLim99 · 2021-10-29T04:12:12Z

+
+Below is a sequence diagram of the Budget component when `handleBudget` is executed:
+![](BudgetComponent.drawio.png)
+


Is the final return arrow of the BudgetManager object correct? Should the arrow not be at the end of the activation bar instead of the middle of the activation bar?

ThaddeusLim99 · 2021-10-29T04:13:27Z

+<br>
+
+Below is a sequence diagram of the Budget component when `handleBudget` is executed:
+![](BudgetComponent.drawio.png)


Perhaps the XBudget object box could be placed at the top along with the other object boxes for better standardization. Currently it looks a little messy.

ThaddeusLim99 · 2021-10-29T04:14:46Z

+
+<br>
+
+Below is a sequence diagram of the Budget component when `handleBudget` is executed:


Perhaps it would be better to standardise whether the conditional boxes (such as alt and opt) will be behind or infront of the activation bar that it crosses over with.

ThaddeusLim99 · 2021-10-29T04:17:27Z

+
+The image below illustrates the class diagram in the context of data saving and loading.
+
+![img_3.png](DataManagerCD.drawio.png)


Perhaps it would be better to add in the most used variables in the Class Diagram rather than leaving it empty? So that the user has a better idea on what kind of variables are in the class.

ThaddeusLim99

Added some pictures for reference

Update developer guide for data saving and parser

…ouches Final branch cleanup finishing touches

Update DG with sequence diagram

…g-class

Checkstyle edits

…to BudgetFunction

User guide

…into branch-CurrencyTest * 'master' of https://github.com/AY2122S1-CS2113T-T12-3/tp: Update Update user guide Update guides Update user guide User guide update Final commit Update code

added profile pic

…g-class

Update data saving class

Last changes

Final Commit

Update PPP

Edit PPP

Update PPP

PPP

fix ppp

Developer guide

Make UG changes for CS2101

datn02 reviewed Oct 28, 2021

View reviewed changes

arraysius reviewed Oct 28, 2021

View reviewed changes

silinche reviewed Oct 28, 2021

View reviewed changes

oneScotch reviewed Oct 28, 2021

View reviewed changes

ThaddeusLim99 reviewed Oct 29, 2021

View reviewed changes

KZQ1999 and others added 24 commits November 7, 2021 01:13

Merge pull request #237 from AnShengLee/developer-guide

72b1581

Update developer guide for data saving and parser

Merge branch 'master' into final-branch-cleanup-finishing-touches

8ea58f4

Merge pull request #238 from KZQ1999/final-branch-cleanup-finishing-t…

f24af3d

…ouches Final branch cleanup finishing touches

Merge branch 'master' into refactor

cc08db8

Merge pull request #239 from kyun99/refactor

7bed002

Update DG with sequence diagram

Merge remote-tracking branch 'upstream/master' into update-data-savin…

9ff02c1

…g-class

Update guides and DataManager

dbc7ebb

Update user guide

3496c4a

Fix bugs and update JUnit tests

a6cc8a2

Update JUnit tests

03a1be2

Merge branch 'master' into BudgetFunction

5ee1e93

Remove unnecessary code.

e3d8fd1

Checkstyle edits

Merge branch 'BudgetFunction' of https://github.com/jonathanlkw/tp in…

b906e5a

…to BudgetFunction

Add missing import line.

27ae364

Make checkstyle edits

4c68bed

added spacing

bba0ffa

spacing #2

b2320cb

#3 spacing

18cb33f

Merge branch 'master' into final-branch-cleanup-finishing-touches

d19687d

Refactor FinancialCalculator.java, and Parser.java

216423b

Fix DG bug

53a6531

Fix Checkstyle error

155a08a

added stonks main page instead of duke

d2aa566

Update DG

e156d74

AnShengLee and others added 30 commits November 8, 2021 21:43

Update

dc533e3

added profile pic

28640d4

Merge pull request #292 from AnShengLee/user-guide

47409bf

User guide

Merge branch 'master' of https://github.com/AY2122S1-CS2113T-T12-3/tp …

68020b4

…into branch-CurrencyTest * 'master' of https://github.com/AY2122S1-CS2113T-T12-3/tp: Update Update user guide Update guides Update user guide User guide update Final commit Update code

Merge pull request #293 from KZQ1999/ppp-dg-classdiag

f2f2e1a

added profile pic

Merge remote-tracking branch 'upstream/master' into update-data-savin…

833e076

…g-class

Update loading mechanism

35bfabf

Merge pull request #294 from AnShengLee/update-data-saving-class

fff945f

Update data saving class

Last changes pls

49848b5

Merge pull request #295 from AY2122S1-CS2113T-T12-3/branch-CurrencyTest

437a6c1

Last changes

Final Commit

5a70d18

Merge pull request #296 from kyun99/master

c54c214

Final Commit

Merge remote-tracking branch 'upstream/master' into ppp

efac9dc

Update PPP

7035cd3

Merge pull request #297 from AnShengLee/ppp

4ad7167

Update PPP

Edit PPP

08ea65b

Merge pull request #298 from jonathanlkw/PPP

cce3fef

Edit PPP

Edit PPP

ae34d9a

Merge branch 'master' into PPP

61ea3f1

Update PPP

42015bc

Edit PPP

51ac935

Merge pull request #299 from AnShengLee/ppp

0b847fd

Update PPP

Merge pull request #300 from jonathanlkw/PPP

8fc74de

PPP

fix ppp

9a3367c

Merge pull request #301 from kyun99/master

711a3ff

fix ppp

Merge remote-tracking branch 'upstream/master' into developer-guide

2e93c9a

Update developer guide

f0527ed

Merge pull request #302 from AnShengLee/developer-guide

8ba7705

Developer guide

Make UG changes for CS2101

ee89f14

Merge pull request #303 from jonathanlkw/Branch-UG

b125baf

Make UG changes for CS2101

		The image below shows the sequence diagram of how the `AddExpenseCommand` class is used and the other classes involved with it as well.

		![img_2.png](AddExpenseCommandSD.drawio.PNG)


		The image below illustrates the sequence diagram in the context of saving data into `StonksXD_Entries.csv`.

		![img_4.png](SavingFeatureSD.drawio.png)

		which includes listExpense, listIncome and listFind.


		![Untitled Diagram drawio (2)](https://user-images.githubusercontent.com/69465661/138629733-63b2a115-5405-4af5-8a74-4d18f51c8f96.png)


		<br>

		Below is a sequence diagram of the Budget component when `handleBudget` is executed:


		Below is a sequence diagram of the Budget component when `handleBudget` is executed:
		![](BudgetComponent.drawio.png)


		The image below illustrates the class diagram in the context of data saving and loading.

		![img_3.png](DataManagerCD.drawio.png)

Uh oh!

Conversation

KZQ1999 commented Sep 30, 2021

Uh oh!

datn02 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!

arraysius 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!

ThaddeusLim99 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!

ThaddeusLim99 Oct 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThaddeusLim99 Oct 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThaddeusLim99 Oct 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThaddeusLim99 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

ThaddeusLim99 Oct 29, 2021 •

edited

Loading

ThaddeusLim99 Oct 29, 2021 •

edited

Loading

ThaddeusLim99 Oct 29, 2021 •

edited

Loading