[CS2113-T13-1] KitchenCTRL #63

Carlton369 · 2025-03-06T05:07:50Z

No description provided.

yijiano

Good effort so far, but please improve on your standardisation, as well as clean up your code.

yijiano · 2025-03-22T08:27:23Z

src/main/java/logic/commands/Commands.java

+package logic.commands;
+
+import model.Ingredient;
+import model.Recipe;
+import java.util.ArrayList;
+import model.catalogue.IngredientCatalogue;
+
+public class Commands {
+
+    // Add ingredient to inventory
+    public static void addIngredient(IngredientCatalogue inventory, String name, int quantity) {
+        for (Ingredient ing : inventory.getItems()) {
+            if (ing.getIngredientName().equalsIgnoreCase(name)) {
+                ing.setQuantity(ing.getQuantity() + quantity);
+                return;
+            }
+        }
+        inventory.addItem(new Ingredient(name, quantity));
+    }
+
+    // Edit ingredient quantity
+    public void editIngredient(IngredientCatalogue inventory,String name, int newQuantity) {
+        for (Ingredient ing : inventory.getItems()) {
+            if (ing.getIngredientName().equalsIgnoreCase(name)) {
+                ing.setQuantity(newQuantity);
+                return;
+            }
+        }
+    }
+
+    // List all ingredients in inventory
+    public void listIngredients(IngredientCatalogue inventory) {
+        for (Ingredient ing : inventory.getItems()) {
+            System.out.println(ing.getIngredientName() + ": " + ing.getQuantity());
+        }
+    }
+
+    // Delete an ingredient from inventory
+    public void deleteIngredient(IngredientCatalogue inventory, Ingredient ingredientToDelete) {
+        inventory.deleteItem(ingredientToDelete);
+    }
+
+    /*
+    * Checks if there are enough ingredients in inventory to cook recipe
+    *
+    * @paramin recipe
+    * @paramout arraylist of missing ingredients and quantity
+     */
+    public static ArrayList<Ingredient> getMissingIngredients(IngredientCatalogue inventory, Recipe targetRecipe) {
+        ArrayList<Ingredient> missingIngredients = new ArrayList<>();
+        ArrayList<Ingredient> inventoryItems = inventory.getItems();
+        ArrayList<Ingredient> targetRecipeIngredients = targetRecipe.getItems();
+
+        for (Ingredient requiredIngredient : targetRecipeIngredients) {
+            if (!inventoryItems.contains(requiredIngredient)) {
+                missingIngredients.add(requiredIngredient);
+            } else {
+                int index = inventoryItems.indexOf(requiredIngredient);
+                Ingredient availableIngredient = inventoryItems.get(index);
+                if (availableIngredient.getQuantity() < requiredIngredient.getQuantity()) {
+                    int shortage = requiredIngredient.getQuantity() - availableIngredient.getQuantity();
+                    missingIngredients.add(new Ingredient(requiredIngredient.getIngredientName(), shortage));
+                }
+            }
+        }
+        return missingIngredients;
+    }
+
+    public static void cookRecipe(IngredientCatalogue inventory, Recipe recipeToCook) {
+        ArrayList<Ingredient> missingIngredients = getMissingIngredients(inventory, recipeToCook);
+        if (!missingIngredients.isEmpty()) {
+            return;
+        }
+
+        ArrayList<Ingredient> inventoryItems = inventory.getItems();
+        ArrayList<Ingredient> ingredientsToCook = recipeToCook.getItems();
+
+        for (Ingredient requiredIngredient : ingredientsToCook) {
+            int index = inventoryItems.indexOf(requiredIngredient);
+            Ingredient ingredientInInventory = inventoryItems.get(index);
+            ingredientInInventory.subtractQuantity(requiredIngredient.getQuantity());
+        }
+
+    }
+}


Is this even being used? If not, please remove this.

yijiano · 2025-03-22T08:28:34Z

src/main/java/KitchenCTRL.java

+    private Ui ui;
+
+    /**
+     * Main entry-point for the java.duke.Duke application.


Please update this comment

yijiano · 2025-03-22T08:29:42Z

src/main/java/KitchenCTRL.java

+
+    private void exit() {
+        ui.showGoodbyeMessage();
+        System.exit(0);


I doubt this is needed, you can just allow the app to close gracefully.

yijiano · 2025-03-22T08:30:37Z

src/main/java/KitchenCTRL.java

+    public static void carltonTest() {
+        IngredientCatalogue inventory = new IngredientCatalogue();
+        inventory.addItem(new Ingredient("White sugar", 50));
+        inventory.addItem(new Ingredient("Egg", 3));
+        inventory.addItem(new Ingredient("Flour", 50));
+
+        Recipe recipe = new Recipe();
+        recipe.addItem(new Ingredient("White sugar", 20));
+        recipe.addItem(new Ingredient("Egg", 1));
+        recipe.addItem(new Ingredient("Flour", 10));
+
+
+        System.out.println(recipe);
+        System.out.println("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
+        System.out.println("PRINTING MISSING");
+        Commands.cookRecipe(inventory, recipe);
+        inventory.listItems();
+    }
+}


This could have been refactored as a JUnit test instead.

yijiano · 2025-03-22T08:31:50Z

src/main/java/ui/inputparser/Parser.java

+
+public class Parser {
+    public Command parseCommand(String userInput) {
+        String[] commands = userInput.split(" ", 2);


While it is still readable, maybe change the name from commands to something less ambiguous here.

yijiano · 2025-03-22T08:38:10Z

src/main/java/storage/CatalogueContentManager.java

+                return Files.readAllLines(filePath);
+            }
+        } catch (Exception e) {
+            System.err.println("Error loading file: " + e.getMessage());


Consider implementing logging for these error cases.

yijiano · 2025-03-22T08:40:32Z

src/main/java/model/Recipe.java

+    @Override
+    public CommandResult addItem(Ingredient ingredient) {
+        items.add(ingredient);
+        return null;


Maybe you can print an empty CommandResult instead of just null?

yijiano · 2025-03-22T08:42:21Z

src/main/java/commands/Command.java

+    public Command(String args) {
+
+    }
+
+    public Command() {
+
+    }


Is there a difference between these two constructors?

yijiano · 2025-03-22T08:45:01Z

src/main/java/commands/Command.java

+    public CommandResult execute() { // Ensure this method exists
+        return null;
+    }
+
+    public CommandResult execute(IngredientCatalogue inventory) {
+        throw new UnsupportedOperationException("override me");
+    }
+}


Since the intention is to override this method, perhaps this can be an abstract method.

yijiano · 2025-03-22T08:50:40Z

src/main/java/commands/AddIngredientCommand.java

+        assert name != null && !name.trim().isEmpty() : "Ingredient name must not be null or empty";
+        assert quantity > 0 : "Ingredient quantity must be greater than zero";


Please implement proper guard clauses instead of just using assertions.

This applies to most of the command classes.

Branch rchlai

yijiano

Good effort, keep up the good work. Also, thanks for reading my previosu review and making the necessary changes.

yijiano · 2025-04-01T12:10:21Z

src/main/java/model/catalogue/Inventory.java

+        String[] keywordList = ingredientName.toLowerCase().split(" ");
+
+        return items.stream()
+                .filter(currIngredient -> {


Consider using other stream operations such as findFirst which would be more clear.

yijiano · 2025-04-01T12:18:49Z

src/main/java/model/catalogue/Inventory.java

+        // Create the calculation message
+        String calculations = existingIngredient.getIngredientName() + ": " +
+                "Initial quantity = " + initialQuantity + ", " +
+                "Subtracted = " + decreaseQuantity + ", " +
+                "Remaining = " + existingIngredient.getQuantity();


Maybe there is a way to refactor this so that it can be a method/class of its own?

yijiano · 2025-04-01T12:30:44Z

src/main/java/ui/inputparser/InputParser.java

+        for (int i = 0; i < similarRecipe.size(); i++) {
+            System.out.println("Type '" + (i + 1) + "' to delete: " + similarRecipe.get(i).getRecipeName());
+        }
+        System.out.println("Type '-1' to cancel this action.");


Maybe this check can be abstracted out? Especially since this check has been used several times.

yijiano · 2025-04-01T12:32:39Z

src/main/java/ui/inputparser/Parser.java

+        case INVENTORY, RECIPE -> {
+            // Expecting: add <ingredientName> <quantity>
+            String[] parts = args.split(" ", 2);
+            if (parts.length < 2) {
+                throw new IllegalArgumentException("Invalid format! Usage: add <name> <quantity>");
+            }
+
+            String name = parts[0].trim();
+            int quantity;
+            try {
+                quantity = Integer.parseInt(parts[1].trim());
+            } catch (NumberFormatException e) {
+                throw new IllegalArgumentException("Quantity must be a valid integer!");
+            }


Maybe abstract this out so that this method is not so complex. Also, try to follow the switch statement as stated in the code style.

yijiano · 2025-04-01T12:34:30Z

src/main/java/commands/AddCommand.java

+    public AddCommand(String name, int quantity) {
+        assert name != null && !name.trim().isEmpty() : "Name must not be null or empty";
+
+        assert screen == RECIPEBOOK || quantity > 0 : "Quantity must be greater than zero";
+
+        this.name = name;
+        this.quantity = quantity;
+    }
+
+    public AddCommand(String name) {
+        assert name != null && !name.trim().isEmpty() : "Name must not be null or empty";
+
+        this.name = name;
+        this.quantity = 0; // irrelevant for recipebook screen
+    }


Maybe use try-catch rather than just assert to catch malformed inputs.

yijiano · 2025-04-01T12:38:13Z

src/main/java/model/catalogue/RecipeBook.java

+        return items.stream()
+                .filter(currRecipe -> {
+                    String name = getRecipeNameLowercase(currRecipe);
+                    return Arrays.stream(keywordList).allMatch(name::contains);
+                })
+                .collect(Collectors.toCollection(ArrayList::new));


The stream operation findFirst might do well here

yijiano · 2025-04-01T12:38:57Z

src/main/java/model/catalogue/RecipeBook.java

+        if (choice == 0) {
+            addRecipe(recipe);
+            return new CommandResult(recipe.getRecipeName() + " added to recipe book.");
+        }


This if block can be merged with the above.

yijiano · 2025-04-01T12:39:51Z

src/main/java/model/catalogue/RecipeBook.java

+            return new CommandResult(recipe.getRecipeName() + " does not exist in the recipe book.");
+        }
+
+        if (similarRecipe.size() == SINGLE_MATCH && isExactMatchFound(similarRecipe.get(FIRST_ITEM_INDEX), recipe)) {


The if blocks can be combined, and if needed abstract out the condition to its own method/boolean variable.

yijiano · 2025-04-01T12:44:25Z

src/main/java/model/catalogue/Catalogue.java

+     */
+    public void updateItem(T oldItem, T newItem) {
+        int index = items.indexOf(oldItem);
+        if (index != -1) {


Maybe you can re-use your AddItem method?

yijiano · 2025-04-01T12:48:58Z

src/main/java/commands/CookRecipeCommand.java

+        for (Ingredient requiredIngredient : recipeIngredients) {
+            if (!inventoryItems.contains(requiredIngredient)) {
+                missingIngredients.add(requiredIngredient);
+            } else {
+                int index = inventoryItems.indexOf(requiredIngredient);
+                Ingredient availableIngredient = inventoryItems.get(index);
+                if (availableIngredient.getQuantity() < requiredIngredient.getQuantity()) {
+                    int shortage = requiredIngredient.getQuantity() - availableIngredient.getQuantity();
+                    missingIngredients.add(new Ingredient(requiredIngredient.getIngredientName(), shortage));
+                }
+            }
+        }


Maybe make this method simpler (abstract out the steps/conditions)?

sxkhoo · 2025-04-02T05:32:09Z

docs/diagrams/recipebook.png

The class logo is wrong, should be : instead.

sxkhoo · 2025-04-02T05:39:26Z

docs/DeveloperGuide.md

-|v1.0| user      |enter commands into the system| interact with it and perform necessary actions efficiently       |
-|v1.0| user      |save and retrieve data| have accessible and up-to-date information                       |
-|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 ...                                                |


Could add a column for priority, overall looks good!

sxkhoo · 2025-04-02T05:47:27Z

docs/DeveloperGuide.md

@@ -11,7 +11,7 @@ KitchenCTRL uses the following tools for development:
 The design and implementation of KitchenCTRL has been broken down into various sections


Looks good!

sxkhoo · 2025-04-02T05:51:34Z

docs/DeveloperGuide.md

+The commands package provides a structured way to define and execute operations in the application. By inheriting from the Command class, each command ensures consistency and adheres to the application's design principles. The CookRecipeCommand is a concrete example of how commands are implemented to perform specific tasks.
+
 ### Model Component
 ![Model UML diagram](diagrams/model.png)


The class logo seems to be incorrect.

IgoyAI

Please check the UML Diagram. Overall good already.

IgoyAI · 2025-04-03T03:14:04Z

docs/diagrams/logic.png