Merge pull request nus-cs2103-AY2021S1#84 from li-s/branch-untagCommand

Modify DeleteCommand, DeleteParser to UntagCommand, UntagParser

Author: luo-git

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

@@ -7,7 +7,7 @@ public class Messages {
 
     public static final String MESSAGE_UNKNOWN_COMMAND = "Unknown command";
     public static final String MESSAGE_INVALID_COMMAND_FORMAT = "Invalid command format! \n%1$s";
-    public static final String MESSAGE_INVALID_TAG_DISPLAYED_INDEX = "The tag index provided is invalid";
+    public static final String MESSAGE_INVALID_TAG_DISPLAYED_INDEX = "The Tag index provided is invalid";
     public static final String MESSAGE_TAGS_LISTED_OVERVIEW = "%1$d tags listed!";
 
 }

src/main/java/seedu/address/logic/commands/DeleteCommand.java renamed to src/main/java/seedu/address/logic/commands/UntagCommand.java

@@ -11,22 +11,22 @@
 import seedu.address.model.tag.Tag;
 
 /**
- * Deletes a person identified using it's displayed index from the address book.
+ * Untags a Tag identified using it's displayed index from the address book.
  */
-public class DeleteCommand extends Command {
+public class UntagCommand extends Command {
 
-    public static final String COMMAND_WORD = "delete";
+    public static final String COMMAND_WORD = "untag";
 
     public static final String MESSAGE_USAGE = COMMAND_WORD
-            + ": Deletes the person identified by the index number used in the displayed person list.\n"
+            + ": Untags the tagged file identified by the index number used in the displayed Tag list.\n"
             + "Parameters: INDEX (must be a positive integer)\n"
             + "Example: " + COMMAND_WORD + " 1";
 
-    public static final String MESSAGE_DELETE_TAG_SUCCESS = "Deleted Tag: %1$s";
+    public static final String MESSAGE_UNTAG_TAG_SUCCESS = "Untagged Tag: %1$s";
 
     private final Index targetIndex;
 
-    public DeleteCommand(Index targetIndex) {
+    public UntagCommand(Index targetIndex) {
         this.targetIndex = targetIndex;
     }
 
@@ -39,15 +39,15 @@ public CommandResult execute(Model model) throws CommandException {
             throw new CommandException(Messages.MESSAGE_INVALID_TAG_DISPLAYED_INDEX);
         }
 
-        Tag personToDelete = lastShownList.get(targetIndex.getZeroBased());
-        model.deleteTag(personToDelete);
-        return new CommandResult(String.format(MESSAGE_DELETE_TAG_SUCCESS, personToDelete));
+        Tag tagToUntag = lastShownList.get(targetIndex.getZeroBased());
+        model.deleteTag(tagToUntag);
+        return new CommandResult(String.format(MESSAGE_UNTAG_TAG_SUCCESS, tagToUntag));
     }
 
     @Override
     public boolean equals(Object other) {
         return other == this // short circuit if same object
-                || (other instanceof DeleteCommand // instanceof handles nulls
-                && targetIndex.equals(((DeleteCommand) other).targetIndex)); // state check
+                || (other instanceof UntagCommand // instanceof handles nulls
+                && targetIndex.equals(((UntagCommand) other).targetIndex)); // state check
     }
 }

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

@@ -9,11 +9,11 @@
 import seedu.address.logic.commands.AddCommand;
 import seedu.address.logic.commands.ClearCommand;
 import seedu.address.logic.commands.Command;
-import seedu.address.logic.commands.DeleteCommand;
 import seedu.address.logic.commands.ExitCommand;
 import seedu.address.logic.commands.FindCommand;
 import seedu.address.logic.commands.HelpCommand;
 import seedu.address.logic.commands.ListCommand;
+import seedu.address.logic.commands.UntagCommand;
 import seedu.address.logic.parser.exceptions.ParseException;
 
 /**
@@ -46,8 +46,8 @@ public Command parseCommand(String userInput) throws ParseException {
         case AddCommand.COMMAND_WORD:
             return new AddCommandParser().parse(arguments);
 
-        case DeleteCommand.COMMAND_WORD:
-            return new DeleteCommandParser().parse(arguments);
+        case UntagCommand.COMMAND_WORD:
+            return new UntagCommandParser().parse(arguments);
 
         case ClearCommand.COMMAND_WORD:
             return new ClearCommand();

src/main/java/seedu/address/logic/parser/DeleteCommandParser.java renamed to src/main/java/seedu/address/logic/parser/UntagCommandParser.java

@@ -3,26 +3,26 @@
 import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
 
 import seedu.address.commons.core.index.Index;
-import seedu.address.logic.commands.DeleteCommand;
+import seedu.address.logic.commands.UntagCommand;
 import seedu.address.logic.parser.exceptions.ParseException;
 
 /**
- * Parses input arguments and creates a new DeleteCommand object
+ * Parses input arguments and creates a new UntagCommand object
  */
-public class DeleteCommandParser implements Parser<DeleteCommand> {
+public class UntagCommandParser implements Parser<UntagCommand> {
 
     /**
-     * Parses the given {@code String} of arguments in the context of the DeleteCommand
-     * and returns a DeleteCommand object for execution.
+     * Parses the given {@code String} of arguments in the context of the UntagCommand
+     * and returns a UntagCommand object for execution.
      * @throws ParseException if the user input does not conform the expected format
      */
-    public DeleteCommand parse(String args) throws ParseException {
+    public UntagCommand parse(String args) throws ParseException {
         try {
             Index index = ParserUtil.parseIndex(args);
-            return new DeleteCommand(index);
+            return new UntagCommand(index);
         } catch (ParseException pe) {
             throw new ParseException(
-                    String.format(MESSAGE_INVALID_COMMAND_FORMAT, DeleteCommand.MESSAGE_USAGE), pe);
+                    String.format(MESSAGE_INVALID_COMMAND_FORMAT, UntagCommand.MESSAGE_USAGE), pe);
         }
     }
 

src/test/java/seedu/address/logic/LogicManagerTest.java

@@ -56,8 +56,8 @@ public void execute_invalidCommandFormat_throwsParseException() {
 
     @Test
     public void execute_commandExecutionError_throwsCommandException() {
-        String deleteCommand = "delete 9";
-        assertCommandException(deleteCommand, MESSAGE_INVALID_TAG_DISPLAYED_INDEX);
+        String untagCommand = "untag 9";
+        assertCommandException(untagCommand, MESSAGE_INVALID_TAG_DISPLAYED_INDEX);
     }
 
     @Test

src/test/java/seedu/address/logic/commands/DeleteCommandTest.java renamed to src/test/java/seedu/address/logic/commands/UntagCommandTest.java

@@ -20,47 +20,47 @@
 
 /**
  * Contains integration tests (interaction with the Model, UndoCommand and RedoCommand) and unit tests for
- * {@code DeleteCommand}.
+ * {@code UntagCommand}.
  */
-public class DeleteCommandTest {
+public class UntagCommandTest {
 
     private Model model = new ModelManager(getTypicalAddressBook(), new UserPrefs());
 
     @Test
     public void execute_validIndexUnfilteredList_success() {
-        Tag personToDelete = model.getFilteredTagList().get(INDEX_FIRST_TAG.getZeroBased());
-        DeleteCommand deleteCommand = new DeleteCommand(INDEX_FIRST_TAG);
+        Tag tagToDelete = model.getFilteredTagList().get(INDEX_FIRST_TAG.getZeroBased());
+        UntagCommand untagCommand = new UntagCommand(INDEX_FIRST_TAG);
 
-        String expectedMessage = String.format(DeleteCommand.MESSAGE_DELETE_TAG_SUCCESS, personToDelete);
+        String expectedMessage = String.format(UntagCommand.MESSAGE_UNTAG_TAG_SUCCESS, tagToDelete);
 
         ModelManager expectedModel = new ModelManager(model.getAddressBook(), new UserPrefs());
-        expectedModel.deleteTag(personToDelete);
+        expectedModel.deleteTag(tagToDelete);
 
-        assertCommandSuccess(deleteCommand, model, expectedMessage, expectedModel);
+        assertCommandSuccess(untagCommand, model, expectedMessage, expectedModel);
     }
 
     @Test
     public void execute_invalidIndexUnfilteredList_throwsCommandException() {
         Index outOfBoundIndex = Index.fromOneBased(model.getFilteredTagList().size() + 1);
-        DeleteCommand deleteCommand = new DeleteCommand(outOfBoundIndex);
+        UntagCommand untagCommand = new UntagCommand(outOfBoundIndex);
 
-        assertCommandFailure(deleteCommand, model, Messages.MESSAGE_INVALID_TAG_DISPLAYED_INDEX);
+        assertCommandFailure(untagCommand, model, Messages.MESSAGE_INVALID_TAG_DISPLAYED_INDEX);
     }
 
     @Test
     public void execute_validIndexFilteredList_success() {
         showTagAtIndex(model, INDEX_FIRST_TAG);
 
-        Tag personToDelete = model.getFilteredTagList().get(INDEX_FIRST_TAG.getZeroBased());
-        DeleteCommand deleteCommand = new DeleteCommand(INDEX_FIRST_TAG);
+        Tag tagToDelete = model.getFilteredTagList().get(INDEX_FIRST_TAG.getZeroBased());
+        UntagCommand untagCommand = new UntagCommand(INDEX_FIRST_TAG);
 
-        String expectedMessage = String.format(DeleteCommand.MESSAGE_DELETE_TAG_SUCCESS, personToDelete);
+        String expectedMessage = String.format(untagCommand.MESSAGE_UNTAG_TAG_SUCCESS, tagToDelete);
 
         Model expectedModel = new ModelManager(model.getAddressBook(), new UserPrefs());
-        expectedModel.deleteTag(personToDelete);
+        expectedModel.deleteTag(tagToDelete);
         showNoTag(expectedModel);
 
-        assertCommandSuccess(deleteCommand, model, expectedMessage, expectedModel);
+        assertCommandSuccess(untagCommand, model, expectedMessage, expectedModel);
     }
 
     @Test
@@ -71,21 +71,21 @@ public void execute_invalidIndexFilteredList_throwsCommandException() {
         // ensures that outOfBoundIndex is still in bounds of address book list
         assertTrue(outOfBoundIndex.getZeroBased() < model.getAddressBook().getTagList().size());
 
-        DeleteCommand deleteCommand = new DeleteCommand(outOfBoundIndex);
+        UntagCommand untagCommand = new UntagCommand(outOfBoundIndex);
 
-        assertCommandFailure(deleteCommand, model, Messages.MESSAGE_INVALID_TAG_DISPLAYED_INDEX);
+        assertCommandFailure(untagCommand, model, Messages.MESSAGE_INVALID_TAG_DISPLAYED_INDEX);
     }
 
     @Test
     public void equals() {
-        DeleteCommand deleteFirstCommand = new DeleteCommand(INDEX_FIRST_TAG);
-        DeleteCommand deleteSecondCommand = new DeleteCommand(INDEX_SECOND_TAG);
+        UntagCommand deleteFirstCommand = new UntagCommand(INDEX_FIRST_TAG);
+        UntagCommand deleteSecondCommand = new UntagCommand(INDEX_SECOND_TAG);
 
         // same object -> returns true
         assertTrue(deleteFirstCommand.equals(deleteFirstCommand));
 
         // same values -> returns true
-        DeleteCommand deleteFirstCommandCopy = new DeleteCommand(INDEX_FIRST_TAG);
+        UntagCommand deleteFirstCommandCopy = new UntagCommand(INDEX_FIRST_TAG);
         assertTrue(deleteFirstCommand.equals(deleteFirstCommandCopy));
 
         // different types -> returns false

src/test/java/seedu/address/logic/parser/AddressBookParserTest.java

@@ -15,11 +15,11 @@
 
 import seedu.address.logic.commands.AddCommand;
 import seedu.address.logic.commands.ClearCommand;
-import seedu.address.logic.commands.DeleteCommand;
 import seedu.address.logic.commands.ExitCommand;
 import seedu.address.logic.commands.FindCommand;
 import seedu.address.logic.commands.HelpCommand;
 import seedu.address.logic.commands.ListCommand;
+import seedu.address.logic.commands.UntagCommand;
 import seedu.address.logic.parser.exceptions.ParseException;
 import seedu.address.model.tag.Tag;
 import seedu.address.model.tag.TagNameContainsKeywordsPredicate;
@@ -44,10 +44,10 @@ public void parseCommand_clear() throws Exception {
     }
 
     @Test
-    public void parseCommand_delete() throws Exception {
-        DeleteCommand command = (DeleteCommand) parser.parseCommand(
-                DeleteCommand.COMMAND_WORD + " " + INDEX_FIRST_TAG.getOneBased());
-        assertEquals(new DeleteCommand(INDEX_FIRST_TAG), command);
+    public void parseCommand_untag() throws Exception {
+        UntagCommand command = (UntagCommand) parser.parseCommand(
+                UntagCommand.COMMAND_WORD + " " + INDEX_FIRST_TAG.getOneBased());
+        assertEquals(new UntagCommand(INDEX_FIRST_TAG), command);
     }
 
     @Test

src/test/java/seedu/address/logic/parser/DeleteCommandParserTest.java renamed to src/test/java/seedu/address/logic/parser/UntagCommandParserTest.java

@@ -7,26 +7,26 @@
 
 import org.junit.jupiter.api.Test;
 
-import seedu.address.logic.commands.DeleteCommand;
+import seedu.address.logic.commands.UntagCommand;
 
 /**
  * As we are only doing white-box testing, our test cases do not cover path variations
- * outside of the DeleteCommand code. For example, inputs "1" and "1 abc" take the
- * same path through the DeleteCommand, and therefore we test only one of them.
+ * outside of the UntagCommand code. For example, inputs "1" and "1 abc" take the
+ * same path through the UntagCommand, and therefore we test only one of them.
  * The path variation for those two cases occur inside the ParserUtil, and
  * therefore should be covered by the ParserUtilTest.
  */
-public class DeleteCommandParserTest {
+public class UntagCommandParserTest {
 
-    private DeleteCommandParser parser = new DeleteCommandParser();
+    private UntagCommandParser parser = new UntagCommandParser();
 
     @Test
-    public void parse_validArgs_returnsDeleteCommand() {
-        assertParseSuccess(parser, "1", new DeleteCommand(INDEX_FIRST_TAG));
+    public void parse_validArgs_returnsUntagCommand() {
+        assertParseSuccess(parser, "1", new UntagCommand(INDEX_FIRST_TAG));
     }
 
     @Test
     public void parse_invalidArgs_throwsParseException() {
-        assertParseFailure(parser, "a", String.format(MESSAGE_INVALID_COMMAND_FORMAT, DeleteCommand.MESSAGE_USAGE));
+        assertParseFailure(parser, "a", String.format(MESSAGE_INVALID_COMMAND_FORMAT, UntagCommand.MESSAGE_USAGE));
     }
 }