[CS2113-T12-4] WellNUS++ by wenxin-c · Pull Request #25 · nus-cs2113-AY2223S2/tp

wenxin-c · 2023-03-02T04:51:04Z

WellNUS++ is a Command Line Interface(CLI) app for NUS Computing students to keep track and improve their physical and mental wellness in various aspects. If you can type fast, WellNUS++ can update their wellness progress faster than traditional Graphical User Interface(GUI) apps.

ngkaiwen123

Description of design and implementation is generally well done! Good work! Some diagrams may need to be improve for better readability.

ngkaiwen123 · 2023-03-29T04:13:28Z

+### Reflection Component
+
+![Reflection Component Class Diagram](diagrams/ReflectionSequenceDiagram.png)
+![Reflection Component Class Diagram](diagrams/ReflectionClassDiagram.png)


The dotted arrows appear to be a little confusing. Perhaps it would be possible to redraw them?

ngkaiwen123 · 2023-03-29T04:19:52Z

+`LikeCommand` class: <br>
+
+- Command format: `like <index of question(1~5)>`
+- Users can add an introspective question that is generated in the previous set into their favorite list. Since there
+  will only
+  be 5 questions per set, the indexes are restricted to integer 1~5.
+- `addFavQuestion()` method in `QuestionList` class is used to add and store the data.
+- Users can only successfully add a question to favorite list if they have gotten a set of questions previously.
+- Every time a question is added into the favorite list, the indexes of this particular question will be stored in data
+  file straightaway. It prevents data loss due to unforeseen computer shutdown.
+
+`FavoriteCommand` class: <br>
+
+- Command format: `fav`
+- Users can get the questions in their favorite list.
+- `getFavQuestions()` method in `QuestionList` class matches the indexes to corresponding questions and return this set
+  of questions
+  back to `FavCommand` for output. As such, `QuestionList` is a dependency for `FavoriteCommand` as well.
+
+`HomeCommand` class: <br>
+
+- Command format: `home`
+- This command allows users to return back to the main WellNUS++ interface.
+- Similar to `GetCommand`, `validateCommand()` method will also be called to validate the command.
+- It will then call the class-level method `ReflectionManager.setIsExit()` to terminate the while loop
+  in `Reflectionmanager`.


Perhaps it will also be great to include how these classes handle errors? Or if there are any cases (or zero cases) of errors they may need to handle?

ngkaiwen123 · 2023-03-29T04:24:25Z

-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+Implementation of `parseUserInput`:

+![CommandParser implementation](diagrams/CommandParserSequence.png)


A reference frame for the CommandParser accessing its own methods inside the loop may help to better describe what is happening in the sequence diagram?

ngkaiwen123 · 2023-03-29T04:30:02Z

+
+### AtomicHabit Component
+
+![AtomicHabit Component](diagrams/AtomicHabit.png)


A redraw of the arrows to make them seem neater may be better for the reader?

ngkaiwen123 · 2023-03-29T04:40:03Z

+#### Overview
+The overall execution lifecycle of the WellNus application involves 4 main components, as shown in the diagram below.
+
+![Application Lifecycle](diagrams/WellnusSequence.png)


Text on dotted lines should be the variable returned rather than a description?

ngyida

Nice DG overall! The link to github is a nice touch :)

ngyida · 2023-03-30T01:22:59Z

+
+![Application Lifecycle](diagrams/WellnusSequence.png)
+
+The application begins with a call to `WellNus.start()`, which initialises an instance of `MainManager` and calls the 


Could this be done without since it is a description of the sequence diagram?

ngyida · 2023-03-30T01:25:21Z

+![Reflection Component Class Diagram](diagrams/ReflectionSequenceDiagram.png)
+![Reflection Component Class Diagram](diagrams/ReflectionClassDiagram.png)


This diagram is too crowded which makes it hard to read. Could you perhaps abstract some of the details out?

ngyida · 2023-03-30T01:26:41Z

+are not the focus of this section since they are outside of `reflection` package.<br>
+<br>
+
+#### Feature Package (`ReflectionManager`, `ReflectionQuestion`, `QuestionList`, `TextUi`, `RandomNumberGenerator` classes)


Could consider the use of UML diagrams to represent class to improve clarity

ngyida · 2023-03-30T01:32:18Z

+
+#### Integration with WellNUS++
+
+![Integration](diagrams/CommandParserClass.png)


This class diagram may not follow the standard UML notation

shawntangy · 2023-03-30T03:24:39Z

+### Reflection Component
+
+![Reflection Component Class Diagram](diagrams/ReflectionSequenceDiagram.png)
+![Reflection Component Class Diagram](diagrams/ReflectionClassDiagram.png)


The class diagram here could possibly be abstracted out and separated out into different features since it is not mandatory to include everything. Users may find it hard to read as the text size is a little small

shawntangy · 2023-03-30T03:27:16Z

+
+### AtomicHabit Component
+
+![AtomicHabit Component](diagrams/AtomicHabit.png)


To simplify the diagram, maybe not every command has to be shown, which would definitely reduce the amount of arrows

shawntangy · 2023-03-30T03:30:14Z

+  The payload will terminate when the user clicks `enter` or separates the payload with another argument
+  with the `--` delimiter.

 ## Instructions for manual testing


Maybe this section could be removed from the developer guide? This is because your user guide already covers the commands, creating duplicate content.

shawntangy · 2023-03-30T03:31:48Z

+
+For example,
+`
+$ foo bar --arg1 payload1 payload1--1 --arg2 payload2 --arg3


Maybe this could be included in a code block for easier visualization

shawntangy · 2023-03-30T03:38:15Z

+* The app is gamified to make it more attractive for students to use. Levels and micro-goals incentivise our
+  users to keep using the app’s features, allowing them to focus on their work and achieve wellness.

 ## User Stories


User stories language format could be changed to fit the "I want to ..." sentence. For e.g. I want to use keyboard instead of mouse vs I want to I can use keyboard instead of mouse

javienneyeo · 2023-03-30T07:37:47Z

+### Reflection Component
+
+![Reflection Component Class Diagram](diagrams/ReflectionSequenceDiagram.png)
+![Reflection Component Class Diagram](diagrams/ReflectionClassDiagram.png)


diagram is messy and hard to visualise. might want to consider removing some of the less important parts and only showing the important features of the diagram

javienneyeo · 2023-03-30T07:38:34Z

+| v2.0    | Reflective student                                 | I can get the previous questions I viewed                   | I can re-view these questions                      |
+| v2.0    | Easily distracted computing student                | I want to start a timer to keep track of time spent on work | I can do timed-practice                            |
+| v2.0    | Easily distracted computing student                | I want to check the time                                    | I can keep track of my pace                        |
+| v2.0    | A regular WellNUS++ user                           | I wish to have my information stored in the app             | I can re-view my past data                         |


can add priority levels / level of importance to this

Stella1585

(sorry i forgot to submit my review)
developer guide is very informative!

Stella1585 · 2023-03-29T07:16:18Z

+
+### Reflection Component
+
+![Reflection Component Class Diagram](diagrams/ReflectionSequenceDiagram.png)


I feel that this might be a little repetitive as each command is executed in a similar way. It also ends up being very long and looks complicated. Maybe you can separate the commands.

Stella1585 · 2023-03-29T07:39:11Z

+### Reflection Component
+
+![Reflection Component Class Diagram](diagrams/ReflectionSequenceDiagram.png)
+![Reflection Component Class Diagram](diagrams/ReflectionClassDiagram.png)


The association lines are all overlapping, and it is difficult to tell them apart, especially at the top where the label and lines overlap. once again i suggest you can separate into perhaps feature and command diagrams.

Stella1585 · 2023-03-29T07:42:37Z

+The application begins with a call to `WellNus.start()`, which initialises an instance of `MainManager` and calls the 
+`MainManager.runEventDriver()` method.
+
+`MainManager.runEventDriver()` will then take control of user input and provide a basic interface that parses commands 


There are mentions of keywords and user inputs that are being tackled but i do not see a string being passed through or a text ui class, maybe u can show this in your digram too?

Stella1585 · 2023-03-29T07:44:16Z

-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+Implementation of `parseUserInput`:

+![CommandParser implementation](diagrams/CommandParserSequence.png)


Well made sequence diagram, helps me to understand how a command is parsed.

Update developerguide

…inting

Replace 'Implementation Rationale' with 'Design Considerations' to standardise these section headers.

Improve DeveloperGuide Formatting

…activating helpcommand

…rror Remove extra space printed for MainManger when invalid command is given

…Parser Fix developer guide typos command parser

Fix broken link

Fix single-letter variable name

Document add user story dg

More DG test cases

Update DeveloperGuide Table of Contents

Fix User Guide Quickstart Typo

Fix list indices in DeveloperGuide

Update gradle output jar version

Fix broken link

Fix DG list indices

Fix broken TOC Name

ngkaiwen123 reviewed Mar 29, 2023

View reviewed changes

ngyida reviewed Mar 30, 2023

View reviewed changes

shawntangy reviewed Mar 30, 2023

View reviewed changes

javienneyeo reviewed Mar 30, 2023

View reviewed changes

Stella1585 reviewed Apr 6, 2023

View reviewed changes

YongbinWang and others added 25 commits April 8, 2023 19:38

Improve output clarity for attempting update/delete for empty habit list

a3bceb3

Update wenxin PPP content

8e5ebad

Fix typo in wenxin PPP

19546aa

Merge pull request #294 from YongbinWang/update-developerguide

dc03203

Update developerguide

Simplify self reflection sequence diagram

5dd4f12

Merge branch 'master' into document-WenxinPPPUpdate

a0a09c8

Implement printing for decrement as well to differe from increment pr…

419fbf8

…inting

Update focusmanager description

db3a2a7

Update error message for clarity

03f4a46

Add UI-specific logic and break logical checks

ab42a5e

Use OS-agnostic line separator

59cdff9

Merge branch 'master' into task-improveDgFormatting

d2bd8dd

Standardise section headers

dd77440

Replace 'Implementation Rationale' with 'Design Considerations' to standardise these section headers.

Merge pull request #293 from haoyangw/task-improveDgFormatting

b6619af

Improve DeveloperGuide Formatting

Merge branch 'master' into task-gamifDG

35a1bbf

Resolve adding integer as habit name bug

47ea2b4

Fix formatting

5ab93e4

Update text messages to be user-friendly

7059a46

Update user guide regressions

0569d9b

Merge branch 'master' into bugfix-FocusTimer-BugHunt

6432dff

Update DeveloperGuide Manager UML

49f7e42

Address Java CI and update atomichabit test, remove parseInt attempt

a95a619

Merge branch 'master' into WellNusPE-atomichabit-bugfix

9ba3862

Update AtomicHabit sequence diagram for visual clarity and resolve de…

565dfa8

…activating helpcommand

Update test regressions

997688e

wenxin-c and others added 30 commits April 10, 2023 20:25

Merge pull request #377 from YongbinWang/Fix-invalidCommand-PrintingE…

812f6d2

…rror Remove extra space printed for MainManger when invalid command is given

Merge pull request #374 from nichyjt/fix-DeveloperGuide-Typos-Command…

f64903f

…Parser Fix developer guide typos command parser

Fix broken link

8dfb803

Fix single-letter variable name

de87248

Merge pull request #378 from nichyjt/fix-PPP-BrokenLinks-Nicholas

f873dc3

Fix broken link

Merge pull request #379 from haoyangw/bugfix-codeStyle

d48de83

Fix single-letter variable name

Add DG user stories

0e720d3

Merge branch 'master' into document-AddUserStoryDG

678b31b

Fix typo

7c038b3

Merge pull request #380 from wenxin-c/document-AddUserStoryDG

cf4f1aa

Document add user story dg

Provide more test cases in DG

ec81440

Merge branch 'master' into task-dgTestCases

53dff84

Merge pull request #381 from haoyangw/task-dgTestCases

5eb1aa5

More DG test cases

Standardise capitalisation in DG

f8fc3f3

Update DG Table of Contents

720a29b

Update Acknowledgements in DG

c593d1c

Merge pull request #382 from haoyangw/task-fixDgToC

82af624

Update DeveloperGuide Table of Contents

Update gradle output jar version

928a4ad

Make instructions clearer

020dc22

Fix typo

c1f5583

Fix list indices in DG

68c68df

Merge pull request #383 from nichyjt/fix-UG-Quickstart

a7dd8d1

Fix User Guide Quickstart Typo

Merge pull request #385 from haoyangw/bugfix-dgListIndex

107209f

Fix list indices in DeveloperGuide

Merge pull request #384 from haoyangw/task-gradlev2.1Update

524d997

Update gradle output jar version

Fix broken link

a402a23

Merge pull request #386 from nichyjt/fix-BrokenUG-Link

0850105

Fix broken link

Fix DG list indices

e3500c1

Merge pull request #387 from haoyangw/bugfix-dgIndices

79e4b3e

Fix DG list indices

Fix broken TOC

0c2c763

Merge pull request #388 from nichyjt/fix-WrongTOC-Name

2cd29b2

Fix broken TOC Name


		### AtomicHabit Component

		![AtomicHabit Component](diagrams/AtomicHabit.png)


		![Application Lifecycle](diagrams/WellnusSequence.png)

		The application begins with a call to `WellNus.start()`, which initialises an instance of `MainManager` and calls the

		![Reflection Component Class Diagram](diagrams/ReflectionSequenceDiagram.png)
		![Reflection Component Class Diagram](diagrams/ReflectionClassDiagram.png)


		#### Integration with WellNUS++

		![Integration](diagrams/CommandParserClass.png)


		### Reflection Component

		![Reflection Component Class Diagram](diagrams/ReflectionSequenceDiagram.png)

Conversation

wenxin-c commented Mar 2, 2023

Uh oh!

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

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

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants