Refactor and add tests

* Refactor and add tests for Quantity

* Refactor DeleteCommand

* Add CommandUtil

* Refactor tests and relevant classes

* Update tests for shift commands

* Add tests for CommandUtil

* Add tests for ReplenishList and related classes

* Update index error message

* Update ShiftToMainCommand test

* Fix bugs in commands

Author: liawsy

build.gradle

@@ -155,12 +155,12 @@ task copyStylesheets(type: Copy) {
 }
 asciidoctor.dependsOn copyStylesheets
 
-/*
-gradle.projectsEvaluated {
+
+/*gradle.projectsEvaluated {
     tasks.withType(JavaCompile) {
         options.compilerArgs << "-Xlint:unchecked"
     }
-}
-*/
+}*/
+
 
 defaultTasks 'clean', 'test', 'coverage', 'asciidoctor'

src/main/java/io/xpire/MainApp.java

@@ -49,7 +49,7 @@ public class MainApp extends Application {
     protected Storage storage;
     protected Model model;
     protected Config config;
-    protected ItemManager itemManager;
+    //protected ItemManager itemManager;
 
     @Override
     public void init() throws Exception {
@@ -72,9 +72,9 @@ public void init() throws Exception {
 
         logic = new LogicManager(model, storage);
 
-        itemManager = new ItemManager(model, storage);
+        //itemManager = new ItemManager(model, storage);
 
-        initItemManager();
+        //initItemManager();
 
         ui = new UiManager(logic);
 
@@ -120,9 +120,9 @@ private void initLogging(Config config) {
         LogsCenter.init(config);
     }
 
-    private void initItemManager() {
+    /* private void initItemManager() {
         itemManager.updateItemTags();
-    }
+    } */
 
     /**
      * Returns a {@code Config} using the file at {@code configFilePath}. <br>

src/main/java/io/xpire/commons/core/Messages.java

@@ -8,10 +8,11 @@ public class Messages {
     public static final String MESSAGE_UNKNOWN_COMMAND = "Unknown command.";
     public static final String MESSAGE_XPIRE_COMMAND_ONLY = "Command can only be used in the main list.";
     public static final String MESSAGE_INVALID_COMMAND_FORMAT = "Invalid command format! \n%1$s";
-    public static final String MESSAGE_INVALID_ITEM_DISPLAYED_INDEX = "The item index provided is invalid.";
+    public static final String MESSAGE_INVALID_INDEX = "The item index provided is invalid.\n"
+            + "The index must be present on the list.\n";
+    public static final String MESSAGE_INVALID_REMINDER_THRESHOLD = "%s is not a valid reminder threshold.";
     public static final String MESSAGE_INVALID_TAGS = "Tags are not in the item specified!";
-    public static final String MESSAGE_UNKNOWN_DELETE_MODE = "Unknown Delete mode.";
     public static final String MESSAGE_SUGGESTIONS = " Did you mean %s?";
-    public static final String MESSAGE_REPLENISH_SHIFT_SUCCESS = "%s is shifted into the replenish list.";
     public static final String MESSAGE_EMPTY_LIST = "Command not executed. The current list is empty!";
+
 }

src/main/java/io/xpire/commons/util/JsonUtil.java

@@ -24,7 +24,7 @@
 import io.xpire.commons.exceptions.DataConversionException;
 
 /**
- * Converts a Java object instance to JSON and vice versa
+ * Converts a Java object instance to JSON and vice versa.
  */
 public class JsonUtil {
 

src/main/java/io/xpire/commons/util/StringUtil.java

@@ -29,26 +29,9 @@
  */
 public class StringUtil {
 
-    private static final String NUMERIC_VALIDATION_REGEX = "^[0-9]+$";
+    private static final String UNSIGNED_NUMERIC_VALIDATION_REGEX = "^[1-9][0-9]*$";
+    private static final String NUMERIC_VALIDATION_REGEX = "^[+-]*[0-9]*$";
 
-    /**
-     * Returns a detailed message of the t, including the stack trace.
-     */
-    public static String getDetails(Throwable t) {
-        requireNonNull(t);
-        StringWriter sw = new StringWriter();
-        t.printStackTrace(new PrintWriter(sw));
-        return t.getMessage() + "\n" + sw.toString();
-    }
-
-    /**
-     * Returns true if {@code s} is numeric.
-     *
-     * @return true if {@code s} matches validation regex.
-     */
-    public static boolean isNumeric(String s) {
-        return s.matches(NUMERIC_VALIDATION_REGEX);
-    }
 
     //@@author JermyTan
     /**
@@ -72,6 +55,36 @@ public static boolean containsPhraseIgnoreCase(String sentence, String phrase) {
         return sentence.toLowerCase().contains(trimmedPhrase.toLowerCase());
     }
 
+    /**
+     * Returns a detailed message of the t, including the stack trace.
+     */
+    public static String getDetails(Throwable t) {
+        requireNonNull(t);
+        StringWriter sw = new StringWriter();
+        t.printStackTrace(new PrintWriter(sw));
+        return t.getMessage() + "\n" + sw.toString();
+    }
+
+    //@author liawsy
+    /**
+     * Returns true if {@code s} is an unsigned number with no leading 0s.
+     *
+     * @return true if {@code s} matches validation regex.
+     */
+    public static boolean isUnsignedNumericWithoutLeadingZeroes(String s) {
+        return s.matches(UNSIGNED_NUMERIC_VALIDATION_REGEX);
+    }
+
+    /**
+     * Returns true if {@code s} is numeric.
+     *
+     * @return true if {@code s} matches validation regex.
+     */
+    public static boolean isNumeric(String s) {
+        return s.matches(NUMERIC_VALIDATION_REGEX);
+    }
+    //@author
+
     /**
      * Returns true if {@code s} represents a non-negative integer.
      * e.g. 0, 1, 2, 3, ..., {@code Integer.MAX_VALUE} <br>.
@@ -82,7 +95,6 @@ public static boolean containsPhraseIgnoreCase(String sentence, String phrase) {
      */
     public static boolean isNonNegativeInteger(String s) {
         requireNonNull(s);
-
         try {
             int value = Integer.parseInt(s);
             return value >= 0 && !s.startsWith("+"); // "+1" is successfully parsed by Integer#parseInt(String)

src/main/java/io/xpire/logic/Logic.java

@@ -44,7 +44,7 @@ public interface Logic {
     ObservableList<Item> getReplenishItemList();
 
     /**
-     * Returns the user prefs' xpire file path.
+     * Returns the user prefs' file path.
      */
     Path getListFilePath();
 

src/main/java/io/xpire/logic/commands/AddCommand.java

@@ -2,14 +2,12 @@
 
 import static io.xpire.commons.util.CollectionUtil.requireAllNonNull;
 import static io.xpire.model.ListType.XPIRE;
-import static java.util.Objects.requireNonNull;
-
-import java.util.List;
 
+import io.xpire.logic.commands.exceptions.CommandException;
+import io.xpire.logic.commands.util.CommandUtil;
 import io.xpire.logic.parser.exceptions.ParseException;
 import io.xpire.model.Model;
 import io.xpire.model.item.ExpiryDate;
-import io.xpire.model.item.Item;
 import io.xpire.model.item.Name;
 import io.xpire.model.item.Quantity;
 import io.xpire.model.item.XpireItem;
@@ -29,18 +27,16 @@ public class AddCommand extends Command {
             + "Example: " + COMMAND_WORD + "|Strawberry|11/12/1999|2";
 
     public static final String MESSAGE_SUCCESS = "New item added to tracking list: %s";
-    public static final String MESSAGE_SUCCESS_ITEM_UPDATED = "Quantity for item is increased to %s";
+    public static final String MESSAGE_SUCCESS_ITEM_UPDATED = "Quantity for item %s is increased to %s";
     public static final String MESSAGE_SUCCESS_ITEM_ADDED = "New item added to tracking list: %s";
-    public static final String MESSAGE_DUPLICATE_ITEM = "This item already exists";
 
-    private String result = "";
     private XpireItem toAdd;
     private final Name name;
     private final Quantity quantity;
     private final ExpiryDate expiryDate;
 
     /**
-     * Creates an AddCommand to add the specified {@code XpireItem}
+     * Creates an AddCommand to add the specified {@code XpireItem}.
      */
     public AddCommand(Name name, ExpiryDate expiryDate, Quantity quantity) {
         this.name = name;
@@ -58,18 +54,15 @@ public AddCommand(Name name, ExpiryDate expiryDate, Quantity quantity) {
      * @throws ParseException if xpireItem added is a duplicate.
      */
     @Override
-    public CommandResult execute(Model model, StateManager stateManager) throws ParseException {
+    public CommandResult execute(Model model, StateManager stateManager) throws CommandException {
         requireAllNonNull(model, stateManager);
-        stateManager.saveState(new ModifiedState(model));
-
         if (model.hasItem(XPIRE, this.toAdd)) {
-            XpireItem itemToReplace = retrieveXpireItem(this.toAdd, model.getItemList(XPIRE));
-            XpireItem itemWithUpdatedQuantity = increaseItemQuantity(new XpireItem(itemToReplace), this.quantity);
-            model.setItem(XPIRE, itemToReplace, itemWithUpdatedQuantity);
+            XpireItem itemWithUpdatedQuantity = CommandUtil.updateItemQuantity(stateManager, model, this.toAdd);
             setShowInHistory(true);
             return new CommandResult(String.format(MESSAGE_SUCCESS_ITEM_UPDATED,
-                    itemWithUpdatedQuantity.getQuantity()));
+                    itemWithUpdatedQuantity.getName(), itemWithUpdatedQuantity.getQuantity()));
         } else {
+            stateManager.saveState(new ModifiedState(model));
             model.addItem(XPIRE, toAdd);
             setShowInHistory(true);
             return new CommandResult(String.format(MESSAGE_SUCCESS_ITEM_ADDED, toAdd));
@@ -98,37 +91,4 @@ public String toString() {
         return "Add command";
     }
 
-    /**
-     * Retrieves item that is the same as item inputted by user.
-     *
-     * @param item existing in the tracking list.
-     * @param list where item is retrieved from.
-     * @return exact item which is the same as input item.
-     **/
-    private XpireItem retrieveXpireItem(XpireItem item, List<? extends Item> list) {
-        requireNonNull(item);
-        int index = -1;
-        for (int i = 0; i < list.size(); i++) {
-            if (list.get(i).isSameItem(item)) {
-                index = i;
-            }
-        }
-        return (XpireItem) list.get(index);
-    }
-
-    /**
-     * Increases the item quantity for any duplicate items.
-     *
-     * @param targetItem the target item to increase the quantity of.
-     * @param quantity how much to increase the item quantity by.
-     * @return The new item with revised quantity.
-     * @throws ParseException if
-     */
-    private XpireItem increaseItemQuantity(XpireItem targetItem, Quantity quantity) throws ParseException {
-        Quantity prevQuantity = targetItem.getQuantity();
-        Quantity updatedQuantity = prevQuantity.increaseQuantity(quantity);
-        targetItem.setQuantity(updatedQuantity);
-        return targetItem;
-    }
-
 }

src/main/java/io/xpire/logic/commands/DeleteCommand.java

@@ -1,7 +1,7 @@
 package io.xpire.logic.commands;
 
-import static io.xpire.commons.core.Messages.MESSAGE_REPLENISH_SHIFT_SUCCESS;
 import static io.xpire.commons.util.CollectionUtil.requireAllNonNull;
+import static io.xpire.logic.commands.util.CommandUtil.MESSAGE_REPLENISH_SHIFT_SUCCESS;
 import static io.xpire.model.ListType.REPLENISH;
 import static io.xpire.model.ListType.XPIRE;
 
@@ -11,6 +11,7 @@
 import io.xpire.commons.core.Messages;
 import io.xpire.commons.core.index.Index;
 import io.xpire.logic.commands.exceptions.CommandException;
+import io.xpire.logic.commands.util.CommandUtil;
 import io.xpire.logic.parser.exceptions.ParseException;
 import io.xpire.model.ListType;
 import io.xpire.model.Model;
@@ -35,6 +36,7 @@ private enum DeleteMode { ITEM, QUANTITY, TAGS }
 
     public static final String COMMAND_WORD = "delete";
     public static final String COMMAND_SHORTHAND = "d";
+    public static final String MESSAGE_UNKNOWN_DELETE_MODE = "Unknown Delete mode.";
 
     public static final String MESSAGE_USAGE =
             "Three formats available for " + COMMAND_WORD + ":\n"
@@ -50,15 +52,13 @@ private enum DeleteMode { ITEM, QUANTITY, TAGS }
     public static final String MESSAGE_DELETE_ITEM_SUCCESS = "Deleted item: %s";
     public static final String MESSAGE_DELETE_TAGS_SUCCESS = "Deleted tags from item: %s";
     public static final String MESSAGE_DELETE_QUANTITY_SUCCESS = "Reduced quantity by %s from item: %s";
-    public static final String MESSAGE_DELETE_QUANTITY_FAILURE = "Invalid quantity specified. \n"
-            + "Quantity must be positive and less than or equals to item's quantity.";
 
     private final Index targetIndex;
     private final Set<Tag> tagSet;
     private final Quantity quantity;
     private final DeleteMode mode;
     private final ListType listType;
-    private Item item = null;
+    private Item item;
     private String result = "";
 
     public DeleteCommand(ListType listType, Index targetIndex) {
@@ -92,7 +92,7 @@ public CommandResult execute(Model model, StateManager stateManager) throws Comm
         ObservableList<? extends Item> currentList = model.getCurrentList();
 
         if (this.targetIndex.getZeroBased() >= currentList.size()) {
-            throw new CommandException(Messages.MESSAGE_INVALID_ITEM_DISPLAYED_INDEX);
+            throw new CommandException(Messages.MESSAGE_INVALID_INDEX);
         }
 
         Item targetItem = currentList.get(this.targetIndex.getZeroBased());
@@ -106,22 +106,22 @@ public CommandResult execute(Model model, StateManager stateManager) throws Comm
         case QUANTITY:
             return executeDeleteQuantity(model, targetItem, stateManager);
         default:
-            throw new CommandException(Messages.MESSAGE_UNKNOWN_DELETE_MODE);
+            throw new CommandException(MESSAGE_UNKNOWN_DELETE_MODE);
         }
     }
 
     /**
      * Executes the command and returns the result message.
      *
      * @param model model {@code Model} which the command should operate on.
-     * @param targetItem target item to reduce the quantity of,
+     * @param targetItem target item to reduce the quantity of.
      * @return feedback message of the operation result for display.
      * @throws CommandException If an error occurs during command execution.
      */
     private CommandResult executeDeleteQuantity(Model model, Item targetItem, StateManager stateManager)
-            throws CommandException, ParseException {
+            throws CommandException {
         assert this.quantity != null;
-        XpireItem updatedItem = reduceItemQuantity(new XpireItem((XpireItem) targetItem), this.quantity);
+        XpireItem updatedItem = CommandUtil.reduceItemQuantity((XpireItem) targetItem, this.quantity);
         stateManager.saveState(new ModifiedState(model));
         model.setItem(listType, targetItem, updatedItem);
         // transfer item to replenish list
@@ -132,7 +132,7 @@ private CommandResult executeDeleteQuantity(Model model, Item targetItem, StateM
             setShowInHistory(true);
             return new CommandResult(this.result);
         }
-        this.result = String.format(MESSAGE_DELETE_QUANTITY_SUCCESS, quantity.toString(), targetItem);
+        this.result = String.format(MESSAGE_DELETE_QUANTITY_SUCCESS, quantity.toString(), targetItem.getName());
         setShowInHistory(true);
         return new CommandResult(this.result);
     }
@@ -161,8 +161,7 @@ private CommandResult executeDeleteTags(Model model, Item targetItem, StateManag
         return new CommandResult(this.result);
     }
 
-    /**
-     * Executes the command and returns the result message.
+    /** Executes the command and returns the result message.
      *
      * @param model model {@code Model} which the command should operate on.
      * @param targetItem target item to delete completely.
@@ -220,25 +219,6 @@ private Item removeTagsFromReplenishItem(Item targetReplenishItem, Set<Tag> tagS
         return targetReplenishItem;
     }
 
-    /**
-     * Reduces xpireItem's quantity by amount specified.
-     *
-     * @param targetXpireItem XpireItem which amount will be reduced.
-     * @param reduceByQuantity Quantity to be reduced.
-     * @return The new XpireItem with its quantity reduced.
-     * @throws ParseException if
-     */
-    private XpireItem reduceItemQuantity(XpireItem targetXpireItem, Quantity reduceByQuantity) throws CommandException,
-                                                                                                      ParseException {
-        Quantity originalQuantity = targetXpireItem.getQuantity();
-        if (originalQuantity.isLessThan(reduceByQuantity)) {
-            throw new CommandException(MESSAGE_DELETE_QUANTITY_FAILURE);
-        }
-        Quantity updatedQuantity = originalQuantity.deductQuantity(reduceByQuantity);
-        targetXpireItem.setQuantity(updatedQuantity);
-        return targetXpireItem;
-    }
-
     /**
      * Shifts Item to ReplenishList.
      */

src/main/java/io/xpire/logic/commands/SetReminderCommand.java

@@ -58,7 +58,7 @@ public CommandResult execute(Model model, StateManager stateManager) throws Comm
         ObservableList<? extends Item> currentList = model.getCurrentList();
 
         if (this.index.getZeroBased() >= currentList.size()) {
-            throw new CommandException(Messages.MESSAGE_INVALID_ITEM_DISPLAYED_INDEX);
+            throw new CommandException(Messages.MESSAGE_INVALID_INDEX);
         }
 
         XpireItem targetItem = (XpireItem) currentList.get(this.index.getZeroBased());