Merge pull request AY2425S1-CS2103T-F11-2#149 from Rachelcoll/documents

Update UG and DG implementation for `attendance` `mark` and `unmark` command
yyihaoc · Nov 6, 2024 · 317129b · 317129b
2 parents 88da46f + b3ff363
commit 317129b
Show file tree

Hide file tree

Showing 18 changed files with 321 additions and 157 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -150,6 +150,70 @@ Examples:
 * `list` followed by `delete 2` deletes the 2nd person in the address book.
 * `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.
 
+### Listing all members for attendance : `attendance`
+
+Lists all contacts that have the role “Member” in the address book, making it easier to check and mark attendance for them directly.
+
+Format: `attendance` or `atd` (alias)
+
+* The command must be in lowercase. Variations (e.g., capitalized or mixed-case) will not be recognized.
+* This command does not take any additional parameters. If any extra input is provided, an error message will be displayed.
+
+
+![result for 'attendance'](images/ListAttendanceResult.png)
+
+### Marking attendance : `mark`
+
+Marks attendance for **members** with specified Telegram handles on a specific date.
+
+
+Format: `mark t/TELEGRAM1 [t/TELEGRAM2] [...] d/DATE`
+
+Alternative Format: `m t/TELEGRAM1 [t/TELEGRAM2] [...] d/DATE`
+
+* Each Telegram handle must begin with t/, followed by an alphanumeric or _ string with no spaces, e.g., t/berniceyu123.
+* The command is not case-sensitive (e.g., t/alexyeoh is the same as t/ALEXYEOH) except command keyword `mark` itself.
+* The command does not allow spaces between the prefix t/ or d/ and the argument.
+
+Command Parameters:
+- Telegram Handles (`t/telegram`):
+  * Accepts multiple handles separated by spaces, each beginning with t/.
+  * Handles must be alphanumeric or include _ (e.g., t/alex_yeoh123).
+  * Invalid input: Spaces within or after the prefix (e.g., t/ alexyeoh) result in an error.
+  * Telegram handle should belong to a contact with `Member` role.
+
+- Date (`d/date`)
+  * Takes in one string value with format d/YYYY-MM-DD (eg. d/2024-01-22 not d/2024/1/22)
+  * Only accept one date, if multiple dates are input, only the last one will be recorded as the attendance date.
+  * Date must not be later than current date (eg. 2090-11-02 is an invalid datetime)
+
+Examples:
+
+* `mark t/toom t/maary d/2024-11-02`
+
+  ![result of command `mark t/toom t/maary d/2024-11-02`](images/MarkCommandResult.png)
+
+* Mark attendance of contact with telegram `toom` first, then input command `mark t/toom t/maary d/2024-11-02`
+
+  ![img_3.png](images/RepeatedMarkCommandResult.png)  
+
+* Mark attendance of a non-member contact `mark t/jerry d/2024-11-02`
+
+  ![result of command `mark t/jerry d/2024-11-02`](images/MarkNonMemberCommandResult.png)
+
+
+### Unmarking attendance : `unmark`
+
+Unmarks attendance for **members** with specified Telegram handles on a specific date.
+
+
+Format: `unmark t/TELEGRAM1 [t/TELEGRAM2] [...] d/DATE`
+
+Alternative Format: `um t/TELEGRAM1 [t/TELEGRAM2] [...] d/DATE` 
+
+* All parameter constraints and error messages are the same as `mark` command, except `mark` is replaced by `unmark`
+
+
 ### Clearing all entries : `clear`
 
 Clears all entries from the address book.
@@ -206,3 +270,6 @@ Action | Format, Examples
 **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
 **List** | `list`
 **Help** | `help`
+**Attendance** | `attendance` or `atd`
+**Mark Attendance** | `mark t/TELEGRAM1 [t/TELEGRAM2] [...] d/DATE` or `m t/TELEGRAM1 [t/TELEGRAM2] [...] d/DATE` <br> e.g., `mark t/berniceYu t/alexYeoh d/2024-11-02`
+**Unmark Attendance** | `unmark t/TELEGRAM1 [t/TELEGRAM2] [...] d/DATE` or `um t/TELEGRAM1 [t/TELEGRAM2] [...] d/DATE`
diff --git a/docs/diagrams/MarkAttendanceActivityDiagram.puml b/docs/diagrams/MarkAttendanceActivityDiagram.puml
@@ -0,0 +1,20 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+start
+:User inputs telegram handles and date to mark attendance
+:User executes command;
+
+'Since the beta syntax does not support placing the condition outside the
+'diamond we place it as the true branch instead.
+
+if () then ([user input is valid])
+    :Get list of Members from filteredPersonList of model;
+    :Create copy of existing member
+    Add attendance of the specified date to each member;
+    :Update corresponding members in address book;
+else ([else])
+endif
+stop
+@enduml
diff --git a/docs/diagrams/MarkAttendanceCommandClassDiagram.puml b/docs/diagrams/MarkAttendanceCommandClassDiagram.puml
@@ -0,0 +1,50 @@
+@startuml
+!include style.puml
+skinparam ClassFontColor #000000
+skinparam ClassBorderColor #000000
+skinparam ClassBackgroundColor #FFFFAA
+
+' Class Diagram for MarkAttendance Feature
+
+class AddressBook {
+    - FilteredList<Person> filteredPersons
+    + void setPerson(Person target, Person updatedPerson)
+    + FilteredList<Person> getFilteredPersonList()
+}
+
+class Model
+
+class Person {
+    + boolean isMember()
+}
+
+class Attendance {
+    - LocalDate session
+}
+
+class Role
+
+class Member
+
+class AttendanceMarkingCommand {
+    + List<String> displayMembers()
+}
+
+class MarkAttendanceCommand {
+    - List<Telegram> telegrams
+    - Attendance attendance
+    + CommandResult execute(Model model) throws CommandException
+}
+
+
+' Relationships
+AttendanceMarkingCommand .right.|> Command
+MarkAttendanceCommand .up.|> AttendanceMarkingCommand
+ModelManager .left.|> Model
+ModelManager o-- AddressBook
+AddressBook o-left- Person
+MarkAttendanceCommand -right-> Model : uses
+Member .right.|> Role
+Person -left-> "*" Role : contains
+Person --> "*" Attendance : contains
+@enduml
diff --git a/docs/diagrams/MarkAttendanceSequenceDiagram-Logic.puml b/docs/diagrams/MarkAttendanceSequenceDiagram-Logic.puml
@@ -0,0 +1,64 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":MarkAttendanceCommandParser" as MarkAttendanceCommandParser LOGIC_COLOR
+participant "m:MarkAttendanceCommand" as MarkAttendanceCommand LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+[-> LogicManager : execute(mark)
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand(mark)
+activate AddressBookParser
+
+create MarkAttendanceCommandParser
+AddressBookParser -> MarkAttendanceCommandParser
+activate MarkAttendanceCommandParser
+
+create MarkAttendanceCommand
+MarkAttendanceCommandParser -> MarkAttendanceCommand : parse(arguments)
+activate MarkAttendanceCommand
+
+MarkAttendanceCommand --> MarkAttendanceCommandParser : m
+deactivate MarkAttendanceCommand
+
+MarkAttendanceCommandParser --> AddressBookParser
+deactivate MarkAttendanceCommandParser
+
+AddressBookParser --> LogicManager : m
+deactivate AddressBookParser
+
+LogicManager -> MarkAttendanceCommand : execute()
+activate MarkAttendanceCommand
+
+MarkAttendanceCommand -> Model : getFilteredPersonList()
+activate Model
+
+Model --> MarkAttendanceCommand : filteredPersonList
+deactivate Model
+
+MarkAttendanceCommand -> MarkAttendanceCommand : markAttendance()
+activate MarkAttendanceCommand
+
+MarkAttendanceCommand -> Model : setPerson()
+activate Model
+
+MarkAttendanceCommand -> MarkAttendanceCommand : findByTelegram()
+activate MarkAttendanceCommand
+
+MarkAttendanceCommand --> LogicManager : result
+deactivate MarkAttendanceCommand
+
+MarkAttendanceCommand -[hidden]-> LogicManager : result
+destroy MarkAttendanceCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/MarkAttendanceSequenceDiagram-Model.puml b/docs/diagrams/MarkAttendanceSequenceDiagram-Model.puml
@@ -0,0 +1,24 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+participant ":AddressBook" as AddressBook MODEL_COLOR
+participant "persons:UniquePersonList" as UniquePersonList MODEL_COLOR
+end box
+
+[-> Model : setPerson(p)
+activate Model
+
+Model -> AddressBook : setPerson(p)
+activate AddressBook
+
+AddressBook -> UniquePersonList : contains(p)
+AddressBook --> Model
+deactivate AddressBook
+
+[<-- Model
+deactivate Model
+
+@enduml
diff --git a/docs/diagrams/UndoRedoState0.puml b/docs/diagrams/UndoRedoState0.puml
diff --git a/docs/diagrams/UndoSequenceDiagram-Logic.puml b/docs/diagrams/UndoSequenceDiagram-Logic.puml
diff --git a/docs/diagrams/UndoSequenceDiagram-Model.puml b/docs/diagrams/UndoSequenceDiagram-Model.puml
diff --git a/docs/diagrams/style.puml b/docs/diagrams/style.puml
@@ -75,5 +75,5 @@ skinparam DefaultTextAlignment center
 skinparam packageStyle Rectangle
 
 hide footbox
-hide members
+hide empty members
 hide circle
diff --git a/docs/images/ListAttendanceResult.png b/docs/images/ListAttendanceResult.png
diff --git a/docs/images/MarkAttendanceActivityDiagram.png b/docs/images/MarkAttendanceActivityDiagram.png
diff --git a/docs/images/MarkAttendanceCommandClassDiagram.png b/docs/images/MarkAttendanceCommandClassDiagram.png
diff --git a/docs/images/MarkAttendanceSequenceDiagram-Logic.png b/docs/images/MarkAttendanceSequenceDiagram-Logic.png
diff --git a/docs/images/MarkAttendanceSequenceDiagram-Model.png b/docs/images/MarkAttendanceSequenceDiagram-Model.png
diff --git a/docs/images/MarkCommandResult.png b/docs/images/MarkCommandResult.png
diff --git a/docs/images/MarkNonMemberCommandResult.png b/docs/images/MarkNonMemberCommandResult.png
diff --git a/docs/images/RepeatedMarkCommandResult.png b/docs/images/RepeatedMarkCommandResult.png