Merge pull request #9 from jasonqiu212/branch-A-Checkstyle

Add checkstyle

build.gradle

@@ -2,6 +2,7 @@ plugins {
     id 'java'
     id 'application'
     id 'com.github.johnrengelman.shadow' version '5.1.0'
+    id 'checkstyle'
 }
 
 repositories {
@@ -51,6 +52,10 @@ shadowJar {
     archiveClassifier = null
 }
 
+checkstyle {
+    toolVersion = '10.2'
+}
+
 run {
     standardInput = System.in
 }

config/checkstyle/suppressions.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+        "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+    <suppress checks="JavadocType" files=".*Test\.java"/>
+    <suppress checks="MissingJavadocMethodCheck" files=".*Test\.java"/>
+</suppressions>

src/main/java/cheese/command/FindCommand.java

@@ -1,12 +1,12 @@
 package cheese.command;
 
+import java.util.ArrayList;
+
 import cheese.data.TaskList;
 import cheese.storage.Storage;
 import cheese.task.Task;
 import cheese.ui.Response;
 
-import java.util.ArrayList;
-
 /**
  * Represents a user command to find a task by searching for a keyword.
  */

src/main/java/cheese/data/TaskList.java

@@ -1,11 +1,11 @@
 package cheese.data;
 
+import java.util.ArrayList;
+
 import cheese.exception.CheeseException;
 import cheese.parser.Parser;
 import cheese.task.Task;
 
-import java.util.ArrayList;
-
 /**
  * Represents a list of tasks that supports adding tasks, deleting tasks, and marking tasks as
  * complete/incomplete.
@@ -83,6 +83,13 @@ public Task markTaskAsNotDone(int taskIndex) throws CheeseException {
         return task;
     }
 
+    /**
+     * Delays task deadline by 1 day.
+     *
+     * @param taskIndex Index of task to snooze.
+     * @return Task that is snoozed.
+     * @throws CheeseException If index is not in the range of task list.
+     */
     public Task snoozeTask(int taskIndex) throws CheeseException {
         Task task = getTask(taskIndex);
         task.snooze();

src/main/java/cheese/storage/Storage.java

@@ -1,17 +1,17 @@
 package cheese.storage;
 
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.Scanner;
+
 import cheese.data.TaskList;
 import cheese.exception.CheeseException;
 import cheese.task.Deadline;
 import cheese.task.Event;
 import cheese.task.Task;
 import cheese.task.Todo;
 
-import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
-import java.util.Scanner;
-
 /**
  * Represents a storage that interacts with <code>Cheese</code>'s save file.
  */

src/main/java/cheese/task/Deadline.java

@@ -1,10 +1,10 @@
 package cheese.task;
 
+import java.time.LocalDateTime;
+
 import cheese.storage.Storage;
 import cheese.utils.DateTimeUtils;
 
-import java.time.LocalDateTime;
-
 /**
  * Represents a deadline with description, complete/incomplete status, and deadline.
  */

src/main/java/cheese/task/Event.java

@@ -1,10 +1,10 @@
 package cheese.task;
 
+import java.time.LocalDateTime;
+
 import cheese.storage.Storage;
 import cheese.utils.DateTimeUtils;
 
-import java.time.LocalDateTime;
-
 /**
  * Represents an event with description, complete/incomplete status, and time interval.
  */

src/main/java/cheese/task/Task.java

@@ -12,8 +12,6 @@ public abstract class Task {
     /** Whether task is complete or incomplete. */
     private boolean isDone;
 
-    public abstract void snooze();
-
     /**
      * Constructs an instance of <code>Task</code>.
      *
@@ -35,6 +33,8 @@ protected Task(boolean isDone, String description) {
         this.description = description;
     }
 
+    public abstract void snooze();
+
     public void setDone() {
         isDone = true;
     }

src/main/java/cheese/ui/Main.java

@@ -1,5 +1,7 @@
 package cheese.ui;
 
+import java.io.IOException;
+
 import cheese.Cheese;
 import cheese.ui.controller.MainWindow;
 import javafx.application.Application;
@@ -8,8 +10,6 @@
 import javafx.scene.layout.AnchorPane;
 import javafx.stage.Stage;
 
-import java.io.IOException;
-
 /**
  * Represents a GUI for Cheese using FXML.
  */

src/main/java/cheese/ui/Response.java

@@ -1,10 +1,10 @@
 package cheese.ui;
 
+import java.util.ArrayList;
+
 import cheese.data.TaskList;
 import cheese.task.Task;
 
-import java.util.ArrayList;
-
 /**
  * Contains the responses given by Cheese.
  */
@@ -15,7 +15,8 @@ public class Response {
      * @return Message to display to welcome user.
      */
     public static String getWelcomeMessage() {
-        return "Woof! I'm Cheese, your puppy assistant.\n" + "What can I do for you?";
+        return "Woof! I'm Cheese, your puppy assistant.\n"
+                + "What can I do for you?";
     }
 
     /**
@@ -26,7 +27,9 @@ public static String getWelcomeMessage() {
      * @return Message to display after adding task.
      */
     public static String getAddTaskMessage(Task addedTask, int newListSize) {
-        return "Gotcha! I have a paw-fect memory!\n" + "  " + addedTask + "\n" + "You have " + newListSize + " task(s) in the list.";
+        return "Gotcha! I have a paw-fect memory!\n"
+                + "  " + addedTask + "\n"
+                + "You have " + newListSize + " task(s) in the list.";
     }
 
     /**
@@ -37,7 +40,9 @@ public static String getAddTaskMessage(Task addedTask, int newListSize) {
      * @return Message to display after deleting task.
      */
     public static String getDeleteTaskMessage(Task deletedTask, int remainingListSize) {
-        return "Gotcha master! I'll forget about this task!\n" + "  " + deletedTask + "\n" + "You have " + remainingListSize + " task(s) remaining.";
+        return "Gotcha master! I'll forget about this task!\n"
+                + "  " + deletedTask + "\n"
+                + "You have " + remainingListSize + " task(s) remaining.";
     }
 
     /**
@@ -57,7 +62,8 @@ public static String getMarkTaskAsDoneMessage(Task taskDone) {
      * @return Message to display after marking task as incomplete.
      */
     public static String getMarkTaskAsNotDoneMessage(Task taskNotDone) {
-        return "Okay master, I've marked this task as incomplete.\n" + "  " + taskNotDone;
+        return "Okay master, I've marked this task as incomplete.\n"
+                + "  " + taskNotDone;
     }
 
     /**
@@ -67,7 +73,8 @@ public static String getMarkTaskAsNotDoneMessage(Task taskNotDone) {
      * @return Message to display after snoozing task.
      */
     public static String getSnoozeTaskMessage(Task taskSnoozed) {
-        return "Gotcha! I've snoozed this task by 1 day. Wanna go for a walk now??\n" + "  " + taskSnoozed;
+        return "Gotcha! I've snoozed this task by 1 day. Wanna go for a walk now??\n"
+                + "  " + taskSnoozed;
     }
 
     /**

src/main/java/cheese/ui/controller/DialogBox.java

@@ -1,5 +1,8 @@
 package cheese.ui.controller;
 
+import java.io.IOException;
+import java.util.Collections;
+
 import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 import javafx.fxml.FXML;
@@ -11,9 +14,6 @@
 import javafx.scene.image.ImageView;
 import javafx.scene.layout.HBox;
 
-import java.io.IOException;
-import java.util.Collections;
-
 /**
  * Controls dialog box consisting of an ImageView to represent the speaker's face and a label
  * containing text from the speaker.

src/main/java/cheese/ui/controller/MainWindow.java

@@ -14,6 +14,14 @@
  */
 public class MainWindow extends AnchorPane {
 
+    /** Image to represent the user. */
+    private Image userImage =
+            new Image(this.getClass().getResourceAsStream("/images/User.png"));
+
+    /** Image to represent Cheese. */
+    private Image cheeseImage =
+            new Image(this.getClass().getResourceAsStream("/images/Cheese.png"));
+
     /** Scroll pane to contain the chat. */
     @FXML
     private ScrollPane scrollPane;
@@ -29,22 +37,14 @@ public class MainWindow extends AnchorPane {
     /** An instance of <code>Cheese</code>. */
     private Cheese cheese;
 
-    /** Image to represent the user. */
-    private final Image IMAGE_USER =
-            new Image(this.getClass().getResourceAsStream("/images/User.png"));
-
-    /** Image to represent Cheese. */
-    private final Image IMAGE_CHEESE =
-            new Image(this.getClass().getResourceAsStream("/images/Cheese.png"));
-
     /**
      * Initializes the main window.
      */
     @FXML
     public void initialize() {
         scrollPane.vvalueProperty().bind(dialogContainer.heightProperty());
         this.dialogContainer.getChildren()
-                .add(DialogBox.getCheeseDialog(Response.getWelcomeMessage(), IMAGE_CHEESE));
+                .add(DialogBox.getCheeseDialog(Response.getWelcomeMessage(), cheeseImage));
     }
 
     /**
@@ -64,8 +64,8 @@ public void setCheese(Cheese c) {
     private void handleUserInput() {
         String input = userInput.getText();
         String response = cheese.getResponse(input);
-        dialogContainer.getChildren().addAll(DialogBox.getUserDialog(input, IMAGE_USER),
-                DialogBox.getCheeseDialog(response, IMAGE_CHEESE));
+        dialogContainer.getChildren().addAll(DialogBox.getUserDialog(input, userImage),
+                DialogBox.getCheeseDialog(response, cheeseImage));
         userInput.clear();
     }
 }

src/main/java/cheese/utils/DateTimeUtils.java

@@ -17,7 +17,7 @@ public class DateTimeUtils {
 
     /**
      * Parses string to date time using input formatter.
-     * 
+     *
      * @param dateTime String to parse.
      * @return Parsed date time.
      */
@@ -27,7 +27,7 @@ public static LocalDateTime parseString(String dateTime) {
 
     /**
      * Parses date time to string using output formatter.
-     * 
+     *
      * @param dateTime Date time to parse.
      * @return Parsed string representing date time.
      */
@@ -37,7 +37,7 @@ public static String parseLocalDateTimeToOutput(LocalDateTime dateTime) {
 
     /**
      * Parses date time to string using input formatter.
-     * 
+     *
      * @param dateTime Date time to parse.
      * @return Parsed string representing date time.
      */

src/test/java/cheese/data/TaskListTest.java

@@ -1,7 +1,9 @@
 package cheese.data;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+
 import org.junit.jupiter.api.Test;
+
 import cheese.task.Deadline;
 import cheese.task.Event;
 import cheese.task.Todo;

src/test/java/cheese/task/TodoTest.java

@@ -1,6 +1,7 @@
 package cheese.task;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+
 import org.junit.jupiter.api.Test;
 
 public class TodoTest {