[CS2113-T12-2] Grocery in Time

.gitignore

@@ -15,3 +15,7 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+GroceryList.log
+GroceryList.log.lck
+

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "markis.code-coverage"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "interactive"
+}

README.md

@@ -1,4 +1,6 @@
-# Duke project template
+# GiT
+
+Grocery in Time !
 
 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

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("git.Git")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("Git")
     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) | Luo Zi Hui | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Liu Siyi  | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Willson Han Zhekai  | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Sharlyn Lui  | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Luo Yu   | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)

docs/DeveloperGuide.md

@@ -7,23 +7,99 @@
 ## Design & implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### 1. View all groceries added
+   * First create a method in "Grocery" class that prints the grocery in a preferred format.\
+     e.g., NAME, AMOUNT, EXPIRATION, PRICE.
+   * Then create a method in "GroceryList" class that prints all the groceries in the list.
+
+
+### 2. List the groceries by price in descending order
+   * First, create a field in "Grocery" class that stores the cost of a grocery.
+   * When adding a grocery, prompt the user to enter the cost.
+   * Format the cost into 2 decimal places, remove the dollar sign and store it as a string.
+   * Second, the grocery's cost accordingly before adding it into the list.
+   * When setting the cost, convert the cost from String into Double.
+   * Third, add method in "GroceryList" class to create a copy of the current grocery list, then sort the 
+   new grocery list by price using lambda function. Reverse and print the new list.
+
+
+### 3. Input category for each grocery added
+   * In Grocery class, modified the Grocery constructor to accept the 'category' parameter.
+   * In Parser class executeCommand method, modified the add command to prompt the user for the category of the grocery. Passed the category as a parameter when creating a new Grocery object.
+   * In Ui class, added a new method promptForCategory to prompt the user for the category of the grocery.
+   * In Grocery class, modified the printGrocery method to include the category information in the output string.
+
+
+### 4. Input amount for each grocery added
+   * In Grocery class, modified the Grocery constructor to accept the 'amount' parameter.
+   * In Parser class executeCommand method, modified the add command to prompt the user for the amount of grocery. Passed the amount as a parameter when creating a new Grocery object.
+   * In Ui class, added a new method promptForAmount to prompt the user for the amount of grocery.
+   * In Grocery class, modified the printGrocery method to print different units of measurement for different categories.
+
+
+### 5. Input the location of where each grocery is stored
+   * In Grocery class, modified the Grocery class to include location (String) as an attribute.
+   * In Grocery class, modified the Grocery constructor to accept the 'location' parameter.
+   * In Grocery class, under printGrocery, added locationString to format location.
+   * In Parser class executeCommand method, modified the add command to prompt the user for where the grocery is stored. Passed the location as a parameter when creating a new Grocery object.
+   * In Ui class, added promptForLocation method to take in user input for location of the grocery.
+   * In Ui class, modified the printGrocery method to print the 'location' of the grocery alongside the grocery name.
+   * Alternative considered: Can possibly add location as enumeration however different people might store groceries in different places thus better to set as String so that user is free to input location details however specific they want.
+
+### 6. Edit grocery amount after using a grocery
+   * A `Grocery` stores its `amount` as an attribute. All `Grocery` objects are then stored in an ArrayList in `GroceryList`, which entirely handles the editing of the `amount`.
+
+![Grocery (showing amount) and GroceryList class diagram](./diagrams/GroceryAmtGroceryList.png)
+
+   * `GroceryList#editAmount()` is used to either decrease or directly set the `amount` of a `Grocery`. It takes in 2 parameters:
+      1. details: String — User input read from `Scanner`.
+      2. use: boolean — `true` decreases the `amount`, while `false` directly sets it.
+   * To edit the `amount` after using a `Grocery`, the user inputs `use GROCERY a/AMOUNT`. 
+Our app then executes `GroceryList#editAmount()` with parameter `use = true`, as illustrated by the following sequence diagram.
+
+![useAmt sequence diagram](./diagrams/useAmt.png)
+
+  * Additional checks specific to `use` ensure that the user only inputs a valid `int`, or that the `amount` must not be 0 beforehand.
+  * Any exceptions thrown come with a message to help the user remedy their specific issue, as displayed by the `Ui`.
+
+### 7. Input expiration date of each grocery when added
+   * In Grocery class, the expiration field in the Grocery class was changed from a String to a LocalDate to standardize date handling.
+   * In Grocery class, the setExpiration method was updated to accept a String input, convert it to a LocalDate using a specified format ("yyyy-MM-dd"), and then store this date.
+   * In UI class, the UI now includes a multi-step process to prompt the user for the year, month, and day of the grocery item's expiration date. This process ensures that the date is captured in a user-friendly manner and stored accurately.
+   * In GroceryList class, a new method, sortByExpiration, was added to allow sorting the list of groceries by their expiration dates in ascending order. This method utilizes the Collections.sort method with a lambda expression comparing the expiration dates of Grocery items.
+
+### 8. Editing expiration date after it is added
+   * In GroceryList class, modified the editExpiration method to parse String into localdate.
 
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+Our target user is someone who regularly goes grocery shopping, and would like to track and manage their inventory of groceries.
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+Grocery in Time aims to act as an easy-to-use central database for all the user's groceries. Managing many groceries stored at different locations around the house can get confusing,
+therefore our app will allow users to track their groceries easily. 
+
+Users are able to edit and manage the category, amount, expiration date, and storage location of their groceries.
+When groceries are running low, the app can generate a shopping list to remind users of what they need to buy.
+Furthermore, the app can generate a list of items that are expiring soon, reminding users to consume their groceries as soon as possible.
 
 ## 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    | new user                      | see instructions on how to use the app      | refer to them when I forget how to use the application |
+| v1.0    | user                          | add groceries to the app                    | manage all my groceries                                |
+| v1.0    | user                          | view all my groceries                       | know what I have bought                                |
+| v1.0    | user                          | delete groceries from the list              | stop tracking those groceries                          |
+| v1.0    | user                          | add the amount of a grocery                 | keep track of the amount of that item I have           |
+| v1.0    | user                          | add the expiration date of the grocery      | keep track of when my items expire easily              |
+| v2.0    | financially-aware user        | add the cost of the groceries               | know how much I am spending                            |
+| v2.0    | health-conscious user         | categorise my groceries                     | know what types of groceries I have                    |
+| v2.0    | user with many storage spaces | add the location of where an item is stored | see where I keep my groceries                          |
+| v2.0    | user who consumes groceries   | track the usage of my groceries             | know how much I have left                              |
 
 ## Non-Functional Requirements
 

docs/UserGuide.md

@@ -1,33 +1,151 @@
-# User Guide
+# User Guide to ***Grocery in Time***
 
-## Introduction
+![Grocery in Time logo](images/GitStartup.png)
 
-{Give a product intro}
 
-## Quick Start
+## Introduction
 
-{Give steps to get started quickly}
+Grocery in Time (GiT) is a **grocery tracker app**, optimised for use via a Command Line Interface (CLI).
+It allows users to track and manage their groceries around their home easily.
 
+ 
+## Quick Start
 1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+2. Down the latest version of `Grocery in Time` from [here](https://github.com/AY2324S2-CS2113-T12-2/tp/releases).
+3. Open a command terminal, `cd` into the folder where the JAR file is
+   and use `java -jar Git.jar` to run Grocery in Time.
 
+ 
 ## Features 
 
-{Give detailed description of each feature}
+> #### Notes about the command format
+> * Words in `UPPERCASE` are parameters to be supplied by the user.
+> <br> e.g. In `find KEYWORD`, `KEYWORD` is a parameter to be supplied: `find cheese`.
+> 
+> 
+> * Features requiring the `GROCERY` input are case-insensitive. 
+> <br> e.g. `amt GROCERY a/AMOUNT` will set the amount of `milk` or `MILK`.
+
+&nbsp;
+### Setting the amount of a grocery: `amt`
+Sets the amount of a grocery.
+
+Format: `amt GROCERY a/AMOUNT`
+
+* `AMOUNT` must be a valid integer.
+
+Example of usage:
+
+`amt milk a/5`
+
+&nbsp;
+### Using a grocery: `use`
+Reduce the amount of a grocery after using it.
+
+Format: `use GROCERY a/AMOUNT`
+
+* `AMOUNT` must be a valid integer.
+* If `AMOUNT` is greater than what the `GROCERY` has in stock, its amount will be reduced to 0.
+* If the amount of the `GROCERY` is already 0, GiT will let the user know and the amount stays at 0.
+
+Example of usage:
+
+`use meat a/4`
+
+&nbsp;
+### Finding groceries: `find`
+Find groceries containing a given keyword.
+
+Format: `find KEYWORD`
+
+* The search is case-insensitive.
+* If a phrase is passed, the entire phrase is searched for.
+
+Example of usage:
+
+`find cheese`
+![Find example output](images/featureExampleOutputs/FindExOut.png)
+
+
+&nbsp;
+### Adding a storage location: `loc`
+Add a storage location to be tracked.
+
+Format: `loc LOCATION`
+
+Example of usage:
+
+`loc freezer`
+
+&nbsp;
+### Storing a grocery in a storage location: `store`
+Store a grocery in a given storage location.
+
+Format: `store GROCERY l/LOCATION`
+
+* `LOCATION` is case-insensitive. e.g. `freezer` matches `FREEZER`.
+* If `LOCATION` does not exist, GiT will create the storage location and store the `GROCERY` there automatically.
+
+Example of usage:
+
+`store paprika l/spice rack`
+
+&nbsp;
+### Viewing storage locations and their groceries: `listl`
+View all storage locations being tracked, or the groceries stored in a given location
+
+Format: `listl [LOCATION]`
+
+* `LOCATION` is an optional parameter.
+* Without `LOCATION`, all storage locations will be displayed.
+* With `LOCATION`, all groceries in the given `LOCATION` will be displayed
+
+Example of usage:
+
+* `listl`
+
+![Listl example output](images/featureExampleOutputs/ListlExOut.png)
+
+* `listl cubby`
+
+![Listl LOCATION example output](images/featureExampleOutputs/ListlLocExOut.png)
+
+&nbsp;
+### Removing a storage location: `delloc`
+Remove a storage location from tracking.
+
+Format: `delloc LOCATION`
+
+Example of usage:
+
+`delloc cabinet`
+
+### List all groceries: `list`
+Shows a list of all groceries you have.
+
+Format: `list`
+
+Example of usage:
+
+`list`
+
+### List all groceries by price: `listc`
+Shows a list of all groceries you have, sorted by price.
+
+Format: `listc`
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+Example of usage:
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+`listc`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+### List all groceries by expiration date: `liste`
+Shows a list of all groceries you have, sorted by expiration date.
 
-Example of usage: 
+Format: `liste`
 
-`todo n/Write the rest of the User Guide d/next week`
+Example of usage:
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+`liste`
 
 ## FAQ
 
@@ -37,6 +155,13 @@ Example of usage:
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+| Command                                                        | Format and example         |
+|----------------------------------------------------------------|----------------------------|
+| Set grocery amount                                             | `amt GROCERY a/AMOUNT`     |
+| Use grocery                                                    | `use GROCERY a/AMOUNT`     | 
+| Find groceries                                                 | `find KEYWORD`             |
+| Add storage location                                           | `loc LOCATION`             |
+| Store grocery                                                  | `store GROCERY l/LOCATION` |
+| View storage locations <br> View groceries in a given location | `listl [LOCATION]`         |
+| Remove storage location                                        | `delloc LOCATION`          |

docs/diagrams/GroceryAmtGroceryList.puml

@@ -0,0 +1,13 @@
+@startuml
+skinparam classAttributeIconSize 0
+
+class GroceryList
+GroceryList : +editAmount(details : String, use : boolean)
+
+class Grocery
+Grocery : -amount : int
+
+GroceryList "1" ---> "*" Grocery : stores >
+
+
+@enduml