[karishma-t] iP

README.md

@@ -1,24 +1,114 @@
-# Duke 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.
-
-## Setting up in Intellij
-
-Prerequisites: JDK 11, update Intellij to the most recent version.
-
-1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
-1. Open the project into Intellij as follows:
-   1. Click `Open`.
-   1. Select the project directory, and click `OK`.
-   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:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+
+# User Guide for Ken
+
+```
+K   K  EEEEE   N   N
+K  K   E       NN  N
+KKK    EEEE    N N N
+K  K   E       N  NN
+K   K  EEEEE   N   N
+```
+## Features 
+Ken is a CLI chatbot that helps you manage your tasks efficiently. Easily add and delete tasks, deadline and events, save them, and use Ken to manage them easily. 
+
+## Usage
+
+### `todo, deadline, event` - Add a Task 
+
+To add a task, use one of the following commands:
+
+- `todo [task description]`: Adds a todo task.
+- `deadline [task description] /by [deadline]`: Adds a deadline task, with when it is due by.
+- `event [task description] /from [start date] /to [end date]`: Adds an event task, with the duration of the event.
+
+#### Example of usage :
+
+`todo activity`
+
+`deadline project /by Friday`
+
+`event lunch /from 2pm /to 4pm`
+
+
+#### Expected outcome: 
+
+```
+Got it. I've added this task:
+   [T][ ] activity
+Now you have 1 tasks in the list.
+```
+```
+Got it. I've added this task:
+[D][ ] project  by: Friday
+Now you have 4 tasks in the list.
+```
+```
+Got it. I've added this task:
+[E][ ] lunch  from: 2pm to: 4pm
+Now you have 5 tasks in the list.
+```
+
+
+### `list` - Viewing all tasks
+
+To view a list of all your tasks and their corresponding information, use this command
+
+`list`
+
+#### Expected outcome:
+
+
+```
+Here are the tasks in your list:
+ 1.[T][ ] studying for test
+ 2.[D][ ] project by: Friday
+ 3.[E][ ] lunch from: 2pm to: 4pm
+```
+
+
+### `delete` - Removing tasks
+
+To delete a task, use the delete command followed by the task number:
+
+`delete 2`
+
+#### Expected outcome:
+
+
+```
+Got it. I've removed this task:
+   [D][ ] project by: Friday
+Now you have 2 tasks in the list.
+```
+### `find` - Searching for tasks by keywords
+
+To find a particular task and their corresponding information from the list by using any part of description, use this command
+
+`find lunch`
+
+#### Expected outcome:
+
+
+```
+Here are the matching tasks in your list:
+2. [E][ ] lunch ( from: 2pm to: 4pm )
+```
+
+
+### `mark` - Searching for tasks by keywords
+
+To mark a task as done, use the mark command followed by the task number:
+
+#### Example of usage :
+
+`mark 2`
+
+#### Expected outcome:
+
+```
+Nice! I've marked this task as done:
+ [X] lunch from: 2pm to: 4pm
+```
+
+
+

data/ken.txt

@@ -0,0 +1 @@
+T | 0 | it works!!!!!!

docs/README.md

@@ -1,29 +1,139 @@
-# User Guide
+# User Guide for Ken
 
+```
+K   K  EEEEE   N   N
+K  K   E       NN  N
+KKK    EEEE    N N N
+K  K   E       N  NN
+K   K  EEEEE   N   N
+```
 ## Features 
+Ken is a CLI chatbot that helps you manage your tasks efficiently. Easily add and delete tasks, deadline and events, save them, and use Ken to manage them easily. 
 
-### Feature-ABC
+- Add tasks of different types: Todo, Deadline, Event
+- List all your tasks
+- Mark tasks as done
+- Unmark tasks 
+- Delete tasks
+- Find tasks
 
-Description of the feature.
+## Usage
 
-### Feature-XYZ
+### `todo, deadline, event` - Add a Task 
 
-Description of the feature.
+To add a task, use one of the following commands:
 
-## Usage
+- `todo [task description]`: Adds a todo task.
+- `deadline [task description] /by [deadline]`: Adds a deadline task, with when it is due by.
+- `event [task description] /from [start date] /to [end date]`: Adds an event task, with the duration of the event.
+
+#### Example of usage :
+
+`todo activity`
+
+`deadline project /by Friday`
+
+`event lunch /from 2pm /to 4pm`
+
+
+#### Expected outcome: 
+
+```
+Got it. I've added this task:
+   [T][ ] activity
+Now you have 1 tasks in the list.
+```
+```
+Got it. I've added this task:
+[D][ ] project  by: Friday
+Now you have 4 tasks in the list.
+```
+```
+Got it. I've added this task:
+[E][ ] lunch  from: 2pm to: 4pm
+Now you have 5 tasks in the list.
+```
 
-### `Keyword` - Describe action
 
-Describe the action and its outcome.
+### `list` - Viewing all tasks
 
-Example of usage: 
+To view a list of all your tasks and their corresponding information, use this command
+
+`list`
 
-`keyword (optional arguments)`
+#### Expected outcome:
 
-Expected outcome:
 
-Description of the outcome.
+```
+Here are the tasks in your list:
+ 1.[T][ ] studying for test
+ 2.[D][ ] project by: Friday
+ 3.[E][ ] lunch from: 2pm to: 4pm
+```
+
+
+### `delete` - Removing tasks
+
+To delete a task, use the delete command followed by the task number:
+
+`delete 2`
+
+#### Expected outcome:
+
 
 ```
-expected output
+Got it. I've removed this task:
+   [D][ ] project by: Friday
+Now you have 2 tasks in the list.
 ```
+### `find` - Searching for tasks by keywords
+
+To find a particular task and their corresponding information from the list by using any part of description, use this command
+
+`find lunch`
+
+#### Expected outcome:
+
+
+```
+Here are the matching tasks in your list:
+2. [E][ ] lunch ( from: 2pm to: 4pm )
+```
+
+
+### `mark` - Marking tasks as completed
+
+To mark a task as done, use the mark command followed by the task number:
+
+#### Example of usage :
+
+`mark 2`
+
+#### Expected outcome:
+
+```
+Nice! I've marked this task as done:
+ [X] lunch from: 2pm to: 4pm
+```
+
+
+### `unmark` - Unmarking tasks as uncompleted
+
+To unmark a previously marked task, use the unmark command followed by the task number:
+
+#### Example of usage :
+
+`unmark 2`
+
+#### Expected outcome:
+
+```
+Nice! I've unmarked this task as done:
+ [ ] lunch from: 2pm to: 4pm
+```
+
+
+### `bye` - Terminating Ken 
+
+When you've finished organizing your tasks, simply enter 
+`bye`

ken.txt

@@ -0,0 +1,2 @@
+D | 1 | ip |  by: friday
+T | 0 | studying for test | null

pullreq1.txt

@@ -0,0 +1 @@
+Pull request 1

src/main/java/AddCommand.java

@@ -0,0 +1,86 @@
+public class AddCommand {
+    /**
+     * Handles the addition of a task to the task list.
+     *
+     * @param taskType        The type of the task (e.g., "T" for Todo).
+     * @param taskDescription The description of the task.
+     * @param taskList        The TaskList to which the task will be added.
+     * @throws EmptyDescriptionException If the task description is empty.
+     * @throws MissingInfoException      If required information is missing for a task type.
+     */
+    public static void AddTask(String taskType, String taskDescription, TaskList taskList) throws EmptyDescriptionException, MissingInfoException {
+        if (taskDescription.isEmpty()) {
+            throw new EmptyDescriptionException("Hey!! Description cannot be empty for a " + taskType + " task.");
+        }
+        taskType = taskType.substring(0, 1).toUpperCase();
+        String[] dateInfo = CommandParser.extractDateInfo(taskDescription);
+        if (isMissingInfo(taskType, dateInfo)) {
+            throw new MissingInfoException(taskType);
+        }
+        taskDescription = dateInfo[0];
+        addTaskToList(taskType, taskDescription, dateInfo[1], taskList);
+        displayTaskAddedMessage(taskType, taskDescription, dateInfo[1], taskList);
+    }
+
+    /**
+     * Checks if required information is missing for a task type.
+     *
+     * @param taskType The type of the task.
+     * @param dateInfo An array containing task description and date information.
+     * @return True if required information is missing, otherwise false.
+     */
+    private static boolean isMissingInfo(String taskType, String[] dateInfo) {
+        if (taskType.equals("D") && dateInfo[1] == null) {
+            return true;
+        } else return taskType.equals("E") && (dateInfo[1] == null || dateInfo[1].isEmpty());
+    }
+
+    /**
+     * Adds a task to the task list.
+     *
+     * @param taskType        The type of the task.
+     * @param taskDescription The description of the task.
+     * @param dateInfo        The date information for the task.
+     * @param taskList        The TaskList to which the task will be added.
+     */
+    private static void addTaskToList(String taskType, String taskDescription, String dateInfo, TaskList taskList) {
+        taskList.getTaskTypes().add(taskType);
+        taskList.getTaskDates().add(dateInfo);
+        taskList.getTaskDescriptions().add(taskDescription.trim());
+        taskList.getTaskDoneStatus().add(false);
+    }
+
+    /**
+     * Displays a message confirming the addition of a task.
+     *
+     * @param taskType        The type of the task.
+     * @param taskDescription The description of the task.
+     * @param dateInfo        The date information for the task.
+     * @param taskList        The TaskList to which the task was added.
+     */
+    private static void displayTaskAddedMessage(String taskType, String taskDescription, String dateInfo, TaskList taskList) {
+        System.out.println(" Got it. I've added this task:");
+        String dateInfoText = dateInfo != null ? " " + dateInfo : "";
+        System.out.println("   [" + taskType + "][ ] " + taskDescription + dateInfoText);
+        System.out.println(" Now you have " + taskList.getTaskDescriptions().size() + " tasks in the list.");
+    }
+
+    /**
+     * Handles adding a task and saves tasks after adding it.
+     *
+     * @param taskType        The type of the task (e.g., "T" for Todo).
+     * @param taskDescription The description of the task.
+     * @param taskList        The TaskList to which the task will be added.
+     * @throws KenException If there's an issue with the task or task list handling.
+     */
+    public static void handleAddTask(String taskType, String taskDescription, TaskList taskList) throws KenException {
+        AddTask(taskType, taskDescription, taskList);
+        Storage.saveTasks(taskList); // Save tasks after deleting
+    }
+
+    public static class MissingInfoException extends KenException {
+        public MissingInfoException(String taskType) {
+            super("Hey!! Don't leave the description or date empty for a " + taskType + " task.");
+        }
+    }
+}