[CS2113-W13-2] FitTrack

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+FitTrackLogger.log
+FitTrackLogger.log.lck

FitTrackLogger.log

@@ -0,0 +1,6 @@
+Oct 31, 2024 11:16:20 AM fittrack.logger.FitTrackLogger setupLogger
+INFO: Logger successfully initialized
+Oct 31, 2024 11:16:20 AM fittrack.storage.Storage initialiseSaveFile
+INFO: Accessing existing save file...
+Oct 31, 2024 11:16:20 AM fittrack.storage.Storage loadSaveFile
+INFO: Save file successfully loaded.

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# fittrack
 
 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.
 
@@ -8,7 +8,7 @@ Prerequisites: JDK 17 (use the exact version), update Intellij to the most recen
 
 1. **Ensure Intellij JDK 17 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 17 in a previous Intellij project.
 1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the setup**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
+1. **Verify the setup**: After the importing is complete, locate the `src/main/java/fittrack/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
    ```
    > Task :compileJava
    > Task :processResources NO-SOURCE
@@ -39,7 +39,7 @@ Prerequisites: JDK 17 (use the exact version), update Intellij to the most recen
 
 ### JUnit tests
 
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
+* A skeleton JUnit test (`src/test/java/fittrack/duke/DukeTest.java`) is provided with this project template. 
 * If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
 
 ## Checkstyle

build.gradle

@@ -42,5 +42,6 @@ checkstyle {
 }
 
 run{
+    enableAssertions = true
     standardInput = System.in
-}
+}

docs/AboutUs.md

@@ -1,9 +1,8 @@
 # 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) | Zackermax See Zheng Feng | [Github](https://github.com/Zackermax) | [Portfolio](docs/team/zackermaxsee.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Ng Chee Kiang | [Github](https://github.com/CheeKiangg) | [Portfolio](docs/team/CheeKiang.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Marcus Wong | [Github](https://github.com/TheDinos) | [Portfolio](docs/team/marcuswong.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Avjay Bhar | [Github](https://github.com/Yvorm) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Ayushi Yadav | [Github](https://github.com/ayushi0803) | [Portfolio](docs/team/ayushi.md)

docs/Calculator.puml

@@ -0,0 +1,77 @@
+@startuml
+
+skinparam linetype ortho
+hide circle
+skinparam classAttributeIconSize 0
+skinparam classBackgroundColor White
+skinparam classBorderColor Black
+
+' Abstract class
+abstract class Calculator {
+    - static final int AGE_RANGE_LOWER_START : int
+    - static final int AGE_RANGE_LOWER_END : int
+    - static final int AGE_RANGE_UPPER_START : int
+    - static final int AGE_RANGE_UPPER_END : int
+    + static getPointsFromTable(Map<LookUpKey, TreeMap<Integer, Integer>>, Gender, int, int, boolean) : int
+    + static addAgeSubTable(Map<LookUpKey, TreeMap<Integer, Integer>>, Gender, int, int[][], boolean) : void
+    + static addAllTables(Map<LookUpKey, TreeMap<Integer, Integer>>, Gender, int[][][], boolean) : void
+}
+
+' Derived classes
+class PullUpCalculator {
+    - static final Map<LookUpKey, TreeMap<Integer, Integer>> pullUpTable
+    - static final boolean reverseOrder
+    + static calculatePoints(Gender, int, int) : int
+    + static initialiseMaleData() : void
+    + static initialiseFemaleData() : void
+}
+
+class ShuttleRunCalculator {
+    - static final Map<LookUpKey, TreeMap<Integer, Integer>> shuttleRunTable
+    - static final boolean reverseOrder
+    + static calculatePoints(Gender, int, int) : int
+    + static initialiseMaleData() : void
+    + static initialiseFemaleData() : void
+}
+
+class SitAndReachCalculator {
+    - static final Map<LookUpKey, TreeMap<Integer, Integer>> sitAndReachTable
+    - static final boolean reverseOrder
+    + static calculatePoints(Gender, int, int) : int
+    + static initialiseMaleData() : void
+    + static initialiseFemaleData() : void
+}
+
+class SitUpCalculator {
+    - static final Map<LookUpKey, TreeMap<Integer, Integer>> sitUpTable
+    - static final boolean reverseOrder
+    + static calculatePoints(Gender, int, int) : int
+    + static initialiseMaleData() : void
+    + static initialiseFemaleData() : void
+}
+
+class StandingBroadJumpCalculator {
+    - static final Map<LookUpKey, TreeMap<Integer, Integer>> broadJumpTable
+    - static final boolean reverseOrder
+    + static calculatePoints(Gender, int, int) : int
+    + static initialiseMaleData() : void
+    + static initialiseFemaleData() : void
+}
+
+class WalkAndRunCalculator {
+    - static final Map<LookUpKey, TreeMap<Integer, Integer>> walkAndRunTable
+    - static final boolean reverseOrder
+    + static calculatePoints(Gender, int, int) : int
+    + static initialiseMaleData() : void
+    + static initialiseFemaleData() : void
+}
+
+' Relationships
+Calculator <|--- PullUpCalculator
+Calculator <|-- ShuttleRunCalculator
+Calculator <|--- SitAndReachCalculator
+Calculator <|-- SitUpCalculator
+Calculator <|--- StandingBroadJumpCalculator
+Calculator <|-- WalkAndRunCalculator
+
+@enduml

docs/DeveloperGuide.md

@@ -4,9 +4,144 @@
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
+## Setting up, getting started
+First , **fork** this repo, and clone the fork into your computer.
+1. **Configure the JDK**: Follow the guide [se-edu/guides] IDEA: Configuring the JDK to ensure Intellij is configured 
+   to use **JDK 17**.
+2. **Import the project as a Gradle project**: Follow the guide [se-edu/guides] IDEA: Importing a Gradle project
+   to import the project into IDEA.
+3. Verify the setup:
+   (i) Run the FitTrack.Main and try a few commands like `help`.
+   (ii) Run the tests to ensure that all of it pass.
+
 ## Design & implementation
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+## Software Architecture
+![Architecture.png](Images/Archi_Architecture.png)
+
+**FitTrack** is the main class and entry point of the application. It manages high level functionalities by coordinating the following classes:
+
+| Class           | Functionality                                                                                                |
+|-----------------|--------------------------------------------------------------------------------------------------------------|
+| FitTrackLogger  | Manages logging for the application, ensuring errors and important events are properly recorded              |
+| Storage         | Manages saving and loading data from a persistent storage file                                               |
+| User            | Records the user’s information, such as age and gender, and provides methods to modify or retrieve this data |
+| Parser          | Handles parsing of user input, converting it into commands and actions                                       |
+| Ui              | Handles user interaction and CLI output, printing messages and data to the console                           |
+| TrainingSession | Represents a single training session, including exercises and metadata (e.g. date and description)           |
+| Exercise        | Represents different types of exercises available in the application, like pull-ups or shuttle runs          |
+
+## Features
+
+### Storage
+![Storage.png](Images/Class_Storage.png)
+
+### Set User
+When the application starts up, it will prompt the user for their gender and age via the Set User feature.
+Their input is processed by Parser and stored in an instance of the User class.
+Upon successful setting of the gender and age fields, a confirmation of the user's gender and age will be printed in the CLI via the Ui class.
+After this initialization process, if the user desires, they can set their gender and age again at any time by calling the "set" command.
+
+![SetUser.png](Images/Class_SetUser.png)
+
+### Add Training Session
+![AddTrainingSession.png](Images/Class_AddTrainingSession.png)
+
+#### 1. Class Interaction Overview
+When the user adds a new training session, an instance of the `TrainingSession` class is created. 
+This instance initializes an EnumMap, which instantiates the 6 `ExerciseStation` child classes with 
+their initial values.
+Below is a class diagram showing the EnumMap after an instance of `TrainingSession` is created.
+![Class_TrainingSessionInitialState.png](Images/Class_TrainingSessionInitialState.png)
+
+#### 2. Sequence of Event 
+![Sequence_addTrainingSessionCommand.png](Images%2FSequence_addTrainingSessionCommand.png)
+1) **User Inputs Add command**:The User initiates the "add <name of the training session>" command by 
+   calling Parser with the input.
+2) **Instantiation of TrainingSession**: The Parser creates a new TrainingSession object with the 
+   current time, description, and user.
+3) **Instantiation of Exercise Stations**: Within TrainingSession class, all 6 subclasses of exercise
+   stations are instantiated.
+4) **UI Interaction**: The Parser calls Ui.printAddedSession(sessionList), which:
+   (i) Begins a UI segment
+   (ii) Prints a session message
+   (iii) Prints the description of the last added session
+   (iv) Calls printSessionCount to show the total count
+   (v) Ends the segment.
+4) Refer to Section on Edit Exercise and Point Calculation for specific implementation of 
+   performance metric and point conversion.
+
+### Delete Training Session
+When Parser detects the "delete" command, the TrainingSession instance at the user's specified index in sessionList will be 
+copied into a new private TrainingSession instance called sessionToDelete. The original instance in sessionList will 
+then be deleted. The new private instance is used to print the details of the deleted session, giving the user 
+confirmation that the TrainingSession they wished to delete has been successfully deleted. The new TrainingSession
+instance is then disposed of.
+
+![DeleteTrainingSession.png](Images/Class_DeleteTrainingSession.png)
+
+### List Training Sessions
+When Parser detects the "list" command, it calls printSessionList() followed by printSessionCount().
+printSessionList() first checks if sessionList is empty. If sessionList is empty, it prints a message saying so.
+If sessionList is not empty, it will be iterated through. 
+For each TrainingSession in sessionList, getSessionDescription will be called, returning its details as a String.
+The TrainingSession's index will be printed, followed by the session description before iterating to the next index.
+
+![ListTrainingSessions.png](Images/Class_ListTrainingSessions.png)
+
+### View Training Session
+When Parser detects the "view" command, it calls printSessionView() on the user's specified session index.
+This in turn calls viewSession(), which outputs the details of the TrainingSession instance in the CLI.
+This process fetches the details of each of the 6 ExerciseStation classes, which fetch details from the Calculator classes.
+
+![ViewTrainingSession.png](Images/Class_ViewTrainingSession.png)
+
+### Edit Exercise
+
+The **Edit Exercise** feature is managed by the `TrainingSession` class, and is primarily carried out by its 
+`editExercise()` function. This feature utilizes the `setPerformance()`and `getReps()` methods from the 
+`ExerciseStation` classes to edit the repetitions and timings for the user’s selected 
+exercises. Additionally, it calculates the points the user will earn for each exercise based on the updated "rep" or
+"timing" values.
+
+#### Step 2: Editing a Training Session
+
+When the user wishes to edit a training session, they specify an `Exercise` Enum, and the reps/timing to be inputted.
+These variables are then passed to the`editExercise` function. This function calls the relevant methods to update the 
+repetitions or timings and calculates the corresponding points for the specified exercise.
+
+The following sequence diagram illustrates the function calls involved in this process:
+
+![Sequence_editExercise.png](Images/Sequence_editExercise.png)
+
+Additionally, the state diagram below shows the end state of the `editExercise` function after execution of the command,
+`editExercise(Exercise.PULL_UP, 1)` and `editExercise(Exercise.SHUTTLE_RUN, "16.0")`:
+
+![Class_TrainingSessionEditState.png](Images/Class_TrainingSessionEditState.png)
+
+### Points Calculation
+
+The **points calculation feature** is a significant part of the `ExerciseStation` system. It allows for the calculation
+of user-specific points based on their performance in various exercises (e.g., pull-ups, sit-ups). This process 
+involves interaction between the `ExerciseStation` and the `Calculator` classes, ensuring that the correct points are
+assigned based on predefined lookup tables.
+
+#### 1. Class Interaction Overview
+
+Each `ExerciseStation` subclass (e.g., `PullUpStation`, `SitUpStation`) has its own implementation of the `getPoints()` 
+method. The main responsibility of this method is to invoke the `calculatePoints()` function from the 
+respective **calculator** class (e.g., `PullUpCalculator`, `SitUpCalculator`), which holds the points calculation logic.
+
+#### 2.  Sequence of Events:
+![getPointsSequenceDiagram.png](getPointsSequenceDiagram.png)
+1. **User Inputs Performance**: The user’s performance (e.g., number of pull-ups) is passed to the
+   `setPerformance()` method in the exercise station.
+
+2. **Invoke Points Calculation**: Once the performance is set, the `getPoints()` method is called. 
+   This method interacts with the calculator class (e.g., `PullUpCalculator`) to compute the points.
+
+3. **Calculator Logic**: The calculator class uses a lookup table, which maps the user's performance 
+   to points based on their age and gender. The points are returned to the exercise station, where they are stored.
 
 
 ## Product scope
@@ -20,10 +155,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|
+Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *
+
+| Priority | As a ... | I want to ...                          | So that I can ...                                   |
+|----------|----------|----------------------------------------|-----------------------------------------------------|
+| ***      | new user | see usage instructions                 | refer to them when I forget how to use the app      |
+| ***      | user     | add a new training session             | record my NAPFA training progress                   |
+| ***      | user     | edit my new training session           | record the reps/time I attained for each exercise   |
+| ***      | user     | delete a training session              | remove a session that was added by mistake          |
+| ***      | user     | view a list of past training sessions  | track the number of training sessions I have done   |
+| ***      | user     | view the details of a training session | have an overview of my performance for that session |
+| ***      | user     | store my training sessions             | keep a record of my sessions when the app is closed |
+| **       | user     | calculate my NAPFA points per exercise | conveniently view my standing for each station      |
+| *        | user     | know my NAPFA achievement level        | know my NAPFA standard at a glance                  |
 
 ## Non-Functional Requirements
 

docs/Diagrams/Archi_Architecture.puml

@@ -0,0 +1,60 @@
+@startuml
+hide circle
+skinparam classAttributeIconSize 0
+skinparam classBackgroundColor White
+skinparam classBorderColor Black
+
+rectangle Exercise <<enumeration>> {
+}
+
+rectangle User {
+}
+
+rectangle FitTrackLogger {
+}
+
+rectangle Storage {
+}
+
+rectangle FitTrack {
+}
+
+rectangle Parser {
+}
+
+rectangle Ui {
+}
+
+rectangle TrainingSession {
+}
+
+rectangle ExerciseStation {
+}
+
+rectangle Calculator {
+}
+
+FitTrack  -->  Parser
+FitTrack  -->  Ui
+FitTrack  -->  Storage
+FitTrack  -->  User
+FitTrack  -->  FitTrackLogger
+
+Parser  -->  TrainingSession
+Parser  --> Exercise
+Parser  -->  User
+Parser  -->  Ui
+
+Ui  -->  User
+Ui  -->  TrainingSession
+
+Storage  -->  TrainingSession
+Storage  -->  FitTrackLogger
+
+TrainingSession  -->  User
+TrainingSession  --> Exercise
+TrainingSession  --> ExerciseStation
+
+ExerciseStation --> Calculator
+
+@enduml