[CS2113-F11-3] PantryPal #29

H-ZhanHao · 2025-02-21T03:50:30Z

PantryPal provides NUS students a better way to manage their meals by presenting all essential information at a glance, ensuring effortless meal planning via ingredient tracking and grocery management.

Branch rchlai

sevenseasofbri

Very good job team! I think the code is well structured and follows good code quality practices for the most part. I have briefly gone over and added some comments. Let me know if you have any questions.

sevenseasofbri · 2025-03-23T10:13:25Z

src/main/java/pantrypal/general/control/Parser.java

+
+public class Parser {
+
+    public Command parse(String input) {


function is >30LOC so try to break it up into multiple functions/refactor similar portions of code into new methods.

sevenseasofbri · 2025-03-23T10:14:27Z

src/main/java/pantrypal/general/control/Parser.java

+            return new RemovePlan(index);
+        case "addRecipe":
+            return new AddRecipe();
+        case "viewRecipe": //Add error handling for empty recipe field


Avoid writing comments like they are notes to the programmer themselves.

sevenseasofbri · 2025-03-23T10:16:19Z

src/main/java/pantrypal/inventory/IngredientInventory.java

+import java.util.Map;
+import java.util.Scanner;
+
+public class IngredientInventory {


For all functions in this class, the method header comments need to be of the following form:

From java coding standard: In method header comments, the first sentence should start in the form Returns ..., Sends ..., Adds ... etc. (not Return or Returning etc.).

It is also better if you write them JavaDoc style.

sevenseasofbri · 2025-03-23T10:16:49Z

src/main/java/pantrypal/inventory/IngredientInventory.java

+        }
+    }
+
+    public static void main(String[] args) {


also a long function, consider breaking it into parts/refactoring relevant code.

sevenseasofbri · 2025-03-23T10:18:14Z

src/main/java/pantrypal/mealplan/Calendar.java

+    /*
+     *
+     * @param planIndex refers to the plan slot in a preset
+     */
+
+    /*
+    public void AddPlanToCalendar(int planIndex){
+        plans.add(planPresets.get(planIndex));
+    }
+    */
+
+    /*
+     *
+     * @param planIndex refers to the plan in this calendar
+     */
+
+    /*
+    public void RemovePlanFromCalendar(int planIndex){
+        plans.remove(planIndex);
+    }
+    */


Avoid commenting out dead code. Remove if it is not needed.

sevenseasofbri · 2025-03-23T10:18:49Z

src/main/java/pantrypal/mealplan/Calendar.java

+public class Calendar {
+    String userName;
+    int selectedPlan;
+    //ArrayList<MealPlan> plans;


Avoid commenting out dead code. Remove if it is not needed.

sevenseasofbri · 2025-03-23T10:19:31Z

src/main/java/pantrypal/recipe/Instruction.java

+
+    @Override
+    public boolean equals(Object obj) {
+        //Return True if 2 object has the same step number


Suggested change

//Return True if 2 object has the same step number

// Return True if 2 object has the same step number

sevenseasofbri · 2025-03-23T10:20:02Z

src/main/java/pantrypal/recipe/RecipeManager.java

+
+    public void editRecipe(String command) {
+
+        // Splitting into parts


Redundant comment, i think it is already clear from the code.

sevenseasofbri · 2025-03-23T10:21:05Z

src/main/java/pantrypal/shoppinglist/AutoGenerationLogic.java

+
+        for (Map.Entry<String, Double> entry : alerts.entrySet()) {
+            String ingredientName = entry.getKey();
+            double threshold = entry.getValue();
+
+            // Retrieve the ingredient details from the inventory
+            Ingredient ingredient = ingredients.get(ingredientName);
+            if (ingredient != null && ingredient.getQuantity() < threshold) {
+                double required = threshold - ingredient.getQuantity();
+
+                // Update existing item if present; if not, add a new item.
+                boolean updated = shoppingList.updateItem(ingredientName, required, ingredient.getUnit());
+                if (!updated) {
+                    shoppingList.addItem(new ShoppingListItem(ingredientName, required, ingredient.getUnit()));
+                }


3-levels of indentation, consider refactoring internal levels .

sevenseasofbri · 2025-03-23T10:21:31Z

src/main/java/pantrypal/shoppinglist/ShoppingList.java

+import java.util.ArrayList;
+import java.util.List;
+
+public class ShoppingList {


Similarly for this class,

In method header comments, the first sentence should start in the form Returns ..., Sends ..., Adds ... etc. (not Return or Returning etc.)

ashleyang2001 · 2025-04-02T03:20:30Z

docs/DeveloperGuide.md

+
+4. **Error Handling**: The Parser feature includes error handling to manage invalid input and provide feedback to the user. If the input cannot be parsed or if the command is not recognized, an appropriate error message is displayed.
+
+# Sequence Diagram


Entity should have a : beside its name

ashleyang2001 · 2025-04-02T03:37:05Z

docs/DeveloperGuide.md

+- **Unit Management**: Ensures valid unit selection and provides functionality for unit conversion.
+
+
+## Ingredient Inventory Feature


Each class section should follow the same format/structure

ashleyang2001 · 2025-04-02T03:39:25Z

docs/DeveloperGuide.md

+- **Deleting Ingredients**: Users can remove ingredients from the inventory, ensuring accurate stock representation.
+- **Low-Stock Alerts**: The system supports configurable alerts to notify users when ingredients are running low.
+
+### Sequence Diagram


Font size should be consistent too. Nevertheless, good details overall! Covers dependencies and core functionalities

ashleyang2001

Good job, this is an awesome first draft!

Gavalion · 2025-04-02T03:54:56Z

docs/DeveloperGuide.md

+The Parser feature is designed to be modular and extensible, allowing for easy addition of new commands and functionalities. The core components of the Parser feature include:
+1. **Command Classes**: Each command is represented by a separate class, which encapsulates the logic and parameters associated with that command. This design allows for clear separation of concerns and makes it easy to add new commands in the future.
+
+2. **Parser Class**: The `Parser` class is responsible for parsing the user input and instantiating the appropriate command class. It uses a series of `switch` statements to determine the type of command based on the input string.


it's better to explain how parser works based on the input

Gavalion · 2025-04-02T03:57:38Z

docs/DeveloperGuide.md

+### Sequence Diagram
+The following sequence diagram illustrates the interaction between the user, the Ingredient Inventory, and the
+Ingredient feature during ingredient management:
+


It is better to explain how each command interact with other classes

jyukuan

Good job but still can be improved

jyukuan · 2025-04-03T03:32:44Z

docs/DeveloperGuide.md

+3. **Command Execution**: Once the command is parsed and instantiated, it is executed by calling the `execute` method on the command object. This method contains the logic for performing the action associated with the command.
+
+4. **Error Handling**: The Parser feature includes error handling to manage invalid input and provide feedback to the user. If the input cannot be parsed or if the command is not recognized, an appropriate error message is displayed.
+


It is better to add some sample code.

jyukuan · 2025-04-03T03:37:21Z

docs/DeveloperGuide.md

+## Sequence Diagram
+The following sequence diagram illustrates the interaction between the user, the Ingredient Inventory, and the
+Ingredient feature during ingredient management:
+


It is better to make the larger difference between all the feature titles, for now it is hard to read.

jyukuan · 2025-04-03T03:46:50Z

docs/DeveloperGuide.md

+The following sequence diagram illustrates the interaction between the user, the `Parser`, and the `Command` classes during the execution of a command:
+
+<img src="img_1.png" alt="drawing" style="width:900px;"/>
+


For this diagram, here is no return 'dot' line and activation bar

jyukuan · 2025-04-03T03:52:42Z

docs/DeveloperGuide.md

+The following sequence diagram illustrates the interaction between the `Storage` class and the other key lists in the application during the loading and saving of data:
+The key lists include: `StockList`, `LowStockList`, `RecipeList`, `ShoppingList`
+<img src="img_3.png" alt="drawing" style="width:1000px;"/>
+


For the sequence diagram, the return 'dot' line is necessary, and it is better to regular the input format.

xmtan1

Other than the long lines of text, I think this DG was quite comprehensive!

xmtan1 · 2025-04-03T03:37:27Z

docs/DeveloperGuide.md

+
+# Class Diagram
+<img src="img_2.png" alt="drawing" style="width:1500px;"/>
+


For the class diagram, I think it would be best to omit the names of the parameters in the class methods as the class diagram is currently quite small and hard to read..

e.g. +task(String name, Ingredient ingredient) --> +task(String, Ingredient)

xmtan1 · 2025-04-03T03:38:16Z

docs/DeveloperGuide.md

 ## Instructions for manual testing

 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+


Maybe add a short description of what your program does?

xmtan1 · 2025-04-03T03:53:44Z

docs/DeveloperGuide.md

+- **Add Plan**: Instantiates a new Meal Plan instance with a name optionally keyed by the user
+- **Remove Plan**: Removes a plan from the currently created preset
+- **Add recipe to plan**: Facilitates the procedure of adding a recipe to the indicated meal plan as decided by the user
+- **Remove recipe from plan**: Facilitates the procedure of removing a recipe from the indicated meal plan as decided by the user


Would it be possible to add a diagram here to break up the long lines of text? For example for each feature I think it would be better to add a diagram for the core functionalities with boxes and arrows. Description of each functionality is self explanatory from the name and doesn't need to be explicity listed in my opinion.

xmtan1 · 2025-04-03T03:56:56Z

docs/DeveloperGuide.md

+The following sequence diagram illustrates the interaction between the user, the Ingredient Inventory, and the
+Ingredient feature during ingredient management:
+
+<img src="img_4.png" alt="drawing" style="width:500px;"/>


For each method call, I think it would be good to add a dotted arrow back to caller class if the method returns something

lys2333 · 2025-04-03T03:32:47Z

docs/DeveloperGuide.md

+The Storage feature is designed to be modular and extensible, allowing for easy addition of new data types and functionalities. The core components of the Storage feature include:
+1. **Storage Class**: The `Storage` class is responsible for managing the reading and writing of data to and from `data.txt`. It provides methods for loading data from the file and saving data back to the file.
+2. **Data Classes**: The Storage feature interacts with various data classes, such as `IngredientInventory`, `ShoppingList`, `RecipeManager`, and `PlanPresets`. Each of these classes represents a specific type of data list and provides methods for manipulating that list.
+3. **File Handling**: The Storage feature uses file handling techniques to read and write data to `data.txt`. It ensures that the data is formatted correctly and that any errors during file operations are handled gracefully.


Could provide some explanation or example of error handling (e.g. throwing exception)?

lys2333 · 2025-04-03T03:37:12Z

docs/DeveloperGuide.md

+The Command classes are designed to be modular and expandable, allowing for easy addition of new commands and functionalities.
+The core components of the Command classes include:
+1. **Command Classes**: Each command is represented by a separate class, which encapsulates the logic and parameters associated with that command. This design allows for clear separation of concerns and makes it easy to add new commands in the future.
+2. **Command Types**: Each command inherits from a specific command type, which is used to identify the command's functionality group. This allows for better organization and management of commands within the application.


Maybe the guide could clarify what these command types are (e.g. abstract classes/interfaces)? A brief list or example might help.

lys2333 · 2025-04-03T03:48:18Z

docs/img_1.png

Should the lifelines of the command objects (RecipeCommand, MealPlanCommand, etc.) continue after execute(...) to show that the object might still exist or interact with other components later?

lys2333 · 2025-04-03T04:06:54Z

docs/img_1.png

Should there be return arrows from the execute(...) methods back to the Parser or User lifelines? It might help show what kind of response or result is returned after command execution.

Add JUnit tests for Recipe, add Recipe section for User Guide

…into branch-enhancements

Add admin's tp requirements

Branch enhancements

Add defensiveness to commands

MealPlan commands naming refresh

* commit '9925f1542e215247092bce50aca65f469a2d46de': Rename function removePlanFromList to align with matching user input Fix: Gradle Coding Style Issues Add JavaDoc to Parser, Storage, UI Fix EXPECTED.txt Update for EXPECTED.txt Add JUnit Tests Update PantryPal.java: Main class is more OOP Add to commit for upstream pull Add on merge fixes Add bugfix attempts

Added Product Description in TP ReadME

Sequence diagram addition for MealPlan

Bug Fix: Add Meat into category Storage Bug Fix: Add exception handling for illegal arguments

Update UG: Add Meal Plan Commands

Update UG: update command summary and added missing findplan command

DG Update

Update PPP

added captions for meal plan sequence diagram to provide context

Update DeveloperGuide.md

Update PPP

update PPP

nus-se-bot closed this Feb 21, 2025

damithc reopened this Feb 21, 2025

nus-cs2113-AY2425S2 deleted a comment from nus-se-bot Feb 21, 2025

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

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

f93a344

Branch rchlai

sevenseasofbri reviewed Mar 23, 2025

View reviewed changes

ashleyang2001 reviewed Apr 2, 2025

View reviewed changes

Gavalion reviewed Apr 2, 2025

View reviewed changes

jyukuan reviewed Apr 3, 2025

View reviewed changes

xmtan1 reviewed Apr 3, 2025

View reviewed changes

lys2333 reviewed Apr 3, 2025

View reviewed changes

minhbgn and others added 17 commits April 4, 2025 01:14

Fix more bugs

813ca53

Handle bugs arising due to new feature

daf38b1

Fix OS-dependent error

52610b1

Update UserGuide.md

e6f8211

Merge pull request #148 from minhbgn/master

2252b1b

Add JUnit tests for Recipe, add Recipe section for User Guide

Rectify UnitList and convertIngredients functionalities

38dd125

Add Ingredient modifications

ddd9617

Add admin's tp requirements

2bb7f93

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

ca1c06d

…into branch-enhancements

Add checkstyle modifications

a9c76e7

Add PPP documents and assert statements

c6113dc

Add admin's tp requirements

Merge pull request #142 from srfl0/branch-enhancements

9c267f8

Branch enhancements

Add Minh into About us.md

83dc8f5

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

72a1668

Add defensiveness to commands

0da958e

Merge pull request #150 from srfl0/branch-enhancements

723855f

Add defensiveness to commands

Fixed bug in convert ingredient method

c8bd6e2

srfl0 and others added 30 commits April 8, 2025 04:48

Merge pull request #297 from srfl0/branch-v2.1

9925f15

MealPlan commands naming refresh

Add Product Description on TP

cdf5b56

Merge pull request #298 from yok2086/neww

33496e1

Added Product Description in TP ReadME

Add sequence diagrams for MealPlan

ace8108

Merge branch 'master' into branch-v2.1

ff29830

Merge pull request #299 from srfl0/branch-v2.1

1e9f3c1

Sequence diagram addition for MealPlan

Update UG: Add Meal Plan Commands

2520d01

Bug Fix: Add Meat into category Storage Bug Fix: Add exception handling for illegal arguments

Update h-zhanhao.md

cd006ad

Merge pull request #300 from H-ZhanHao/zhan-v2.1

20f56e2

Update UG: Add Meal Plan Commands

Update UG: update command summary and added missing findplan command

90dfa86

Update README.md

091ec31

Merge pull request #301 from H-ZhanHao/zhan-v2.1

c5160fb

Update UG: update command summary and added missing findplan command

Update UserGuide.md

d336905

Update h-zhanhao.md

d81b10c

Update DG

0204656

Merge branch 'master' into branch-v2.1

ac742d9

Update PPP

ae35f7e

Merge pull request #302 from srfl0/branch-v2.1

b255486

DG Update

Merge pull request #303 from kemilii/PPP-2

ba839e7

Update PPP

Update DeveloperGuide.md

c0c78de

Update DeveloperGuide.md

90daa64

Update DeveloperGuide.md

a544821

added captions for meal plan sequence diagram to provide context

Merge pull request #304 from AY2425S2-CS2113-F11-3/srfl0-patch-1

315b95a

Update DeveloperGuide.md

Update PPP

daeef20

Merge pull request #305 from kemilii/PPP-2

924c7ee

Update PPP

Update PPP

5335c3f

Merge pull request #306 from kemilii/PPP-2

1671aa5

Update PPP

update PPP

6332d24

Merge pull request #307 from srfl0/branch-v2.1

1fb12f1

update PPP

	//Return True if 2 object has the same step number
	// Return True if 2 object has the same step number


		public void editRecipe(String command) {

		// Splitting into parts


		4. Error Handling: The Parser feature includes error handling to manage invalid input and provide feedback to the user. If the input cannot be parsed or if the command is not recognized, an appropriate error message is displayed.

		# Sequence Diagram

		- Unit Management: Ensures valid unit selection and provides functionality for unit conversion.


		## Ingredient Inventory Feature

		3. Command Execution: Once the command is parsed and instantiated, it is executed by calling the `execute` method on the command object. This method contains the logic for performing the action associated with the command.

		4. Error Handling: The Parser feature includes error handling to manage invalid input and provide feedback to the user. If the input cannot be parsed or if the command is not recognized, an appropriate error message is displayed.

		The following sequence diagram illustrates the interaction between the user, the `Parser`, and the `Command` classes during the execution of a command:

		<img src="img_1.png" alt="drawing" style="width:900px;"/>


		# Class Diagram
		<img src="img_2.png" alt="drawing" style="width:1500px;"/>

		## Instructions for manual testing

		{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}

[CS2113-F11-3] PantryPal #29

Are you sure you want to change the base?

[CS2113-F11-3] PantryPal #29

Uh oh!

Conversation

H-ZhanHao commented Feb 21, 2025

Uh oh!

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

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

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

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!