Merge branch 'master' into branch-add-DG

Author: channne

docs/DeveloperGuide.md

@@ -218,17 +218,56 @@ The following **UML activity diagram** shows what happens when a user executes a
 <img src="images/AddLabCommandActivityDiagram.png" width="600" />
 
 
-### Filter Feature
+### `filter`: Filter Students by Labs Feature
 
-#### Proposed Implementation
+The `filter` feature allows user to filter the list of students by their `Lab` and its `LabStatus`.
 
-The Filter feature is implemented by updating the `listOfStudents` using `StudentHasLabPredicate` which extends
-`Predicate`. `StudentHasLabPredicate` contains the attribute `Lab` and overrides the `Predicate#test()` method to
+The Filter feature is implemented by updating `fitleredStudents` using `StudentHasLabPredicate` which extends
+`Predicate<Student>`. `StudentHasLabPredicate` contains the attribute `Lab` and overrides the `Predicate#test()` method to
 determine if a `Student` has a specific `Lab` in its `LabList`.
 
+The command format for filter is `fitler l/LAB_NUMBER s/LAB_STATUS` where `LAB_NUMBER` should a `Lab` that exists within
+TAddressBook and `LAB_STATUS` should be one of the three values below:
+- `u` : UNSUBMITTED
+- `s` : SUBMITTED
+- `g` : GRADED
+
 Given below is an example usage scenario and how the filter mechanism behaves at each step.
+1. When the user executes `filter` command, `FilterCommandParser#parse(String)` will be invoked to parse the given command
+    and create a `StudentHasLabPredicate` with a dummy `Lab` with the given `LabStatus`. Then, a new `FilterCommand` is
+    instantiated using the `StudentHasLabPredicate`.
+
+
+2. `FilterCommand#execute(Model)` will then execute the command on the current `Model` of the system.
+
+
+3. The `FilterCommand` object will check if the `Model` object contains the `Lab` carried by the `StudentHasLabPredicate`.
+    If the `Lab` is not found, a `CommandException` will be thrown.
+
+
+4. The `StudentHasLabPredicate` is passed as a parameter into the `Model#addOnFilteredStudentList(Predicate)` method.
+
+
+5. `Model` object retrieves its original `Predicate<Student>` to perform `Predicate#and(Predicate)` with the
+    `StudentHasLabPredicate` passed in. The new `Predicate<Student>` is used to filter the `filteredStudents` within
+    the `Model` object.
+
 
-Step 1. The user executes `filter l/1 s/s` command.
+6. A `CommandResult` object is created with a feedback message and is returned.
+
+The **UML sequence diagram** below shows the parsing of the user input using `FilterCommandParser` to create a
+`StudentHasLabPredicate` and subsequently a `FilterCommand` object.
+
+<img src="images/FilterCommandParserSequenceDiagram.png" width="850" />
+
+After the `FilterCommand` object is created, it is utilised to filter the student list.
+The following **UML sequence diagram** shows the interaction between the components during the execution of the `filter` command:
+
+<img src="images/FilterCommandSequenceDiagram.png" width="850" />
+
+The following **UML activity diagram** shows what happens when a `filter` command is executed:
+
+<img src="images/FilterCommandActivityDiagram.png" width="850" />
 
 
 ### `labedit`: Edit Lab Feature
@@ -303,57 +342,6 @@ Step 3. The user executes `add n/David …​` to add a new student. The `add` c
 
 ![UndoRedoState2](images/UndoRedoState2.png)
 
-<div markdown="span" class="alert alert-info">:information_source: **Note:** If a command fails its execution, it will not call `Model#commitAddressBook()`, so the TAddressBook state will not be saved into the `addressBookStateList`.
-
-</div>
-
-Step 4. The user now decides that adding the student was a mistake, and decides to undo that action by executing the `undo` command. The `undo` command will call `Model#undoAddressBook()`, which will shift the `currentStatePointer` once to the left, pointing it to the previous TAddressBook state, and restores the TAddressBook to that state.
-
-![UndoRedoState3](images/UndoRedoState3.png)
-
-<div markdown="span" class="alert alert-info">:information_source: **Note:** If the `currentStatePointer` is at index 0, pointing to the initial TAddressBook state, then there are no previous TAddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather
-than attempting to perform the undo.
-
-</div>
-
-The following sequence diagram shows how the undo operation works:
-
-![UndoSequenceDiagram](images/UndoSequenceDiagram.png)
-
-<div markdown="span" class="alert alert-info">:information_source: **Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
-
-</div>
-
-The `redo` command does the opposite — it calls `Model#redoAddressBook()`, which shifts the `currentStatePointer` once to the right, pointing to the previously undone state, and restores the TAddressBook to that state.
-
-<div markdown="span" class="alert alert-info">:information_source: **Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest TAddressBook state, then there are no undone TAddressBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
-
-</div>
-
-Step 5. The user then decides to execute the command `list`. Commands that do not modify the TAddressBook, such as `list`, will usually not call `Model#commitAddressBook()`, `Model#undoAddressBook()` or `Model#redoAddressBook()`. Thus, the `addressBookStateList` remains unchanged.
-
-![UndoRedoState4](images/UndoRedoState4.png)
-
-Step 6. The user executes `clear`, which calls `Model#commitAddressBook()`. Since the `currentStatePointer` is not pointing at the end of the `addressBookStateList`, all TAddressBook states after the `currentStatePointer` will be purged. Reason: It no longer makes sense to redo the `add n/David …​` command. This is the behavior that most modern desktop applications follow.
-
-![UndoRedoState5](images/UndoRedoState5.png)
-
-The following activity diagram summarizes what happens when a user executes a new command:
-
-<img src="images/CommitActivityDiagram.png" width="250" />
-
-#### Design considerations:
-
-**Aspect: How undo & redo executes:**
-
-* **Alternative 1 (current choice):** Saves the entire TAddressBook.
-  * Pros: Easy to implement.
-  * Cons: May have performance issues in terms of memory usage.
-
-* **Alternative 2:** Individual command knows how to undo/redo by itself.
-  * Pros: Will use less memory (e.g. for `delete`, just save the student being deleted).
-  * Cons: We must ensure that the implementation of each individual command is correct.
-
 --------------------------------------------------------------------------------------------------------------------
 
 ## **Documentation, logging, testing, configuration, dev-ops**

docs/UserGuide.md

@@ -53,7 +53,7 @@ If you can type fast, TAddressBook can get your lab management tasks done faster
     - [Find students](#locating-students-by-name--find)
     - [Delete students](#deleting-a-student--delete)
     - [Clear students](#clearing-all-entries--clear)
-    - [Filter students based on status of lab tags](#filter-by-status-of-individual-labs--filter)
+    - [Filter students by labs](#filter-by-status-of-individual-labs--filter)
     - [View student details](#view-student-details--view)
 
 - [Manage labs](#lab-related-features)

docs/diagrams/FilterCommandActivityDiagram.puml

@@ -0,0 +1,15 @@
+@startuml
+'https://plantuml.com/activity-diagram-beta
+
+start
+:User executes filter command with LAB_NUMBER and LAB_STATUS;
+:Dummy Lab created with the same LAB_NUMBER and LAB_STATUS;
+if () then ([Lab exists in Model])
+    :Create StudentHasLabPredicate using dummy Lab;
+    :Add on filter to studentList with StudentHasLabPredicate;
+else ([else])
+    :Displays error message;
+endif
+stop
+
+@enduml

docs/diagrams/FilterCommandParserSequenceDiagram.puml

@@ -0,0 +1,30 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant "p:FilterCommandParser" as FilterCommandParser LOGIC_COLOR
+participant "f:FitlerCommand" as FilterCommand LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "s:StudentHasLabPredicate" as StudentHasLabPredicate MODEL_COLOR
+end box
+
+[-> FilterCommandParser : parse("l/1 s/s")
+activate FilterCommandParser
+
+create StudentHasLabPredicate
+FilterCommandParser -> StudentHasLabPredicate : StudentHasLabPredicate(labToFilter)
+activate StudentHasLabPredicate
+StudentHasLabPredicate --> FilterCommandParser
+deactivate StudentHasLabPredicate
+
+create FilterCommand
+FilterCommandParser -> FilterCommand : FilterCommand(s)
+activate FilterCommand
+FilterCommand --> FilterCommandParser
+deactivate FilterCommand
+
+[<-- FilterCommandParser : f
+
+@enduml

docs/diagrams/FilterCommandSequence.puml

@@ -0,0 +1,33 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant "f:FilterCommand" as FilterCommand LOGIC_COLOR
+participant "c:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "m:Model" as Model MODEL_COLOR
+
+[-> FilterCommand : execute(m)
+activate FilterCommand
+
+FilterCommand -> Model : hasLab(toFilter)
+activate Model
+Model --> FilterCommand
+deactivate Model
+
+FilterCommand -> Model : addOnFilteredStudentList(predicate)
+activate Model
+Model --> FilterCommand
+deactivate Model
+
+create CommandResult
+FilterCommand -> CommandResult
+activate CommandResult
+CommandResult --> FilterCommand
+deactivate CommandResult
+
+[<-- FilterCommand : c
+
+@enduml

docs/diagrams/FilterCommandSequenceDiagram.puml

@@ -5,21 +5,56 @@ title: Channe Chwa's Project Portfolio Page
 
 ### Project: TAddressBook
 
-TAddress Book is a desktop app for CS2030S TAs to manage students and labs, optimized for use via a Command Line
-Interface. It is based on [AddressBook Level 3](https://se-education.org/addressbook-level3/).
+[TAddress Book](https://github.com/AY2122S2-CS2103-F10-1/tp) is a desktop app for CS2030S Teaching Assistants (TAs) to manage students and labs, in particular the grading process of lab assignments.
+It is based on [AddressBook Level 3](https://se-education.org/addressbook-level3/).
 
-Given below are my contributions to the project.
+Given below are my contributions to the project. The code contributed can be found at this [Reposense link](https://nus-cs2103-ay2122s2.github.io/tp-dashboard/?search=channne&breakdown=true&sort=groupTitle&sortWithin=title&since=2022-02-18&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other).
 
-**Features**
-1. Implemented ability to store marks associated with individual labs for individual students.
-    * Allows TA to keep track of marks given when grading labs.
-2. Implemented commands to allow for submission of labs, grading of labs and editing of lab details (status and/or marks).
-    * Allows TA to keep track of students' progress in labs as well as his/her own grading progress.
-
-**Code contributed**: [Reposense link](https://nus-cs2103-ay2122s2.github.io/tp-dashboard/?search=channne&breakdown=true&sort=groupTitle&sortWithin=title&since=2022-02-18&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other)
+### Features
 
-**Project management**: to be added soon
+#### New features
 
-**Documentation**: to be added soon
+* Added `LabMark` class ([#91](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/91))
+  * **Description**: Each `Lab` is associated with a `LabMark` which is `Unknown` when `LabStatus` is `UNSUBMITTED`/`SUBMITTED` and an integer from 0 to 100 when `LabStatus` is `GRADED`
+  * **Motivation**: Allows TA to keep track of marks given to individual labs when grading labs of students.
+  * **Highlights**: Involved multiple defensive checks comparing `LabMark` and `LabStatus` in order to ensure that invalid labs (e.g. `GRADED` labs with `Unknown` marks) did not exist
+* Implemented `SubmitLabCommand`, `GradeLabCommand`, `EditLabCommand` ([#91](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/91))
+  * **Description**:
+    * `SubmitLabCommand` allows for updating of `LabStatus` from `UNSUBMITTED` to `SUBMITTED`
+    * `GradeLabCommand` allows for updating of `LabStatus` from `UNSUBMITTED` or `SUBMITTED` to `GRADED` and updates `LabMark` from `Unknown` to a given integer from 0 to 100
+    * `EditLabCommand` allows for editing of `LabStatus` and/or `LabMark` (provided that the resultant lab is not invalid, e.g. `LabMark` is not `Unknown` yet `LabStatus` is not `GRADED`)
+  * **Motivation**:
+    * Allows TA to keep track of students' progress in labs as well as his/her own grading progress.
+    * Allows TA to modify previous data which may have been incorrectly entered.
+  * **Highlights**:
+    * `SubmitLabCommand` and `GradeLabCommand` are subclasses of `EditLabCommand` with an identical `Command#execute` method, which calls other methods that perform validity checks on the labs to be edited and return class-specific error messages. Differing behavior is implemented using the OOP principle of polymorphism by overriding of superclass methods.
+    * Originally was `EditLabStatusCommand` ([#71](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/71)), but refactored to three different commands after addition of `LabMark`
+
+#### Enhancements to existing features
+* Refactored `Person` from AddressBook Level 3 to `Student`
+  * Added `StudentId` attribute ([#50](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/50)), deleted `Phone` and `Address` attributes ([#52](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/52))
+  * Renamed class, variable and method names ([#76](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/76))
+  * Updated `AddCommand`, `EditCommand` and relevant tests
+* Fix bugs from PE-D: [#122](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/122)
+
+### Other contributions
+
+#### Documentation
+* User Guide (UG):
+  * Added documentation for `labsub`, `labgrad`, `labedit` ([#96](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/96))
+  * Added sample screenshots ([#133](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/133))
+  * Refined UG by standardizing formatting and parameter constraint descriptions (e.g. for `INDEX` and `LAB_MARK`)
+* Developer Guide (DG):
+  * Contributed to user stories and use cases UC1, UC3, UC4, UC5 ([#33](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/33), [#85](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/85))
+  * Added implementation details for `labedit` ([#143](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/143))
+  * Added instructions for manual testing of `labedit`
+* Ensured that PDF versions of UG and DG looked and worked as expected
+
+#### Project management
+* Managed issue tracker by converting user stories and other features to issues and assigning them to relevant team members
+* Helped to manage milestones by adding deadlines and labeling issues
+
+#### Review and mentoring
+* Helped to review team members' PRs, e.g. [#67](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/67), [#77](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/77), [#90](https://github.com/AY2122S2-CS2103-F10-1/tp/pull/90)
+* Contributed 11 bug reports/suggestions for another team during [PE-D](https://github.com/channne/ped/issues) 
 
-**Community**: to be added soon