[CS2113-W13-2] FitTrack

.gitignore

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

FitTrackLogger.log

@@ -0,0 +1,6 @@
+Oct 29, 2024 12:37:24 PM fittrack.logger.FitTrackLogger setupLogger
+INFO: Logger successfully initialized
+Oct 29, 2024 12:37:24 PM fittrack.storage.Storage initialiseSaveFile
+INFO: Accessing existing save file...
+Oct 29, 2024 12:37:24 PM 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

@@ -6,8 +6,77 @@
 
 ## Design & implementation
 
+# High Level Functionalities
+![HighLevel.png](HighLevel.png)
+
+**FitTrack** is the main class and entry point of the application.  
+It manages high level functionalities by coordinating the `FitTrackLogger`, `Storage`, `User`, `Parser`, `Ui`, `TrainingSession`, and `Exercise` classes.
+
+- **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** holds 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** manages all output and user interaction, such as printing data and messages to the console.
+- **TrainingSession** represents a single training session, including exercises and metadata (like date and description).
+- **Exercise** represents different types of exercises available in the application, like pull-ups or shuttle runs.
+
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+### Edit Exercise Feature
+
+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 values.
+
+#### Step 1: Logging a New Training Session
+
+When the user logs a new training session, an instance of the `TrainingSession` class is created. This instance 
+initializes an EnumMap, which populates the various `ExerciseStation` instances with their initial values. 
+Below is a representation of how the `ExerciseStations` are initialized:
+
+![TrainingSessionInitialState.png](TrainingSessionInitialState.png)  
+
+#### 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,
+which is 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:
+
+![editExerciseSequenceDiagram.png](editExerciseSequenceDiagram.png)
+
+Additionally, the state diagram below shows the end state of the `editExercise` function after execution of the command,
+`editExercise(Exercise.PULL_UP, 1)`:
+
+![TrainingSessionEditState.png](TrainingSessionEditState.png)
+
+### Points Calculation Feature
+
+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.
+
+![getPointsSequenceDiagram.png](getPointsSequenceDiagram.png)
+##### Sequence of Events:
+
+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
 ### Target user profile

docs/HighLevel.puml

@@ -0,0 +1,88 @@
+@startuml
+' Use right-angle straight lines for relationships
+skinparam linetype ortho
+hide circle
+skinparam classAttributeIconSize 0
+skinparam classBackgroundColor White
+skinparam classBorderColor Black
+
+' Define classes
+class FitTrack {
+    +main()
+}
+
+class Parser {
+    +parse()
+    +getExercise()
+}
+
+class Ui {
+    +printGreeting()
+    +printUser()
+    +printHelp()
+    +printAddedSession()
+    +printDeletedSession()
+    +printSessionList()
+    +printSessionView()
+    +printUnrecognizedInputMessage()
+}
+
+class Storage {
+    +initialiseSaveFile()
+    +loadSaveFile()
+    +updateSaveFile()
+}
+
+class TrainingSession {
+    -LocalDateTime sessionDateTime
+    -String description
+    -User user
+    +editExercise()
+    +printSessionDescription()
+    +viewSession()
+}
+
+class User {
+    -String gender
+    -int age
+    +setGender()
+    +setAge()
+    +getGender()
+    +getAge()
+}
+
+enum Exercise <<enumeration>> {
+    PULL_UP
+    SHUTTLE_RUN
+    SIT_AND_REACH
+    SIT_UP
+    STANDING_BROAD_JUMP
+    WALK_AND_RUN
+}
+
+class FitTrackLogger {
+    +setupLogger()
+}
+
+' Define relationships with right-angle arrows
+FitTrack "1" --> "1" Parser : uses
+FitTrack "1" --> "1" Ui : uses
+FitTrack "1" --> "1" Storage : uses
+FitTrack "1" --> "1" User : manipulates
+FitTrack "1" --> "1" FitTrackLogger : uses
+
+Parser "1" --> "*" TrainingSession : manipulates
+Parser "1" --> Exercise : gets
+Parser "1" --> "1" User : manipulates
+Parser "1" --> "1" Ui : uses
+
+Ui "1" -> "1" User : displays
+Ui "1" --> "*" TrainingSession : displays
+
+Storage "1" --> "*" TrainingSession : manages
+Storage "1" --> "1" FitTrackLogger : uses
+
+TrainingSession "*" ---> "1" User : belongs to
+TrainingSession "*" --> Exercise : contains
+
+@enduml

docs/LowLevel.puml

@@ -0,0 +1,87 @@
+@startuml
+
+' Abstract class
+abstract class ExerciseStation {
+    + setPerformance(int performanceResult)
+    + getPoints(User user)
+    + getName() : String
+    + toString() : String
+    - points : int
+}
+
+' Classes that extend ExerciseStation
+class PullUpStation {
+    - name : String = "Pull Up Station"
+    - reps : int
+    + PullUpStation()
+    + getReps() : int
+    + setPerformance(int performanceResult)
+    + getPoints(User user) : int
+    + getName() : String
+    + toString() : String
+}
+
+class ShuttleRunStation {
+    - name : String = "Shuttle Run Station"
+    - time : int
+    + ShuttleRunStation()
+    + getTime() : String
+    + setPerformance(int performanceResult)
+    + getPoints(User user) : int
+    + getName() : String
+    + toString() : String
+}
+
+class SitAndReachStation {
+    - name : String = "Sit and Reach Station"
+    - length : int
+    + SitAndReachStation()
+    + getLength() : int
+    + setPerformance(int performanceResult)
+    + getPoints(User user) : int
+    + getName() : String
+    + toString() : String
+}
+
+class SitUpStation {
+    - name : String = "Sit Up Station"
+    - reps : int
+    + SitUpStation()
+    + getReps() : int
+    + setPerformance(int performanceResult)
+    + getPoints(User user) : int
+    + getName() : String
+    + toString() : String
+}
+
+class StandingBroadJumpStation {
+    - name : String = "Standing Broad Jump Station"
+    - distance : int
+    + StandingBroadJumpStation()
+    + getDistance() : int
+    + setPerformance(int performanceResult)
+    + getPoints(User user) : int
+    + getName() : String
+    + toString() : String
+}
+
+class WalkAndRunStation {
+    - name : String = "Walk and Run Station"
+    - time : int
+    + WalkAndRunStation()
+    + getTime() : String
+    + setPerformance(int performanceResult)
+    + getPoints(User user) : int
+    + getName() : String
+    + toString() : String
+}
+
+' Relationship between ExerciseStation and its subclasses
+ExerciseStation <|-- PullUpStation
+ExerciseStation <|-- ShuttleRunStation
+ExerciseStation <|-- SitAndReachStation
+ExerciseStation <|-- SitUpStation
+ExerciseStation <|-- StandingBroadJumpStation
+ExerciseStation <|-- WalkAndRunStation
+
+@enduml