Merge pull request #230 from salty-flower/dg-addt/delt

Update DG for `add-t`/`delete-t`

Author: gremmyz

docs/DeveloperGuide.md

@@ -494,8 +494,37 @@ The following activity diagram shows the logic of the `help` command.
 
 **Overview:**
 
+The `add-t` command is used to add additional tags to an existing `Person` in ConnectUS specified by the user.
+
+The format for the `add-t` command can be found [here](https://ay2223s2-cs2103t-w15-1.github.io/tp/UserGuide.html#46-adding-additional-tags-to-a-contact-add-t).
+
+<div style="page-break-after: always"></div>
+
 **Feature Details:**
 
+1. The user specifies a person index that represents a `Person` to be edited, followed by the tag to be added.
+2. If a negative or zero index is provided, an error is thrown. The user is prompted to re-enter the command correctly.
+3. If the index is not in valid range of the contact list provided, an error is thrown. The user is prompted to re-enter the command correctly.
+4. The `Person` is cross-referenced in the `Model` to check if it already exists. If it does, then an error is raised as feedback to the user.
+5. If step 5 completes without exceptions, the new `Person` will be successfully edited and stored inside the contact list.
+
+The following activity diagram shows the logic of the `add-t` command.
+
+![AddTagToPersonCommandActivityDiagram](images/AddTagToPersonCommandActivityDiagram.png)
+
+The sequence of the `add-t` command is as follows:
+
+1. The command `add-t INPUT` is entered by the user, where the `INPUT` is an integer index followed by a tag to add (e.g. `add-t 1 r/friend`).
+2. `Logic Manager` calls the `ConnectUsParser#parseCommand` with the given `INPUT`
+3. `ConnectUsParser` parses the command word. creating an instance of `AddTagToPersonCommandParser` to `parse` the tags via the respective `ParserUtil` functions.
+4. `AddTagToPersonCommandParser` creates the corresponding `AddTagDescriptor` object. This `AddTagDescriptor` object is taken as the input of a new `AddTagToPersonCommand` object created by `AddTagToPersonCommandParser`.
+5. `Logic Manager` executes `AddTagToPersonCommand#execute`, creating a `Person` from the aforementioned`AddTagDescriptor` object and adding this `Person` to the model through `Model#setPerson`.
+6. `Model#updateFilteredPersonList` is called to update the list of `Person` objects.
+7. A `Command Result` is returned with the result of the execution.
+
+The following sequence diagram shows how `add-t` works:
+
+![AddTagToPersonCommandSequenceDiagram](images/AddTagToPersonCommandSequenceDiagram.png)
 
 [↑ Back to top of section](#4-implementation)
 
@@ -507,8 +536,38 @@ The following activity diagram shows the logic of the `help` command.
 
 **Overview:**
 
+The `delete-t` command is used to delete individual tags from an existing `Person` in ConnectUS specified by the user.
+
+The format for the `delete-t` command can be found [here](https://ay2223s2-cs2103t-w15-1.github.io/tp/UserGuide.html#47-deleting-tags-from-a-contact-delete-t).
+
+<div style="page-break-after: always"></div>
+
 **Feature Details:**
 
+1. The user specifies a person index that represents a `Person` to be edited, followed by the tag index to be deleted.
+2. If a negative or zero index is provided, an error is thrown. The user is prompted to re-enter the command correctly.
+3. If the index is not in valid range of the contact list provided, an error is thrown. The user is prompted to re-enter the command correctly.
+4. The `Person` is cross-referenced in the `Model` to check if it already exists. If it does, then an error is raised as feedback to the user.
+5. If step 5 completes without exceptions, the tag of `Person` will be successfully deleted and this change will be stored inside the contact list.
+
+The following activity diagram shows the logic of the `delete-t` command.
+
+![DeleteTagFromPersonCommandActivityDiagram](images/DeleteTagFromPersonCommandActivityDiagram.png)
+
+The sequence of the `delete-t` command is as follows:
+
+1. The command `delete-t INPUT` is entered by the user, where the `INPUT` is an integer index followed by a tag index to delete (e.g. `delete-t 1 r/1`).
+2. `Logic Manager` calls the `ConnectUsParser#parseCommand` with the given `INPUT`
+3. `ConnectUsParser` parses the command word. creating an instance of `DeleteTagFromPersonCommandParser` to `parse` the tags via the respective `ParserUtil` functions.
+4. `DeleteTagFromPersonCommandParser` parses the corresponding tag indices. They are taken as the constructor arguments of a new `DeleteTagFromPersonCommand` object.
+5. `Logic Manager` executes `DeleteTagFromPersonCommand#execute`, creating a new `Person` with new tag lists from its parameters and replacing the original `Person` with this new `Person` in the model through `Model#setPerson`.
+6. `Model#updateFilteredPersonList` is called to update the list of `Person` objects.
+7. A `Command Result` is returned with the result of the execution.
+
+The following sequence diagram shows how `delete-t` works:
+
+![DeleteTagFromPersonCommandSequenceDiagram](images/DeleteTagFromPersonCommandSequenceDiagram.png)
+
 [↑ Back to top of section](#4-implementation)
 
 [↑ Back to table of contents](#table-of-contents)

docs/diagrams/AddTagToPersonCommandActivityDiagram.puml

@@ -0,0 +1,16 @@
+@startuml
+!pragma useVerticalIf on
+start
+:User enters add-t command;
+if () then ([else])
+  :Error: Invalid command format;
+  stop
+([Person index is provided and valid]) elseif () then ([else])
+  :Error: Invalid command format;
+  stop
+ else ([At least one tag is provided])
+endif
+  :add-t command successfully executes.;
+stop
+
+@enduml

docs/diagrams/AddTagToPersonCommandSequenceDiagram.puml

@@ -0,0 +1,73 @@
+@startuml
+!include style.puml
+
+skinparam defaultFontSize 40
+skinparam SequenceReferencebackgroundColor LightYellow
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":ConnectUsParser" as ConnectUsParser LOGIC_COLOR
+participant ":AddTagToPersonCommandParser" as AddTagToPersonCommandParser LOGIC_COLOR
+participant ":AddTagToPersonCommand" as AddTagToPersonCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":AddTagDescriptor" as AddTagDescriptor MODEL_COLOR
+participant ":Person" as Person MODEL_COLOR
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute(input)
+activate LogicManager
+
+LogicManager -> ConnectUsParser : parseCommand(input)
+activate ConnectUsParser
+
+create AddTagToPersonCommandParser
+ConnectUsParser -> AddTagToPersonCommandParser++
+return
+
+ConnectUsParser -> AddTagToPersonCommandParser : parse(args)
+activate AddTagToPersonCommandParser
+
+create AddTagDescriptor
+AddTagToPersonCommandParser -> AddTagDescriptor++
+return addTagDescriptor
+
+
+create AddTagToPersonCommand
+AddTagToPersonCommandParser -> AddTagToPersonCommand++
+return
+
+return addTagToPersonCommand
+destroy AddTagToPersonCommandParser
+
+return addTagToPersonCommand
+
+
+LogicManager->AddTagToPersonCommand : execute(model)
+activate AddTagToPersonCommand
+
+AddTagToPersonCommand -> Model : getFilteredPersonList()
+activate Model
+return
+
+AddTagToPersonCommand -> AddTagToPersonCommand : createEditedPerson(personToEdit, addTagDescriptor)
+
+AddTagToPersonCommand -> Model : setPerson(personToEdit, editedPerson)
+activate Model
+return
+
+AddTagToPersonCommand -> Model : updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS)
+activate Model
+return
+
+create CommandResult
+AddTagToPersonCommand ->CommandResult++
+return
+
+return commandResult
+return
+
+@enduml

docs/diagrams/DeleteTagFromPersonCommandActivityDiagram.puml

@@ -0,0 +1,19 @@
+@startuml
+!pragma useVerticalIf on
+start
+:User enters delete-t command;
+if () then ([else])
+  :Error: Invalid command format;
+  stop
+([Person index is provided]) elseif () then ([else])
+  :Error: Invalid command format;
+  stop
+([All tag indices provided are valid]) elseif () then ([else])
+  :Error: Invalid command format;
+  stop
+else ([At least one tag index is provided])
+endif
+  :delete-t command successfully executes.;
+stop
+
+@enduml

docs/diagrams/DeleteTagFromPersonCommandSequenceDiagram.puml

@@ -0,0 +1,69 @@
+@startuml
+!include style.puml
+
+skinparam defaultFontSize 40
+skinparam SequenceReferencebackgroundColor LightYellow
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":ConnectUsParser" as ConnectUsParser LOGIC_COLOR
+participant ":DeleteTagFromPersonCommandParser" as DeleteTagFromPersonCommandParser LOGIC_COLOR
+participant ":DeleteTagFromPersonCommand" as DeleteTagFromPersonCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Person" as Person MODEL_COLOR
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute(input)
+activate LogicManager
+
+LogicManager -> ConnectUsParser : parseCommand(input)
+activate ConnectUsParser
+
+create DeleteTagFromPersonCommandParser
+ConnectUsParser -> DeleteTagFromPersonCommandParser++
+return
+
+ConnectUsParser -> DeleteTagFromPersonCommandParser : parse(args)
+activate DeleteTagFromPersonCommandParser
+
+create DeleteTagFromPersonCommand
+DeleteTagFromPersonCommandParser -> DeleteTagFromPersonCommand++
+return
+
+return DeleteTagFromPersonCommand
+destroy DeleteTagFromPersonCommandParser
+
+return DeleteTagFromPersonCommand
+
+
+LogicManager->DeleteTagFromPersonCommand : execute(model)
+activate DeleteTagFromPersonCommand
+
+DeleteTagFromPersonCommand -> Model : getFilteredPersonList()
+activate Model
+return
+
+create Person
+DeleteTagFromPersonCommand -> Person++ : Person(personToEdit, editedRemarks, editedModules, editedCcas, editedMajors)
+return
+
+DeleteTagFromPersonCommand -> Model : setPerson(personToEdit, editedPerson)
+activate Model
+return
+
+DeleteTagFromPersonCommand -> Model : updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS)
+activate Model
+return
+
+create CommandResult
+DeleteTagFromPersonCommand ->CommandResult++
+return
+
+return commandResult
+return
+
+@enduml