Merge branch 'master' into master

Author: BILLXYR

docs/UserGuide.md

@@ -76,15 +76,20 @@ Examples:
 
 Shows a list of all expenses.
 
-Format: `list [c/CATEGORY]`
-
-<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
-Category item is optional for showing all expenses in the specific category.
-</div>
+Format: `list`
 
 Examples:
 * `list`: list all the expenses in all the categories.
-* `list c/FOODBEVERAGE`: list all the expenses in the food beverage category.
+
+### Listing all expenses in a category : `listbycategory`
+
+Shows a list of all expenses belongs to the category.
+
+Format: `listbycategory CATEGORY`
+
+Examples:
+* `listbycategory entertainment`: list all the expenses in entertainment.
+
 
 ### Deleting an expense: `delete`
 
@@ -116,6 +121,12 @@ The index refers to the index number shown in the displayed expense list.
 Examples:
 * `view 1` views the `amount, category, date and description` of the 1st expense displayed in the list.
 
+### View Category Labels : `viewCategory`
+
+Show all the category lables used in the UniSave.
+
+Format: `viewCategory`
+
 ### Add a description to an expense : `addDes`
 
 Add a description to an existing expense in the finance book.
@@ -187,6 +198,7 @@ Action | Format, Examples
 **List** | `list`
 **Delete** | `delete INDEX`<br> e.g., `delete 3`
 **View** | `view INDEX`<br> e.g., `view 5`
+**View existing categori labels** | `viewCategory`
 **Add Description** | `addDes INDEX d/DESCRIPTION`<br> e.g., `addDes 2 d/ENTERTAINMENT`
 **Delete Description** | `deleteDes INDEX`<br> e.g., `deleteDes 2`
 **Set Budget** | `setBudget a/AMOUNT`<br> e.g., `setBudget a/1000`

src/main/java/seedu/address/ExpenseMainApp.java

@@ -69,7 +69,8 @@ public void init() throws Exception {
     }
 
     /**
-     * Returns a {@code ExpenseModelManager} with the data from {@code storage}'s expense book and {@code userPrefs}. <br>
+     * Returns a {@code ExpenseModelManager} with the data from {@code storage}'s expense book
+     * and {@code userPrefs}. <br>
      * The data from the sample expense book will be used instead if {@code storage}'s expense book is not found,
      * or an empty expense book will be used instead if errors occur when reading {@code storage}'s expense book.
      */

src/main/java/seedu/address/commons/core/Messages.java

@@ -5,7 +5,7 @@
  */
 public class Messages {
     public static final String MESSAGE_INVALID_EXPENSE_DISPLAYED_INDEX = "The expense index provided is invalid";
-
+    public static final String MESSAGE_EXPENSES_LISTED_OVERVIEW = "%1$d expenses listed!";
 
 
     public static final String MESSAGE_UNKNOWN_COMMAND = "Unknown command";

src/main/java/seedu/address/logic/commands/DeleteDescriptionCommand.java

@@ -8,8 +8,9 @@
 import seedu.address.commons.core.index.Index;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
-import seedu.address.model.person.Expense;
 import seedu.address.model.person.Description;
+import seedu.address.model.person.Expense;
+
 
 
 /**
@@ -30,8 +31,8 @@ public class DeleteDescriptionCommand extends Command {
     public static final String MESSAGE_ARGUMENTS = "Index: %1$d, Description: %2$s";
     public static final String MESSAGE_ADD_DESCRIPTION_SUCCESS = "Added description to Expense: %1$s \n";
     public static final String MESSAGE_DELETE_DESCRIPTION_SUCCESS = "Removed description from Expense: %1$s \n";
-    private final Index index;
     private static final Description EMPTY_DESCRIPTION = new Description("");
+    private final Index index;
 
     /**
      * @param index of the expense in the filtered expense list to edit the description
@@ -51,7 +52,8 @@ public CommandResult execute(Model model) throws CommandException {
         }
 
         Expense expenseToEdit = lastShownList.get(index.getZeroBased());
-        Expense editedExpense = new Expense(expenseToEdit.getAmount(), expenseToEdit.getDate(), expenseToEdit.getCategory(),
+        Expense editedExpense = new Expense(expenseToEdit.getAmount(), expenseToEdit.getDate(),
+                expenseToEdit.getCategory(),
                 EMPTY_DESCRIPTION);
 
         model.setExpense(expenseToEdit, editedExpense);
@@ -85,4 +87,4 @@ private String generateSuccessMessage(Expense expenseToEdit) {
         String message = MESSAGE_DELETE_DESCRIPTION_SUCCESS;
         return String.format(message, expenseToEdit);
     }
-}
+}

src/main/java/seedu/address/logic/commands/ListExpenseByCategoryCommand.java

@@ -0,0 +1,42 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+
+import seedu.address.commons.core.Messages;
+import seedu.address.model.Model;
+import seedu.address.model.person.CategoryContainsKeywordsPredicate;
+
+/**
+ * Finds and lists all expenses in expense book whose category contains any of the argument keywords.
+ * Keyword matching is case insensitive.
+ */
+public class ListExpenseByCategoryCommand extends Command {
+
+    public static final String COMMAND_WORD = "listbycategory";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all expenses whose category contains any of "
+            + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
+            + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
+            + "Example: " + COMMAND_WORD + "entertainment";
+
+    private final CategoryContainsKeywordsPredicate predicate;
+
+    public ListExpenseByCategoryCommand(CategoryContainsKeywordsPredicate predicate) {
+        this.predicate = predicate;
+    }
+
+    @Override
+    public CommandResult execute(Model model) {
+        requireNonNull(model);
+        model.updateFilteredExpenseList(predicate);
+        return new CommandResult(
+                String.format(Messages.MESSAGE_EXPENSES_LISTED_OVERVIEW, model.getFilteredExpenseList().size()));
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof ListExpenseByCategoryCommand // instanceof handles nulls
+                && predicate.equals(((ListExpenseByCategoryCommand) other).predicate)); // state check
+    }
+}

src/main/java/seedu/address/logic/commands/SetBudgetCommand.java

@@ -1,13 +1,12 @@
 package seedu.address.logic.commands;
 
-import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 
 import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
 
 public class SetBudgetCommand extends Command {
     public static final String COMMAND_WORD = "setBudget";
-    public static final String MESSAGE_SET_BUDGET_SUCCESS = "Successful! Te budget is now S$ %.2f.\n";
+    public static final String MESSAGE_SET_BUDGET_SUCCESS = "Successful! The budget is now S$ %.2f.\n";
     public static final String MESSAGE_SET_BUDGET_FAIL = "Set Budget failed, please enter a valid budget.\n";
 
     private final double budget;
@@ -18,7 +17,7 @@ public SetBudgetCommand(double budget) {
     }
 
     @Override
-    public CommandResult execute(Model model) throws CommandException {
+    public CommandResult execute(Model model) {
         model.setExpenseBookBudget(budget);
         String msg = String.format(MESSAGE_SET_BUDGET_SUCCESS, budget);
         return new CommandResult(msg);

src/main/java/seedu/address/logic/commands/ShowBudgetCommand.java

@@ -1,24 +1,24 @@
 package seedu.address.logic.commands;
 
-import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 
 public class ShowBudgetCommand extends Command {
 
     public static final String COMMAND_WORD = "showBudget";
     public static final String MESSAGE_BUDGET = "Current budget is: S$ %.2f\n";
     public static final String MESSAGE_REMAINING = "Remaining budget is: S$ %.2f\n";
-    public static final String MESSAGE_SETNEW = "Your current budget is S$0.00, \n"
+    public static final String MESSAGE_SETNEW = "Your current budget is S$ %.2f, \n"
             + "please set a new budget with command: setBudget AMOUNT\n";
 
     @Override
-    public CommandResult execute(Model model) throws CommandException {
-        if (model.getExpenseBookBudget() == 0) {
-            return new CommandResult(MESSAGE_SETNEW);
+    public CommandResult execute(Model model) {
+        double budget = model.getExpenseBookBudget();
+        if (model.getExpenseBookBudget() <= 0) {
+            String setNew = String.format(MESSAGE_SETNEW, budget);
+            return new CommandResult(setNew);
         } else {
-            String budgetMsg = String.format(MESSAGE_BUDGET, model.getExpenseBookBudget());
+            String budgetMsg = String.format(MESSAGE_BUDGET, budget);
             String remainingMsg = String.format(MESSAGE_REMAINING, model.getExpenseBookRemaining());
-
             return new CommandResult(budgetMsg + remainingMsg);
         }
     }

src/main/java/seedu/address/logic/commands/ViewCategoryCommand.java

@@ -0,0 +1,35 @@
+package seedu.address.logic.commands;
+
+import seedu.address.logic.commands.exceptions.CommandException;
+import seedu.address.model.Model;
+import seedu.address.model.person.Category;
+import seedu.address.model.person.Expense;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class ViewCategoryCommand extends Command {
+
+    public static final String COMMAND_WORD = "viewCategory";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD
+            + ": Finds all the category labels used in the ExpenseBook so far. \n"
+            + "Example: " + COMMAND_WORD ;
+
+    public static final String MESSAGE_VIEW_CATEGORY_LABELS_SUCCESS =
+            "View all the existing category labels: \n";
+
+    public ViewCategoryCommand() {
+    }
+
+    @Override
+    public CommandResult execute(Model model) throws CommandException {
+        String message = "";
+        List<Category> categories = model.getCategoryLabels();
+        for (int i = 0; i < categories.size(); i++){
+            message = message + categories.get(i).categoryName + "\n";
+        }
+        return new CommandResult(MESSAGE_VIEW_CATEGORY_LABELS_SUCCESS + message);
+    }
+
+}

src/main/java/seedu/address/logic/commands/ViewCommand.java

@@ -0,0 +1,52 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.List;
+
+import seedu.address.commons.core.Messages;
+import seedu.address.commons.core.index.Index;
+import seedu.address.logic.commands.exceptions.CommandException;
+import seedu.address.model.Model;
+import seedu.address.model.person.Expense;
+
+import static java.util.Objects.requireNonNull;
+
+public class ViewCommand extends Command {
+    public static final String COMMAND_WORD = "view";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD
+            + ": Views the expense identified by the index number used in the displayed expense list.\n"
+            + "Parameters: INDEX (must be a positive integer)\n"
+            + "Example: " + COMMAND_WORD + " 1";
+
+    public static final String MESSAGE_VIEW_EXPENSE_SUCCESS = "View Expense: %s";
+
+    private final Index targetIndex;
+
+    public ViewCommand(Index targetIndex) {
+        this.targetIndex = targetIndex;
+    }
+
+    @Override
+    public CommandResult execute(Model model) throws CommandException {
+        List<Expense> lastShownList = model.getFilteredExpenseList();
+
+        if (targetIndex.getZeroBased() >= lastShownList.size()) {
+            throw new CommandException(Messages.MESSAGE_INVALID_PERSON_DISPLAYED_INDEX);
+        }
+
+        Expense expenseToView = lastShownList.get(targetIndex.getZeroBased());
+        String prefix = String.format(MESSAGE_VIEW_EXPENSE_SUCCESS, targetIndex.getOneBased());
+        String message = prefix + "\n" + expenseToView.toString();
+        return new CommandResult(message);
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof ViewCommand // instanceof handles nulls
+                && targetIndex.equals(((ViewCommand) other).targetIndex)); // state check
+    }
+}
+

src/main/java/seedu/address/logic/parser/ExpenseBookParser.java

@@ -1,7 +1,7 @@
 package seedu.address.logic.parser;
 
-import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
-import static seedu.address.commons.core.Messages.MESSAGE_UNKNOWN_COMMAND;
+import seedu.address.logic.commands.*;
+import seedu.address.logic.parser.exceptions.ParseException;
 
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -11,12 +11,17 @@
 import seedu.address.logic.commands.DeleteDescriptionCommand;
 import seedu.address.logic.commands.DeleteExpenseCommand;
 import seedu.address.logic.commands.DescriptionCommand;
-import seedu.address.logic.commands.HelpCommand;
 import seedu.address.logic.commands.ListExpenseCommand;
+import seedu.address.logic.commands.ListExpenseByCategoryCommand;
+import seedu.address.logic.commands.HelpCommand;
+import seedu.address.logic.commands.ViewCommand;
 import seedu.address.logic.commands.SetBudgetCommand;
 import seedu.address.logic.commands.ShowBudgetCommand;
 import seedu.address.logic.parser.exceptions.ParseException;
 
+import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.address.commons.core.Messages.MESSAGE_UNKNOWN_COMMAND;
+
 /**
  * Parses user input.
  */
@@ -44,21 +49,34 @@ public Command parseCommand(String userInput) throws ParseException {
         switch (commandWord) {
         case DescriptionCommand.COMMAND_WORD:
             return new DescriptionCommandParser().parse(arguments);
+
         case AddExpenseCommand.COMMAND_WORD:
             return new AddExpenseCommandParser().parse(arguments);
+
         case DeleteExpenseCommand.COMMAND_WORD:
             return new DeleteExpenseCommandParser().parse(arguments);
 
         case ListExpenseCommand.COMMAND_WORD:
             return new ListExpenseCommand();
+
+        case ViewCommand.COMMAND_WORD:
+            return new ViewCommandParser().parse(arguments);
+
+        case ViewCategoryCommand.COMMAND_WORD:
+            return new ViewCategoryCommandParser().parse(arguments);
+
         case DeleteDescriptionCommand.COMMAND_WORD:
             return new DeleteDescriptionCommandParser().parse(arguments);
 
+        case ListExpenseByCategoryCommand.COMMAND_WORD:
+            return new ListExpenseByCategoryCommandParser().parse(arguments);
+
         case ShowBudgetCommand.COMMAND_WORD:
             return new ShowBudgetCommandParser().parse(arguments);
 
         case SetBudgetCommand.COMMAND_WORD:
             return new SetBudgetCommandParser().parse(arguments);
+
         default:
             throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
         }

src/main/java/seedu/address/logic/parser/ListExpenseByCategoryCommandParser.java

@@ -0,0 +1,33 @@
+package seedu.address.logic.parser;
+
+import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+
+import java.util.Arrays;
+
+import seedu.address.logic.commands.ListExpenseByCategoryCommand;
+import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.address.model.person.CategoryContainsKeywordsPredicate;
+
+/**
+ * Parses input arguments and creates a new ListExpenseByCategoryCommand object
+ */
+public class ListExpenseByCategoryCommandParser implements Parser<ListExpenseByCategoryCommand> {
+
+    /**
+     * Parses the given {@code String} of arguments in the context of the ListExpenseByCategoryCommand
+     * and returns a ListExpenseByCategoryCommand object for execution.
+     * @throws ParseException if the user input does not conform the expected format
+     */
+    public ListExpenseByCategoryCommand parse(String args) throws ParseException {
+        String trimmedArgs = args.trim();
+        if (trimmedArgs.isEmpty()) {
+            throw new ParseException(
+                    String.format(MESSAGE_INVALID_COMMAND_FORMAT, ListExpenseByCategoryCommand.MESSAGE_USAGE));
+        }
+
+        String[] categoryKeywords = trimmedArgs.split("\\s+");
+
+        return new ListExpenseByCategoryCommand(new CategoryContainsKeywordsPredicate(Arrays.asList(categoryKeywords)));
+    }
+
+}