[CS2113-F14-4] EZMealPlan by Teng-Yong-Quan · Pull Request #44 · nus-cs2113-AY2425S2/tp

Teng-Yong-Quan · 2025-02-27T03:26:12Z

EZMealPlan helps busy people with food dilemma and meal-preparation issues to suggest food recommendations for them. It uses a simple-to-use CLI to provide meal suggestions to the users, taking into account their budget, food preferences and the ingredients they have.

Merge branch 'master' into branch-rchlai

thomasjlalba

Good work thus far! Just some minor suggestions on your coding standards and quality. Keep up the good work!

thomasjlalba · 2025-03-27T08:58:31Z

+     */
+    public Meal removeMeal(int index) throws EZMealPlanException {
+        try {
+            return mealList.remove(index - 1);


Maybe it would be good to comment why it is index - 1 to make it more understandable

thomasjlalba · 2025-03-27T09:01:06Z

+        int indexOfIndex = 1;
+
+        try {
+            return input.split("\\s+")[indexOfIndex];


Maybe it would be good to refactor the regex to make it more understandable to readers and to avoid magic strings

thomasjlalba · 2025-03-27T09:09:08Z

+        if (file.exists()) {
+            Scanner scanner = new Scanner(file);
+            while (scanner.hasNextLine()) {
+                String line = scanner.nextLine().trim();
+                if (line.isEmpty()) {
+                    continue;
+                }
+                // Split the line by "|" with optional spaces around it.
+                String[] parts = line.split("\\s*\\|\\s*");
+                int minLengthToHaveIng = 2;
+                if (parts.length < minLengthToHaveIng) {
+                    continue; // Skip lines that don't have ingredients.
+                }
+                checkValidMeal(parts, meals);
+            }
+            scanner.close();
+        }


Maybe to reduce the nesting you can look into using a guard clause:

if (!file.exists()) { return meals; } // if file exists

thomasjlalba · 2025-03-27T09:10:54Z

+                }
+                // Split the line by "|" with optional spaces around it.
+                String[] parts = line.split("\\s*\\|\\s*");
+                int minLengthToHaveIng = 2;


Maybe this can be placed as a constant instead?

thomasjlalba · 2025-03-27T09:13:12Z

+        int openBracketIndex = ingredientStr.indexOf("(");
+        int closeBracketIndex = ingredientStr.indexOf(")");
+        int notFoundIndex = -1;
+        if (openBracketIndex == notFoundIndex || closeBracketIndex == notFoundIndex) {


Maybe you can refactor the expression within the if statement to be a simpler expression.

thomasjlalba · 2025-03-27T09:14:53Z

+            return;
+        }
+        switch(commandDescription) {
+        case "list":


Maybe you can look into refactoring this to avoid magic strings

thomasjlalba · 2025-03-27T09:17:44Z

+        String splitRegex = "\\s*,\\s*";
+        String[] ingredientsArray = ingInput.split(splitRegex);


Good work here refactoring the magic string regex, do make it consistent for the rest of the project!

thomasjlalba · 2025-03-27T09:31:34Z

+    String ing = "/ing";
+    String mname = "/mname";
+    String mcost = "/mcost";
+    String filterMethod = "";
+    final String byIng = "byIng";
+    final String byMname = "byMname";
+    final String byMcost = "byMcost";


Good work on refactoring the magic strings! But maybe since it is a constant, its naming could be in SCREAMING_SNAKE_CASE.

gitHST · 2025-04-02T04:11:19Z

Might be worth moving images into a folder ie docs/imgs, nbd tho

gitHST · 2025-04-02T04:15:30Z

very nice diagrams

gitHST · 2025-04-02T04:21:24Z

+    assertIterableEquals(expectedMeals, testUI.capturedMeals);
+}
+```
+## Implementation


Could write this part or remove redundant title

gitHST · 2025-04-02T04:22:31Z

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


Maybe just attatch this part to the bottom of the above table, since you have a column for version it would be redundant if every version is a separate table

jxromy

Reviewed your UML diagrams and syntax, overall a well-written DG :)

jxromy · 2025-04-03T03:44:36Z

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


User stories for v1.0 looks good! perhaps more can be added to v2.0?

jxromy · 2025-04-03T03:46:05Z

+![ConstructingMainMeals.png](diagrams/ConstructingMainMeals.png)
+This sequence diagram shows the procedures of extracting meals from the "mainMealFile" (mainList.txt). The procedures of extracting meals from the "userMealFile" (userList.txt) can be depicted simply by replacing "mainMealFile" with "userMealFile", storage.getMainListFile() with storage.getUserListFile(), mealManager.getMainMeals() with mealManager.getUserMeals() and lastly, "mainMeals" of MainMeals class with "userMeals" of UserMeals class.
+
+![RunCommandSequenceDiagram.png](diagrams/RunCommandSequenceDiagram.png)


Great diagram! I love the use of different colours

jxromy · 2025-04-03T03:54:23Z

+
+- All user inputs are case-sensitive and normalised to lowercase.
+
+![BootingUpEZMealPlan.png](diagrams/BootingUpEZMealPlan.png)


Activation boxes are clearly shown and program flow is depicted well

New line error in text after diagrams in this section

jxromy · 2025-04-03T03:55:05Z

+![BootingUpEZMealPlan.png](diagrams/BootingUpEZMealPlan.png)
+This sequence diagram shows the processes that EZMealPlan system has to undergo while it is being booted up before it is ready for usage.
+
+![ConstructingMainMeals.png](diagrams/ConstructingMainMeals.png)


Perhaps a High-Level Architecture Diagram would help to illustrate how major components interact (e.g., Parser → Command → MealManager → Storage)

I agree with this statement as the diagram would illustrate the relationship between each componenets as well

wongyihao02

generally looks good

wongyihao02 · 2025-04-03T04:50:34Z

+     *
+     * @param ingredients a list of ingredients (with name and price) to be bought.
+     */
+    public BuyCommand(List<Ingredient> ingredients) {


dont see this command in the Dev guide.Where does this fit?Is this for constructing meals?

wongyihao02 · 2025-04-03T04:55:29Z

+public abstract class FilterSelectCommand extends Command {
+    String filterOrSelect;
+    String ing = "/ing";
+    String mname = "/mname";


why arent these final,dosent seem like they are getting changed in this class.

wongyihao02 · 2025-04-03T04:57:24Z

+            ui.printDeleteCommandHelp();
+            break;
+        case "view":
+            ui.printViewCommandHelp();


good that code is being abstracted out,SLAP

wongyihao02 · 2025-04-03T05:00:57Z

+        logger.fine("exiting EZMealPlan");
+    }
+
+    private static void checkConstructedLists(MealManager mealManager) {


could these commands be abstracted out into their own classes/packages?

TiangSoonYong

Overall the UML diagrams are well constructed and readable. One minor issue is regarding the use of PNGs instead of the PUML itself.

TiangSoonYong · 2025-04-03T05:25:00Z

It is mentioned that Product is an Abstract, perhaps it should be reflected here as well. Maybe you could change the diagonal arrows to vertical arrows instead as it affected the readability of the multiplicity of ingredientList.

TiangSoonYong · 2025-04-03T05:27:27Z

I like the use of colours within the diagram and it make it more readable!

TiangSoonYong · 2025-04-03T05:28:49Z

+![BootingUpEZMealPlan.png](diagrams/BootingUpEZMealPlan.png)
+This sequence diagram shows the processes that EZMealPlan system has to undergo while it is being booted up before it is ready for usage.
+
+![ConstructingMainMeals.png](diagrams/ConstructingMainMeals.png)


I agree with this statement as the diagram would illustrate the relationship between each componenets as well

dylancmznus · 2025-04-03T03:43:29Z

+- **Storage**: Handles saving and loading from `main_meal_list.txt` and `user_meal_list.txt`.

-{Describe the target user profile}
+### Logging


Logging section may need some more expanding on

dylancmznus · 2025-04-03T03:44:27Z

+
+**Testability:**
+- The design allows for easy unit testing by injecting a test-specific UI that captures the output.
+


Design goals are well explained

dylancmznus · 2025-04-03T03:47:50Z

+| v1.0    | Time-constrained user    | Check for recipes based on cook time                                                                    | Quickly find recipes for myself                                               |
+| v1.0    | Social user              | Share my favorite recipes with friends                                                                  | Get feedback from friends or cooks                                            |
+| v1.0    | new user                 | see usage instructions                                                                                  | refer to them when I forget how to use the application                        |



user stories are well thought out and contains many considerations for the user

dylancmznus · 2025-04-03T03:52:38Z

+    assertIterableEquals(expectedMeals, testUI.capturedMeals);
+}
+```
+## Implementation


The implementation may need to be worked on, with the sequence diagrams added here

brand0nnn · 2025-04-03T05:52:51Z

+![ConstructingMainMeals.png](diagrams/ConstructingMainMeals.png)
+This sequence diagram shows the procedures of extracting meals from the "mainMealFile" (mainList.txt). The procedures of extracting meals from the "userMealFile" (userList.txt) can be depicted simply by replacing "mainMealFile" with "userMealFile", storage.getMainListFile() with storage.getUserListFile(), mealManager.getMainMeals() with mealManager.getUserMeals() and lastly, "mainMeals" of MainMeals class with "userMeals" of UserMeals class.
+
+![RunCommandSequenceDiagram.png](diagrams/RunCommandSequenceDiagram.png)


Well drawn diagram! The colour coding made it easier to read.

brand0nnn · 2025-04-03T05:56:07Z

+
+##### 1.3 Sequence Diagram
+
+![.\diagrams\MealCommand.png](.\diagrams\MealCommand.png)


The return lines should be dashed instead of solid

Update Userguide

Add InventoryCommand

update Userguide

Update DG for SelectCommand

Update the userguide

Update DeveloperGuide with CreateCommand and CreateChecker diagrams

Branch userguide v3

Branch DG

Add to dg Delete

Improve Test Coverage

Add more sequence diagrams

Update UML and correct typos in UG

update DG with for consume and checker

…into branch-final-refactoring # Conflicts: # src/main/java/ezmealplan/command/RecommendCommand.java

Update developer guide

…into branch-final-refactoring # Conflicts: # src/test/java/ezmealplan/command/RecommendCommandTest.java

Update ppp

Branch Final Refactoring

Update PPP

Update UG and PPP

update DG

Fix problems with DG

rchlai added a commit to rchlai/tp that referenced this pull request Mar 20, 2025

Merge pull request nus-cs2113-AY2425S2#44 from rchlai/branch-rchlai

3d122ca

Merge branch 'master' into branch-rchlai

thomasjlalba reviewed Mar 27, 2025

View reviewed changes

gitHST reviewed Apr 2, 2025

View reviewed changes

jxromy reviewed Apr 3, 2025

View reviewed changes

wongyihao02 reviewed Apr 3, 2025

View reviewed changes

TiangSoonYong reviewed Apr 3, 2025

View reviewed changes

dylancmznus reviewed Apr 3, 2025

View reviewed changes

brand0nnn reviewed Apr 3, 2025

View reviewed changes

Teng-Yong-Quan and others added 22 commits April 3, 2025 22:03

Merge pull request #93 from Cheng-Zhiyuan/master

5c45838

Update Userguide

Add InventoryCommand

bc56f54

update Userguide

42d5626

Merge pull request #95 from wentuoc/branch-Inventory

dde190e

Add InventoryCommand

Merge pull request #96 from Cheng-Zhiyuan/Branch-Userguide-V2

bd063fe

update Userguide

Update UG for SelectCommand

77941db

Update DeveloperGuide with CreateCommand and CreateChecker diagrams

91eb962

Merge pull request #97 from olsonwangyj/master

21ad200

Update DG for SelectCommand

Update DG EZMealPlan architecture

5954568

Add DeleteCommand to DG

96e6784

fixed merge conflicts

280b2f3

Update the photos to be most recent version

8023b7d

Update the userguide

Update PPP

5334956

Merge branch 'master' into branch-dg-third

bd8ff89

Edit ui and command packages in DG

f37ad48

fix DG order select and delete

d808ce6

Merge pull request #98 from Teng-Yong-Quan/branch-dg-third

42d09da

Update DeveloperGuide with CreateCommand and CreateChecker diagrams

Merge pull request #99 from Cheng-Zhiyuan/Branch-Userguide-V3

9fac783

Branch userguide v3

Merge branch 'master' into branch-DG-v2

7c8b3d7

Merge pull request #100 from wentuoc/branch-DG-v2

04e4fd1

Branch DG

fixed merge conflicts

56d4c5e

Merge pull request #101 from RyanLing169/Add-to-DG

9b4f060

Add to dg Delete

olsonwangyj and others added 30 commits April 8, 2025 12:09

Merge branch 'master' of https://github.com/AY2425S2-CS2113-F14-4/tp

f6688ea

Add more sequence diagrams

0424d02

Merge pull request #202 from wentuoc/branch-JUnit-tests-v2-1

5140854

Improve Test Coverage

Merge pull request #203 from Teng-Yong-Quan/branch-dg-more

8816c5a

Add more sequence diagrams

Merge pull request #194 from olsonwangyj/master

9a3a36b

Update UML and correct typos in UG

update ppp

d98c2b1

Merge branch 'master' of https://github.com/AY2425S2-CS2113-F14-4/tp

f6c80d2

update DG with for consume and checker

b38f1a4

Update developer guide

c772c87

Update PPP

2dce01e

Add JavaDocs and format code

556a10d

Merge pull request #204 from Cheng-Zhiyuan/master

d1b02f5

update DG with for consume and checker

Updated PPP

a2bb591

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

59dcf57

…into branch-final-refactoring # Conflicts: # src/main/java/ezmealplan/command/RecommendCommand.java

Updated PPP

1a98d15

Merge pull request #205 from Teng-Yong-Quan/branch-ppp-self

910f9ce

Update developer guide

Updated PPP

5a9a7ae

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

9d072f0

…into branch-final-refactoring # Conflicts: # src/test/java/ezmealplan/command/RecommendCommandTest.java

Merge pull request #207 from RyanLing169/update-PPP

eeef9b1

Update ppp

Update build.gradle

8cce837

Merge pull request #206 from wentuoc/branch-final-refactoring

9caba6a

Branch Final Refactoring

Merge pull request #208 from olsonwangyj/master

6d6cc7d

Update PPP

update DG

0741e53

Update UG and PPP

9610123

Merge pull request #209 from wentuoc/branch-final-refactoring

d6d099d

Update UG and PPP

Merge branch 'master' into master

b2c053a

Merge pull request #210 from Cheng-Zhiyuan/master

628964f

update DG

Fix problems with DG

43ed11e

Fix bug with Parser

891303d

Merge pull request #211 from wentuoc/master

f7c06b4

Fix problems with DG

		String splitRegex = "\\s,\\s";
		String[] ingredientsArray = ingInput.split(splitRegex);


		- All user inputs are case-sensitive and normalised to lowercase.

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


		Testability:
		- The design allows for easy unit testing by injecting a test-specific UI that captures the output.


		##### 1.3 Sequence Diagram

		![.\diagrams\MealCommand.png](.\diagrams\MealCommand.png)

Conversation

Teng-Yong-Quan commented Feb 27, 2025

Uh oh!

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

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

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

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

Reviewers

Assignees

Labels