Merge pull request #1 from jason-raiin/mark-command

Mark command

docs/diagrams/edit/CreateEditMeetingCommand.puml

@@ -0,0 +1,26 @@
+@startuml
+!include ../style.puml
+skinparam ArrowFontStyle plain
+
+title Create EditMeetingCommand
+
+Participant ":LogicManager" as logic LOGIC_COLOR
+Participant ":AddressBookParser" as abp LOGIC_COLOR
+Participant ":EditMeetingCommandParser" as emcp LOGIC_COLOR
+Participant "editMeetingDescriptor:EditMeetingDescriptor" as emd LOGIC_COLOR
+Participant "command:EditMeetingCommand" as emc LOGIC_COLOR
+
+activate logic
+logic -> abp ++: parseCommand(commandText)
+create emcp
+abp -> emcp ++: parse(arguments)
+create emd
+emcp -> emd ++: EditMeetingDescriptor()
+emd --> emcp --:
+create emc
+emcp -> emc ++: EditMeetingCommand(targetIndex, editMeetingDescriptor)
+emc --> emcp --: command
+emcp --> abp --: command
+abp --> logic --: command
+
+@enduml

docs/diagrams/edit/EditMeetingClassDiagram.puml

@@ -0,0 +1,33 @@
+@startuml
+!include ../style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor LOGIC_COLOR_T4
+skinparam classBackgroundColor LOGIC_COLOR
+
+package Parser as ParserPackage {
+Class "<<interface>>\nParser" as Parser
+Class EditMeetingCommandParser
+}
+
+package Command as CommandPackage {
+Class EditMeetingCommand
+Class EditMeetingDescriptor
+Class "{abstract}\nCommand" as Command
+}
+
+Class Index
+Class AddressBookParser
+Class LogicManager
+
+AddressBookParser .down.> EditMeetingCommandParser : creates >
+EditMeetingCommandParser ..> EditMeetingCommand : creates >
+EditMeetingCommand -down->"1" EditMeetingDescriptor
+EditMeetingCommand -down->"1" Index
+EditMeetingCommand -left-|> Command
+EditMeetingCommandParser .down.|> Parser
+EditMeetingCommandParser .left.> EditMeetingDescriptor : creates >
+EditMeetingCommandParser .down.> Index : creates >
+LogicManager -right->"1" AddressBookParser
+LogicManager .down.> EditMeetingCommand : executes >
+
+@enduml

docs/diagrams/edit/EditMeetingSequenceDiagram.puml

@@ -0,0 +1,36 @@
+@startuml
+!include ../style.puml
+skinparam ArrowFontStyle plain
+
+title Execute EditMeetingCommand
+
+box Logic LOGIC_COLOR_T1
+Participant ":LogicManager" as logic LOGIC_COLOR
+Participant "command:EditMeetingCommand" as emc LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+Participant ":ModelManager" as model MODEL_COLOR
+Participant "editedMeeting:Meeting" as meet MODEL_COLOR
+end box
+
+[->logic : execute
+activate logic
+ref over logic, emc: Create EditMeetingCommand
+logic -> emc ++: execute(model)
+emc -> model ++: getFilteredMeetingList
+model --> emc --:
+emc -> emc ++:  createEditedMeeting
+create meet
+emc -> meet ++: Meeting()
+meet --> emc --:
+emc --> emc --:
+emc -> model ++: setMeeting
+model --> emc --:
+emc -> model ++:updateFilteredMeetingList
+model --> emc --:
+emc --> logic --: CommandResult
+[<--logic
+deactivate logic
+
+@enduml

docs/diagrams/tracing/ViewContactCommandSequenceDiagram.puml → docs/diagrams/view/CreateViewContactCommand.puml

@@ -2,7 +2,7 @@
 !include ../style.puml
 skinparam ArrowFontStyle plain
 
-title View Contact Command Sequence
+title Create ViewContactCommand
 
 Participant ":LogicManager" as logic LOGIC_COLOR
 Participant ":AddressBookParser" as abp LOGIC_COLOR
@@ -13,11 +13,10 @@ Participant "command:ViewContactCommand" as ec LOGIC_COLOR
 activate logic
 logic -> abp ++: parseCommand(commandText)
 create vccp
-abp -> vccp
 abp -> vccp ++: parse(arguments)
 create ec
-vccp -> ec ++: index
-ec --> vccp --
+vccp -> ec ++: ViewContactCommand(targetIndex)
+ec --> vccp --: command
 vccp --> abp --: command
 abp --> logic --: command
 

docs/diagrams/tracing/ViewCommandsSequenceDiagram.puml → docs/diagrams/view/ViewCommandsSequenceDiagram.puml

@@ -2,11 +2,10 @@
 !include ../style.puml
 skinparam ArrowFontStyle plain
 
-title Store viewed Items to Model
+title Store Viewed Items to Model
 
 box Logic LOGIC_COLOR_T1
 Participant ":LogicManager" as logic LOGIC_COLOR
-Participant ":AddressBookParser" as abp LOGIC_COLOR
 Participant "command:ViewContactCommand" as vcc LOGIC_COLOR
 end box
 
@@ -16,7 +15,7 @@ end box
 
 [->logic : execute
 activate logic
-ref over logic, abp, vcc: View Contact Command Sequence
+ref over logic, vcc: Create ViewContactCommand
 logic -> vcc ++: execute(model)
 vcc -> model ++: setViewedPersonIndex(targetIndex)
 model --> vcc --:

docs/team/jason-raiin.md

@@ -12,36 +12,40 @@ My contributions to the project are listed below.
 
 - **New Feature**: Remove contact from meeting command
   - Added command and parser
-  - Thorough testing
 
+- **New Feature**: Mark meeting command
+  - Added command and parser
+  - Updates last contacted time for contacts
 
 - **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=jason-raiin&breakdown=true)
 
 - **Project management**:
-
-  - to be added soon
+  - Contributed issues
+  - Reviewed PRs
 
 - **Enhancements to existing features**:
-
-  - Add Tag to meetings: logic and UI
+  - Add Tags field to meetings
   - Convert Tag to factory class with no duplicates
+  - Added Status field to meetings
 
 - **Documentation**:
 
   - User Guide
-    - Remove meeting contact command
+    - `rmmc` command
+    - `mark` command
     - Minor edits
 
   - Developer Guide
+    - `rmmc` command
+    - `mark` command
     - User profile
     - Value proposition
     - User stories
     - Use cases
 
 - **Community**:
-
   - to be added soon
 
 - **Tools**:
-
   - Added util method `parseIndexes`
+  - Improved methods for `typicalMeetings` and `typicalAddressBook`

docs/team/lomaply.md

@@ -26,7 +26,7 @@ My contributions to the project are listed below.
     - Review and merge pull requests
 
 - **Enhancements to existing features**:
-  
+
   - Sort contacts by last contacted time
   - New Command
     - "editm"
@@ -39,7 +39,7 @@ My contributions to the project are listed below.
     - First draft of User Guide with initial plans for v1.2
     - Update parts of User Guide on `viewm`, `viewc`, `editm`
   - Developer Guide
-    - Add Implementation notes on `viewm` & `viewc`
+    - Add Implementation notes on `viewm`, `viewc`, `editc` and `editm`
 
 - **Community**:
 

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

@@ -71,6 +71,8 @@ public static String format(Meeting meeting) {
                 .append(meeting.getEnd())
                 .append("; Attendees: ");
         meeting.getAttendees().forEach(builder::append);
+        builder.append("; Completed: ")
+                .append(meeting.getStatus());
         return builder.toString();
     }
 

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

@@ -79,7 +79,7 @@ static Meeting addAttendee(Meeting meeting, Attendee attendeeToAdd) {
         Set<Attendee> updatedAttendees = new LinkedHashSet<>(meeting.getAttendees());
         updatedAttendees.add(attendeeToAdd);
         Meeting updatedMeeting = new Meeting(meeting.getTitle(), meeting.getLocation(), meeting.getStart(),
-                meeting.getEnd(), updatedAttendees, meeting.getTags());
+                meeting.getEnd(), updatedAttendees, meeting.getTags(), meeting.getStatus());
 
         return updatedMeeting;
     }

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

@@ -25,6 +25,7 @@
 import seedu.address.model.meeting.Attendee;
 import seedu.address.model.meeting.Location;
 import seedu.address.model.meeting.Meeting;
+import seedu.address.model.meeting.MeetingStatus;
 import seedu.address.model.meeting.MeetingTime;
 import seedu.address.model.meeting.Title;
 import seedu.address.model.tag.Tag;
@@ -102,12 +103,13 @@ static Meeting createEditedMeeting(Meeting meetingToEdit,
         LocalDateTime updatedEnd = editMeetingDescriptor.getEnd().orElse(meetingToEdit.getEnd());
         Set<Attendee> attendees = meetingToEdit.getAttendees();
         Set<Tag> updatedTags = editMeetingDescriptor.getTags().orElse(meetingToEdit.getTags());
+        MeetingStatus status = meetingToEdit.getStatus();
 
         if (!MeetingTime.isValidMeetingTime(updatedStart, updatedEnd)) {
             throw new CommandException(MeetingTime.MESSAGE_CONSTRAINTS);
         }
 
-        return new Meeting(updatedTitle, updatedLocation, updatedStart, updatedEnd, attendees, updatedTags);
+        return new Meeting(updatedTitle, updatedLocation, updatedStart, updatedEnd, attendees, updatedTags, status);
     }
 
     @Override

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

@@ -34,7 +34,7 @@ public class FindMeetingCommand extends Command {
      * @param predicate The predicate that will be used by the FindMeetingCommand object.
      */
     public FindMeetingCommand(GeneralMeetingPredicate predicate) {
-        assert predicate != null;
+        requireNonNull(predicate);
         this.predicate = predicate;
     }
 

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

@@ -0,0 +1,105 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+
+import java.time.LocalDateTime;
+import java.util.Iterator;
+import java.util.List;
+
+import seedu.address.commons.core.index.Index;
+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.meeting.Attendee;
+import seedu.address.model.meeting.Meeting;
+import seedu.address.model.meeting.MeetingStatus;
+import seedu.address.model.person.Person;
+
+/**
+ * Marks a meeting as complete.
+ */
+public class MarkMeetingCommand extends Command {
+
+    public static final String COMMAND_WORD = "mark";
+
+    public static final String MESSAGE_MARK_MEETING_SUCCESS = "Meeting marked as complete: %1$s";
+
+    public static final String MESSAGE_MEETING_ALREADY_COMPLETE = "Meeting has already been marked as complete.";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD
+            + ": Marks the meeting identified by the index number used in the displayed meetings list as complete.\n"
+            + "Parameters: INDEX (must be a positive integer)\n" + "Example: " + COMMAND_WORD + "1";
+
+    private final Index targetIndex;
+
+    public MarkMeetingCommand(Index targetIndex) {
+        this.targetIndex = targetIndex;
+    }
+
+    @Override
+    public CommandResult execute(Model model) throws CommandException {
+        requireNonNull(model);
+        List<Meeting> lastShownList = model.getFilteredMeetingList();
+
+        if (targetIndex.getZeroBased() >= lastShownList.size()) {
+            throw new CommandException(Messages.MESSAGE_INVALID_MEETING_DISPLAYED_INDEX);
+        }
+
+        Meeting meetingToMark = lastShownList.get(targetIndex.getZeroBased());
+        Meeting updatedMeeting = markMeeting(meetingToMark);
+        model.setMeeting(meetingToMark, updatedMeeting);
+
+        Iterator<Attendee> attendeeIterator = meetingToMark.getAttendees().iterator();
+        while (attendeeIterator.hasNext()) {
+            Attendee attendee = attendeeIterator.next();
+            Person person = model.getPerson(attendee.getAttendeeName());
+            Person updatedPerson = updateLastContactedTime(person, meetingToMark.getEnd());
+            model.setPerson(person, updatedPerson);
+        }
+
+        return new CommandResult(String.format(MESSAGE_MARK_MEETING_SUCCESS, Messages.format(updatedMeeting)));
+    }
+
+    static Meeting markMeeting(Meeting meeting) throws CommandException {
+        if (meeting.getStatus().isComplete) {
+            throw new CommandException(MESSAGE_MEETING_ALREADY_COMPLETE);
+        }
+
+        Meeting markedMeeting = new Meeting(meeting.getTitle(), meeting.getLocation(), meeting.getStart(),
+                meeting.getEnd(), meeting.getAttendees(), meeting.getTags(), new MeetingStatus(true));
+
+        return markedMeeting;
+    }
+
+    static Person updateLastContactedTime(Person person, LocalDateTime lastContactedTime) {
+        if (lastContactedTime.isBefore(person.getLastContactedTime())) {
+            return person;
+        }
+
+        Person updatedPerson = new Person(person.getName(), person.getPhone(), person.getEmail(), lastContactedTime,
+                person.getStatus(), person.getRemark(), person.getTags());
+
+        return updatedPerson;
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if (other == this) {
+            return true;
+        }
+
+        // instanceof handles nulls
+        if (!(other instanceof MarkMeetingCommand)) {
+            return false;
+        }
+
+        MarkMeetingCommand otherMarkMeetingCommand = (MarkMeetingCommand) other;
+        return targetIndex.equals(otherMarkMeetingCommand.targetIndex);
+    }
+
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this).add("targetIndex", targetIndex).toString();
+    }
+}

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

@@ -68,7 +68,7 @@ static Meeting removeAttendee(Meeting meeting, Attendee attendeeToRemove) {
         Set<Attendee> updatedAttendees = new LinkedHashSet<>(meeting.getAttendees());
         updatedAttendees.remove(attendeeToRemove);
         Meeting updatedMeeting = new Meeting(meeting.getTitle(), meeting.getLocation(), meeting.getStart(),
-                meeting.getEnd(), updatedAttendees, meeting.getTags());
+                meeting.getEnd(), updatedAttendees, meeting.getTags(), meeting.getStatus());
 
         return updatedMeeting;
     }

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

@@ -20,6 +20,7 @@
 import seedu.address.model.meeting.Attendee;
 import seedu.address.model.meeting.Location;
 import seedu.address.model.meeting.Meeting;
+import seedu.address.model.meeting.MeetingStatus;
 import seedu.address.model.meeting.MeetingTime;
 import seedu.address.model.meeting.Title;
 import seedu.address.model.tag.Tag;
@@ -56,8 +57,9 @@ public AddMeetingCommand parse(String args) throws ParseException {
         }
         Set<Attendee> attendeeList = ParserUtil.parseAttendees(argMultimap.getAllValues(PREFIX_NAME));
         Set<Tag> tagList = ParserUtil.parseTags(argMultimap.getAllValues(PREFIX_TAG));
+        MeetingStatus status = new MeetingStatus(false);
 
-        Meeting meeting = new Meeting(title, location, start, end, attendeeList, tagList);
+        Meeting meeting = new Meeting(title, location, start, end, attendeeList, tagList, status);
 
         return new AddMeetingCommand(meeting);
     }