[waiter-palypoo] ip

docs/README.md

@@ -1,29 +1,180 @@
 # User Guide
 
+Welcome to the HinaBot User Guide! HinaBot is a personal assistant program that helps you 
+maintain a to-do list.
+
 ## Features 
 
-### Feature-ABC
+### Support for multiple task types
+
+HinaBot supports 3 different types of items on a to-do list: regular tasks, deadlines (tasks which have a due-date),
+and events (which have a start and end date).
+
+### Search function
 
-Description of the feature.
+HinaBot allows you to search your to-do list for tasks that contain a particular substring, making it easier to keep
+track of large numbers of tasks.
 
-### Feature-XYZ
+### Delete and mark functions
 
-Description of the feature.
+HinaBot allows you to mark tasks as done or not done and also supports deletion of a task.
+
+### Save and load function
+All changes you make to your to-do list are stored locally, meaning you can pick up right where you left off.
 
 ## Usage
 
-### `Keyword` - Describe action
+### `todo` - Add a regular task to the to-do list
 
-Describe the action and its outcome.
+Adds a regular task (no due date) to the to-do list. By default, the task is set as not done.
 
 Example of usage: 
 
-`keyword (optional arguments)`
+`todo buy milk`
+
+Expected outcome:
+
+The task is added to your to-do list and HinaBot announces how many tasks are currently on your list
+
+```
+Noted! This task has been added:
+[T][ ] buy milk
+There are 1 items on your list.
+```
+### `deadline` - Add a deadline to the to-do list
+
+Adds a deadline (with a do-by date in dd-MMM-yyyy HH:mm format) to the to-do list. By default, the task is set as not done.
+
+Example of usage:
+
+`deadline Assignment 1 /by 04-Apr-2023 23:59`
 
 Expected outcome:
 
-Description of the outcome.
+The deadline is added to your to-do list and HinaBot announces how many tasks are currently on your list
+
+```
+Noted! This task has been added:
+[D][ ] Assignment 1  (by: 04-Apr-2023 23:59)
+There are 2 items on your list
+```
+### `event` - Add an event to the to-do list
+
+Adds an event (with start and end times in dd-MMM-yyyy HH:mm format) to the to-do list. By default, the task is set as not done.
+
+Example of usage:
+
+`event Midterms /from 03-Mar-2023 13:00 /to 03-Mar-2023 17:30`
+
+Expected outcome:
+
+The deadline is added to your to-do list and HinaBot announces how many tasks are currently on your list
+
+```
+Noted! This task has been added:
+[E][ ] Midterms (from: 03-Mar-2023 13:00 to: 03-Mar-2023 17:30)
+There are 2 items on your list
+```
+### `list` - Lists all tasks in the to-do list
+
+Prints a list of all tasks in the to-do list including the task type and done status.
+
+Example of usage:
+
+`list`
+
+Expected outcome:
+
+The deadline is added to your to-do list and HinaBot announces how many tasks are currently on your list
+
+```
+1. [T][ ] buy milk
+2. [D][ ] Assignment 1  (by: 04-Apr-2023 23:59)
+3. [E][ ] Midterms (from: 03-Mar-2023 13:00 to: 03-Mar-2023 17:30)
+```
+### `mark` - Marks a task as done
+
+Marks an item by its index on the to-do list as done. This is indicated by an 'X' in the checkbox next to 
+its description.
+
+Example of usage:
+
+`mark 1`
+
+Expected outcome:
 
+An acknowledgement message and an 'X' is printed in the checkbox next to item 1 on the to-do list.
 ```
-expected output
+Roger that! This task is marked as done: 
+[T][X] buy milk
 ```
+
+### `unmark` - Marks a task as not done
+
+Marks an item by its index on the to-do list as not done. This is indicated by a blank checkbox next to
+its description.
+
+Example of usage:
+
+`unmark 1`
+
+Expected outcome:
+
+An acknowledgement message and a blank checkbox is printed next to item 1 on the to-do list.
+```
+Roger that! This task is marked as not done: 
+[T][ ] buy milk
+```
+
+### `delete` - Remove a task from the to-do list
+
+Removes the item at the specified index from the to-do list.
+
+Example of usage:
+
+`delete 3`
+
+Expected outcome:
+
+An acknowledgement message and the description of the task being removed is shown, followed by an announcement
+of the size of the remaining list.
+```
+Got it! This task will be removed:
+[E][ ] Midterms (from: 03-Mar-2023 13:00 to: 03-Mar-2023 17:30)
+There are 2 items on your list.
+```
+
+### `find` - Search for a task
+
+Searches the to-do list for all tasks with a description containing the substring provided by the user.
+
+Example of usage:
+
+`find buy`
+
+Expected outcome:
+
+Any matching tasks, along with their index on the list, are printed.
+
+```
+Found a match! Here are the results master!
+1. [T][ ] buy milk
+```
+
+### `bye` - Exits the program
+
+Terminates the program and prints a goodbye message.
+
+Example of usage:
+
+`bye`
+
+Expected outcome:
+
+The program exits with code 0 and a goodbye message is shown.
+
+```
+Goodbye master, let's meet again soon...
+
+Process finished with exit code 0
+```

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

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: hina.HinaBot
+

src/main/java/hina/HinaBot.java

@@ -0,0 +1,47 @@
+package hina;
+
+import hina.exceptions.HinaException;
+import hina.helper.Parser;
+import hina.helper.Storage;
+import hina.helper.TaskList;
+import hina.helper.Ui;
+
+import java.io.FileNotFoundException;
+
+public class HinaBot {
+    private static Ui ui;
+    private static Storage storage;
+    private static TaskList tasks;
+
+    /**
+     * Class constructor specifying the path to a file containing save data. Tries to
+     * access the save file and attempts to create a new one if it does not exist.
+     *
+     * @param savePath path to the save file.
+     * @param dataDir directory the save file is stored in.
+     */
+    public HinaBot(String savePath, String dataDir) {
+        ui = new Ui();
+        storage = new Storage();
+        Ui.showGreeting();
+        try {
+            tasks = new TaskList(Storage.readSaveFile(savePath));
+        } catch (FileNotFoundException exception) {
+            Storage.createSaveFile(savePath, dataDir);
+        }
+    }
+
+    public static void main(String[] args) {
+        new HinaBot("data/savedlist.txt", "data");
+
+        while (true) {
+            try {
+                Parser.readCommand();
+            } catch (HinaException cmdException) {
+                Ui.invalidCommandMessage();
+            } catch (StringIndexOutOfBoundsException argException) {
+                Ui.notEnoughDetails();
+            }
+        }
+    }
+}

src/main/java/hina/exceptions/HinaException.java

@@ -0,0 +1,4 @@
+package hina.exceptions;
+
+public class HinaException extends Throwable {
+}

src/main/java/hina/helper/Parser.java

@@ -0,0 +1,87 @@
+package hina.helper;
+
+import hina.exceptions.HinaException;
+
+import java.io.IOException;
+import java.util.Scanner;
+
+/**
+ * Contains methods to process user input.
+ */
+public class Parser {
+    /**
+     * Reads a user input from the command line and determines if it was a command.
+     * If the input was a recognised command, handle it respectively, else throws
+     * a <code>HinaException</code>.
+     *
+     * @throws HinaException If the input is not recognised as a valid command.
+     */
+    public static void readCommand() throws HinaException {
+        String line;
+        Scanner in = new Scanner(System.in);
+        line = in.nextLine().trim();
+        if (line.equalsIgnoreCase("bye")) {
+            Ui.showExitMessage();
+            System.exit(0);
+        } else if (line.equalsIgnoreCase("list")) {
+            TaskList.listTasks();
+        } else if (line.split(" ")[0].equalsIgnoreCase("mark")) {
+            try {
+                int taskIndex = Integer.parseInt(line.split(" ")[1]);
+                TaskList.markTask(taskIndex);
+            } catch (NumberFormatException | ArrayIndexOutOfBoundsException e) {
+                Ui.invalidNumberMessage();
+            }
+            try {
+                Storage.writeToFile();
+            } catch (IOException ioexception) {
+                Ui.couldNotSaveMessage();
+            }
+        } else if (line.split(" ")[0].equalsIgnoreCase("unmark")) {
+            int taskIndex = Integer.parseInt(line.split(" ")[1]);
+            TaskList.unmarkTask(taskIndex);
+            try {
+                Storage.writeToFile();
+            } catch (IOException ioexception) {
+                Ui.couldNotSaveMessage();
+            }
+        } else if (line.split(" ")[0].equalsIgnoreCase("todo")) {
+            TaskList.addTask(line.substring(5));
+            try {
+                Storage.writeToFile();
+            } catch (IOException ioexception) {
+                Ui.couldNotSaveMessage();
+            }
+        } else if (line.split(" ")[0].equalsIgnoreCase("deadline")) {
+            TaskList.addDeadline(line.substring(9));
+            try {
+                Storage.writeToFile();
+            } catch (IOException ioexception) {
+                Ui.couldNotSaveMessage();
+            }
+        } else if (line.split(" ")[0].equalsIgnoreCase("event")) {
+            TaskList.addEvent(line.substring(6));
+            try {
+                Storage.writeToFile();
+            } catch (IOException ioexception) {
+                Ui.couldNotSaveMessage();
+            }
+        } else if (line.split(" ")[0].equalsIgnoreCase("delete")) {
+            try {
+                int taskIndex = Integer.parseInt(line.split(" ")[1]);
+                TaskList.deleteTask(taskIndex);
+            } catch (NumberFormatException | ArrayIndexOutOfBoundsException e) {
+                Ui.invalidNumberMessage();
+            }
+            try {
+                Storage.writeToFile();
+            } catch (IOException ioexception) {
+                Ui.couldNotSaveMessage();
+            }
+        } else if (line.split(" ")[0].equalsIgnoreCase("find")) {
+            TaskList.findTask(line);
+        } else {
+            throw new HinaException();
+        }
+    }
+}