[Guanlin] iP

docs/README.md

@@ -1,29 +1,118 @@
-# User Guide
+# GermaBot User Guide
+
+GermaBot is a task list bot. You can add, delete, find and list the stored tasks. GermaBot recognizes 3 different type 
+of tasks: Todo tasks, deadline tasks and event tasks. 
+GermaBot is also capable of saving files to your local hard disk, to the `/src/data/GermaBotData.txt` file.
 
 ## Features 
 
-### Feature-ABC
+> ## Notes about the command format.
+> - Words in `UPPER_CASE` are the parameters to be supplied by the user.
+> - Extra parameters that do not take in any parameters (such as `list` and `bye`) will be ignored. 
+> e.g. if the input is `list 123`, it will be interpreted as `list`.
+
+
+
+### Adding Todo tasks : `todo`
+Adds a todo task to the task list.
 
-Description of the feature.
+Format: `todo TASK_NAME`
 
-### Feature-XYZ
+### Adding Deadline tasks : `deadline` 
+Adds a deadline task to the task list. 
 
-Description of the feature.
+Format: `deadline TASK_NAME /by DEADLINE`
+
+Example:
+```
+deadline Read a book /by 4th July
+```
 
-## Usage
+### Adding Event tasks : `event`
+Adds an event task to the task list. 
 
-### `Keyword` - Describe action
+Format: `event TASK_NAME /from STARTDATE /to ENDDATE`
 
-Describe the action and its outcome.
+Example:
+```
+event Dad's party /from 6pm /to 12am
+```
 
-Example of usage: 
+### Listing all tasks : `list`
+Shows the list of the current tasks, including the details of the task.
 
-`keyword (optional arguments)`
+Example input:
+```
+list 
+```
+Example output:
+```
+Gotcha! Here are your tasks:
+1. [T][X] Read a book
+2. [D][ ] Finish IP (by: 23rd November)
+3. [E][X] Dad's birthday party (from: 6pm to: 12am)
+```
+
+### Deleting tasks : `delete`
+Deletes a task from the task list.
+
+Format: `delete TASK_NUMBER`
+
+Example:
+```
+delete 2
+```
+Example output:
+```
+Okay! I've removed this task from your To Do List:
+[D][X] Finish IP (by: tmr)
+Now you have, let me count... 4 items left in your To Do List!
+```
 
-Expected outcome:
+### Finding tasks : `find`
+Finds a task containing certain keywords.
 
-Description of the outcome.
+Format: `find KEYWORDS`
 
+Example:
 ```
-expected output
+find book
 ```
+Example output:
+```
+Gotcha! Finding tasks containing 'book'...
+1. [T][X] Read a book
+```
+
+### Marking tasks as done : `mark`
+Marks a task as done. 
+
+Format: `mark TASK_NUMBER`
+
+Example: 
+```
+mark 2
+```
+Example output:
+```
+Good job! I'll mark this task as done: [X] Finish IP
+```
+
+### Marking tasks as undone : `unmark`
+Marks a task as undone.
+
+Format: `unmark TASK_NUMBER`
+
+Example:
+```
+unmark 1
+```
+Example output:
+```
+Aww, not done? Okay, I'll mark this task as undone: [ ] Read a book
+```
+
+### Exiting the program: `bye`
+Exits the program.
+
+Format: `bye`

src/data/GermaBotData.txt

@@ -0,0 +1,3 @@
+T | 1 | Read a book
+D | 0 | Finish IP | tmr
+E | 1 | Do NOT drop out (IMPOSSIBLE) | now | end of semester

src/main/java/DataHandling/LoadData.java

@@ -0,0 +1,121 @@
+package DataHandling;
+
+import Exceptions.FileReadException;
+import Exceptions.LoadFileException;
+import GermaBot.UI;
+import Tasks.*;
+
+import java.io.FileNotFoundException;
+import java.util.Scanner;
+import java.util.ArrayList;
+import java.io.File;
+
+/**
+ * The LoadData class handles loading tasks from a file into the program.
+ */
+public class LoadData {
+    static ArrayList<Task> toDoList = new ArrayList<>();
+    static int counter = 0;
+
+    /**
+     * Loads a ToDo task from a string description and adds it to the task list.
+     *
+     * @param description The description of the ToDo task.
+     * @throws LoadFileException If the description is empty.
+     */
+    public static void loadToDo(String description) throws LoadFileException {
+        if (description.isEmpty()) {
+            throw new LoadFileException();
+        }
+        toDoList.add(new ToDo(description));
+    }
+
+    /**
+     * Loads a Deadline task from a string description and adds it to the task list.
+     *
+     * @param description The description of the Deadline task, including the deadline date.
+     * @throws LoadFileException If the description or deadline date is empty or invalid.
+     */
+    public static void loadDeadline(String description) throws LoadFileException {
+        String[] deadlineDescription = description.split("\\|");
+        String task = deadlineDescription[0].trim();
+        String by = deadlineDescription[1].trim();
+        if (task.isBlank() || by.isBlank()) {
+            throw new LoadFileException();
+        }
+        toDoList.add(new Deadline(task, by));
+    }
+
+    /**
+     * Loads an Event task from a string description and adds it to the task list.
+     *
+     * @param description The description of the Event task, including the start and end dates.
+     * @throws LoadFileException If the description or dates are empty or invalid.
+     */
+    public static void loadEvent(String description) throws LoadFileException {
+        String[] eventDescription = description.split("\\|");
+        String task = eventDescription[0].trim();
+        String from = eventDescription[1].trim();
+        String by = eventDescription[2].trim();
+        if (task.isBlank() || from.isBlank() || by.isBlank()) {
+            throw new LoadFileException();
+        }
+        toDoList.add(new Event(task, from, by));
+    }
+
+    /**
+     * Loads tasks from a file into the program.
+     *
+     * @return An ArrayList of tasks loaded from the file.
+     * @throws FileNotFoundException If the file is not found.
+     * @throws FileReadException If there is an error reading the file, such as if the file is in an invalid format.
+     */
+    public static ArrayList<Task> loadFile() throws FileNotFoundException, FileReadException {
+        File data = new File("src/data/GermaBotData.txt");
+        Scanner fileInput = new Scanner(data);
+        do {
+            String task = fileInput.nextLine();
+            if (task.trim().isEmpty()) {
+                throw new FileReadException();
+            }
+            counter++;
+            char type = task.charAt(0);
+            String description = task.substring(8);
+            boolean isCompleted = task.charAt(4) != '0';
+            if (type == 'T') {
+                try {
+                    loadToDo(description);
+                } catch (LoadFileException e) {
+                    UI.printLoadFileException();
+                }
+            } else if (type == 'D') {
+                try {
+                    loadDeadline(description);
+                } catch (LoadFileException e) {
+                    UI.printLoadFileException();
+                }
+            } else if (type == 'E') {
+                try {
+                    loadEvent(description);
+                } catch (LoadFileException e) {
+                    UI.printLoadFileException();
+                }
+            } else {
+                break;
+            }
+            int idxToMark = toDoList.size() - 1;
+            toDoList.get(idxToMark).setDone(isCompleted);
+        } while (fileInput.hasNext());
+        fileInput.close();
+        return toDoList;
+    }
+
+    /**
+     * Returns the number of tasks loaded from the file.
+     *
+     * @return The number of tasks.
+     */
+    public static int getCounter() {
+        return counter;
+    }
+}

src/main/java/DataHandling/SaveData.java

@@ -0,0 +1,54 @@
+package DataHandling;
+
+import Tasks.*;
+
+import java.io.FileWriter;
+import java.io.IOException;
+
+/**
+ * The SaveData class handles saving tasks to a file.
+ */
+public class SaveData {
+    private static final String filePath = "src/data/GermaBotData.txt";
+
+    /**
+     * Saves a ToDo task to the file.
+     *
+     * @param toDoTask The ToDo task to be saved.
+     * @param taskType The type of the task ('T' for ToDo).
+     * @throws IOException If there is an error writing to the file.
+     */
+    public static void addTodoToFile(ToDo toDoTask, char taskType) throws IOException {
+        FileWriter writer = new FileWriter(filePath, true);
+        writer.write("T | " + (toDoTask.isDone() ? "1" : "0") + " | " + toDoTask.getDescription() + System.lineSeparator());
+        writer.close();
+    }
+
+    /**
+     * Saves a Deadline task to the file.
+     *
+     * @param deadlineTask The Deadline task to be saved.
+     * @param taskType The type of the task ('D' for Deadline).
+     * @throws IOException If there is an error writing to the file.
+     */
+    public static void addDeadlineToFile(Deadline deadlineTask, char taskType) throws IOException {
+        FileWriter writer = new FileWriter(filePath, true);
+        writer.write("D | " +  (deadlineTask.isDone() ? "1" : "0") + " | " + deadlineTask.getDescription() +
+                " | " + deadlineTask.getBy() + System.lineSeparator());
+        writer.close();
+    }
+
+    /**
+     * Saves an Event task to the file.
+     *
+     * @param eventTask The Event task to be saved.
+     * @param taskType The type of the task ('E' for Event).
+     * @throws IOException If there is an error writing to the file.
+     */
+    public static void addEventToFile(Event eventTask, char taskType) throws IOException {
+        FileWriter writer = new FileWriter(filePath, true);
+        writer.write("E | " + (eventTask.isDone() ? "1" : "0") + " | " + eventTask.getDescription() +
+                " | " + eventTask.getFrom() + " | " + eventTask.getTo() + System.lineSeparator());
+        writer.close();
+    }
+}

src/main/java/Exceptions/EmptyTaskException.java

@@ -0,0 +1,4 @@
+package Exceptions;
+
+public class EmptyTaskException extends Exception{
+}

src/main/java/Exceptions/FileReadException.java

@@ -0,0 +1,4 @@
+package Exceptions;
+
+public class FileReadException extends Exception{
+}

src/main/java/Exceptions/LoadFileException.java

@@ -0,0 +1,4 @@
+package Exceptions;
+
+public class LoadFileException extends Exception {
+}

src/main/java/Exceptions/MissingDeadlineException.java

@@ -0,0 +1,4 @@
+package Exceptions;
+
+public class MissingDeadlineException extends Exception{
+}

src/main/java/Exceptions/MissingStartDateException.java

@@ -0,0 +1,4 @@
+package Exceptions;
+
+public class MissingStartDateException extends Exception{
+}

src/main/java/Exceptions/TaskNotFoundException.java

@@ -0,0 +1,4 @@
+package Exceptions;
+
+public class TaskNotFoundException extends Exception{
+}

src/main/java/Exceptions/UnknownInputException.java

@@ -0,0 +1,4 @@
+package Exceptions;
+
+public class UnknownInputException extends Exception{
+}