[CS2113-F11-2] EssenMakanan

.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("essenmakanan.EssenMakanan")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("essenMakanan")
     archiveClassifier.set("")
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/DeveloperGuide.md

@@ -1,11 +1,233 @@
+---
+layout: default
+title: Developer Guide
+---
+* Table of Contents
+  {:toc}
+
+--------------------------------------------------------------------------------------------------------------------
+
 # Developer Guide
 
 ## Acknowledgements
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
+References
+1. Developer Guide: https://se-education.org/addressbook-level3/DeveloperGuide.html 
+2. User Guide: https://se-education.org/addressbook-level3/UserGuide.html
+3. 
+
 ## Design & implementation
 
+## Design
+
+### Architecture
+
+<img src="images/ArchitectureDiagram.png" width="280" />
+
+The ***Architecture Diagram*** given above explains the high-level design of the App.
+
+Given below is a quick overview of main components and how they interact with each other.
+
+**Main components of the architecture**
+
+### UI component
+
+### Logic component
+
+### Model component
+
+### Storage component
+
+In this application, it uses text files to store all data, i.e, recipes and ingredients. 
+
+
+When booting up the application, `restoreSavedData` will be called to get both recipes and ingredients 
+from the previous session.
+
+<img src="images/RestoreIngredientStorageSequenceDiagram.png" width="347" />
+<img src="images/RestoreRecipeStorageSequenceDiagram.png" width="347" />
+
+When a user exits the application, `saveData` will be called and it will convert all data from recipes and
+ingredients into a string which will be put in their own respective text files.
+
+<img src="images/StoreIngredientStorageSequenceDiagram.png" width="525" />
+<img src="images/StoreRecipeStorageSequenceDiagram.png" width="706" />
+
+
+## Implementation
+### Help Feature
+The help feature is facilitated by the `HelpCommand` class. By calling `executeCommand` on the class, it will invoke the `Ui` class to print the user help commands.
+
+
+- **Step 1**
+
+  Input will be sent from the main `EssenMakanan` class to the `Parser` to identify the command type
+
+
+- **Step 2**
+
+  A new `HelpCommand` object will be created and will be sent back to main
+
+
+- **Step 3**
+
+  `commandObject#executeCommand()` will be called which in turn calls `Ui#showCommands()`
+
+
+- **Step 4**
+
+  Finally `Ui#showCommands()` will call `Ui#showRecipeCommands()`, `Ui#showIngredientCommands()`, `Ui#showOtherCommands()` to print all commands for recipe, ingredient and others respectively
+
+
+<img src="images/HelpFunctionSequenceDiagram.png" width="732" />
+
+### Exit feature
+The help feature is facilitated by the `ExitCommand` class. By calling `executeCommand` on the class, it will invoke the `Ui` class to print the exit command.
+
+- **Step 1**
+
+  Input will be sent from the main `EssenMakanan` class to the `Parser` to identify the command type
+
+
+- **Step 2**
+
+  A new `ExitCommand` object will be created and will be sent back to main
+
+
+- **Step 3**
+
+  `commandObject#executeCommand()` will be called which in turn calls `Ui#showCommands()`
+
+
+- **Step 4**
+
+  Finally `Ui#showCommands()` will print the exit message
+
+
+<img src="images/ExitSequenceDiagram.png" width="571" />
+
+
+### Add Recipe feature
+
+The add recipe feature is facilitated by the `AddRecipeCommand` class. By calling `executeCommand` on the class, the steps will
+be executed as follows:
+- **Step1**
+
+  `AddRecipeCommand` will parse the recipe title using `RecipeParser`. Then, it will return the recipe title.
+
+
+- **Step2**
+
+  `AddRecipeCommand` will create a new `Recipe` with the obtained title.
+
+
+- **Step3**
+
+  `AddRecipeCommand` will add newly created `Recipe` into `RecipeList`. Then, the recipe will be added into an
+  `ArrayList` inside `RecipeList`.
+
+
+- **Step4**
+
+  `AddRecipeCommand` will call `Ui` class to print out the title of the recently added recipe.
+
+<img src="images/AddNewRecipeSequenceDiagram.png" width="963" />
+
+### View Ingredients feature
+The view ingredient feature is facilitated by the `ViewIngredientCommand` class. Users can input
+"view i" to trigger this command. Users will then be able to see all ingredients stored.
+Example: 
+
+`1. bread: 2pcs`
+
+`2. apple: 500g`
+
+`...`
+
+- **Step 1**
+
+  Input will be sent from the main `EssenMakanan` class to the `Parser` to identify the command type.
+
+
+- **Step 2**
+
+  A new `ViewIngredientCommand` object will be created and will be sent back to main 
+
+
+- **Step 3**
+
+  `commandObject#executeCommand()` will be called which in turn calls `Ui#printAllIngredients()`
+
+
+- **Step 4**
+
+  Finally `Ui#printAllIngredients()` will call `IngredientList#listIngredients()` to print all the ingredients
+  to standard output
+
+
+<img src="images/ViewAllIngredientSequenceDiagram.png" width="967" />
+
+### View Recipes feature
+The view recipes feature is facilitated by the `ViewRecipeCommand` class. Users can input
+"view r" to trigger this command
+
+* **Step 1**
+
+  Input will be sent from the main `EssenMakanan` class to the `Parser` to identify the command type.
+
+* **Step 2**
+
+  A new `ViewRecipeCommand` object will be created and will be sent back to main
+
+* **Step 3**
+
+  `commandObject#executeCommand()` will be called which in turn calls `Ui#printAllRecipes()`
+
+* **Step 4**
+
+  Finally, `RecipeList#listRecipeTitles()` will be called to print all the ingredients
+  to standard output
+
+<img src="images/ViewAllRecipeSequenceDiagram.png" width="862" />
+
+### Add Ingredient feature
+
+The add Ingredient feature is used by a `AddIngredientCommand` class.
+Multiple ingredients can be added at the same time using the syntax
+`add i/NAME,QUANTITY,UNIT i/INGREDIENT2,.. i/INGREDIENT3...`
+
+By calling `executeCommand` on the class, the steps will
+be executed as follows:
+* **Step1**
+
+  `AddIngredientCommand` will use the "split" method of `String` to get an array of the descriptions of ingredients 
+   and iterate all the elements in this array
+
+
+* **Step2**
+
+  `AddIngredientCommand` will get a new `Ingredient` by invoking the method "parseIngredient" of `IngredientParser` 
+  for each element of the obtained array
+
+
+* **Step3**
+
+  `AddIngredientCommand` will add this `Ingredient` into `IngredientList`. Then, the ingredient will be added into an
+  `ArrayList` inside `IngredientList`.
+
+
+* **Step4**
+
+  `AddIngredientCommand` will call `Ui` class to print out the name of the recently added ingredient.
+
+<img src="images/AddNewIngredientSequenceDiagram.png" width="1676" />
+
+
+### Delete feature
+
+
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
 
@@ -14,25 +236,37 @@
 
 {Describe the target user profile}
 
+This product is for people who share kitchen space and ingredients with other cooks.
+
+
 ### Value proposition
 
 {Describe the value proposition: what problem does it solve?}
 
+Easy and intuitive way to keep track of ingredients you have in your kitchen. This helps avoid buying duplicated ingredients, reminds you of the ingredients you need, and gives a visualisation of the recipe timeline to ensure that advance preparation is done in time, eg marinating.
+
+
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+| Version | As a ...      | I want to ...                     | So that I can ...                            |
+|---------|---------------|-----------------------------------|----------------------------------------------|
+| v1.0    | beginner user | see all recipes                   | learn and try all recipes                    |
+| v1.0    | beginner user | add new recipes into the list     | learn and try out new recipes                |
+| v1.0    | beginner user | see all ingredient I have         |                                              |
+| v1.0    | beginner user | add ingredients to the empty list | add an item to my kitchen inventory          |
+| v2.0a   | amateur       | delete some recipes               | remove a recipe that I no longer want to use |
 
 ## Non-Functional Requirements
 
 {Give non-functional requirements}
+1. Should work on any mainstream OS as long as it has Java 11 or above installed.
+2. Should be able to hold up to 1000 recipes and ingredients without a noticeable sluggishness in performance for typical usage.
+3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
 
 ## Glossary
-
 * *glossary item* - Definition
+- Mainstream OS: Windows, Linux, Unix, OS-X
 
-## Instructions for manual testing
 
+## Instructions for manual testing
 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}