[owenyeo] IP #522

owenyeo · 2023-09-02T15:10:00Z

ChatBot

"A wise man once said work smart not hard." - Someone smart, probably

ChatBot frees your mind of having to remember things you need to do. It's,

Text-based
Easy to learn and master
SUPER convenient to use!
Funny and charismatic!

All you need to do is,

download it from here.
double-click it.
add your tasks.
let it manage your tasks for you 😄

And it is FREE!

Features:

Look at the charismatic Bot's introduction!

/**
     * Prints an introduction.
     */
    public void intro() {
        print(new String[] {"Hello! I am Bobby Wasabi", 
            "What can I do for you today?"});
    }

…bsite. Added functionality to rename chatbot.

Added functionality to read User input Added ability to exit chat when User Input is "bye" Provided documentation. Removed Message subclass due to redundancy.

Added functionality to add items into list

Added a Command Enum for cleaner code Added new classes Task, Event, Todo, Deadline

…nException. Added error handling in ChatBot.

Added InvalidIndexException for number errors in mark, unmark, and delete.

Added saveTasks to save data on a text file. Added loadTasks for potential future use.

Improved formatting of toSaveString in ChatBot.java Fixed bug where type of task is not correctly shown. Removed loadFile due to redundancy.

Added functionality to reformat DateTime when printing.

Added functionality for Storage to load previous lists. Added SaveFileNotFound exception

Added documentation for all new classes. Fixed bug when marking tasks as done and reloading it in the next session.

Previous version of ChatBot did not have support for Gradle. Support for gradle is required as we ramp up automated unit testing. Gradle support is therefore added, with JUnit tests coming in the next commit. Gradle is used for its ease of use and compatibility with JUnit. Fixed bugs regarding error messages not printing out.

No automated unit testing was implemented in this project. This led to time inefficiency as I had to manually test each component one by one. Therefore, JUnit tests are being implemented to test the various components in this project. Currently, I am implementing only tests for TaskList and Parser. More will be implemented as required. Fixed a bug regarding InvalidDescriptionException not being thrown when an empty description is passed through.

No coding convention was adhered to. This causes code to be less readable by others. Thus, from now on the project will adhere to Java Coding Convention. Checkstyle will be implemented and consistent checks from developer side will continue to ensure this.

There is no find command currently in the chatbot. This makes it hard to look for tasks that the user may specifically is looking for. A find command is thus added and is currently working as per developer's testing.

wj331

LGTM, just some nits on naming etc

wj331 · 2023-09-05T03:52:58Z

src/main/java/ChatBot.java

+
+    //Enum Command to make code cleaner and allow for the use of 
+    //switch case statements.
+    private static enum Command {


Maybe consider using Commands instead of Command?

wj331 · 2023-09-05T03:54:33Z

src/main/java/ChatBot.java

+    public void addToList(String taskString, Command command) 
+        throws InvalidDescriptionException {
+        switch(command) {
+            case ADD_TODO:


indentation of case should be same as switch i think?

wj331 · 2023-09-05T03:57:58Z

src/main/java/ChatBot.java

+                    list.add(new Event(eventLabel.trim(), eventParts2[0].trim(), eventParts2[1].trim()));
+                    saveTasks();
+                } catch (IndexOutOfBoundsException e) {
+                    throw new InvalidDescriptionException("Are you stupid? Can you follow instructions?");


haha this actually made me laugh. q funny

wj331 · 2023-09-05T03:59:43Z

src/main/java/ChatBot.java

+     * @param listNum Index of the item of the list to delete.
+     */
+    public void delete(int listNum) {
+        int index = listNum - 1;


Perhaps be more descriptive? index of (indexDone)?

wj331 · 2023-09-05T04:02:52Z

src/main/java/Event.java

+ * @author Owen Yeo
+ */
+public class Event extends Task{
+    private LocalDateTime from;


Perhaps use a more descriptive name? eg fromTime? from feels abit too general it could be from (location) instead of from (time)?

Project has no checkstyle support, which makes it difficult to check for errors pertaining to coding convetion. Thus, checkstyle support has been added to automate checking and ensure better code quality.

zsh-eng

Overall, some minor changes with naming and comments. LGTM!

zsh-eng · 2023-09-07T03:30:46Z

src/main/java/chatbot/ChatBot.java

+        }
+    }
+
+    public void run() {


Perhaps a JavaDoc comment for this method?

zsh-eng · 2023-09-07T03:35:15Z

src/main/java/chatbot/commands/Command.java

+     * 
+     * @return false
+     */
+    public boolean isExit() {return false;}


Should this method follow Egyptian style braces instead?

zsh-eng · 2023-09-07T03:37:40Z

src/main/java/chatbot/commands/UnmarkItem.java

+     */
+    @Override
+    public void execute(TaskList tasks, Storage storage, Ui ui) 
+        throws InvalidIndexException {


Should this wrapped line be indented by 8 spaces instead?

zsh-eng · 2023-09-07T03:38:08Z

src/main/java/chatbot/exceptions/SaveFileNotFound.java

@@ -0,0 +1,9 @@
+package chatbot.exceptions;
+


Perhaps a JavaDoc comment here to describe the class.

zsh-eng · 2023-09-07T03:38:32Z

src/main/java/chatbot/parser/Parser.java

+        switch(command) {
+            case BYE:
+                return new Bye("", CommandType.BYE);
+
+            case DISPLAY_LIST:
+                return new DisplayList("", CommandType.DISPLAY_LIST);
+
+            case MARK:
+                return new MarkItem(inputStrings[1], CommandType.MARK);
+
+            case UNMARK:
+                return new UnmarkItem(inputStrings[1], CommandType.UNMARK);
+
+            case ADD_TODO:
+                return new AddToDo(inputStrings[1], CommandType.ADD_TODO);
+
+            case ADD_DEADLINE:
+                return new AddDeadline(inputStrings[1], CommandType.ADD_DEADLINE);
+
+            case ADD_EVENT:
+                return new AddEvent(inputStrings[1], CommandType.ADD_EVENT);
+
+            case DELETE:
+                return new DeleteItem(inputStrings[1], CommandType.DELETE);
+
+            case FIND:
+                return new FindTask(inputStrings[1], CommandType.FIND);
+
+            default:
+                throw new InvalidCommandException("Don't be stupid, speak english.");


I like how clean this looks. Keep it up!

zsh-eng · 2023-09-07T03:40:11Z

src/main/java/chatbot/task/Deadline.java

+    /**
+     * 
+     */
+    @Override
+    public String toSaveString() {
+        return "D " + super.toSaveString() + " | " + originalString;
+    }
+
+    /**
+     * 
+     */


Perhaps a JavaDoc comment here? Since the methods are overriden, I think removing the comment is fine too!

zsh-eng · 2023-09-07T03:42:51Z

src/main/java/chatbot/ui/Ui.java

+    public void bye() {
+        print(new String[] {"Bye. Have a bad day you doofus."});
+    }


Perhaps a method name that starts with a verb, for example printGoodbye would be more descriptive?

For your reference:

Names representing methods must be verbs and written in camelCase.

There is no GUI for ChatBot, which is not ideal for User Experience. A UI was therefore added using JavaFX, and is currently working well as per developer testing and JUnit tests.

ChatBot has no support for FXML, which makes GUI design clunkier and more tedious. FXML Support thus has been added to facilitate GUI design. Original functions seem to be working well as per unit testing and developer tests.

Project does not have any assert statements, meaning that potential issues with logic may go unnoticed. Adding assertion statements thus will allow for better developer testing and ensure code works as intended. As a step towards bettering code quality, assertion statements have been added to some classes where errors tend to happen, e.g. tasklist and tasks with timings.

Code has some minor violations in coding standards throughtout the project. This leads to lower readability of code and thus makes it hard to debug. Checkstyle is thus used to detect such errors, and code is screened to correct any violation detected.

Chatbot did not recognise and handle duplicate entries of the same task. This led to clunky UX as users added multiple entries of the same task. Added functionality to inform users of duplicate entries when adding new tasks, to list duplicates, and to delete all duplicates if any. Fixed a bug regarding delete where the wrong number of remaining tasks left is shown.

README formatting was wrong and looks clunky. Fixed remaining issues.

File path is hardcoded into chatBot, causing .jar files to not save tasks properly. Bug has been fixed.

App could not run on windows systems due to FXML compatibalitity issues. Imported packages for Windows and Linux to ensure cross-platform compatibality Brushed up on some header commands.

README is outside of docs folder, making it messy. Moved README to docs folder.

owenyeo added 16 commits August 23, 2023 22:41

Added Skeleton code that outputs the required output as per source we…

1795e04

…bsite. Added functionality to rename chatbot.

Added echoing functionality

4130123

Added functionality to read User input Added ability to exit chat when User Input is "bye" Provided documentation. Removed Message subclass due to redundancy.

Added the functionality of listing

6390de9

Added functionality to add items into list

Added functionality to unmark and mark tasks as done

b9fcb6a

Added functionality to add ToDo, Event, and Deadline

61b2190

Added a Command Enum for cleaner code Added new classes Task, Event, Todo, Deadline

Added ChatBotException, InvalidCommandException, and InvalidDescrptio…

7dfe76e

…nException. Added error handling in ChatBot.

Added delete functionality

85de7a8

Added InvalidIndexException for number errors in mark, unmark, and delete.

Added InvalidIndexException

4fe5821

Added saveTasks to save data on a text file. Added loadTasks for potential future use.

Improved on documentation

3201c19

Improved formatting of toSaveString in ChatBot.java Fixed bug where type of task is not correctly shown. Removed loadFile due to redundancy.

Added functionality to store DateTime objects

2c3b245

Added functionality to reformat DateTime when printing.

Refactored code into different files for more OOP

88f8909

Added functionality for Storage to load previous lists. Added SaveFileNotFound exception

Reorganised code into packages.

2ed0b5e

Added documentation for all new classes. Fixed bug when marking tasks as done and reloading it in the next session.

Follow coding convention

e11eebb

No coding convention was adhered to. This causes code to be less readable by others. Thus, from now on the project will adhere to Java Coding Convention. Checkstyle will be implemented and consistent checks from developer side will continue to ensure this.

Add Find command

d367c95

There is no find command currently in the chatbot. This makes it hard to look for tasks that the user may specifically is looking for. A find command is thus added and is currently working as per developer's testing.

wj331 reviewed Sep 5, 2023

View reviewed changes

Add Checkstyle Support

15915cc

Project has no checkstyle support, which makes it difficult to check for errors pertaining to coding convetion. Thus, checkstyle support has been added to automate checking and ensure better code quality.

zsh-eng reviewed Sep 7, 2023

View reviewed changes

owenyeo added 11 commits September 7, 2023 20:14

Add GUI support for ChatBot

105a851

There is no GUI for ChatBot, which is not ideal for User Experience. A UI was therefore added using JavaFX, and is currently working well as per developer testing and JUnit tests.

Add FXML Support to GUI

82a31ff

ChatBot has no support for FXML, which makes GUI design clunkier and more tedious. FXML Support thus has been added to facilitate GUI design. Original functions seem to be working well as per unit testing and developer tests.

Improve Code Quality

d958d4e

Code has some minor violations in coding standards throughtout the project. This leads to lower readability of code and thus makes it hard to debug. Checkstyle is thus used to detect such errors, and code is screened to correct any violation detected.

Add User Guide and Screenshot

a59f792

Add Screenshot and User Guide

b1a3625

Improve README

2ad87a1

README formatting was wrong and looks clunky. Fixed remaining issues.

Fix hard-coding file path

eb3e12f

File path is hardcoded into chatBot, causing .jar files to not save tasks properly. Bug has been fixed.

Fix bug with FXML

53531c3

App could not run on windows systems due to FXML compatibalitity issues. Imported packages for Windows and Linux to ensure cross-platform compatibality Brushed up on some header commands.

Moved README to doc folder

b6674b8

README is outside of docs folder, making it messy. Moved README to docs folder.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[owenyeo] IP #522

[owenyeo] IP #522

owenyeo commented Sep 2, 2023 •

edited

Loading

wj331 left a comment

wj331 Sep 5, 2023

wj331 Sep 5, 2023

wj331 Sep 5, 2023

wj331 Sep 5, 2023

wj331 Sep 5, 2023

zsh-eng left a comment

zsh-eng Sep 7, 2023

zsh-eng Sep 7, 2023

zsh-eng Sep 7, 2023

zsh-eng Sep 7, 2023

zsh-eng Sep 7, 2023

zsh-eng Sep 7, 2023

zsh-eng Sep 7, 2023 •

edited

Loading

[owenyeo] IP #522

Are you sure you want to change the base?

[owenyeo] IP #522

Conversation

owenyeo commented Sep 2, 2023 • edited Loading

ChatBot

wj331 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zsh-eng left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zsh-eng Sep 7, 2023 • edited Loading

Choose a reason for hiding this comment

owenyeo commented Sep 2, 2023 •

edited

Loading

zsh-eng Sep 7, 2023 •

edited

Loading