Improve coding standard by removing magic strings.

AY2324S1-CS2113-T17-2 · Nov 9, 2023 · ea05f47 · ea05f47
1 parent b3d10e5
commit ea05f47
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 20 deletions.
diff --git a/src/main/java/seedu/cafectrl/command/ListIngredientCommand.java b/src/main/java/seedu/cafectrl/command/ListIngredientCommand.java
@@ -19,7 +19,6 @@ public class ListIngredientCommand extends Command {
     protected Ui ui;
     protected Menu menu;
 
-
     public ListIngredientCommand(int listIndex, Menu menu, Ui ui) {
         this.index = listIndex;
         this.menu = menu;

diff --git a/src/main/java/seedu/cafectrl/data/Pantry.java b/src/main/java/seedu/cafectrl/data/Pantry.java
@@ -154,16 +154,16 @@ public void calculateDishAvailability(Menu menu, Order order) {
     public int calculateMaxDishes(Dish dish, Menu menu, Order order) {
         int maxNumofDish = Integer.MAX_VALUE;
         ArrayList<Ingredient> dishIngredients = retrieveIngredientsForDish(dish.getName(), menu);
-        boolean restockHeaderDisplayed = false;
+        boolean isRestockHeaderDisplayed = false;
         int dishQty = order.getQuantity();
 
         for (Ingredient dishIngredient : dishIngredients) {
             int numOfDish = calculateMaxDishForEachIngredient(dishIngredient);
             maxNumofDish = Math.min(numOfDish, maxNumofDish);
 
-            if (!restockHeaderDisplayed && (numOfDish < dishQty)) {
+            if (!isRestockHeaderDisplayed && (numOfDish < dishQty)) {
                 ui.showToUser(Messages.RESTOCK_CORNER, Messages.RESTOCK_TITLE, Messages.RESTOCK_CORNER);
-                restockHeaderDisplayed = true;
+                isRestockHeaderDisplayed = true;
             }
 
             if (numOfDish < dishQty && !order.getIsComplete()) {

diff --git a/src/main/java/seedu/cafectrl/storage/Decoder.java b/src/main/java/seedu/cafectrl/storage/Decoder.java
@@ -129,9 +129,7 @@ public static Sales decodeSales(ArrayList<String> textLines, Menu menu) {
             boolean isComplete = "true".equals(orderData[4].trim());
             Dish dish = menu.getDishFromName(dishName);
             if(dish == null) {
-                ui.showToUser("oh no! " + dishName + " does not exist in our menu, "
-                        + "you might have tempered with the file and added in a non existing dish."
-                        , "don't worry, we will continue operations without " + dishName);
+                ui.showDecodedInvalidDish(dishName);
             } else {
                 Order orderedDish = new Order(menu.getDishFromName(dishName), quantity, totalOrderCost, isComplete);
                 //increase size of orderLists if needed

diff --git a/src/main/java/seedu/cafectrl/ui/Messages.java b/src/main/java/seedu/cafectrl/ui/Messages.java
@@ -78,5 +78,9 @@ public class Messages {
     public static final String INGREDIENTS_END_CAP = "+-------------------------------------------------------+";
     public static final String INGREDIENTS_CORNER =  "+----------------------------------------+--------------+";
     public static final String INGREDIENTS_TITLE =   "| Ingredient                             + Quantity     +";
+    /** Messages for decoder **/
+    public static final String INVALID_DISH = " does not exist in our menu. \n"
+            + "You might have tempered with the file and added in a non existing dish.\n"
+            + "Don't worry :D , we will continue operations without ";
 
 }
diff --git a/src/main/java/seedu/cafectrl/ui/Ui.java b/src/main/java/seedu/cafectrl/ui/Ui.java
@@ -261,4 +261,8 @@ public void showPreviousDay() {
     public void showNextDay() {
         showToUser(Messages.NEXT_DAY_COMMAND_MESSAGE);
     }
+
+    public void showDecodedInvalidDish(String dishName) {
+        showToUser(dishName + Messages.INVALID_DISH + dishName);
+    }
 }
diff --git a/src/test/java/seedu/cafectrl/command/AddOrderCommandTest.java b/src/test/java/seedu/cafectrl/command/AddOrderCommandTest.java
@@ -7,6 +7,7 @@
 import seedu.cafectrl.data.Pantry;
 import seedu.cafectrl.data.dish.Dish;
 import seedu.cafectrl.data.dish.Ingredient;
+import seedu.cafectrl.ui.Messages;
 import seedu.cafectrl.ui.Ui;
 
 import java.io.ByteArrayOutputStream;
@@ -56,16 +57,15 @@ public void execute_addValidOrder_expectOneOrder() {
         String actualOutput = baos.toString().trim();
         System.setOut(originalOut);
 
-        String expectedOutput = "I'm busy crafting your selected dish in the virtual kitchen of your dreams. "
-                + "Bon appétit!"
-                + "-----------------------------------------------------"
-                + "Order is ready!"
+        String expectedOutput =  Messages.CHEF_MESSAGE
+                + Messages.LINE_STRING
+                + Messages.COMPLETE_ORDER
                 + "Total order cost: $5.00"
-                + "-----------------------------------------------------"
-                + "Listed below are the availability of the dishes for the next order!"
+                + Messages.LINE_STRING
+                + Messages.AVAILABLE_DISHES
                 + "Dish: chicken rice"
                 + "Available Dishes: 8"
-                + "-----------------------------------------------------"
+                + Messages.LINE_STRING
                 + "Dish: chicken curry"
                 + "Available Dishes: 4";
 
@@ -116,14 +116,13 @@ public void execute_addInvalidOrder_expectRestockMessage() {
         String actualOutput = baos.toString().trim();
         System.setOut(originalOut);
 
-        String expectedOutput = "I'm busy crafting your selected dish in the virtual kitchen of your dreams. "
-                + "Bon appétit!"
-                + "+----------------------------------------+--------------+--------------+"
+        String expectedOutput = Messages.CHEF_MESSAGE
+                + Messages.RESTOCK_CORNER
                 + "| Restock                                | Current      | Needed       |"
-                + "+----------------------------------------+--------------+--------------+"
+                + Messages.RESTOCK_CORNER
                 + "| chicken                                | 1000g        | 2000g        |"
-                + "+----------------------------------------------------------------------+"
-                + "Please restock ingredients before preparing the order :) ";
+                + Messages.RESTOCK_END_CAP
+                + Messages.INCOMPLETE_ORDER;
 
 
         String normalizedExpected = expectedOutput.toLowerCase().replaceAll("\\s+", "").trim();