[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
+

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,11 @@
 # About us
 
+We are a team of students from different faculties in the [National University of Singapore](http://nus.edu.sg/). 
+
 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) | John Doe | [Github](https://github.com/) | [Portfolio](team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | TiKyi Min Khant Naing | [Github](https://github.com/tikimonarch) | [Portfolio](team/tikimonarch.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Elijah Ng | [Github](https://github.com/mxksowie) | [Portfolio](team/elijahng.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Liu Haoran | [Github](https://github.com/yuqiaoluolong) | [Portfolio](team/liuhaoran.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Heng Fu Yuen | [Github](https://github.com/HengFuYuen) | [Portfolio](team/hengfuyuen.md)

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)

docs/UML_diaghrams/database_feature/DataBase_init.puml

@@ -0,0 +1,18 @@
+@startuml
+-> DataBase : init()
+activate DataBase
+activate InputStream
+DataBase -> InputStream : getResourceAsClass()
+InputStream --> DataBase : InputStream
+deactivate InputStream
+
+DataBase -> Scanner : new Scanner(InputStream)
+
+loop After START until START
+    activate Scanner
+    DataBase -> Scanner : nextLine()
+    Scanner --> DataBase : line data
+end
+destroy Scanner
+deactivate DataBase
+@enduml

docs/UML_diaghrams/database_feature/DataBase_search.puml

@@ -0,0 +1,28 @@
+@startuml
+--> DataBase : searchFoodByIndex
+activate DataBase
+DataBase -> Stream : foodStream()
+activate Stream
+Stream --> DataBase : foodStream
+
+DataBase -> Stream : skip()
+Stream --> DataBase : foodStream.skip
+
+DataBase -> Stream : findFirst()
+Stream --> DataBase : optional Food
+
+deactivate Stream
+activate OptionalFood
+
+DataBase -> OptionalFood : orElseThrow()
+alt food is present
+OptionalFood --> DataBase : Food
+end
+alt food is not present
+OptionalFood --> DataBase : NoSuchElementException
+end
+destroy OptionalFood
+
+<-- DataBase : Food
+deactivate DataBase
+@enduml

docs/UML_diaghrams/save_load_feature/FoodPortionDateSaveLoadManager_load.puml

@@ -0,0 +1,34 @@
+@startuml
+
+-> FoodPortionDateSaveLoadManager : load()
+activate FoodPortionDateSaveLoadManager
+
+FoodPortionDateSaveLoadManager -> 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 --> FoodPortionDateSaveLoadManager : FileLoader
+deactivate Loader
+deactivate FoodPortionDateSaveLoadManager
+
+-> FoodPortionDateSaveLoadManager : getFoodList()
+activate FoodPortionDateSaveLoadManager
+
+loop all rows in loader
+FoodPortionDateSaveLoadManager -> FoodPortionDateSaveLoadManager : getFood()
+FoodPortionDateSaveLoadManager -> FoodPortionDateSaveLoadManager : getPortion()
+FoodPortionDateSaveLoadManager -> FoodPortionDateSaveLoadManager : getDateTime()
+end
+<-- FoodPortionDateSaveLoadManager : FoodList
+@enduml

docs/UML_diaghrams/save_load_feature/FoodPortionDateSaveLoadManager_save.puml

@@ -0,0 +1,42 @@
+@startuml
+
+-> FoodPortionDateSaveLoadManager : readySaver()
+activate FoodPortionDateSaveLoadManager
+FoodPortionDateSaveLoadManager -> Saver : resetSize()
+activate Saver
+Saver --> FoodPortionDateSaveLoadManager
+deactivate Saver
+<-- FoodPortionDateSaveLoadManager
+deactivate FoodPortionDateSaveLoadManager
+
+
+-> FoodPortionDateSaveLoadManager : saveFoodList()
+activate FoodPortionDateSaveLoadManager
+activate FoodList
+FoodPortionDateSaveLoadManager -> FoodList : getFoods()
+FoodList --> FoodPortionDateSaveLoadManager : List<Food>
+FoodPortionDateSaveLoadManager -> FoodList : getPortionSizes()
+FoodList --> FoodPortionDateSaveLoadManager : List<Integer>
+FoodPortionDateSaveLoadManager -> FoodList : getDateTimes()
+FoodList --> FoodPortionDateSaveLoadManager : List<LocalDateTime>
+deactivate FoodList
+loop all food portion date entries
+    activate Saver
+    FoodPortionDateSaveLoadManager -> Saver : add()
+end
+
+FoodPortionDateSaveLoadManager -> Saver : save()
+
+activate FileWriter
+loop all entries in Saver table
+    Saver -> FileWriter : write()
+    FileWriter --> Saver
+end
+Saver -> FileWriter : close()
+destroy FileWriter
+Saver --> FoodPortionDateSaveLoadManager
+deactivate Saver
+
+deactivate FoodPortionDateSaveLoadManager
+
+@enduml

docs/UML_diaghrams/save_load_feature/design.puml

@@ -0,0 +1,23 @@
+@startuml
+object Saver
+object Loader
+object FoodPortionDateSaveLoadManager
+object PersonSaveLoadManager
+object Command
+object File
+object FoodList
+
+File <-up-> Saver
+File <-up-> Loader
+
+Saver <-up-> FoodPortionDateSaveLoadManager
+Saver <-up-> PersonSaveLoadManager
+Loader <-up-> FoodPortionDateSaveLoadManager
+Loader <-up-> PersonSaveLoadManager
+
+FoodList -left--> FoodPortionDateSaveLoadManager
+FoodPortionDateSaveLoadManager -right-->  FoodList
+
+FoodPortionDateSaveLoadManager <-up-> Command
+PersonSaveLoadManager <-up-> Command
+@enduml