[CS2113-F14-3] BYTE-CEPS by joshualeejunyi · Pull Request #53 · nus-cs2113-AY2324S2/tp

joshualeejunyi · 2024-03-08T06:51:52Z

BYTE-CEPS is a fitness application that allows tech-savvy users of all kind keep track of their fitness journey through the simplicity and efficiency of the command line interface.

implement basic findBook function

NgYaoDong

Generally good job, just minor issues here and there. :)

NgYaoDong · 2024-04-04T01:08:20Z

+![addExercise](https://github.com/V4Vern/tp/assets/28131050/45f7e9b3-8a31-4dfe-a783-433acb71fa58)
+


Should there be an extra box coming out since you are calling a method of its own class?

NgYaoDong · 2024-04-04T01:10:31Z

+![addExercise](https://github.com/V4Vern/tp/assets/28131050/45f7e9b3-8a31-4dfe-a783-433acb71fa58)
+


Should the activation bar for ExerciseManager be extended all the way to where it says "Print error message indicating invalid command format"?

Assuming the print success message is void, the arrow should be dashed.

NgYaoDong · 2024-04-04T01:13:16Z

+![WorkoutLogOverview.png](./diagrams/WorkoutLogOverview.png)


 ## Product scope


Target user profile and value proposition seems to be missing.

NgYaoDong · 2024-04-04T01:15:58Z

+### `Activity` and child classes
+The `Activity` class serves as a parent class to `Exercise`, `ExerciseLog`, `Workout`, `WorkoutLog` and `Day` classes for the ease of usage of `ActivityManager` classes (see below).
+
+![ActivityClassDiagram](diagrams/ActivityClassDiagram.png)


exerciseLogs and exerciseList's visibilities seem to be missing?

NgYaoDong · 2024-04-04T01:27:31Z

+### `Activity` and child classes
+The `Activity` class serves as a parent class to `Exercise`, `ExerciseLog`, `Workout`, `WorkoutLog` and `Day` classes for the ease of usage of `ActivityManager` classes (see below).
+
+![ActivityClassDiagram](diagrams/ActivityClassDiagram.png)


Is the Parser class missing an activation bar?

NgYaoDong · 2024-04-04T01:30:27Z

+### `Activity` and child classes
+The `Activity` class serves as a parent class to `Exercise`, `ExerciseLog`, `Workout`, `WorkoutLog` and `Day` classes for the ease of usage of `ActivityManager` classes (see below).
+
+![ActivityClassDiagram](diagrams/ActivityClassDiagram.png)


Should there be a C logo beside the name of your classes?

nkotaa

Somewhat verbose.

nkotaa · 2024-04-04T01:22:20Z

+ execute(parser : Parser) : String
+- executeInfoAction(parser : Parser) : String
+- executeListAction(parser : Parser) : String
+- executeUnassignAction(parser : Parser) : String
+- executeAssignAction(parser : Parser) : String
+- executeDeleteAction(parser : Parser) : String
+- executeCreateAction(parser : Parser) : String
+- processWorkout(parser : Parser) : Workout
+- assignExerciseToWorkout(parser : Parser) : String
+- getFullWorkoutString(workoutPlanName : String) : String
+- unassignExerciseFromWorkout(parser : Parser) : String
+ getActivityType(plural : boolean) : String
+- executeSearchAction(parser : Parser) : String
+}


Note that not all attributes and methods need be stated. Consider including only the relevant ones.

nkotaa · 2024-04-04T01:23:01Z

+ {static} DAYS : String[]
+- exerciseManager : ExerciseManager
+- workoutManager : WorkoutManager
+- workoutLogsManager : WorkoutLogsManager
+ WeeklyProgramManager(exerciseManager : ExerciseManager, workoutManager : WorkoutManager, workoutLogsManager : WorkoutLogsManager)
+- initializeDays() : void
+- getDay(day : String) : Day
+ execute(parser : Parser) : String
+- executeListAction() : String
+- executeAssignAction(parser : Parser) : String
+ assignWorkoutToDay(workout : Activity, day : String) : String
+- getDayFromDate(date : LocalDate) : Day
+- getDayFromDate(dateString : String) : Day
+- executeLogAction(parser : Parser) : String
+- {static} getWorkoutName(selectedDay : Day, workoutDate : String) : String
+- executeTodayAction() : String
+- getTodaysWorkoutString(givenWorkout : Workout, workoutDate : String, workoutDay : Day) : String
+- executeHistoryAction(parser : Parser) : String
+- getHistoryString() : String
+- executeClearAction(parser : Parser) : String
+ exportToJSON() : JSONObject
+ getActivityType(plural : boolean) : String
+ getListString() : String
+}


nkotaa · 2024-04-04T01:35:07Z

+#### The `Exercise` class
+An `Exercise` object represents a single exercise entered by the user. The exercise name is stored in `Exercise.activityname`.
+
+#### The `Workout` class
+A `Workout` object represents a single workout created by the user. It contains an `ArrayList` of `Exercise` objects.
+
+#### The `ExerciseLog` class
+An `ExerciseLog` object is similar to an `Exercise` object, except that it also contains information on the weight, sets and repetitions of each exercise.
+
+#### The `WorkoutLog` class
+A `WorkoutLog` object is similar to that of a `Workout` object, except it contains an `ArrayList` of `ExerciseLog` objects.


Would all this not already be self-evident from the class diagram?

nkotaa · 2024-04-04T01:49:10Z

+1. The process begins with the user inputting a command via the command-line interface. In this scenario, the User provides the command `exercise /list` to list all exercises.
+2. The command parser receives the user input and parses it to extract relevant information, such as the action (`exercise /list`) and any additional parameters.
+3. Upon receiving the parsed command, the Exercise Manager component validates the input to ensure it conforms to the expected format and criteria. This step is crucial for maintaining data integrity and preventing errors in subsequent processing.
+4. If the input passes validation, the ExerciseManager instructs the ActivityManager to list all exercises. The ActivityManager retrieves the list of exercises from the activitySet. The ActivityManager returns the exercise list to the ExerciseManager. The ExerciseManager prints the list of exercises to the User.
+5. If the input fails validation, an error message is generated and displayed to the user, informing them of the invalid command format. This ensures that users receive timely feedback and can correct their input accordingly


Consider starting the sequence diagram at a later stage, say when the command has already been parsed, for a more condensed and meaningful explanation.

nkotaa · 2024-04-04T01:54:00Z

+
+The sequence diagram below shows how an exercise is created.
+
+![addExercise](https://github.com/V4Vern/tp/assets/28131050/45f7e9b3-8a31-4dfe-a783-433acb71fa58)


FYI you should link to repository resources instead of external links, as done above.

nkotaa · 2024-04-04T01:56:03Z

+
+The sequence diagram below shows how an exercise is deleted.
+
+![deleteExercise](https://github.com/V4Vern/tp/assets/28131050/3fde6b4e-d292-497a-9468-2118125678a7)


Kindly add activation boxes for self-method calls in the ExerciseManager.

wjunjie01

Overall looks good except for some minor diagram issue

wjunjie01 · 2024-04-04T01:27:11Z

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

-## Design & implementation
+## Classes: overview


Would it be better to include a table of contents (with links to the relevant sections) for easier navigability?

wjunjie01 · 2024-04-04T01:31:33Z

+### `Activity` and child classes
+The `Activity` class serves as a parent class to `Exercise`, `ExerciseLog`, `Workout`, `WorkoutLog` and `Day` classes for the ease of usage of `ActivityManager` classes (see below).
+
+![ActivityClassDiagram](diagrams/ActivityClassDiagram.png)


Should there be a 'C' symbol in the class diagram?

Overall the class diagram seems quite comprehensive covering the relevant classes. Nice.

wjunjie01 · 2024-04-04T01:32:46Z

+4. <code>getListString()</code>: Get the string containing all the activities contained in the <code>ActivityManager</code>.
+5. `execute()`: Execute all commands related to the `ActivityManager` and return the required user input.
+
+![ActivityManagerClassDiagram](diagrams/ActivityManagerClassDiagram.png)


Should there be a 'C' / 'A' symbol in the class diagram?

wjunjie01 · 2024-04-04T01:35:34Z

+
+The sequence diagram below shows how an exercise is edited.
+


It seems that there is a missing sequence diagram here?

wjunjie01 · 2024-04-04T01:40:20Z

+
+The sequence diagram below shows how an exercise is created.
+
+![addExercise](https://github.com/V4Vern/tp/assets/28131050/45f7e9b3-8a31-4dfe-a783-433acb71fa58)


Should the return arrow in the sequence be depicted as a solid line?

Can the invocation of the method be more concise?

Are there supposed to be two class boxes at the top and bottom?

wjunjie01 · 2024-04-04T01:46:53Z

+
+The sequence diagram below shows how exercises can be listed
+
+![listExercise](https://github.com/V4Vern/tp/assets/28131050/eebe0e2e-d486-4644-b36d-e26b499d1f53)


Should the return arrow in the sequence be depicted as a solid line?

Is an activation bar required when invoking a method within the function?

wjunjie01 · 2024-04-04T01:58:14Z

+
+The sequence diagram below shows how an exercise can be searched.
+
+![searchExercises](https://github.com/V4Vern/tp/assets/28131050/fd32eba4-a7f1-460d-81cc-d9e57ca100c2)


Is an activation bar required when invoking a method within the function?

wjunjie01 · 2024-04-04T02:04:09Z

+
+The sequence diagram below shows how an exercise is deleted.
+
+![deleteExercise](https://github.com/V4Vern/tp/assets/28131050/3fde6b4e-d292-497a-9468-2118125678a7)


Is an activation bar required when invoking a method within the function?

tayponghee · 2024-04-04T05:17:55Z

+### `Activity` and child classes
+The `Activity` class serves as a parent class to `Exercise`, `ExerciseLog`, `Workout`, `WorkoutLog` and `Day` classes for the ease of usage of `ActivityManager` classes (see below).
+
+![ActivityClassDiagram](diagrams/ActivityClassDiagram.png)


Consider omitting methods that are trivial/unnecessary to improve the readability of the class diagram.

tayponghee · 2024-04-04T05:21:48Z

+![addExercise](https://github.com/V4Vern/tp/assets/28131050/45f7e9b3-8a31-4dfe-a783-433acb71fa58)
+


Assuming the print success message is void, the arrow should be dashed.

tayponghee · 2024-04-04T05:25:10Z

-|--------|----------|---------------|------------------|
-|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|
+| Version | As a ... | I want to ...             | So that I can ...                                           |


Consider adding more user stories

Add logging for different weights & reps

…into storage-test-fix

Fix bugs and refactor

Edit UG introduction

PPP

PPP: fix link

Finalise PPP

Change heading format

Fix bugs, edit UG & DG

Add key UG grammar corrections

Update readme.md and Fix table

Actually fix table insha'allah

Fix table in UG

Fix DG UMLs

Add DG corrections

joshualeejunyi changed the title ~~[F14-3] BYTE-CEPS~~ [CS2113-F14-3] BYTE-CEPS Mar 8, 2024

joshualeejunyi force-pushed the master branch from 039a9d3 to e8ab7a3 Compare March 17, 2024 08:58

yeozongyao pushed a commit to yeozongyao/tp that referenced this pull request Apr 1, 2024

Merge pull request nus-cs2113-AY2324S2#53 from liuzehui03/master

ffdb391

implement basic findBook function

NgYaoDong reviewed Apr 4, 2024

View reviewed changes

nkotaa reviewed Apr 4, 2024

View reviewed changes

wjunjie01 reviewed Apr 4, 2024

View reviewed changes

tayponghee reviewed Apr 4, 2024

View reviewed changes

V4Vern and others added 23 commits April 10, 2024 14:14

Fix gradle issue

9fbe800

Merge pull request #151 from V4Vern/workout

f55bbd9

Add logging for different weights & reps

Merge branch 'master' of https://github.com/AY2324S2-CS2113-F14-3/tp …

6533004

…into storage-test-fix

Fix bugs and refactor

da096a2

Remove whitespace

6b3d16a

Move all test JSONs into jsons folder & alter code accordingly

98a6c53

Rename test methods to fit naming scheme

d6296e6

Add methods that account for pre-existing corrupted or blank test.json

01ee899

Merge pull request #152 from pqienso/YuAn-fixMultipleLoggingBugs

1804189

Fix bugs and refactor

Clean up diagrams and plantuml codes

8a064ee

Update sequence diagram for exercise

864b0e7

Clean up & add deleteWorkout sequence diagram

1325ea2

Extract repeated magic literal "./jsons/" to String constant

a7b7d2f

Add sequence diagram for workout

a7a8fe8

Add more assertions, follow coding standard

8eae29f

Add sequence diagram for assignExercise to workout

1c91f0b

Add assign workout sequence diagram

4148618

Add sequence diagram for listExerciseInWorkout

a78aa42

Update DeveloperGuide.md

4760706

Write PPP draft, add missing author tags

0c3aa92

Add Javadocs to HelpMenuManager class

a95797c

Add Javadocs for HelpValidator class

eb7aed0

Fix coding standard violations

33dcd92

joshualeejunyi and others added 30 commits April 15, 2024 18:51

Merge pull request #206 from V4Vern/master

4d40cdd

Edit UG introduction

Remove sentence

647ea91

Merge pull request #208 from LWachtel1/final-ppp

9f1a37d

PPP

Fix broken link

f31ac12

Merge pull request #210 from LWachtel1/master

49df2f8

PPP: fix link

Merge pull request #209 from pqienso/YuAn-W13

32ccc2b

Finalise PPP

Change heading format

da6ec68

Merge pull request #211 from joshualeejunyi/update-ppp

af22cfa

Change heading format

Update UserGuide.md

2860f5d

Update DeveloperGuide.md

1e46670

Fix validation error for program /today

76a5391

Fix storage bug for exercise reps & sets

f5ded04

Merge pull request #212 from V4Vern/master

04bf3be

Fix bugs, edit UG & DG

Add key UG grammar corrections

4d4ed67

Add further grammar changes

13ba98e

Update command summary to include missing entries

9b198a3

Fix table of contents link to direct to correct heading

99e8967

Merge pull request #213 from LWachtel1/checking-UG

3662f24

Add key UG grammar corrections

Update readme

7400b3c

Reformat table with IntelliJ button

679745a

Merge pull request #214 from LWachtel1/checking-UG

0ddbd53

Update readme.md and Fix table

Add extra line for table rendering

cda2c6e

Merge pull request #215 from LWachtel1/checking-UG

37c2793

Actually fix table insha'allah

Fix table in UG

3442e78

Merge pull request #216 from V4Vern/master

ed872b3

Fix table in UG

Fix DG UMLs

c693caa

Add DG corrections

2e212f3

Merge pull request #217 from joshualeejunyi/fix-dg-umls

34b887b

Fix DG UMLs

Edit v2.0 user story for rep monitoring

88d2554

Merge pull request #218 from LWachtel1/checking-DG

20c02fc

Add DG corrections

		![addExercise](https://github.com/V4Vern/tp/assets/28131050/45f7e9b3-8a31-4dfe-a783-433acb71fa58)

		![WorkoutLogOverview.png](./diagrams/WorkoutLogOverview.png)


		## Product scope


		The sequence diagram below shows how an exercise is created.

		![addExercise](https://github.com/V4Vern/tp/assets/28131050/45f7e9b3-8a31-4dfe-a783-433acb71fa58)


		The sequence diagram below shows how an exercise is deleted.

		![deleteExercise](https://github.com/V4Vern/tp/assets/28131050/3fde6b4e-d292-497a-9468-2118125678a7)


		The sequence diagram below shows how exercises can be listed

		![listExercise](https://github.com/V4Vern/tp/assets/28131050/eebe0e2e-d486-4644-b36d-e26b499d1f53)


		The sequence diagram below shows how an exercise can be searched.

		![searchExercises](https://github.com/V4Vern/tp/assets/28131050/fd32eba4-a7f1-460d-81cc-d9e57ca100c2)

Uh oh!

Conversation

joshualeejunyi commented Mar 8, 2024

Uh oh!

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

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

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

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!

8 participants