Merge pull request #150 from 1rbg/v1.4-GabrielDGUpdates

V1.4 gabriel dg updates

docs/DeveloperGuide.md

@@ -4,14 +4,40 @@ title: Developer Guide
 ---
 
 * Table of Contents
-  {:toc}
+    * [**Acknowledgements**](#Acknowledgements)
+    * [**Setting up, getting started**](#Setting-up-getting-started)
+    * [**Design**](#Design)
+        * [Architecture](#Architecture)
+        * [UI component](#UI-component)
+        * [Logic component](#Logic-component)
+        * [Model component](#Model-component)
+        * [Storage component](#Storage-component)
+        * [Common classes](#Common-classes)
+    * [**Implementation**](#Implementation)
+        * [\[Implemented\] Schedule feature](#implemented-schedule-feature)
+            * [Proposed Implementation](#proposed-implementation)
+        * [\[Implemented\] Contact archiving](#implemented-contact-archiving)
+            * [Proposed Implementation](#proposed-implementation)
+        * [\[Proposed\] Undo/redo feature](#proposed-undoredo-feature)
+            * [Proposed Implementation](#proposed-implementation)
+            * [Design considerations:](#design-considerations)
+    * [**Documentation, logging, testing, configuration, dev-ops**](#documentation-logging-testing-configuration-dev-ops)
+    * [**Appendix: Requirements**](#appendix-requirements)
+        * [Product scope](#product-scope)
+        * [User stories](#user-stories)
+        * [Use cases](#use-cases)
+        * [Non-Functional Requirements](#non-functional-requirements)
+        * [Glossary](#glossary)
+    * [**Appendix: Instructions for manual testing**](#appendix-instructions-for-manual-testing)
+        * [Launch and shutdown](#launch-and-shutdown)
+        * [Deleting a person](#deleting-a-person)
+        * [Saving data](#saving-data)
 
 --------------------------------------------------------------------------------------------------------------------
 
 ## **Acknowledgements**
 
-* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the
-  original source as well}
+* Calendar for Schedule feature adapted from: https://gist.github.com/Da9el00/f4340927b8ba6941eb7562a3306e93b6
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -41,8 +67,8 @@ Given below is a quick overview of main components and how they interact with ea
 **Main components of the architecture**
 
 **`Main`** (consisting of
-classes [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java)
-and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java)) is
+classes [`Main`](https://github.com/AY2324S2-CS2103T-T17-4/tp/tree/master/src/main/java/seedu/address/Main.java)
+and [`MainApp`](https://github.com/AY2324S2-CS2103T-T17-4/tp/tree/master/src/main/java/seedu/address/MainApp.java)) is
 in charge of the app launch and shut down.
 
 * At app launch, it initializes the other components in the correct sequence, and connects them up with each other.
@@ -82,7 +108,7 @@ The sections below give more details of each component.
 ### UI component
 
 The **API** of this component is specified
-in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
+in [`Ui.java`](https://github.com/AY2324S2-CS2103T-T17-4/tp/tree/master/src/main/java/seedu/address/ui/Ui.java)
 
 ![Structure of the UI Component](images/UiClassDiagram.png)
 
@@ -93,9 +119,9 @@ visible GUI.
 
 The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that
 are in the `src/main/resources/view` folder. For example, the layout of
-the [`MainWindow`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java)
+the [`MainWindow`](https://github.com/AY2324S2-CS2103T-T17-4/tp/tree/master/src/main/java/seedu/address/ui/MainWindow.java)
 is specified
-in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml)
+in [`MainWindow.fxml`](https://github.com/AY2324S2-CS2103T-T17-4/tp/tree/master/src/main/resources/view/MainWindow.fxml)
 
 The `UI` component,
 
@@ -106,7 +132,7 @@ The `UI` component,
 
 ### Logic component
 
-The **API** of this component is specified in [`Logic.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/logic/Logic.java)
+The **API** of this component is specified in [`Logic.java`](https://github.com/AY2324S2-CS2103T-T17-4/tp/tree/master/src/main/java/seedu/address/logic/Logic.java)
 
 Here's a (partial) class diagram of the `Logic` component:
 
@@ -147,7 +173,7 @@ How the parsing works:
 ### Model component
 
 **API
-** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java)
+** : [`Model.java`](https://github.com/AY2324S2-CS2103T-T17-4/tp/tree/master/src/main/java/seedu/address/model/Model.java)
 
 <img src="images/ModelClassDiagram.png" width="450" />
 
@@ -173,7 +199,7 @@ The `Model` component,
 ### Storage component
 
 **API
-** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java)
+** : [`Storage.java`](https://github.com/AY2324S2-CS2103T-T17-4/tp/tree/master/src/main/java/seedu/address/storage/Storage.java)
 
 <img src="images/StorageClassDiagram.png" width="550" />
 
@@ -196,6 +222,38 @@ Classes used by multiple components are in the `seedu.addressbook.commons` packa
 
 This section describes some noteworthy details on how certain features are implemented.
 
+### \[Implemented\] Schedule feature
+#### Proposed Implementation
+
+The current implementation of the schedule feature is facilitated by the `Schedule` interface. It contains a 
+`Set<ScheduleDate>`, which contains the `ScheduleDate` objects that represent the dates in the schedule and hold a
+list of who is working on that particular date.
+
+Given below is an example usage scenario and how the schedule mechanism behaves at each step.
+
+Step 1. The user launches the application for the first time. A concrete class implementing `Schedule` will be 
+initialised with an empty set of `ScheduleDate` objects. The `ModelManager` is then initialised with the `Schedule`. 
+
+Step 2. The user executes `schedule 98765432 2024-04-15` command to add a schedule entry for the person with phone 
+number `98765432` on the date `2024-04-15`. The old `Schedule` object is then updated in the `Model` through the calling 
+of `Model#addPersonToSchedule()`, which creates a new `ScheduleDate` object that corresponds to the date 
+`2024-04-15`, and adds the person with phone number `98765432` to the list of people working on that date. The UI 
+changes screen to show the updated schedule.
+
+<img src="images/ScheduleSequenceDiagram.png"/>
+
+Step 3. The user decides that he would like to add another person on the same date. The user executes `schedule 
+92345678 2024-04-15` command to add a schedule entry for the person with phone number `92345678` on the date 
+`2024-04-15`. The old `Schedule` object is then updated in the `Model` through the calling of 
+`Model#addPersonToSchedule()`, which uses the existing `ScheduleDate` object associated with `2024-04-15` that 
+corresponds to the date `2024-04-15`, and adds the person with phone number `98765432` to the list of people working 
+on that date. The UI changes screen to show the updated schedule.
+
+Step 4. The user decides that he would like to remove the schedule entry. The user executes `unschedule 98765432 
+2024-04-15` command to remove the schedule entry for the person with phone number `98765432` on the date 
+`2024-04-15`. The `unschedule` command removes a person with phone number `98765432` from the existing 
+`ScheduleDate` with date `2024-04-15`. The UI changes screen to show the updated schedule.
+
 ### \[Implemented\] Contact archiving
 #### Proposed Implementation
 
@@ -359,14 +417,15 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
 | Priority | As a …​                                                        | I want to …​                                       | So that I can…​                                                       |
 |----------|----------------------------------------------------------------|----------------------------------------------------|-----------------------------------------------------------------------|
-| `* *`    | new user                                                       | see a tutorial and usage instructions              | familiarise with FnBuddy' features                                 |
+| `* *`    | new user                                                       | see a tutorial and usage instructions              | familiarise with FnBuddy' features                                    |
 | `* * *`  | user                                                           | add an employee contact with banking details       | quickly access the employee's banking details for salary disbursement |
 | `* * *`  | user                                                           | delete an employee contact                         | remove entries that I no longer need                                  |
 | `* * *`  | user                                                           | view all employee contacts                         |                                                                       |
 | `* *`    | user                                                           | track an employee's weekly worked hours            | access it for employee salary calculation                             |
 | `* *`    | user handling employees with a variety of employment contracts | tag an employee contact with their employment type | retrieve the salary rate of the employee                              |
 | `* *`    | user with human error tendencies                               | retrieve an employee's calculated pay              | avoid paying out an incorrect salary amount                           |
 | `* *`    | user                                                           | edit an employee contact details                   | keep the employee's details up to date                                |
+| `* *`    | user                                                           | schedule my employee shifts                        | plan workload more easily                                             |
 | `*`      | user with many employees                                       | sort employees contacts by name                    | locate the employee contact easily                                    |
 | `*`      | user with potential returning employees                        | archive an employee contact                        | reopen the employee's details when they return easily                 |
 | `*`      | user with forgetfulness                                        | search for contacts by keyword                     | find contacts without needing to provide their full name              |

docs/diagrams/ScheduleSequenceDiagram.puml

@@ -0,0 +1,76 @@
+@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 ":ScheduleCommandParser" as ScheduleCommandParser LOGIC_COLOR
+participant "a:ScheduleCommand" as ScheduleCommand LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "m:Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("schedule 98765432 2024-04-15")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("schedule 98765432 2024-04-15")
+activate AddressBookParser
+
+create ScheduleCommandParser
+AddressBookParser -> ScheduleCommandParser
+activate ScheduleCommandParser
+
+ScheduleCommandParser --> AddressBookParser
+deactivate ScheduleCommandParser
+
+AddressBookParser -> ScheduleCommandParser : parse("98765432 2024-04-15")
+activate ScheduleCommandParser
+
+create ScheduleCommand
+ScheduleCommandParser -> ScheduleCommand
+activate ScheduleCommand
+
+ScheduleCommand --> ScheduleCommandParser :
+deactivate ScheduleCommand
+
+ScheduleCommandParser --> AddressBookParser : a
+deactivate ScheduleCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+ScheduleCommandParser -[hidden]-> AddressBookParser
+destroy ScheduleCommandParser
+
+AddressBookParser --> LogicManager : a
+deactivate AddressBookParser
+
+LogicManager -> ScheduleCommand : execute(m)
+activate ScheduleCommand
+
+ScheduleCommand -> Model : getPersonByPhoneNumber("98765432")
+activate Model
+
+Model --> ScheduleCommand : p1
+deactivate Model
+
+ScheduleCommand -> Model : addPersonToSchedule(p1, "2024-04-15")
+activate Model
+
+Model --> ScheduleCommand
+deactivate Model
+
+create CommandResult
+ScheduleCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> ScheduleCommand
+deactivate CommandResult
+
+ScheduleCommand --> LogicManager : r
+deactivate ScheduleCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml