[CS2113-F14-2] DinEZ

.gitignore

@@ -15,3 +15,6 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+#log files
+*.log

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: logic.MainLogic
+

MenuLogger.log

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="GBK" standalone="no"?>
+<!DOCTYPE log SYSTEM "logger.dtd">
+<log>
+</log>

OrderAddCommandLogger.log

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="GBK" standalone="no"?>
+<!DOCTYPE log SYSTEM "logger.dtd">
+<log>
+<record>
+  <date>2024-04-03T14:19:34.748138100Z</date>
+  <millis>1712153974748</millis>
+  <nanos>138100</nanos>
+  <sequence>0</sequence>
+  <logger>OrderAddCommandLogger</logger>
+  <level>INFO</level>
+  <class>command.order.OrderAddCommand</class>
+  <method>execute</method>
+  <thread>1</thread>
+  <message>Adding new item to order</message>
+</record>
+<record>
+  <date>2024-04-03T14:19:34.751139200Z</date>
+  <millis>1712153974751</millis>
+  <nanos>139200</nanos>
+  <sequence>1</sequence>
+  <logger>OrderAddCommandLogger</logger>
+  <level>INFO</level>
+  <class>command.order.OrderAddCommand</class>
+  <method>execute</method>
+  <thread>1</thread>
+  <message>Item successfully added to order</message>
+</record>
+</log>

build.gradle

@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,8 @@
 # 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://media.licdn.com/dms/image/D4D03AQHqwchTapLQSw/profile-displayphoto-shrink_800_800/0/1689641178627?e=1715817600&v=beta&t=0zJsfORUyukckyySHLfJWKJGEdSk6vE4IBQLC0tEiPo) | Zheng Wentao | [Github](https://github.com/Zhengwinter/) | [Portfolio](docs/team/johndoe.md)
+![](https://media.licdn.com/dms/image/D5635AQF9CsBIurtIhQ/profile-framedphoto-shrink_400_400/0/1709822298987?e=1710486000&v=beta&t=ZFPmBTwS2j4itxdUfOToKvL_Wd55X4m0V1_SBnHl_Go) | Xiao Bo  | [Github](https://github.com/Xb990219) | [Portfolio](docs/team/UserGuide.md)
+![](https://static.wikia.nocookie.net/pure-good-wiki/images/6/6e/Winnie_The_Pooh.png/revision/latest?cb=20210310185331) | Zeng Zheqi | [Github](https://github.com/adamzzq) | [Portfolio](youtube.com)
+![](https://media.licdn.com/dms/image/D5603AQFfWFYq1mqgcA/profile-displayphoto-shrink_400_400/0/1696897863941?e=1715212800&v=beta&t=TLopY2QuxEZz9oFQttl_5avFfWdGFdeMX25c60Tnvl8) | Webster Tan | [Github](https://github.com/webtjs) | [Portfolio](docs/team/UserGuide.md)

docs/DeveloperGuide.md

@@ -4,10 +4,137 @@
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
+## Design
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Architecture
+![Architecture](images\Architecture.png)
+
+The **Architecture diagram** given above shows the high-level design of the application.
 
+Given below is a quick overview of main components and how they interact with each other.
+
+**`Main`** is in charge of the app launch, shut down, and taking user input.
+
+* At the app launch, it loads the data from the file system, and initializes other components.
+* At the app shut down, it saves the data to the file system, and shuts down other components.
+
+The app's work is done by the following components:
+
+* [**`MainLogic`**](#sublogic-component): The main logic command executor.
+* [**`SubLogic`**](#sublogic-component): The sub logics(i.e. **`MenuLogic`**, **`OrderLogic`**) command executor.
+* [**`Parser`**](#parser-component): The parser that parses user input to command.
+* [**`Model`**](#model-component): The data model that stores the data.
+* [**`Command`**](#command-component): Represents a command that the user can execute.
+* [**`Storage`**](#storage-component): Reads data from, and writes data.
+
+**How the architecture components interact with each other**
+
+The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user issues 
+the command `Create order -menu 01`, `add -item 001` and `complete`.
+
+![Sequence Diagram](images\ArchitectureSequanceDiagram.png)
+
+### UI Component
+The UI component is responsible for parsing user input into commands that can be executed by the logic component.
+There is a `analyzeInput` method in the `Parser` class that interprets the user input and classifies 
+it into a `CommandType` enum.<br>
+The `splitInput` method is used to split the user input into an array of strings, according to the command type.
+It returns an array containing any arguments that are needed to execute the command.
+
+### Logic Component
+The logic component consists of classes that handle the logic of the application. The logic component is divided into
+`MainLogic` and `SubLogic` which consists of `OrderLogic` and `MenuLogic`.
+
+* [**`MainLogic`**](#model-component): A class to handle the first level commands, and pass the user input to corresponding
+classes for analysis and execution.
+* [**`OrderLogic`**](#model-component) and [**`MenuLogic`**](#model-component): A class to handle the second level commands,
+and pass the user input to corresponding classes for analysis and execution.
+
+### Command Component
+The command component consists of two different command interfaces: `MainCommand` and `OrderCommand`. The `MainCommand`
+interface is for the various command classes that are used in the `MainLogic`, while the `OrderCommand` interface is for
+command classes used in `OrderLogic`.  
+
+A `Command` object will be created in either the `MainLogic` or `OrderLogic`
+based on what command the user has inputted(e.g., `MainHelpCommand` object is created when the user inputs the `help`
+command). The `execute()` method of the `Command` object is then called to execute the command, which may require
+certain arguments based on the type of command.
+
+### Model Component
+The model consists of classes describing the objects used in this application.
+The general structure is that menu and order are separate, but they both work with `menuItem(s)`, which 
+represent food items on the menu.
+
+* [**`ItemManager`**](#model-component): An interface containing methods representing operations common to **`Menu`** 
+  and **`Order`**. <br><br />
+* [**`Item`**](#model-component): An abstract class representing a food item. It should be implemented by **`MenuItem`**.
+  <br><br />
+* [**`Menu`**](#model-component): A class representing the menu(s) of the restaurant, where each contains menuItem(s)
+ that can be ordered. Multiple menus can exist and each has a unique ID. <br><br />
+* [**`MenuItem`**](#model-component): A class inheriting item, and represents a food item on the menu. <br><br />
+* [**`Order`**](#model-component): A class representing an order to be entered into the system to be kept track of. Each 
+  order has a unique ID generated from the time of order.<br><br />
+* [**`SetMenu`**](#model-component): An enumeration representing the different types of set menus available, examples of
+  which includes *breakfast*, *lunch*, *dinner*.
+
+The *Class Diagram* below shows how the model components interact with each other, including interactions such as 
+dependencies, associations and inheritance.
+
+![Class Diagram](images/modelcomponent.png)
+
+## Implementation
+
+### `MainLogic`
+Generally, the main logic works as follows:
+1. User enters an input which is received in the *ui* and parsed by the `Parser`.
+2. The `Parser` classifies the command based on `CommandType`.
+3. If it is a first level command, `execute` is called on the corresponding class.
+4. If it is not a first level command, the command will be pass to `SubLogic` to handle.
+
+**Create Order** <br>
+`Mainlogic` takes user input and crate an `Order` class and pass it to `OrderLogic` to execute the command.
+
+**View Order by ID** <br>
+`Mainlogic` takes in the command and the order ID, execute the `view order` command by calling a static method<br>
+in `ViewOrderCommand` class.
+
+**View all orders** <br>
+`Mainlogic` takes in the command and calls the `ViewOrdersSummaryCommand` class to execute the command<br>    
+by querying the orderList.
+
+**View Receipt** <br>
+`Mainlogic` takes in the command and calls the `ViewReceiptCommand` class to execute the command
+### `OrderLogic`
+Generally, the order logic works as follows: 
+1. User enters an input which is received in the *ui* and parsed by the `Parser`. 
+2. The `Parser` classifies the command based on `CommandType`
+3. Within `OrderLogic`, `execute` is called on the corresponding class
+4. Control is passed to other sections of the code
+
+**View Menu** <br>
+Within the construct of the order logic, the menu can be accessed for viewing in order to select items from 
+available menus. This is carried out with the `view menu` command.
+
+**View Item**  
+Within `OrderLogic`, a list containing all the items that have been added to the current active order can be viewed by executing
+the `view item` command.
+
+**Add**  
+Inside `OrderLogic`, items from the menu can be added into the current active order.
+This is carried out using the `add -item <item_id> -quantity <quantity_of_item>` command,
+where `<item_id>` is an integer corresponding to the item's id in the menu,
+and `<quantity_of_item>` is an integer of the amount of that item to be added.
+
+**Delete**  
+In `OrderLogic`, items from the current order can be removed via the
+`delete -item <item_id> -quantity <quantity_of_item>` command. `<item_id>`
+and `<quantity_of_item>` are the same type of parameters as the ones specified
+in the `Add` command class.
+
+**Complete**  
+Inside `OrderLogic`, once the order is finished, it can be completed and closed
+by executing the `complete` command. This marks the current order as completed
+and the program returns back to `MainLogic` for subsequent command executions.
 
 ## Product scope
 ### Target user profile

docs/README.md

@@ -1,4 +1,4 @@
-# Duke
+# DINEZ
 
 {Give product intro here}
 

docs/UMLdiagrams/Architecture.puml

@@ -0,0 +1,32 @@
+@startuml
+!include <office/Concepts/globe_internet>
+!include <office/Concepts/documents>
+!include <office/Users/user>
+!include style.puml
+
+Class "<$user>" as User #red
+Class "<$documents>" as File #blue
+
+Package " "<<Rectangle>>{
+    Class Main #grey
+    Class MainLogic MAIN_LOGIC_COLOR
+    Class Command COMMAND_COLOR
+    Class SubLogic SUB_LOGIC_COLOR
+    Class Storage STORAGE_COLOR
+    Class Model MODEL_COLOR
+    Class Parser PARSER_COLOR
+}
+User .left.> Main : input
+Main .right.> User : output
+Main .left.> MainLogic
+MainLogic -down.> SubLogic #green
+MainLogic -left.> Parser #green
+Main -up-> Storage #green
+MainLogic -up> Model #green
+SubLogic -left.> Parser #red
+SubLogic -down-> Model #red
+Command -down-> Model #lightgreen
+Storage -right.> File #black
+Parser -down.> Command #orange
+
+@enduml

docs/UMLdiagrams/ArchitectureSequanceDiagram.puml

@@ -0,0 +1,67 @@
+@startuml
+!include style.puml
+
+Actor User as user USER_COLOR
+Participant ":MainLogic" as mainLogic MAIN_LOGIC_COLOR
+Participant ":SubLogic(OrderLogic)" as subLogic SUB_LOGIC_COLOR
+Participant ":Parser" as parser PARSER_COLOR
+Participant ":Command" as command COMMAND_COLOR
+Participant ":Model" as model MODEL_COLOR
+participant ":Storage" as storage STORAGE_COLOR
+
+
+user -> mainLogic : "Create order -menu 01"
+activate mainLogic MAIN_LOGIC_COLOR
+mainLogic -> parser : analyzeInput("Create order -menu 01")
+activate parser PARSER_COLOR
+parser --> mainLogic : return command
+deactivate parser
+mainLogic -> command : execute(command)
+activate command COMMAND_COLOR
+command -> model : get(menu01)
+activate model MODEL_COLOR
+model --> command : return menu01
+deactivate model
+command -> model : createOrder(menu01)
+activate model MODEL_COLOR
+model --> command : return newOrder
+deactivate model
+command --> subLogic : return newOrder
+deactivate command
+activate subLogic SUB_LOGIC_COLOR
+user -> subLogic : "add -item 001"
+subLogic -> parser : analyzeInput("add -item 001")
+activate parser PARSER_COLOR
+parser --> subLogic : return command
+deactivate parser
+subLogic -> command : execute(command)
+activate command COMMAND_COLOR
+command -> model : get(item001)
+activate model MODEL_COLOR
+model --> command : return item001
+deactivate model
+command -> model : addItem(newOrder, item001)
+activate model MODEL_COLOR
+model --> command : return newOrder
+deactivate model
+command --> subLogic : return newOrder
+deactivate command
+user -> subLogic : "complete"
+subLogic -> parser : analyzeInput("complete")
+activate parser PARSER_COLOR
+parser --> subLogic : return command
+deactivate parser
+subLogic -> command : execute(command)
+activate command COMMAND_COLOR
+deactivate subLogic
+command --> mainLogic : return newOrder
+deactivate command
+mainLogic -> storage : save(newOrder)
+activate storage STORAGE_COLOR
+storage --> mainLogic
+deactivate storage
+
+
+
+
+@enduml

docs/UMLdiagrams/model.puml

@@ -0,0 +1,71 @@
+@startuml
+'https://plantuml.com/class-diagram
+
+skinparam dpi 600
+
+abstract class Item {
+    -id
+    - name
+    - unitPrice
+
+    + Item (id: String, name: String, unitPrice: double)
+    +getID() : String
+    +getName() : String
+    +getPrice() : double
+
+}
+interface ItemManager {
+    add(var1: MenuItem) : boolean
+    remove(var1: String) : boolean
+    getID() : String
+}
+class Menu {
+- logr
+- menuID
+- setupLogger() : void
++ Menu(menuID: String)
++ getItem(itemID: String) : Optional<MenuItem>
++ getID() : String
++ add(item: MenuItem) : boolean
++ remove(itemID: String) : boolean
++ toString() : String
+}
+class MenuItem {
++ MenuItem(id: String, name: String, unitPrice: double)
++ toString(): String
++ compareTo(o: MenuItem) : int
+}
+class Order {
+- SERVICE_CHARGE
+- GST
+- orderID
++ add(item: MenuItem) : boolean
++ remove(itemID: String) : boolean
++ remove(item: MenuItem) : boolean
++ getItemCount(itemID String): int
++ getID() : String
++ getSize() : int
++ getTotalPrice() : double
++ getReceipt() : String
++ getOrderSummary() : String
++ toString() : String
+}
+enum SetMenu {
+    Breakfast
+    Lunch
+    Dinner
+}
+
+Item <|-- MenuItem
+
+ItemManager <|.. Menu
+ItemManager <|.. Order
+
+MenuItem "1" <..  Order : order
+MenuItem "1" <.. Menu : menu
+
+SetMenu <.. Menu
+
+
+
+@enduml