[nihalzp] iP

.gitignore

@@ -15,3 +15,6 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+# Data files
+/data/

docs/README.md

@@ -1,29 +1,108 @@
-# User Guide
+# Python User Guide
+
+**Python** task manager will be a blessing for users with fast typing speed. You can
+add three types of tasks, mark tasks as completed, delete tasks, and if necessary
+find tasks using a keyword!
 
 ## Features 
+Python comes with the following core features:
+* [Add Todo](#add-todo)
+* [Add Deadline](#add-deadline)
+* [Add Event](#add-event)
+* [Mark Task](#mark-task)
+* [Unmark Task](#unmark-task)
+* [Delete Task](#delete-task)
+* [Find Tasks](#find-tasks)
+* [List Tasks](#list-tasks)
+* [Exit](#exit-program)
+
+### Add Todo
+Format:
+`todo [todo description]`
+
+Example of usage:
+`todo buy groceries`
+
+Add a simple todo!
+
+### Add Deadline
+
+Format:
+`deadline [deadline description] /by [due date]`
+
+Example of usage:
+`deadline lab 2 /by friday night`
+
+Add a deadline with due date!
+
+
+### Add Event
+
+Format:
+`event [event description] /from [start date] /to [end date]`
+
+Example of usage:
+`event math exam /from monday 2pm /to monday 4pm`
+
+Add an event to keep track of both start and end times of an activity!
+
+### Mark Task
+
+Format:
+`mark [index of the task - 1 based]`
+
+Example of usage:
+`mark 1`
+
+Mark the task at index as done!
+
+### Unmark Task
+
+Format:
+`unmark [index of the task - 1 based]`
+
+Example of usage:
+`unmark 1`
+
+Unmark the task at index as not done yet!
+
+### Delete Task
+
+Format:
+`delete [index of the task - 1 based]`
+
+Example of usage:
+`delete 1`
+
+Delete the task at the index!
+
+### Find Tasks
 
-### Feature-ABC
+Format:
+`find [keyword]`
 
-Description of the feature.
+Example of usage:
+`find exam`
 
-### Feature-XYZ
+List the tasks that contains the keyword in the description!
 
-Description of the feature.
+### List Tasks
 
-## Usage
+Format:
+`list`
 
-### `Keyword` - Describe action
+Example of usage:
+`list`
 
-Describe the action and its outcome.
+List all the tasks along with completion status and task type!
 
-Example of usage: 
+### Exit Program
 
-`keyword (optional arguments)`
+Format:
+`bye`
 
-Expected outcome:
+Example of usage:
+`bye`
 
-Description of the outcome.
+Greet Python 'bye' to exit the program!
 
-```
-expected output
-```

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

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: python.Python
+

src/main/java/python/Python.java

@@ -0,0 +1,21 @@
+package python;
+
+import python.exception.PythonException;
+import python.ui.Ui;
+
+public class Python {
+    static final private Ui ui = new Ui();
+
+    public static void main(String[] args) {
+        ui.welcomeUser();
+        do {
+            ui.getUserInput();
+            try {
+                ui.parseLine();
+                ui.executeLine();
+            } catch (PythonException e) {
+                ui.displayException(e);
+            }
+        } while (!ui.isExit());
+    }
+}

src/main/java/python/exception/PythonException.java

@@ -0,0 +1,7 @@
+package python.exception;
+
+public class PythonException extends Exception {
+    public PythonException(String errorMessage) {
+        super(errorMessage);
+    }
+}

src/main/java/python/parser/Command.java

@@ -0,0 +1,26 @@
+package python.parser;
+
+/**
+ * Defines the commands expected from the user
+ */
+public class Command {
+    public static final String COMMAND_BYE = "bye";
+    public static final String COMMAND_LIST = "list";
+    public static final String COMMAND_MARK = "mark";
+    public static final String COMMAND_UNMARK = "unmark";
+    public static final String COMMAND_DELETE = "delete";
+    public static final String COMMAND_TODO = "todo";
+    public static final String COMMAND_DEADLINE = "deadline";
+    public static final String COMMAND_EVENT = "event";
+    public static final String COMMAND_FIND = "find";
+
+    /**
+     * Returns whether the given command is "bye" command or not
+     *
+     * @param command The command to check
+     * @return Returns whether the given command is "bye" command or not
+     */
+    public static boolean isCommandBye(String command) {
+        return (command.equals(COMMAND_BYE));
+    }
+}

src/main/java/python/parser/Parser.java

@@ -0,0 +1,126 @@
+package python.parser;
+
+/**
+ * Contains utility functions for parsing of raw input given by the user. All classes here are static
+ */
+public class Parser {
+    /**
+     * Returns the first word as command
+     *
+     * @param inputLine The raw user input
+     * @return Returns the first word as command
+     */
+    public static String extractCommandFromInputLine(String inputLine) {
+        return inputLine.split("\\s+")[0];
+    }
+
+    /**
+     * Returns the rest of the sentence excluding the first word
+     *
+     * @param inputLine The raw user input
+     * @return Returns the rest of the sentence excluding the first word
+     */
+    public static String extractCommandDescFromInputLine(String inputLine) {
+        return inputLine.split(" ", 2)[1];
+    }
+
+    /**
+     * Returns the second word as integer
+     *
+     * @param inputLine The raw user input
+     * @return Returns the second word as integer
+     */
+    public static int extractTaskNoFromInputLine(String inputLine) {
+        return Integer.parseInt(inputLine.split(" ")[1]);
+    }
+
+    /**
+     * Returns the second word as keyword
+     *
+     * @param inputLine The raw user input
+     * @return Returns the second word as keyword
+     */
+    public static String extractKeywordFromInputLine(String inputLine) {
+        return inputLine.split(" ")[1];
+    }
+
+    /**
+     * Returns the rest of the sentence excluding the first word
+     *
+     * @param inputLine The raw user input
+     * @return Returns the rest of the sentence excluding the first word
+     */
+    public static String extractTodoDescFromInputLine(String inputLine) {
+        return inputLine.split(" ", 2)[1];
+    }
+
+    /**
+     * Returns the rest of the sentence excluding the first word
+     *
+     * @param inputLine The raw user input
+     * @return Returns the rest of the sentence excluding the first word
+     */
+    public static String extractDeadlineDetailsFromInputLine(String inputLine) {
+        return inputLine.split(" ", 2)[1];
+    }
+
+    /**
+     * Returns the text after the first word
+     *
+     * @param deadlineDetails The deadline details
+     * @return Returns the text after the first word
+     */
+    public static String extractDeadlineDescFromDeadlineDetails(String deadlineDetails) {
+        return deadlineDetails.split(" /by ")[0];
+    }
+
+    /**
+     * Returns the text after the /by command
+     *
+     * @param deadlineDetails The deadline details
+     * @return Returns the text after the /by command
+     */
+    public static String extractDeadlineByFromDeadlineDetails(String deadlineDetails) {
+        return deadlineDetails.split(" /by ")[1];
+    }
+
+    /**
+     * Returns the rest of the sentence excluding the first word
+     *
+     * @param inputLine The raw user input
+     * @return Returns the rest of the sentence excluding the first word
+     */
+    public static String extractEventDetailsFromInputLine(String inputLine) {
+        return inputLine.split(" ", 2)[1];
+    }
+
+    /**
+     * Returns the sentence before /from
+     *
+     * @param eventDetails The event details
+     * @return Returns the sentence before /from
+     */
+    public static String extractEventDescFromEventDetails(String eventDetails) {
+        return eventDetails.split("\\s+/from\\s+|\\s+/to\\s+", 3)[0];
+    }
+
+    /**
+     * Returns the sentence after /from and before /to
+     *
+     * @param eventDetails The event details
+     * @return Returns the sentence after /from and before /to
+     */
+    public static String extractEventFromFromEventDetails(String eventDetails) {
+        return eventDetails.split("\\s+/from\\s+|\\s+/to\\s+", 3)[1];
+    }
+
+    /**
+     * Returns the sentence after /to
+     *
+     * @param eventDetails The event details
+     * @return Returns the sentence after /to
+     */
+    public static String extractEventToFromEventDetails(String eventDetails) {
+        return eventDetails.split("\\s+/from\\s+|\\s+/to\\s+", 3)[2];
+    }
+}

src/main/java/python/task/Deadline.java

@@ -0,0 +1,49 @@
+package python.task;
+
+/**
+ * Represents a deadline object using due date
+ */
+public class Deadline extends Task {
+    final static private String TYPE_ICON = "[D]";
+    private String by;
+
+    /**
+     * Constructs <code>Deadline</code> object
+     *
+     * @param description The description of the task
+     * @param by          The due datetime
+     */
+    public Deadline(String description, String by) {
+        super(description);
+        this.by = by;
+    }
+
+    /**
+     * Returns the type icon of deadline
+     *
+     * @return Returns the type icon of deadline
+     */
+    @Override
+    public String getTypeIcon() {
+        return TYPE_ICON;
+    }
+
+    /**
+     * Returns the due datetime of deadline
+     *
+     * @return Returns the due datetime of deadline
+     */
+    public String getBy() {
+        return by;
+    }
+
+    /**
+     * Returns a human-readable string format
+     *
+     * @return Returns a human-readable string format
+     */
+    @Override
+    public String toString() {
+        return super.toString() + " (by: " + getBy() + ")";
+    }
+}