Merge pull request #52 from AhQuanz/update-docs

Update DG Design section and Implementation for done command

Author: daniellau88

docs/DeveloperGuide.md

@@ -100,6 +100,23 @@ for the `execute("deletecheese 1")` API call.
 
 ### Model component
 
+![Structure of the Model Component](images/ModelClassDiagram.png)
+
+![Structure of the Customer Component](images/CustomerClassDiagram.png)
+
+![Structure of the Cheese Component](images/CheeseClassDiagram.png)
+
+![Structure of the Order Component](images/OrderClassDiagram.png)
+
+**API** : [`Model.java`](https://github.com/AY2021S2-CS2103-W16-2/tp/blob/master/src/main/java/seedu/address/model/Model.java)
+
+The `Model`,
+* stores a `UserPref` object that represents the user`s preferences.
+* stores the address book data.
+* exposes an unmodifiable `ObservableList<Customer>`, `ObservableList<Order>`,`ObservableList<Cheese>` that can be 'observed'.
+e.g. the Ui can be bound to this list so that the UI automatically updates when the data in the list change.
+* does not depend on any of the other three components.
+
 ### Storage component
 
 ![Structure of the Storage Component](images/StorageClassDiagram.png)
@@ -288,6 +305,44 @@ instances to accommodate the changes. We do not choose this design as it is very
 unlikely a user would want to modify a completed `Order`, and the user can always
 add a new `Order` instance in the worst case.
 
+### Mark an order as complete feature
+
+#### implementation
+
+Marking an order as completed is implemented in [`DoneCommand.java`](https://github.com/AY2021S2-CS2103-W16-2/tp/blob/master/src/main/java/seedu/address/logic/commands/DoneCommand.java).
+
+`DoneCommand` extends from `command` and overwrites the operations `execute()` and `equals()`.
+
+Given below is an example usage scenario and how the feature of marking an order as complete feature behaves at each step.
+
+Step 1. The user launches CHIM which will restore archived customers , orders and cheeses.
+
+Step 2. The user issues the command `done 1` to mark the first order shown in the `listorders` as completed.
+The `done` command calls `DoneCommand.execute()` which will check the index given is valid and order selected is not completed yet.
+
+Step 3. After initial checks are completed, `DoneCommand.execute()` will call on `ModelManager.getUnassignedCheeses()`
+to retrieve unAssigned Cheese(s) required for the order.
+
+Step 4. `DoneCommand.execute()` will call `DoneCommand.createDoneOrder()` to create a new `order`
+if there is enough unassigned Cheese(s) from `ModelManager.getUnassignedCheeses()`.
+
+Step 5. `DoneCommand.execute()` will call `ModelManager.setOrder()`
+to replace the original order with the new order created from `DoneCommand.createDoneOrder()`
+and calls `ModelManager.updateCheesesStatus()` to update all cheese(s)'s assign status used for this order.
+
+The following sequence diagram shows how the operation `done 1` is carried out as detailed above.
+
+![Sequence Diagram of the Done Command](images/DoneCommandSeqDiagram.png)
+
+#### Design consideration 
+* Aspect : Searching for available cheese(s) for the order.
+    * Current choice : Searching for unassigned cheeses for the order is implemented in the `Model.AddressBook`.
+        * Pros: no dependency between `Done` command and `Cheese`.
+        * Cons: performance issues due to multiple functions calls.
+    * Alternative 1 : `Done` command will search for unassigned cheeses.
+        * Pros: better in terms of performance as there are lesser functions to be called.
+        * Cons: This introduces another reason for 'DoneCommand.execute()' to change in the future.
+
 ## **Documentation, logging, testing, configuration, dev-ops** [In Progress]
 
 --------------------------------------------------------------------------------------------------------------------
@@ -574,7 +629,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
 **MSS**
 1. User enters the index of the order to be marked as complete.
-1. CHIM assigns avaliable cheeses to the order and marks the order as complete.
+1. CHIM assigns available cheeses to the order and marks the order as complete.
 
    Use case ends.
 
@@ -653,6 +708,14 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
   Use case ends.
 
 
+#### Use case: Clear all data 
+
+**MSS**
+1. User enters the command to clear all data.
+2. CHIM clears customer , orders and cheese data and informs the user. 
+    
+    Use case ends.
+
 #### Use case: Exit the application
 
 **MSS**

docs/UserGuide.md

@@ -137,7 +137,6 @@ Format: `deletecustomer p/PHONE_NUMBER`
 
 Example: `deletecustomer p/65555555`
 
-
 ### Listing orders: `listorders`
 
 Displays all orders in CHIM.
@@ -150,7 +149,6 @@ Displays all cheeses in CHIM.
 
 Format: `listcheeses`
 
-
 ### Listing customers: `listcustomers`
 
 Displays the customers in CHIM.
@@ -206,6 +204,12 @@ Examples:
 * `findorder n/Alice s/incomplete`
 * `findorder p/92280919`
 
+### Clearing all data in CHIM: `clear`
+
+Clears all data in CHIM and save files 
+
+Format: `clear`
+
 ### Exiting the program: `exit`
 
 Exits the program.
@@ -242,4 +246,5 @@ Action | Format, Examples
 **Find Customer** | `findcustomer [n/NAME_KEYWORDS...] [p/PHONE_KEYWORDS...] [e/EMAIL_KEYWORDS...] [a/ADDRESS_KEYWORDS...]` <br> e.g. `findcustomer n/Betty`
 **Find Cheese** | `findcheese [t/CHEESE_TYPE_KEYWORDS...] [s/ASSIGNMENT_STATUS]` <br> e.g. `findcheese t/Brie Feta s/unassigned`
 **Find Order** | `findorder [t/CHEESE_TYPE_KEYWORDS...] [n/CUSTOMER_NAME_KEYWORDS] [p/CUSTOMER_PHONE_KEYWORDS] [s/COMPLETION_STATUS]`  <br> e.g. `findorder t/gouda s/complete`
+**Clear** | `clear`
 **Exit** | `exit`

docs/images/CheeseClassDiagram.png

@@ -11,7 +11,7 @@
 public class ClearCommand extends Command {
 
     public static final String COMMAND_WORD = "clear";
-    public static final String MESSAGE_SUCCESS = "Address book has been cleared!";
+    public static final String MESSAGE_SUCCESS = "All data in saved file and CHIM has been cleared!";
 
 
     @Override