Merge pull request #254 from HanB1n/fix-message-bugs

Refactor Messages and Bug Fix for Message formatting
nus-cs2103-AY2425S1 · Nov 7, 2024 · 9274a0a · 9274a0a
2 parents b2544c5 + 1f3d23b
commit 9274a0a
Show file tree

Hide file tree

Showing 74 changed files with 428 additions and 341 deletions.
diff --git a/src/main/java/seedu/address/logic/Messages.java b/src/main/java/seedu/address/logic/Messages.java
@@ -5,6 +5,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import seedu.address.logic.commands.person.EditCommand;
 import seedu.address.logic.parser.Prefix;
 import seedu.address.model.person.Person;
 import seedu.address.model.tag.Tag;
@@ -16,47 +17,129 @@
  */
 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";
+    /**
+     * General Messages
+     */
+    public static final String MESSAGE_CLEAR_SUCCESS = "Address book has been cleared!";
     public static final String MESSAGE_ENTER_VALID_INDEX = "Please enter a valid index from %d to %d.";
+    public static final String MESSAGE_DUPLICATE_FIELDS =
+            "Multiple values specified for the following single-valued field(s): ";
+    public static final String MESSAGE_EXIT_ACKNOWLEDGEMENT = "Exiting Address Book as requested ...";
+    public static final String SHOWING_HELP_MESSAGE = "Opened help window.";
+    public static final String MESSAGE_INVALID_COMMAND_FORMAT = "Invalid command format! \n%1$s";
     public static final String MESSAGE_NOTHING_TO_PERFORM_ON = "There are no %s to %s.";
+    public static final String MESSAGE_UNKNOWN_COMMAND = "Unknown command";
+
+    /**
+     * Messages specific to Person
+     */
+    public static final String MESSAGE_ADD_PERSON_SUCCESS = "New person added: %1$s";
+    public static final String MESSAGE_DELETE_PERSON_SUCCESS = "Deleted Person: %1$s";
+    public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book";
+    public static final String MESSAGE_EDIT_PERSON_SUCCESS = "Edited Person: %1$s";
+    public static final String MESSAGE_INVALID_EDIT_PERSON_FORMAT =
+            String.format(MESSAGE_INVALID_COMMAND_FORMAT, EditCommand.MESSAGE_USAGE);
+    public static final String MESSAGE_LIST_PERSON_SUCCESS = "Listed all persons";
     public static final String MESSAGE_INVALID_PERSON_DISPLAYED_INDEX = "The person index provided is invalid. \n"
             + MESSAGE_ENTER_VALID_INDEX;
-    public static final String MESSAGE_INVALID_TASK_DISPLAYED_INDEX = "The task index provided (%d) is invalid. \n"
-            + MESSAGE_ENTER_VALID_INDEX;
-    public static final String MESSAGE_INVALID_DATE_FORMAT = "Invalid date format. Expected format: yyyy-MM-dd";
-    public static final String MESSAGE_TASK_NOT_FOUND_IN_AB = "Task does not exist in the address book.";
-    public static final String MESSAGE_TO_BEFORE_FROM_INVALID = "\"From\" date must be before \"To\" date.";
-    public static final String MESSAGE_INVALID_WEDDING_DISPLAYED_INDEX = "The wedding index provided is invalid";
-    public static final String MESSAGE_DUPLICATE_FIELDS =
-            "Multiple values specified for the following single-valued field(s): ";
+    public static final String MESSAGE_PERSON_NOT_EDITED = "At least one field to edit must be provided.";
+
+
+    /**
+     * Messages specific to Tag
+     */
+    public static final String MESSAGE_ASSIGN_TAG_SUCCESS = "Added tag(s) %1$s to %2$s.";
+    public static final String MESSAGE_CREATE_TAG_SUCCESS = "New tag added: %1$s";
+    public static final String MESSAGE_DELETE_TAG_SUCCESS = "Deleted Tag: %1$s.";
+    public static final String MESSAGE_DELETE_TAG_FAILURE_STILL_TAGGED = "The Tag: %1$s is still used.";
+    public static final String MESSAGE_DELETE_TAG_FAILURE_NOT_FOUND = "The Tag: %1$s does not exist.";
+    public static final String MESSAGE_DUPLICATE_TAG = "This tag already exists in the address book";
+    public static final String MESSAGE_FORCE_TAG_TO_CONTACT = "Use f/ to force the tagging of contacts."
+            + " This will create the require Tags.";
+    public static final String MESSAGE_FORCE_DELETE_TAG = "Use f/ to force the deletion of tags."
+            + " This will unassign all people currently with the Tag.";
+    public static final String MESSAGE_LIST_TAG_SUCCESS = "Listed all tags";
+    public static final String MESSAGE_REMOVE_TAG_SUCCESS = "Removed tag(s) %1$s from %2$s.";
     public static final String MESSAGE_TAG_NOT_FOUND = "One or more specified tags do not exist in the Wedlinker.";
     public static final String MESSAGE_TAG_NOT_FOUND_IN_CONTACT = "Some tags were not found in the person's tag list.";
-    public static final String MESSAGE_ADD_TAG_SUCCESS = "Added tag(s) %1$s to %2$s.";
-    public static final String MESSAGE_ADD_TASK_SUCCESS = "Added task(s) %1$s to %2$s.";
-    public static final String MESSAGE_UNASSIGN_TASK_SUCCESS = "Removed task(s) %1$s from %2$s.";
-    public static final String MESSAGE_TASK_NOT_FOUND_IN_CONTACT = "Some task(s) "
-            + "were not found in the person's task list.";
-    public static final String MESSAGE_ONLY_VENDOR_CAN_BE_ASSIGNED_TASK = "%1$s is not a Vendor, "
-            + "tasks can only be assigned to vendors.";
-    public static final String MESSAGE_ADD_WEDDING_SUCCESS = "Added wedding(s) %1$s to %2$s.";
+
+    /**
+     * Messages specific to Wedding
+     */
+    public static final String MESSAGE_ASSIGN_WEDDING_SUCCESS = "Assigned wedding(s) %1$s to %2$s.";
+    public static final String MESSAGE_CREATE_WEDDING_SUCCESS = "New wedding created: %1$s";
+    public static final String MESSAGE_DELETE_WEDDING_SUCCESS = "Deleted Wedding: %1$s";
+    public static final String MESSAGE_DELETE_WEDDING_FAILURE_STILL_USED = "The Wedding: %1$s is still used";
+    public static final String MESSAGE_DELETE_WEDDING_FAILURE_NOT_FOUND = "The Wedding: %1$s does not exist";
+    public static final String MESSAGE_DUPLICATE_WEDDING = "This wedding already exists in the address book";
+    public static final String MESSAGE_EDIT_WEDDING_SUCCESS = "Edited Wedding: %1$s";
+    public static final String MESSAGE_WEDDING_NOT_EDITED = "At least one field to edit must be provided.";
+    public static final String MESSAGE_FORCE_ASSIGN_WEDDING_TO_CONTACT = "Use f/ to force the assignment of wedding(s)."
+            + " This will automatically help you create the wedding required.";
+    public static final String MESSAGE_FORCE_DELETE_WEDDING = "Use f/ to force the deletion of wedding."
+            + " This will unassign all people currently assigned to this Wedding.";
+    public static final String MESSAGE_INVALID_WEDDING_DISPLAYED_INDEX = "The wedding index provided is invalid";
+    public static final String MESSAGE_LIST_WEDDING_SUCCESS = "Listed all weddings";
     public static final String MESSAGE_REMOVE_WEDDING_SUCCESS = "Removed wedding(s) %1$s from %2$s.";
     public static final String MESSAGE_WEDDING_NOT_FOUND = "One or more specified weddings do not exist in "
             + "the Wedlinker.";
     public static final String MESSAGE_WEDDING_NOT_FOUND_IN_CONTACT = "Some weddings were not found in "
             + "the person's wedding list.";
-    public static final String MESSAGE_FORCE_ASSIGN_WEDDING_TO_CONTACT = "Use f/ to force the assignment of wedding(s)."
-            + " This will automatically help you create the wedding required.";
-    public static final String MESSAGE_FORCE_DELETE_WEDDING = "Use f/ to force the deletion of wedding."
-            + " This will unassign all people currently assigned to this Wedding.";
-    public static final String MESSAGE_FORCE_TAG_TO_CONTACT = "Use f/ to force the tagging of contacts."
-            + " This will create the require Tags.";
-    public static final String MESSAGE_FORCE_DELETE_TAG = "Use f/ to force the deletion of tags."
-            + " This will unassign all people currently with the Tag.";
+
+    /**
+     * Messages specific to Task
+     */
+    public static final String MESSAGE_ASSIGN_TASK_SUCCESS = "Added task(s) %1$s to %2$s.";
+    public static final String MESSAGE_DUPLICATE_TASK_IN_PERSON = "Task '%s' is already assigned to %s";
+    public static final String MESSAGE_DUPLICATE_TASK_IN_WEDLINKER = "This task already exists in the address book";
+    public static final String MESSAGE_DELETE_TASK_SUCCESS = "Deleted task: %1$s";
+    public static final String MESSAGE_INVALID_TASK_DISPLAYED_INDEX = "The task index provided (%d) is invalid. \n"
+            + MESSAGE_ENTER_VALID_INDEX;
+    public static final String MESSAGE_INVALID_DATE_FORMAT = "Invalid date format. Expected format: yyyy-MM-dd";
+    public static final String MESSAGE_LIST_TASK_SUCCESS = "Listed all tasks";
+    public static final String MESSAGE_MARK_TASK_SUCCESS = "Marked task: %1$s";
+    public static final String MESSAGE_ONLY_VENDOR_CAN_BE_ASSIGNED_TASK = "%1$s is not a Vendor, "
+            + "tasks can only be assigned to vendors.";
+    public static final String MESSAGE_TASK_ADDED_SUCCESS = "New task(s) added: %1$s";
     public static final String MESSAGE_TASK_ALREADY_COMPLETED = "Some tasks specified are already completed.";
     public static final String MESSAGE_TASK_ALREADY_UNCOMPLETED = "Some tasks specified are already uncompleted.";
+    public static final String MESSAGE_TASK_NOT_FOUND_IN_AB = "Task does not exist in the address book.";
+    public static final String MESSAGE_TASK_NOT_FOUND_IN_CONTACT = "Some task(s) "
+            + "were not found in the person's task list.";
+    public static final String MESSAGE_TO_BEFORE_FROM_INVALID = "\"From\" date must be before \"To\" date.";
+    public static final String MESSAGE_UNASSIGN_TASK_SUCCESS = "Removed task(s) %1$s from %2$s.";
+    public static final String MESSAGE_UNMARK_TASK_SUCCESS = "Unmarked task: %1$s";
+
+    /**
+     * Messages specific to Vendor
+     */
+    public static final String MESSAGE_ADD_VENDOR_SUCCESS = "%1$s has been added as a vendor.";
+    public static final String MESSAGE_DUPLICATE_VENDOR = "%1$s is already a vendor.";
     public static final String MESSAGE_FORCE_UNASSIGN_VENDOR = "Use f/ to force the unassignment of vendors."
             + " This will unassign all tasks currently with the Vendor.";
+    public static final String MESSAGE_UNASSIGN_VENDOR_FAILURE_TASK_EXISTS = "The Vendor: %1$s still has tasks"
+            + " assigned to them";
+    public static final String MESSAGE_UNASSIGN_VENDOR_FAILURE_NOT_VENDOR = "%1$s is not a vendor.";
+    public static final String MESSAGE_UNASSIGN_VENDOR_SUCCESS = "%1$s has been unassigned and is no longer a vendor.";
+
+    /**
+     * Messages specific to Find
+     */
+    public static final String MESSAGE_FIND_ADDRESS_PERSON_SUCCESS = "Search for address containing \"%s\" "
+            + " was successful. Showing results:";
+    public static final String MESSAGE_FIND_EMAIL_PERSON_SUCCESS = "Search for email containing \"%s\" was successful. "
+            + " Showing results:";
+    public static final String MESSAGE_FIND_NAME_PERSON_SUCCESS = "Search for name containing \"%s\" was successful. "
+            + " Showing results:";
+    public static final String MESSAGE_FIND_PHONE_PERSON_SUCCESS = "Search for phone number containing \"%s\" "
+            + " was successful. Showing results:";
+    public static final String MESSAGE_FIND_TAG_PERSON_SUCCESS = "Search for tag containing \"%s\" was successful. "
+            + " Showing results:";
+    public static final String MESSAGE_FIND_TASK_PERSON_SUCCESS = "Search for task containing \"%s\" was successful. "
+            + " Showing results:";
+    public static final String MESSAGE_FIND_WEDDING_PERSON_SUCCESS = "Search for wedding(s) containing "
+            + "\"%s\" was successful. Showing results:";
+    public static final String MESSAGE_FIND_PERSON_UNSUCCESSFUL = "No contacts found.";
 
     /**
      * Returns an error message indicating the duplicate prefixes.

diff --git a/src/main/java/seedu/address/logic/commands/ClearCommand.java b/src/main/java/seedu/address/logic/commands/ClearCommand.java
@@ -2,6 +2,7 @@
 
 import static java.util.Objects.requireNonNull;
 
+import seedu.address.logic.Messages;
 import seedu.address.model.AddressBook;
 import seedu.address.model.Model;
 
@@ -11,13 +12,11 @@
 public class ClearCommand extends Command {
 
     public static final String COMMAND_WORD = "clear";
-    public static final String MESSAGE_SUCCESS = "Address book has been cleared!";
-
 
     @Override
     public CommandResult execute(Model model) {
         requireNonNull(model);
         model.setAddressBook(new AddressBook());
-        return new CommandResult(MESSAGE_SUCCESS);
+        return new CommandResult(Messages.MESSAGE_CLEAR_SUCCESS);
     }
 }
diff --git a/src/main/java/seedu/address/logic/commands/ExitCommand.java b/src/main/java/seedu/address/logic/commands/ExitCommand.java
@@ -1,5 +1,6 @@
 package seedu.address.logic.commands;
 
+import seedu.address.logic.Messages;
 import seedu.address.model.Model;
 
 /**
@@ -9,11 +10,9 @@ public class ExitCommand extends Command {
 
     public static final String COMMAND_WORD = "exit";
 
-    public static final String MESSAGE_EXIT_ACKNOWLEDGEMENT = "Exiting Address Book as requested ...";
-
     @Override
     public CommandResult execute(Model model) {
-        return new CommandResult(MESSAGE_EXIT_ACKNOWLEDGEMENT, false, true);
+        return new CommandResult(Messages.MESSAGE_EXIT_ACKNOWLEDGEMENT, false, true);
     }
 
 }
diff --git a/src/main/java/seedu/address/logic/commands/HelpCommand.java b/src/main/java/seedu/address/logic/commands/HelpCommand.java
@@ -1,5 +1,6 @@
 package seedu.address.logic.commands;
 
+import seedu.address.logic.Messages;
 import seedu.address.model.Model;
 
 /**
@@ -12,10 +13,8 @@ public class HelpCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Shows program usage instructions.\n"
             + "Example: " + COMMAND_WORD;
 
-    public static final String SHOWING_HELP_MESSAGE = "Opened help window.";
-
     @Override
     public CommandResult execute(Model model) {
-        return new CommandResult(SHOWING_HELP_MESSAGE, true, false);
+        return new CommandResult(Messages.SHOWING_HELP_MESSAGE, true, false);
     }
 }
diff --git a/src/main/java/seedu/address/logic/commands/findcommand/FindAddressCommand.java b/src/main/java/seedu/address/logic/commands/findcommand/FindAddressCommand.java
@@ -2,6 +2,7 @@
 
 import static java.util.Objects.requireNonNull;
 
+import seedu.address.logic.Messages;
 import seedu.address.logic.commands.CommandResult;
 import seedu.address.model.Model;
 import seedu.address.model.person.keywordspredicate.AddressContainsKeywordsPredicate;
@@ -11,9 +12,6 @@
  */
 public class FindAddressCommand extends FindCommand {
 
-    public static final String MESSAGE_FIND_ADDRESS_PERSON_SUCCESS = "Search for address containing \"%s\" "
-            + " was successful. Showing results:";
-
     /**
      * Command to filter contacts in WedLinker based on phone numbers.
      * The search matches any parts of the phone numbers.
@@ -30,9 +28,11 @@ public CommandResult execute(Model model) {
         model.updateFilteredPersonList((AddressContainsKeywordsPredicate) predicate);
 
         if (!model.getFilteredPersonList().isEmpty()) {
-            return new CommandResult(String.format(MESSAGE_FIND_ADDRESS_PERSON_SUCCESS, predicate.getDisplayString()));
+            return new CommandResult(String.format(
+                    Messages.MESSAGE_FIND_ADDRESS_PERSON_SUCCESS, predicate.getDisplayString()
+            ));
         } else {
-            return new CommandResult(MESSAGE_FIND_PERSON_UNSUCCESSFUL);
+            return new CommandResult(Messages.MESSAGE_FIND_PERSON_UNSUCCESSFUL);
         }
     }
 

diff --git a/src/main/java/seedu/address/logic/commands/findcommand/FindCommand.java b/src/main/java/seedu/address/logic/commands/findcommand/FindCommand.java
@@ -24,8 +24,6 @@ public abstract class FindCommand extends Command {
             + "Parameters: PREFIX/ KEYWORDS [MORE_KEYWORDS]...\n"
             + "Example: " + COMMAND_WORD + " " + PREFIX_NAME + " alice charlie";
 
-    public static final String MESSAGE_FIND_PERSON_UNSUCCESSFUL = "No contacts found.";
-
     protected final TraitContainsKeywordsPredicate<?> predicate;
 
     public FindCommand(TraitContainsKeywordsPredicate<?> predicate) {

diff --git a/src/main/java/seedu/address/logic/commands/findcommand/FindEmailCommand.java b/src/main/java/seedu/address/logic/commands/findcommand/FindEmailCommand.java
@@ -2,6 +2,7 @@
 
 import static java.util.Objects.requireNonNull;
 
+import seedu.address.logic.Messages;
 import seedu.address.logic.commands.CommandResult;
 import seedu.address.model.Model;
 import seedu.address.model.person.keywordspredicate.EmailContainsKeywordsPredicate;
@@ -10,8 +11,6 @@
  * Keyword matching is case-insensitive and allows partial matching, including numbers and symbols.
  */
 public class FindEmailCommand extends FindCommand {
-    public static final String MESSAGE_FIND_EMAIL_PERSON_SUCCESS = "Search for email containing \"%s\" was successful. "
-            + " Showing results:";
 
     /**
      * Command to filter contacts in WedLinker based on names using partial matching.
@@ -30,9 +29,11 @@ public CommandResult execute(Model model) {
         model.updateFilteredPersonList((EmailContainsKeywordsPredicate) predicate);
 
         if (!model.getFilteredPersonList().isEmpty()) {
-            return new CommandResult(String.format(MESSAGE_FIND_EMAIL_PERSON_SUCCESS, predicate.getDisplayString()));
+            return new CommandResult(String.format(
+                    Messages.MESSAGE_FIND_EMAIL_PERSON_SUCCESS, predicate.getDisplayString()
+            ));
         } else {
-            return new CommandResult(MESSAGE_FIND_PERSON_UNSUCCESSFUL);
+            return new CommandResult(Messages.MESSAGE_FIND_PERSON_UNSUCCESSFUL);
         }
     }
 

diff --git a/src/main/java/seedu/address/logic/commands/findcommand/FindNameCommand.java b/src/main/java/seedu/address/logic/commands/findcommand/FindNameCommand.java
@@ -2,6 +2,7 @@
 
 import static java.util.Objects.requireNonNull;
 
+import seedu.address.logic.Messages;
 import seedu.address.logic.commands.CommandResult;
 import seedu.address.model.Model;
 import seedu.address.model.person.keywordspredicate.NameContainsKeywordsPredicate;
@@ -11,9 +12,6 @@
  */
 public class FindNameCommand extends FindCommand {
 
-    public static final String MESSAGE_FIND_NAME_PERSON_SUCCESS = "Search for name containing \"%s\" was successful. "
-            + " Showing results:";
-
     /**
      * Command to filter contacts in WedLinker based on names using partial matching.
      * This command allows users to search for contacts by providing one or more keywords.
@@ -31,9 +29,11 @@ public CommandResult execute(Model model) {
         model.updateFilteredPersonList((NameContainsKeywordsPredicate) predicate);
 
         if (!model.getFilteredPersonList().isEmpty()) {
-            return new CommandResult(String.format(MESSAGE_FIND_NAME_PERSON_SUCCESS, predicate.getDisplayString()));
+            return new CommandResult(String.format(
+                    Messages.MESSAGE_FIND_NAME_PERSON_SUCCESS, predicate.getDisplayString()
+            ));
         } else {
-            return new CommandResult(MESSAGE_FIND_PERSON_UNSUCCESSFUL);
+            return new CommandResult(Messages.MESSAGE_FIND_PERSON_UNSUCCESSFUL);
         }
     }
 

diff --git a/src/main/java/seedu/address/logic/commands/findcommand/FindPhoneCommand.java b/src/main/java/seedu/address/logic/commands/findcommand/FindPhoneCommand.java
@@ -2,6 +2,7 @@
 
 import static java.util.Objects.requireNonNull;
 
+import seedu.address.logic.Messages;
 import seedu.address.logic.commands.CommandResult;
 import seedu.address.model.Model;
 import seedu.address.model.person.keywordspredicate.PhoneContainsKeywordsPredicate;
@@ -11,10 +12,6 @@
  */
 public class FindPhoneCommand extends FindCommand {
 
-    public static final String MESSAGE_FIND_PHONE_PERSON_SUCCESS = "Search for phone number containing \"%s\" "
-            + " was successful. Showing results:";
-
-
     /**
      * Command to filter contacts in WedLinker based on phone numbers.
      * The search matches any parts of the phone numbers.
@@ -31,9 +28,11 @@ public CommandResult execute(Model model) {
         model.updateFilteredPersonList((PhoneContainsKeywordsPredicate) predicate);
 
         if (!model.getFilteredPersonList().isEmpty()) {
-            return new CommandResult(String.format(MESSAGE_FIND_PHONE_PERSON_SUCCESS, predicate.getDisplayString()));
+            return new CommandResult(String.format(
+                    Messages.MESSAGE_FIND_PHONE_PERSON_SUCCESS, predicate.getDisplayString()
+            ));
         } else {
-            return new CommandResult(MESSAGE_FIND_PERSON_UNSUCCESSFUL);
+            return new CommandResult(Messages.MESSAGE_FIND_PERSON_UNSUCCESSFUL);
         }
     }