[CS2113-F13-1] Taste of Mom's

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.Duke
+

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# Taste Of Mom's (TOM)
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 

build.gradle

@@ -11,6 +11,7 @@ repositories {
 
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
+    testImplementation 'junit:junit:4.13.1'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
 }
 
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true;
 }

data/1-Hotpot.txt

@@ -0,0 +1,10 @@
+Hotpot
+Chinese
+Ingredient list
+Beef
+Porken
+Carrots
+Step list
+chop beef
+burn food
+eat food

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) |  Leong Yat Pang  | [Github](https://github.com/YatPang) | [Portfolio](team/leongyatpang.md)|
+|![](https://via.placeholder.com/100.png?text=Photo) |   Lim Hong Yao   | [Github](http://github.com/LimHongYao) | [Portfolio](team/limhongyao.md)|
+|![](https://via.placeholder.com/100.png?text=Photo) | Aung Phone Naing | [Github](https://github.com/Aung-Phone-Naing) | [Portfolio](team/aungphonenaing.md)|
+|![](https://via.placeholder.com/100.png?text=Photo) |    Liu Ziyang    | [Github](https://github.com/liuziyang020319) | [Portfolio](team/liuziyang.md)|
+

docs/PlantUML/ArchitectureInteract.puml

@@ -0,0 +1,37 @@
+@startuml ArchitectureInteract
+box Manager #White
+Actor User #Blue
+participant ":UI" as UI #Gray
+participant ":Duke" as Duke #Gold
+participant ":Parser" as Parser #Yellow
+participant ":Command" as Command #Beige
+participant ":RecipeList" as RecipeList #OrangeRed
+participant ":Storage" as Storage #DimGray
+end box
+
+activate Duke #Gold
+Duke -> UI : readCommand()
+activate UI #Gray
+User -> UI : delete 1
+UI --> Duke : delete 1
+Duke -> Parser : parseCommand(delete 1)
+activate Parser #Yellow
+Parser --> Duke
+deactivate Parser
+Duke -> Command : execute(delete,1)
+activate Command #Beige
+Command -> RecipeList : delete(1)
+activate RecipeList #OrangeRed
+RecipeList -> Storage
+activate Storage #DimGray
+Storage -> Storage : save()
+activate Storage
+Storage --> Storage
+deactivate Storage
+Storage --> RecipeList
+deactivate Storage
+RecipeList --> Command
+deactivate RecipeList
+Command --> Duke
+deactivate Command
+@enduml

docs/PlantUML/CommandComponent.puml

@@ -0,0 +1,26 @@
+@startuml
+
+class Command implements StringLib {
+    - type: CommandType
+    - fullDescription: String
+    + isExit(): boolean
+    + execute(recipeList: RecipeList, ui: UI): void
+}
+
+enum CommandType {
+    LIST
+    ADD
+    DELETE
+    FIND
+    CLEAR
+    VIEW
+    HELP
+    EXIT
+    UNKNOWN
+}
+
+Command --> CommandType
+IncompleteInputException --|> Exceptions : extends
+Command ..> IncompleteInputException : uses
+
+@enduml

docs/PlantUML/FindRecipe.puml

@@ -0,0 +1,34 @@
+@startuml Recipe Find
+box Find #White
+Actor User
+participant ":UI" as UI
+participant ":Duke" as Duke
+participant ":Parser" as Parser
+participant ":Command" as Command
+participant ":RecipeList" as RecipeList
+end box
+activate Duke
+Duke -> UI : "readCommand()"
+activate UI
+User -> UI : "Find MaLaXiangGuo"
+UI --> Duke
+deactivate UI
+Duke -> Parser : "parseCommand()"
+activate Parser
+Parser --> Duke
+deactivate Parser
+Duke -> Command : "execute()"
+activate Command
+Command -> RecipeList : "searchRecipeList()"
+activate RecipeList
+RecipeList -> UI : show recipe with index
+activate UI
+UI --> RecipeList
+deactivate UI
+RecipeList --> Command
+deactivate RecipeList
+Command --> Duke
+deactivate Command
+
+
+@enduml

docs/PlantUML/Help.puml

@@ -0,0 +1,31 @@
+@startuml Help
+box Manager #White
+Actor User
+
+participant ":UI" as UI
+participant ":Duke" as Duke
+participant ":Parser" as Parser
+participant ":Command" as Command1
+end box
+
+activate Duke
+
+User -> Duke : "help"
+Duke -> Parser : "parseCommand()"
+activate Parser
+Parser --> Duke
+deactivate Parser
+Duke -> Command1 : "execute()"
+activate Command1
+Command1 -> UI : "showHelp()"
+activate UI
+UI -> User : HELP message shown
+UI --> Command1
+deactivate UI
+Command1 --> Duke
+deactivate Command1
+Duke -> Command1 : delete
+destroy Command1
+
+
+@enduml

docs/PlantUML/MainArchitecture.puml

@@ -0,0 +1,22 @@
+@startuml MainArchitecture
+
+archimate #Technology "User" as User <<technology-device>>
+archimate #Technology "Data" as Data <<application-data-object>>
+
+
+rectangle RM {
+    rectangle UI 
+    rectangle Duke 
+    rectangle Parser 
+    rectangle Storage 
+    rectangle RecipeList
+    rectangle Command
+    User -down.> UI
+    Storage .> Data
+    Duke -up-> UI
+    Duke -> Command
+    Command -> RecipeList
+    Duke -up-> Parser
+    Storage -up-> RecipeList
+}
+@enduml

docs/PlantUML/ParserComponent.puml

@@ -0,0 +1,23 @@
+@startuml ParserComponent
+
+class Parser implements StringLib {
+  +parseCommands(line: String): Command
+  +parseRecipe(description: String): ArrayList<String>
+  -matchString(input: String, regex: String): boolean
+  -RECIPE_WRONG_NAME_INGREDIENTS_TAG_STEP: String
+  -RECIPE_MISSING_NAME: String
+  -RECIPE_MISSING_INGREDIENTS: String
+  -RECIPE_MISSING_TAG: String
+  -RECIPE_MISSING_STEP: String
+}
+
+class IncompleteInputException {
+}
+
+class Exceptions {
+}
+
+IncompleteInputException --|> Exceptions : extends
+Parser ..> IncompleteInputException : uses
+
+@enduml

docs/PlantUML/RecipeListComponent.puml

@@ -0,0 +1,68 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+class RecipeList {
+    - recipeList:ArrayList<Recipe>
+    - currRecipeNumber: int
+    + getRecipeList(): ArrayList<Recipe>
+    + getCurrRecipeNumber(): int
+    + getRecipeFromList(itemNum:int): Recipe
+    + getNewestRecipe(): Recipe
+    + addNewRecipe(recipe: Recipe)
+    + removeRecipe(index: int)
+    + clearRecipeList()
+}
+class Recipe {
+    - ingredientList: IngredientList
+    - stepList: StepList
+    - name: String
+    - tag: String
+    + getIngredientList(): IngredientList
+    + getStepList(): StepList
+    + getName(): Name
+    + getTag(): String
+    + toString(): String
+}
+
+class IngredientList {
+    - list: ArrayList<Ingredient>
+    - currIngredientNumber: int
+    + getCurrIngredientNumber(): int
+    + addIngredient(item: Ingredient)
+    + removeIngredient(index: int)
+    + showList()
+    + getList(): ArrayList<Ingredient>
+}
+
+class Ingredient {
+    - name: String
+    + getName(): String
+
+}
+
+class StepList {
+    - stepList: ArrayList<Step>
+    - currStepNumber: int
+    + addStep(step: Step)
+    + removeStep(stepIndex: int)
+    + showStepList()
+    + getList(): ArrayList<Step>
+}
+
+class Step {
+    - description: String
+    + getStep(): String
+    + toString(): String
+}
+class RecipeListEmptyError {
+}
+class Exceptions {
+}
+RecipeList -> "*" Recipe : stores >
+Recipe -> "1" IngredientList : contains >
+Recipe --> "1" StepList : contains >
+IngredientList --> Ingredient : stores >
+StepList --> Step : stores >
+RecipeList ..> RecipeListEmptyError : uses
+RecipeListEmptyError --|> Exceptions : extends
+@enduml