[CS2113-T11b-1] CookingAids by jxromy · Pull Request #71 · nus-cs2113-AY2425S2/tp

jxromy · 2025-03-11T13:13:55Z

CookingAids helps exchange students plan for healthy meals effortlessly. With an intuitive meal planner and a built-in recipe generator, users can create healthy meal plans and optimise their grocery shopping. The recipe generator suggests easy-to-make dishes based on available ingredients, making meal preparation more efficient and cost-effective.

aditichadha1310 · 2025-03-28T09:55:37Z

+    private static int currentId = 1; // Keeps track of the latest assigned ID
+
+    public static synchronized int generateNewDishId() {
+        return currentId++; // Increment and return the next ID


It would be nice to have comments for the reader rather than the coder to increase readability. Avoid adding comments which are for the coder's reference.

aditichadha1310 · 2025-03-28T10:02:21Z

+        removeExpiredIngredients(name);
+
+        // Reduce quantity starting from the earliest expiry date
+        for (Iterator<Ingredient> iterator = ingredientList.iterator(); iterator.hasNext() && amount > 0; ) {


It would be nice to use more intuitive variable names than "iterator" to increase code readability.

aditichadha1310 · 2025-03-28T10:02:54Z

+
+        // Reduce quantity starting from the earliest expiry date
+        for (Iterator<Ingredient> iterator = ingredientList.iterator(); iterator.hasNext() && amount > 0; ) {
+            Ingredient ing = iterator.next();


Similarly for "ing" , better to use more intuitive variable name.

aditichadha1310 · 2025-03-28T10:04:47Z

+
+        ArrayList<String> ingredients = new ArrayList<>();
+        if (!ingredientsString.isEmpty()) {
+            String[] ingredientArray = ingredientsString.split(",");


Try avoiding the usage of magic strings and magic literals

Thanks for spotting this! Issue has been fixed in the latest commit

aditichadha1310 · 2025-03-28T10:05:23Z

+    }
+
+
+    public static void deleteDish(String receivedText) {


This is a very long method. try to keep method length to about 30 LOC.

Long methods have been refactored in the latest commit

noradazaperez

Shouldn't you be using standard UML notation? It seems that the red squares and green circles are not standard UML.

Maybe the classes and methods are too detailed. Try being more simple. For example, instead of
static void initializeIngredientStorage(HashMap , List newIngredients), you could try

initializeIngredienteStorage(String[], Ingredient[]): void

You might be missing some attributes and methods in the Ingredient class.
Shouldn't user stories be properly edited?
It seems that you guys haven't added any non -functional requirements or instructions for manual testing.

kaixiangg

Progress looks good to me so far, just a few nits to pick, keep it up! :)

kaixiangg · 2025-04-02T04:22:33Z

+
+#### <ins>Implementation</ins>
+
+* `Food` is an abstract class.


Nice job displaying the details of the classes here clearly, however would it be more concise and clear if it is integrated directly together with class diagrams?

kaixiangg · 2025-04-02T04:25:11Z

@@ -2,29 +2,144 @@

 ## Acknowledgements


Can consider including sources used here such as different libraries used.

kaixiangg · 2025-04-02T04:26:26Z

+
+
+![img.png](img.png)
+### UI 


Can consider making each of the components of the application with a larger font for easier readability for developers who are collaborating

kaixiangg · 2025-04-02T04:28:20Z

+| v2.1    | aspiring chef | save my favourite recipes | access them easily |
+| v2.1    | user that is going to shop soon | be recommended recipes that are an item away | plan what to buy next when I'm not limited by my current ingredients |
 ## Non-Functional Requirements



Can consider adding manual testing section when one downloads the jar file for more completeness

kaixiangg · 2025-04-02T04:29:12Z

Similar to the earlier reviews left, there could be formatting issues that might not directly reflect when using the IDE and hence the markdown is not being displayed nicely.

jwyk

Other than rendering problems and fore-mentioned comments, the DG looks clean and good 👍.

jwyk · 2025-04-02T05:18:16Z

+| Version | As a ... | I can ... | So that I can ... |
+|---------|----------|-----------|-------------------|
+| v1.0    | Veteran cook | add new recipes to the list | enjoy my own recipes without relying on the default list |
+| v1.0    | forgetful student | see my current quantity of ingredients | check if I have enough ingredients to make foods and whether I should buy more |
+| v1.0    | indecisive user | change my meal plans | have flexibility in my meals |


Should align this to make the table work because the table isn't rendering properly

jwyk · 2025-04-02T05:21:33Z

+
+The bulk of the app's work is done by the following components:
+* `UI`: The UI of the App.
+* `Command`:The command executor.


Missing whitespace.

jwyk · 2025-04-02T05:23:37Z

+
+### How the architecture components interact with each other
+The _Sequence Diagram_ below shows how the components interact with each other for the scenario where the user issues 
+the command add -ingredient=tomato -quantity=5 -expiry=2025-04-03


Should enclose this command in `` tags.

jwyk · 2025-04-02T05:28:03Z

Might want to change the way how you displayed the PlantUML diagrams for public/protected/private parameters and methods to follow CS2113 convention.

yeeern27 · 2025-04-02T13:01:09Z

Consider increase the word font to increase readability

yeeern27 · 2025-04-02T13:04:35Z

+}
+
+ExpiryDate --|> DishDate
+Ingredient --|> Food


Could potentially include the multiplicity between food and ingredients to increase the clarity

yeeern27 · 2025-04-02T13:09:51Z

could potentially show how these block of commands interact with other part of the system

yeeern27 · 2025-04-02T13:12:08Z

there is a lack of the diagram to show the data flow, ie after the data is being parsed, how is it being stored/ modified. Could consider to add that in

kmnyn · 2025-04-03T04:39:50Z

+* `AddDishCommand` adds a dish to the DishCalendar.
+* `RemoveDishCommand` removes a dish from the DishCalendar.
+* `AddRecipeCommand` adds a recipe to the RecipeBank.
+* `RemoveRecipeCommand` removes a recipe from the RecipeBank.
+* `AddIngredientCommand` adds an ingredient to the IngredientStorage.
+* `RemoveIngredientCommand` removes an ingredient from the IngredientStorage.
+* `AddShoppingItemCommand` adds an item to the ShoppingList.
+* `RemoveShoppingItemCommand` removes an item from the ShoppingList.


Will it be better to elaborate on the implementation of the commands rather than briefly stating the description?

kmnyn · 2025-04-03T04:42:56Z

+The following is a UML diagram of the `commands` package:
+![Commands.png](images/Commands.png)


Detailed and well-structured UML diagram for understanding. Good job!

kmnyn · 2025-04-03T04:44:53Z

+| v2.1    | beginner meal prepper | see meal-prepping tips | improve my meal-prepping |
+| v2.1    | health conscious student | track calories of dishes | know exactly how many calories my food has |
+| v2.1    | aspiring chef | save my favourite recipes | access them easily |
+| v2.1    | user that is going to shop soon | be recommended recipes that are an item away | plan what to buy next when I'm not limited by my current ingredients |


Very detailed and developed user stories help to visualize the developing process of your project.

kmnyn · 2025-04-03T04:47:22Z

+| v2.1    | aspiring chef | save my favourite recipes | access them easily |
+| v2.1    | user that is going to shop soon | be recommended recipes that are an item away | plan what to buy next when I'm not limited by my current ingredients |
 ## Non-Functional Requirements



Maybe consider to add sequence diagram for each command you have for better visualization of your commands.

James17042002 · 2025-04-03T05:16:16Z

+Below is a Sequence Diagram of an example of how a User performs command view -month=5 to view his dishes for the month of May
+![img.png](images/sequenceView.png)
+The class diagrams of UI and Calendar printer are seen below
+![img.png](images/classUI.png)


I think there are icons used in the plantUML diagram that does not follow course guidelines.

James17042002 · 2025-04-03T05:36:46Z

+The following is the class diagram for the classes Recipe and RecipeBank.
+
+![Items.png](images/Items.png)
+


Good job creating the class diagram! But I think the link between recipeBank and recipe is a bit ambiguous, there is a "1" but also a "contains" and "many".

If recipeBank contains a recipe, I think the arrow should be the other way around.

James17042002 · 2025-04-03T05:55:21Z

+The following is the class diagram for the classes Recipe and RecipeBank.
+
+![Items.png](images/Items.png)
+


Also, maybe its better to add a * to the link between recipe and ingredient.

James17042002 · 2025-04-03T05:58:29Z

+The following is the class diagram for the classes Recipe and RecipeBank.
+
+![Items.png](images/Items.png)
+


If recipeBank contains a recipe, I think the arrow should be the other way around.

James17042002 · 2025-04-03T06:00:40Z

+The following is the class diagram for the classes Recipe and RecipeBank.
+
+![Items.png](images/Items.png)
+


The link between recipeBank and dish also has no arrow.

szeyingg · 2025-04-04T04:28:55Z

+<div style="page-break-after: always;"></div>
+
+### How the architecture components interact with each other
+The _Sequence Diagram_ below shows how the components interact with each other for the scenario where the user issues 


class diagram might be more suitable to represent overall architecture instead of a sequence diagram

szeyingg · 2025-04-04T04:30:41Z

+These classes facilitate user interaction by providing formatted output and handling command-based operations.
+
+Below is a Sequence Diagram of an example of how a User performs command view -month=5 to view his dishes for the month of May
+![img.png](images/sequenceView.png)


would be better to standardise a colour for all your diagrams for consistency

szeyingg · 2025-04-04T04:33:25Z

+This approach keeps business logic separate from UI logic, improving code maintainability and readability.
+
+<div style="page-break-after: always;"></div>
+


can consider adding a line break between each section for better readability

szeyingg · 2025-04-04T04:37:52Z

+planning their meals with their limited budget and time.
+<div style="page-break-after: always;"></div>

 ## User Stories


might want to double check the format of user stories, does not properly show up as table

szeyingg · 2025-04-04T04:42:00Z

+
+The following is the class diagram for the classes Recipe and RecipeBank.
+
+![Items.png](images/Items.png)


can relook at positioning of classes to make labels on arrows more visible

yangyi-zhu · 2025-04-04T07:23:51Z

+        printCalendarRow(year, month, secondRowFirstDate, daysInMonth, list);
+        printCalendarRow(year, month, thirdRowFirstDate, daysInMonth, list);
+        printCalendarRow(year, month, fourthRowFirstDate, daysInMonth, list);
+        printCalendarRow(year, month, fifthRowFirstDate, daysInMonth, list);
+        printCalendarRow(year, month, sixthRowFirstDate, daysInMonth, list);


This part could probably be done using a loop

yangyi-zhu · 2025-04-04T07:24:28Z

+    private boolean expiringSoon = false;
+    private boolean expired = false;


I think these can be updated based on current date automatically rather than requiring separate fields

yangyi-zhu · 2025-04-04T07:25:45Z

+        int startIndex = receivedText.indexOf(RECIPE_FLAG) + RECIPE_FLAG.length();
+        int endIndex = receivedText.indexOf(" ", startIndex);
+        if (endIndex == -1) {
+            endIndex = receivedText.length();
+        }
+
+        return receivedText.substring(startIndex, endIndex).trim();


This code was repeated several times

yangyi-zhu · 2025-04-04T07:30:22Z

+            @JsonProperty("name") String dishName,
+            @JsonProperty("date") String dishDate) {
+
+        this.dishName = dishName.toLowerCase();


Great consideration of case-sensitivity!

fixed bugs with recipe delete

recipe deletion warns if dishes scheduled

…d for ingredient. Adjusted test cases to reflect units behind ingredients

Fixed bugs regarding ingredient expiry dates. Added new Update comman…

Logger

Improved code readability Updated app version in welcome message

* 'master' of https://github.com/jxromy/tp: checkstyle start Update command # Conflicts: # docs/UserGuide.md

Updated UG table of commands

Add LoggerTest, update PPP

* 'master' of https://github.com/jxromy/tp:

* 'master' of https://github.com/jxromy/tp: Update whalesyong.md Update AboutUs.md Update AboutUs.md Update AboutUs.md fixing text ui test minor fix for logger Fix Text UI for Github CI Robustify tests for CI Add debug code for Github CI Try fixing github CI Add flushing for log tests for Github CI Fix checkstyle AGAIN resolve checkstyle err Fix Test errors for CI Fix checkstlye Add LoggerTest, update PPP Add PPP segment # Conflicts: # data/cookingaids.json

Fixed UG

Updated PPP

change aboutus links

fix error emssages for shopping list

Update parser diagram

Minor ppp update

Final PR

aditichadha1310 reviewed Mar 28, 2025

View reviewed changes

noradazaperez reviewed Apr 2, 2025

View reviewed changes

kaixiangg reviewed Apr 2, 2025

View reviewed changes

jwyk reviewed Apr 2, 2025

View reviewed changes

yeeern27 reviewed Apr 2, 2025

View reviewed changes

kmnyn reviewed Apr 3, 2025

View reviewed changes

James17042002 reviewed Apr 3, 2025

View reviewed changes

szeyingg reviewed Apr 4, 2025

View reviewed changes

yangyi-zhu reviewed Apr 4, 2025

View reviewed changes

Roma Joshi and others added 19 commits April 5, 2025 14:11

fixed bugs with recipe add and delete

5800b27

Merge pull request #164 from Roma637/master

c526d98

fixed bugs with recipe delete

recipe delete checks for dishes and confirms

2eb2009

checkstyle

a7b8edc

Merge pull request #165 from Roma637/master

5704fa8

recipe deletion warns if dishes scheduled

Fixed dish date error handling

8d5c04b

Add extra flag to list dish

4b27748

Fixed calendar month handling

774ef3f

Add basic logger functionality

b813944

Minor fix to pass CI

5b97428

Fixed bugs regarding ingredient expiry dates. Added new Update comman…

675a88e

…d for ingredient. Adjusted test cases to reflect units behind ingredients

Merge pull request #166 from nictzl/master

ff3c921

Fixed bugs regarding ingredient expiry dates. Added new Update comman…

Update EXPECTED.TXT in text ui test

ba95b5c

Merge pull request #3 from whalesyong/logger

4ad1812

Logger

Added check for existence in delete ingredient

09acec7

Improved code readability Updated app version in welcome message

Merge branch 'master' of https://github.com/jxromy/tp

98f6ef8

* 'master' of https://github.com/jxromy/tp: checkstyle start Update command # Conflicts: # docs/UserGuide.md

Added description of bye command to UG

c1c6dd8

Updated UG table of commands

Fixed expected syntax in JUnit tests

5f49101

Fixed shell script testing

c7c95ee

whalesyong and others added 30 commits April 8, 2025 12:10

Merge pull request #209 from whalesyong/master

d8456c5

Add LoggerTest, update PPP

change aboutus links

6d65cf2

Update AboutUs.md

39d17eb

Update AboutUs.md

9341372

Update AboutUs.md

cd1f15b

Update whalesyong.md

6ee920f

Fixed UG and images

9f75cc0

Merge branch 'master' of https://github.com/jxromy/tp

b685cd6

* 'master' of https://github.com/jxromy/tp:

Merge pull request #215 from jxromy/master

33a3a54

Fixed UG

Update UserGuide.md

a893870

merge from remote

8bc0478

Update UserGuide.md

aa328a8

Updated PPP

003bc79

Merge pull request #216 from jxromy/master

67d98b7

Updated PPP

added exception and fixed error messages

e44ff7a

update DG, reformat image

ec6a52f

merge upstream

0e7504f

megre from remote

f582b08

Merge pull request #213 from Roma637/master

b9a57cd

change aboutus links

Merge pull request #217 from Roycecodes/master

bb7f26d

fix error emssages for shopping list

Final update of PPP

429f244

added line to ppp

d7e8478

fixed linkst to ppp

34fb3eb

Update parser diagram

7749a28

Merge pull request #219 from jxromy/master

4a04538

Update parser diagram

Merge pull request #218 from Roycecodes/minor_ppp_update

01cb7f5

Minor ppp update

Last push for PPP

1075ced

Merge branch 'AY2425S2-CS2113-T11b-1:master' into master

cd51a77

Merge pull request #220 from jxromy/master

c57c7f6

Final PR


		#### <ins>Implementation</ins>

		* `Food` is an abstract class.

		The following is a UML diagram of the `commands` package:
		![Commands.png](images/Commands.png)

		The following is the class diagram for the classes Recipe and RecipeBank.

		![Items.png](images/Items.png)

		This approach keeps business logic separate from UI logic, improving code maintainability and readability.

		<div style="page-break-after: always;"></div>

		private boolean expiringSoon = false;
		private boolean expired = false;



		![img.png](img.png)
		### UI

Conversation

jxromy commented Mar 11, 2025

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!

noradazaperez left a comment

Choose a reason for hiding this comment

Uh oh!

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

kaixiangg commented Apr 2, 2025

Uh oh!

jwyk left a comment

Choose a reason for hiding this comment

Uh oh!

jwyk Apr 2, 2025 • 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!

jwyk Apr 2, 2025 • 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!

jwyk Apr 2, 2025 • 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!

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!

jwyk Apr 2, 2025 •

edited

Loading

jwyk Apr 2, 2025 •

edited

Loading

jwyk Apr 2, 2025 •

edited

Loading