[LWachtel1] iP

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# chatman project template
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 
@@ -13,7 +13,7 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
    1. If there are any further prompts, accept the defaults.
 1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
    In the same dialog, set the **Project language level** field to the `SDK default` option.
-3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
+3. After that, locate the `src/main/java/chatman.java` file, right-click it, and choose `Run chatman.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
    ```
    Hello from
     ____        _        

docs/README.md

@@ -1,29 +1,170 @@
-# User Guide
+# ChatMan User Guide
+
+**ChatMan** is a chatbot that enables storage and tracking of a user's different tasks. 
+
+It possesses 3 main categories of tasks:
+
+- **todos** (tasks without any timeframe)
+- **deadlines** (tasks with endpoints for completion)
+- **events** (tasks with start-point and endpoints)
+
+A user can interact with **ChatMan** using commands that allow them to add & remove tasks from storage, mark them as 
+complete/incomplete, list all currently stored tasks and find stored tasks using keyword search.
 
 ## Features 
 
-### Feature-ABC
+This section details all **ChatMan** commands available to a user, what they do and how to correctly format them.
+
+### Listing stored tasks: `list`
+
+Displays all currently stored tasks to user.
+
+Format: `list`
+
+*Example output:*
+```
+1.[T][ ]return book
+2.[D][ ]buy gifts (by: 24th December)
+3.[E][ ]job interview (from: 25th March 10am to: 11am)
+```
+### Searching stored tasks: `find`
+
+Returns all tasks whose descriptions contain the keyword/key-phrase provided with 'find'.
+
+Format: `find KEYWORD`
+
+>Please note that `KEYWORD` cannot contain any **/** characters
 
-Description of the feature.
+*Example input:*
+`find job`
 
-### Feature-XYZ
+*Example output:*
+```
+Here are the full matches in your list for 'job':
+3.[E][ ]job interview (from: 25th March 10am to: 11am)
+```
+### Adding a todo: `todo`
+Adds a task without any timeframe to the task list. By default, this task is not marked as complete.
 
-Description of the feature.
+Format: `todo DESCRIPTION`
 
-## Usage
+>Please note that `DESCRIPTION` cannot contain any **/** characters
 
-### `Keyword` - Describe action
+*Example input:*
+`todo return book`
 
-Describe the action and its outcome.
+*Example output:*
+```
+Got it. I've added this task:
+[T][ ]return book
+Now you have 1 tasks in the list.
+```
 
-Example of usage: 
+### Adding a deadline: `deadline`
+Adds a task with an endpoint to the task list. By default, this task is not marked as complete.
 
-`keyword (optional arguments)`
+Format: `deadline DESCRIPTION /by ENDPOINT`
 
-Expected outcome:
+>Please note that all ARGUMENTS cannot contain any **/** characters
 
-Description of the outcome.
+*Example input:*
+`deadline buy gifts /by 24th December`
 
+*Example output:*
 ```
-expected output
+Got it. I've added this task:
+[D][ ]buy gifts (by: 24th December)
+Now you have 2 tasks in the list.
 ```
+
+### Adding an event: `event`
+Adds a task with a start-point and an endpoint to the task list. By default, this task is not marked as complete.
+
+Format: `event DESCRIPTION /from STARTPOINT /to ENDPOINT`
+
+>Please note that all ARGUMENTS cannot contain any **/** characters
+
+*Example input:*
+`event job interview /from 25th March 10am /to 11am`
+
+*Example output:*
+```
+Got it. I've added this task:
+[E][ ]job interview (from: 25th March 10am to: 11am)
+Now you have 3 tasks in the list.
+```
+### Marking & unmarking tasks: `mark` and `unmark`
+
+`mark` labels a stored task (at the provided list position) as complete.
+`unmark` labels a stored task (at the provided list position) as incomplete.
+
+*[X]* is the 'complete' label.
+
+*[ ]* is the 'incomplete' label.
+
+Format: 
+- `mark LIST_POSITION`
+- `unmark LIST_POSITION`
+
+>Please note that LIST_POSITION must be a numerical position within the bounds of the list.
+
+*Example input:*
+`mark 1`
+
+*Example Output:*
+```
+Nice! I've marked this task as done:
+[T][X]return book
+```
+The action of this command is also reflected when the user next enters `list`:
+```
+1.[T][X]return book
+2.[D][ ]buy gifts (by: 24th December)
+3.[E][ ]job interview (from: 25th March 10am to: 11am)
+```
+
+### Deleting tasks: `delete`
+
+Removes the stored task, at the provided list position, from the task list.
+
+Format: `delete LIST_POSITION`
+
+>Please note that LIST_POSITION must be a numerical position within the bounds of the list.
+
+*Example input:*
+`delete 1`
+
+*Example Output:*
+```
+Noted. I've removed this task:
+[T][X]return book
+Now you have 2 tasks in the list.
+```
+The action of this command is also reflected when the user next enters `list`:
+```
+1.[D][ ]buy gifts (by: 24th December)
+2.[E][ ]job interview (from: 25th March 10am to: 11am)
+```
+
+### Exiting ChatMan: `bye`
+
+Terminates **ChatMan** execution.
+
+Format: `bye`
+
+*Output:*
+`Bye. Hope to see you again soon!`
+
+## Command Summary
+
+| Action                    | Command Format                                    |
+|---------------------------|---------------------------------------------------|
+| list tasks                | `list`                                            |
+| keyword/key-phrase search | `find KEYWORD`                                    |
+| add a todo                | `todo DESCRIPTION`                                |
+| add a deadline            | `deadline DESCRIPTION /by ENDPOINT`               |
+| add an event              | `event DESCRIPTION /from STARTPOINT /to ENDPOINT` |
+| mark a task as complete   | `mark LIST_POSITION`                              |
+| mark a task as incomplete | `unmark LIST_POSITION`                            |
+| delete a task             | `delete LIST_POSITION`                            |
+| exit                      | `bye`                                             |

src/main/java/chatman/ChatMan.java

@@ -0,0 +1,66 @@
+package chatman;
+
+import chatman.commands.GreetCommand;
+import chatman.exceptions.*;
+import chatman.storage.StorageHandler;
+import chatman.utility.Tasklist;
+import chatman.utility.Ui;
+
+
+import java.io.IOException;
+
+/**
+ * Provides entry point for ChatMan.
+ *
+ * @author LWachtel1
+ * */
+public class ChatMan {
+
+    private Ui chatbot;
+
+    public ChatMan() {
+        chatbot = new Ui();
+    }
+
+    /**
+     * Opens task storage file and loads file contents into list of stored tasks upon initial program execution.
+     * If successful, prints greeting for user and calls chatbot.read() to trigger ChatMan loop execution.
+     * Also provides handlers for any exceptions.
+     **/
+    public void run() {
+
+        try {
+            StorageHandler.openStorageFile();
+            StorageHandler.loadStorageFile();
+
+            GreetCommand hello = new GreetCommand(" ");
+            hello.perform();
+
+
+            chatbot.read();
+
+        } catch(IOException e) {
+            System.out.println(e.getMessage());
+        } catch (FalseCommandException e) {
+            e.sendErrorMsg();
+        } catch (FullListException e) {
+            e.sendErrorMsg();
+        } catch (IncorrectArgumentNumException e) {
+            e.sendErrorMsg();
+        } catch (IncorrectIndexException e) {
+            e.sendErrorMsg();
+        } catch (EmptyListException e) {
+            e.sendErrorMsg();
+        } catch (IncorrectFormatException e) {
+            e.sendErrorMsg();
+        }
+
+    }
+
+    /**
+     * Main method of program.
+     **/
+    public static void main(String[] args) {
+        new ChatMan().run();
+    }
+}

src/main/java/chatman/commands/ByeCommand.java

@@ -0,0 +1,39 @@
+package chatman.commands;
+
+import chatman.exceptions.IncorrectArgumentNumException;
+
+/**
+ * Implements functionality to enable ChatMan response to user-entered "bye" command.
+ *
+ * @author LWachtel1
+ * */
+public class ByeCommand extends Command{
+
+    /**
+     * Constructor for ByeCommand; invokes superclass constructor.
+     *
+     * @param userCommand Receives and stores user-entered command (from Parser object) to use in perform()
+     * method.
+     * */
+    public ByeCommand(String userCommand) {
+        super(userCommand);
+    }
+
+    /**
+     * Prints goodbye message for ChatMan user; called if they enter "bye" command with no arguments.
+     *
+     * @throws IncorrectArgumentNumException If "bye" command entered with any additional arguments.
+     */
+    @Override
+    public void perform() throws IncorrectArgumentNumException {
+        String[] fullCommand= userCommand.split(" ");
+        if (fullCommand.length > 1) {
+            String erroneousInput= userCommand.replaceAll("(?i)BYE", "");
+            throw new IncorrectArgumentNumException("BYE", erroneousInput);
+        }
+
+        System.out.printf("%s%n", "____________________________________________________________");
+        System.out.printf("%s%n", "Bye. Hope to see you again soon!");
+        System.out.printf("%s%n", "____________________________________________________________");
+    }
+}