Merge pull request #8 from raymondge/JAR-released

Finalise the rest of the task

Author: raymondge

TaskList/Task0.txt

@@ -11,6 +11,7 @@ repositories {
 
 
 dependencies {
+    implementation 'junit:junit:4.12'
     String javaFxVersion = '11'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
@@ -46,11 +47,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "Launcher"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "Launcher"
     archiveClassifier = null
 }
 

TaskList/Task1.txt

@@ -1,20 +1,151 @@
-# User Guide
+# User Guide for duke bot
 
 ## Features 
 
-### Feature 1 
-Description of feature.
+### Say bye to duke `bye` 
 
-## Usage
+Exit the program.
 
-### `Keyword` - Describe action
+Input instruction: 
 
-Describe action and its outcome.
+`bye`
 
-Example of usage: 
+### Find a task `find` 
 
-`keyword (optional arguments)`
+Find the expected task with given index in the task list.
 
-Expected outcome:
+Input instruction: 
 
-`outcome`
+`find` + `index`
+
+Example of usage: find 1 
+
+### Delete a task `delete` 
+
+Delete the expected task with given index in the task list.
+
+Input instruction: 
+
+`delete` + `index`
+
+Example of usage: delete 1 
+
+### Create a todo task `todo` 
+
+Create a task that you are going to do and store in the tasklist.
+
+Input instruction: 
+
+`todo` + `task content`
+
+Example of usage: todo play games
+
+### Create a deadline task `deadline` 
+
+Create a task with a deadline
+
+Input instruction: 
+
+`deadline` + `task content` + `/by` + `YYYY-MM-DD`
+
+Example of usage: deadline finish homework /by 2020-05-12
+
+### Create a event task `event` 
+
+Create an event
+
+Input instruction: 
+
+`event` + `task content` + `/at` + `YYYY-MM-DD`
+
+Example of usage: event celebrate holiday /at 2020-05-12
+
+### List your tasks `list` 
+
+Show the list of tasks
+
+Input instruction: 
+
+`list`
+
+Example of usage: list
+
+### Find out statistics `stats` 
+
+Show the number of task completed
+
+Input instruction: 
+
+`stats`
+
+Example of usage: stats
+
+### Says hi to duke `hi` 
+
+Greet the bot and it will greet you back
+
+Input instruction: 
+
+`hi`
+
+Example of usage: hi
+
+### Mark your task done `done` 
+
+Mark your task done 
+
+Input instruction: 
+
+`done` + `index`
+
+Example of usage: done 1
+
+//@@author dcchan98-reused
+//Reused from https://github.com/dcchan98/ip/blob/master/src/main/java/Storage.java with minor modification
+
+public void writeToFile(Task myTask, int todoNum) {
+ 
+         createToDo("ToDo/item" + todoNum + ".txt");
+ 
+         try {
+             ObjectOutputStream out = new ObjectOutputStream(new FileOutputStream("ToDo/item" + todoNum + ".txt"));
+             out.writeObject(myTask);
+         } catch (IOException e) {
+             e.printStackTrace();
+         }
+     }
+public Task readFromFile(String fileDir) {
+          Task myTask = null;
+          try {
+              ObjectInputStream in = new ObjectInputStream(new FileInputStream(fileDir));
+              myTask = (Task) in.readObject();
+          } catch (IOException | ClassNotFoundException e) {
+              e.printStackTrace();
+          }
+          return myTask;
+  
+      }
+public void updateDirectory(TaskList myTaskList) {
+  
+          // deleting all files in directory
+          File dir = new File("ToDo");
+          File[] myItems = dir.listFiles();
+          for (File child : myItems) {
+              if (child.toString().substring(0, 9).equals("ToDo/item")) {
+                  Path path = FileSystems.getDefault().getPath(child.toString());
+                  try {
+                      Files.delete(path);
+                  } catch (NoSuchFileException x) {
+                      System.err.format("%s: no such" + " file or directory%n", path);
+                  } catch (IOException x) {
+                      System.err.println(x);
+                  }
+              }
+          }
+  
+          // repopulating directory with that in arraylist taks
+          for (int i = 0; i < myTaskList.getTasks().size(); i++) {
+              writeToFile(myTaskList.getTasks().get(i), i);
+          }
+      }
+//@@author dcchan98-reused

TaskList/Task2.txt

@@ -2,21 +2,36 @@
 import java.time.format.DateTimeFormatter;
 
 /**
- * Encapsulates data for a deadline task.
+ * A deadline task that comprises a deadline task description, date and whether it is done.
  */
 
 public class Deadline extends Task {
 
     protected LocalDate time;
 
+    /**
+     * Create a deadline task.
+     * @param description of task.
+     * @param isDone done status of task.
+     * @param time of task.
+     */
     public Deadline(String description, boolean isDone, LocalDate time) {
         super(description, isDone);
         this.time = time;
     }
 
+    /**
+     * Returns the deadline date.
+     * @return deadline date.
+     */
     public String getDate() {
         return time.format(DateTimeFormatter.ofPattern("MMM d yyyy"));
     }
+
+    /**
+     * Returns the String description for deadline.
+     * @return String description.
+     */
     @Override
     public String toString() {
         return "[D]" + super.toString() + " (by: " + getDate() + ")";

build.gradle

@@ -23,6 +23,11 @@ public class DialogBox extends HBox {
     @FXML
     private ImageView displayPicture;
 
+    /**
+     * Create a DialogBox.
+     * @param text of Dialog.
+     * @param img image of Dialog.
+     */
     private DialogBox(String text, Image img) {
         try {
             FXMLLoader fxmlLoader = new FXMLLoader(MainWindow.class.getResource("/view/DialogBox.fxml"));
@@ -47,10 +52,16 @@ private void flip() {
         setAlignment(Pos.TOP_LEFT);
     }
 
+    /**
+     * Static method to get User Dialog with text and image.
+     */
     public static DialogBox getUserDialog(String text, Image img) {
         return new DialogBox(text, img);
     }
 
+    /**
+     * Static method to get Duke Dialog with text and image with flipped position.
+     */
     public static DialogBox getDukeDialog(String text, Image img) {
         var db = new DialogBox(text, img);
         db.flip();