[CS2113T-F14-2] Fitbot

.gitignore

@@ -15,3 +15,8 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+
+#User data file
+/data/
+/text-ui-test/data/
+

build.gradle

@@ -29,7 +29,7 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.duke.Main"
 }
 
 shadowJar {
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

config/checkstyle/checkstyle.xml

@@ -185,7 +185,7 @@
             <property name="caseIndent" value="0"/>
             <property name="throwsIndent" value="4"/>
             <property name="lineWrappingIndentation" value="4"/>
-            <property name="arrayInitIndent" value="4"/>
+            <property name="arrayInitIndent" value="8"/>
         </module>
         <module name="AbbreviationAsWordInName">
             <property name="ignoreFinal" value="false"/>

docs/AboutUs.md

@@ -2,8 +2,8 @@
 
 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) | Tay Weida | [Github](https://github.com/weidak) | [Portfolio](docs/team/tayweida.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Tan Xing Jie | [Github](https://github.com/xingjie99) | [Portfolio](docs/team/tanxingjie.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Tan Rui Yang | [Github](https://github.com/tryyang2001) | [Portfolio](docs/team/tanruiyang.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Toh Yi Zhi | [Github](https://github.com/tttyyzzz/tp) | [Portfolio](docs/team/noidea.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Tan Le Yi | [Github](https://github.com/tlyi) | [Portfolio](docs/team/johndoe.md)

docs/_config.yml

@@ -0,0 +1,14 @@
+title: "Fitbot"
+theme: minima
+
+header_pages:
+  - UserGuide.md
+  - DeveloperGuide.md
+  - AboutUs.md
+
+repository: "AY2122S1-CS2113T-F14-2/tp"
+
+plugins:
+  - jemoji
+
+

docs/diagrams/AddFoodItemSequenceDiagram.puml

@@ -0,0 +1,54 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+!include Style.puml
+hide footbox
+
+participant "command:AddFoodCommand" As AddFoodCommand LOGIC_COLOUR
+participant "foodBank:FoodBank" As FoodBank DATA_COLOUR
+
+activate AddFoodCommand LOGIC_COLOUR
+?->AddFoodCommand :execute()
+
+alt isCalorieFromFoodBank
+    AddFoodCommand -> FoodBank : findCalorie(description)
+    activate FoodBank DATA_COLOUR
+    FoodBank --> AddFoodCommand : calories
+    deactivate FoodBank
+    create "food" As Food1 DATA_COLOUR
+    AddFoodCommand -> Food1 ** : new Food(description,calories,dateTime)
+    activate Food1 DATA_COLOUR
+    Food1 -> Food1 ++ DATA_COLOUR: setTimePeriod (dateTime)
+    Food1 --> Food1 --
+    Food1 --> AddFoodCommand : food
+    deactivate Food1
+else
+create "food" As Food2 DATA_COLOUR
+    AddFoodCommand -> Food2 ** : new Food(description,calories,dateTime)
+    activate Food2 DATA_COLOUR
+    Food2 -> Food2 ++ DATA_COLOUR : setTimePeriod (dateTime)
+    Food2 --> Food2 --
+    Food2 --> AddFoodCommand : food
+    deactivate Food2
+end
+
+participant "filteredFoodList:FoodList" As FoodList DATA_COLOUR
+participant "commandResult:CommandResult" As CommandResult LOGIC_COLOUR
+AddFoodCommand -> FoodList : \t\t\t\t\t\t\t\t\t\t\t\t\t\t\taddItem(food)
+activate FoodList DATA_COLOUR
+FoodList -> FoodList ++  DATA_COLOUR: sortList()
+FoodList --> FoodList --
+FoodList --> AddFoodCommand
+deactivate FoodList
+AddFoodCommand -> CommandResult **: \t\t\t\t\t\t\t\t\tnew CommandResult(String.format(MESSAGE_SUCCESS,food))
+activate CommandResult LOGIC_COLOUR
+CommandResult --> AddFoodCommand
+deactivate CommandResult
+
+?<-- AddFoodCommand : commandResult\t
+deactivate AddFoodCommand
+destroy Food1
+destroy Food2
+destroy CommandResult
+destroy AddFoodCommand
+@enduml

docs/diagrams/AddFutureExerciseSequenceDaigram.puml

@@ -0,0 +1,44 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+!include Style.puml
+hide footbox
+
+participant "command:AddFutureExerciseCommand" As AddFutureExerciseCommand LOGIC_COLOUR
+participant "exerciseBank:ItemBank" As ItemBank DATA_COLOUR
+
+activate AddFutureExerciseCommand LOGIC_COLOUR
+?->AddFutureExerciseCommand :execute()
+
+opt isCalorieFromBank
+    AddFutureExerciseCommand -> ItemBank : getCaloriesOfItemWithMatchingName(description)
+    activate ItemBank DATA_COLOUR
+    ItemBank --> AddFutureExerciseCommand : \t\t\t\tcalories
+    deactivate ItemBank
+end
+create "Exercise" As Exercise DATA_COLOUR
+    AddFutureExerciseCommand -> Exercise ** : \t\t\t\tnew Exercise(description,calories,date)
+    activate Exercise DATA_COLOUR
+    Exercise --> AddFutureExerciseCommand : \t\t\t\t\t\t\texercise
+    deactivate Exercise
+
+
+participant "futureExerciseItems:FutureExerciseList" As FutureExerciseItems DATA_COLOUR
+participant "commandResult:CommandResult" As CommandResult LOGIC_COLOUR
+AddFutureExerciseCommand -> FutureExerciseItems : \t\t\t\t\t\t\t\t\t\taddItem(exercise)
+activate FutureExerciseItems DATA_COLOUR
+FutureExerciseItems -> FutureExerciseItems ++  DATA_COLOUR: sortList()
+FutureExerciseItems --> FutureExerciseItems --
+FutureExerciseItems --> AddFutureExerciseCommand
+deactivate FutureExerciseItems
+AddFutureExerciseCommand -> CommandResult **: \t\t\t\t\t\t\tnew CommandResult(String.format(MESSAGE_SUCCESS,exercise))
+activate CommandResult LOGIC_COLOUR
+CommandResult --> AddFutureExerciseCommand
+deactivate CommandResult
+
+?<-- AddFutureExerciseCommand : commandResult
+deactivate AddFutureExerciseCommand
+destroy Exercise
+destroy CommandResult
+destroy AddFutureExerciseCommand
+@enduml

docs/diagrams/AddRecurringExerciseSequenceDiagram.puml

@@ -0,0 +1,51 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+!include Style.puml
+hide footbox
+
+participant "command:AddRecurringExerciseCommand" As AddRecurringExerciseCommand LOGIC_COLOUR
+participant "exerciseBank:ItemBank" As ItemBank DATA_COLOUR
+
+activate AddRecurringExerciseCommand LOGIC_COLOUR
+?->AddRecurringExerciseCommand :execute()
+
+opt isCalorieFromBank
+    AddRecurringExerciseCommand -> ItemBank : getCaloriesOfItemWithMatchingName(description)
+    activate ItemBank DATA_COLOUR
+    ItemBank --> AddRecurringExerciseCommand : \t\t\t\tcalories
+    deactivate ItemBank
+
+end
+
+participant "futureExerciseItems:FutureExerciseList" As FutureExerciseItems DATA_COLOUR
+AddRecurringExerciseCommand -> FutureExerciseItems : \taddRecurringExercises(exercise, calories, startDate, endDate, dayOfTheWeek)
+activate FutureExerciseItems DATA_COLOUR
+loop matchesAllDayAndDate
+create "Exercise" As Exercise DATA_COLOUR
+    FutureExerciseItems -> Exercise ** : \tnew Exercise(description,calories,date)
+    activate Exercise DATA_COLOUR
+    Exercise --> FutureExerciseItems : \t\t\texercise
+    deactivate Exercise
+FutureExerciseItems -> FutureExerciseItems ++  DATA_COLOUR: addItem(exercise)
+FutureExerciseItems --> FutureExerciseItems --
+end
+FutureExerciseItems -> FutureExerciseItems ++  DATA_COLOUR: sortList()
+FutureExerciseItems --> FutureExerciseItems --
+FutureExerciseItems --> AddRecurringExerciseCommand
+deactivate FutureExerciseItems
+
+participant "commandResult:CommandResult" As CommandResult LOGIC_COLOUR
+AddRecurringExerciseCommand -> CommandResult **: \t\t\t\t\t\t\tnew CommandResult(MESSAGE_SUCCESS)
+activate CommandResult LOGIC_COLOUR
+CommandResult --> AddRecurringExerciseCommand
+deactivate CommandResult
+
+
+
+?<-- AddRecurringExerciseCommand : commandResult
+deactivate AddRecurringExerciseCommand
+destroy Exercise
+destroy CommandResult
+destroy AddRecurringExerciseCommand
+@enduml

docs/diagrams/Architecture.puml

@@ -0,0 +1,25 @@
+@startuml
+!include style.puml
+hide footbox
+
+participant ":Ui" as ui UI_COLOUR
+-> ui ++ UI_COLOUR : addFoodItem
+participant ":Main" as main MAIN_COLOUR
+ui -> main ++MAIN_COLOUR
+create ":Parser" as parser LOGIC_COLOUR
+main -> parser ++ LOGIC_COLOUR : parseAddFoodItem()
+participant ":Data" as itemlist DATA_COLOUR
+parser -> itemlist ++ DATA_COLOUR : addFoodItem()
+itemlist --> parser --  :
+parser --> main --
+main --> ui : add food item\n success
+destroy parser
+<--- ui -- : show add food item\n success message
+participant ":Storage" as storage STORAGE_COLOUR
+main -> storage ++ STORAGE_COLOUR: saveFoodList()
+storage -> storage ++ STORAGE_COLOUR: save to file
+storage --> storage --
+storage --> main --
+main --
+
+@enduml

docs/diagrams/ItemBankAndItemClassDiagram.puml

@@ -0,0 +1,57 @@
+@startuml
+'https://plantuml.com/class-diagram
+!include Style.puml
+hide circle
+<<<<<<< HEAD
+skinparam classAttributeIconSize 0
+=======
+hide methods
+>>>>>>> 83092670751ea3ce3345837c07acdf21a2d26a5a
+
+class ItemBank DATA_COLOUR
+class "{abstract}\nItemList" as ItemList DATA_COLOUR
+class FoodList DATA_COLOUR
+class ExerciseList DATA_COLOUR
+class FutureExerciseList DATA_COLOUR
+
+ItemBank <|-down- ItemList
+ItemList <|-down- FoodList
+ItemList <|-down- ExerciseList
+ExerciseList <|-down- FutureExerciseList
+
+class "{abstract}\nItem" as Item DATA_COLOUR{
+#name: String
+#calories: int
+}
+
+class Food DATA_COLOUR {
+#dateTime: LocalDateTime
+}
+
+class Exercise DATA_COLOUR {
+#date: LocalDate
+}
+
+enum "<<enumeration>>\nTimePeriod" as TimePeriod DATA_COLOUR {
+Morning,
+Afternoon,
+Evening,
+Night
+}
+
+Item <|-down- Food
+Item <|-down- Exercise
+Item "*" <-left- ItemBank: internalItems
+<<<<<<< HEAD
+TimePeriod "1" <-- Food : timePeriod\n\n\n
+=======
+TimePeriod "1" <-- Food : timePeriod\n\n
+>>>>>>> 83092670751ea3ce3345837c07acdf21a2d26a5a
+Item <.. ItemList
+Item <.. FoodList
+Item <.. ExerciseList
+Food <.. FoodList
+Exercise <.. ExerciseList
+Exercise <.. FutureExerciseList
+note "Class methods are not shown for simplicity" as N1 DATA_COLOUR
+@enduml

docs/diagrams/LogicClassDiagram.puml

@@ -0,0 +1,28 @@
+@startuml
+'https://plantuml.com/class-diagram
+!include Style.puml
+hide circle
+hide empty members
+skinparam minclassWidth 120
+skinparam Padding 5
+
+class ParserManager LOGIC_COLOUR
+class CommandResult LOGIC_COLOUR
+class XYZCommand LOGIC_COLOUR
+abstract class "{abstract}\nCommand" AS Command LOGIC_COLOUR
+
+ParserManager ..> XYZCommand : > creates
+XYZCommand --|> Command
+Command .right.> CommandResult : > produces
+
+class Data DATA_COLOUR
+class Main MAIN_COLOUR
+
+Main ..> ParserManager : > feeds user input
+ParserManager ..> Command : > returns
+Command --> Data : > modifies
+Main ..> Command : > executes
+Main ..> CommandResult : > retrieves
+
+
+@enduml

docs/diagrams/LogicSequenceDiagram.puml

@@ -0,0 +1,58 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+!include Style.puml
+hide footbox
+autoactivate on
+
+participant ":Main" AS Main MAIN_COLOUR
+participant ":ParserManager" AS ParserManager LOGIC_COLOUR
+participant ":AddCommandParser" AS AddCommandParser LOGIC_COLOUR
+participant "c:AddFoodCommand" AS AddFoodCommand LOGIC_COLOUR
+participant "r:CommandResult" AS CommandResult LOGIC_COLOUR
+participant "f:Food" AS Food DATA_COLOUR
+participant ":FoodList" AS FoodList DATA_COLOUR
+activate Main MAIN_COLOUR
+create ParserManager
+Main -> ParserManager LOGIC_COLOUR
+return
+Main -> ParserManager LOGIC_COLOUR : parseCommand ("add f/potato c/30")
+ref over ParserManager
+    determine type
+    of command
+end ref
+
+create AddCommandParser
+ParserManager -> AddCommandParser LOGIC_COLOUR
+return
+ParserManager -> AddCommandParser LOGIC_COLOUR : parse("f/...")
+
+ref over AddCommandParser
+    parse required
+    parameters
+    for the command
+end ref
+
+
+create AddFoodCommand
+AddCommandParser -> AddFoodCommand LOGIC_COLOUR : new AddFoodCommand("potato", ...)
+return c
+return c
+return c
+destroy AddCommandParser
+
+Main -> AddFoodCommand LOGIC_COLOUR : setData(profile, exerciseItems, ...)
+destroy ParserManager
+return
+Main -> AddFoodCommand LOGIC_COLOUR : execute()
+create Food
+AddFoodCommand -> Food DATA_COLOUR : new Food("potato", ...)
+return f
+AddFoodCommand -> FoodList DATA_COLOUR : add(f)
+return
+destroy Food
+create CommandResult
+AddFoodCommand -> CommandResult LOGIC_COLOUR
+return r
+return r
+destroy CommandResult
+@enduml