Add add/delete function to TagCommand #52

YeoBohShin · 2023-10-12T06:13:46Z

Users can now add/delete specific tags from students, instead of always replacing tags with a new set of tags

Instead of replacing all tags with user inputed tags, now user can add and delete individual tags from the student. However, users can still mass delete or replace using the old function.

codecov · 2023-10-12T06:15:36Z

Codecov Report

Merging #52 (cc80a53) into master (1b7f8d4) will increase coverage by 0.45%.
The diff coverage is 94.20%.

@@             Coverage Diff              @@
##             master      #52      +/-   ##
============================================
+ Coverage     76.55%   77.01%   +0.45%     
- Complexity      468      478      +10     
============================================
  Files            74       76       +2     
  Lines          1497     1540      +43     
  Branches        151      152       +1     
============================================
+ Hits           1146     1186      +40     
- Misses          306      308       +2     
- Partials         45       46       +1

Files	Coverage Δ
src/main/java/seedu/address/logic/Messages.java	`88.88% <100.00%> (ø)`
...va/seedu/address/logic/commands/AddTagCommand.java	`100.00% <100.00%> (ø)`
...seedu/address/logic/commands/DeleteTagCommand.java	`100.00% <100.00%> (ø)`
...ain/java/seedu/address/logic/parser/CliSyntax.java	`87.50% <100.00%> (ø)`
...n/java/seedu/address/model/person/ClassNumber.java	`92.85% <ø> (ø)`
.../java/seedu/address/model/util/SampleDataUtil.java	`20.00% <ø> (ø)`
...u/address/storage/JsonSerializableAddressBook.java	`100.00% <100.00%> (ø)`
.../java/seedu/address/logic/commands/TagCommand.java	`93.54% <94.11%> (+0.95%)`	⬆️
...a/seedu/address/logic/parser/TagCommandParser.java	`71.42% <66.66%> (-11.91%)`	⬇️

Added test cases for adding and deleting tags to ensure that it is working as intended.

ChangruHenryQian

Overall, solid effort for add/delete function to TagCommand. Great job!
Would it be possible for you to make the code pass the Java CI?

ChangruHenryQian · 2023-10-13T01:11:37Z

src/test/java/seedu/address/logic/commands/DeleteTagCommandTest.java

+package seedu.address.logic.commands;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static seedu.address.logic.commands.CommandTestUtil.VALID_TAG_FRIENDS;
+import static seedu.address.logic.commands.CommandTestUtil.assertCommandFailure;
+import static seedu.address.logic.commands.CommandTestUtil.assertCommandSuccess;
+import static seedu.address.logic.commands.CommandTestUtil.showPersonAtIndex;
+import static seedu.address.testutil.TypicalIndexes.INDEX_FIRST_PERSON;
+import static seedu.address.testutil.TypicalIndexes.INDEX_SECOND_PERSON;
+import static seedu.address.testutil.TypicalPersons.getTypicalAddressBook;
+
+import java.util.Set;
+
+import org.junit.jupiter.api.Test;
+
+import seedu.address.commons.core.index.Index;
+import seedu.address.logic.Messages;
+import seedu.address.model.AddressBook;
+import seedu.address.model.Model;
+import seedu.address.model.ModelManager;
+import seedu.address.model.UserPrefs;
+import seedu.address.model.person.Person;
+import seedu.address.model.tag.Tag;
+import seedu.address.model.util.SampleDataUtil;
+import seedu.address.testutil.PersonBuilder;
+import seedu.address.testutil.TypicalPersons;
+
+public class DeleteTagCommandTest {
+
+    private Model model = new ModelManager(getTypicalAddressBook(), new UserPrefs());
+
+    @Test
+    public void execute_deleteTag_success() {
+        Person editedStudent = new PersonBuilder(model.getFilteredPersonList().get(1))
+            .withTags(VALID_TAG_FRIENDS).build();
+        Set<Tag> tagToDelete = SampleDataUtil.getTagSet("owesMoney");
+        DeleteTagCommand deleteTagCommand = new DeleteTagCommand(INDEX_SECOND_PERSON,
+            tagToDelete);
+
+        String expectedMessage = String.format(TagCommand.MESSAGE_DELETE_TAG_SUCCESS,
+            editedStudent.getName()) + tagToDelete;
+
+        Model expectedModel = new ModelManager(new AddressBook(model.getAddressBook()), new UserPrefs());
+        expectedModel.setPerson(model.getFilteredPersonList().get(1), editedStudent);
+
+        assertCommandSuccess(deleteTagCommand, model, expectedMessage, expectedModel);
+        assertEquals(editedStudent.getTags(), model.getFilteredPersonList().get(1).getTags());
+    }
+
+    @Test
+    public void execute_indexOutOfBound_failure() {
+        showPersonAtIndex(model, INDEX_FIRST_PERSON);
+        Index outOfBoundIndex = INDEX_SECOND_PERSON;
+
+        assertTrue(outOfBoundIndex.getZeroBased() < model.getAddressBook().getPersonList().size());
+
+        DeleteTagCommand deleteTagCommand = new DeleteTagCommand(outOfBoundIndex, TypicalPersons.ALICE.getTags());
+
+        assertCommandFailure(deleteTagCommand, model, Messages.MESSAGE_INVALID_PERSON_DISPLAYED_INDEX);
+    }
+
+    @Test
+    public void equals() {
+        final DeleteTagCommand standardCommand = new DeleteTagCommand(INDEX_FIRST_PERSON,
+            TypicalPersons.ALICE.getTags());
+
+        DeleteTagCommand commandWithSameValue = new DeleteTagCommand(INDEX_FIRST_PERSON,
+            SampleDataUtil.getTagSet(VALID_TAG_FRIENDS));
+
+        assertTrue(standardCommand.equals(commandWithSameValue));
+
+        assertTrue(standardCommand.equals(standardCommand));
+
+        assertFalse(standardCommand.equals(null));
+
+        assertFalse(standardCommand.equals(new ClearCommand()));
+    }
+
+    @Test
+    public void toStringMethod() {
+        Index targetIndex = Index.fromOneBased(1);
+        DeleteTagCommand deleteTagCommand = new DeleteTagCommand(targetIndex, TypicalPersons.ALICE.getTags());
+        String expected = DeleteTagCommand.class.getCanonicalName() + "{tags=" + TypicalPersons.ALICE.getTags() + "}";
+        assertEquals(expected, deleteTagCommand.toString());
+    }
+}


I like your effort on sufficient testing on deleting tests.

ChangruHenryQian · 2023-10-13T01:14:44Z

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

+package seedu.address.logic.commands;
+
+import static seedu.address.logic.Messages.MESSAGE_INVALID_PERSON_DISPLAYED_INDEX;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import seedu.address.commons.core.index.Index;
+import seedu.address.logic.commands.exceptions.CommandException;
+import seedu.address.model.Model;
+import seedu.address.model.person.Person;
+import seedu.address.model.tag.Tag;
+
+/**
+ * Deletes the tags of an existing student in the address book.
+ */
+public class DeleteTagCommand extends TagCommand {
+
+    public DeleteTagCommand(Index index, Set<Tag> tags) {
+        super(index, tags);
+    }
+
+    @Override
+    public CommandResult execute(Model model) throws CommandException {
+        List<Person> lastShownList = model.getFilteredPersonList();
+
+        if (index.getZeroBased() >= lastShownList.size()) {
+            throw new CommandException(MESSAGE_INVALID_PERSON_DISPLAYED_INDEX);
+        }
+
+        Person personToEdit = lastShownList.get(index.getZeroBased());
+        Set<Tag> newTags = deleteTags(personToEdit.getTags(), super.tags);
+        Person editedPerson = new Person(
+                personToEdit.getName(), personToEdit.getPhone(), personToEdit.getEmail(),
+                personToEdit.getAddress(), newTags);
+
+        model.setPerson(personToEdit, editedPerson);
+        model.updateFilteredPersonList(Model.PREDICATE_SHOW_ALL_PERSONS);
+
+        return new CommandResult(generateSuccessMessage(editedPerson));
+    }
+
+    private Set<Tag> deleteTags(Set<Tag> studentTags, Set<Tag> tagsToDelete) {
+        Set<Tag> newTags = new HashSet<>(studentTags);
+        newTags.removeAll(tagsToDelete);
+        return newTags;
+    }
+
+    private String generateSuccessMessage(Person personToEdit) {
+        return String.format(MESSAGE_DELETE_TAG_SUCCESS, personToEdit.getName()) + tags;
+    }
+}


Clear and neat implementation of the deleteTagCommand Class.

Updated TagCommand to tag students by specifying their student number instead of index. This allows TAs to efficiently tag students instead of searching through the list the find the index of the student.

Update tagCommand in UserGuide to follow the updated tagcommand

LWZ19

LGTM.

YeoBohShin added 3 commits October 8, 2023 13:54

Do tutorial for adding command

53a89e2

Merge branch 'tutorial-adding-command'

de482f2

Added add/delete function to TagCommand

ba2631a

Instead of replacing all tags with user inputed tags, now user can add and delete individual tags from the student. However, users can still mass delete or replace using the old function.

YeoBohShin added 4 commits October 12, 2023 15:43

Add test cases for Add/Delete TagCommand

cd70742

Added test cases for adding and deleting tags to ensure that it is working as intended.

Merge branch 'master' into master

a0d6ba2

Fix merge conflict

821e0fd

Merge branch 'branch-tagcommand'

a7a8939

ChangruHenryQian reviewed Oct 13, 2023

View reviewed changes

ChangruHenryQian modified the milestone: v1.2 Oct 13, 2023

YeoBohShin added 3 commits October 13, 2023 17:52

Update TagCommand

511c113

Updated TagCommand to tag students by specifying their student number instead of index. This allows TAs to efficiently tag students instead of searching through the list the find the index of the student.

Update UserGuide.md

431b37c

Update tagCommand in UserGuide to follow the updated tagcommand

Merge branch 'master' into master

cc80a53

LWZ19 approved these changes Oct 13, 2023

View reviewed changes

LWZ19 merged commit 5827476 into AY2324S1-CS2103T-T11-1:master Oct 13, 2023
5 checks passed

ngeeyonglim added type.Story A user story priority.High Must do labels Oct 14, 2023

ngeeyonglim added this to the v1.2 milestone Oct 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add add/delete function to TagCommand #52

Add add/delete function to TagCommand #52

YeoBohShin commented Oct 12, 2023

codecov bot commented Oct 12, 2023 •

edited

Loading

ChangruHenryQian left a comment

ChangruHenryQian Oct 13, 2023

ChangruHenryQian Oct 13, 2023

LWZ19 left a comment

Add add/delete function to TagCommand #52

Add add/delete function to TagCommand #52

Conversation

YeoBohShin commented Oct 12, 2023

codecov bot commented Oct 12, 2023 • edited Loading

Codecov Report

ChangruHenryQian left a comment

Choose a reason for hiding this comment

ChangruHenryQian Oct 13, 2023

Choose a reason for hiding this comment

ChangruHenryQian Oct 13, 2023

Choose a reason for hiding this comment

LWZ19 left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 12, 2023 •

edited

Loading