[SaiChaitanya13] ip

README.md

@@ -13,7 +13,7 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
    1. If there are any further prompts, accept the defaults.
 1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
    In the same dialog, set the **Project language level** field to the `SDK default` option.
-3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
+3. After that, locate the `src/buddy.main/java/Duke.java` file, right-click it, and choose `Run Duke.buddy.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
    ```
    Hello from
     ____        _        

docs/README.md

@@ -1,29 +1,104 @@
 # User Guide
 
+Buddy is a very helpful tool in helping you manage your daily tasks
+and helping you be more organised. It also helps you improve your day to day productivity!
+Get immersed in this cli-optimised application!
+
 ## Features 
 
-### Feature-ABC
+### Add tasks to your task list
+Add various types of tasks - todo, deadline and event.
 
-Description of the feature.
+### Delete tasks from your task list
+Delete tasks from the list.
 
-### Feature-XYZ
+### Keep track of the progress of your tasks
+Mark/Unmark tasks from the list to keep track of what you have completed.
 
-Description of the feature.
+### Find tasks in your task list
+Find tasks that match a keyword
 
 ## Usage
 
-### `Keyword` - Describe action
+### `todo` - Adds a Todo task
+
+Format: `todo <TASK_DESCRIPTION>`
+
+- Adds a todo with `<TASK_DESCRIPTION>`
+- `<TASK_DESCRIPTION>` should not be empty
+
+Examples of usage:
+- `todo cs2113 project`
+- `todo cs2102 assignment`
+
+### `deadline` - Adds a Deadline task
+Format: `deadline <TASK_DESCRIPTION> /by <deadlinedate>`
+
+- Adds a task with a `<TASK_DESCRIPTION>` to be completed by `<deadlinedate>`
+- Deadline date should be in `<YYYY-MM-DD>` format
+- Deadline date cannot be before today's date
+- Deadline date should not be empty
+
+Examples of usage:
+- `deadline cs2113 ip /by 2023-03-03`
+- `deadline cs1010 assignment /by 2024-04-04`
+
+### `event` - Adds a Event task
+Format: `event <TASK_DESCRIPTION> /from <Start> /to <End>`
+
+- Adds a task with a `<TASK_DESCRIPTION>` with a start `<Start>` to end `<End>`
+- `<TASK_DESCRIPTION>` should not be empty
+- `<Start>` and `<End>` should not be empty
+
+Examples of usage:
+- `event cs2113 exam /from 4pm /to 6pm`
+- `event NUS Open House /from 24 Dec 2023 6am /to 6pm`
+
+### `mark` - Marks a task as done
+Format: `mark <INDEX_OF_TASK>`
+
+- Marks a task as done
+- `<INDEX_OF_TASK>` should be within the task list
+
+Examples of usage:
+- `mark 2`
+- `mark 1`
+
+### `unmark` - Marks a task as not done
+Format: `unmark <INDEX_OF_TASK>`
+
+- Marks a task as not done
+- `<INDEX_OF_TASK>` should be within the task list
+
+Examples of usage:
+- `unmark 2`
+- `unmark 4`
+
+### `delete` - Deletes a task from the task list
+Format: `delete <INDEX_OF_TASK>`
+
+- Deletes a task
+- `<INDEX_OF_TASK>` should be within the task list
+
+Examples of usage:
+- `delete 2`
+- `delete 1`
+
+### `find` - Finds a task by keyword
+Format: `find <keyword>`
 
-Describe the action and its outcome.
+- Finds matching tasks
+- `<keyword>` should be one word
 
-Example of usage: 
+Examples of usage:
+- `find cs2113`
+- `find todo`
 
-`keyword (optional arguments)`
+### `bye` - Exits the program
+Format: `bye`
 
-Expected outcome:
+- Exits the program.
 
-Description of the outcome.
+### HOW DO I SAVE MY TASK LIST?
 
-```
-expected output
-```
+- The program auto saves your task list and loads it when you run the program!

src/main/java/META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: buddy.Buddy
+

src/main/java/buddy/Buddy.java

@@ -0,0 +1,52 @@
+package buddy;
+
+import java.util.Scanner;
+
+import buddy.parser.Parser;
+import buddy.storage.Storage;
+import buddy.tasks.TaskList;
+import buddy.ui.Ui;
+
+/**
+ * The part which executes the entire program
+ */
+public class Buddy {
+    private final Storage storage;
+    private static TaskList taskList;
+    private final Ui ui;
+    public static int taskCount = 0;
+
+    /**
+     * Constructor for Buddy class
+     *
+     * @param filePath The filepath of the file
+     */
+    public Buddy(String filePath) {
+        taskList = new TaskList();
+        storage = new Storage(filePath);
+        ui = new Ui();
+    }
+
+    /**
+     * This function runs the program till completion (till a "bye" is inputted)
+     */
+    public void run() {
+        ui.loadFileOrCreateFile(taskList, storage);
+        ui.greetUser();
+        String input;
+        Scanner in = new Scanner(System.in);
+        input = in.nextLine();
+        Parser processAllCommands = new Parser();
+
+        while (!processAllCommands.isExit(input)) {
+            processAllCommands.executeInput(taskList, input, storage);
+            input = in.nextLine();
+        }
+        ui.sayByeToUser();
+    }
+
+
+    public static void main(String[] args) {
+        new Buddy("./Data").run();
+    }
+}

src/main/java/buddy/commands/Command.java

@@ -0,0 +1,17 @@
+package buddy.commands;
+
+import buddy.exceptions.InvalidCommandException;
+import buddy.tasks.TaskList;
+
+/**
+ * Constructor for Command class
+ */
+public abstract class Command {
+    /**
+     * Executes the commands by the user for all the different types of commands - actionCommands and addTaskCommands
+     *
+     * @param taskList List of tasks
+     * @param input    Command inputted by the user
+     */
+    public abstract void executeCommand(TaskList taskList, String input) throws InvalidCommandException;
+}

src/main/java/buddy/commands/actionCommands/DeleteTaskCommand.java

@@ -0,0 +1,29 @@
+package buddy.commands.actionCommands;
+
+import buddy.commands.Command;
+import buddy.messages.Messages;
+import buddy.tasks.TaskList;
+
+
+public class DeleteTaskCommand extends Command {
+
+    /**
+     * Process DeleteTaskCommand by user and deletes task from task list
+     *
+     * @param taskList List of tasks
+     * @param input    Command inputted by user
+     */
+    @Override
+    public void executeCommand(TaskList taskList, String input) {
+        try {
+            String[] deleteSplit = input.split(" ", 2);
+            int taskNumberToBeDeleted = Integer.parseInt(deleteSplit[1]);
+            int indexOfTaskInTaskList = taskNumberToBeDeleted - 1;
+            taskList.deleteTask(indexOfTaskInTaskList);
+
+        } catch (IndexOutOfBoundsException e) {
+            System.out.println("That is not a valid task to delete! Please check your list again and input a valid task");
+            System.out.println(Messages.DIVIDER);
+        }
+    }
+}

src/main/java/buddy/commands/actionCommands/FindTaskCommand.java

@@ -0,0 +1,43 @@
+package buddy.commands.actionCommands;
+
+import buddy.exceptions.InvalidCommandException;
+import buddy.messages.Messages;
+import buddy.commands.Command;
+import buddy.tasks.TaskList;
+import buddy.tasks.Task;
+
+import java.util.ArrayList;
+
+import static java.util.stream.Collectors.toList;
+
+public class FindTaskCommand extends Command {
+
+    /**
+     * Process FindTaskCommand by user and finds and outputs the matching task to keyword
+     * If there are no matching tasks, tells user that there are none
+     *
+     * @param taskList List of tasks
+     * @param input    Command inputted by user
+     */
+    @Override
+    public void executeCommand(TaskList taskList, String input) throws InvalidCommandException {
+        if (input.equals("find")){
+            throw new InvalidCommandException();
+        }
+        String keyword = input.split(" ")[1].trim().toLowerCase();
+        ArrayList<Task> matchedTasks;
+        matchedTasks = (ArrayList<Task>) taskList.stream()                                              // casts list to ArrayList
+                .filter(t -> t.getTaskName().trim().toLowerCase().contains(keyword)).collect(toList());
+        System.out.println(Messages.DIVIDER);
+        if (!matchedTasks.isEmpty()) {
+            System.out.println("Well, here is the list of tasks matching your keyword!");
+        }
+        for (Task task : matchedTasks) {
+            System.out.println(task);
+        }
+        if (matchedTasks.isEmpty()) {
+            System.out.println("Oops, there are no tasks matching the keyword! Try again with another keyword");
+        }
+        System.out.println(Messages.DIVIDER);
+    }
+}

src/main/java/buddy/commands/actionCommands/HelpCommand.java

@@ -0,0 +1,21 @@
+package buddy.commands.actionCommands;
+
+import buddy.messages.Messages;
+import buddy.ui.Ui;
+import buddy.commands.Command;
+import buddy.tasks.TaskList;
+
+public class HelpCommand extends Command {
+    /**
+     * Process HelpCommand by user and prints help message
+     *
+     * @param taskList List of tasks
+     * @param input    Command inputted by user
+     */
+    @Override
+    public void executeCommand(TaskList taskList, String input) {
+        System.out.println(Messages.DIVIDER);
+        Ui.displayHelpMessage();
+        System.out.println(Messages.DIVIDER);
+    }
+}

src/main/java/buddy/commands/actionCommands/ListCommand.java

@@ -0,0 +1,32 @@
+package buddy.commands.actionCommands;
+
+import buddy.Buddy;
+import buddy.messages.Messages;
+import buddy.commands.Command;
+import buddy.tasks.TaskList;
+
+public class ListCommand extends Command {
+
+    /**
+     * Process ListCommand by user and prints out the list of tasks
+     *
+     * @param taskList List of tasks
+     * @param input    Command inputted by user
+     */
+    @Override
+    public void executeCommand(TaskList taskList, String input) {
+        System.out.println(Messages.DIVIDER);
+        if (!taskList.isEmpty()) {
+            System.out.println("Here is the list of tasks you have remaining! Come on Buddy!");
+        }
+        int index = 1;                                              // index which shows numbers the task
+        for (int i = 0; i < Buddy.taskCount; i++) {
+            System.out.println(index + "." + taskList.get(i));
+            index++;                                                // increment the number on the task
+        }
+        if (taskList.isEmpty()) {
+            System.out.println("There is nothing in the list! Please enter a new command");
+        }
+        System.out.println(Messages.DIVIDER);
+    }
+}