[Nigel Yeo] iP

.gitignore

@@ -3,6 +3,8 @@
 /out/
 /*.iml
 
+*.class
+
 # Gradle build files
 /.gradle/
 /build/
@@ -14,4 +16,3 @@ src/main/resources/docs/
 bin/
 
 /text-ui-test/ACTUAL.TXT
-text-ui-test/EXPECTED-UNIX.TXT

docs/README.md

@@ -1,30 +1,145 @@
-# Duke User Guide
+# Legin User Guide
 
-// Update the title above to match the actual product name
+Legin is a command line chat bot that helps users with their daily tracking of tasks, these tasks includes various types such as Todo, Deadline and Event types. The bot is able to store these data and retrieve where the user last left off, allowing continuous usage of the bot from day to day.
 
-// Product screenshot goes here
+## Quick Start
 
-// Product intro goes here
+1. Ensure you have Java ```17``` or above installed in your Computer.
+2. Download the latest ```.jar``` file from [here](https://github.com/NigelYeoTW/ip/releases).
+3. Copy the file to the folder you want to use as the home folder for Legin. Note that the data storage text file will also be created in this folder.
+4. Open a command terminal, ```cd``` into the folder you put the jar file in, and use the ```java -jar ip.jar``` command to run the application.
+   The following should be displayed in your command line upon successfully starting up Legin 
+   ![image](https://github.com/user-attachments/assets/d37c981f-5a60-4824-896b-45a59795157b)
+   Note that the file path displayed will be your specific file path where you store the jar file
+5. Type some of these commands into the command line and press Enter to execute it
+   Here are some of the commands you can try:
+   + ```list```: List all tasks you have with indexes
+   + ```todo read up CS2113 Tutorial 2```: Adds a Todo task into your task list with description 'read up CS2113 Tutorial 2'
+   + ```mark 3```: Marks the 3rd task in the list as done
+   + ```delete 5```: Deletes the 5th task in the task list
+   + ```find homework```: Search through the task list and outputs all the task that have 'homework' in their description
+   + ```bye```: Terminates Legin
+6. Refer to the [Features](#features) below for details of each command.
 
-## Adding deadlines
+## Features
 
-// Describe the action and its outcome.
+### Adding a Todo task: ```todo```
 
-// Give examples of usage
+Adds a Todo task to the task list. <br />
+Format: ```todo TASK_DESCRIPTION``` <br />
+Example: 
++ ```todo Water the plants``` <br />
+  The following would be seen on the terminal if done correctly:
+  ![image](https://github.com/user-attachments/assets/777aa717-3c10-4e65-a484-79ec87161220)
 
-Example: `keyword (optional arguments)`
 
-// A description of the expected outcome goes here
+### Adding a Deadline task: ```deadline```
 
-```
-expected output
-```
+Adds a task that has a deadline to the task list. <br />
+Format: ```deadline TASK_DESCRIPTION /by DEADLINE``` <br />
+Example:
++ ```deadline submit quiz 1 /by 27 October 4pm``` <br />
+  The following would be seen on the terminal if done correctly:
+  ![image](https://github.com/user-attachments/assets/ad576583-c6d2-49ab-9cbe-867826817688)
+
+Note: Users are to adhere to the space after ```TASK_DESCRIPTION``` and ```/by``` to prevent unexpected behavior
 
-## Feature ABC
+### Adding a Event task: ```event```
 
-// Feature details
+Adds a event that has a duration period into the task list. <br />
+Format: ```event EVENT_DESCRIPTION /from EVENT_START /to EVENT_END``` <br />
+Example:
++ ```event Meet friend at Yishun /from 18 October 9pm /to 18 October 11pm``` <br />
+  The following would be seen on the terminal if done correctly:
+  ![image](https://github.com/user-attachments/assets/2ac2d029-b1fe-4083-9835-0e599d41f0e9)
+
+Note: Users are to adhere to the space after ```EVENT_DESCRIPTION```, ```/from``` and ```/to``` to prevent unexpected behavior
 
 
-## Feature XYZ
+### Marking a task: ```mark```
 
-// Feature details
+Marks a tasks in the task list by its index as done. Index of task can be obtained by using the ```list``` command. <br />
+Format: ```mark INDEX``` <br />
+Example:
++ ```mark 3```
+
+Note: ```INDEX``` should be displayed in task list when ```list``` is called
+
+
+### Unmarking a task: ```unmark```
+
+Unmarks a task in the task list by its index as undone. Index of task can be obtained by using the ```list``` command. <br />
+Format: ```unmark INDEX``` <br />
+Example:
++ ```unmark 5```
+
+Note: ```INDEX``` should be displayed in task list when ```list``` is called
+
+
+### Listing all tasks: ```list```
+
+Lists out all the tasks in the task list. <br />
+Format: ```list```
+
+
+### Deleting a task: ```delete```
+
+Deletes a task in the task list by it index. Index of task can be obtained by using the ```list``` command. <br />
+Format: ```delete INDEX``` <br />
+Note: ```INDEX``` should be displayed in task list when ```list``` is called
+
+
+### Find task by description: ```find```
+
+Finds all tasks with description that matches the given keyword by user <br />
+Format: ```find KEYWORD [MORE_KEYWORDS]...``` <br />
+Example: 
++ ```find tutorial``` returns ```tutorial 4```, ```math tutorial```, ```english tutorial 6```
++ ```find jurong west``` returns ```meeting at jurong west```, ```jurong west cafe```
++ ```find real``` returns ```really good cafe```, ```surreal theme park at Hougang```
+
+Note:
++ Keywords used are case sensitive
++ Keywords can be partial words of a full word
++ Keywords should only be used to match task desciption, task type should be ommited
+
+
+### Terminating Legin: ```bye```
+
+Terminates program. <br />
+Format: ```bye``` <br />
+Note: User should not close the application before using this command to avoid unsaved data from current window
+
+
+### Saving the data
+Data will be saved in a text file where the ```.jar``` file is stored with file name ```tasklist.txt``` <br />
+Data will be saved upon termination of the program with ```bye```
+
+
+### Editting the data file 
+Data is stored in the form of:
++ 'TASK_TYPE\|IS_TASK_DONE\|TASK_DESCRIPTION' for Todo tasks <br />
++ 'TASK_TYPE\|IS_TASK_DONE\|TASK_DESCRIPTION\|DUEDATE' for Deadline tasks <br />
++ 'TASK_TYPE\|IS_TASK_DONE\|TASK_DESCRIPTION\|TIME_START\|TIME_END' for Event tasks <br />
+Each line stores data for only one task
+
+The following are some fixed parameters: 
+TASK_TYPE:
++ 'T' - Todo task
++ 'D' - Deadline task
++ 'E' - Event task
+
+IS_TASK_DONE:
++ 'true' - marks task as done
++ 'false' - marks task as undone
+
+## Command Summary
++ Action|Format, Examples
+  Add Todo task|```todo TASK_DESCRIPTION``` <br /> eg. ```todo Water the plants```
+  Add Deadline task|```deadline TASK_DESCRIPTION /by DEADLINE``` <br /> eg. ```deadline submit quiz 1 /by 27 October 4pm```
+  Add Event task|```event EVENT_DESCRIPTION /from EVENT_START /to EVENT_END``` <br /> eg. ```event Meet friend at Yishun /from 18 October 9pm /to 18 October 11pm```
+  Mark task as done|```mark INDEX``` <br /> eg. ```mark 3```
+  Mark task as undone|```unmark INDEX``` <br /> eg. ```unmark 5```
+  List all tasks|```list```
+  Delete task|```delete INDEX```
+  Find task|```find KEYWORD [MORE_KEYWORDS]...``` <br /> eg . ```find jurong west```

src/main/java/Legin.java

@@ -0,0 +1,42 @@
+import parser.Parser;
+import storage.Storage;
+import task.TaskList;
+import ui.Ui;
+
+/**
+ * Represents the command line bot that helps stores your tasks.
+ * Functionalities include adding, deleting, finding and marking tasks as well as categorise them into todo, deadline
+ * and event.
+ * <p>
+ * User input should follow the following: [command][arg...]
+ */
+public class Legin {
+    private final TaskList taskList;
+    private final Storage storage;
+    private final Ui ui = new Ui();
+    private final Parser parser = new Parser();
+
+    private Legin() {
+        storage = new Storage();
+        taskList = storage.getloadedTaskList();
+    }
+
+    private void runBot() {
+        boolean hasSaidBye = false;
+        ui.greet();
+        while (!hasSaidBye) {
+            String input = ui.readInput();
+            hasSaidBye = parser.parseInput(taskList, input);
+        }
+        storage.updateTextFile(taskList);
+        ui.exiting();
+    }
+
+    /**
+     * Initialises the bot and start running the bot until the user terminates it
+     */
+    public static void main(String[] args) {
+        Legin legin = new Legin();
+        legin.runBot();
+    }
+}

src/main/java/META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: Legin
+

src/main/java/exception/LeginEmptyTaskException.java

@@ -0,0 +1,11 @@
+package exception;
+
+/**
+ * Signals that the task the user input has no description
+ */
+public class LeginEmptyTaskException extends LeginException{
+    private static final String ERROR_MESSAGE = "BROO! No task description is given!";
+    public LeginEmptyTaskException() {
+        super(ERROR_MESSAGE);
+    }
+}

src/main/java/exception/LeginException.java

@@ -0,0 +1,10 @@
+package exception;
+
+/**
+ * Serves as a general class for all Legin exceptions
+ */
+public class LeginException extends Exception{
+    public LeginException(String errorMessage) {
+        super(errorMessage);
+    }
+}

src/main/java/exception/LeginIndexOutOfBoundsException.java

@@ -0,0 +1,12 @@
+package exception;
+
+/**
+ * Signals that the index the user input is out of the range of the task list array
+ */
+public class LeginIndexOutOfBoundsException extends LeginException{
+    private static final String ERROR_MESSAGE = "BROO! No such task index!";
+    public LeginIndexOutOfBoundsException() {
+        super(ERROR_MESSAGE);
+    }
+}
+

src/main/java/exception/LeginInvalidCommandException.java

@@ -0,0 +1,11 @@
+package exception;
+
+/**
+ * Signals that the user has input a command that does not exist
+ */
+public class LeginInvalidCommandException extends LeginException{
+    private static final String ERROR_MESSAGE = "BROO! No such command!";
+    public LeginInvalidCommandException() {
+        super(ERROR_MESSAGE);
+    }
+}

src/main/java/exception/LeginMissingParamsException.java

@@ -0,0 +1,12 @@
+package exception;
+
+/**
+ * Signals that the user failed to input all arguments required for the type of task <br>
+ * Usually thrown due to missing time stamps or duration in input
+ */
+public class LeginMissingParamsException extends LeginException {
+    private static final String ERROR_MESSAGE = "BROO! Missing Parameters!";
+    public LeginMissingParamsException() {
+        super(ERROR_MESSAGE);
+    }
+}

src/main/java/parser/Parser.java

@@ -0,0 +1,78 @@
+package parser;
+import exception.LeginIndexOutOfBoundsException;
+import exception.LeginInvalidCommandException;
+import task.TaskList;
+import ui.Ui;
+
+/**
+ * Pulls command from user input and calling {@code TaskList} methods to execute them
+ */
+public class Parser {
+    private static final int COMMAND_INDEX = 0;
+    private static final int INDEX_TO_MARK = 1;
+    private final Ui ui = new Ui();
+
+    private void checkIndexValidity(TaskList tasklist, int index) throws LeginIndexOutOfBoundsException {
+        if (index > tasklist.getTaskCount()) {
+            throw new LeginIndexOutOfBoundsException();
+        }
+    }
+
+    private boolean selectCommand(TaskList taskList, String command, String[] words, String input) {
+        int indexOfTaskToMark;
+        try {
+            switch (command) {
+            case "bye":
+                return true;
+            case "list":
+                taskList.listAllTask();
+                break;
+            case "mark":
+                indexOfTaskToMark = Integer.parseInt(words[INDEX_TO_MARK]);
+                checkIndexValidity(taskList, indexOfTaskToMark);
+                taskList.markTask(indexOfTaskToMark);
+                break;
+            case "unmark":
+                indexOfTaskToMark = Integer.parseInt(words[INDEX_TO_MARK]);
+                checkIndexValidity(taskList, indexOfTaskToMark);
+                taskList.unmarkTask(indexOfTaskToMark);
+                break;
+            case "todo":
+                taskList.addTodo(input);
+                break;
+            case "deadline":
+                taskList.addDeadline(input);
+                break;
+            case "event":
+                taskList.addEvent(input);
+                break;
+            case "delete":
+                int indexOfTaskToDelete = Integer.parseInt(words[1]);
+                checkIndexValidity(taskList, indexOfTaskToDelete);
+                taskList.deleteTask(indexOfTaskToDelete);
+                break;
+            case "find":
+                taskList.findAllMatchingTask(input);
+                break;
+            default:
+                throw new LeginInvalidCommandException();
+            }
+        } catch (LeginInvalidCommandException | LeginIndexOutOfBoundsException e) {
+            ui.printExceptionMessage(e);
+        }
+        return false;
+    }
+
+    /**
+     * Parse the user input and retrieves the command, calling {@code selectCommand} to execute the command
+     *
+     * @param taskList Contains all information of current tasks
+     * @param input User input into command line
+     * @return {@code true} if the user command is bye
+     */
+    public boolean parseInput(TaskList taskList, String input) {
+        String[] wordsOfInput = input.split(" ");
+        String command = wordsOfInput[COMMAND_INDEX];
+        return selectCommand(taskList, command, wordsOfInput, input);
+    }
+}