[Johannes] iP #498

jwdavis0200 · 2022-08-28T15:57:45Z

Duker

“To-Do lists help us break life into small steps.” — Randy Pausch

Duker isn't like any other to-do list. You don't have to install anything on your computer!
Simply,

Download it here.
Double-Click
Start slaying!

What features do I get with Duker?

Remove your to-dos. Be Gone!!
Add them! Remember adding is just as important as removing!.
Find your tasks. We know it gets crazy. :"^)
List them out, mark them, unmark them and MORE!

Future features to be Added:
[ ] Make it look better for your eyes.
[ ] Make it ~~faster~~ EVEN faster
[ ] Many mOre, stay tuned! 👍

If you are a Java Programmer, take a look at the source code to see how OOP this is!!
This is our main.

public static void main(String[] args) {
        try {
            new Duke("storage.txt").run();
        } catch (DukeException de) {
            System.out.println("--------------------------------------\n");
            System.out.println(de.getMessage());
            System.out.println("--------------------------------------\n");
            main(args);
        } catch (IOException io) {
            System.out.println("--------------------------------------\n");
            System.out.println(io.getMessage());
            System.out.println("--------------------------------------\n");
        }
    }

…in a new prompt feedback

…tion of chatbot to minimise code repetition.

…em as a list when the string list is passed as an input

Added checklist functionality and modified storeman method to accomodate new function. Added listOut method to generalise listing out of tasks, to minimise code repetition.

… Deadlines

…flexibility

…implemented within storeman method). replaced contains with startsWith where appropariate to ensure correctness of program when running.

…f program

…unknown or in the wrong format, to be caught by main. Main will restart duke upon catching the exception and print the message of the error to console right before.

…red)

… the process of testing

Merge pull request 1 from temp branch to master branch

…epresentation of Task and Deadline

storage.txt is a cached file by Duke to save the list of Tasks by user in previous run. storage.txt changed every run and there's no need to track the file in repo. Hence, should be include in .gitignore as a file to be ignored by git tracking

The classes are not packaged and organised. We need to organise our files better, into duke package, utility package and dukeexception package. Hence we add package statements for each file according to where they are organised and import package statements accordingly.

No JUnit test to test correctness of classes. We want to test the toString methods of Event and Todo classes to ensure correctness. Added JUnit tests for the toString methods of Event and Todo classes using JUnit.

Currently, Duke does not have functionality to find matching tasks in the TaskList when requested by client We want to allow client to find their matching tasks when requested. Added conditionals in Parser and methods in TaskList and Ui classes to support this functionality.

…ove method not used from Ui class. askForPath is a method from the Ui class which is not used. There is no task to create a fat jar via build.gradle. askForPath affects readability and adds extra lines of unnecessary codes. We also need a task to create a fat jar via build.gradle. We should remove askForPath method sicne it is nto used and add task to build.gradle in order to automate the creation of fat jar file.

…t instead. Added Java documentation. add method is in Storage class but it deals with adding tasks into the task list. There is no Java documentation. TaskList class should be handling this operaton. Java documentations should also be added for the classes. Transfer the add method to the TaskList class from the Storage class. Added Java documentation for the classes of the program.

Previously, Checkstyle was not implemented to check for coding standard violations. There are many Checkstyle coding violations upon implementing the Checkstyle Feature via Gradle. Fixed many of such violations to meet the Checkstyle coding standards.

sugiyem

In general, I think your code looks good already. There's some coding standard violations listed below, but other than that, LGTM!

sugiyem · 2022-08-30T16:55:22Z

src/main/java/dukechatbot/duke/Duke.java

+    private TaskList tasks;
+    private Ui ui;
+    private ArrayList<Task> al;
+    private Parser parse;


Maybe the variable al and parse can be renamed to a more descriptive object name?

sugiyem · 2022-08-30T16:57:07Z

src/main/java/dukechatbot/utility/Deadline.java

+    /**
+     * Defines the Date time format to read in the commands passed by client for processing.
+     */
+    protected static final DateTimeFormatter DTF = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm");


Nice abstraction!

sugiyem · 2022-08-30T16:59:30Z

src/main/java/dukechatbot/duke/Duke.java

+        try {
+            new Duke("storage.txt").run();
+        } catch (DukeException de) {
+            System.out.println("--------------------------------------\n");


This dashed line is used multiple times. Maybe it can be defined as a constant?

sugiyem · 2022-08-30T17:01:47Z

src/main/java/dukechatbot/utility/Storage.java

@@ -0,0 +1,83 @@
+package dukechatbot.utility;
+import java.io.*;


Maybe you can list all the imported classes explicitly?

sugiyem · 2022-08-30T17:03:17Z

src/main/java/dukechatbot/utility/TaskList.java

+     * Encapsulates the array list associated with the instance of
+     * TaskList
+     */
+    private ArrayList<Task> tl;


Maybe can rename this variable to make it more descriptive?

sugiyem · 2022-08-30T17:07:30Z

src/main/java/dukechatbot/utility/Parser.java

+                        if (uncap.startsWith("deadline")) {
+                            int idOfSlash = str.indexOf('/');
+                            if (idOfSlash - 9 == 0) {
+                                this.ui.showDescEmptyError("deadline");


I think this deeply nested if-else statement make the code quiet hard to read

sugiyem · 2022-08-30T17:11:12Z

src/main/java/dukechatbot/utility/Ui.java

+    /**
+     * Defines the array list that is associated with the program run.
+     */
+    private ArrayList<Task> tl;


I think this variable can also be renamed to something more descriptive.

Duke was a CLI application. To make it more appealing, we should implement a basic GUI. Added basic GUI functionality using JavaFx.

There was no documentation for the new classes previously. We need documentation to explain the new classes to fellow programmers. Documented the different classes implementing the GUI.

paullee18

Overall good but some minor coding standard violations.

paullee18 · 2022-09-02T05:32:16Z

src/main/java/dukechatbot/duke/Duke.java

+    private Storage storage;
+    private TaskList tasks;
+    private Ui ui;
+    private ArrayList<Task> al;


Perhaps there's no need for another ArrayList when theres already a TaskList

paullee18 · 2022-09-02T05:34:46Z

src/main/java/dukechatbot/utility/Parser.java

+                    if (uncap.startsWith("unmark")) {
+                        int i = Integer.parseInt(String.valueOf(uncap.charAt(7)));
+                        response = tasks.unmark(i, ui);
+                    } else if (uncap.startsWith("mark")) {


Deeply nested if else loops are quite confusing, perhaps could make use of switch statements instead?

paullee18 · 2022-09-02T05:35:12Z

src/main/java/dukechatbot/utility/Storage.java

@@ -0,0 +1,83 @@
+package dukechatbot.utility;
+import java.io.*;


Could import classes explicitly

paullee18 · 2022-09-02T05:37:04Z

src/main/java/dukechatbot/utility/TaskList.java

+        if (String.valueOf(ln.charAt(4)).equals("X")) {
+            done = true;
+        }
+        if (tag.equals("T")) {


Perhaps this parsing of the command to determine how to create the Todo should be done in the Parser class?

paullee18 · 2022-09-02T05:37:33Z

src/main/java/dukechatbot/utility/TaskList.java

+        String tag = String.valueOf(ln.charAt(1));
+        String desc = null;
+        int id = -1;
+        boolean done = false;


Could use isDone as variable name instead

yuanxi1

Overall, I think your code is clean and easy to understand!

yuanxi1 · 2022-09-02T13:43:42Z

src/main/java/dukechatbot/duke/Duke.java

+            System.out.println("--------------------------------------\n");
+            System.out.println(io.getMessage());
+            System.out.println("--------------------------------------\n");


Maybe this can be abstracted into a utility method, for example formatErrorMessage?

yuanxi1 · 2022-09-02T13:52:38Z

src/main/java/dukechatbot/utility/Ui.java

+    }
+
+    /**
+     * lists out the tasks in the task list to the user.


This is not stated explicitly in the coding standard docs but I think the first letter should be capitalised?

yuanxi1 · 2022-09-02T13:53:52Z

src/main/java/dukechatbot/utility/Ui.java

+    /**
+     * lists out the matching tasks in the task list that meets
+     * the user's find query.
+     * @param tl containing the tasks store in the task list.


Could add an empty line between description and parameter section.

yuanxi1 · 2022-09-02T14:13:01Z

src/main/java/dukechatbot/utility/Storage.java

+        if (file.exists()) {
+            this.load();
+        } else {
+            if (file.createNewFile()) {
+                this.load();
+            } else {
+                throw new IOException("File failed creation!");
+            }
+        }


Since if the named file already exits createNewFile() does nothing and return false, maybe this part can be further simplified?
Besides, the IOException will be thrown if the file already exits, if that's the intended behaviour maybe it would be clearer if the error message indicate that file already exits?

Lan-Jingbo

Very good

save was a non-static method of the Storage class. The save() should be static method since it's associated to Storage class not the instance. Changed save to be static and modified code to work with this change in implementation.

Build.gradle does not point to Launcher class which meant the jar file does not use javaFX. To create a Jar file using JavaFX, we need to point to the Launcher class. Modify build.gradle for javaFX implementation.

The program has no way of testing for errors during the runtime. Assert statements can help with this by forcing the program to terminate on bug. Added Assert statements in some classes to check for runtime error that could have been caused by programmer error.

Add Assert statements.

The Java classes have poor coding quality standards. To improve readability, it is imperative for us to fix this. Improved readability by fixing issues such as deep nested conditionals and extracting methods into helper methods amongst other tweaks.

Improve Code Quality

Duplicate tasks can be added into the Duke task list. This may be a mistake by the user and may cause confusion. Added the methods isDuplicate to check for duplicates, modified the add method and added a method into UI class to implement the feature to prevent duplicate tasks when user tries to add duplicates.

Old template of Duke is for original template from upstream repo. There are alot of updates to Duke with added functionalities to support new features. Updated README for users to learn how to use the new features implemented into Duke.

BufferedReader was placed in the wrong line and may read file before file exists. This can cause the program to fail when user runs an exported jar file. Modifie lines of code to deal with this issue.

Readme was the plain template providede by the greenfield package. We should update the Readme to accurately reflect the features of Duke. Updated the Readme to reflect Duke features and how users cana use Duke.

The Storage constructor has extra try catch block for IOException handling. This is not required with the modified logic of the constructor.

Previously tracked all HTML updates. HTML files are easily generated when needed for javadocs. Removed HTML tracing via gitignore

Name of jar will be duke. Needs the jar build to be named DukeTaskBot. Changed archive build name by shadowjar plugin to be DukeTaskBot

damithc and others added 30 commits July 31, 2022 17:20

Add Gradle support

556af3f

Added Level-1 functionality, Greet, Echo, Exit

f1c8472

Fixed cosmetic bugs and a technical bug where whitespace will result …

187c115

…in a new prompt feedback

Added bye method for more general implementation for the end of opera…

324e89a

…tion of chatbot to minimise code repetition.

Added storeman method for storing of lists of input and outputting th…

9734e6d

…em as a list when the string list is passed as an input

Added Task Class to encapsulate tasks passed as input.

5fc2e89

Added checklist functionality and modified storeman method to accomodate new function. Added listOut method to generalise listing out of tasks, to minimise code repetition.

Added three subclasses of Task; Deadline, Event, Todo

de5b284

Removed reduncant, unused checklist method

e014ef7

Edited Todo Class to meet specifications of project

31322c5

Added support for tracking of three types of classes, Todo, Event and…

f6a01bb

… Deadlines

Replaced contains method with startsWith for program correctness and …

a0d05fa

…flexibility

Added three subclasess of Task; Todo, Event, Deadline

18f224e

removed redundant, not used checklist method(checklist functionality …

288b3d9

…implemented within storeman method). replaced contains with startsWith where appropariate to ensure correctness of program when running.

Various bug fix for Level-3

25b4a83

Change to Guard clause to ensure correctness and better flexibility o…

ff240bc

…f program

Bug Fix for Event TAG attribute

f86fe54

Added support for subclasses of Task; for Todo, Event, Deadline tracking

0be8c1d

Added DukeException for throwing Duke-caused Exceptions

71136ec

Added feature for storeman method to throw DukeException if input is …

e80eff2

…unknown or in the wrong format, to be caught by main. Main will restart duke upon catching the exception and print the message of the error to console right before.

Added to gitignore

238cd67

added to gitignore

0b8ae87

Support for delete added

e0c1635

updated gitignore, added test-ui-test(but to be configured to be igno…

e6d2fb3

…red)

removed debug statement

cecaaf1

update files to be ignored

88cf1a8

Updated input, expected and actual as well as runtest.bat to automate…

2a3278f

… the process of testing

Merge branch 'master' into temp

eee3ade

Merge pull request #1 from jwdavis0200/temp

cc7549a

Merge pull request 1 from temp branch to master branch

Add save and load functionality to Duke and minor changes to String r…

925dbc0

…epresentation of Task and Deadline

jwdavis0200 added 6 commits August 25, 2022 19:08

Add basic JUnit tests for Event and Todo classes

a69734c

No JUnit test to test correctness of classes. We want to test the toString methods of Event and Todo classes to ensure correctness. Added JUnit tests for the toString methods of Event and Todo classes using JUnit.

Fix code to meet Checkstyle.

fd27527

Previously, Checkstyle was not implemented to check for coding standard violations. There are many Checkstyle coding violations upon implementing the Checkstyle Feature via Gradle. Fixed many of such violations to meet the Checkstyle coding standards.

sugiyem reviewed Aug 30, 2022

View reviewed changes

jwdavis0200 added 2 commits August 31, 2022 18:49

Add incomplete Basic GUI functionality to Duke

244af75

Duke was a CLI application. To make it more appealing, we should implement a basic GUI. Added basic GUI functionality using JavaFx.

Document classes implementing UI.

7587212

There was no documentation for the new classes previously. We need documentation to explain the new classes to fellow programmers. Documented the different classes implementing the GUI.

paullee18 reviewed Sep 2, 2022

View reviewed changes

yuanxi1 reviewed Sep 2, 2022

View reviewed changes

Lan-Jingbo reviewed Sep 3, 2022

View reviewed changes

jwdavis0200 added 18 commits September 7, 2022 17:38

Change save method into static

14a0ab7

save was a non-static method of the Storage class. The save() should be static method since it's associated to Storage class not the instance. Changed save to be static and modified code to work with this change in implementation.

Modify build.gradle

0eeb832

Build.gradle does not point to Launcher class which meant the jar file does not use javaFX. To create a Jar file using JavaFX, we need to point to the Launcher class. Modify build.gradle for javaFX implementation.

Add Assert statements.

61b464b

The program has no way of testing for errors during the runtime. Assert statements can help with this by forcing the program to terminate on bug. Added Assert statements in some classes to check for runtime error that could have been caused by programmer error.

Merge pull request #3 from jwdavis0200/branch-Assertions

bf94579

Add Assert statements.

Improve Code Quality

e5945b3

The Java classes have poor coding quality standards. To improve readability, it is imperative for us to fix this. Improved readability by fixing issues such as deep nested conditionals and extracting methods into helper methods amongst other tweaks.

Improve Code Quality

ac4d7b7

The Java classes have poor coding quality standards. To improve readability, it is imperative for us to fix this. Improved readability by fixing issues such as deep nested conditionals and extracting methods into helper methods amongst other tweaks.

Merge pull request #4 from jwdavis0200/branch-CodingStandard

e538329

Improve Code Quality

Update README.md

18b975d

Update README.md

e3ae2d2

Modify README to suit product for user guide.

a767bfe

Old template of Duke is for original template from upstream repo. There are alot of updates to Duke with added functionalities to support new features. Updated README for users to learn how to use the new features implemented into Duke.

Merge branch 'master' of https://github.com/jwdavis0200/ip_own

398ecc7

Modify to fix file reading bug

12e32db

BufferedReader was placed in the wrong line and may read file before file exists. This can cause the program to fail when user runs an exported jar file. Modifie lines of code to deal with this issue.

Update Readme

0eb20d2

Readme was the plain template providede by the greenfield package. We should update the Readme to accurately reflect the features of Duke. Updated the Readme to reflect Duke features and how users cana use Duke.

Modify the guard clauses of Storage constructor.

5f60da7

The Storage constructor has extra try catch block for IOException handling. This is not required with the modified logic of the constructor.

Remove HTML tracking.

990680c

Previously tracked all HTML updates. HTML files are easily generated when needed for javadocs. Removed HTML tracing via gitignore

Move README.md

d43ca9b

Update build.gradle for name of archive

117f869

Name of jar will be duke. Needs the jar build to be named DukeTaskBot. Changed archive build name by shadowjar plugin to be DukeTaskBot

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Johannes] iP #498

[Johannes] iP #498

jwdavis0200 commented Aug 28, 2022 •

edited

Loading

sugiyem left a comment

sugiyem Aug 30, 2022

sugiyem Aug 30, 2022

sugiyem Aug 30, 2022

sugiyem Aug 30, 2022

sugiyem Aug 30, 2022

sugiyem Aug 30, 2022

sugiyem Aug 30, 2022

paullee18 left a comment

paullee18 Sep 2, 2022

paullee18 Sep 2, 2022

paullee18 Sep 2, 2022

paullee18 Sep 2, 2022

paullee18 Sep 2, 2022

yuanxi1 left a comment

yuanxi1 Sep 2, 2022 •

edited

Loading

yuanxi1 Sep 2, 2022 •

edited

Loading

yuanxi1 Sep 2, 2022 •

edited

Loading

yuanxi1 Sep 2, 2022 •

edited

Loading

Lan-Jingbo left a comment

		@@ -0,0 +1,83 @@
		package dukechatbot.utility;
		import java.io.*;

[Johannes] iP #498

Are you sure you want to change the base?

[Johannes] iP #498

Conversation

jwdavis0200 commented Aug 28, 2022 • edited Loading

Duker

What features do I get with Duker?

sugiyem 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

Choose a reason for hiding this comment

paullee18 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

yuanxi1 left a comment

Choose a reason for hiding this comment

yuanxi1 Sep 2, 2022 • edited Loading

Choose a reason for hiding this comment

yuanxi1 Sep 2, 2022 • edited Loading

Choose a reason for hiding this comment

yuanxi1 Sep 2, 2022 • edited Loading

Choose a reason for hiding this comment

yuanxi1 Sep 2, 2022 • edited Loading

Choose a reason for hiding this comment

Lan-Jingbo left a comment

Choose a reason for hiding this comment

jwdavis0200 commented Aug 28, 2022 •

edited

Loading

yuanxi1 Sep 2, 2022 •

edited

Loading

yuanxi1 Sep 2, 2022 •

edited

Loading

yuanxi1 Sep 2, 2022 •

edited

Loading

yuanxi1 Sep 2, 2022 •

edited

Loading