[W5][M11-3] Dannica Ong

src/seedu/addressbook/commands/AddCommand.java

@@ -4,13 +4,7 @@
 import java.util.Set;
 
 import seedu.addressbook.data.exception.IllegalValueException;
-import seedu.addressbook.data.person.Address;
-import seedu.addressbook.data.person.Email;
-import seedu.addressbook.data.person.Name;
-import seedu.addressbook.data.person.Person;
-import seedu.addressbook.data.person.Phone;
-import seedu.addressbook.data.person.ReadOnlyPerson;
-import seedu.addressbook.data.person.UniquePersonList;
+import seedu.addressbook.data.person.*;
 import seedu.addressbook.data.tag.Tag;
 
 /**
@@ -22,9 +16,9 @@ public class AddCommand extends Command {
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
             + "Contact details can be marked private by prepending 'p' to the prefix.\n"
-            + "Parameters: NAME [p]p/PHONE [p]e/EMAIL [p]a/ADDRESS  [t/TAG]...\n"
+            + "Parameters: NAME g/GENDER [p]p/PHONE [p]e/EMAIL [p]a/ADDRESS  [t/TAG]...\n"
             + "Example: " + COMMAND_WORD
-            + " John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 t/friends t/owesMoney";
+            + " John Doe g/M p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 t/friends t/owesMoney";
 
     public static final String MESSAGE_SUCCESS = "New person added: %1$s";
     public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book";
@@ -37,6 +31,7 @@ public class AddCommand extends Command {
      * @throws IllegalValueException if any of the raw values are invalid
      */
     public AddCommand(String name,
+                      String gender,
                       String phone, boolean isPhonePrivate,
                       String email, boolean isEmailPrivate,
                       String address, boolean isAddressPrivate,
@@ -47,6 +42,7 @@ public AddCommand(String name,
         }
         this.toAdd = new Person(
                 new Name(name),
+                new Gender(gender),
                 new Phone(phone, isPhonePrivate),
                 new Email(email, isEmailPrivate),
                 new Address(address, isAddressPrivate),

src/seedu/addressbook/data/person/Gender.java

@@ -0,0 +1,55 @@
+package seedu.addressbook.data.person;
+
+import seedu.addressbook.data.exception.IllegalValueException;
+
+/**
+ * Represents a Person's gender in the address book.
+ * Guarantees: immutable; is valid as declared in {@link #isValidGender(String)}
+ */
+public class Gender {
+
+    public static final String EXAMPLE = "female";
+    public static final String MESSAGE_GENDER_CONSTRAINTS =
+            "Person's gender should be either female or male.";
+    public static final String GENDER_VALIDATION_REGEX = "[\\w+]";
+
+    public final String value;
+
+    /**
+     * Validates given gender.
+     *
+     * @throws IllegalValueException if given gender string is invalid.
+     */
+    public Gender(String gender) throws IllegalValueException {
+        String trimmedGender = gender.trim();
+        if (!isValidGender(trimmedGender)) {
+            throw new IllegalValueException(MESSAGE_GENDER_CONSTRAINTS);
+        }
+        this.value = trimmedGender;
+    }
+
+    /**
+     * Returns true if the given string is a valid gender.
+     */
+    public static boolean isValidGender(String test) {
+        return test.matches(GENDER_VALIDATION_REGEX);
+    }
+
+    @Override
+    public String toString() {
+        return value;
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof Gender // instanceof handles nulls
+                && this.value.equals(((Gender) other).value)); // state check
+    }
+
+    @Override
+    public int hashCode() {
+        return value.hashCode();
+    }
+
+}

src/seedu/addressbook/data/person/Person.java

@@ -13,6 +13,7 @@
 public class Person implements ReadOnlyPerson {
 
     private Name name;
+    private Gender gender;
     private Phone phone;
     private Email email;
     private Address address;
@@ -22,8 +23,9 @@ public class Person implements ReadOnlyPerson {
     /**
      * Assumption: Every field must be present and not null.
      */
-    public Person(Name name, Phone phone, Email email, Address address, Set<Tag> tags) {
+    public Person(Name name, Gender gender, Phone phone, Email email, Address address, Set<Tag> tags) {
         this.name = name;
+        this.gender = gender;
         this.phone = phone;
         this.email = email;
         this.address = address;
@@ -34,14 +36,17 @@ public Person(Name name, Phone phone, Email email, Address address, Set<Tag> tag
      * Copy constructor.
      */
     public Person(ReadOnlyPerson source) {
-        this(source.getName(), source.getPhone(), source.getEmail(), source.getAddress(), source.getTags());
+        this(source.getName(), source.getGender(), source.getPhone(), source.getEmail(), source.getAddress(), source.getTags());
     }
 
     @Override
     public Name getName() {
         return name;
     }
 
+    @Override
+    public Gender getGender() { return gender; }
+
     @Override
     public Phone getPhone() {
         return phone;
@@ -80,7 +85,7 @@ public boolean equals(Object other) {
     @Override
     public int hashCode() {
         // use this method for custom fields hashing instead of implementing your own
-        return Objects.hash(name, phone, email, address, tags);
+        return Objects.hash(name, gender, phone, email, address, tags);
     }
 
     @Override

src/seedu/addressbook/data/person/ReadOnlyPerson.java

@@ -11,6 +11,7 @@
 public interface ReadOnlyPerson {
 
     Name getName();
+    Gender getGender();
     Phone getPhone();
     Email getEmail();
     Address getAddress();
@@ -39,6 +40,7 @@ default boolean hasSameData(ReadOnlyPerson other) {
         return other == this // short circuit if same object
                 || (other != null // this is first to avoid NPE below
                     && other.getName().equals(this.getName()) // state checks here onwards
+                    && other.getGender().equals(this.getGender())
                     && other.getPhone().equals(this.getPhone())
                     && other.getEmail().equals(this.getEmail())
                     && other.getAddress().equals(this.getAddress())
@@ -51,22 +53,30 @@ default boolean hasSameData(ReadOnlyPerson other) {
     default String getAsTextShowAll() {
         final StringBuilder builder = new StringBuilder();
         final String detailIsPrivate = "(private) ";
+
         builder.append(getName())
+
+                .append(" Gender: ");
+        builder.append(getGender())
+
                 .append(" Phone: ");
         if (getPhone().isPrivate()) {
             builder.append(detailIsPrivate);
         }
         builder.append(getPhone())
+
                 .append(" Email: ");
         if (getEmail().isPrivate()) {
             builder.append(detailIsPrivate);
         }
         builder.append(getEmail())
+
                 .append(" Address: ");
         if (getAddress().isPrivate()) {
             builder.append(detailIsPrivate);
         }
         builder.append(getAddress())
+
                 .append(" Tags: ");
         for (Tag tag : getTags()) {
             builder.append(tag);
@@ -80,6 +90,9 @@ default String getAsTextShowAll() {
     default String getAsTextHidePrivate() {
         final StringBuilder builder = new StringBuilder();
         builder.append(getName());
+
+        builder.append(" Gender: ").append(getGender());
+
         if (!getPhone().isPrivate()) {
             builder.append(" Phone: ").append(getPhone());
         }

src/seedu/addressbook/parser/Parser.java

@@ -36,6 +36,7 @@ public class Parser {
 
     public static final Pattern PERSON_DATA_ARGS_FORMAT = // '/' forward slashes are reserved for delimiter prefixes
             Pattern.compile("(?<name>[^/]+)"
+                    + " g/(?<gender>[^/]+)"
                     + " (?<isPhonePrivate>p?)p/(?<phone>[^/]+)"
                     + " (?<isEmailPrivate>p?)e/(?<email>[^/]+)"
                     + " (?<isAddressPrivate>p?)a/(?<address>[^/]+)"
@@ -119,6 +120,8 @@ private Command prepareAdd(String args) {
             return new AddCommand(
                     matcher.group("name"),
 
+                    matcher.group("gender"),
+
                     matcher.group("phone"),
                     isPrivatePrefixPresent(matcher.group("isPhonePrivate")),
 

src/seedu/addressbook/storage/AddressBookDecoder.java

@@ -11,12 +11,7 @@
 
 import seedu.addressbook.data.AddressBook;
 import seedu.addressbook.data.exception.IllegalValueException;
-import seedu.addressbook.data.person.Address;
-import seedu.addressbook.data.person.Email;
-import seedu.addressbook.data.person.Name;
-import seedu.addressbook.data.person.Person;
-import seedu.addressbook.data.person.Phone;
-import seedu.addressbook.data.person.UniquePersonList;
+import seedu.addressbook.data.person.*;
 import seedu.addressbook.data.tag.Tag;
 import seedu.addressbook.storage.StorageFile.StorageOperationException;
 
@@ -55,6 +50,7 @@ private static Person decodePersonFromString(String encodedPerson)
 
         return new Person(
                 new Name(matcher.group("name")),
+                new Gender(matcher.group("gender")),
                 new Phone(matcher.group("phone"), isPrivatePrefixPresent(matcher.group("isPhonePrivate"))),
                 new Email(matcher.group("email"), isPrivatePrefixPresent(matcher.group("isEmailPrivate"))),
                 new Address(matcher.group("address"), isPrivatePrefixPresent(matcher.group("isAddressPrivate"))),

src/seedu/addressbook/storage/AddressBookEncoder.java

@@ -29,6 +29,8 @@ private static String encodePersonToString(Person person) {
 
         encodedPersonBuilder.append(person.getName());
 
+        encodedPersonBuilder.append("g/").append(person.getGender().value);
+
         encodedPersonBuilder.append(person.getPhone().isPrivate() ? " p" : " ");
         encodedPersonBuilder.append("p/").append(person.getPhone().value);
 

test/java/seedu/addressbook/commands/AddCommandTest.java

@@ -17,6 +17,7 @@
 import seedu.addressbook.data.exception.IllegalValueException;
 import seedu.addressbook.data.person.Address;
 import seedu.addressbook.data.person.Email;
+import seedu.addressbook.data.person.Gender;
 import seedu.addressbook.data.person.Name;
 import seedu.addressbook.data.person.Person;
 import seedu.addressbook.data.person.Phone;
@@ -32,16 +33,25 @@ public class AddCommandTest {
     public void addCommand_invalidName_throwsException() {
         final String[] invalidNames = { "", " ", "[]\\[;]" };
         for (String name : invalidNames) {
-            assertConstructingInvalidAddCmdThrowsException(name, Phone.EXAMPLE, true, Email.EXAMPLE, false,
+            assertConstructingInvalidAddCmdThrowsException(name, Gender.EXAMPLE, Phone.EXAMPLE, true, Email.EXAMPLE, false,
                     Address.EXAMPLE, true, EMPTY_STRING_SET);
         }
     }
 
+    @Test
+    public void addCommand_invalidGender_throwsException() {
+        final String[] invalidGenders = { "", " ", "F/M", "[]\\[;]", "f", "m", "JSG" };
+        for (String gender : invalidGenders) {
+            assertConstructingInvalidAddCmdThrowsException(Name.EXAMPLE, gender, Phone.EXAMPLE, true, Email.EXAMPLE, true,
+                    Address.EXAMPLE, false, EMPTY_STRING_SET);
+        }
+    }
+
     @Test
     public void addCommand_invalidPhone_throwsException() {
         final String[] invalidNumbers = { "", " ", "1234-5678", "[]\\[;]", "abc", "a123", "+651234" };
         for (String number : invalidNumbers) {
-            assertConstructingInvalidAddCmdThrowsException(Name.EXAMPLE, number, false, Email.EXAMPLE, true,
+            assertConstructingInvalidAddCmdThrowsException(Name.EXAMPLE, Gender.EXAMPLE, number, false, Email.EXAMPLE, true,
                     Address.EXAMPLE, false, EMPTY_STRING_SET);
         }
     }
@@ -51,7 +61,7 @@ public void addCommand_invalidEmail_throwsException() {
         final String[] invalidEmails = { "", " ", "def.com", "@", "@def", "@def.com", "abc@",
                                          "@invalid@email", "invalid@email!", "!invalid@email" };
         for (String email : invalidEmails) {
-            assertConstructingInvalidAddCmdThrowsException(Name.EXAMPLE, Phone.EXAMPLE, false, email, false,
+            assertConstructingInvalidAddCmdThrowsException(Name.EXAMPLE, Gender.EXAMPLE, Phone.EXAMPLE, false, email, false,
                     Address.EXAMPLE, false, EMPTY_STRING_SET);
         }
     }
@@ -60,7 +70,7 @@ public void addCommand_invalidEmail_throwsException() {
     public void addCommand_invalidAddress_throwsException() {
         final String[] invalidAddresses = { "", " " };
         for (String address : invalidAddresses) {
-            assertConstructingInvalidAddCmdThrowsException(Name.EXAMPLE, Phone.EXAMPLE, true, Email.EXAMPLE,
+            assertConstructingInvalidAddCmdThrowsException(Name.EXAMPLE, Gender.EXAMPLE, Phone.EXAMPLE, true, Email.EXAMPLE,
                     true, address, true, EMPTY_STRING_SET);
         }
     }
@@ -71,7 +81,7 @@ public void addCommand_invalidTags_throwsException() {
                                          { "", " " } };
         for (String[] tags : invalidTags) {
             Set<String> tagsToAdd = new HashSet<>(Arrays.asList(tags));
-            assertConstructingInvalidAddCmdThrowsException(Name.EXAMPLE, Phone.EXAMPLE, true, Email.EXAMPLE,
+            assertConstructingInvalidAddCmdThrowsException(Name.EXAMPLE, Gender.EXAMPLE, Phone.EXAMPLE, true, Email.EXAMPLE,
                     true, Address.EXAMPLE, false, tagsToAdd);
         }
     }
@@ -80,30 +90,31 @@ public void addCommand_invalidTags_throwsException() {
      * Asserts that attempting to construct an add command with the supplied
      * invalid data throws an IllegalValueException
      */
-    private void assertConstructingInvalidAddCmdThrowsException(String name, String phone,
+    private void assertConstructingInvalidAddCmdThrowsException(String name, String gender, String phone,
             boolean isPhonePrivate, String email, boolean isEmailPrivate, String address,
             boolean isAddressPrivate, Set<String> tags) {
         try {
-            new AddCommand(name, phone, isPhonePrivate, email, isEmailPrivate, address, isAddressPrivate,
+            new AddCommand(name, gender, phone, isPhonePrivate, email, isEmailPrivate, address, isAddressPrivate,
                     tags);
         } catch (IllegalValueException e) {
             return;
         }
         String error = String.format(
                 "An add command was successfully constructed with invalid input: %s %s %s %s %s %s %s %s",
-                name, phone, isPhonePrivate, email, isEmailPrivate, address, isAddressPrivate, tags);
+                name, gender, phone, isPhonePrivate, email, isEmailPrivate, address, isAddressPrivate, tags);
         fail(error);
     }
 
     @Test
     public void addCommand_validData_correctlyConstructed() throws Exception {
-        AddCommand command = new AddCommand(Name.EXAMPLE, Phone.EXAMPLE, true, Email.EXAMPLE, false,
+        AddCommand command = new AddCommand(Name.EXAMPLE, Gender.EXAMPLE, Phone.EXAMPLE, true, Email.EXAMPLE, false,
                 Address.EXAMPLE, true, EMPTY_STRING_SET);
         ReadOnlyPerson p = command.getPerson();
 
         // TODO: add comparison of tags to person.equals and equality methods to
         // individual fields that compare privacy to simplify this
         assertEquals(Name.EXAMPLE, p.getName().fullName);
+        assertEquals(Gender.EXAMPLE, p.getGender().value);
         assertEquals(Phone.EXAMPLE, p.getPhone().value);
         assertTrue(p.getPhone().isPrivate());
         assertEquals(Email.EXAMPLE, p.getEmail().value);

test/java/seedu/addressbook/commands/DeleteCommandTest.java

@@ -11,12 +11,7 @@
 import seedu.addressbook.common.Messages;
 import seedu.addressbook.data.AddressBook;
 import seedu.addressbook.data.exception.IllegalValueException;
-import seedu.addressbook.data.person.Address;
-import seedu.addressbook.data.person.Email;
-import seedu.addressbook.data.person.Name;
-import seedu.addressbook.data.person.Person;
-import seedu.addressbook.data.person.Phone;
-import seedu.addressbook.data.person.ReadOnlyPerson;
+import seedu.addressbook.data.person.*;
 import seedu.addressbook.data.person.UniquePersonList.PersonNotFoundException;
 import seedu.addressbook.ui.TextUi;
 import seedu.addressbook.util.TestUtil;
@@ -32,13 +27,13 @@ public class DeleteCommandTest {
 
     @Before
     public void setUp() throws Exception {
-        Person johnDoe = new Person(new Name("John Doe"), new Phone("61234567", false),
+        Person johnDoe = new Person(new Name("John Doe"), new Gender("M"), new Phone("61234567", false),
                 new Email("[email protected]", false), new Address("395C Ben Road", false), Collections.emptySet());
-        Person janeDoe = new Person(new Name("Jane Doe"), new Phone("91234567", false),
+        Person janeDoe = new Person(new Name("Jane Doe"), new Gender("F"), new Phone("91234567", false),
                 new Email("[email protected]", false), new Address("33G Ohm Road", false), Collections.emptySet());
-        Person samDoe = new Person(new Name("Sam Doe"), new Phone("63345566", false),
+        Person samDoe = new Person(new Name("Sam Doe"), new Gender("M"), new Phone("63345566", false),
                 new Email("[email protected]", false), new Address("55G Abc Road", false), Collections.emptySet());
-        Person davidGrant = new Person(new Name("David Grant"), new Phone("61121122", false),
+        Person davidGrant = new Person(new Name("David Grant"), new Gender("M"), new Phone("61121122", false),
                 new Email("[email protected]", false), new Address("44H Define Road", false),
                 Collections.emptySet());
 
@@ -64,7 +59,7 @@ public void execute_noPersonDisplayed_returnsInvalidIndexMessage() {
     @Test
     public void execute_targetPersonNotInAddressBook_returnsPersonNotFoundMessage()
             throws IllegalValueException {
-        Person notInAddressBookPerson = new Person(new Name("Not In Book"), new Phone("63331444", false),
+        Person notInAddressBookPerson = new Person(new Name("Not In Book"), new Gender("M"), new Phone("63331444", false),
                 new Email("[email protected]", false), new Address("156D Grant Road", false), Collections.emptySet());
         List<ReadOnlyPerson> listWithPersonNotInAddressBook = TestUtil.createList(notInAddressBookPerson);