Merge pull request nus-cs2103-AY2021S1#79 from chrystalquek/update-find-command-person

Allow for search of contacts by both Name and Description

Author: chrystalquek

src/main/java/seedu/address/logic/commands/person/FindCommand.java

@@ -5,7 +5,7 @@
 import seedu.address.commons.core.Messages;
 import seedu.address.logic.commands.CommandResult;
 import seedu.address.model.person.ModelPerson;
-import seedu.address.model.person.person.NameContainsKeywordsPredicate;
+import seedu.address.model.person.person.NameDescriptionContainsKeywordsPredicate;
 
 /**
  * Finds and lists all persons in address book whose name contains any of the argument keywords.
@@ -15,14 +15,15 @@ public class FindCommand extends Command {
 
     public static final String COMMAND_WORD = "find";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose names contain any of "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose names and/or "
+            + "descriptions contain 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 + " alice bob charlie";
+            + "Example: " + COMMAND_WORD + " alice bob user";
 
-    private final NameContainsKeywordsPredicate predicate;
+    private final NameDescriptionContainsKeywordsPredicate predicate;
 
-    public FindCommand(NameContainsKeywordsPredicate predicate) {
+    public FindCommand(NameDescriptionContainsKeywordsPredicate predicate) {
         this.predicate = predicate;
     }
 

src/main/java/seedu/address/logic/parser/person/FindCommandParser.java

@@ -7,7 +7,7 @@
 import seedu.address.logic.commands.person.FindCommand;
 import seedu.address.logic.parser.Parser;
 import seedu.address.logic.parser.exceptions.ParseException;
-import seedu.address.model.person.person.NameContainsKeywordsPredicate;
+import seedu.address.model.person.person.NameDescriptionContainsKeywordsPredicate;
 
 /**
  * Parses input arguments and creates a new FindCommand object
@@ -28,7 +28,7 @@ public FindCommand parse(String args) throws ParseException {
 
         String[] nameKeywords = trimmedArgs.split("\\s+");
 
-        return new FindCommand(new NameContainsKeywordsPredicate(Arrays.asList(nameKeywords)));
+        return new FindCommand(new NameDescriptionContainsKeywordsPredicate(Arrays.asList(nameKeywords)));
     }
 
 }

src/main/java/seedu/address/logic/parser/person/ParserUtil.java

@@ -65,16 +65,6 @@ public static Phone parsePhone(Optional<String> phone) throws ParseException {
         return new Phone(trimmedPhone);
     }
 
-    /**
-     * Parses a {@code String phone} into a {@code Phone}.
-     * Leading and trailing whitespaces will be trimmed.
-     *
-     * @throws ParseException if the given {@code phone} is invalid.
-     */
-    public static Phone parsePhone(String phone) throws ParseException {
-        return parsePhone(Optional.of(phone));
-    }
-
     /**
      * Parses a {@code String email} into an {@code Email}.
      * Leading and trailing whitespaces will be trimmed.

src/main/java/seedu/address/model/person/person/NameContainsKeywordsPredicate.java renamed to src/main/java/seedu/address/model/person/person/NameDescriptionContainsKeywordsPredicate.java

@@ -8,24 +8,25 @@
 /**
  * Tests that a {@code Person}'s {@code Name} matches any of the keywords given.
  */
-public class NameContainsKeywordsPredicate implements Predicate<Person> {
+public class NameDescriptionContainsKeywordsPredicate implements Predicate<Person> {
     private final List<String> keywords;
 
-    public NameContainsKeywordsPredicate(List<String> keywords) {
+    public NameDescriptionContainsKeywordsPredicate(List<String> keywords) {
         this.keywords = keywords;
     }
 
     @Override
     public boolean test(Person person) {
         return keywords.stream()
-                .anyMatch(keyword -> StringUtil.containsWordIgnoreCase(person.getName().fullName, keyword));
+                .anyMatch(keyword -> StringUtil.containsWordIgnoreCase(person.getName().fullName, keyword)
+                        || StringUtil.containsWordIgnoreCase(person.getDescription().value.orElse(""), keyword));
     }
 
     @Override
     public boolean equals(Object other) {
         return other == this // short circuit if same object
-                || (other instanceof NameContainsKeywordsPredicate // instanceof handles nulls
-                && keywords.equals(((NameContainsKeywordsPredicate) other).keywords)); // state check
+                || (other instanceof NameDescriptionContainsKeywordsPredicate // instanceof handles nulls
+                && keywords.equals(((NameDescriptionContainsKeywordsPredicate) other).keywords)); // state check
     }
 
 }

src/main/java/seedu/address/model/util/SampleDataUtil.java

@@ -1,5 +1,7 @@
 package seedu.address.model.util;
 
+import java.util.Optional;
+
 import seedu.address.model.deliverable.DeliverableBook;
 import seedu.address.model.deliverable.ReadOnlyDeliverableBook;
 import seedu.address.model.deliverable.deliverable.Deadline;
@@ -28,13 +30,13 @@ public static Person[] getSamplePersons() {
             new Person(new Name("Alex Yeoh"), new Phone("87438807"), new Email("[email protected]"),
                     Role.getRole("stk"), new OptionalDescription("End user")),
             new Person(new Name("Bernice Yu"), new Phone("99272758"), new Email("[email protected]"),
-                    Role.getRole("stk"), new OptionalDescription("End user")),
+                    Role.getRole("dev"), new OptionalDescription("Frontend Engineer")),
             new Person(new Name("Charlotte Oliveiro"), new Phone("93210283"), new Email("[email protected]"),
-                    Role.getRole("stk"), new OptionalDescription("End user")),
-            new Person(new Name("David Li"), new Phone("91031282"), new Email("[email protected]"),
-                    Role.getRole("stk"), new OptionalDescription("End user")),
-            new Person(new Name("Irfan Ibrahim"), new Phone("92492021"), new Email("[email protected]"),
-                    Role.getRole("stk"), new OptionalDescription("End user")),
+                    Role.getRole("stk"), new OptionalDescription("Business analyst")),
+            new Person(new Name("David Li"), new Phone(Optional.empty()), new Email("[email protected]"),
+                    Role.getRole("dev"), new OptionalDescription("Backend Engineer")),
+            new Person(new Name("Irfan Ibrahim"), new Phone(Optional.empty()), new Email("[email protected]"),
+                    Role.getRole("stk"), new OptionalDescription(Optional.empty())),
             new Person(new Name("Roy Balakrishnan"), new Phone("92624417"), new Email("[email protected]"),
                     Role.getRole("stk"), new OptionalDescription("End user"))
         };

src/test/data/JsonSerializableAddressBookTest/typicalPersonsAddressBook.json

@@ -16,9 +16,9 @@
       "value": "98765432"
     },
     "email" : "[email protected]",
-    "role": "stk",
+    "role": "dev",
     "description": {
-      "value" : "Admin personnel"
+      "value" : "Frontend engineer"
     }
   }, {
     "name" : "Carl Kurz",
@@ -28,22 +28,22 @@
     "email" : "[email protected]",
     "role": "stk",
     "description": {
-      "value" : null
+      "value" : "Business analyst"
     }
   }, {
     "name" : "Daniel Meier",
     "phone" : {
-      "value": "87652533"
+      "value": null
     },
     "email" : "[email protected]",
-    "role": "stk",
+    "role": "dev",
     "description": {
-      "value" : null
+      "value" : "Backend engineer"
     }
   }, {
     "name" : "Elle Meyer",
     "phone" : {
-      "value": "9482224"
+      "value": null
     },
     "email" : "[email protected]",
     "role": "stk",
@@ -58,17 +58,17 @@
     "email" : "[email protected]",
     "role": "stk",
     "description": {
-      "value" : null
+      "value" : "Product designer, Kurz work partner"
     }
   }, {
     "name" : "George Best",
     "phone" : {
-      "value": "9482442"
+      "value": null
     },
     "email" : "[email protected]",
     "role": "stk",
     "description": {
-      "value" : null
+      "value" : "Secondary user"
     }
   } ]
 }

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

@@ -7,7 +7,7 @@
 import static seedu.address.logic.commands.person.CommandTestUtil.EMAIL_DESC_AMY;
 import static seedu.address.logic.commands.person.CommandTestUtil.NAME_DESC_AMY;
 import static seedu.address.logic.commands.person.CommandTestUtil.PHONE_DESC_AMY;
-import static seedu.address.logic.commands.person.CommandTestUtil.ROLE_DESC_STK;
+import static seedu.address.logic.commands.person.CommandTestUtil.ROLE_DESC_AMY;
 import static seedu.address.testutil.Assert.assertThrows;
 import static seedu.address.testutil.TypicalPersons.AMY;
 
@@ -81,7 +81,7 @@ public void execute_storageThrowsIoException_throwsCommandException() {
 
         // Execute add command
         String addCommand =
-                AddCommand.COMMAND_WORD + ROLE_DESC_STK + NAME_DESC_AMY + PHONE_DESC_AMY + EMAIL_DESC_AMY
+                AddCommand.COMMAND_WORD + ROLE_DESC_AMY + NAME_DESC_AMY + PHONE_DESC_AMY + EMAIL_DESC_AMY
                         + DESCRIPTION_DESC_AMY;
         Person expectedPerson = new PersonBuilder(AMY).build();
         ModelPersonManager expectedModel = new ModelPersonManager();

src/test/java/seedu/address/logic/commands/person/CommandTestUtil.java

@@ -18,7 +18,7 @@
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.person.AddressBook;
 import seedu.address.model.person.ModelPerson;
-import seedu.address.model.person.person.NameContainsKeywordsPredicate;
+import seedu.address.model.person.person.NameDescriptionContainsKeywordsPredicate;
 import seedu.address.model.person.person.Person;
 import seedu.address.testutil.EditPersonDescriptorBuilder;
 
@@ -33,19 +33,19 @@ public class CommandTestUtil {
     public static final String VALID_PHONE_BOB = "22222222";
     public static final String VALID_EMAIL_AMY = "[email protected]";
     public static final String VALID_EMAIL_BOB = "[email protected]";
-    public static final String VALID_ROLE_DEV = "dev";
-    public static final String VALID_ROLE_STK = "stk";
+    public static final String VALID_ROLE_AMY = "stk";
+    public static final String VALID_ROLE_BOB = "dev";
     public static final String VALID_DESCRIPTION_AMY = "End user";
-    public static final String VALID_DESCRIPTION_BOB = "Admin personnel";
+    public static final String VALID_DESCRIPTION_BOB = "Frontend engineer";
 
     public static final String NAME_DESC_AMY = " " + PREFIX_NAME + VALID_NAME_AMY;
     public static final String NAME_DESC_BOB = " " + PREFIX_NAME + VALID_NAME_BOB;
     public static final String PHONE_DESC_AMY = " " + PREFIX_PHONE + VALID_PHONE_AMY;
     public static final String PHONE_DESC_BOB = " " + PREFIX_PHONE + VALID_PHONE_BOB;
     public static final String EMAIL_DESC_AMY = " " + PREFIX_EMAIL + VALID_EMAIL_AMY;
     public static final String EMAIL_DESC_BOB = " " + PREFIX_EMAIL + VALID_EMAIL_BOB;
-    public static final String ROLE_DESC_DEV = " " + PREFIX_ROLE + VALID_ROLE_DEV;
-    public static final String ROLE_DESC_STK = " " + PREFIX_ROLE + VALID_ROLE_STK;
+    public static final String ROLE_DESC_AMY = " " + PREFIX_ROLE + VALID_ROLE_AMY;
+    public static final String ROLE_DESC_BOB = " " + PREFIX_ROLE + VALID_ROLE_BOB;
     public static final String DESCRIPTION_DESC_AMY = " " + PREFIX_DESCRIPTION + VALID_DESCRIPTION_AMY;
     public static final String DESCRIPTION_DESC_BOB = " " + PREFIX_DESCRIPTION + VALID_DESCRIPTION_BOB;
 
@@ -121,7 +121,7 @@ public static void showPersonAtIndex(ModelPerson modelPerson, Index targetIndex)
 
         Person person = modelPerson.getFilteredPersonList().get(targetIndex.getZeroBased());
         final String[] splitName = person.getName().fullName.split("\\s+");
-        modelPerson.updateFilteredPersonList(new NameContainsKeywordsPredicate(Arrays.asList(splitName[0])));
+        modelPerson.updateFilteredPersonList(new NameDescriptionContainsKeywordsPredicate(Arrays.asList(splitName[0])));
 
         assertEquals(1, modelPerson.getFilteredPersonList().size());
     }

src/test/java/seedu/address/logic/commands/person/FindCommandTest.java

@@ -5,9 +5,11 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static seedu.address.commons.core.Messages.MESSAGE_PERSONS_LISTED_OVERVIEW;
 import static seedu.address.logic.commands.person.CommandTestUtil.assertCommandSuccess;
+import static seedu.address.testutil.TypicalPersons.ALICE;
 import static seedu.address.testutil.TypicalPersons.CARL;
 import static seedu.address.testutil.TypicalPersons.ELLE;
 import static seedu.address.testutil.TypicalPersons.FIONA;
+import static seedu.address.testutil.TypicalPersons.GEORGE;
 import static seedu.address.testutil.TypicalPersons.getTypicalAddressBook;
 
 import java.util.Arrays;
@@ -18,7 +20,7 @@
 import seedu.address.model.UserPrefs;
 import seedu.address.model.person.ModelPerson;
 import seedu.address.model.person.ModelPersonManager;
-import seedu.address.model.person.person.NameContainsKeywordsPredicate;
+import seedu.address.model.person.person.NameDescriptionContainsKeywordsPredicate;
 
 /**
  * Contains integration tests (interaction with the Model) for {@code FindCommand}.
@@ -29,10 +31,10 @@ public class FindCommandTest {
 
     @Test
     public void equals() {
-        NameContainsKeywordsPredicate firstPredicate =
-                new NameContainsKeywordsPredicate(Collections.singletonList("first"));
-        NameContainsKeywordsPredicate secondPredicate =
-                new NameContainsKeywordsPredicate(Collections.singletonList("second"));
+        NameDescriptionContainsKeywordsPredicate firstPredicate =
+                new NameDescriptionContainsKeywordsPredicate(Collections.singletonList("first"));
+        NameDescriptionContainsKeywordsPredicate secondPredicate =
+                new NameDescriptionContainsKeywordsPredicate(Collections.singletonList("second"));
 
         FindCommand findFirstCommand = new FindCommand(firstPredicate);
         FindCommand findSecondCommand = new FindCommand(secondPredicate);
@@ -57,27 +59,48 @@ public void equals() {
     @Test
     public void execute_zeroKeywords_noPersonFound() {
         String expectedMessage = String.format(MESSAGE_PERSONS_LISTED_OVERVIEW, 0);
-        NameContainsKeywordsPredicate predicate = preparePredicate(" ");
+        NameDescriptionContainsKeywordsPredicate predicate = preparePredicate(" ");
         FindCommand command = new FindCommand(predicate);
         expectedModelPerson.updateFilteredPersonList(predicate);
         assertCommandSuccess(command, modelPerson, expectedMessage, expectedModelPerson);
         assertEquals(Collections.emptyList(), modelPerson.getFilteredPersonList());
     }
 
     @Test
-    public void execute_multipleKeywords_multiplePersonsFound() {
+    public void execute_multipleNameKeywords_multiplePersonsFound() {
         String expectedMessage = String.format(MESSAGE_PERSONS_LISTED_OVERVIEW, 3);
-        NameContainsKeywordsPredicate predicate = preparePredicate("Kurz Elle Kunz");
+        NameDescriptionContainsKeywordsPredicate predicate = preparePredicate("Kurz Elle Kunz");
         FindCommand command = new FindCommand(predicate);
         expectedModelPerson.updateFilteredPersonList(predicate);
         assertCommandSuccess(command, modelPerson, expectedMessage, expectedModelPerson);
         assertEquals(Arrays.asList(CARL, ELLE, FIONA), modelPerson.getFilteredPersonList());
     }
 
+    @Test
+    public void execute_multipleDescriptionKeywords_multiplePersonsFound() {
+        String expectedMessage = String.format(MESSAGE_PERSONS_LISTED_OVERVIEW, 3);
+        NameDescriptionContainsKeywordsPredicate predicate = preparePredicate("user business analyst");
+        FindCommand command = new FindCommand(predicate);
+        expectedModelPerson.updateFilteredPersonList(predicate);
+        assertCommandSuccess(command, modelPerson, expectedMessage, expectedModelPerson);
+        assertEquals(Arrays.asList(ALICE, CARL, GEORGE), modelPerson.getFilteredPersonList());
+    }
+
+    @Test
+    public void execute_multipleNameDescriptionKeywords_multiplePersonsFound() {
+        String expectedMessage = String.format(MESSAGE_PERSONS_LISTED_OVERVIEW, 4);
+        NameDescriptionContainsKeywordsPredicate predicate = preparePredicate("Kurz user");
+        FindCommand command = new FindCommand(predicate);
+        expectedModelPerson.updateFilteredPersonList(predicate);
+        assertCommandSuccess(command, modelPerson, expectedMessage, expectedModelPerson);
+        // Fiona description contains "Kurz"
+        assertEquals(Arrays.asList(ALICE, CARL, FIONA, GEORGE), modelPerson.getFilteredPersonList());
+    }
+
     /**
      * Parses {@code userInput} into a {@code NameContainsKeywordsPredicate}.
      */
-    private NameContainsKeywordsPredicate preparePredicate(String userInput) {
-        return new NameContainsKeywordsPredicate(Arrays.asList(userInput.split("\\s+")));
+    private NameDescriptionContainsKeywordsPredicate preparePredicate(String userInput) {
+        return new NameDescriptionContainsKeywordsPredicate(Arrays.asList(userInput.split("\\s+")));
     }
 }