[CS2113-T17-1] AthletiCLI

.gitignore

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

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/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+_site/

docs/AboutUs.md

@@ -1,9 +1,13 @@
-# About us
+---
+layout: page
+title: About Us
+---
+
+| 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?s=100) |  Yang Ming-Tian   |  [Github](https://github.com/skylee03)   |    [Portfolio](docs/team/skylee03.md)     |
 
-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)

docs/DeveloperGuide.md

@@ -1,33 +1,211 @@
-# Developer Guide
+---
+layout: page
+title: Developer Guide
+---
+
+- Table of Contents
+{:toc}
 
 ## 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
+## Design
+
+This section provides a high-level explanation of the design and implementation of AthletiCLI, 
+supported by UML diagrams and short code snippets to illustrate the flow of data and interactions between the 
+components.
+
+
+### Architecture
+
+Given below is a quick overview of main components and how they interact with each other.
+
+**Main components of the architecture**
+
+**`AthletiCLI`** is in charge of the app launch and shut down.
+
+The bulk of the AthletiCLI’s work is done by the following components, with each of them corresponds to a package:
+
+* [`UI`](https://github.com/AY2324S1-CS2113-T17-1/tp/tree/master/src/main/java/athleticli/ui): The UI of AthletiCLI.
+* [`Storage`](https://github.com/AY2324S1-CS2113-T17-1/tp/tree/master/src/main/java/athleticli/storage): Reads data from, and writes data to, the hard disk.
+* [`Data`](https://github.com/AY2324S1-CS2113-T17-1/tp/tree/master/src/main/java/athleticli/data): Holds the data of AthletiCLI in memory.
+* [`Commands`](https://github.com/AY2324S1-CS2113-T17-1/tp/tree/master/src/main/java/athleticli/commands): The command executors.
+
+[`Exceptions`](https://github.com/AY2324S1-CS2113-T17-1/tp/tree/master/src/main/java/athleticli/exceptions) represents exceptions used by multiple other components.
+
+### UI Component
+
+### Storage Component
+
+### Data Component
+
+### Commands Component
+
+## Implementation
+
+### Diet Management in AthletiCLI
+
+#### [Implemented] Setting Up, Editing, Deleting, Listing, and Finding Diets
+
+Regardless of the operation you are performing on diets (setting up, editing, deleting, listing, or finding), the process follows a general five-step pattern in AthletiCLI:
+
+1. **Input Processing**: The user's input is passed through AthletiCLI to the Parser Class. Examples of user inputs include:
+    - `add-diet calories/500 protein/20 carb/50 fat/10 datetime/2021-09-01 06:00` for adding a diet.
+    - `edit-diet 1 calories/500 protein/20 carb/50 fat/10 datetime/2021-09-01 06:00` for editing a diet.
+    - `delete-diet 1` for deleting a diet.
+    - `list-diet` for listing all diets.
+    - `find-diet 2021-09-01` for finding diets of a particular date.
+
+2. **Command Identification**: The Parser Class identifies the type of diet operation and passes the necessary parameters.
+
+3. **Command Creation**: An instance of the corresponding command class is created (e.g., AddDietCommand, EditDietCommand, etc.) and returned to AthletiCLI.
+
+4. **Command Execution**: AthletiCLI executes the command, interacting with the data instance of DietList to perform the required operation.
+
+5. **Result Display**: A message is returned post-execution and passed through AthletiCLI to the UI for display to the user.
+
+By following these general steps, AthletiCLI ensures a streamlined process for managing diet-related tasks.
+
+### [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 be passed to UI(not shown) for display.
+
+#### [Implemented] Adding activities
+The `add-activity` feature allows users to add a new activity into the application.
+These are the main components behind the architecture of the `add-activity` feature:
+1. `AthletiCLI`: faciliates the mechanism. It captures the input and calls the parser and execution.
+2. `Parser`: parses the user input and generates the appropriate command object and activity 
+   instance.
+3. `AddActivityCommand`: encapsulates the execution of the `add-activity` command. It adds 
+   the activity to the data.
+4. `Activity`: represents the activity that is to be added.
+5. `Data`: holds current state of the activity list.
+6. `ActivityList`: maintains the list of all added activities.
+
+Given below is an example usage scenario and how the add mechanism behaves at each step.
+
+**Step 1 - Input Capture:** The user issues an `add-activity ...` which is captured and passed to the Parser by the 
+running AthletiCLI instance.
+
+**Step 2 - Activity Parsing:** The Parser parses the raw input to obtain the arguments of the activity. Given that all 
+parameters are provided correctly and no exception is thrown, a new activity object is created.
+
+**Step 3 - Command Parsing:** In addition the parser will create an `AddActivityCommand` object with the newly added 
+activity attached to it. The command implements the `AddActivityCommand#execute()` operation and is passed to 
+the AthletiCLI instance.
+
+**Step 4 - Activity Addition:** The AthletiCLI instance executes the `AddActivityCommand` object. The command will 
+access the data and retrieve the currently stored list of activities stored inside it. The new `Activity` object is 
+added to the list.
+
+**Step 5 - User Interaction:** Once the activity is successfully added, a confirmation message is displayed to the user.
+
+The following sequence diagram shows how the `add-activity` operation works:
+<p  align="center" width="100%">
+  <img width="80%" src="DeveloperGuide/AddActivity.png" alt="Sequence Diagram of add-activity`"/>
+</p>
+
+### [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. 
+
+### Sleep Management in AthletiCLI
+
+#### [Implemented] Adding, Editing, Deleting, Listing Sleep
+
+1. **Input Processing**: The user's input is passed through AthletiCLI to the Parser Class. Examples of user inputs include:
+    - "add-sleep hours/8 datetime/2021-09-01 06:00" for adding sleep.
+    - "edit-sleep 1 hours/8 datetime/2021-09-01 06:00" for editing sleep.
+    - "delete-sleep 1" for deleting sleep.
+    - "list-sleep" for listing all sleep.
+
+2. **Command Identification**: The Parser Class identifies the type of sleep operation and passes the necessary parameters.
+
+3. **Command Creation**: An instance of the corresponding command class is created (e.g., AddSleepCommand, EditSleepCommand, etc.) and returned to AthletiCLI.
+
+4. **Command Execution**: AthletiCLI executes the command, interacting with the data instance of SleepList to perform the required operation.
+
+5. **Result Display**: A message is returned post-execution and passed through AthletiCLI to the UI for display to the user.
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+AthletiCLI is designed for athletic individuals who are committed to optimizing their performance. 
+
+These users are highly disciplined and engaged not only in regular, intense physical training but also in nutrition, mental conditioning, and recovery. 
+
+They are looking for a holistic tool that integrates all facets of an athletic lifestyle. AthletiCLI serves as a daily or weekly companion, designed to monitor, track, and analyze various elements crucial for high-level athletic performance. 
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+AthletiCLI provides a streamlined, integrated solution for athletic individuals focused on achieving peak performance. 
+
+While the app includes robust capabilities for tracking physical training metrics, it also offers features for monitoring dietary habits and sleep metrics. 
+
+By providing a comprehensive view of various performance-related factors over time, AthletiCLI enables athletes to identify trends, refine their training and lifestyle habits, and optimize outcomes. The app is more than a tracking tool—it's a performance optimization platform that takes into account the full spectrum of an athlete's life. 
 
 ## 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    | health-conscious user           | add my dietary information | keep track of my daily calorie and nutrient intake                                     |
+| v1.0    | organized user                  | delete a dietary entry     | remove outdated or incorrect data from my diet records                                 |
+| v1.0    | fitness enthusiast              | view all my diet records   | have a clear overview of my dietary habits and make informed decisions on my diet      |
+| 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.                 |
+| v1.0    | sleep deprived user             | add my sleep information   | keep track of my sleep habits and identify areas for improvement                       |
+| v1.0    | sleep deprived user             | delete a sleep entry       | remove outdated or incorrect data from my sleep records                                |
+| v1.0    | sleep deprived user             | view all my sleep records  | have a clear overview of my sleep habits and make informed decisions on my sleep       |
+| v1.0    | sleep deprived user             | edit my sleep entries      | correct any mistakes or update my sleep information as needed                          |
+| v2.0    | user                            | find a to-do item by name  | locate a to-do without having to go through the entire list                            |
+| v2.0    | meticulous user                 | edit my dietary entries    | correct any mistakes or update my diet information as needed                           |
+| v2.0    | active user                     | set activity goals         | work towards a specific fitness target for different sports activities.                |
+| v2.0    | adaptable athlete               | edit my activity goals     | modify my fitness targets to align with my current fitness level and schedule.         |
+| v2.0    | organized athlete               | list all my activity goals | have a clear overview of my set targets and track my progress easily.                  |
+| v2.0    | meticulous user                 | find my diets by date      | easily retrieve my dietary records for a specific day and monitor my eating habits.    |
 
 ## Non-Functional Requirements
 
-{Give non-functional requirements}
+1. AthletiCLI should work on Windows, MacOS and Linux that has java 11 installed.
+2. AthletiCLI should be able to store data locally.
+3. AthletiCLI should be able to work offline.
+4. AthletiCLI should be easy to use.
 
 ## Glossary
 

docs/DeveloperGuide/AddActivity.puml

@@ -0,0 +1,38 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+skinparam Style strictuml
+skinparam SequenceMessageAlignment center
+
+!define LOGIC_COLOR #3333C4
+!define LOGIC_COLOR_T1 #7777DB
+!define LOGIC_COLOR_T2 #5252CE
+!define LOGIC_COLOR_T3 #1616B0
+!define LOGIC_COLOR_T4 #101086
+
+participant ":AthletiCLI" as AthletiCLI LOGIC_COLOR
+participant ":Parser" as Parser #lightblue
+participant "a:Activity" as Activity #yellow
+participant "c:AddActivityCommand" as AddActivityCommand #lightgreen
+participant "data:Data" as Data #lightgrey
+participant "activities:ActivityList" as activities #lightgrey
+
+AthletiCLI++
+AthletiCLI -> Parser++: parseCommand(userInput)
+Parser -> Parser++: parseActivity(arguments)
+Parser -> Activity++: Activity()
+Activity --> Parser--: a
+Parser--
+Parser -> AddActivityCommand++: parseAddActivityCommand(arguments)
+AddActivityCommand --> Parser--: c
+Parser --> AthletiCLI--: c
+
+AthletiCLI -> AddActivityCommand++: execute(a, data)
+AddActivityCommand -> Data++: getActivities()
+Data --> activities++
+activities --> Data--: activities
+
+Data --> AddActivityCommand--: activities
+AddActivityCommand -> activities++: add(a)
+activities --> AddActivityCommand--
+AddActivityCommand -> AthletiCLI--: message
+@enduml

docs/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'jekyll'
+gem 'github-pages', group: :jekyll_plugins
+gem 'wdm', '~> 0.1.0' if Gem.win_platform?
+gem 'webrick'