[CS2113-T17-2] CafeCTRL

.gitignore

@@ -15,3 +15,4 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+META-INF/MANIFEST.MF

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.cafectrl.CafeCtrl")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("cafectrl")
     archiveClassifier.set("")
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+Display |   Name   |              Github Profile              | Portfolio 
+--------|:--------:|:----------------------------------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) | Shanice  | [Github](https://github.com/ShaniceTang) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Naychi  | [Github](https://github.com/NaychiMin/tp) | [Portfolio](docs/team/johndoe.md)
+![](https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.scmp.com%2Fweek-asia%2Fpolitics%2Farticle%2F3095228%2Fmalaysia-najibs-cheesy-super-ring-jibe-comes-back-bite-him-after&psig=AOvVaw2ohFjBBhoZxtARfOKEnTXE&ust=1696586245977000&source=images&cd=vfe&opi=89978449&ved=0CBEQjRxqFwoTCJiboLbS3oEDFQAAAAAdAAAAABAE) |  Zi Yi   | [Github](https://github.com/ziyi105) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Dexter Hoon | [Github](https://github.com/DextheChik3n) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Chua Zhong Heng | [Github](https://github.com/Cazh1/tp) | [Portfolio](docs/team/johndoe.md)

docs/DeveloperGuide.md

@@ -6,8 +6,102 @@
 
 ## Design & implementation
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+## Design
 
+### Parser
+
+![Parser Parsing User Input Sequence Diagram](umlimages/Parser.png)
+
+*Figure 1: Parser Parsing User Input Sequence Diagram*
+
+API: [Parser.java]({repoURL}src/main/java/seedu/cafectrl/parser/Parser.java)
+
+When user input a string to `Main`,  it passes the full user input to `Parser` via `parseCommand`. In `parseCommand`,  it finds the matching keyword for different command from the user input, then it calls the respective `prepareCommand` method within `Parser`. `prepareCommand` then generates the corresponding command class and return it to `parseCommand`, which returns the `Command` back to `Main` for execution.
+
+## Features
+
+### Add Dish
+
+![Add Dish Execution](uml/AddDishCommand_execute.png)
+*Figure X: Execution of add_dish command*
+
+API: [AddDishCommand.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/command/AddDishCommand.java)
+
+The `add_dish` command, add a dish to the `Menu` object and prints out a formatted message to state the name, price and ingredients entered for the dish.
+
+when the `execute()` method from `AddDishCommand` is called in the main class `CafeCtrl`, the `addDish()` method is first called to add the `Dish` object to the `Menu`. It will then call the `printAddDishMessage()` method, which gets all the parameters of the `Dish` object (dishName, dishPrice, dishIngredients) and passes them to the `Ui` to then be printed out to the User.
+
+Separation of Concerns was applied to ensure the `Ui` is only responsible with only displaying messages while the `Menu` deals with the logic of adding dish to the menu. This implementation also encapsulates the details of adding a dish and displaying messages. For example, The `AddDishCommand` class doesn't need to know how the internal details of the dish adding and message printing are performed.
+
+### Adding a Dish
+
+### List Menu
+A list command can be used to display all the `Dish` objects stored in `Menu`.
+
+The following class diagram illustrates the relationship between the respective classes involved in the creation and execution of a list command.
+![List Menu Execution](umlimages/ListMenuCommandClass.png)
+
+![List Menu Execution](umlimages/ListMenuCommand_execute.png)
+
+Figure 1: Execution of list_menu command
+
+API: [ListMenuCommand.java]({repoURL}src/main/java/seedu/cafectrl/command/ListMenuCommand.java)
+
+When the `execute()` method of ListMenuCommand is invoked in Main, it checks if the size of the menu by running `menu.getSize()`. 
+
+1) If the menu is empty, it will call its `printEmptyMenu()` method to display to the user a `MENU_EMPTY_MESSAGE` in the Ui object and returns afterward.
+2) If the menu is not empty, it will call its `printFullMenu()` method.
+`printFullMenu()` will first print the top portion of the menu using the Ui object. 
+It then iterates through the `Dish` objects in `Menu` in a "for" loop, using `menu.getDishFromId()` to retrieve the Dish object.
+The `dishName` and `dishPrice` are both access from `Dish` Class using `getName()` and `getPrice()` respectively.
+The data are then packaged nicely in a `leftAlignFormat`, with (indexNum + ". " + dishName," $" + dishPrice) such that
+   e.g. (1. Chicken Rice $2.50) is shown.
+
+### List Ingredients
+![List Ingredient Execution](umlimages/ListIngredientCommand_execute.png)
+
+*Figure 2: Execution of list_ingredient command*
+
+API: [ListIngredientCommand.java]({repoURL}src/main/java/seedu/cafectrl/command/ListIngredientCommand.java)
+
+| No | Step                          | Description                                                                                                                                                                                                                                                                                                                                                                              |
+|----|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 1  | Initialization                | The sequence begins with the `Main` class invoking the `execute` method of the `ListIngredientCommand` after parsing a user command.                                                                                                                                                                                                                                                     |
+| 2-3  | Interaction with 'Menu'       | The `ListIngredientCommand` communicates with the `Menu` class, invoking the `getMenuItemsList()` method to retrieve a list of menu items. The function returns an ArrayList of objects of 'Dish' type.                                                                                                                                                                                  |
+| 4  | Interaction with 'Ui'         | The `ListIngredientCommand` communicates with the `Ui` class, invoking the `printIngredients()` method to print out the list of ingredients used for the selected dish. <br/> * The function returns an ArrayList of objects of 'Dish' type. The `get()` method is then invoked to get the dish of the specified index. However, this is ommitted to prevent unnecessary sophistication. |
+| 5-6  | Interaction with 'Dish'       | The `Ui` class communicates with the `Dish` class, invoking the `getIngredients()` method to obtain the list of ingredients for the selected dish. The `Dish` class responds with an ArrayList of objects of 'Ingredient' type to the `Ui` class.                                                                                                                                        |
+| 7-8  | Iteration through Ingredients | There is a loop that iterates through each ingredient in the list. The `Ui` class interacts with the `Ingredients` class, converting each ingredient to a string containing the ingredient and quantity needed.                                                                                                                                                                          |
+| 9-10  | Display to User               | The `Ui` class showcases the information to the user through the `showToUser()` method.                                                                                                                                                                                                                                                                                                  |
+
+### Delete Dish
+
+### Delete Dish
+
+![Delete Dish Execution](uml/DeleteDishCommand_execute.png)
+<br>*Figure X: Execution of delete dish command
+
+API: [DeleteDishCommand.java]({repoURL}src/main/java/seedu/cafectrl/command/DeleteDishCommand.java)
+
+When the `execute()` method of `DeleteDishCommand` is invoked in `Main`, it subsequently calls `getMenuItemsList().get(dishIndexToBeDeleted)` method on the `Menu` object to retrieve the `Dish` object to be deleted.
+Following this, the `showDeleteMesage()` method in the Ui component is triggered to display a message to show the user which dish is about to be deleted.
+Afterward, `DeleteDishCommand` calls `removeDish(dishIndexToBeDeleted)` of the `Menu` object to remove the selected dish at the index indicated by the user.
+This sequence of actions orchestrates the flow of information and operations between `Main`, `DeleteDishCommand`, `Menu`, and `Ui` components, ensuring the seamless handling of the dish deleting functionality within the application.
+
+
+`DeleteDishCommand` is implemented in such a way because:
+1. It promotes loose coupling between components. For instance, `Main` doesn't need to know the details of how the `execute()` of `DeleteDishCommand` is executed or how the message is displayed in `Ui`.
+2. Each component has a specific role and responsibility. `Main` is responsible for receiving user input and invoking `execute()`, `DeleteDishCommand` is responsible for encapsulating the delete operation, `Menu` is responsible for managing the menu items, and `Ui` is responsible for displaying messages to the user. This separation of concerns makes the code more maintainable and easier to understand.
+
+
+### Edit Price
+
+![Edit Price Execution](umlimages/EditPriceCommand_execute.png)
+
+*Figure 3: Execution of edit_price command*
+
+API: [EditPriceCommand.java]({repoURL}src/main/java/seedu/cafectrl/command/EditPriceCommand.java)
+
+When the `execute()` method of `EditPriceCommand` is invoked in `Main`, it subsequently calls the `setPrice()` method on the `Dish` object to modify the price of the specific dish. Following this, the `showEditPriceMessages()` method in the Ui component is triggered to display a message related to the successful execution of the price modification process. This sequence of actions orchestrates the flow of information and operations between the `Main`, `EditPriceCommand`, `Dish`, and `Ui` components, ensuring the seamless handling of the price editing functionality within the application.
 
 ## Product scope
 ### Target user profile

docs/_config.yml

@@ -0,0 +1 @@
+theme: minima

docs/uml/AddDishCommand_execute.puml

@@ -0,0 +1,36 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+autonumber
+
+-> AddDishCommand: execute()
+activate AddDishCommand
+AddDishCommand -> Menu: addDish(dish: Dish)
+activate Menu
+return
+AddDishCommand -> Ui: printAddDishMessage(dish: Dish)
+
+
+activate Ui
+Ui -> Dish: getName()
+activate Dish
+Dish --> Ui: dishNameString: String
+deactivate Dish
+Ui -> Dish: getPrice()
+activate Dish
+Dish --> Ui: dishPrice: float
+deactivate Dish
+
+loop ingredients
+Ui -> Ingredients: toString()
+activate Ingredients
+Ingredients --> Ui
+deactivate Ingredients
+end loop
+
+Ui -> Ui: showToUser(message: String)
+activate Ui
+return
+return
+return
+
+@enduml

docs/uml/DeleteDishCommand_execute.puml

@@ -0,0 +1,26 @@
+@startuml
+!define COMMAND class ListIngredientCommand
+!define UI class Ui
+!define MENU class Menu
+
+autonumber
+
+-> DeleteDishCommand : execute()
+activate DeleteDishCommand
+
+DeleteDishCommand -> Menu : getMenuItemsList().get(dishIndexToBeDeleted: int)
+activate Menu
+return (selectedDish: Dish)
+DeleteDishCommand -> Ui : showDeleteMessage(selectedDish: Dish)
+activate Ui
+Ui -> Ui : showToUser(message: String)
+activate Ui
+return
+return
+DeleteDishCommand -> Menu : removeDish(dishIndexToBeDeleted: int)
+activate Menu
+return
+return
+
+
+@enduml

docs/umldiagrams/EditPriceCommand_execute.puml

@@ -0,0 +1,13 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+autonumber
+
+Main -> EditPriceCommand: execute()
+activate EditPriceCommand
+EditPriceCommand -> Dish: setPrice(price: float)
+activate Dish
+EditPriceCommand -> Ui: showEditPriceMessages()
+deactivate EditPriceCommand
+deactivate Dish
+@enduml

docs/umldiagrams/ListIngredientCommand_execute.puml

@@ -0,0 +1,41 @@
+@startuml
+!define COMMAND class ListIngredientCommand
+!define UI class Ui
+!define MENU class Menu
+!define DISH class Dish
+!define PARSER class Parser
+
+autonumber
+ -> ListIngredientCommand: execute()
+
+activate ListIngredientCommand
+ListIngredientCommand -> Menu : getMenuItemsList()
+activate Menu
+Menu --> ListIngredientCommand: selectedDish : Dish
+deactivate Menu
+
+ListIngredientCommand -> Ui : printIngredients(selectedDish: Dish)
+activate Ui
+Ui -> Dish : selectedDish.getIngredients()
+activate Dish
+Dish --> Ui : ingredients: Ingredient
+deactivate Dish
+
+
+loop ingredients
+Ui -> Ingredients: ingredient.toString()
+activate Ingredients
+Ingredients --> Ui
+deactivate Ingredients
+end loop
+
+Ui -> Ui: showToUser(message: String)
+activate Ui
+Ui --> Ui
+deactivate Ui
+Ui --> ListIngredientCommand
+deactivate Ui
+deactivate ListIngredientCommand
+<-- ListIngredientCommand
+
+@enduml

docs/umldiagrams/ListMenuCommandClass.puml

@@ -0,0 +1,60 @@
+@startuml
+'https://plantuml.com/class-diagram
+
+
+title Class Diagram of CafeCtrl `list_menu` Command
+
+CafeCtrl "1" --> "1" UI
+CafeCtrl "1" --> "1" Parser
+CafeCtrl "1" --> "1" Menu
+
+CafeCtrl "1" o-- "*" Command
+Command <|- ListMenuCommand
+Parser "1" --> "*" ListMenuCommand
+ListMenuCommand --> Menu
+Menu --> "*" Dish
+
+class CafeCtrl {
+- setup()
+- run()
++ main(args : String[])
+}
+
+class Command {
+
+}
+
+class UI {
+{static} - scanner : Scanner
++ receiveUserInput() : String
++ showMenuTop() : void
++ showMenuBottom() : void
++ showEmptyMenu() : void
++ showMenuDish(indexNum : String, dishName : String, dishPrice : String) : void
+}
+
+class ListMenuCommand {
+# menu : Menu
+# ui : Ui
++ execute() : void
++ printEmptyMenu(ui : Ui) : void
++ printFullMenu(menu : Menu, ui : Ui)
+}
+
+class Parser {
+{static} + parseCommand(menu : Menu, userInput : String, ui : Ui, pantry : Pantry, orderList : OrderList) : Command
+{static} - prepareListMenu(menu : Menu, ui : Ui) : Command
+}
+
+class Menu {
+- menuItems : ArrayList<Dish>
++ getDishFromId(menuID : int) : Dish
+}
+
+class Dish {
+- name : String
+- price : float
++ getName() : String
++ getPrice() : float
+}
+@enduml