Skip to content

Commit

Permalink
Merge branch 'master' into Bug_Fix4
Browse files Browse the repository at this point in the history
  • Loading branch information
howenc authored Nov 13, 2023
2 parents 4782a33 + 8c4353e commit bb9a106
Show file tree
Hide file tree
Showing 11 changed files with 365 additions and 126 deletions.
270 changes: 168 additions & 102 deletions docs/DeveloperGuide.md

Large diffs are not rendered by default.

41 changes: 41 additions & 0 deletions docs/diagrams/mark/CreateMarkMeetingCommandSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
@startuml CreateMarkMeetingCommand
!include ../style.puml

title Create MarkMeetingCommand

participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":MarkMeetingCommandParser" as MarkMeetingCommandParser LOGIC_COLOR
participant "command:MarkMeetingCommand" as MarkMeetingCommand LOGIC_COLOR

activate LogicManager

LogicManager -> AddressBookParser : parseCommand("mark 1")
activate AddressBookParser

create MarkMeetingCommandParser
AddressBookParser -> MarkMeetingCommandParser
activate MarkMeetingCommandParser

MarkMeetingCommandParser --> AddressBookParser
deactivate MarkMeetingCommandParser

AddressBookParser -> MarkMeetingCommandParser : parse("1")
activate MarkMeetingCommandParser

create MarkMeetingCommand
MarkMeetingCommandParser -> MarkMeetingCommand
activate MarkMeetingCommand

MarkMeetingCommand --> MarkMeetingCommandParser : command
deactivate MarkMeetingCommand

MarkMeetingCommandParser --> AddressBookParser : command
deactivate MarkMeetingCommandParser

'Hidden arrow to position the destroy marker below the end of the activation bar.
MarkMeetingCommandParser -[hidden]-> AddressBookParser
destroy MarkMeetingCommandParser

AddressBookParser --> LogicManager : command
deactivate AddressBookParser
40 changes: 40 additions & 0 deletions docs/diagrams/mark/MarkMeetingCommandSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
@startuml Execute MarkMeetingCommand
!include ../style.puml

title Execute MarkMeetingCommand

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant "command:MarkMeetingCommand" as MarkMeetingCommand LOGIC_COLOR
participant "result:CommandResult" as CommandResult LOGIC_COLOR
endbox

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
end box

[-> LogicManager : execute("mark 1")
activate LogicManager

ref over LogicManager, MarkMeetingCommand : Create MarkMeetingCommand

LogicManager -> MarkMeetingCommand : execute(model)
activate MarkMeetingCommand

ref over MarkMeetingCommand, Model : Mark Meeting

ref over MarkMeetingCommand, Model : Update Attendee LastContactedTime

create CommandResult
MarkMeetingCommand -> CommandResult
activate CommandResult

CommandResult --> MarkMeetingCommand
deactivate CommandResult

MarkMeetingCommand --> LogicManager : result
deactivate MarkMeetingCommand

[<--LogicManager : result
deactivate LogicManager
@enduml
34 changes: 34 additions & 0 deletions docs/diagrams/mark/MarkMeetingSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
@startuml MarkMeeting
!include ../style.puml

title Mark Meeting

box Logic LOGIC_COLOR_T1
participant "command:MarkMeetingCommand" as MarkMeetingCommand LOGIC_COLOR
endbox

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
participant "markedMeeting:Meeting" as Meeting MODEL_COLOR
end box

activate MarkMeetingCommand

MarkMeetingCommand -> MarkMeetingCommand : markMeeting(meeting)
activate MarkMeetingCommand

create Meeting
MarkMeetingCommand -> Meeting
activate Meeting

Meeting --> MarkMeetingCommand : markedMeeting
deactivate Meeting

MarkMeetingCommand --> MarkMeetingCommand : markedMeeting
deactivate MarkMeetingCommand

MarkMeetingCommand -> Model : setMeeting(meeting, markedMeeting)
activate Model

Model --> MarkMeetingCommand
deactivate Model
44 changes: 44 additions & 0 deletions docs/diagrams/mark/UpdateAttendeeSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
@startuml Update Attendee LastContactedTime
!include ../style.puml

title Update Attendee LastContactedTime

box Logic LOGIC_COLOR_T1
participant "command:MarkMeetingCommand" as MarkMeetingCommand LOGIC_COLOR
endbox

box Model MODEL_COLOR_T1
participant "updatedPerson:Person" as Person MODEL_COLOR
participant ":Model" as Model MODEL_COLOR
end box

activate MarkMeetingCommand

loop for each attendee

MarkMeetingCommand -> Model : getPerson(attendee)
activate Model

Model --> MarkMeetingCommand : person
deactivate Model

MarkMeetingCommand -> MarkMeetingCommand : updateLastContactedTime(person, time)
activate MarkMeetingCommand

create Person
MarkMeetingCommand -> Person
activate Person

Person -> MarkMeetingCommand : updatedPerson
deactivate Person

MarkMeetingCommand --> MarkMeetingCommand : updatedPerson
deactivate MarkMeetingCommand

MarkMeetingCommand -> Model : setPerson(person, updatedPerson)
activate Model

Model --> MarkMeetingCommand
deactivate Model

end
Binary file added docs/images/mark/CreateMarkMeetingCommand.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/mark/MarkMeeting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 37 additions & 23 deletions docs/team/jason-raiin.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,25 @@ title: Jason's Project Portfolio Page

### Project: OutBook

OutBook is a desktop personal secretary application used for saving contacts and scheduling meetings. Users can link their contacts to their meetings, to keep track of the personnel attending these meetings.
OutBook is a desktop data management application for freelance insurance agents to manage their numerous contacts and meeting schedule. Users can link their contacts to their meetings, to keep track of the personnel attending these meetings.

My contributions to the project are listed below.

- **New Feature**: Remove contact from meeting command (Pull Request [#51](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/51))
- What it does: Allows the user to remove an Attendee from the meeting.
- Justification: Basic functionality for meetings

- **New Feature**: Remove contact from meeting command
- Added command and parser
- **New Feature**: Add `Tag`s to meetings (Pull Request [#63](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/63))
- What it does: Meetings can have tags associated to them
- Justification: Enables searching and filtering, similar to Persons

- **New Feature**: Mark meeting command
- Added command and parser
- Updates last contacted time for contacts
- **New Features**: Add `Status` field to meetings (Pull Request [#105](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/105))
- What it does: Meetings can be marked as complete
- Justification: Users want to see which meetings have already been done

- **New Feature**: Mark meeting command (Pull Request [#105](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/105))
- What it does: Allows the user to mark a meeting as complete, and updates the last contacted time of all attendees
- Justification: Automates the updating of last contacted time for attendees

- **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=jason-raiin&breakdown=true)

Expand All @@ -24,32 +32,38 @@ My contributions to the project are listed below.
- Reviewed PRs

- **Enhancements to existing features**:
- Add tags to meetings
- Convert `Tag` to factory class with no duplicates
- Added `Status` field to meetings
- Duplicate contacts: added checks for duplicate emails and phones
- Email format: Improved Regex for email field
- `ParseException`: Improved throwing, handling, and display of parsing exceptions
- Used `LinkedHashSet` for attendees instead of `HashSet` (Pull Request [#51](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/51))
- Justification: Some commands require indexing of the Attendee set, so a `LinkedHashSet` is more appropriate to ensure that the indexing is consistent
- Convert `Tag` to factory class (Pull Request [#64](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/64))
- Justification: Eliminate duplicate objects to reduce memory usage
- `ParseException`: Improved throwing, handling, and display of parsing exceptions (Pull Request [#155](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/155))
- Justification: Allows the user to see the root cause when an error is encountered.
- Duplicate contacts: added checks for duplicate emails and phones (Pull Request [#161](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/161))
- Justification: Prevent duplicate entries
- Email format: Improved Regex for email field (Pull Request [#161](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/161))
- Justification: Narrowed the check to only accept common email formats.


- **Documentation**:

- User Guide
- `rmmc` command
- `mark` command
- Minor edits
- `rmmc` command guide
- `mark` command guide
- Proofreading and copywriting

- Developer Guide
- `rmmc` command
- `mark` command
- `rmmc` documentation and diagrams
- `mark` documentation and diagrams
- User profile
- Value proposition
- User stories
- Use cases

- **Community**:
- to be added soon

- **Tools**:
- Added util method `parseIndexes`
- Improved methods for `typicalMeetings` and `typicalAddressBook`
- Added `DateTimeUtil` for parsing and formatting dates
- Added util method `parseIndexes` (Pull Request [#51](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/51))
- What it does: Parses multiple indexes in a command and checks that the correct number of index arguments are provided
- Justification: `addmc` and `rmmc` commands take in multiple index arguments
- Improved methods for `typicalMeetings` and `typicalAddressBook` (Pull Request [#105](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/105))
- Justification: Increase ease of testing
- Added `DateTimeUtil` for parsing and formatting dates (Pull Request [#161](https://github.com/AY2324S1-CS2103T-F12-4/tp/pull/161))
- Justification: Abstract frequeuntly used parse and format methods into a common util
2 changes: 1 addition & 1 deletion docs/team/lomaply.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Linus' Project Portfolio Page

### Project: OutBook

OutBook is a desktop personal secretary application used for saving contacts and scheduling meetings. Users can link their contacts to their meetings, to keep track of the personnel attending these meetings.
OutBook is a desktop data management application for freelance insurance agents to manage their numerous contacts and meeting schedule. Users can link their contacts to their meetings, to keep track of the personnel attending these meetings.

My contributions to the project are listed below.

Expand Down

0 comments on commit bb9a106

Please sign in to comment.