[CS2113-F11-1] FITNUS

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "interactive"
+}

build.gradle

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

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # 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) | Kevin Zhang | [Github](https://github.com/kevinz420) | [Portfolio](docs/team/johndoe.md)
+![](https://picsum.photos/100) |   Ethan Huang   |     [Github](https://github.com/remy9926)      | [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

@@ -6,8 +6,37 @@
 
 ## Design & implementation
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Handling User Inputs & Displaying Output
 
+A lot of the initial project setup that deals with things like parsing, displaying outputs back to the user, exceptions, etc. are strongly inspired by the address book example project demoed in class. Specifically, we have classes that are responsible for various aspects of our project in order to follow the single-responsibility principle and limit the amount of coupling. 
+
+One specific design implementation we chose was having a Command superclass that all commands in our application will inherit from. This allows every command we write in the future to be guaranteed to possess all methods specified in the superclass. Therefore we can call these methods in our main function without needing to worry about the differences between various commands because they all inherit from the same parent. Another alternative we considered was simply making each separate command its own function and calling them from our parser class. However, we want to keep the commands as high level as possible and avoid calling more lower-level functions if possible so we can provide more encapsulation to each command. Therefore, we decided to go with this class-based command hierarchy that was also found in the example address book repo.
+
+Below is a class diagram that describes how our various components interact with one another:
+
+![image](https://github.com/AY2324S1-CS2113-F11-1/tp/assets/54857388/21bd2aa9-8e50-49d2-b888-50446115f922)
+
+The parser class is responsible for reading the user input and creating specific command objects. All of these subcommands inherit from a general Command parent class which has an `execute` method that can be called regardless of child class and will return a CommandResult object. The CommandResult object dictates what info (string or list of items) needs to be returned to the user for viewing. Both CommandResult and TextUi (responsible for actually displaying data from CommandResult to user) will only print objects from classes that inherit from the Printable interface. This ensures that objects in the `relevantItems` list are all serializable as a human-readable string to be displayed to the end user.
+
+### Update Exercises from Log feature
+
+The proposed feature is to allow users to update exercises from the ExerciseLog class to allow for full CRUD functionality of the class. Currently, users are able to create exercises and log them as well as view all the exercises that they have created, but in the case of a typo, they are unable to update the log to accomodate for the user error. To improve the user experience, this update feature has been proposed to allow users to have a better experience using the app.
+
+The update feature will be implemented by allowing users to select the task that they want to edit by specifying the month and day that they logged this exercise at, as well as the corresponding exercise name and the number of calories that the exercise has burned. This is because each exercise is stored within Day objects, and in order to check if two exercises are equivalent, we check both the exerciseName and caloriesBurned fields. Thus, these parameters will need to be specified by the user in order to update the exercise log.
+
+Below is an example of how this feature will work:
+
+Step 1: Upon starting the app, the ExerciseLog class is initialized and a log is created for the user to log their exercises.
+
+<img width="661" alt="Screenshot 2023-10-22 at 22 21 04" src="https://github.com/Remy9926/tp/assets/95456114/933b3636-eba7-442b-bcf2-aec22ef49dba">
+
+Step 2: The user calls the log command with the specified parameters to add a new exercise to the list. However, the user notices that they made a typo and want to change the details of the exercise that they just logged.
+
+<img width="682" alt="Screenshot 2023-10-22 at 22 23 59" src="https://github.com/Remy9926/tp/assets/95456114/318cd321-6516-4163-a4ce-4a9e5d5edf7b">
+
+Step 3: The user calls the update command with the information of the old exercise as well as the new information that the user wants to update with. With this, the update is done.
+
+<img width="652" alt="Screenshot 2023-10-22 at 22 25 09" src="https://github.com/Remy9926/tp/assets/95456114/d07d5570-11fc-426c-877d-feb31a338f0a">
 
 ## Product scope
 ### Target user profile

docs/README.md

@@ -6,3 +6,5 @@ Useful links:
 * [User Guide](UserGuide.md)
 * [Developer Guide](DeveloperGuide.md)
 * [About Us](AboutUs.md)
+
+test

docs/UserGuide.md

@@ -29,6 +29,40 @@ Example of usage:
 
 `todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
 
+### Adding an exercise: `log`
+Adds a new exercise to the Exercise Log.
+
+Format: `log MONTH DAY EXERCISE_NAME CALORIES_BURNED`
+
+* The `MONTH` is an integer specifying the month in which the exercise was performed (1-12 inclusive)
+* The `DAY` is an integer specifying the day of the month in which the exercise was performed
+* The `EXERCISE_NAME` is a single word string specifying the type of exercise performed
+* The `CALORIES_BURNED` is an integer specifying the number of calories burned by the exercise
+
+Example of usage:
+
+`log 1 26 Basketball 179`
+
+`log 12 24 Volleyball 5`
+
+### Updating an exercise: `update`
+Updates the specified exercise within the Exercise Log.
+
+Format: `update MONTH DAY OLD_EXERCISE_NAME OLD_CALORIES_BURNED NEW_EXERCISE_NAME NEW_CALORIES_BURNED`
+
+* The `MONTH` is an integer specifying the month in which the exercise was performed (1-12 inclusive)
+* The `DAY` is an integer specifying the day of the month in which the exercise was performed
+* The `OLD_EXERCISE_NAME` is a single word string specifying the name of the exercise to be updated
+* The `OLD_CALORIES_BURNED` is an integer specifying the number of calories burned by the exercise to be updated
+* The `NEW_EXERCISE_NAME` is a single word string specifying the new exercise name
+* The `NEW_CALORIES_BURNED` is an integer specifying the new number of calories burned
+
+Example of usage:
+
+`update 1 26 Basketball 179 Rugby 55`
+
+`update 12 24 Volleyball 5 Hockey 98`
+
 ## FAQ
 
 **Q**: How do I transfer my data to another computer? 

src/main/java/seedu/duke/Duke.java

@@ -1,21 +1,115 @@
 package seedu.duke;
 
-import java.util.Scanner;
+import seedu.duke.commands.Command;
+import seedu.duke.commands.CommandResult;
+import seedu.duke.commands.ExitCommand;
+import seedu.duke.commands.meal.MealCommand;
+import seedu.duke.data.GoalList;
+import seedu.duke.data.meal.Meal;
+import seedu.duke.parser.Parser;
+import seedu.duke.exerciselog.Log;
+import seedu.duke.ui.TextUi;
+import java.util.ArrayList;
 
+/**
+ * Entry point of the Address Book application.
+ * Initializes the application and starts the interaction with the user.
+ */
 public class Duke {
+
+    /**
+     * Version info of the program.
+     */
+    public static final String VERSION = "AddressBook Level 2 - Version 1.0";
+    public static GoalList goals = new GoalList();
+    public static Log exerciseLog = new Log();
+    static ArrayList<Meal> meals = new ArrayList<Meal>();
+    private TextUi ui;
+
+    // private StorageFile storage;
+    public static void main(String... launchArgs) {
+        new Duke().run(launchArgs);
+    }
+
+    /**
+     * @param launchArgs
+     *                   Runs the program until termination.
+     */
+    public void run(String[] launchArgs) {
+        start(launchArgs);
+        runCommandLoopUntilExitCommand();
+        exit();
+    }
+
+    /**
+     * Sets up the required objects, loads up the data from the storage file, and
+     * prints the welcome message.
+     *
+     * @param launchArgs arguments supplied by the user at program launch
+     */
+    private void start(String[] launchArgs) {
+        try {
+            this.ui = new TextUi();
+            // this.storage = initializeStorage(launchArgs);
+            ui.showWelcomeMessage(VERSION, "storage.getPath()");
+            MealCommand.setMeals(meals);
+        } catch (Exception e) { // TODO: change to specific storage exceptions later
+            ui.showInitFailedMessage();
+            throw new RuntimeException(e);
+        }
+    }
+
+    /**
+     * Prints the Goodbye message and exits.
+     */
+    private void exit() {
+        ui.showGoodbyeMessage();
+        System.exit(0);
+    }
+
     /**
-     * Main entry-point for the java.duke.Duke application.
+     * Reads the user command and executes it, until the user issues the exit
+     * command.
      */
-    public static void main(String[] args) {
-        String logo = " ____        _        \n"
-                + "|  _ \\ _   _| | _____ \n"
-                + "| | | | | | | |/ / _ \\\n"
-                + "| |_| | |_| |   <  __/\n"
-                + "|____/ \\__,_|_|\\_\\___|\n";
-        System.out.println("Hello from\n" + logo);
-        System.out.println("What is your name?");
-
-        Scanner in = new Scanner(System.in);
-        System.out.println("Hello " + in.nextLine());
+    private void runCommandLoopUntilExitCommand() {
+        Command command;
+        do {
+            String userCommandText = ui.getUserCommand();
+            command = new Parser().parseCommand(userCommandText);
+            CommandResult result = executeCommand(command);
+            ui.showResultToUser(result);
+
+        } while (!ExitCommand.isExit(command));
+    }
+
+    /**
+     * Executes the command and returns the result.
+     *
+     * @param command user command
+     * @return result of the command
+     */
+    private CommandResult executeCommand(Command command) {
+        try {
+            CommandResult result = command.execute();
+            // storage.save(addressBook);
+            return result;
+        } catch (Exception e) {
+            ui.showToUser(e.getMessage());
+            throw new RuntimeException(e);
+        }
     }
+
+    // /**
+    // * Creates the StorageFile object based on the user specified path (if any) or
+    // the default storage path.
+    // * @param launchArgs arguments supplied by the user at program launch
+    // * @throws InvalidStorageFilePathException if the target file path is
+    // incorrect.
+    // */
+    // private StorageFile initializeStorage(String[] launchArgs) throws
+    // InvalidStorageFilePathException {
+    // boolean isStorageFileSpecifiedByUser = launchArgs.length > 0;
+    // return isStorageFileSpecifiedByUser ? new StorageFile(launchArgs[0]) : new
+    // StorageFile();
+    // }
 }

src/main/java/seedu/duke/commands/Command.java

@@ -0,0 +1,21 @@
+package seedu.duke.commands;
+
+/**
+ * Represents an executable command.
+ */
+public class Command {
+    String userCommand;
+
+    public Command() {
+    }
+
+    public Command(String cmd){
+        this.userCommand = cmd;
+    }
+
+    public CommandResult execute() throws Exception {
+        throw new UnsupportedOperationException("This method is to be implemented by child classes");
+    }
+
+
+}

src/main/java/seedu/duke/commands/CommandResult.java

@@ -0,0 +1,41 @@
+package seedu.duke.commands;
+
+import java.util.List;
+import java.util.Optional;
+
+import seedu.duke.data.Printable;
+
+/**
+ * Represents the result of a command execution.
+ */
+public class CommandResult {
+
+    /**
+     * The feedback message to be shown to the user. Contains a description of the execution result
+     */
+    public final String feedbackToUser;
+
+    /**
+     * The list of objects that was produced by the command
+     */
+    private final List<? extends Printable> relevantItems;
+
+    public CommandResult(String feedbackToUser) {
+        this.feedbackToUser = feedbackToUser;
+        relevantItems = null;
+    }
+
+    public CommandResult(String feedbackToUser, List<? extends Printable> relevantItems) {
+        this.feedbackToUser = feedbackToUser;
+        this.relevantItems = relevantItems;
+    }
+
+    /**
+     * Returns a list of objects relevant to the command result, if any.
+     * @return relevant items
+     */
+    public Optional<List<? extends Printable>> getRelevantItems() {
+        return Optional.ofNullable(relevantItems);
+    }
+
+}

src/main/java/seedu/duke/commands/ExitCommand.java

@@ -0,0 +1,22 @@
+package seedu.duke.commands;
+
+/**
+ * Terminates the program.
+ */
+public class ExitCommand extends Command {
+
+    public static final String COMMAND_WORD = "exit";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Exits the program.\n"
+            + "Example: " + COMMAND_WORD;
+    public static final String MESSAGE_EXIT_ACKNOWEDGEMENT = "Exiting FITNUS as requested ...";
+
+    @Override
+    public CommandResult execute() {
+        return new CommandResult(MESSAGE_EXIT_ACKNOWEDGEMENT);
+    }
+
+    public static boolean isExit(Command command) {
+        return command instanceof ExitCommand; // instanceof returns false if it is null
+    }
+}

src/main/java/seedu/duke/commands/GoalCommand.java

@@ -0,0 +1,31 @@
+package seedu.duke.commands;
+
+import seedu.duke.Duke;
+import seedu.duke.ui.TextUi;
+import seedu.duke.data.exception.IncorrectFormatException;
+
+
+public class GoalCommand extends Command {
+
+    public static final String COMMAND_WORD = "set";
+
+    public GoalCommand(String cmd){
+        super(cmd);
+    }
+
+    public CommandResult execute() {
+        try{
+            Duke.goals.addGoal(this.userCommand);
+            String addGoalResultMsg = TextUi.addGoalSuccessMessage(Duke.goals);
+            return new CommandResult(addGoalResultMsg);
+
+        }catch(IncorrectFormatException ife){
+            ife.handleException();
+        }catch(NumberFormatException nfe){
+            System.out.println("Please input a valid number for calories.");
+        }
+
+        return null;
+    }
+
+}

src/main/java/seedu/duke/commands/HelpCommand.java

@@ -0,0 +1,26 @@
+package seedu.duke.commands;
+
+
+/**
+ * Shows help instructions.
+ */
+public class HelpCommand extends Command {
+
+    public static final String COMMAND_WORD = "help";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Shows program usage instructions.\n"
+            + "Example: " + COMMAND_WORD;
+
+    @Override
+    public CommandResult execute() {
+        return new CommandResult(
+                HelpCommand.MESSAGE_USAGE
+        //                        + "\n" + DeleteCommand.MESSAGE_USAGE
+        //                        + "\n" + ClearCommand.MESSAGE_USAGE
+        //                        + "\n" + FindCommand.MESSAGE_USAGE
+        //                        + "\n" + ListCommand.MESSAGE_USAGE
+        //                        + "\n" + ViewCommand.MESSAGE_USAGE
+        //                        + "\n" + ViewAllCommand.MESSAGE_USAGE
+        );
+    }
+}