Merge pull request #351 from ziyi105/general-coding-standard-check

General coding standard check

src/main/java/seedu/cafectrl/CafeCtrl.java

@@ -23,26 +23,25 @@
  */
 public class CafeCtrl {
 
-    private static Logger logger = Logger.getLogger(CafeCtrl.class.getName());
+    private static final Logger logger = Logger.getLogger(CafeCtrl.class.getName());
     private final Ui ui;
-    private Menu menu;
+    private final Storage storage;
+    private final Pantry pantry;
+    private final Menu menu;
+    private final Sales sales;
+    private final CurrentDate currentDate;
+
     private Command command;
-    private Pantry pantry;
-    private Sales sales;
-    private CurrentDate currentDate;
-    private Storage storage;
 
     /**
      * Private constructor for the CafeCtrl class, used for initializing the user interface and menu list.
      */
-
     private CafeCtrl() {
         initLogger();
         this.ui = new Ui();
         this.storage = new Storage(this.ui);
-        this.sales = new Sales();
-        this.menu = this.storage.loadMenu();
         this.pantry = this.storage.loadPantryStock();
+        this.menu = this.storage.loadMenu();
         this.sales = this.storage.loadOrderList(menu);
         this.currentDate = new CurrentDate(sales);
 
@@ -59,6 +58,7 @@ private CafeCtrl() {
     private void run() {
         ui.showWelcome();
         ui.printLine();
+
         do {
             try {
                 String fullUserInput = ui.receiveUserInput();
@@ -82,8 +82,9 @@ private void initLogger() {
         logger.setUseParentHandlers(false);
         try {
             FileHandler fileHandler = new FileHandler("cafeCtrl.log");
-            logger.addHandler(fileHandler);
             SimpleFormatter formatter = new SimpleFormatter();
+
+            logger.addHandler(fileHandler);
             fileHandler.setFormatter(formatter);
         } catch (IOException e) {
             e.printStackTrace();
@@ -94,6 +95,4 @@ public static void main(String[] args) {
         CafeCtrl cafeCtrl = new CafeCtrl();
         cafeCtrl.run();
     }
-
 }
-

src/main/java/seedu/cafectrl/command/EditPriceCommand.java

@@ -18,7 +18,7 @@ public class EditPriceCommand extends Command {
             + "edit_price dish/DISH_INDEX price/NEW_PRICE\n"
             + "Example: edit_price dish/1 price/4.50";
 
-    private static Logger logger = Logger.getLogger(CafeCtrl.class.getName());
+    private static final Logger logger = Logger.getLogger(CafeCtrl.class.getName());
     protected Menu menu;
     protected Ui ui;
     private final int menuID;

src/main/java/seedu/cafectrl/command/HelpCommand.java

@@ -11,10 +11,9 @@
  */
 public class HelpCommand extends Command {
     public static final String COMMAND_WORD = "help";
-    public static final String MESSAGE_USAGE = "To view all commands:\n"
-            + COMMAND_WORD;
+    public static final String MESSAGE_USAGE = "To view all commands:\n" + COMMAND_WORD;
 
-    private static Logger logger = Logger.getLogger(CafeCtrl.class.getName());
+    private static final Logger logger = Logger.getLogger(CafeCtrl.class.getName());
     protected Ui ui;
 
 
@@ -28,6 +27,7 @@ public HelpCommand(Ui ui) {
     @Override
     public void execute() {
         logger.info("Executing HelpCommand...");
+
         ui.printLine();
         ui.showHelp();
     }

src/main/java/seedu/cafectrl/data/Chef.java

@@ -3,19 +3,15 @@
 import seedu.cafectrl.CafeCtrl;
 import seedu.cafectrl.ui.Ui;
 
-import java.text.DecimalFormat;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
 
 public class Chef {
-    private static Logger logger = Logger.getLogger(CafeCtrl.class.getName());
+    private static final Logger logger = Logger.getLogger(CafeCtrl.class.getName());
     private final Order order;
     private final Pantry pantry;
     private final Ui ui;
-    private Menu menu;
-    private final DecimalFormat dollarValue = new DecimalFormat("0.00");
-
 
     public Chef(Order order, Pantry pantry, Ui ui) {
         this.order = order;
@@ -28,9 +24,11 @@ public void cookDish() {
         try {
             if (!order.getIsComplete()) {
                 ui.showChefMessage();
+
                 boolean isComplete = pantry.isDishCooked(order.getIngredientList());
-                logger.info("Dish cooked: " + isComplete);
                 order.setComplete(isComplete);
+
+                logger.info("Dish cooked: " + isComplete);
             }
         } catch (Exception e) {
             logger.log(Level.WARNING, "Unsuccessful order: " + e.getMessage(), e);

src/main/java/seedu/cafectrl/data/CurrentDate.java

@@ -3,24 +3,28 @@
 import java.util.ArrayList;
 
 public class CurrentDate {
+    private static final int MIN_ORDER_LIST_SIZE = 0;
+    private static final int DAY_BASE_NUMBER = 0;
+    private static final int DAY_OFFSET = 1;
+    private static final int ORDER_LIST_SIZE_OFFSET = 1;
     private int currentDay;
 
     public CurrentDate() {
-        currentDay = 0;
+        currentDay = DAY_BASE_NUMBER;
     }
     public CurrentDate(int day) {
-        currentDay = day - 1;
+        currentDay = day - DAY_OFFSET;
     }
     public CurrentDate(Sales sales) {
         setDate(sales);
     }
 
     public void nextDay() {
-        currentDay += 1;
+        currentDay += DAY_OFFSET;
     }
 
     public void previousDay() {
-        currentDay -= 1;
+        currentDay -= DAY_OFFSET;
     }
 
     public int getCurrentDay() {
@@ -30,15 +34,16 @@ public int getCurrentDay() {
     /**
      * Sets the current date to the latest date the user left off
      *
-     * @param sales Used to access the number of orderlist created
+     * @param sales Used to access the number of order list created
      */
     public void setDate(Sales sales) {
         ArrayList<OrderList> orderLists = sales.getOrderLists();
         int orderListsSize = orderLists.size();
-        if (orderListsSize > 0) {
-            currentDay = orderListsSize - 1;
+
+        if (orderListsSize > MIN_ORDER_LIST_SIZE) {
+            currentDay = orderListsSize - ORDER_LIST_SIZE_OFFSET;
         } else {
-            currentDay = 0;
+            currentDay = DAY_BASE_NUMBER;
         }
     }
 }

src/main/java/seedu/cafectrl/data/Menu.java

@@ -8,7 +8,7 @@
 import java.util.logging.Logger;
 
 public class Menu {
-    private static Logger logger = Logger.getLogger(CafeCtrl.class.getName());
+    private static final Logger logger = Logger.getLogger(CafeCtrl.class.getName());
     private ArrayList<Dish> menuItems;
 
     public Menu() {
@@ -22,9 +22,11 @@ public Menu(ArrayList<Dish> menuItems) {
     public ArrayList<Dish> getMenuItemsList() {
         return menuItems;
     }
+
     public int getSize() {
         return menuItems.size();
     }
+
     public Dish getDishFromId(int menuID) {
         return menuItems.get(menuID);
     }
@@ -40,24 +42,13 @@ public Dish getDishFromName(String dishName) {
         for (int i = 0; i < getSize(); i++) {
             String menuDishName = getDishFromId(i).getName();
             String formattedMenuDishName = menuDishName.toLowerCase().trim();
+
             if (formattedMenuDishName.equals(formattedDishName)){
                 return getDishFromId(i);
             }
         }
         return null;
     }
-    public void removeDish(int menuID) {
-        menuItems.remove(menuID);
-    }
-    public void addDish(Dish dish) {
-        menuItems.add(dish);
-    }
-
-    public boolean isValidDishIndex(int dishIndex) {
-        logger.info("Checking if dish index " + dishIndex + " is valid...");
-        int offSetDishIndex = dishIndex - Ui.OFFSET_LIST_INDEX;
-        return offSetDishIndex >= 0 && offSetDishIndex < this.getSize();
-    }
 
     //@@author NaychiMin
     /**
@@ -76,4 +67,26 @@ public ArrayList<Order> getAggregatedOrders() {
         }
         return aggregatedOrders;
     }
+
+    //@@author ziyi105
+    /**
+     * Checks whether the dish index can be found in the menu
+     *
+     * @param dishIndex dish index to be checked
+     * @return true if it is valid, false otherwise
+     */
+    public boolean isValidDishIndex(int dishIndex) {
+        logger.info("Checking if dish index " + dishIndex + " is valid...");
+
+        int offSetDishIndex = dishIndex - Ui.OFFSET_LIST_INDEX;
+        return offSetDishIndex >= 0 && offSetDishIndex < this.getSize();
+    }
+
+    //@@author DextheChik3n
+    public void removeDish(int menuID) {
+        menuItems.remove(menuID);
+    }
+    public void addDish(Dish dish) {
+        menuItems.add(dish);
+    }
 }

src/main/java/seedu/cafectrl/data/Order.java

@@ -11,19 +11,19 @@ public class Order {
     private final Dish orderedDish;
     private int dishQty;
     private final ArrayList<Ingredient> ingredientList;
-    private boolean isComplete = false;
     private float totalOrderCost;
+    private boolean isComplete = false;
 
     public Order(Dish orderedDish, int dishQty) {
-        this.dishQty = dishQty;
         this.orderedDish = orderedDish;
+        this.dishQty = dishQty;
         this.ingredientList = setIngredientList();
         this.totalOrderCost = calculateTotalOrderCost();
     }
 
     public Order(Dish orderedDish, int dishQty, float orderCost, boolean isComplete) {
-        this.dishQty = dishQty;
         this.orderedDish = orderedDish;
+        this.dishQty = dishQty;
         this.ingredientList = setIngredientList();
         this.totalOrderCost = orderCost;
         this.isComplete = isComplete;
@@ -59,6 +59,7 @@ private ArrayList<Ingredient> setIngredientList() {
             String ingredientName = ingredient.getName();
             int ingredientQty = ingredient.getQty() * dishQty;
             String ingredientUnit = ingredient.getUnit();
+
             dishIngredient.add(new Ingredient(ingredientName, ingredientQty, ingredientUnit));
         }
         return dishIngredient;

src/main/java/seedu/cafectrl/data/OrderList.java

@@ -14,7 +14,7 @@
 public class OrderList {
     private static final DecimalFormat dollarValue = new DecimalFormat("0.00");
     private static final String HEADER_FORMAT = "%-20s %-10s %-20s\n";
-    private static Logger logger = Logger.getLogger(CafeCtrl.class.getName());
+    private static final Logger logger = Logger.getLogger(CafeCtrl.class.getName());
     private ArrayList<Order> orderList;
     private float totalOrderListCost;
 
@@ -79,6 +79,7 @@ public void printOrderList(Menu menu, Ui ui) {
      */
     private void aggregateOrder(Order order, ArrayList<Order> aggregatedOrders) {
         logger.info("Aggregating order...");
+
         if (order.getIsComplete()) {
             int index = getIndexByDishName(aggregatedOrders, order.getDishName());
             aggregatedOrders.get(index)
@@ -100,6 +101,7 @@ private int getIndexByDishName(ArrayList<Order> aggregatedOrders, String dishNam
             Order order = aggregatedOrders.get(i);
             String orderDishName = order.getDishName().trim();
             dishName = dishName.trim();
+
             if (orderDishName.equalsIgnoreCase(dishName)) {
                 return i;
             }
@@ -116,6 +118,7 @@ private int getIndexByDishName(ArrayList<Order> aggregatedOrders, String dishNam
     private float calculateTotalCost(ArrayList<Order> orders) {
         logger.info("Calculating total cost...");
         float totalCost = 0;
+
         for (Order order : orders) {
             totalCost += order.getTotalOrderCost();
             logger.info("Total cost: " + totalCost);