Merge pull request #140 from Cary-Xx/final

Add history command and minor fix
AY1920S1-CS2103-T14-4 · Nov 10, 2019 · 11a499b · 11a499b
2 parents b550c8d + 767342f
commit 11a499b
Show file tree

Hide file tree

Showing 29 changed files with 235 additions and 59 deletions.
diff --git a/src/main/java/seedu/address/logic/CommandHistory.java b/src/main/java/seedu/address/logic/CommandHistory.java
@@ -0,0 +1,58 @@
+package seedu.address.logic;
+
+import static java.util.Objects.requireNonNull;
+
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
+
+/**
+ * Stores the history of commands executed.
+ */
+public class CommandHistory {
+    private final ObservableList<String> userInputHistory = FXCollections.observableArrayList();
+    private final ObservableList<String> unmodifiableUserInputHistory =
+            FXCollections.unmodifiableObservableList(userInputHistory);
+
+    public CommandHistory() {}
+
+    public CommandHistory(CommandHistory commandHistory) {
+        userInputHistory.addAll(commandHistory.userInputHistory);
+    }
+
+    /**
+     * Appends {@code userInput} to the list of user input entered.
+     */
+    public void add(String userInput) {
+        requireNonNull(userInput);
+        userInputHistory.add(userInput);
+    }
+
+    /**
+     * Returns an unmodifiable view of {@code userInputHistory}.
+     */
+    public ObservableList<String> getHistory() {
+        return unmodifiableUserInputHistory;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        // short circuit if same object
+        if (obj == this) {
+            return true;
+        }
+
+        // instanceof handles nulls
+        if (!(obj instanceof CommandHistory)) {
+            return false;
+        }
+
+        // state check
+        CommandHistory other = (CommandHistory) obj;
+        return userInputHistory.equals(other.userInputHistory);
+    }
+
+    @Override
+    public int hashCode() {
+        return userInputHistory.hashCode();
+    }
+}
diff --git a/src/main/java/seedu/address/logic/LogicManager.java b/src/main/java/seedu/address/logic/LogicManager.java
@@ -29,11 +29,13 @@ public class LogicManager implements Logic {
 
     private final Model model;
     private final Storage storage;
+    private final CommandHistory history;
     private final MymParser mymParser;
 
     public LogicManager(Model model, Storage storage) {
         this.model = model;
         this.storage = storage;
+        history = new CommandHistory();
         mymParser = new MymParser();
     }
 
@@ -42,8 +44,12 @@ public CommandResult execute(String commandText) throws CommandException, ParseE
         logger.info("----------------[USER COMMAND][" + commandText + "]");
 
         CommandResult commandResult;
-        Command command = mymParser.parseCommand(commandText);
-        commandResult = command.execute(model);
+        try {
+            Command command = mymParser.parseCommand(commandText);
+            commandResult = command.execute(model, history);
+        } finally {
+            history.add(commandText);
+        }
 
         try {
             storage.saveExpenseList(model.getExpenseList());

diff --git a/src/main/java/seedu/address/logic/commands/AddBudgetCommand.java b/src/main/java/seedu/address/logic/commands/AddBudgetCommand.java
@@ -7,6 +7,7 @@
 import static seedu.address.logic.parser.CliSyntax.PREFIX_END_DATE;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME;
 
+import seedu.address.logic.CommandHistory;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.ViewState;
@@ -49,7 +50,7 @@ public AddBudgetCommand(Budget budget) {
     }
 
     @Override
-    public CommandResult execute(Model model) throws CommandException {
+    public CommandResult execute(Model model, CommandHistory history) throws CommandException {
         requireNonNull(model);
 
         if (toAdd.getEndDate().localDate.isBefore(toAdd.getStartDate().localDate)) {

diff --git a/src/main/java/seedu/address/logic/commands/AddCommand.java b/src/main/java/seedu/address/logic/commands/AddCommand.java
@@ -7,6 +7,7 @@
 import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG;
 
+import seedu.address.logic.CommandHistory;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.ViewState;
@@ -49,7 +50,7 @@ public AddCommand(Expense expense) {
     }
 
     @Override
-    public CommandResult execute(Model model) throws CommandException {
+    public CommandResult execute(Model model, CommandHistory history) throws CommandException {
         requireNonNull(model);
 
         if (model.hasExpense(toAdd)) {

diff --git a/src/main/java/seedu/address/logic/commands/ClearCommand.java b/src/main/java/seedu/address/logic/commands/ClearCommand.java
@@ -2,6 +2,7 @@
 
 import static java.util.Objects.requireNonNull;
 
+import seedu.address.logic.CommandHistory;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.ExpenseList;
 import seedu.address.model.Model;
@@ -22,7 +23,7 @@ public class ClearCommand extends Command {
     public static final String MESSAGE_CLEAR_ERROR = "An error occurred while trying to clear list";
 
     @Override
-    public CommandResult execute(Model model) throws CommandException {
+    public CommandResult execute(Model model, CommandHistory history) throws CommandException {
         requireNonNull(model);
         ViewState viewState = model.getViewState();
 

diff --git a/src/main/java/seedu/address/logic/commands/Command.java b/src/main/java/seedu/address/logic/commands/Command.java
@@ -1,5 +1,6 @@
 package seedu.address.logic.commands;
 
+import seedu.address.logic.CommandHistory;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 
@@ -12,8 +13,9 @@ public abstract class Command {
      * Executes the command and returns the result message.
      *
      * @param model {@code Model} which the command should operate on.
+     * @param history history of user inputs.
      * @return feedback message of the operation result for display
      * @throws CommandException If an error occurs during command execution.
      */
-    public abstract CommandResult execute(Model model) throws CommandException;
+    public abstract CommandResult execute(Model model, CommandHistory history) throws CommandException;
 }
diff --git a/src/main/java/seedu/address/logic/commands/DeleteCommand.java b/src/main/java/seedu/address/logic/commands/DeleteCommand.java
@@ -6,6 +6,7 @@
 
 import seedu.address.commons.core.Messages;
 import seedu.address.commons.core.index.Index;
+import seedu.address.logic.CommandHistory;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.ViewState;
@@ -35,7 +36,7 @@ public DeleteCommand(Index targetIndex) {
     }
 
     @Override
-    public CommandResult execute(Model model) throws CommandException {
+    public CommandResult execute(Model model, CommandHistory history) throws CommandException {
         requireNonNull(model);
 
         ViewState viewState = model.getViewState();

diff --git a/src/main/java/seedu/address/logic/commands/EditBudgetCommand.java b/src/main/java/seedu/address/logic/commands/EditBudgetCommand.java
@@ -12,6 +12,7 @@
 import seedu.address.commons.core.Messages;
 import seedu.address.commons.core.index.Index;
 import seedu.address.commons.util.CollectionUtil;
+import seedu.address.logic.CommandHistory;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.ViewState;
@@ -77,7 +78,7 @@ private static Budget createEditedBudget(Budget budgetToEdit, EditBudgetDescript
     }
 
     @Override
-    public CommandResult execute(Model model) throws CommandException {
+    public CommandResult execute(Model model, CommandHistory history) throws CommandException {
         requireNonNull(model);
 
         List<Budget> lastShownList = model.getFilteredBudgetList();

diff --git a/src/main/java/seedu/address/logic/commands/EditCommand.java b/src/main/java/seedu/address/logic/commands/EditCommand.java
@@ -16,6 +16,7 @@
 import seedu.address.commons.core.Messages;
 import seedu.address.commons.core.index.Index;
 import seedu.address.commons.util.CollectionUtil;
+import seedu.address.logic.CommandHistory;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.ViewState;
@@ -87,7 +88,7 @@ private static Expense createEditedExpense(Expense expenseToEdit, EditExpenseDes
     }
 
     @Override
-    public CommandResult execute(Model model) throws CommandException {
+    public CommandResult execute(Model model, CommandHistory history) throws CommandException {
         requireNonNull(model);
         ViewState viewState = model.getViewState();
         List<Expense> lastShownList;

diff --git a/src/main/java/seedu/address/logic/commands/ExitCommand.java b/src/main/java/seedu/address/logic/commands/ExitCommand.java
@@ -1,5 +1,6 @@
 package seedu.address.logic.commands;
 
+import seedu.address.logic.CommandHistory;
 import seedu.address.model.Model;
 
 /**
@@ -12,7 +13,7 @@ public class ExitCommand extends Command {
     public static final String MESSAGE_EXIT_ACKNOWLEDGEMENT = "Exiting MYMorise as requested ...";
 
     @Override
-    public CommandResult execute(Model model) {
+    public CommandResult execute(Model model, CommandHistory history) {
         return new CommandResult(MESSAGE_EXIT_ACKNOWLEDGEMENT, false, true);
     }
 

diff --git a/src/main/java/seedu/address/logic/commands/FindCommand.java b/src/main/java/seedu/address/logic/commands/FindCommand.java
@@ -3,6 +3,7 @@
 import static java.util.Objects.requireNonNull;
 
 import seedu.address.commons.core.Messages;
+import seedu.address.logic.CommandHistory;
 import seedu.address.model.Model;
 import seedu.address.model.expense.NameContainsKeywordsPredicate;
 
@@ -26,7 +27,7 @@ public FindCommand(NameContainsKeywordsPredicate predicate) {
     }
 
     @Override
-    public CommandResult execute(Model model) {
+    public CommandResult execute(Model model, CommandHistory history) {
         requireNonNull(model);
         model.updateFilteredExpenseList(predicate);
         int size = model.getFilteredExpenseList().size();

diff --git a/src/main/java/seedu/address/logic/commands/HelpCommand.java b/src/main/java/seedu/address/logic/commands/HelpCommand.java
@@ -1,5 +1,6 @@
 package seedu.address.logic.commands;
 
+import seedu.address.logic.CommandHistory;
 import seedu.address.model.Model;
 
 /**
@@ -15,7 +16,7 @@ public class HelpCommand extends Command {
     public static final String SHOWING_HELP_MESSAGE = "Opened help window.";
 
     @Override
-    public CommandResult execute(Model model) {
+    public CommandResult execute(Model model, CommandHistory history) {
         return new CommandResult(SHOWING_HELP_MESSAGE, true, false);
     }
 }
diff --git a/src/main/java/seedu/address/logic/commands/HistoryCommand.java b/src/main/java/seedu/address/logic/commands/HistoryCommand.java
@@ -0,0 +1,32 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.ArrayList;
+import java.util.Collections;
+
+import seedu.address.logic.CommandHistory;
+import seedu.address.model.Model;
+
+/**
+ * Lists all the commands entered by user from the start of app launch.
+ */
+public class HistoryCommand extends Command {
+
+    public static final String COMMAND_WORD = "history";
+    public static final String MESSAGE_SUCCESS = "Entered commands (from most recent to earliest):\n%1$s";
+    public static final String MESSAGE_NO_HISTORY = "You have not yet entered any commands.";
+
+    @Override
+    public CommandResult execute(Model model, CommandHistory history) {
+        requireNonNull(history);
+        ArrayList<String> previousCommands = new ArrayList<>(history.getHistory());
+
+        if (previousCommands.isEmpty()) {
+            return new CommandResult(MESSAGE_NO_HISTORY);
+        }
+
+        Collections.reverse(previousCommands);
+        return new CommandResult(String.format(MESSAGE_SUCCESS, String.join("\n", previousCommands)));
+    }
+}
diff --git a/src/main/java/seedu/address/logic/commands/ListCommand.java b/src/main/java/seedu/address/logic/commands/ListCommand.java
@@ -3,6 +3,7 @@
 import static java.util.Objects.requireNonNull;
 import static seedu.address.model.Model.PREDICATE_SHOW_ALL_EXPENSES;
 
+import seedu.address.logic.CommandHistory;
 import seedu.address.model.Model;
 import seedu.address.model.ViewState;
 
@@ -16,7 +17,7 @@ public class ListCommand extends Command {
     public static final String MESSAGE_SUCCESS = "Listed all expenses";
 
     @Override
-    public CommandResult execute(Model model) {
+    public CommandResult execute(Model model, CommandHistory history) {
         requireNonNull(model);
         model.updateFilteredExpenseList(PREDICATE_SHOW_ALL_EXPENSES);
         model.setViewState(ViewState.DEFAULT_EXPENSELIST);

diff --git a/src/main/java/seedu/address/logic/commands/ViewBudgetCommand.java b/src/main/java/seedu/address/logic/commands/ViewBudgetCommand.java
@@ -6,6 +6,7 @@
 
 import seedu.address.commons.core.Messages;
 import seedu.address.commons.core.index.Index;
+import seedu.address.logic.CommandHistory;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.ViewState;
@@ -35,7 +36,7 @@ public ViewBudgetCommand(Index targetIndex) {
     }
 
     @Override
-    public CommandResult execute(Model model) throws CommandException {
+    public CommandResult execute(Model model, CommandHistory history) throws CommandException {
         requireNonNull(model);
 
         List<Budget> lastShownList = model.getFilteredBudgetList();

diff --git a/src/main/java/seedu/address/logic/commands/ViewBudgetListCommand.java b/src/main/java/seedu/address/logic/commands/ViewBudgetListCommand.java
@@ -3,6 +3,7 @@
 import static java.util.Objects.requireNonNull;
 import static seedu.address.model.Model.PREDICATE_SHOW_ALL_BUDGETS;
 
+import seedu.address.logic.CommandHistory;
 import seedu.address.model.Model;
 import seedu.address.model.ViewState;
 
@@ -16,7 +17,7 @@ public class ViewBudgetListCommand extends Command {
     public static final String MESSAGE_SUCCESS = "Listed all budgets";
 
     @Override
-    public CommandResult execute(Model model) {
+    public CommandResult execute(Model model, CommandHistory history) {
         requireNonNull(model);
         model.updateFilteredBudgetList(PREDICATE_SHOW_ALL_BUDGETS);
         model.setViewState(ViewState.BUDGETLIST);

diff --git a/src/main/java/seedu/address/logic/parser/MymParser.java b/src/main/java/seedu/address/logic/parser/MymParser.java
@@ -16,6 +16,7 @@
 import seedu.address.logic.commands.ExitCommand;
 import seedu.address.logic.commands.FindCommand;
 import seedu.address.logic.commands.HelpCommand;
+import seedu.address.logic.commands.HistoryCommand;
 import seedu.address.logic.commands.ListCommand;
 import seedu.address.logic.commands.ViewBudgetCommand;
 import seedu.address.logic.commands.ViewBudgetListCommand;
@@ -84,6 +85,9 @@ public Command parseCommand(String userInput) throws ParseException {
         case AddBudgetCommand.COMMAND_WORD:
             return new AddBudgetCommandParser().parse(arguments);
 
+        case HistoryCommand.COMMAND_WORD:
+            return new HistoryCommand();
+
         default:
             throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
         }

diff --git a/src/main/java/seedu/address/model/budget/Budget.java b/src/main/java/seedu/address/model/budget/Budget.java
@@ -96,7 +96,6 @@ public void addExpenseIntoBudget(Expense expense) {
         recalculateAmountLeft();
     }
 
-
     /**
      * @param expense target expense in the budget
      */