Merge pull request #7 from gachia/branch-C-Help

Completed C-Help

build.gradle

@@ -16,13 +16,13 @@ checkstyle {
 
 shadowJar {
     archiveBaseName = "duke"
-    archiveVersion = "0.1.5"
+    archiveVersion = "0.1.6"
     archiveClassifier = null
     archiveAppendix = null
 }
 
 group 'duke'
-version '0.1.5'
+version '0.1.6'
 
 repositories {
     mavenCentral()

src/main/data/help.txt

@@ -0,0 +1,15 @@
+Here are the list of commands that you can use:
+  - todo <task name>
+      (saves a default To-Do task)
+  - deadline <task name> /by <date and time in D/MM/YYYY HHmm>
+      (saves a To-Do task with a deadline)
+  - event <event name> /at <venue>
+      (saves an Event task with a location)
+  - delete <task number>
+      (deletes a task from your list)
+  - done <task number>
+      (marks a task as done)
+  - list
+      (displays your task list)
+  - find <task name>
+      (find tasks with the search term)

src/main/java/ExitCommand.java

@@ -1,5 +1,3 @@
-import javafx.application.Platform;
-
 /**
  * Represents the Command for exiting the Duke Chatbot.
  * A sub-class of Command.

src/main/java/Gui.java

@@ -2,6 +2,7 @@
 
 import javafx.application.Application;
 import javafx.fxml.FXMLLoader;
+import javafx.scene.image.Image;
 import javafx.scene.Scene;
 import javafx.scene.layout.AnchorPane;
 import javafx.stage.Stage;
@@ -24,8 +25,9 @@ public void start(Stage stage) {
             FXMLLoader fxmlLoader = new FXMLLoader(Gui.class.getResource("/view/MainWindow.fxml"));
             AnchorPane ap = fxmlLoader.load();
             Scene scene = new Scene(ap);
-            stage.setTitle("Duke: Your Virtual Assistant");
+            stage.setTitle("Duke: Your Task Assistant");
             stage.setScene(scene);
+            stage.getIcons().add(new Image(Gui.class.getResourceAsStream("/images/dukeIcon.png")));
             fxmlLoader.<MainWindow>getController().setDuke(duke);
             stage.show();
         } catch (IOException e) {

src/main/java/HelpCommand.java

@@ -0,0 +1,22 @@
+/**
+ * Represents the Command for helping the user use the Chatbot.
+ * A sub-class of Command.
+ */
+public class HelpCommand extends Command {
+
+    /**
+     * Overridden execute method from Command to return the help message for the user.
+     * The help message details can be found in /data folder.
+     *
+     * @param storage Storage object for saving purposes
+     * @param tasks   Contains the list of tasks
+     * @param ui      Holds Ui printing methods and user input field
+     * @param input   User input
+     * @return Help Message from UI
+     * @throws DukeException If help file is unable to be read in showHelp()
+     */
+    @Override
+    public String execute(Storage storage, TaskList tasks, Ui ui, String input) throws DukeException {
+        return ui.showHelp();
+    }
+}

src/main/java/MainWindow.java

@@ -1,4 +1,3 @@
-import javafx.application.Platform;
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
 import javafx.scene.control.ScrollPane;

src/main/java/Parser.java

@@ -28,6 +28,8 @@ public static Command parse(String userCmd) throws DukeException {
             return new AddEventCommand();
         case "deadline":
             return new AddDeadlineCommand();
+        case "help":
+            return new HelpCommand();
         default:
             throw new DukeException("Invalid Command");
         }

src/main/java/Ui.java

@@ -1,4 +1,6 @@
 import java.util.Scanner;
+import java.io.File;
+import java.io.FileNotFoundException;
 
 /**
  * Handles the printing of Duke messages.
@@ -7,12 +9,14 @@ public class Ui {
 
     final String lineSpace = "_______________________________\n";
     private Scanner sc;
+    final String helpFilePath;
 
     /**
      * Default Constructor to initialise Scanner object for user input.
      */
     public Ui() {
         sc = new Scanner(System.in);
+        helpFilePath = "src/main/data/help.txt";
     }
 
     /**
@@ -21,14 +25,16 @@ public Ui() {
      * @return welcome message
      */
     public String showWelcome() {
+        /*
         final String logo = " ____        _        \n"
                 + "|  _ \\ _   _| | _____ \n"
                 + "| | | | | | | |/ / _ \\\n"
                 + "| |_| | |_| |   <  __/\n"
                 + "|____/ \\__,_|_|\\_\\___|\n";
-        final String startMessage = "Hello! I'm Duke\nWhat can I do for you?\n";
-        String welcomeMessage = startMessage;
-        return welcomeMessage;
+         */
+        final String startMessage = "Hello! I'm Duke, Your Task Assistant.\n"
+                + "What can I do for you?\n" + "If you need help, type help in the field.";
+        return startMessage;
     }
 
     /**
@@ -89,6 +95,25 @@ public String showDelete(Task task, int listSize) {
         return message;
     }
 
+    /**
+     * Prints a help message that lists the available commands the user is able
+     * to type. Message is read from a text file in /data folder.
+     *
+     * @return Help Message
+     * @throws DukeException If file is unable to be read
+     */
+    public String showHelp() throws DukeException {
+        try {
+            File f = new File(helpFilePath);
+            Scanner sc = new Scanner(f);
+            String helpMessage = sc.useDelimiter("\\A").next();
+            sc.close();
+            return helpMessage;
+        } catch (FileNotFoundException e) {
+            throw new DukeException("Failed to load help text file");
+        }
+    }
+
 
     /**
      * Prints a straight line for clarity purposes.