imaginarys96 iP

docs/README.md

@@ -1,29 +1,194 @@
 # User Guide
+The Chatbot name is very intuitive - Chatbot.
 
 ## Features 
+1. list
+2. mark
+3. unmark
+4. todo
+5. deadline
+6. event
+7. delete
+8. find
+
+### Feature-list
+List all tasks
+### Feature-mark
+Mark a task as done
+### Feature-unmark
+Unmark a task as done
+### Feature-todo
+Add a todo
+### Feature-deadline
+Add a deadline
+### Feature-event
+Add an event
+### Feature-delete
+Delete a task
+### Feature-find
+Find a task
 
-### Feature-ABC
 
-Description of the feature.
 
-### Feature-XYZ
 
-Description of the feature.
 
 ## Usage
 
-### `Keyword` - Describe action
+### `list` - list all tasks
+List all the tasks recorded
+
+Command: `list`
+
+Argument: Nil
+
+Example: `list`
+
+Example of outcome:
+
+    Tasks are listed
+```
+    ____________________________________________________________
+     Here are the tasks in your list:
+     1.[T][X] read book
+     2.[D][ ] return book (by: June 6th)
+     3.[E][ ] project meeting (from: Aug 6th 2pm to: 4pm)
+     4.[T][X] join sports club
+     5.[T][ ] borrow book
+    ____________________________________________________________
+```
+
+### `mark` - mark a task
+Command: `mark`
+
+Argument: <int> ID of the task
+
+Example: `mark 1`
+
+Example of outcome:
+
+    Task is marked as done
+
+```
+____________________________________________________________
+ Nice! I've marked this task as done:
+   [X] borrow new book
+____________________________________________________________
+```
+
+### `unmark` - unmark a task
+Mark a task as done
 
-Describe the action and its outcome.
+Command: `unmark`
 
-Example of usage: 
+Argument: <int> ID of the task
 
-`keyword (optional arguments)`
+Example: `unmark 1`
 
-Expected outcome:
+Example of outcome:
 
-Description of the outcome.
+    Task is unmarked
 
 ```
-expected output
+____________________________________________________________
+ OK, I've marked this task as not done yet:
+   [ ] borrow new book
+____________________________________________________________
+```
+
+### `todo` - add a todo
+
+Command: `todo`
+
+Argument: <String> description of the task
+
+Example: `todo borrow book`
+
+Example of outcome:
+
+    Todo is added
+
+```
+    ____________________________________________________________
+     Got it. I've added this task:
+       [T][ ] borrow book
+     Now you have 5 tasks in the list.
+    ____________________________________________________________
+```
+
+### `deadline` - add a deadline
+
+Command: `deadline`
+
+Argument: <String> description of the deadline
+
+Example: `deadline return book /by Sunday`
+
+Example of outcome:
+
+    Deadline is added
+
+```
+    ____________________________________________________________
+     Got it. I've added this task:
+       [D][ ] return book (by: Sunday)
+     Now you have 6 tasks in the list.
+    ____________________________________________________________
+```
+
+### `event` - add an event
+
+Command: `event`
+
+Argument: <String> description of the event
+
+Example: `event project meeting /from Mon 2pm /to 4pm`
+
+Example of outcome:
+
+    Event is added
+
+```
+    ____________________________________________________________
+     Got it. I've added this task:
+       [E][ ] project meeting (from: Mon 2pm to: 4pm)
+     Now you have 7 tasks in the list.
+    ____________________________________________________________
+```
+### `delete` - delete a task
+
+Command: `delete`
+
+Argument: <int> ID of the task to delete
+
+Example: `delete 1`
+
+Example of outcome:
+
+    Task is deleted
+
+```
+    ____________________________________________________________
+     Noted. I've removed this task:
+       [E][ ] project meeting (from: Aug 6th 2pm to: 4pm)
+     Now you have 4 tasks in the list.
+    ____________________________________________________________
+```
+
+### `find` - find a task
+Command: `find`
+
+Argument: `String` What to search for
+
+Example: `find book`
+
+Example of outcome:
+
+    book is found
+
 ```
+____________________________________________________________
+ Here are the matching tasks in your list:
+   [T][ ] borrow book
+   [T][ ] borrow new book
+____________________________________________________________
+```

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

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: chatbot.Chatbot
+

src/main/java/chatbot/Chatbot.java

@@ -0,0 +1,65 @@
+package chatbot;
+
+import chatbot.command.Command;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Scanner;
+
+public class Chatbot {
+    private Storage storage;
+    private Parser parser;
+    private Ui ui;
+    private TaskList taskList;
+
+    public Chatbot() {
+        this.ui = new Ui();
+        this.storage = new Storage("./tasklist.txt");
+        this.parser = new Parser();
+        this.taskList = new TaskList();
+    }
+
+
+    /**
+     * Runs the main routine of the app
+     *
+     * @author  Jeremy
+     * @since   2023-10-06
+     */
+    public void run() throws IOException {
+        this.ui.showGreetingMessage();
+
+        ArrayList<String> lines = storage.parseFile(this.taskList.getTaskList());
+        for(String line : lines) {
+            try {
+                Command c = this.parser.parseCommand(line);
+                c.execute(this.taskList.getTaskList(), false);
+            } catch(ChatbotUnknownCommandException | ChatbotEmptyDescException e) {
+                this.ui.showError(e.getMessage(), true);
+                continue;
+            } catch (Exception e) {
+                this.ui.showError(e.getMessage(), false);
+            }
+        }
+
+        Scanner in = new Scanner(System.in);
+        String input = "";
+        while(!input.equals("bye")) {
+            try{
+                input = in.nextLine();
+                Command c = this.parser.parseCommand(input);
+                c.execute(this.taskList.getTaskList(), true);
+            } catch(ChatbotUnknownCommandException | ChatbotEmptyDescException e) {
+                this.ui.showError(e.getMessage(), true);
+                continue;
+            } catch (Exception e) {
+                this.ui.showError(e.getMessage(), false);
+            }
+        }
+        this.ui.showByeMessage();
+    }
+
+    public static void main(String[] args) throws Exception {
+        new Chatbot().run();
+    }
+}

src/main/java/chatbot/ChatbotEmptyDescException.java

@@ -0,0 +1,7 @@
+package chatbot;
+
+public class ChatbotEmptyDescException extends Exception {
+    public ChatbotEmptyDescException(String exceptionMsg) {
+        super(exceptionMsg);
+    }
+}

src/main/java/chatbot/ChatbotUnknownCommandException.java

@@ -0,0 +1,7 @@
+package chatbot;
+
+public class ChatbotUnknownCommandException extends Exception {
+    public ChatbotUnknownCommandException(String exceptionMsg) {
+        super(exceptionMsg);
+    }
+}

src/main/java/chatbot/Deadline.java

@@ -0,0 +1,15 @@
+package chatbot;
+
+public class Deadline extends Task {
+    protected String by;
+
+    public Deadline(String description, String by) {
+        super(description);
+        this.by = by;
+    }
+
+    @Override
+    public String toString() {
+        return "[D]" + super.toString() + " (by: " + by + ")";
+    }
+}

src/main/java/chatbot/Event.java

@@ -0,0 +1,16 @@
+package chatbot;
+
+public class Event extends Task {
+    protected String fromDate;
+    protected String toDate;
+    public Event(String description, String fromDate, String toDate) {
+        super(description);
+        this.fromDate = fromDate;
+        this.toDate = toDate;
+    }
+
+    @Override
+    public String toString() {
+        return "[E]" + super.toString() + " (from: " + this.fromDate + " to: " + this.toDate + ")";
+    }
+}

src/main/java/chatbot/Parser.java

@@ -0,0 +1,35 @@
+package chatbot;
+
+import chatbot.command.*;
+
+public class Parser {
+    /**
+     * Parse the command and returns a Command object
+     *
+     * @param   input       The input to be parsed
+     * @author  Jeremy
+     * @since   2023-10-06
+     */
+    public Command parseCommand(String input) throws ChatbotUnknownCommandException {
+        if (input.equals("list")) {
+            return new ListCommand("list", input);
+        } else if (input.startsWith("mark ")) {
+            return new MarkCommand("mark", input);
+        } else if (input.startsWith("unmark ")) {
+            return new UnmarkCommand("unmark", input);
+        } else if (input.startsWith("todo")) {
+            return new TodoCommand("todo", input);
+        } else if (input.startsWith("deadline")) {
+            return new DeadlineCommand("deadline", input);
+        } else if (input.startsWith("event")) {
+            return new EventCommand("event", input);
+        } else if (input.startsWith("delete")) {
+            return new DeleteCommand("delete", input);
+        } else if (input.startsWith("find")) {
+            return new FindCommand("find", input);
+        } else {
+            // unknown command
+            throw new ChatbotUnknownCommandException(" ☹ OOPS!!! I'm sorry, but I don't know what that means :-(");
+        }
+    }
+}