Merge pull request nus-cs2103-AY2021S1#86 from luo-git/Branch-TagCommand

Modify AddCommand AddCommandParser to TagCommand and TagCommandParser

Author: li-s

src/main/java/seedu/address/Main.java

@@ -20,6 +20,6 @@
  */
 public class Main {
     public static void main(String[] args) {
-        Application.launch(MainApp.class, args);
+        Application.launch(NewMainApp.class, args);
     }
 }

src/main/java/seedu/address/logic/commands/AddCommand.java renamed to src/main/java/seedu/address/logic/commands/TagCommand.java

@@ -11,47 +11,54 @@
 /**
  * Adds a person to the address book.
  */
-public class AddCommand extends Command {
+public class TagCommand extends Command {
 
-    public static final String COMMAND_WORD = "add";
+    public static final String COMMAND_WORD = "tag";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a tag to the hello file. "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a tag to the HelleFile's address book. "
             + "Parameters: "
-            + PREFIX_TAG_NAME + "NAME "
-            + PREFIX_FILE_ADDRESS + "ADDRESS "
+            + PREFIX_TAG_NAME + "TAG_NAME "
+            + PREFIX_FILE_ADDRESS + "FILE_ADDRESS "
             + "Example: " + COMMAND_WORD + " "
-            + PREFIX_TAG_NAME + "John Doe "
-            + PREFIX_FILE_ADDRESS + "311, Clementi Ave 2, #02-25 ";
+            + PREFIX_TAG_NAME + "cs2103 "
+            + PREFIX_FILE_ADDRESS + "F:\\OneDrive\\CS2013T ";
 
     public static final String MESSAGE_SUCCESS = "New tag added: %1$s";
-    public static final String MESSAGE_DUPLICATE_TAG = "Tag duplicated!";
+    public static final String MESSAGE_DUPLICATE_TAG = "Duplicate tag name!";
 
-    private final Tag toAdd;
+    private final Tag toTag;
 
     /**
      * Creates an AddCommand to add the specified {@code Tag}
      */
-    public AddCommand(Tag tag) {
+    public TagCommand(Tag tag) {
         requireNonNull(tag);
-        toAdd = tag;
+        toTag = tag;
     }
 
+    /**
+     * Executes the command and add the tag to model.
+     *
+     * @param model {@code Model} which the command should operate on.
+     * @return A Command result of executing tag command.
+     * @throws CommandException
+     */
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);
 
-        if (model.hasTag(toAdd)) {
+        if (model.hasTag(toTag)) {
             throw new CommandException(MESSAGE_DUPLICATE_TAG);
         }
 
-        model.addTag(toAdd);
-        return new CommandResult(String.format(MESSAGE_SUCCESS, toAdd));
+        model.addTag(toTag);
+        return new CommandResult(String.format(MESSAGE_SUCCESS, toTag));
     }
 
     @Override
     public boolean equals(Object other) {
         return other == this // short circuit if same object
-                || (other instanceof AddCommand // instanceof handles nulls
-                && toAdd.equals(((AddCommand) other).toAdd));
+                || (other instanceof TagCommand // instanceof handles nulls
+                && toTag.equals(((TagCommand) other).toTag));
     }
 }

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

@@ -6,13 +6,13 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import seedu.address.logic.commands.AddCommand;
 import seedu.address.logic.commands.ClearCommand;
 import seedu.address.logic.commands.Command;
 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.TagCommand;
 import seedu.address.logic.commands.UntagCommand;
 import seedu.address.logic.parser.exceptions.ParseException;
 
@@ -43,8 +43,8 @@ public Command parseCommand(String userInput) throws ParseException {
         final String arguments = matcher.group("arguments");
         switch (commandWord) {
 
-        case AddCommand.COMMAND_WORD:
-            return new AddCommandParser().parse(arguments);
+        case TagCommand.COMMAND_WORD:
+            return new TagCommandParser().parse(arguments);
 
         case UntagCommand.COMMAND_WORD:
             return new UntagCommandParser().parse(arguments);

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

@@ -2,7 +2,7 @@
 
 /**
  * A prefix that marks the beginning of an argument in an arguments string.
- * E.g. 't/' in 'add James t/ friend'.
+ * E.g. 't/' in 'tag f/C:/abc.txt t/myFile'.
  */
 public class Prefix {
     private final String prefix;

src/main/java/seedu/address/logic/parser/AddCommandParser.java renamed to src/main/java/seedu/address/logic/parser/TagCommandParser.java

@@ -1,14 +1,12 @@
 package seedu.address.logic.parser;
 
 import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_COMMAND;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_FILE_ADDRESS;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_OLD_TAG_NAME;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG_NAME;
 
 import java.util.stream.Stream;
 
-import seedu.address.logic.commands.AddCommand;
+import seedu.address.logic.commands.TagCommand;
 import seedu.address.logic.parser.exceptions.ParseException;
 import seedu.address.model.tag.FileAddress;
 import seedu.address.model.tag.Tag;
@@ -17,32 +15,28 @@
 /**
  * Parses input arguments and creates a new AddCommand object
  */
-public class AddCommandParser implements Parser<AddCommand> {
+public class TagCommandParser implements Parser<TagCommand> {
 
     /**
-     * Parses the given {@code String} of arguments in the context of the AddCommand
-     * and returns an AddCommand object for execution.
+     * Parses the given {@code String} of arguments in the context of the TagCommand
+     * and returns an TagCommand object for execution.
      * @throws ParseException if the user input does not conform the expected format
      */
-    public AddCommand parse(String args) throws ParseException {
+    public TagCommand parse(String args) throws ParseException {
         ArgumentMultimap argMultimap =
-                ArgumentTokenizer.tokenize(args, PREFIX_TAG_NAME, PREFIX_FILE_ADDRESS,
-                        PREFIX_OLD_TAG_NAME, PREFIX_COMMAND);
+                ArgumentTokenizer.tokenize(args, PREFIX_TAG_NAME, PREFIX_FILE_ADDRESS);
 
         if (!arePrefixesPresent(argMultimap, PREFIX_TAG_NAME, PREFIX_FILE_ADDRESS)
                 || !argMultimap.getPreamble().isEmpty()) {
-            throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
+            throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, TagCommand.MESSAGE_USAGE));
         }
 
-
-
         TagName tagName = ParserUtil.parseTagName(argMultimap.getValue(PREFIX_TAG_NAME).get());
         FileAddress fileAddress = ParserUtil.parseFileAddress(argMultimap.getValue(PREFIX_FILE_ADDRESS).get());
 
         Tag tag = new Tag(tagName, fileAddress);
 
-
-        return new AddCommand(tag);
+        return new TagCommand(tag);
     }
 
     /**

src/main/java/seedu/address/model/tag/FileAddress.java

@@ -9,6 +9,7 @@
  */
 public class FileAddress {
 
+    // TODO change message to be more understandable
     public static final String MESSAGE_CONSTRAINTS = "File addresses can take any values, and it should not be blank";
 
     /*

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

@@ -15,9 +15,9 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
-import seedu.address.logic.commands.AddCommand;
 import seedu.address.logic.commands.CommandResult;
 import seedu.address.logic.commands.ListCommand;
+import seedu.address.logic.commands.TagCommand;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.logic.parser.exceptions.ParseException;
 import seedu.address.model.Model;
@@ -76,14 +76,14 @@ public void execute_storageThrowsIoException_throwsCommandException() {
         StorageManager storage = new StorageManager(addressBookStorage, userPrefsStorage);
         logic = new LogicManager(model, storage);
 
-        // Execute add command
-        String addCommand = AddCommand.COMMAND_WORD + NAME_DESC_AMY
+        // Execute tag command
+        String tagCommand = TagCommand.COMMAND_WORD + NAME_DESC_AMY
                 + FILE_ADDRESS_DESC_AMY;
         Tag expectedTag = new TagBuilder(AMY).build();
         ModelManager expectedModel = new ModelManager();
         expectedModel.addTag(expectedTag);
         String expectedMessage = LogicManager.FILE_OPS_ERROR_MESSAGE + DUMMY_IO_EXCEPTION;
-        assertCommandFailure(addCommand, CommandException.class, expectedMessage, expectedModel);
+        assertCommandFailure(tagCommand, CommandException.class, expectedMessage, expectedModel);
     }
 
     @Test

src/test/java/seedu/address/logic/commands/AddCommandIntegrationTest.java renamed to src/test/java/seedu/address/logic/commands/TagCommandIntegrationTest.java

@@ -16,7 +16,7 @@
 /**
  * Contains integration tests (interaction with the Model) for {@code AddCommand}.
  */
-public class AddCommandIntegrationTest {
+public class TagCommandIntegrationTest {
 
     private Model model;
 
@@ -27,19 +27,19 @@ public void setUp() {
 
     @Test
     public void execute_newTag_success() {
-        Tag validPerson = new TagBuilder().build();
+        Tag validTag = new TagBuilder().build();
 
         Model expectedModel = new ModelManager(model.getAddressBook(), new UserPrefs());
-        expectedModel.addTag(validPerson);
+        expectedModel.addTag(validTag);
 
-        assertCommandSuccess(new AddCommand(validPerson), model,
-                String.format(AddCommand.MESSAGE_SUCCESS, validPerson), expectedModel);
+        assertCommandSuccess(new TagCommand(validTag), model,
+                String.format(TagCommand.MESSAGE_SUCCESS, validTag), expectedModel);
     }
 
     @Test
     public void execute_duplicateTag_throwsCommandException() {
-        Tag personInList = model.getAddressBook().getTagList().get(0);
-        assertCommandFailure(new AddCommand(personInList), model, AddCommand.MESSAGE_DUPLICATE_TAG);
+        Tag tagInList = model.getAddressBook().getTagList().get(0);
+        assertCommandFailure(new TagCommand(tagInList), model, TagCommand.MESSAGE_DUPLICATE_TAG);
     }
 
 }

src/test/java/seedu/address/logic/commands/AddCommandTest.java renamed to src/test/java/seedu/address/logic/commands/TagCommandTest.java

@@ -11,6 +11,7 @@
 import java.util.Arrays;
 import java.util.function.Predicate;
 
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import javafx.collections.ObservableList;
@@ -23,55 +24,57 @@
 import seedu.address.model.tag.Tag;
 import seedu.address.testutil.TagBuilder;
 
-public class AddCommandTest {
+public class TagCommandTest {
 
     @Test
     public void constructor_nullTag_throwsNullPointerException() {
-        assertThrows(NullPointerException.class, () -> new AddCommand(null));
+        assertThrows(NullPointerException.class, () -> new TagCommand(null));
     }
 
     @Test
-    public void execute_tagAcceptedByModel_addSuccessful() throws Exception {
+    @Disabled
+    // This test is using the original idea of tagging person.
+    public void execute_tagAcceptedByModel_tagSuccessful() throws Exception {
         ModelStubAcceptingTagAdded modelStub = new ModelStubAcceptingTagAdded();
-        Tag validPerson = new TagBuilder().build();
+        Tag validTag = new TagBuilder().build();
 
-        CommandResult commandResult = new AddCommand(validPerson).execute(modelStub);
+        CommandResult commandResult = new TagCommand(validTag).execute(modelStub);
 
-        assertEquals(String.format(AddCommand.MESSAGE_SUCCESS, validPerson), commandResult.getFeedbackToUser());
-        assertEquals(Arrays.asList(validPerson), modelStub.tagsAdded);
+        assertEquals(String.format(TagCommand.MESSAGE_SUCCESS, validTag), commandResult.getFeedbackToUser());
+        assertEquals(Arrays.asList(validTag), modelStub.tagsAdded);
     }
 
     @Test
-    public void execute_duplicateTag_throwsCommandException() {
-        Tag validPerson = new TagBuilder().build();
-        AddCommand addCommand = new AddCommand(validPerson);
-        ModelStub modelStub = new ModelStubWithTag(validPerson);
+    public void execute_duplicateTagName_throwsCommandException() {
+        Tag validTag = new TagBuilder().build();
+        TagCommand tagCommand = new TagCommand(validTag);
+        ModelStub modelStub = new ModelStubWithTag(validTag);
 
-        assertThrows(CommandException.class, AddCommand.MESSAGE_DUPLICATE_TAG, () -> addCommand.execute(modelStub));
+        assertThrows(CommandException.class, TagCommand.MESSAGE_DUPLICATE_TAG, () -> tagCommand.execute(modelStub));
     }
 
     @Test
     public void equals() {
-        Tag alice = new TagBuilder().withTagName("Alice").build();
-        Tag bob = new TagBuilder().withTagName("Bob").build();
-        AddCommand addAliceCommand = new AddCommand(alice);
-        AddCommand addBobCommand = new AddCommand(bob);
+        Tag t1 = new TagBuilder().withTagName("cs2101").build();
+        Tag t2 = new TagBuilder().withTagName("cs2103").build();
+        TagCommand tagT1Command = new TagCommand(t1);
+        TagCommand tagT2Command = new TagCommand(t2);
 
         // same object -> returns true
-        assertTrue(addAliceCommand.equals(addAliceCommand));
+        assertTrue(tagT1Command.equals(tagT1Command));
 
         // same values -> returns true
-        AddCommand addAliceCommandCopy = new AddCommand(alice);
-        assertTrue(addAliceCommand.equals(addAliceCommandCopy));
+        TagCommand tagT1CommandCopy = new TagCommand(t1);
+        assertTrue(tagT1Command.equals(tagT1CommandCopy));
 
         // different types -> returns false
-        assertFalse(addAliceCommand.equals(1));
+        assertFalse(tagT1Command.equals(1));
 
         // null -> returns false
-        assertFalse(addAliceCommand.equals(null));
+        assertFalse(tagT1Command.equals(null));
 
         // different person -> returns false
-        assertFalse(addAliceCommand.equals(addBobCommand));
+        assertFalse(tagT1Command.equals(tagT2Command));
     }
 
     /**
@@ -150,7 +153,7 @@ public void updateFilteredTagList(Predicate<Tag> predicate) {
     }
 
     /**
-     * A Model stub that contains a single person.
+     * A Model stub that contains a single tag.
      */
     private class ModelStubWithTag extends ModelStub {
         private final Tag tag;
@@ -168,8 +171,9 @@ public boolean hasTag(Tag tag) {
     }
 
     /**
-     * A Model stub that always accept the person being added.
+     * A Model stub that always accept the tag being added.
      */
+    @Deprecated
     private class ModelStubAcceptingTagAdded extends ModelStub {
         final ArrayList<Tag> tagsAdded = new ArrayList<>();
 

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

@@ -13,12 +13,12 @@
 
 import org.junit.jupiter.api.Test;
 
-import seedu.address.logic.commands.AddCommand;
 import seedu.address.logic.commands.ClearCommand;
 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.TagCommand;
 import seedu.address.logic.commands.UntagCommand;
 import seedu.address.logic.parser.exceptions.ParseException;
 import seedu.address.model.tag.Tag;
@@ -33,8 +33,8 @@ public class AddressBookParserTest {
     @Test
     public void parseCommand_add() throws Exception {
         Tag person = new TagBuilder().build();
-        AddCommand command = (AddCommand) parser.parseCommand(TagUtil.getAddCommand(person));
-        assertEquals(new AddCommand(person), command);
+        TagCommand command = (TagCommand) parser.parseCommand(TagUtil.getTagCommand(person));
+        assertEquals(new TagCommand(person), command);
     }
 
     @Test