Add Calendar Model

docs/AboutUs.md

@@ -1,6 +1,6 @@
 ---
   layout: default.md
-  title: "About Us"
+    title: "About Us"
 ---
 
 # About Us

docs/DeveloperGuide.md

@@ -286,7 +286,7 @@ _{Explain here how the data archiving feature will be implemented}_
 
 Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
 
-| Priority | As a …​                                                             | I want to …​                                                                 | So that I can…​                                                                         |
+| Priority | As a …                                                              | I want to …                                                                  | So that I can…                                                                          |
 |----------|---------------------------------------------------------------------|------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
 | `* * *`  | NUS student                                                         | search for the contacts of other students within my university               | contact them for group projects                                                         |
 | `* * *`  | NUS student                                                         | search for a name in the contact                                             | easily find the person’s contact                                                        |

docs/UserGuide.md

@@ -6,6 +6,10 @@
 
 UniMate is a desktop app for students to **manage contacts** and **manage schedules** optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, UniMate can get your contact management tasks done faster than traditional GUI apps.
 
+AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a  Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
+
+<!-- * Table of Contents -->
+<page-nav-print />
 <!-- * Table of Contents -->
 <page-nav-print />
 
@@ -175,15 +179,14 @@ Format: `exit`
 
 ## Calendar System
 
-### Adding an event (Coming Soon)
+### Adding an event
 
 Adds an event to the user's calendar.
 
-Format: `addEvent DESCRIPTION d/DATE s/START_TIME e/END_TIME`
+Format: `addEvent d/DESCRIPTION ts/START_DATE_TIME ts/END_DATE_TIME`
 
-* Adds the event starting from `START_TIME` and ending at `END_TIME`
-* `START_TIME` and `END_TIME` must be in 24 hour notation
-* `DATE` must be in the format `DD/MM/YYYY`
+* Adds the event starting from `START_DATE_TIME` and ending at `END_DATE_TIME`
+* `START_DATE_TIME` and `END_DATE_TIME` must be in `yyyy-MM-dd HH:mm` format
 
 Example:
 * `addEvent Cry about deadlines d/12/12/2012 s/2200 e/2359`
@@ -263,6 +266,6 @@ Action     | Format, Examples
 **Filter** | `filter TAG [MORE_TAGS]` <br> e.g., `filter CSGOD CS2103`
 **List** | `list`
 **Help** | `help`
-**addEvent** | `addEvent DESCRIPTION d/DAY s/START_TIME e/END_TIME` <br> e.g., `addEvent Cry about deadlines d/MON s/2200 e/2359`
+**addEvent** | `addEvent d/DESCRIPTION ts/START_DATE_TIME te/END_DATE_TIME` <br> e.g., `addEvent d/Cry about deadlines ts/2023-01-01 00:01 te/2023-12-31 23:59`
 **deleteEvent** | `deleteEvent d/DATE s/START_TIME` <br> e.g., `deleteEvent d/12/12/2012 s/2200`
 **viewEvents** | `viewEvents`

docs/team/lihongguang00.md

@@ -3,21 +3,25 @@
   title: "Hongguang's Project Portfolio Page"
 ---
 
-### Project: AddressBook Level 3
+### Project: UniMate
 
-AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+UniMate is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
 
 Given below are my contributions to the project.
 
-* **New Feature**: Added the ability to undo/redo previous commands.
+* **New Feature**: To be determined
   * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
   * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
   * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
   * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*
 
 * **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
 
+<<<<<<<< HEAD:docs/team/junhonglow.md
+* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=zoom&zA=junhonglow&zR=AY2324S1-CS2103-F13-4%2Ftp%5Bmaster%5D&zACS=104.16170212765958&zS=2023-09-22&zFS=&zU=2023-10-05&zMG=false&zFTF=commit&zFGS=groupByRepos&zFR=false)
+========
 * **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=lihongguang00%20&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=lihongguang00&tabRepo=AY2324S1-CS2103-F13-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
+>>>>>>>> branch-Merge-Conflict:docs/team/lihongguang00.md
 
 * **Project management**:
   * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub

src/main/java/seedu/address/logic/LogicManager.java

@@ -11,7 +11,7 @@
 import seedu.address.logic.commands.Command;
 import seedu.address.logic.commands.CommandResult;
 import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.logic.parser.AddressBookParser;
+import seedu.address.logic.parser.UniMateParser;
 import seedu.address.logic.parser.exceptions.ParseException;
 import seedu.address.model.Model;
 import seedu.address.model.ReadOnlyAddressBook;
@@ -31,23 +31,23 @@ public class LogicManager implements Logic {
 
     private final Model model;
     private final Storage storage;
-    private final AddressBookParser addressBookParser;
+    private final UniMateParser uniMateParser;
 
     /**
      * Constructs a {@code LogicManager} with the given {@code Model} and {@code Storage}.
      */
     public LogicManager(Model model, Storage storage) {
         this.model = model;
         this.storage = storage;
-        addressBookParser = new AddressBookParser();
+        uniMateParser = new UniMateParser();
     }
 
     @Override
     public CommandResult execute(String commandText) throws CommandException, ParseException {
         logger.info("----------------[USER COMMAND][" + commandText + "]");
 
         CommandResult commandResult;
-        Command command = addressBookParser.parseCommand(commandText);
+        Command command = uniMateParser.parseCommand(commandText);
         commandResult = command.execute(model);
 
         try {

src/main/java/seedu/address/logic/Messages.java

@@ -5,6 +5,7 @@
 import java.util.stream.Stream;
 
 import seedu.address.logic.parser.Prefix;
+import seedu.address.model.event.Event;
 import seedu.address.model.person.Person;
 
 /**
@@ -18,6 +19,10 @@ public class Messages {
     public static final String MESSAGE_PERSONS_LISTED_OVERVIEW = "%1$d persons listed!";
     public static final String MESSAGE_DUPLICATE_FIELDS =
                 "Multiple values specified for the following single-valued field(s): ";
+    public static final String MESSAGE_INDEX_OUT_OF_BOUNDS = "Event index is out of bounds!";
+    public static final String MESSAGE_DATE_CHANGE_SUCCESSFUL = "Successfully changed!";
+    private static final String MESSAGE_EVENT_ADDED_SUCCESSFULLY = "Event added successfully!";
+    private static final String MESSAGE_EVENT_TIMING_CONFLICT = "Conflicting timing!";
 
     /**
      * Returns an error message indicating the duplicate prefixes.
@@ -48,4 +53,17 @@ public static String format(Person person) {
         return builder.toString();
     }
 
+    /**
+     * Formats the event for display to the user.
+     *
+     * @param event event to be displayed.
+     * @return String of appropriate format.
+     */
+    public static String format(Event event) {
+        final StringBuilder builder = new StringBuilder();
+        builder.append(event.getDescription())
+                .append("; ")
+                .append(event.getEventPeriod());
+        return builder.toString();
+    }
 }

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

@@ -0,0 +1,80 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_EVENT_DESCRIPTION;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_EVENT_END_DATE_TIME;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_EVENT_START_DATE_TIME;
+
+import seedu.address.commons.util.ToStringBuilder;
+import seedu.address.logic.Messages;
+import seedu.address.logic.commands.exceptions.CommandException;
+import seedu.address.model.Model;
+import seedu.address.model.event.Event;
+
+/**
+ * Adds an event to the calendar.
+ */
+public class AddEventCommand extends Command {
+
+    public static final String COMMAND_WORD = "addEvent";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds an event to the calendar. "
+            + "Parameters: "
+            + PREFIX_EVENT_DESCRIPTION + "DESCRIPTION "
+            + PREFIX_EVENT_START_DATE_TIME + "START DATE AND TIME "
+            + PREFIX_EVENT_END_DATE_TIME + "END DATE AND TIME...\n"
+            + "Example: " + COMMAND_WORD + " "
+            + PREFIX_EVENT_DESCRIPTION + "Nap "
+            + PREFIX_EVENT_START_DATE_TIME + "2024-01-01 12:00 "
+            + PREFIX_EVENT_END_DATE_TIME + "2024-01-01 18:00";
+
+    public static final String MESSAGE_SUCCESS = "New event added: %1$s";
+
+    public static final String MESSAGE_EVENT_CONFLICT = "This event is conflicting with another event";
+
+    private final Event toAdd;
+
+    /**
+     * Creates an AddEventCommand to add the event into the calendar.
+     *
+     * @param event event to be added.
+     */
+    public AddEventCommand(Event event) {
+        requireNonNull(event);
+        toAdd = event;
+    }
+
+    @Override
+    public CommandResult execute(Model model) throws CommandException {
+        requireNonNull(model);
+
+        if (!model.canAddEvent(toAdd)) {
+            throw new CommandException(MESSAGE_EVENT_CONFLICT);
+        }
+
+        model.addEvent(toAdd);
+        return new CommandResult(String.format(MESSAGE_SUCCESS, Messages.format(toAdd)));
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if (other == this) {
+            return true;
+        }
+
+        // instanceof handles nulls
+        if (!(other instanceof AddEventCommand)) {
+            return false;
+        }
+
+        AddEventCommand otherAddCommand = (AddEventCommand) other;
+        return toAdd.equals(otherAddCommand.toAdd);
+    }
+
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .add("toAdd", toAdd)
+                .toString();
+    }
+}

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

@@ -0,0 +1,51 @@
+package seedu.address.logic.parser;
+
+import static seedu.address.logic.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_EVENT_DESCRIPTION;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_EVENT_END_DATE_TIME;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_EVENT_START_DATE_TIME;
+
+import java.util.stream.Stream;
+
+import seedu.address.logic.commands.AddEventCommand;
+import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.address.model.event.Event;
+import seedu.address.model.event.EventDescription;
+import seedu.address.model.event.EventPeriod;
+
+/**
+ * Parses input arguments and creates a new AddEventCommand object.
+ */
+public class AddEventCommandParser implements Parser<AddEventCommand> {
+    @Override
+    public AddEventCommand parse(String args) throws ParseException {
+        ArgumentMultimap argMultiMap =
+                ArgumentTokenizer.tokenize(args, PREFIX_EVENT_DESCRIPTION, PREFIX_EVENT_START_DATE_TIME,
+                        PREFIX_EVENT_END_DATE_TIME);
+
+        if (!arePrefixesPresent(argMultiMap, PREFIX_EVENT_DESCRIPTION, PREFIX_EVENT_START_DATE_TIME,
+                PREFIX_EVENT_END_DATE_TIME) || !argMultiMap.getPreamble().isEmpty()) {
+            throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddEventCommand.MESSAGE_USAGE));
+        }
+
+        argMultiMap.verifyNoDuplicatePrefixesFor(PREFIX_EVENT_DESCRIPTION, PREFIX_EVENT_START_DATE_TIME,
+                PREFIX_EVENT_END_DATE_TIME);
+        EventDescription description = ParserUtil.parseEventDescription(argMultiMap
+                .getValue(PREFIX_EVENT_DESCRIPTION).get());
+        EventPeriod eventPeriod = ParserUtil.parseEventPeriod(argMultiMap.getValue(PREFIX_EVENT_START_DATE_TIME).get(),
+                argMultiMap.getValue(PREFIX_EVENT_END_DATE_TIME).get());
+
+        return new AddEventCommand(new Event(description, eventPeriod));
+    }
+
+    /**
+     * Checks if all the given prefix fields are non-empty.
+     *
+     * @param argumentMultimap argumentMultimap managing arguments for this command.
+     * @param prefixes prefixes to be tested.
+     * @return true if all fields are non-empty, false if any field contains empty value.
+     */
+    private static boolean arePrefixesPresent(ArgumentMultimap argumentMultimap, Prefix... prefixes) {
+        return Stream.of(prefixes).allMatch(prefix -> argumentMultimap.getValue(prefix).isPresent());
+    }
+}

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

@@ -12,4 +12,9 @@ public class CliSyntax {
     public static final Prefix PREFIX_ADDRESS = new Prefix("a/");
     public static final Prefix PREFIX_TAG = new Prefix("t/");
 
+    public static final Prefix PREFIX_EVENT_DESCRIPTION = new Prefix("d/");
+
+    public static final Prefix PREFIX_EVENT_START_DATE_TIME = new Prefix("ts/");
+
+    public static final Prefix PREFIX_EVENT_END_DATE_TIME = new Prefix("te/");
 }

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

@@ -1,6 +1,7 @@
 package seedu.address.logic.parser;
 
 import static java.util.Objects.requireNonNull;
+import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
 
 import java.util.Collection;
 import java.util.Collections;
@@ -11,6 +12,8 @@
 import seedu.address.commons.core.index.Index;
 import seedu.address.commons.util.StringUtil;
 import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.address.model.event.EventDescription;
+import seedu.address.model.event.EventPeriod;
 import seedu.address.model.person.Address;
 import seedu.address.model.person.Email;
 import seedu.address.model.person.Name;
@@ -138,4 +141,38 @@ public static Optional<Set<Tag>> parseTagsForUse(Collection<String> tags) throws
         Collection<String> tagSet = tags.size() == 1 && tags.contains("") ? Collections.emptySet() : tags;
         return Optional.of(ParserUtil.parseTags(tagSet));
     }
+
+    /**
+     * Parses the event description String into a EventDescription object.
+     *
+     * @param description description String.
+     * @return EventDescription object with the given description String.
+     * @throws ParseException if the description is empty.
+     */
+    public static EventDescription parseEventDescription(String description) throws ParseException {
+        requireNonNull(description);
+        String trimmedDescription = description.trim();
+        if (!EventDescription.isValid(description)) {
+            throw new ParseException(EventDescription.MESSAGE_CONSTRAINTS);
+        }
+        return new EventDescription(trimmedDescription);
+    }
+
+    /**
+     * Parses given start date string and end date string into an EventPeriod object.
+     *
+     * @param startDate start date string in 'yyyy-MM-dd HH:mm' format.
+     * @param endDate end date string in 'yyyy-MM-dd HH:mm' format.
+     * @return EventPeriod object describing the time period between startDate and endDate.
+     * @throws ParseException if the startDate or endDate strings are in inproper format.
+     */
+    public static EventPeriod parseEventPeriod(String startDate, String endDate) throws ParseException {
+        requireAllNonNull(startDate, endDate);
+        String trimmedStartDate = startDate.trim();
+        String trimmedEndDate = endDate.trim();
+        if (!EventPeriod.isValidPeriod(trimmedStartDate, trimmedEndDate)) {
+            throw new ParseException(EventPeriod.MESSAGE_CONSTRAINTS);
+        }
+        return new EventPeriod(trimmedStartDate, trimmedEndDate);
+    }
 }

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

@@ -9,6 +9,7 @@
 
 import seedu.address.commons.core.LogsCenter;
 import seedu.address.logic.commands.AddCommand;
+import seedu.address.logic.commands.AddEventCommand;
 import seedu.address.logic.commands.ClearCommand;
 import seedu.address.logic.commands.Command;
 import seedu.address.logic.commands.DeleteCommand;
@@ -21,15 +22,15 @@
 import seedu.address.logic.parser.exceptions.ParseException;
 
 /**
- * Parses user input.
+ * Parses user input for UniMate.
  */
-public class AddressBookParser {
+public class UniMateParser {
 
     /**
      * Used for initial separation of command word and args.
      */
     private static final Pattern BASIC_COMMAND_FORMAT = Pattern.compile("(?<commandWord>\\S+)(?<arguments>.*)");
-    private static final Logger logger = LogsCenter.getLogger(AddressBookParser.class);
+    private static final Logger logger = LogsCenter.getLogger(UniMateParser.class);
 
     /**
      * Parses user input into command for execution.
@@ -81,10 +82,12 @@
         case FilterCommand.COMMAND_WORD:
             return new FilterCommandParser().parse(arguments);
 
+        case AddEventCommand.COMMAND_WORD:
+            return new AddEventCommandParser().parse(arguments);
+
         default:
             logger.finer("This user input caused a ParseException: " + userInput);
             throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
         }
     }
-
 }