[yuhengr] ip

docs/README.md

@@ -1,29 +1,69 @@
-# User Guide
+# User Guide - Chatbot Ekud
+This is the user guide for chatbot Ekud, a Command Line Interface (CLI) application.<br>
 
 ## Features 
 
-### Feature-ABC
+### Adding a task
+Adds a task to the task list. The task can be a Todo, Deadline or Event.<br>
 
-Description of the feature.
+## Usage
+> `todo <description>`<br>
+> Adds a Todo task with the given description.
+
+> `deadline <description> /by <by>`<br>
+> Adds a Deadline task with the given description and deadline to meet.
+
+> `event <description> /from <from> /to <to>`<br>
+> Adds an event task with its ongoing period.
+
+### Listing all the tasks
+
+Shows a list of all the tasks in the task list.
+
+## Usage
+> `list`
+
+### Deleting a task
+
+Deletes a task in the task list.
 
-### Feature-XYZ
+## Usage
+> `delete <index>`
+
+### Marking a task
 
-Description of the feature.
+Mark a task as completed.
 
 ## Usage
+> `mark <index>`
 
-### `Keyword` - Describe action
+### Unmarking a task
 
-Describe the action and its outcome.
+Unmark a task as uncompleted.
 
-Example of usage: 
+## Usage
+> `unmark <index>`
 
-`keyword (optional arguments)`
+### Deleting a task
 
-Expected outcome:
+Deletes a task based on the task number.
+
+## Usage
+> `delete <index>`
+
+### Finding a task
+
+Finds relevant tasks based on keyword.
+
+## Usage
+> `find <keyword>`
 
-Description of the outcome.
+#### Example of usage:
+`find books` - Finds tasks that contain keyword "books".
 
+#### Expected outcome:
 ```
-expected output
+Here are the relevant tasks:
+1.[T][] read book
+2.[D][] return book
 ```

src/main/java/Duke.java

@@ -1,10 +1,83 @@
+import java.util.Scanner;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import exception.EkudException;
+import task.TaskList;
+import storage.Storage;
+import ui.UI;
+
+/**
+ * This Duke class is an abstraction of the chatbot and provides its driver method.
+ */
 public class Duke {
+
     public static void main(String[] args) {
-        String logo = " ____        _        \n"
-                + "|  _ \\ _   _| | _____ \n"
-                + "| | | | | | | |/ / _ \\\n"
-                + "| |_| | |_| |   <  __/\n"
-                + "|____/ \\__,_|_|\\_\\___|\n";
-        System.out.println("Hello from\n" + logo);
+
+        System.out.println(UI.GREETING_MESSAGE);
+
+        String userInput;
+        Scanner in = new Scanner(System.in);
+        TaskList tasks = new TaskList();
+
+        Storage storage = new Storage();
+
+        // Try to load existing tasks.
+        try {
+            tasks = storage.readFromFile();
+        }
+        catch (FileNotFoundException error){
+            System.out.println(UI.FILE_NOT_FOUND_MESSAGE);
+        }
+
+        userInput = in.nextLine();
+
+        while(!userInput.equals("bye")){
+            String[] userInputWords = userInput.split(" ");
+            String userCommand = userInputWords[0].toLowerCase();
+
+            if(userCommand.equals("list")){
+                tasks.list();
+            }
+            else if(userCommand.equals("mark")){
+                tasks.mark(userInput);
+            }
+            else if(userCommand.equals("unmark")){
+                tasks.unmark(userInput);
+            }
+            else if(userCommand.equals("todo")){
+                tasks.addTodo(userInput);
+            }
+            else if(userCommand.equals("deadline")){
+                tasks.addDeadline(userInput);
+            }
+            else if(userCommand.equals("event")){
+                tasks.addEvent(userInput);
+            }
+            else if(userCommand.equals("delete")){
+                tasks.delete(userInput);
+            }
+            else if(userCommand.equals("find")) {
+                tasks.find(userInput);
+            }
+            else{
+                try {
+                    throw new EkudException();
+                }
+                catch (EkudException error){
+                    System.out.println(UI.INVALID_COMMAND_MESSAGE);
+                }
+            }
+            userInput = in.nextLine();
+        }
+
+        // Save tasks before ending the session.
+        try {
+            storage.writeToFile(tasks);
+        }
+        catch(IOException error) {
+            System.out.println(UI.FILE_WRITE_ERROR_MESSAGE);
+        }
+
+        System.out.println(UI.EXIT_MESSAGE);
     }
 }

src/main/java/exception/EkudException.java

@@ -0,0 +1,4 @@
+package exception;
+
+public class EkudException extends Exception {
+}

src/main/java/storage/Storage.java

@@ -0,0 +1,49 @@
+package storage;
+
+import java.util.Scanner;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileWriter;
+import java.io.IOException;
+import task.TaskList;
+
+/**
+ * This Storage class is a file manager that stores the list of tasks.
+ */
+public class Storage {
+
+    private static final String filePath = "tasks.txt";
+
+    public Storage() {}
+
+    /**
+     * Saves the tasks before ending the chatbot session.
+     *
+     * @param tasks contain the tasks that were added during the session.
+     * @throws IOException if the text file cannot be opened or written to etc.
+     */
+    public void writeToFile(TaskList tasks) throws IOException {
+        FileWriter fw = new FileWriter(filePath);
+        for(int i = 0; i < tasks.getTaskCount(); i++){
+            fw.write(tasks.getTask(i).toString() + "\n");
+        }
+        fw.close();
+    };
+
+    /**
+     * Loads pre-existing tasks from a text file.
+     *
+     * @return TaskList object containing the loaded tasks.
+     * @throws FileNotFoundException if the text file cannot be found.
+     */
+    public TaskList readFromFile() throws FileNotFoundException {
+        File f = new File(filePath);
+        Scanner s = new Scanner(f);
+        TaskList tasks = new TaskList();
+        while(s.hasNext()) {
+            String currentLine = s.nextLine();
+            tasks.addTaskFromFile(currentLine);
+        }
+        return tasks;
+    };
+}

src/main/java/task/Deadline.java

@@ -0,0 +1,19 @@
+package task;
+
+/**
+ * This Deadline class represents a task with a deadline to meet.
+ */
+public class Deadline extends Task {
+
+    protected String by;
+
+    public Deadline(String description, String by) {
+        super(description);
+        this.by = by;
+    }
+
+    @Override
+    public String toString() {
+        return "[D]" + super.toString() + " (by: " + by + ")";
+    }
+}

src/main/java/task/Event.java

@@ -0,0 +1,20 @@
+package task;
+
+/**
+ * This Event class represents a task and its ongoing period.
+ */
+public class Event extends Task {
+
+    protected String startTime;
+    protected String endTime;
+
+    public Event(String description, String startTime, String endTime) {
+        super(description);
+        this.startTime = startTime;
+        this.endTime = endTime;
+    }
+
+    public String toString() {
+        return "[E]" + super.toString() + " (from: " + this.startTime + " to: " + this.endTime + ")";
+    }
+}

src/main/java/task/Task.java

@@ -0,0 +1,31 @@
+package task;
+
+/**
+ * The super class for Todo, Deadline and Event.
+ */
+public class Task {
+    protected String description;
+    protected boolean isDone;
+
+    public Task(String description) {
+        this.description = description;
+        this.isDone = false;
+    }
+
+    public String getStatusIcon() {
+        return (isDone ? "X" : " ");
+    }
+
+    public void markAsDone() {
+        this.isDone = true;
+    }
+
+    public void markAsNotDone() {
+        this.isDone = false;
+    }
+
+    @Override
+    public String toString() {
+        return String.format("[%s] %s", this.getStatusIcon(), this.description);
+    }
+}