[CS2113-W12-1] HealthMate #1

DarkDragoon2002 · 2024-09-18T05:17:24Z

Helping busy and CLI-affine people to build healthy eating habits to improve their mental and physical well-being.

wenxin-c

Overall good work from the team. Some minor suggestions for you to consider. Keep it up!!

wenxin-c · 2024-10-24T17:34:17Z

src/main/java/seedu/healthmate/HealthGoal.java

+     * @param healthGoalInput the input health goal (e.g., WEIGHT_LOSS).
+     */
+    public void saveHealthGoal(String healthGoalInput) {
+        assert healthGoalInput != null : "Health goal input cannot be null";


Good use of assertion!!

wenxin-c · 2024-10-24T17:35:38Z

src/main/java/seedu/healthmate/HealthGoal.java

+            rawCaloriesTarget = 88.362 + (13.397 * weight) + (4.799 * height) - (5.677 * age);
+        } else {
+            rawCaloriesTarget = 447.593 + (9.247 * weight) + (3.098 * height) - (4.330 * age);


You could consider turning the magic numbers into constant as well to give it a meaning.

wenxin-c · 2024-10-24T17:37:29Z

src/main/java/seedu/healthmate/DateTimeUtils.java

+    public static LocalDate currentDate() {
+        return LocalDate.now();


You could try to name methods as verbs instead of noun, e.g. getCurrentData()

wenxin-c · 2024-10-24T17:42:10Z

src/main/java/seedu/healthmate/HistoryTracker.java

+        } catch (NoSuchElementException e) {
+            // silent catch if existing user file contains no content
+        }


Try not to use empty catch block, you might want to implement some error catching/logging in the catch block.

wenxin-c · 2024-10-24T17:44:20Z

src/main/java/seedu/healthmate/HistoryTracker.java

+    private void saveMealToFile(List<Meal> meals, String fileName) {
+        try (BufferedWriter writer = new BufferedWriter(new FileWriter(DATA_DIRECTORY + File.separator + fileName))) {
+            for (Meal meal : meals) {
+                writer.write(meal.toSaveString());
+                writer.newLine();
+            }
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+    }


This class is getting very long. One improvement you can consider is to extract such helper methods e.g. saving data to a file etc into a utils class and invoke relevant methods if needed.

wenxin-c · 2024-10-24T17:52:52Z

src/main/java/seedu/healthmate/command/commands/AddMealEntryCommand.java

+    private static final String FORMAT =
+            "add mealEntry {meal name from menu} | or | add mealEntry {meal name} /c{number of " + "calories}";
+    private static final String DESCRIPTION = "Adds a meal entry to the meal log either from a pre-existing meal in " +
+            "the" +


You could consider splitting the line at other places instead of having a single word on one line.

wenxin-c · 2024-10-24T17:58:38Z

src/main/java/seedu/healthmate/MealList.java

+    public int size() {
+        return this.mealList.size();
+    }


Try to name this method as verb as well like other methods, e.g. getSize()

wenxin-c · 2024-10-24T17:59:40Z

src/main/java/seedu/healthmate/MealSaver.java

+
+    public Meal extractMealFromUserInput(String userInput) {
+        try {
+            String command = "save meal";


You might consider extracting some string into named constant to give it some meaning.

wenxin-c · 2024-10-24T18:04:24Z

src/main/java/seedu/healthmate/ChatParser.java

+            switch (userInput) {
+            case "bye":
+                logger.log(Level.INFO, "User closes application");
+                UI.printFarewell();
+                break;
+            default:
+                try {
+                    this.multiCommandParsing(userInput, user);
+                    logger.log(Level.INFO, "User input contains more than 1 token");
+                } catch (ArrayIndexOutOfBoundsException a) {
+                    logger.log(Level.WARNING, "Invalid command", a);
+                    UI.printReply("Invalid command", "Retry: ");
+                }


If there are no more potential cases to be added, you could consider just use a simple if...else.... switch will be more suitable if there are more cases.

wenxin-c · 2024-10-24T18:05:15Z

src/main/java/seedu/healthmate/ChatParser.java

+import seedu.healthmate.command.Command;
+import seedu.healthmate.command.commands.LogMealsCommand;
+import seedu.healthmate.command.commands.SaveMealCommand;
+import seedu.healthmate.command.commands.ListCommandsCommand;
+import seedu.healthmate.command.commands.AddMealEntryCommand;
+import seedu.healthmate.command.commands.DeleteMealCommand;
+import seedu.healthmate.command.commands.DeleteMealEntryCommand;
+import seedu.healthmate.command.commands.MealMenuCommand;
+import seedu.healthmate.command.commands.UpdateUserDataCommand;
+import seedu.healthmate.command.commands.TodayCalorieProgressCommand;
+import seedu.healthmate.command.commands.HistoricCalorieProgressCommand;
+import seedu.healthmate.command.CommandMap;


Good extraction of commands!!

cnivedit

Good attempt! Consider refining and adding more diagrams

cnivedit · 2024-10-30T06:52:57Z

docs/DeveloperGuide.md

+To create or load a user profile the `User` class provides the method `checkForUserData` which loads 
+saved user information if available from an existing file usingn the `HistoryTracker` or prompts the user
+to input new information for creating a new profile as shown in the sequence diagram below.
+![User SD](images/userSequenceDiagram.jpg)


Does the scanner instance exist prior to this point? If yes, there shouldnt be an activation bar for the constructor and in case it was newly created, perhaps there should be a call to the constructor?

Perhaps consider omitting info about file creation as it may not be relevant to the purpose of the sequence diagram

cnivedit · 2024-10-30T07:05:51Z

docs/DeveloperGuide.md

+For the sake of clarity, UI class is omitted since it is used across most classes to systematize any form of
+printing output to the user.
+
+![High Level CD](images/highLevelClassDiagram.jpg)


Should the class names be preceded with a colon?

cnivedit · 2024-10-30T07:07:08Z

docs/DeveloperGuide.md

+The Meal class encapsulates the concept of a meal. As the purpose of this application 
+is to track calorie consumption, this consists of a mandatory calorie entry. The meal's name attribute, 
+is however an Optional<String> allowing a case, where no meaningful label can be attached to a certain consumption.
+![User SD](images/addMeal.png)


Image fails to load

cnivedit · 2024-10-30T07:09:23Z

docs/images/addMeal.png

Should the sequence diagram omit program execution prior to when add meal command is detected?

kaboomzxc

Overall DG is okay good 👍🏻

kaboomzxc · 2024-10-31T10:57:16Z

docs/DeveloperGuide.md

+For the sake of clarity, UI class is omitted since it is used across most classes to systematize any form of
+printing output to the user.


although I understand that you mentioned Ui class is omitted for clarity, however my modest opinion is that Ui is crucial component to be documented. would a separate UI class diagram be useful?

kaboomzxc · 2024-10-31T11:12:36Z

docs/DeveloperGuide.md

+8. Error Handling:
+   - Try entering invalid commands or data to ensure the application handles errors gracefully and provides helpful error messages.


would it be favourable to show some examples?

kaboomzxc · 2024-10-31T11:21:11Z

src/main/java/seedu/healthmate/HealthGoal.java

+    public double getTargetCalories(double height, double weight, boolean isMale, int age) {
+        assert height > 0 : "Height must be positive";
+        assert weight > 0 : "Weight must be positive";
+        assert age > 0 : "Age must be positive";


good to guard against negative height/weight/age !
I am wondering, would it be useful to guard against unrealistic data such as 500 yrs of Age ?

kaboomzxc · 2024-10-31T11:30:23Z

docs/DeveloperGuide.md

+For the sake of clarity, UI class is omitted since it is used across most classes to systematize any form of
+printing output to the user.
+
+![High Level CD](images/highLevelClassDiagram.jpg)


Good separation of concerns between classes !

kaboomzxc · 2024-10-31T11:31:39Z

docs/DeveloperGuide.md

+
+#### HealthMate


Clear explanation of classes

kaboomzxc · 2024-10-31T11:47:03Z

docs/DeveloperGuide.md

+
+HistoryTracker allows for the persistance of user inputted data between sessions by storing it in a local csv file.
+
+## Features


Could some Sequence Diagrams of the processing of Commands be shown?

kaboomzxc · 2024-10-31T12:14:05Z

docs/DeveloperGuide.md

+![User SD](images/userSequenceDiagram.jpg)
+Reference diagrams used
+![User SD](images/askForUserDataSD.png)
+![Read User SD](images/readUserDataFromFileSD.png)


Good decision to show two sub-diagrams for clarity; creating a new profile for new user, and loading saved file for existing user

kaboomzxc · 2024-10-31T12:15:05Z

docs/DeveloperGuide.md

+---
+### Creating a User Profile
+To create or load a user profile the `User` class provides the method `checkForUserData` which loads 
+saved user information if available from an existing file usingn the `HistoryTracker` or prompts the user


found a minor typo hehe , "using" is the correct spelling instead of "usingn"

kennethszj · 2024-10-31T12:26:40Z

docs/DeveloperGuide.md

+This specifically includes adherance to the "Tell Don't Ask" principle which was enforced by
+making most attributes of all classes above private and avoiding getter methods if possible.
+The following diagram illustrates the resulting associations, methods and attributes.
+For the sake of clarity, UI class is omitted since it is used across most classes to systematize any form of


would it be helpful to include a minimal/simple representation of the UI class in the high level class diagram to indicate dependency across all classes. this might improve clarity around UI interactions

kennethszj · 2024-10-31T12:38:06Z

docs/DeveloperGuide.md

+To create or load a user profile the `User` class provides the method `checkForUserData` which loads 
+saved user information if available from an existing file usingn the `HistoryTracker` or prompts the user
+to input new information for creating a new profile as shown in the sequence diagram below.
+![User SD](images/userSequenceDiagram.jpg)


i agree with cnivedit about the Scanner instance's activation bar. additionally, if scanner is indeed reused across multiple interactions, would it make sense to show its initialisation outside the main sequence flow?

kennethszj · 2024-10-31T12:42:45Z

docs/DeveloperGuide.md

+The Meal class encapsulates the concept of a meal. As the purpose of this application 
+is to track calorie consumption, this consists of a mandatory calorie entry. The meal's name attribute, 
+is however an Optional<String> allowing a case, where no meaningful label can be attached to a certain consumption.
+![User SD](images/addMeal.png)


the sequence for extractAndAppendMeal() is clear in showing that a meal object is created and appended.
Would it be clearer to describe what information is extracted? like what does this method extract (eg, name, calorie...)

kennethszj · 2024-10-31T12:51:26Z

docs/DeveloperGuide.md

+to input new information for creating a new profile as shown in the sequence diagram below.
+![User SD](images/userSequenceDiagram.jpg)
+Reference diagrams used
+![User SD](images/askForUserDataSD.png)


in the sequence, "printString(...)" is used multiple times. would it be more readable to differentiate each print string with specific text or parameters? (eg, printstring(enter calorie:)). this could help viewers understand what actual prompt is displayed at each step.

jadenlimjc

Overall a good DG, perhaps the Command Handling Section could do with some sequence diagrams or examples of inputs to aid clarity

jadenlimjc · 2024-11-01T13:37:43Z

docs/DeveloperGuide.md

+This specifically includes adherance to the "Tell Don't Ask" principle which was enforced by
+making most attributes of all classes above private and avoiding getter methods if possible.
+The following diagram illustrates the resulting associations, methods and attributes.
+For the sake of clarity, UI class is omitted since it is used across most classes to systematize any form of


likewise to previous reviewers, my belief is that some documentation of the UI component would be useful in order to provide clarity into possible outputs a user should receive. perhaps you could separate the UI diagram form the overarching diagram provided to retain the clarity your diagram currently has while still providing viewers with the information regarding the UI class.

jadenlimjc · 2024-11-01T13:39:18Z

docs/DeveloperGuide.md

+- A `MealList` object called `mealOptions` 
+  - Contains meals that are presaved by the user for quick selection to track commonly consumed meals
+  - the command `meal menu` is used to display the current mealOptions. The implementation of this command is shown in the UML diagram below.
+![Meal Menu SD](images/mealMenuSD.png)


perhaps the diagram could include a user so that the run() function does not appear out of nowhere, providing additional clarity.

jadenlimjc · 2024-11-01T13:47:49Z

docs/DeveloperGuide.md

+To create or load a user profile the `User` class provides the method `checkForUserData` which loads 
+saved user information if available from an existing file usingn the `HistoryTracker` or prompts the user
+to input new information for creating a new profile as shown in the sequence diagram below.
+![User SD](images/userSequenceDiagram.jpg)


personally, this image used is quite blurry and the details are hard to see regardless of zoom. perhaps the team could consider making the diagram slightly easier on the eyes to improve user experience. another possible solution could be to break the diagram into smaller independent sections. as cnivedit mentioned, the file creation may not be the mos relevant to the creation of a user profile so can consider depicting file creation in a separate diagram.

Add UserEntryList class. Change txt save file to csv.

…ecommendations

…ations 66 add meal option recommendations

Update DG

…ryry-3302/tp into 60-timeline-of-weight-history

Bug fix historicCalories Test

Fix timestamp bug

…oon2002/tp into Bug-Fixes-+-Update-Docs

Update Jonas PPP

Bug fixes + Update docs

…ssing-t-in-list-commands-documentation Fix: add documentation to add meal entry

Update PPP

PPP + DG changes

Fix: Renamed PPP according to submission guidelines

change team name to lowercase

Include HP intro text and PPP updates

Fix formatting UG

…ssing-t-in-list-commands-documentation Fix

wenxin-c reviewed Oct 24, 2024

View reviewed changes

cnivedit reviewed Oct 30, 2024

View reviewed changes

kaboomzxc reviewed Oct 31, 2024

View reviewed changes

kennethszj reviewed Oct 31, 2024

View reviewed changes

jadenlimjc reviewed Nov 1, 2024

View reviewed changes

ryan-txn and others added 25 commits November 2, 2024 14:52

Remove unecessary import

50c7b7e

Update user dummy data

0e762dc

Merge pull request #109 from ryan-txn/Implement_Single_User_TimeStamp

dd0acbc

Add UserEntryList class. Change txt save file to csv.

Create recommender package

cbfbe7b

Merge branch 'AY2425S1-CS2113-W12-1:master' into 66-add-meal-option-r…

54f06e1

…ecommendations

create recipe map

899fd30

create meal recommendations

6308bc2

Test: create test cases

35425f9

Fix styles

b04154b

Add: Update commands

d37a045

Feat: Add Weight timeline display

5d1758c

Test: Weight Entry Display test

8cb9313

Merge pull request #123 from ryryry-3302/66-add-meal-option-recommend…

3369dc2

…ations 66 add meal option recommendations

Bug fix historicCalories Test

0be62b8

update DG and UG

9a4e6a4

Fix test

93ad68d

Merge pull request #126 from AY2425S1-CS2113-W12-1/updateDG

5495e50

Update DG

Merge branch 'master' into 60-timeline-of-weight-history

2329171

Fix timestamp bug

e4bf14c

Style: fix styling issue

54bf3bb

Merge branch '60-timeline-of-weight-history' of https://github.com/ry…

c374167

…ryry-3302/tp into 60-timeline-of-weight-history

Merge branch 'master' into fixTest

c21e54c

Merge pull request #124 from AY2425S1-CS2113-W12-1/fixTest

925c942

Bug fix historicCalories Test

Merge pull request #128 from Dri-water/fix-timestamp

ce070d2

Fix timestamp bug

Merge branch 'master' into 60-timeline-of-weight-history

bc46d28

Dri-water and others added 30 commits November 11, 2024 21:29

Update Jonas PPP

61cf54a

Fix: Text-ui-test fixed

86b0001

Merge branch 'Bug-Fixes-+-Update-Docs' of https://github.com/DarkDrag…

4af913a

…oon2002/tp into Bug-Fixes-+-Update-Docs

Fix PPP formatting

76f8405

Merge pull request #234 from Dri-water/update-Jonas-PPP

d274c71

Update Jonas PPP

Fix: Fixed user_data.csv

d20204b

Merge pull request #233 from DarkDragoon2002/Bug-Fixes-+-Update-Docs

52f047e

Bug fixes + Update docs

Fix: add documentation to add meal entry

3af84a4

Update PPP

c7063e4

Docs: Updated Docs

dd6d71e

Merge pull request #236 from ryryry-3302/235-add-mealentry-command-mi…

56f3d10

…ssing-t-in-list-commands-documentation Fix: add documentation to add meal entry

Merge branch 'master' into UpdatePPPKenneth

8fb0631

Merge pull request #238 from AY2425S1-CS2113-W12-1/UpdatePPPKenneth

7489534

Update PPP

Merge pull request #237 from DarkDragoon2002/Update-Docs

2697e33

PPP + DG changes

change team name to lowercase

984cade

Fix: Renamed PPP according to submission guidelines

45a7adf

Fix: PPP Formatting

d417185

Shorten PPP

a92fd78

Merge pull request #239 from DarkDragoon2002/Update-Docs

47a19f6

Fix: Renamed PPP according to submission guidelines

Merge pull request #240 from AY2425S1-CS2113-W12-1/makeNameLower

2797182

change team name to lowercase

Fix final errors in PPP

e99cff8

Add short description to HP

6aa01d2

Merge pull request #241 from AY2425S1-CS2113-W12-1/makeNameLower

c50a65f

Include HP intro text and PPP updates

Fix formatting UG

859d76e

Correct errors, added details

cabe637

Merge pull request #242 from AY2425S1-CS2113-W12-1/UpdateDGKenneth

5b5f4f1

Fix formatting UG

Fix

1af38f0

Fix style

060a260

Update test

e42a2fa

Merge pull request #243 from ryryry-3302/235-add-mealentry-command-mi…

c661dd8

…ssing-t-in-list-commands-documentation Fix

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113-W12-1] HealthMate #1

[CS2113-W12-1] HealthMate #1

DarkDragoon2002 commented Sep 18, 2024

wenxin-c left a comment

wenxin-c Oct 24, 2024

wenxin-c Oct 24, 2024

wenxin-c Oct 24, 2024

wenxin-c Oct 24, 2024

wenxin-c Oct 24, 2024

wenxin-c Oct 24, 2024

wenxin-c Oct 24, 2024

wenxin-c Oct 24, 2024

wenxin-c Oct 24, 2024

wenxin-c Oct 24, 2024

cnivedit left a comment

cnivedit Oct 30, 2024

cnivedit Oct 30, 2024

cnivedit Oct 30, 2024

cnivedit Oct 30, 2024

cnivedit Oct 30, 2024

kaboomzxc left a comment

kaboomzxc Oct 31, 2024

kaboomzxc Oct 31, 2024

kaboomzxc Oct 31, 2024

kaboomzxc Oct 31, 2024

kaboomzxc Oct 31, 2024

kaboomzxc Oct 31, 2024

kaboomzxc Oct 31, 2024

kaboomzxc Oct 31, 2024

kennethszj Oct 31, 2024

kennethszj Oct 31, 2024

kennethszj Oct 31, 2024 •

edited

Loading

kennethszj Oct 31, 2024 •

edited

Loading

jadenlimjc left a comment

jadenlimjc Nov 1, 2024

jadenlimjc Nov 1, 2024

jadenlimjc Nov 1, 2024

		public static LocalDate currentDate() {
		return LocalDate.now();

		For the sake of clarity, UI class is omitted since it is used across most classes to systematize any form of
		printing output to the user.

		8. Error Handling:
		- Try entering invalid commands or data to ensure the application handles errors gracefully and provides helpful error messages.


		HistoryTracker allows for the persistance of user inputted data between sessions by storing it in a local csv file.

		## Features


		#### HealthMate

[CS2113-W12-1] HealthMate #1

Are you sure you want to change the base?

[CS2113-W12-1] HealthMate #1

Conversation

DarkDragoon2002 commented Sep 18, 2024

wenxin-c 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cnivedit 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

kaboomzxc 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kennethszj Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

kennethszj Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

jadenlimjc 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

kennethszj Oct 31, 2024 •

edited

Loading

kennethszj Oct 31, 2024 •

edited

Loading