[Wang Zhihuang] iP

data/output.txt

@@ -0,0 +1,3 @@
+T | 0 | add book
+D | 1 | bye | 1040
+T | 0 | see book

docs/README.md

@@ -1,29 +1,152 @@
 # User Guide
+toDoList is a Command Line Interface (CLI) application that 
+helps you to manage your tasks.
+
+## Contents of User Guide
+- Features
+  1. [`list` - List all tasks](#listing-all-tasks)
+  2. [`todo` - Create a todo task](#adding-a-todo)
+  3. [`deadline` - Create a deadline task](#adding-a-deadline)
+  4. [`event` - Create an event task](#adding-an-event)
+  5. [`done` - Mark task as done](#mark-as-done)
+  6. [`delete` - Delete task from list](#delete-task)
+  7. [`find` - Find tasks based on keyword](#find-task)
+  8. [`bye` - Exit program](#exit-program)
+- Command Summary
 
 ## Features 
+toDoList supports 3 types of tasks: `To-Do`, `Deadline` and `Event`.
+
+### Listing all tasks
+
+Shows a list of all tasks.
 
-### Feature-ABC
+Format: `list`
+
+Example of usage:
+```
+list
+```
+Expected outcome:
+```
+     Here are the tasks in your list:
+     1.[T][ ] add book
+     2.[E][X] see book (at: 29/09/21 2359)
+     3.[D][ ] submit work (by: 30/10/21 1800)
+```
 
-Description of the feature.
+### Adding a Todo
+Adds a Todo task
 
-### Feature-XYZ
+Format: `todo <TASK_NAME>`
 
-Description of the feature.
+Example of usage:
+```
+todo add book
+```
+Expected outcome:
+```
+     Got it. I've added this task:
+       [T][ ] add book
+     Now you have 6 tasks in the list.
+```
 
-## Usage
+### Adding a Deadline
+Adds a Deadline task, followed by date
 
-### `Keyword` - Describe action
+Format: `deadline <TASK_NAME> /by <DATE>`
 
-Describe the action and its outcome.
+Example of usage:
+```
+deadline finish assignment /by 29/09/21 2359
+```
+Expected outcome:
+```
+     Got it. I've added this task:
+       [D][ ] finish assignment (by: 29/09/21 2359)
+     Now you have 7 tasks in the list.
+```
 
-Example of usage: 
+### Adding an Event
+Adds an Event task, followed by date
 
-`keyword (optional arguments)`
+Format: `event <TASK_NAME> /at <DATE>`
 
+Example of usage:
+```
+event birthday party /at 30/10/21 1800
+```
 Expected outcome:
+```
+     Got it. I've added this task:
+       [E][ ] birthday party (at: 30/10/21 1800)
+     Now you have 8 tasks in the list.
+```
+
+### Mark as done
+Marks a task as done
 
-Description of the outcome.
+Format: `done <TASK_INDEX>`
 
+Example of usage:
 ```
-expected output
+done 3
 ```
+Expected outcome:
+```
+     Nice! I've marked this task as done:
+       [D][X] finish assignment (by: 29/09/21 2359)
+```       
+
+### Delete task
+Deletes a task from the list.
+
+Format: `delete <TASK_INDEX>`
+
+Example of usage:
+```
+delete 2
+```
+Expected outcome:
+```
+     Noted. I've removed this task:
+       [E][ ] birthday party (at: 30/10/21 1800)
+     Now you have 3 tasks in the list.
+```       
+
+### Find task
+Finds tasks given keyword
+
+Format: `find <KEYWORD>`
+
+Example of usage:
+```
+find book
+```
+Expected outcome:
+```
+     Here are the matching tasks in your list:
+     1.[D][ ] throw book (by: 01/01/22)
+     2.[T][ ] buy new book
+``` 
+
+
+### Exit program
+Exits from toDoList.
+
+Format: `bye`
+
+## Command Summary           
+
+|Commands    |Format, Examples                                                                          |
+| ----       | ----                                                                                     |
+|**List**    | `list`                                                                                   |
+|**Todo**    | `todo <TASK_NAME>` <br> eg: `todo add book`                                              |
+|**Deadline**| `deadline <TASK_NAME> /by <DATE>` <br> eg: `deadline finish assignment /by 29/09/21 2359`|
+|**Event**   | `event <TASK_NAME> /at <DATE>` <br> eg: `event birthday party /at 30/10/21 1800`         |
+|**Done**    | `done <TASK_INDEX>` <br> eg: `done 3`                                                    |
+|**Delete**  | `delete <TASK_INDEX>` <br> eg: `delete 2`                                                |
+|**Find**    | `find <KEYWORD>` <br> eg: `find book`                                                    |
+|**Bye**     | `bye`                                                                                    |
+
+

src/main/java/duke/DukeException.java

@@ -0,0 +1,5 @@
+package duke;
+
+public class DukeException extends Exception {
+
+}

src/main/java/duke/command/Duke.java

@@ -0,0 +1,15 @@
+package duke.command;
+
+import duke.task.TaskManager;
+
+import java.util.Scanner;
+
+public class Duke {
+
+    public static void main(String[] args) {
+        TaskManager taskManager = new TaskManager();
+        Scanner scanner = new Scanner(System.in);
+        Ui ui = new Ui(taskManager, scanner);
+        ui.start();
+    }
+}

src/main/java/duke/command/Ui.java

@@ -0,0 +1,48 @@
+package duke.command;
+
+import duke.data.Storage;
+import duke.task.Parser;
+import duke.task.TaskManager;
+
+import java.util.Scanner;
+
+public class Ui {
+    private TaskManager taskManager;
+    private Scanner scanner;
+
+    private static final String LINE = "    ____________________________________________________________\n";
+    private static final String LOGO = "\n" +
+            "                                                   \n" +
+            "  ,--.       ,------.       ,--.  ,--.      ,--.   \n" +
+            ",-'  '-.,---.|  .-.  \\ ,---.|  |  `--',---,-'  '-. \n" +
+            "'-.  .-| .-. |  |  \\  | .-. |  |  ,--(  .-'-.  .-' \n" +
+            "  |  | ' '-' |  '--'  ' '-' |  '--|  .-'  `)|  |   \n" +
+            "  `--'  `---'`-------' `---'`-----`--`----' `--'   \n" +
+            "                                                   \n";
+    private static final String GREETINGS = LINE
+            + LOGO
+            + "     Welcome to the toDoList Chatbot\n"
+            + "     What would you like to do today?\n"
+            + LINE;
+
+    public Ui(TaskManager taskManager, Scanner scanner) {
+        this.taskManager = taskManager;
+        this.scanner = scanner;
+    }
+
+    /**
+     * Starts the program.
+     */
+    public void start() {
+        Storage.loadData();
+        System.out.println(GREETINGS);
+        boolean isExit = false;
+        while (!isExit) {
+            String input = scanner.nextLine();
+            System.out.print(LINE);
+            isExit = Parser.parse(input);
+            System.out.print(LINE);
+            Storage.saveData();
+        }
+    }
+}

src/main/java/duke/data/Storage.java

@@ -0,0 +1,129 @@
+package duke.data;
+
+import duke.task.Deadline;
+import duke.task.Event;
+import duke.task.Task;
+import duke.task.TaskManager;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Scanner;
+
+public class Storage {
+
+    private static final String PATH_NAME = "data/output.txt";
+    private static final String FILE_CREATION_ERROR = "Error in creating file";
+    private static final String SEPARATOR = " | ";
+
+    /**
+     * Creates file inside its directory.
+     */
+    public static void createFile(){
+        try {
+            Path path = Paths.get(PATH_NAME);
+            Files.createDirectories(path.getParent());
+        } catch (IOException e) {
+            System.out.println(FILE_CREATION_ERROR);
+        }
+    }
+
+    /**
+     * Reads content from file and adds into TaskList.
+     *
+     * @param filePath Path where file is read from.
+     * @throws FileNotFoundException If file not found.
+     */
+    public static void readFromFile(String filePath) throws FileNotFoundException {
+        File file = new File(filePath);
+        Scanner scanner = new Scanner(file);
+        while (scanner.hasNext()) {
+            String line = scanner.nextLine();
+            String[] details = line.split("\\|");
+            String taskType = details[0].trim();
+            boolean isDone = details[1].trim().equals("1");
+            String description = details[2].trim();
+            String timing;
+            switch (taskType) {
+            case "T":
+                TaskManager.loadToDoFromFile(description, isDone);
+                break;
+            case "D":
+                timing = details[3].trim();
+                TaskManager.loadDeadlineFromFile(description, timing, isDone);
+                break;
+            case "E":
+                timing = details[3].trim();
+                TaskManager.loadEventFromFile(description, timing, isDone);
+                break;
+            }
+        }
+    }
+
+    /**
+     * Appends to end of file.
+     *
+     * @param filePath Path to append file to.
+     * @param textToAppend Text to be appended.
+     * @throws IOException If an I/O exception has occurred.
+     */
+    public static void appendToFile(String filePath, String textToAppend) throws IOException {
+        FileWriter fw = new FileWriter(filePath, true); // create a FileWriter in append mode
+        fw.write(textToAppend);
+        fw.close();
+    }
+
+    /**
+     * Writes to file.
+     *
+     * @param filePath Path to write file to.
+     * @throws IOException If an I/O exception has occurred.
+     */
+    public static void writeToFile(String filePath) throws IOException {
+        String textToAppend;
+        FileWriter fw = new FileWriter(filePath, false);
+        fw.write(""); //clear the file
+        fw.close();
+        for (Task task: TaskManager.taskList) {
+            String taskType = task.getIcon();
+            String status = task.getStatus();
+            String description = task.getDescription();
+            String timing = task.getTime();
+
+            textToAppend = taskType + SEPARATOR + status + SEPARATOR + description;
+            if (task instanceof Event || task instanceof Deadline) {
+                textToAppend += SEPARATOR + timing;
+            }
+            textToAppend += "\n";
+            appendToFile(filePath, textToAppend);
+        }
+    }
+
+    /**
+     * Saves data into file.
+     */
+    public static void saveData() {
+        try {
+            Path path = Paths.get(PATH_NAME);
+            Files.createDirectories(path.getParent());
+            writeToFile(PATH_NAME);
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+    }
+
+    /**
+     * Loads data from file.
+     */
+    public static void loadData() {
+        try {
+            readFromFile(PATH_NAME);
+        } catch (FileNotFoundException e) {
+            createFile();
+        }
+    }
+}