[CS2113-T16-3] Expiry Eliminator

.gitignore

@@ -8,6 +8,9 @@
 /build/
 src/main/resources/docs/
 
+# Log files
+/*.log.*
+
 # MacOS custom attributes files created by Finder
 .DS_Store
 *.iml

README.md

@@ -1,6 +1,6 @@
-# Duke project template
+# Expiry Eliminator
 
-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.
+This is a project based on Duke, which 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.
 
 ## Setting up in Intellij
 
@@ -9,7 +9,7 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
 1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project.
    * In the same dialog, you _may_ have to set the Project language level field to the SDK default option.
 1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
+1. **Verify the set up**: After the importing is complete, locate the `src/main/java/expiryeliminator/ExpiryEliminator.java` file, right-click it, and choose `Run ExpiryEliminator.main()`. If the setup is correct, you should see something like the below:
    ```
    > Task :compileJava
    > Task :processResources NO-SOURCE
@@ -40,7 +40,7 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
 
 ### JUnit tests
 
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
+* A skeleton JUnit test (`src/test/java/expiryeliminator/ExipiryEliminatorTest.java`) is provided with this project template. 
 * If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
 
 ## Checkstyle

build.gradle

@@ -29,18 +29,19 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "expiryeliminator.ExpiryEliminator"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
-    archiveClassifier = null
+    archiveBaseName = "expiryeliminator"
+    archiveClassifier = "v2.0"
 }
 
 checkstyle {
     toolVersion = '8.23'
 }
 
-run{
+run {
     standardInput = System.in
+    enableAssertions = true;
 }

docs/AboutUs.md

@@ -2,8 +2,9 @@
 
 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)
+
+![](https://via.placeholder.com/100.png?text=Photo) | Bernard Boey | [Github](https://github.com/bernardboey) | [Portfolio](docs/team/bernardboey.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Joshua Dass | [Github](https://github.com/JoshHDs) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Vincent Lau Han Leong | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Kairui | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+

docs/DeveloperGuide.md

@@ -4,15 +4,179 @@
 
 {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.}
+### Data
+**API** : [Data.java](https://github.com/AY2122S1-CS2113-T16-3/tp/tree/master/src/main/java/expiryeliminator/data)
 
+![](diagrams/Data.png)
+
+ - The `Data` Component,
+     - Stores a list of `Recipe` objects, in the form of `RecipeList`
+     - Stores a list of `IngredientStorage`, in the form of `IngredientRepository`
+ - Each `Recipe` has its ingredients and respective quantities stored in `IngredientQuantity`
+ - The `Ingredient Storage` separates a specific ingredient into batches of quantities, 
+   according to the expiry date.
+ - `Ingredient` stores the information of the ingredients, which are its name and unit, 
+   e.g. Chicken and grams.
+
+### Parser
+
+This is a (partial) class diagram of the Parser component. Note that the `Parser` class in actuality is dependent on 
+many of the classes depicted in the diagram: `SingleArgPrefix`, `MultipleArgPrefix`, `OptionalArgPrefix`,
+`ExpiryDateParser`, `UnitParser`, `IngredientParser`, `QuantityParser`, `RecipeParser`. The dependencies have been 
+omitted from the diagram for simplicity.
+
+![](diagrams/ParserClassDiagram.png)
+
+
+
+## Implementation
+This section describes how the features are implemented.
+
+### List all Ingredients Feature
+
+The list ingredients feature is performed by `IngredientRepository`. It loops through all the different
+ingredient storages, and concatenates them into a string which is shown as the output list. Below is the
+sequence diagram for how list works.
+
+![](diagrams/List.png)
+
+### List Expired Ingredients Feature
+
+The list expired ingredients feature is performed by `IngredientRepository`. It loops through all the
+ingredient storages. For each ingredient storage, it gets the type of ingredient being stored in that 
+storage, and creates an empty storage for that ingredient type to store the batches of that ingredient 
+that are expired. The code then loops through all the batches of that ingredients, and add the expired 
+batches to the expire ingredient storage. The expired ingredient storage is converted into a string and
+is shown as the output. Below is the sequence diagram for how list expired ingredients works.
+
+![](diagrams/ListIngredientsExpired.png)
+
+### Delete Expired Ingredients Feature
+
+The delete expired ingredients feature is performed by the `IngredientRepository`. It loops through all
+the ingredient storages. For each ingredient storage, it loops through all the batches of that ingredient.
+If the batch has expired, it adds the expiry date of that batch to an array. After it has looped though
+all the batches of a specific ingredient, it proceeds to remove all those ingredient batches from the
+repository. This process then repeats for the next type of ingredient. Below is the sequence diagram for
+how delete expired ingredients works.
+
+![](diagrams/DeleteExpiredIngredients.png)
+
+### View Ingredient Feature
+
+The view ingredient feature is performed by the `IngredientRepository`. It finds if the ingredient
+repository contains an ingredient with the same name as the user input, and return the storage of that
+ingredient. The storage data is represented as a string that is shown as an output. Below is the sequence
+diagram for how view ingredient works.
+
+![](diagrams/ViewIngredient.png)
+
+### Update Units Feature
+
+The update units feature is performed by both the `IngredientRepository` and `RecipeList`. First, it finds
+the ingredient storage of the ingredient and updates the units there. Then it finds the recipes which 
+contain the ingredient and updates the units there. Below is the sequence diagram for how update unit
+works.
+
+![](diagrams/UpdateUnits.png)
+
+### Shopping List Feature
+
+The shopping list feature is performed by the `IngredientRepository`. It loops through all the recipes 
+the user wants to cook and collates all the ingredients and quantities into totalIngredients. It then
+loops through all the ingredient storages to see if there is enough ingredients. If there isn't it adds 
+the ingredient and respective quantity to the shopping list. It returns the shopping list as a String to
+be shown as the output. Below is the sequence diagram for how the shopping list feature works.
+
+![](diagrams/ShoppingList.png)
+
+### Add Recipe Feature
+
+The add recipe feature is performed by `RecipeList`. It adds a `Recipe` and its respective 
+ingredients to the `RecipeList`.
+
+Here is the sequence diagram for how add recipe works if the correct input is given and 
+all ingredients exist in the `Ingredient Repository`.
+
+![](diagrams/AddRecipe.png)
+
+ `Recipe` checks if an ingredient exists in the `Ingredient Repository` before
+ adding the ingredient into the `Recipe`. If it doesn't exist, `Recipe` adds 
+ the ingredient into the `Ingredient Repository` without any quantity and expiry date, 
+ and it reminds the user to update the units of the ingredients.
+
+The reason for this implementation is so that the user doesn't have to manually add the ingredients,
+as the ingredient has to be in the `Ingredient Repository` for the [cooked 
+recipe feature](#cooked-recipe-feature) to work
+
+> **Note** : Here are a few cases where an error will be returned, and the `Recipe` 
+> will not be saved.
+>
+> - the `Recipe` already exists in the `RecipeList`,
+> - A number less than 1 is entered for one of the quantity of the ingredients of the `Recipe`.
+> - Two same ingredients in one `Recipe`.
+
+<br/>
+
+### Delete Recipe Feature
+
+The delete recipe feature is performed by `RecipeList`. It deletes a `Recipe` from the `RecipeList`.
+
+Here is the sequence diagram for how delete recipe works if the `Recipe` exists in the `RecipeList`.
+
+![](diagrams/DeleteRecipe.png)
+
+> **Note** : If the `Recipe` doesn't exist in the `RecipeList`, an error will be returned.
+
+<br/>
+
+### Cooked Recipe Feature
+
+The cooked recipe feature is performed by `Recipe`. It deletes a certain quantity of ingredients in the
+`Ingredient Repository` based on the quantities of ingredients in the `Recipe`.
+
+Here is the sequence diagram for how cooked recipe works if the amount of ingredients in the `Ingredient Repository`
+is sufficient to be deducted.
+
+![](diagrams/CookedRecipe.png)
+
+The feature leaves the responsibility of dealing with expired ingredients to the user, and
+will remove ingredients starting from the earliest batch of ingredients. (ingredients that 
+expire the soonest, including those that are already expired.)
+
+> **Note** : Here are a few cases where an error will be returned, and the quantities of the ingredients in the
+> `Ingredient Repository` will not be updated.
+> 
+> - The `Recipe` does not exist in the `RecipeList`
+> - There is insufficient ingredients in the `Ingredient Repository` for the `Recipe` to be cooked.
+
+<br/>
+
+###List Recipes User Can Cook Feature
+
+The list recipe user can cook feature is performed by the `ListRecipeUserCanCookCommand`.
+It returns a list of recipes that the user can cook with the ingredients the user currently
+have.
+
+Here is the sequence diagram for how list recipe user can cook works
+
+![](diagrams/ListRecipesUserCanCook.png)
+
+The feature will indicate that the `Recipe` can be cooked even if some of the ingredients have
+expired. However, it will inform the user that there are expiring ingredients. The responsibility
+of dealing with expired ingredients is left to the user.
+
+The feature will inform the user if there is insufficient ingredients to cook any `Recipe` or if 
+there is no `Recipe` in the `RecipeList`.
+
+<br/>
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+Young adults who are living in their own home.
 
 ### Value proposition
 
@@ -22,8 +186,22 @@
 
 |Version| As a ... | I want to ... | So that I can ...|
 |--------|----------|---------------|------------------|
+|v1.0|user|add an ingredient|record what ingredients I have|
+|v1.0|user|delete an ingredient|remove ingredients that I no longer have|
+|v1.0|user|increment quantities for a particular ingredient|record how much of that ingredient I have|
+|v1.0|user|decrement quantities for a particular ingredient|know how many ingredients are left|
+|v1.0|user|list the ingredients with quantities and expiry dates|know the ingredients I have at a glance|
+|v1.0|user|view the quantities for a particular ingredient|know how much of a specific ingredient I have|
+|v1.0|user|list ingredients expiring within the week|know which ingredients I should use up first|
+|v1.0|user|list ingredients that have expired already|know which ingredients to throw away|
+|v1.0|user|add the expiry date for a specific ingredient|record when it must be used by|
 |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|
+|v1.0|user|add a recipe and its constituent ingredients|keep track of what I want to cook|
+|v1.0|user|delete a recipe|retain only recipes I want|
+|v2.0|user|be able to indicate that I have cooked a recipe|keep my ingredient repository accurate|
+|v2.0|user|list recipes i can cook based on the ingredients I have|save time on checking the ingredients I have|
+|v2.0|user|generate a shopping list for a particular recipe/recipes|know what ingredients to buy|
+|v2.0|user|delete all ingredients that have expired at one go|all ingredients I keep track of are not expired|
 
 ## Non-Functional Requirements
 

docs/UserGuide.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-{Give a product intro}
+Expiry Eliminator (v1.0) is a desktop app for managing the freshness of ingredients in your kitchen and the recipes you want to cook, optimized for use via a Command Line Interface (CLI). If you can type fast, Expiry Eliminator can help you manage your ingredients and recipes quickly.
 
 ## Quick Start
 
@@ -15,19 +15,42 @@
 
 {Give detailed description of each feature}
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+### Adding an ingredient: `add`
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+Adds an ingredient to the ingredient repository.
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+Format: `add i/INGREDIENT [u/UNIT] [q/QUANTITY e/EXPIRY_DATE]
 
-Example of usage: 
+- Unit is optional.
+- Quantity and expiry date is optional, but you cannot have one and not the other (i.e. you either don't provide both quantity and expiry date, or you provide both quantity and expiry date).
+- Expiry date must be in the format of `yyyy-mm-dd`.
+- Quantity must be an integer.
+- Note that ingredient names are case insensitive, and will be automatically stored in title case (e.g. `ReD aPplE` will be stored as `Red Apple`).
+- Ingredient names must be unique.
+- If the ingredient name already exists, an error message will be shown.
 
-`todo n/Write the rest of the User Guide d/next week`
+Example of usage:
+- `add i/Red Apple`
+- `add i/Salt u/g`
+- `add i/Red Apple q/5 e/2021-10-08`
+- `add i/Salt u/g q/1000 e/2021-01-01`
+
+### Adding a recipe: `add recipe`
+
+Adds a recipe with its respective ingredients to the database
+
+Format: `add recipe r/RECIPE i/INGREDIENT q/QUANTITY i/INGREDIENT q/QUANTITY...`
+
+- Adds a recipe and its INGREDIENT with the corresponding QUANTITY for each ingredient. 
+  QUANTITY must be a non-negative integer with the corresponding units for ease of reference later on.
+- The ingredient and recipe names are case insensitive (E.g.: ChiCkEN SoUP would be recorded as Chicken Soup)
+- The recipe is added to the next item on the list
+- The ingredients and the quantity can be added in any order, but the first ingredient will correspond to the first
+ quantity added, second ingredient to second quantity etc.
+
+Example of usage:
+`add recipe r/Chicken Soup i/Chicken q/300g i/Salt q/10g`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
 
 ## FAQ
 

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

docs/diagrams/AddRecipe.puml

@@ -0,0 +1,45 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+autonumber
+box Logic
+-> Parser: parseCommand(userInput)
+activate Parser
+
+create AddRecipeCommand
+Parser -> AddRecipeCommand : AddRecipeCommand(recipe, ingredientNames, quantities)
+activate AddRecipeCommand
+
+return
+return command
+
+-> AddRecipeCommand : execute(ingredients,recipes)
+activate AddRecipeCommand
+end box
+
+box Data
+create Recipe
+AddRecipeCommand -> Recipe : Recipe(name)
+activate Recipe
+
+return
+
+loop all ingredients
+AddRecipeCommand -> Recipe : add(ingredientName, quantity, ingredients)
+activate Recipe
+create IngredientQuantity
+Recipe -> IngredientQuantity : IngredientQuantity(ingredientName, quantity)
+activate IngredientQuantity
+return
+end
+
+return
+
+AddRecipeCommand -> RecipeList : add(recipe)
+activate RecipeList
+end box
+
+return
+return message
+destroy AddRecipeCommand
+@enduml