[CS2113-T14-4] DietaryBook

.gitignore

@@ -3,6 +3,9 @@
 /out/
 /*.iml
 
+# VSCode files
+/.vscode/
+
 # Gradle build files
 /.gradle/
 /build/
@@ -15,3 +18,8 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+
+# IDE specific files
+.project
+/.settings/
+

META-INF/MANIFEST.MF

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

UML_diaghrams/save_load_feature/Architecture.puml

@@ -0,0 +1,19 @@
+@startuml
+object Saver
+object Loader
+object FoodSaveLoadManager
+object PersonSaveLoadManager
+object Command
+object File
+
+File <-up-> Saver
+File <-up-> Loader
+
+Saver <-up-> FoodSaveLoadManager
+Saver <-up-> PersonSaveLoadManager
+Loader <-up-> FoodSaveLoadManager
+Loader <-up-> PersonSaveLoadManager
+
+FoodSaveLoadManager <-up-> Command
+PersonSaveLoadManager <-up-> Command
+@enduml

UML_diaghrams/save_load_feature/FoodSaveLoadManager_load.puml

@@ -0,0 +1,24 @@
+@startuml
+
+-> FoodSaveLoadManager : load()
+activate FoodSaveLoadManager
+
+FoodSaveLoadManager -> Loader : static load()
+
+activate Loader
+Loader -> FileLoader : load()
+
+activate FileLoader
+loop all lines
+    activate Scanner
+    FileLoader -> Scanner : readline()
+    Scanner --> FileLoader : line data
+    destroy Scanner
+end
+FileLoader --> Loader : FileLoader
+deactivate FileLoader
+
+Loader --> FoodSaveLoadManager : FileLoader
+deactivate Loader
+deactivate FoodSaveLoadManager
+@enduml

UML_diaghrams/save_load_feature/FoodSaveLoadManager_save.puml

@@ -0,0 +1,24 @@
+@startuml
+-> FoodSaveLoadManager : save
+activate FoodSaveLoadManager
+
+
+loop all food items
+    loop every entry in a food object
+    activate Saver
+    FoodSaveLoadManager -> Saver : add()
+    end
+end
+
+FoodSaveLoadManager -> Saver : save()
+deactivate Saver
+
+activate FileWriter
+loop all entries in Saver table
+    Saver -> FileWriter : write()
+end
+destroy FileWriter
+
+deactivate FoodSaveLoadManager
+
+@enduml

UML_diaghrams/save_load_feature/UML diagram.puml

@@ -0,0 +1,15 @@
+
+@startuml
+-> FoodSaveLoadManager : save
+
+loop all food items
+    loop every entry in a food object
+    FoodSaveLoadManager -> Saver : add()
+    end
+end
+
+FoodSaveLoadManager -> Saver : save()
+loop all entries in Saver table
+    Saver -> FileWriter : write()
+end
+@enduml

build.gradle

@@ -10,6 +10,8 @@ repositories {
 }
 
 dependencies {
+    implementation 'org.junit.jupiter:junit-jupiter:5.4.2'
+    implementation 'org.junit.jupiter:junit-jupiter:5.4.2'
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
 }
@@ -29,11 +31,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.dietbook.DietBook"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "dietbook"
     archiveClassifier = null
 }
 
@@ -43,4 +45,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,13 @@
 # About us
+we are an idiosyncratic and narcissistic batch of self-righteous
+elitist who defends presumably morally questionable positions.
+Also we are cheap!
+
 
 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) | Heng Fu Yuen | [Github](https://github.com/HengFuYuen) | [Portfolio](docs/team/johndoe.md)

docs/DeveloperGuide.md

@@ -1,14 +1,155 @@
 # Developer Guide
 
-## Design & implementation
+* Table of Contents
+{:toc} 
 
+## Design 
+
+### UI component
+![Ui component](diagrams/Ui component.png)
+
+**API**: [`Ui.java`](https://github.com/AY2021S1-CS2113-T14-4/tp/blob/master/src/main/java/seedu/dietbook/Ui.java)
+
+The `UI` component,
+* Takes in user command and passes to the `Logic` components for command execution.
+* Updates the user about any changes in the data after executing the command or errors encountered when executing the commands.
+
+The UI has a dependency with two enumeration class, [`ActivityLevel`](https://github.com/AY2021S1-CS2113-T14-4/tp/blob/master/src/main/java/seedu/dietbook/person/ActivityLevel.java) and [`Gender`](https://github.com/AY2021S1-CS2113-T14-4/tp/blob/master/src/main/java/seedu/dietbook/person/Gender.java) as descriptions of each [`ActivityLevel`](https://github.com/AY2021S1-CS2113-T14-4/tp/blob/master/src/main/java/seedu/dietbook/person/ActivityLevel.java) and [`Gender`](https://github.com/AY2021S1-CS2113-T14-4/tp/blob/master/src/main/java/seedu/dietbook/person/Gender.java) is required. Increased coupling was sacrificed to reduce code duplicates and increase ease of code extension/editing.
+
+## Implementation
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+### [Proposed] Enter user information feature
+
+#### Proposed Implementation
+The proposed feature utilised two commands words [`name`](UserGuide.md/####Entering username: `name`) and [`info`](UserGuide.md/####Entering user information: `info`) that allows users to enter their name using the [`name`](UserGuide.md/####Entering username: `name`) command and [`info`](UserGuide.md/####Entering user information: `info`) to enter other information, such as age, gender, height, activity level, original, current and target weight, separately. 
+
+The proposed feature to enter user information is facilitated by `Manager` which stores a [`Person`](https://github.com/AY2021S1-CS2113-T14-4/tp/blob/master/src/main/java/seedu/dietbook/person/Person.java) which
+ stores all user information provided. It implements the following operation:
+
+* Manager#setPerson(String newName, Gender newGender, int newAge, int newHeight, int newOriginalWeight, int newCurrentWeight, int newTargetWeight, ActivityLevel newActivityLevel) - Calls the method below to set the attribute values of the `Person` object.
+* Person#setAll(String newName, Gender newGender, int newAge, int newHeight, int newOriginalWeight, int newCurrentWeight, int newTargetWeight, ActivityLevel newActivityLevel) - Updates the attribute values of the `Person` object.
+
+Both operation are only executed by the `Manager` class of the `Logic` component. Only one instance of `Person` is ever instantiated. A default person is instantiated at the start with default attribute values and when the user enters their information for the first time during the set up, all the default values would be updated to the inputted values. Therefore, the command to enter the user information will result in a change in the attribute values and not the creation of a new `Person` object.
+
+Given below is the example usage scenario and how the feature works.
+
+Step 1. When the user launches the application for the first time. A default `Person` object will be initialised by `Manager` and the user will be prompted to enter their name.
+
+![Enter Info Step1](diagrams/Enter Info Step1.png)
+
+Step 2. The user executes `name Jack` command to enter their name into DietBook. The `name` command calls `Manager#setName(Jack)`, to store the name in `Manager` first. After which, user will be prompted to enter all other details.
+
+![Enter Info Step2](diagrams/Enter Info Step2.png)
+
+Step 3. The user executes a command like the following `info g/M a/21 h/175 o/85 c/85 t/75 l/2` to enter all other personal information including age, gender, height, activity level, original, current and target weight. The `info` command then calls `Parse#executeProcessedInfo(info g/M a/21 h/175 o/85 c/85 t/75 l/2, manager)` which would parse the user command, check input validity by using methods in `InputChecker` and calls `Manager#setPerson(Jack, Gender.MALE, 21, 175, 85, 85, 75, ActivityLevel.LOW)` which proceeds to call `Person#setAll(Jack, Gender.MALE, 21, 175, 85, 85, 75, ActivityLevel.LOW)`.
+
+![Enter Info Step3](diagrams/Enter Info Step3.png)
+
+The following sequence diagrams shows how the feature works.
+
+`name` command
+
+![Name sequence diagram](diagrams/Name sequence diagram.png)
+
+`info` command
+
+![Info sequence diagram](diagrams/Info sequence diagram.png)
+
+#### Design considerations:
+
+Aspect: Whether to enter name and other information separately or together
+
+* **Alternative 1 (current choice)**: Enter name and other information separately
+    * Pros: Increase user interaction and engagement.
+    * Cons: Enter information using two commands.
+
+* **Alternative 2**: Enter name and other information together
+    * Pros: Enter all information at once.
+    * Cons: Increase user interaction and engagement.
+
+Aspect: Whether to use singleton pattern for Person class
+
+* **Alternative 1 (current choice)**: Did not use singleton pattern for `Person`
+    * Pros: Reduce coupling and increase testability.
+    * Cons:  Risk of creating multiple `Person` object by mistake and there might be negative consequence in creating multiple objects.
+
+    However, there  is minimal risk of creating multiple `Person` object by mistake and minimal negative consequence in creating multiple objects as long as the `Manager` refers the correct instance of `Person`.
+
+* **Alternative 2**: Use singleton pattern for `Person`    
+    * Pros: Easy to implement, prevent the instantiation of more than one `Person` object.
+    * Cons: Increase coupling and reduce testability
+
+Aspect: Changing attribute values in `Person` object or creating new `Person` object
+
+* **Alternative 1 (current choice)**: Changing attribute values in `Person` object 
+    * Pros: Reduce the number of objects being created to reduce memory usage and reduce the risk of creating multiple objects which can potentially lead to negative consequences and bugs.
+    * Cons: Unable to write tests as method chains.
+
+* **Alternative 2**: Creating new `Person` object
+    * Pros: Ability to write tests as method chains.
+    * Cons: Creation of many objects, which take up memory spaces and ensure that only the correct `Person` instance is kept and referred to.
+
+## Save/Load Feature
+
+The Save/Load feature is implemented by the saveload package.
+At the base of the package, there is the <mark> Saver </mark> 
+and <mark> Loader </mark>  class.
+
+### Architecture
+![Alt text](save_load_feature/Architecture.png)
+Note only the Saver and Loader class is flexible. They can be adapted to new situations without modifying
+the code. The FoodSaveLoadManager and PersonSaveLoadManager are written specifically for this version. They
+will have to be modified/replaced for future versions.
+
+#### Saver class
+
+Stores data in a internal table with length and height specified.
+Handles the storage of its data by writing to a text file.
+
+##### Constructor
+Specifies the length and height of the internal Saver table
+##### Main Methods
+* Saver#save() saves the current data to the file in the folder with the given file name
+* Saver#add() Store String data in the x,y position in the table
+
+#### Loader class
+Loads data from a text file and stores it in a internal table just like the saver
+##### Constructor
+static method Loader.load(folder name , file name) : creates a Loader object with 
+a table storing the data found in the text file
+##### Main Methods
+* Loader#get() retrives the data stored in the loader
+
+#### FoodSaveLoadManager class
+Built on top of Saver and Loader class to implement save/load functionality
+for list of food items the user has input into the dietbook. Contains a instance
+of both <mark> Saver </mark> and <mark> Loader </mark>. It has its own folder to work with,
+the user only has to specify the file name.
+##### Main Methods
+* FoodSaveLoadManager#save() saves the list of food objects to the specified file name
+* FoodSaveLoadManager#load() loads the file and returns the list of food objects stored inside it
+
+#### PersonSaveLoadManager class
+Built on top of Saver and Loader class to implement save/load functionality for user information
+Same as FoodSaveLoadManager, it has its own folder to work with, the user only has to specify the file name
+Unlike the FoodSaveLoadManager, it stores the data inside itself and can be updated.
+##### Main Methods
+* PersonSaveLoadManager#save() save the current state into the file
+* PersonSaveLoadManager#load() loads the file 
+* Setters and Getters for all the personal data in this current version
+
+#### UML diaghram
+##### FoodSaveLoadManager#save()
+![Alt text](save_load_feature/FoodSaveLoadManager_save.png)
+##### FoodSaveLoadManager#load()
+![Alt text](save_load_feature/FoodSaveLoadManager_load.png)
+similiar diaghrams for PersonSaveLoadManager
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+NUS students living on campus who would like to track their daily food and nutritional intake.
 
 ### Value proposition
 
@@ -23,12 +164,11 @@
 
 ## Non-Functional Requirements
 
-{Give non-functional requirements}
+1. Should work on any mainstream OS as long as `Java 11` is installed in the system.
 
 ## Glossary
 
-* *glossary item* - Definition
+* *Mainstream OD* - Windows, Linux, Unix, OS-X
+* *Food items* - Includes both food and drinks 
 
 ## 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}

docs/README.md

@@ -1,8 +1,16 @@
-# Duke
+# DietBook
 
-{Give product intro here}
+[![CI status](https://github.com/AY2021S1-CS2113-T14-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2113-T14-4/tp/actions)
+
+DietBook is a Command Line Interface (CLI) desktop application designed to **track your food and nutritional intake** as well as provide you with your **daily calorie recommendation**. As the application mainly targets _NUS students staying on campus_, it has a **database prepopulated with food items commonly found around NUS**. This allows for such food items to be easily added to the list of food items consumed for tracking.
+
+**Useful links:**
+
+* If you would like to use DietBook, head over to [User Guide](UserGuide.md) to get started.
+* If you would like to know more about developing DietBook, head over to [Developer Guide](DeveloperGuide.md).
+* If you would like to know more about the developers, head over to [About Us](AboutUs.md).
+
+**Acknowledgements:**
+
+* Libraries used: [JUnit5](https://github.com/junit-team/junit5)
 
-Useful links:
-* [User Guide](UserGuide.md)
-* [Developer Guide](DeveloperGuide.md)
-* [About Us](AboutUs.md)