[Anderson Leong] iP

docs/README.md

@@ -1,29 +1,237 @@
 # User Guide
+##Getting Started
+### Preparations
+Ensure that `ip.jar` is located within a folder of its own. 
+Open up a Terminal and ensure to the directory is the same as the folder `ip.jar` is located in.
+### Initialising Duke
+Enter the following into the terminal to initialise Duke application.
+```
+java -jar ip.jar
+```
+## Features and Usage
+### Feature List
+- `help`
+- `todo`
+- `deadline`
+- `event`
+- `list`
+- `done`
+- `delete`
+- `bye`
+
+*All commands are not case-sensitive:*
+
+`dEAdLine`, `deadline`, and `Deadline` All mean: `deadline`.
+___
+---
+
+### List Commands: `help`
+Prints all commands available.
+
+**Example of usage:**
+
+*input:*
+```
+help
+```
+---
+---
+
+### Add ToDo: `todo`
+Adds a new ToDo to the task list. A ToDo is a task with a description of the task.
+
+**Arguments:**
+1. `<desc>` - Description of the ToDo task.
+
+**Format:** `todo <desc>`
+
+**Example of usage:**
+
+*input:*
+```
+todo Eat apples
+```
+*output:*
+```
+Got it. I've added this task:
+1.[T][ ] Eat apples
+Now you have 1 tasks in the list.
+```
+---
+---
+### Add Deadline: `deadline`
+Adds a new Deadline to the task list. A Deadline is a task with a description of the task and a deadline.
+
+**Arguments:**
+1. `<desc>` - Description of the Deadline task.
+2. `<by>` - DateTime the deadline should be done by.
+
+**Format:**
+- `deadline <desc> /by <by>`
+
+`<by>` *is accepted in the following formats:*
+- `Custom input`
+- `dd/mm/yyyy`
+- `dd/mm/yyyy hhmm`
+
+**Example of usage:**
+
+*input:*
+```
+deadline IEM2 Assignment /by This Friday
+```
+*output:*
+```
+Got it. I've added this task:
+2.[D][ ] IEM2 Assignment (by: This Friday)
+Now you have 2 tasks in the list.
+```
+___
+*input:*
+```
+deadLine CS2113T ip submission /by 01/10/2021 2359
+```
+*output:*
+```
+Got it. I've added this task:
+3.[D][ ] CS2113T ip Submission (by: Oct 1 2021 11:59 PM)
+Now you have 3 tasks in the list.
+```
+___
+---
+### Add Event: `event`
+Adds a new Event to the task list. An Event is a task with a description of the task and a event.
+
+**Arguments:**
+1. `<desc>` - Description of the Event task.
+2. `<at>` - DateTime or Location the Event should be happening at.
 
-## Features 
+**Format:**
+- `event <desc> /at <at>`
 
-### Feature-ABC
+`<at>` is accepted in the following formats:
+- `Custom input`
+- `dd/mm/yyyy`
+- `dd/mm/yyyy hhmm`
 
-Description of the feature.
+**Example of usage:**
 
-### Feature-XYZ
+*input:*
+```
+event Dance show /at Esplanade
+```
+*output:*
+```
+Got it. I've added this task:
+4.[E][ ] Dance show (at: Esplanade)
+Now you have 4 tasks in the list.
+```
+---
+*input:*
+```
+Event No Time To Die premiere /at 30/09/2021
+```
+*output:*
+```
+Got it. I've added this task:
+5.[E][ ] No Time To Die premiere (at: Sep 30 2021)
+Now you have 5 tasks in the list.
+```
+___
+---
+### List Tasks: `list`
+Prints all tasks in the task list.
+
+**Arguments:**
+None
+
+**Format:** 
+- `list`
+
+**Example of usage:**
+
+*input*
+```
+list
+```
+*output:*
+```
+Here are the tasks in your list:
+1.[T][ ] Eat apples
+2.[D][ ] IEM2 Assignment (by: This Friday)
+3.[D][ ] CS2113T ip Submission (by: Oct 1 2021 11:59 PM)
+4.[E][ ] Dance show (at: Esplanade)
+5.[E][ ] No Time To Die premiere (at: Sep 30 2021)
+
+```
+---
+---
+### Mark Task as Done: `done`
+Marks a Task in the Task List as done.
+
+**Arguments:**
+1. `<index>` - Task index with respect to the list.
+
+**Format:**
+- `done <index>`
+
+`<index>` *should only be a number from the list*
+
+**Example of usage:**
+
+*input:*
+```
+done 4
+```
+*output:*
+```
+Nice, I've marked this task as Done:
+ [E][X] Dance show (at: Esplanade)
+```
+___
+---
+### Remove Task from Task List: `delete`
+Delete a Task from the Task List.
 
-Description of the feature.
+**Arguments:**
+1. `<index>` - Task index with respect to the list.
 
-## Usage
+**Format:**
+- `delete <index>`
 
-### `Keyword` - Describe action
+*`<index>` should only be a number from the list*
 
-Describe the action and its outcome.
+**Example of usage:**
 
-Example of usage: 
+*input:*
+```
+delete 3
+```
+*output:*
+```
+Noted! I've removed this task:
+3.[D][ ] CS2113T ip Submission (by: Oct 1 2021 11:59PM)
+Now you have 4 tasks in the list.
+```
+___
+---
+### Remove Task from Task List: `bye`
+Exits Duke application.
 
-`keyword (optional arguments)`
+**Arguments:**
+ None
 
-Expected outcome:
+**Format:**
+- `bye`
 
-Description of the outcome.
+**Example of usage:**
 
+*input:*
+```
+bye
+```
+*output:*
 ```
-expected output
+Bye. try not to procrastinate!
 ```
+___

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-leap-day

src/main/java/duke/Duke.java

@@ -0,0 +1,73 @@
+package duke;
+
+import duke.DukeExceptions.EmptyCommand;
+import duke.DukeExceptions.InvalidCommandException;
+import duke.task.Task;
+
+import java.io.FileNotFoundException;
+import java.util.Scanner;
+import java.util.ArrayList;
+
+public class Duke {
+
+    private final Storage storage;
+    private TaskList tasksLs;
+    private final Ui ui;
+
+    private final Scanner in = new Scanner(System.in);
+
+    /**
+     * A constructor to initiate Duke.
+     *
+     * @param filepath Filepath when initiating.
+     */
+    public Duke(String filepath) {
+        this.tasksLs = new TaskList(new ArrayList<Task>());
+        this.storage = new Storage(filepath);
+        this.ui = new Ui();
+    }
+
+    /**
+     * Runs Duke object until user exits with </bye>.
+     */
+    private void run() {
+        ui.greetMessage();
+        String input = "";
+        try {
+            tasksLs = storage.loadFile(tasksLs.getList());
+        } catch (FileNotFoundException e) {
+            storage.createFile();
+        }
+
+        boolean closeDuke = false;
+        do {
+            try {
+                input = getInput();
+                String parsed = new Parser(tasksLs, ui).parse(input);
+                System.out.println(parsed);
+                storage.autoSave(tasksLs.getList());
+                closeDuke = input.trim().equals("bye");
+            } catch (InvalidCommandException | EmptyCommand e) {
+                System.out.println(e);
+            }
+        } while (!closeDuke);
+    }
+
+    /**
+     * Prompts user for input.
+     *
+     * @return String input by user.
+     */
+    private String getInput() {
+        return in.nextLine();
+    }
+
+    /**
+     * application.
+     *
+     * @param args to start Duke Application.
+     */
+    public static void main(String[] args) {
+        new Duke("duke.txt").run();
+    }
+}

src/main/java/duke/DukeExceptions/DukeException.java

@@ -0,0 +1,12 @@
+package duke.DukeExceptions;
+
+public class DukeException extends Exception {
+    /**
+     * convert to new default Exception message.
+     *
+     * @return error Message.
+     */
+    public String toString() {
+        return "Something Went Wrong";
+    }
+}

src/main/java/duke/DukeExceptions/EmptyCommand.java

@@ -0,0 +1,15 @@
+package duke.DukeExceptions;
+
+public class EmptyCommand extends DukeException {
+
+    /**
+     * @return Empty input Message.
+     */
+    public String toString() {
+        return ("\t______________________________________________________________________\n" +
+                "\tNo command detected. Command was empty :)\n" +
+                "\t______________________________________________________________________\n" +
+                "\tKey in [help] to list available commands\n" +
+                "\t______________________________________________________________________\n");
+    }
+}