[janelleenqi] iP

.gitignore

@@ -15,3 +15,8 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+/src/main/java/META-INF
+
+/data
+/data/memory.txt

docs/README.md

@@ -1,29 +1,209 @@
-# User Guide
+# User Guide for Luke
 
 ## Features 
 
-### Feature-ABC
+### Task List
 
-Description of the feature.
+Luke keeps a task list of all the todo, deadlines and events.
 
-### Feature-XYZ
+### Mark as Completed/Incomplete
 
-Description of the feature.
+You can mark tasks as completed or incompleted.
+
+### Store Memory
+
+When closing Luke, all current tasks are stored in a txt file.
+The next time Luke is opened, all tasks in the txt file is loaded back into Luke.
 
 ## Usage
 
-### `Keyword` - Describe action
 
-Describe the action and its outcome.
+### `todo` - Add todo
+
+Add new task (todo) to your list.
+
+Format of usage:
+
+`todo DESCRIPTION`
+
+Example of usage:
+
+`todo read book`
+
+Expected outcome:
+
+New todo task added, so there will be a confirmation message.
+
+```
+    Got it. I've added this task:
+    [T][ ] read book
+    Now you have 1 tasks in the list.
+```
+
+### `deadline` - Add deadline
+
+Add new task (deadline) to your list.
+
+Format of usage:
+
+`deadline DESCRIPTION /by DATE`
+
+Example of usage:
+
+`deadline return book /by next saturday`
+
+Expected outcome:
+
+New deadline task added, so there will be a confirmation message.
+
+```
+    Got it. I've added this task:
+    [D][ ] return book (do by: next saturday)
+    Now you have 2 tasks in the list.
+```
+
+### `event` - Add event
+
+Add new task (event) to your list.
+
+Format of usage:
+
+`event DESCRIPTION /from STARTDATE /to ENDDATE`
+
+Example of usage:
+
+`event reading club session /from friday 4 /to 6pm`
+
+Expected outcome:
+
+New event task added, so there will be a confirmation message.
+
+```
+    Got it. I've added this task:
+    [E][ ] reading club session (from: friday 4 to: 6pm)
+    Now you have 1 tasks in the list.
+```
+
+### `list` - Lists all tasks
+
+Lists all tasks in the task list.
 
 Example of usage: 
 
-`keyword (optional arguments)`
+`list`
+
+Expected outcome:
+
+This will display all your tasks, including their type (todo, deadline, event), their task description and their status (completed or not).
+
+```
+    Here are the tasks in your list:
+    1.	[T][ ] read book
+    2.	[D][ ] return book (do by: next saturday)
+    3.	[E][ ] reading club session (from: friday 4 to: 6pm)
+```
+
+### `mark` - Mark a task as completed
+
+Mark a task as completed using the "mark" command followed by the task number.
+
+Format of usage:
+
+`mark INDEX`
+
+Example of usage:
+
+`mark 1`
+
+Expected outcome:
+
+This will mark the task with index 1 as completed.
+
+```
+    Woohoo! You have accomplished:
+    [T][X] read book
+```
+
+### `unmark` - Mark a task as incomplete
+
+Mark a task as incomplete using the "unmark" command followed by the task number.
+
+Format of usage:
+
+`unmark INDEX`
+
+Example of usage:
+
+`unmark 1`
+
+Expected outcome:
+
+This will mark the task with index 1 as incomplete.
+
+```
+    HA! You still have to complete:
+    [T][ ] read book
+```
+
+
+### `find` - Find user's input in tasks descriptions
+
+Show the corresponding tasks.
+
+Format of usage:
+
+`find KEYWORD`
+
+Example of usage:
+
+`find book`
+
+Expected outcome:
+
+List of tasks that have descriptions matching the user's input.
+
+```
+    Here are the matching tasks in your list:
+    1.	[T][ ] read book
+    2.	[D][ ] return book (do by: next saturday)
+```
+
+### `delete` - Remove a task from the task list
+
+To delete a task from your list, use the "delete" command followed by the task number.
+
+Format of usage:
+
+`delete INDEX`
+
+Example of usage:
+
+`delete 2`
+
+Expected outcome:
+
+This will remove the task with index 2 from your list.
+
+
+```
+    Noted. I've removed this task:
+    [D][ ] return book (do by: next saturday)
+    Now you have 2 tasks in the list.
+```
+
+### `bye` - Close Luke
+
+Close Luke and store memory to a txt file.
+
+Example of usage:
+
+`bye`
 
 Expected outcome:
 
-Description of the outcome.
+Message whether memory is stored safely, and Luke is closed.
 
 ```
-expected output
+    Memory Stored Safely!
+    Bye. Hope to see you again soon!
 ```

src/main/java/Luke.java

@@ -0,0 +1,71 @@
+
+import luke.actions.*;
+import luke.user.LukeException;
+import luke.user.Ui;
+import luke.tasks.*;
+import luke.files.*;
+
+/**
+ * The Luke Class represents the main application class for Luke, a task management application.
+ * It initializes the user interface, task storage and task list.
+ * It runs the application loop, managing the user interface, task storage, and task list.
+ */
+public class Luke {
+    public static final String folderPath = "data";
+
+    private Storage storage;
+    private TaskList tasks;
+    private Ui ui;
+
+    /**
+     * Constructs a Luke object.
+     */
+    public Luke() {
+        ui = new Ui();
+        storage = new Storage(folderPath);
+        try {
+            tasks = new TaskList(storage.load());
+        } catch (LukeException e) {
+            ui.showLoadingError();
+            tasks = new TaskList();
+        } catch (NullPointerException e) {
+            //ui.showNoMemoryFileError();
+            tasks = new TaskList();
+        }
+    }
+
+    /**
+     * Runs the Luke application.
+     * It displays a welcome message, reads user commands, and executes corresponding actions.
+     * The application continues running until the user exits.
+     */
+    public void run() {
+        ui.showWelcome();
+        boolean isExit = false;
+        while (!isExit) {
+            try {
+                String fullCommand = ui.readCommand();
+                ui.showLine(); // show the divider line ("_______")
+                Command c = Parser.parse(fullCommand);
+                //c has theActionWord and parameters
+                c.execute(tasks, ui, storage);
+                //tasks has ArrayList<Task> mainTaskList, ui has String echo, storage has ArrayList<Task> tasks
+                isExit = c.isExit(); //for bye command
+            } catch (LukeException e) { //from Parser.parse
+                ui.showError("\t☹ An error occurred." + e.getMessage());
+            } finally {
+                ui.showLine();
+            }
+        }
+    }
+
+    /**
+     * The main method that starts the Luke application.
+     *
+     * @param args The command-line arguments (not used in this application).
+     */
+    public static void main(String[] args) {
+        new Luke().run();
+    }
+}
+

src/main/java/luke/actions/ActionType.java

@@ -0,0 +1,9 @@
+package luke.actions;
+
+/**
+ * The ActionType enum represents the various types of actions that can be performed in the LukeTime application.
+ * Each action corresponds to a specific user command.
+ */
+public enum ActionType {
+    LIST, FIND, MARK, UNMARK, TODO, DEADLINE, EVENT, DELETE, BYE
+}

src/main/java/luke/actions/AddCommand.java

@@ -0,0 +1,67 @@
+package luke.actions;
+
+import luke.files.Storage;
+import luke.tasks.*;
+import luke.user.LukeException;
+import luke.user.Ui;
+
+import static luke.actions.ActionType.*;
+
+/**
+ * The AddCommand Class represents a command for adding a task to the Luke application.
+ * It extends the Command class and includes specific behavior for adding different types of tasks.
+ */
+public class AddCommand extends Command {
+
+    /**
+     * The latest task created as a result of the add command.
+     */
+    private Task latestTask;
+
+    /**
+     * Constructs an AddCommand with the specified action type and parameters.
+     *
+     * @param theAction   The action type (TODO, DEADLINE, EVENT).
+     * @param parameters  The parameters provided with the command (task description or task details).
+     * @throws LukeException If there are missing or invalid arguments for creating the task.
+     */
+    public AddCommand(ActionType theAction, String parameters) throws LukeException {
+
+        super(theAction, parameters);
+        if (theAction == TODO) {
+            latestTask = new Todo(parameters);
+        }
+        if (theAction == DEADLINE) {
+            try {
+                latestTask = new Deadline(parameters);
+            } catch (LukeException e) {
+                System.out.println("\t☹ OOPS!!! You have missing/invalid arguments for deadline. No changes have been made.");
+                throw new LukeException();
+            }
+        }
+        if (theAction == EVENT) {
+            try {
+                latestTask = new Event(parameters);
+            } catch (LukeException e) {
+                System.out.println("\t☹ OOPS!!! You have missing/invalid arguments for event. No changes have been made.");
+                throw new LukeException();
+            }
+        }
+
+    }
+
+    /**
+     * Executes the AddCommand to add the latest task to the task list.
+     *
+     * @param tasks    The task list to which the task will be added.
+     * @param ui       The user interface for displaying messages.
+     * @param storage  The storage for saving task changes (not used in this case).
+     */
+    @Override
+    public void execute(TaskList tasks, Ui ui, Storage storage) {
+        tasks.addTask(latestTask);
+
+        System.out.println("\tGot it. I've added this task:" + "\n" + tasks.get(tasks.size() - 1));
+        System.out.println("\tNow you have " + tasks.size() + " tasks in the list.");
+    }
+}