Merge branch 'branch-A-Release'

# Conflicts:
#	src/test/java/model/TaskListTest.java

Author: YingxuH

build.gradle

@@ -1,7 +1,7 @@
 plugins {
     id 'java'
     id 'application'
-//    id 'checkstyle'
+    id 'checkstyle'
     id 'com.github.johnrengelman.shadow' version '5.1.0'
 }
 
@@ -25,9 +25,9 @@ run {
     standardInput = System.in
 }
 
-//checkstyle {
-//    toolVersion = '8.23'
-//}
+checkstyle {
+    toolVersion = '8.23'
+}
 
 test {
     useJUnitPlatform()

src/main/java/Duke.java

@@ -1,6 +1,12 @@
 //package java;
 
-import exceptions.*;
+import exceptions.IllegalPositionException;
+import exceptions.IllegalDateTimeFormatException;
+import exceptions.InvalidStorageFilePathException;
+import exceptions.NoCommandException;
+import exceptions.NoDescriptionException;
+import exceptions.StorageOperationException;
+
 import parser.Command;
 import parser.Parser;
 import parser.HelpCommand;
@@ -27,21 +33,30 @@ public Duke() {
     }
 
     /**
-     * Load the storage from file into internal task list.
-     * Initiate other components.
+     * Checks does a user input match an exit key.
+     * @param input user input in string.
+     * @return true if user input matches exit key.
      */
-    public Duke(String userName) {
-        this.userName = userName;
-    }
-
     public static boolean isExitKey(String input) {
         return Parser.isExitKey(input);
     }
 
+    /**
+     * Returns greeting string to the screen.
+     * @return greet text.
+     */
     public String greet() {
         return HelpCommand.HELP_TEXT;
     }
 
+    /**
+     * Initializes components.
+     * @throws InvalidStorageFilePathException If default storage path is invalid.
+     * @throws IllegalDateTimeFormatException If datetime strings of loaded tasks are invalid.
+     * @throws NoDescriptionException If loaded tasks do not have description.
+     * @throws StorageOperationException If there is error decoding tasks.
+     * @throws IOException If there is error reading files.
+     */
     public void start() throws
             InvalidStorageFilePathException, IllegalDateTimeFormatException,
             NoDescriptionException, StorageOperationException, IOException {
@@ -53,17 +68,16 @@ public void start() throws
     /**
      * Listen to the user input and take actions.
      */
-    public String getResponse(String input) throws RuntimeException{
+    public String getResponse(String input) throws RuntimeException {
         Command command = null;
-//        assert false: "this is for testing";
         try {
             command = parser.parseCommand(input);
             command.setTaskList(taskList);
             String commandResult = command.execute();
             storage.save(taskList);
 
-            assert commandResult != null: "The response message is null";
-            assert commandResult.length() > 0: "The response message is empty";
+            assert commandResult != null : "The response message is null";
+            assert commandResult.length() > 0 : "The response message is empty";
 
             return commandResult;
         } catch (NoDescriptionException

src/main/java/Main.java

@@ -13,8 +13,8 @@
  */
 public class Main extends Application {
 
-    private final String APP_NAME = "Duke";
-    private final Image APP_ICON = new Image(
+    private final String appName = "Duke";
+    private final Image appIcon = new Image(
             this.getClass().getResourceAsStream("/images/DukeIcon.png"),
             80,
             80,
@@ -36,8 +36,8 @@ public void start(Stage stage) {
             mainWindow.setDuke(duke);
             mainWindow.dukeSpeak(duke.greet());
 
-            stage.setTitle(APP_NAME);
-            stage.getIcons().add(APP_ICON);
+            stage.setTitle(appName);
+            stage.getIcons().add(appIcon);
             stage.show();
         } catch (IOException e) {
             e.printStackTrace();

src/main/java/MainWindow.java

@@ -45,6 +45,10 @@ public void initialize() {
         scrollPane.vvalueProperty().bind(dialogContainer.heightProperty());
     }
 
+    /**
+     * assign a Duke object to the variable duke.
+     * @param d a duke instance.
+     */
     public void setDuke(Duke d) {
         try {
             duke = d;
@@ -56,6 +60,10 @@ public void setDuke(Duke d) {
         }
     }
 
+    /**
+     * Generates duke dialog box.
+     * @param input String to be displayed on screen.
+     */
     public void dukeSpeak(String input) {
         dialogContainer.getChildren().add(
                 DialogBox.getDukeDialog(input, dukeImage)

src/main/java/exceptions/IllegalPositionException.java

@@ -1,5 +1,7 @@
 package exceptions;
 
 public class IllegalPositionException extends Exception {
-    public IllegalPositionException(String cause) { super(cause); }
+    public IllegalPositionException(String cause) {
+        super(cause);
+    }
 }

src/main/java/model/DeadLineTask.java

@@ -60,8 +60,8 @@ public String getTaskType() {
      */
     @Override
     public ArrayList<String> getDetails() {
-        assert description != null: "task description not assigned";
-        assert description.length() > 0: "task description is empty";
+        assert description != null : "task description not assigned";
+        assert description.length() > 0 : "task description is empty";
 
         return new ArrayList<String>(Arrays.asList(
                 this.description,
@@ -70,7 +70,7 @@ public ArrayList<String> getDetails() {
 
     @Override
     public boolean isOnDate(LocalDate targetDate) {
-        assert by != null: "the value of 'by' not assigned";
+        assert by != null : "the value of 'by' not assigned";
         return by.toLocalDate().equals(targetDate);
     }
 
@@ -80,7 +80,7 @@ public boolean isOnDate(LocalDate targetDate) {
      */
     @Override
     public String toString() {
-        assert by != null: "the value of 'by' not assigned";
+        assert by != null : "the value of 'by' not assigned";
         return "[" + TASK_TYPE_CHA + "]" + super.toString() + " (by: " + by.format(DATE_TIME_FORMAT) + ")";
     }
 }

src/main/java/model/EventTask.java

@@ -50,8 +50,8 @@ public EventTask(String description, LocalDateTime at, boolean isDone) throws No
      */
     @Override
     public ArrayList<String> getDetails() {
-        assert description != null: "task description not assigned";
-        assert description.length() > 0: "task description is empty";
+        assert description != null : "task description not assigned";
+        assert description.length() > 0 : "task description is empty";
 
         return new ArrayList<String>(Arrays.asList(
                 this.description,
@@ -70,7 +70,7 @@ public String getTaskType() {
 
     @Override
     public boolean isOnDate(LocalDate targetDate) {
-        assert at != null: "the value of 'at' not assigned";
+        assert at != null : "the value of 'at' not assigned";
         return at.toLocalDate().equals(targetDate);
     }
 
@@ -80,7 +80,7 @@ public boolean isOnDate(LocalDate targetDate) {
      */
     @Override
     public String toString() {
-        assert at != null: "the value of 'at' not assigned";
+        assert at != null : "the value of 'at' not assigned";
         return "[" + TASK_TYPE_CHA + "]"  + super.toString() + " (at: " + at.format(DATE_TIME_FORMAT) + ")";
     }
 }

src/main/java/model/Task.java

@@ -77,9 +77,14 @@ public void setDescription(String description) throws NoDescriptionException {
         this.description = description;
     }
 
+    /**
+     * Checks whether the description of a task contains the inputted keyword.
+     * @param keyWord user input keyword.
+     * @return true if the description contains the keyword, false otherwise.
+     */
     public boolean hasKeyWord(String keyWord) {
-        assert description != null: "description not assigned";
-        assert description.length() > 0: "task description is empty";
+        assert description != null : "description not assigned";
+        assert description.length() > 0 : "task description is empty";
         return description.toLowerCase().contains(keyWord.toLowerCase());
     }
 
@@ -103,8 +108,8 @@ private String getStatusIcon() {
      * @return description of the task.
      */
     public String getDescription() {
-        assert description != null: "description not assigned";
-        assert description.length() > 0: "task description is empty";
+        assert description != null : "description not assigned";
+        assert description.length() > 0 : "task description is empty";
         return this.description;
     }
 
@@ -113,8 +118,8 @@ public String getDescription() {
      * @return an arraylist including the description.
      */
     public ArrayList<String> getDetails() {
-        assert description != null: "description not assigned";
-        assert description.length() > 0: "task description is empty";
+        assert description != null : "description not assigned";
+        assert description.length() > 0 : "task description is empty";
         return new ArrayList<String>(Collections.singletonList(this.description));
     }
 
@@ -138,8 +143,8 @@ public void markAsDone() {
      * @return String.
      */
     public String toString() {
-        assert description != null: "description not assigned";
-        assert description.length() > 0: "task description is empty";
+        assert description != null : "description not assigned";
+        assert description.length() > 0 : "task description is empty";
         return "[" + this.getStatusIcon() + "]" + " " + this.getDescription();
     }
 }

src/main/java/model/TaskList.java

@@ -55,7 +55,7 @@ public String add(Task task) {
 
         String addTaskEndStr = addTaskEnd.insert(13, this.internalList.size()).toString();
 
-        assert this.internalList.size() > 0: "task not added";
+        assert this.internalList.size() > 0 : "task not added";
         return ECHO_ADD_TASK
                 + task.toString()
                 + "\n"
@@ -68,7 +68,7 @@ public String add(Task task) {
      * @return response of the remove action.
      */
     public String remove(int position) throws IllegalPositionException {
-        assert this.internalList.size() > 0: "task list is empty, cannot delete";
+        assert this.internalList.size() > 0 : "task list is empty, cannot delete";
 
 
         if (position < 0 || position >= internalList.size()) {
@@ -93,7 +93,7 @@ public String remove(int position) throws IllegalPositionException {
      * @return response of the mark action.
      */
     public String markTaskAsDone(int position) throws IllegalPositionException {
-        assert this.internalList.size() > 0: "task list is empty, cannot mark";
+        assert this.internalList.size() > 0 : "task list is empty, cannot mark";
 
         if (position < 0 || position >= internalList.size()) {
             throw new IllegalPositionException("Oops!!! The input position "
@@ -108,13 +108,18 @@ public String markTaskAsDone(int position) throws IllegalPositionException {
                 + "\n";
     }
 
+    /**
+     * Filters tasks by checking whether the description contains a specific keyword.
+     * @param keyWord user input keyword.
+     * @return string representations of matched tasks.
+     */
     public String findByKeyWord(String keyWord) {
         StringBuilder matchedTasks = new StringBuilder();
         matchedTasks.append(ECHO_FIND_TASK);
 
         for (int i = 0; i < this.internalList.size(); i++) {
             if (this.internalList.get(i) == null) {
-                assert false: "element in arraylist is null";
+                assert false : "element in arraylist is null";
                 continue;
             }
             Task currentTask = this.internalList.get(i);
@@ -129,6 +134,11 @@ public String findByKeyWord(String keyWord) {
         return matchedTasks.toString();
     }
 
+    /**
+     * Filters tasks by date. Ignore todo tasks.
+     * @param targetDate user input date.
+     * @return string representation of matches tasks.
+     */
     public String findTasksOnDate(LocalDate targetDate) {
         StringBuilder tasksOnDate = new StringBuilder();
         tasksOnDate.append(ECHO_VIEW_SCHEDULE);
@@ -138,7 +148,7 @@ public String findTasksOnDate(LocalDate targetDate) {
 
         for (int i = 0; i < this.internalList.size(); i++) {
             if (this.internalList.get(i) == null) {
-                assert false: "element in arraylist is null";
+                assert false : "element in arraylist is null";
                 continue;
             }
             Task currentTask = this.internalList.get(i);
@@ -161,6 +171,10 @@ public int size() {
         return internalList.size();
     }
 
+    public Task getTask(int index) {
+        return internalList.get(index);
+    }
+
     /**
      * Converts the task list to a string by looping through the tasks and concatenate
      * all the string representation of tasks.
@@ -170,7 +184,7 @@ public String toString() {
         StringBuilder listOverView = new StringBuilder(ECHO_VIEW_TASK_LIST);
         for (int i = 0; i < this.internalList.size(); i++) {
             if (this.internalList.get(i) == null) {
-                assert false: "element in arraylist is null";
+                assert false : "element in arraylist is null";
                 continue;
             }
             listOverView.append(Integer.toString(i + 1));

src/main/java/parser/Command.java

@@ -54,7 +54,7 @@ public int findIndex(Pattern pattern, String input) {
         matcher.find();
 
         String index = matcher.group(POSITION_TARGET_INDEX);
-        assert index != null: "cannot find index";
+        assert index != null : "cannot find index";
         return Integer.parseInt(index) - DIFFERENCE_IN_START_INDEX;
     }
 
@@ -69,7 +69,7 @@ public String findDescription(Pattern pattern, String input) {
         matcher.find();
 
         String description = matcher.group(POSITION_DESCRIPTION);
-        assert description != null: "cannot find index";
+        assert description != null : "cannot find index";
         return description.trim();
     }
 
@@ -86,16 +86,24 @@ public LocalDateTime findDateTime(Pattern pattern, String input) throws IllegalD
         String dateString = matcher.group(POSITION_DATE);
         String timeString = matcher.group(POSITION_TIME);
 
-        assert dateString != null: "cannot find date string";
+        assert dateString != null : "cannot find date string";
         return parseDateTime(dateString, timeString);
     }
 
+    /**
+     * Finds the date string from the user input by regex.
+     * Converts the date string to LocalDate object.
+     * @param pattern Regex used to parse user input.
+     * @param input user input.
+     * @return parse LocalDate object.
+     * @throws IllegalDateTimeFormatException if the date string is in invalid format.
+     */
     public LocalDate findDate(Pattern pattern, String input) throws IllegalDateTimeFormatException {
         Matcher matcher = pattern.matcher(input);
         matcher.find();
         String dateString = matcher.group(POSITION_VIEW_SCHEDULE_DATE);
 
-        assert dateString != null: "cannot find date string";
+        assert dateString != null : "cannot find date string";
         return parseDate(dateString);
     }
 
@@ -110,7 +118,7 @@ public String findKeyword(Pattern pattern, String input) {
         matcher.find();
 
         String keyWord = matcher.group(POSITION_KEYWORD);
-        assert keyWord != null: "cannot find keyword";
+        assert keyWord != null : "cannot find keyword";
         return matcher.group(POSITION_KEYWORD);
     }