[Tze Loong] iP

docs/README.md

@@ -1,29 +1,201 @@
 # User Guide
 
+Nova is a command-line (CLI) chatbot application that helps you keep track of your tasks.
+
 ## Features 
 
-### Feature-ABC
+### Adding tasks to your list
+
+You can add three different types of tasks: 
+1. todo
+2. deadline
+3. event 
+
+### Printing your list of tasks
+
+You can view the tasks listed currently
+
+### Mark your tasks
+
+You can mark/unmark your tasks if you have completed/yet to complete them.
+
+### Find tasks by keyword
 
-Description of the feature.
+You can find tasks that matches a specific keyword in your list 
 
-### Feature-XYZ
+### Delete your tasks
 
-Description of the feature.
+You can delete specific tasks from the list
+
+### Save your tasks
+
+Your tasks are saved after you exit the program and loaded once you reopen
 
 ## Usage
 
-### `Keyword` - Describe action
+### `list` - Displaying the current list of tasks 
+
+Prints out the tasks in the list
+
+Example of usage: 
+
+`list`
+
+Expected outcome:
+
+Nova will acknowledge and display the updated list
+
+```
+Here are all of your 3 tasks: 
+1.[T][ ] run
+2.[D][ ] eat (by: 14 July 2023 6pm)
+3.[E][ ] sleep ( from 1 June to 2 June)
+```
+
+### `todo` - Adds a new task of type: Todo 
+
+Adds a new task and updates the current number of tasks in the list 
+
+Example of usage: 
+
+`todo {description}`
+ e.g.  {todo read}
+
+Expected outcome:
+
+Nova will acknowledge the added task and display the updated number of tasks
+
+```
+I have added this task: 
+[T][ ] read
+You now have 4 tasks in the list.
+```
+
+### `deadline` - Adds a new task of type: deadline
+
+Adds a new task with a deadline and updates the current number of tasks in the list 
+
+Example of usage: 
+
+`deadline {description /by deadline}`
+e.g. {deadline eat /by 14 July 2023 6pm}
+
+Expected outcome:
+
+Nova will acknowledge the added task and display the updated number of tasks
+
+```
+I have added this task: 
+[D][ ] eat (by: 14 July 2023 6pm)
+You now have 5 tasks in the list.
+```
+
+### `event` - Adds a new task of type: event
+
+Adds a new task regarding an event and updates the current number of tasks in the list 
+
+Example of usage: 
+
+`event {description /from date /to date}`
+e.g. {event sleep /from 1 June /to 2 June}
+
+Expected outcome:
+
+Nova will acknowledge the added task and display the updated number of tasks
+
+```
+I have added this task: 
+[E][ ] sleep ( from 1 June to 2 June)
+You now have 6 tasks in the list.
+```
+
+### `mark` - Mark a specific task by index 
+
+Marks a task according to its index in the list
+
+Example of usage: 
+
+`mark {index}`
+
+Expected outcome:
+
+Nova will acknowledge and display the marked task
+
+```
+Nice! This task is completed
+[D][X] eat (by: 14 July 2023 6pm)
+```
+
+### `unmark` - Unmarks a specific task by index 
 
-Describe the action and its outcome.
+Unmarks a task according to its index in the list
 
 Example of usage: 
 
-`keyword (optional arguments)`
+`unmark {index}`
 
 Expected outcome:
 
-Description of the outcome.
+Nova will acknowledge and display the unmarked task
 
 ```
-expected output
+Alright, this task has yet to be complete
+[D][ ] eat (by: 14 July 2023 6pm)
 ```
+
+### `delete` - Deletes a specific task by index 
+
+Deletes a task according to its index in the list
+
+Example of usage: 
+
+`delete {index}`
+
+Expected outcome:
+
+Nova will acknowledge, delete the unmarked task and display the updated number of tasks
+
+```
+Noted. I have deleted this task
+[D][ ] eat (by: 14 July 2023 6pm)
+You now have 1 tasks in the list.
+```
+
+
+### `find` - Deletes a specific task by index 
+
+Find tasks that matches a specific keyword in your list 
+
+Example of usage: 
+
+`find {keyword}`
+
+Expected outcome:
+
+Nova will acknowledge, search for the related tasks and display accordingly 
+
+```
+Here are the matching tasks in your list: 
+1.[D][ ] eat (by: 14 July 2023 6pm)
+2.[T][ ] eat
+```
+
+### `bye` - Exits the application 
+
+Quits the program 
+
+Example of usage: 
+
+`bye`
+
+Expected outcome:
+
+Nova will greet you farewell 
+
+```
+Goodbye. Hope to see u again :) 
+```
+
+
+
+

nova_data/nova_inputs.txt

@@ -0,0 +1,2 @@
+[T][ ] fly
+[D][ ] return book (by: Sunday)

src/main/java/nova/Deadline.java

@@ -0,0 +1,26 @@
+package nova;
+
+public class Deadline extends Tasks {
+
+    protected String by;
+
+    /**
+     * Creates a new Deadline object
+     * 
+     * @param description the description of the task
+     * @param by          the deadline of the task
+     */
+    public Deadline(String description, String by) {
+        super(description);
+        this.by = by;
+    }
+
+    /**
+     * Returns the string corresponding to the task icon and its deadline
+     */
+    @Override
+    public String toString() {
+        return "[D]" + super.toString() + "(by:" + by + ")";
+    }
+
+}

src/main/java/nova/Event.java

@@ -0,0 +1,28 @@
+package nova;
+
+public class Event extends Tasks {
+    protected String start;
+    protected String end;
+
+    /**
+     * Creates a new Event object
+     * 
+     * @param description the description of the task
+     * @param start       the start time of the event
+     * @param end         the end time of the event
+     */
+    public Event(String description, String start, String end) {
+        super(description);
+        this.start = start;
+        this.end = end;
+    }
+
+    /**
+     * Returns the string corresponding to the task icon and the start, end time of
+     * the event
+     */
+    @Override
+    public String toString() {
+        return "[E]" + super.toString() + "(" + "from: " + start + "to: " + end + ")";
+    }
+}

src/main/java/nova/Nova.java

@@ -0,0 +1,76 @@
+package nova;
+
+import java.io.FileNotFoundException;
+import nova.exception.EmptyInputsException;
+import nova.exception.ExceptionChecker;
+
+public class Nova {
+
+    public static void main(String[] args) throws EmptyInputsException {
+        try {
+            Ui.greet_user();
+            Storage.checkFile();
+        } catch (FileNotFoundException e) {
+            System.out.println("File does not exist.");
+        }
+
+        String[] command = Parser.getCommand();
+
+        while (!"bye".equals(command[0])) {
+            try {
+                switch (command[0]) {
+                case "todo":
+                    Tasklist.todo(command[1]);
+                    break;
+                case "deadline":
+                    String[] d = command[1].split("/by", 2);
+                    String d_description = d[0];
+                    String d_by = d[1];
+                    ExceptionChecker.checkEmptyString(d_description);
+                    ExceptionChecker.checkEmptyString(d_by);
+                    Tasklist.deadline(d_description, d_by);
+                    break;
+                case "event":
+                    String[] er = command[1].split("/from|/to", 3);
+                    String e_description = er[0];
+                    String e_start = er[1];
+                    String e_end = er[2];
+                    ExceptionChecker.checkEmptyString(e_description);
+                    ExceptionChecker.checkEmptyString(e_start);
+                    ExceptionChecker.checkEmptyString(e_end);
+                    Tasklist.event(e_description, e_start, e_end);
+                    break;
+                case "list":
+                    Tasklist.list();
+                    break;
+                case "mark":
+                    Integer m_index = Integer.valueOf(command[1]);
+                    Tasklist.markTask(m_index);
+                    break;
+                case "unmark":
+                    Integer u_index = Integer.valueOf(command[1]);
+                    Tasklist.unmarkTask(u_index);
+                    break;
+                case "delete":
+                    Integer d_index = Integer.valueOf(command[1]);
+                    Tasklist.delete(d_index);
+                    break;
+                case "find":
+                    String keyword = command[1];
+                    Tasklist.find(keyword);
+                    break;
+                default:
+                    System.out.println("Command not recognised. Please try again");
+                    break;
+                }
+            } catch (ArrayIndexOutOfBoundsException e) {
+                System.out.println("Command is incomplete. Please try again!");
+            } catch (EmptyInputsException a) {
+                System.out.println(a.getMessage());
+            }
+            command = Parser.getCommand();
+        }
+        Ui.goodbye_user();
+        Tasklist.saveFile();
+    }
+}

src/main/java/nova/Parser.java

@@ -0,0 +1,16 @@
+package nova;
+
+import java.util.Scanner;
+
+public class Parser {
+    private static Scanner scan = new Scanner(System.in);
+    private static String input;
+    private static String[] command;
+
+    public static String[] getCommand() {
+        input = scan.nextLine();
+        command = input.split(" ", 2);
+        return command;
+    }
+
+}