Merge pull request nus-cs2103-AY2021S1#84 from tanwayne890/branch-ListCategory

Add list category

Author: tanwayne890

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`
 

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/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/parser/ExpenseBookParser.java

@@ -6,6 +6,19 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import seedu.address.logic.commands.AddExpenseCommand;
+import seedu.address.logic.commands.Command;
+import seedu.address.logic.commands.DeleteExpenseCommand;
+import seedu.address.logic.commands.DeleteDescriptionCommand;
+import seedu.address.logic.commands.DescriptionCommand;
+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;
 
@@ -34,35 +47,50 @@ public Command parseCommand(String userInput) throws ParseException {
         final String commandWord = matcher.group("commandWord");
         final String arguments = matcher.group("arguments");
         switch (commandWord) {
-            case DescriptionCommand.COMMAND_WORD:
-                return new DescriptionCommandParser().parse(arguments);
+        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 AddExpenseCommand.COMMAND_WORD:
-                return new AddExpenseCommandParser().parse(arguments);
+        case ViewCategoryCommand.COMMAND_WORD:
+            return new ViewCategoryCommandParser().parse(arguments);
 
-            case DeleteExpenseCommand.COMMAND_WORD:
-                return new DeleteExpenseCommandParser().parse(arguments);
+        case DeleteDescriptionCommand.COMMAND_WORD:
+            return new DeleteDescriptionCommandParser().parse(arguments);
 
-            case ListExpenseCommand.COMMAND_WORD:
-                return new ListExpenseCommand();
+        case DeleteExpenseCommand.COMMAND_WORD:
+            return new DeleteExpenseCommandParser().parse(arguments);
 
-            case ViewCommand.COMMAND_WORD:
-                return new ViewCommandParser().parse(arguments);
+        case ListExpenseCommand.COMMAND_WORD:
+            return new ListExpenseCommand();
 
-            case ViewCategoryCommand.COMMAND_WORD:
-                return new ViewCategoryCommandParser().parse(arguments);
+        case ListExpenseByCategoryCommand.COMMAND_WORD:
+            return new ListExpenseByCategoryCommandParser().parse(arguments);
 
-            case DeleteDescriptionCommand.COMMAND_WORD:
-                return new DeleteDescriptionCommandParser().parse(arguments);
+        case ViewCommand.COMMAND_WORD:
+            return new ViewCommandParser().parse(arguments);
 
-            case ShowBudgetCommand.COMMAND_WORD:
-                return new ShowBudgetCommandParser().parse(arguments);
+        case DeleteDescriptionCommand.COMMAND_WORD:
+            return new DeleteDescriptionCommandParser().parse(arguments);
 
-            case SetBudgetCommand.COMMAND_WORD:
-                return new SetBudgetCommandParser().parse(arguments);
+        case ShowBudgetCommand.COMMAND_WORD:
+            return new ShowBudgetCommandParser().parse(arguments);
 
-            default:
-                throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
+        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)));
+    }
+
+}

src/main/java/seedu/address/model/ModelManager.java

@@ -28,7 +28,6 @@ public class ModelManager implements Model {
     private final FilteredList<Person> filteredPersons;
 
     private final FilteredList<Expense> filteredExpenses;
-//    private final ExpenseBook expenseBook;
 
 
     /**
@@ -42,7 +41,6 @@ public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyUserPrefs userPrefs
 
         this.addressBook = new AddressBook(addressBook);
         this.userPrefs = new UserPrefs(userPrefs);
-//        this.expenseBook = new ExpenseBook(expenseBook);
         filteredPersons = new FilteredList<>(this.addressBook.getPersonList());
         filteredExpenses = new FilteredList<>(this.addressBook.getExpenseList());
     }

src/main/java/seedu/address/model/person/CategoryContainsKeywordsPredicate.java

@@ -0,0 +1,31 @@
+package seedu.address.model.person;
+
+import java.util.List;
+import java.util.function.Predicate;
+
+import seedu.address.commons.util.StringUtil;
+
+/**
+ * Tests that a {@code Expense}'s {@code Category} matches any of the keywords given.
+ */
+public class CategoryContainsKeywordsPredicate implements Predicate<Expense> {
+    private final List<String> keywords;
+
+    public CategoryContainsKeywordsPredicate(List<String> keywords) {
+        this.keywords = keywords;
+    }
+
+    @Override
+    public boolean test(Expense expense) {
+        return keywords.stream()
+                .anyMatch(keyword -> StringUtil.containsWordIgnoreCase(expense.getCategory().categoryName, keyword));
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof CategoryContainsKeywordsPredicate // instanceof handles nulls
+                && keywords.equals(((CategoryContainsKeywordsPredicate) other).keywords)); // state check
+    }
+
+}