[CS2113-T17-1] AthletiCLI

.gitignore

@@ -15,3 +15,4 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+/data/

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "githubPullRequests.ignoredPullRequestBranches": [
+        "master"
+    ]
+}

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# AthletiCLI project template
 
 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("athleticli.AthletiCLI")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("athleticli")
     archiveClassifier.set("")
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,10 @@
 # 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)       | Alexander Wolters |   [Github](https://github.com/AlWo223)   |     [Portfolio](docs/team/johndoe.md)     |
+| ![](https://via.placeholder.com/100.png?text=Photo)       |       Nihal       |   [Github](https://github.com/nihalzp)   |     [Portfolio](docs/team/nihalzp.md)     |
+| ![](https://github.com/DaDevChia)                         |    Dylan Chia     |  [Github](https://github.com/DaDevChia)  | [Portfolio](https://github.com/DaDevChia) |
+| ![](https://via.placeholder.com/100.png?text=Photo)       |     Yi Cheng      | [Github](https://github.com/yicheng-toh) |     [Portfolio](docs/team/yicheng.md)     |
+| ![](https://avatars.githubusercontent.com/u/24489025?v=4) |  Yang Ming-Tian   |  [Github](https://github.com/skylee03)   |    [Portfolio](docs/team/skylee03.md)     |
+

docs/DeveloperGuide.md

@@ -1,13 +1,60 @@
 # Developer Guide
 
+## Content Page
+- [Acknowledgements](#acknowledgements)
+- [Design](#design-and-implementation)
+- [Product Scope](#product-scope)
+- [Target User Profile](#target-user-profile)
+- [Value Proposition](#value-proposition)
+- [User Stories](#user-stories)
+- [Non-functional Requirements](#non-functional-requirements)
+- [Glossary](#glossary)
+- [Instruction for Manual Testing](#instructions-for-manual-testing)
+
 ## Acknowledgements
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
 ## Design & implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+#### [Implemented] Setting Up of Diet Goals
+
+This following sequence diagram show how the 'set-diet-goal' command works:
+
+<p  align="center" width="100%">
+  <img width="80%" src="images/setDietGoalUmlSequenceDiagram.svg" alt="'set-diet-goal' Sequence Diagram"/>
+</p>
+
+Step 1. The input from the user ("set-diet-goal fats/1") runs through AthletiCLI to the Parser Class.
+
+Step 2. The Parser Class will identify the request as setting up a diet goal and pass in the parameters
+"fats/1".
+
+Step 3. A temporary dietGoalList is created to store newly created diet goals.
+
+Step 4. The inputs are verified against our lists of approved diet goals.
+
+Step 5. For each of the diet goals that are valid, a dietGoal object will be created and stored in the 
+temporary dietGoalList.
+
+Step 6. The Parser then creates for an instance of SetDietGoalCommand and returns the instance to 
+AthletiCLI.
+
+Step 7. AthletiCLI will execute the SetDietGoalCommand. This adds the dietGoals that are present in the 
+temporary list into the data instance of DietGoalList which will be kept for records.
+
+Step 8. After executing the SetDietGoalCommand, SetDietGoalCommand returns a message that is passed to 
+AthletiCLI to passed to UI(not shown) for display.
+
+#### [Proposed] Implementation of DietGoalList
 
+The current implementation of DietGoalList is an ArrayList.
+It helps to store dietGoals, however it is not efficient in searching for a particular dietGoal.
+At any instance of time, there could only be the existence of one dietGoal.
+Verifying if there is an existence of a dietGoal using an ArrayList takes O(n) time, where n is the number of dietGoals.
+The proposed change will be to change the underlying data structure to a hashmap for amortised O(1) time complexity
+for checking the presence of a dietGoal. 
 
 ## Product scope
 ### Target user profile
@@ -20,14 +67,19 @@
 
 ## 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 usage instructions    | refer to them when I forget how to use the application                                 |
+| v1.0    | motivated weight-conscious user | set diet goals            | have the motivation to work towards keeping weight in check.                           |
+| v1.0    | forgetful user                  | see all my diet goals     | remind myself of all the diet goals I have set.                                        |
+| v1.0    | regretful user                  | remove my diet goals      | I can rescind the strict goals I set previously when I find the goals too far fetched. |
+| v1.0    | motivated user                  | update my diet goals      | I can work towards better version of myself by setting stricter goals.                 |
+| v2.0    | user                            | find a to-do item by name | locate a to-do without having to go through the entire list                            |
 
 ## Non-Functional Requirements
 
 {Give non-functional requirements}
+1. AthletiCLI should work on Windows, MacOS and Linux that has java 11 installed.
 
 ## Glossary
 

docs/DietGoals.puml

@@ -0,0 +1,39 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+skinparam Style strictuml
+skinparam SequenceMessageAlignment center
+participant ":AthletiCLI" as AthletiCLI #lightblue
+participant ":Parser" as Parser
+participant ":dietGoal" as dietGoal
+participant ":SetDietGoalCommand" as SetDietGoalCommand
+participant "temp:dietGoalList" as tempDietGoalList
+participant "data:dietGoalList" as dataDietGoalList
+
+'autonumber
+AthletiCLI++
+AthletiCLI -> Parser++ : ParseCommand("set-diet-goal fats/1")
+Parser -> Parser++ : ParseDietGoalSetEdit("fats/1")
+create tempDietGoalList
+Parser -> tempDietGoalList++ : dietGoalList()
+tempDietGoalList --> Parser-- : dietGoalList
+
+    loop number of valid new diet goals
+    create dietGoal
+    Parser -> dietGoal++ : dietGoal()
+    dietGoal --> Parser-- : dietGoal
+    end
+
+Parser --> Parser-- : dietGoalList
+create SetDietGoalCommand
+Parser -> SetDietGoalCommand++ : SetDietGoalCommand()
+SetDietGoalCommand --> Parser-- : SetDietGoalCommand
+Parser --> AthletiCLI-- : SetDietGoalCommand
+AthletiCLI -> SetDietGoalCommand++ : execute()
+SetDietGoalCommand -> dataDietGoalList++ : add()
+dataDietGoalList --> SetDietGoalCommand--
+destroy tempDietGoalList
+SetDietGoalCommand --> AthletiCLI-- : messages
+
+destroy SetDietGoalCommand
+
+@enduml