[bryancheny] iP #624

bryancheny · 2024-09-02T00:39:36Z

Crack Chatbot Project

Crack is a simple task management chatbot application that helps users manage their tasks efficiently.

Features

Manage tasks with different types: Todo, Deadline, Event
Save and load tasks from a file
User-friendly interface for interaction
Command parsing for task operations

How to Use

Initialize the application: Run the main method in Crack.java.
Add tasks: Use commands to add Todo, Deadline, or Event tasks.
Mark tasks as done: Mark tasks as completed using specific commands.
Save tasks: Tasks are automatically saved to a file.
Load tasks: Tasks are loaded from the file on startup.

./gradlew clean build
./gradlew run

Development Tasks

Add more user commands
Improve error handling

"Crack makes task management a breeze!" - Happy User

This is a fork of this github repository

In build.gradle, the dependencies on distZip and/or distTar causes the shadowJar task to generate a second JAR file for which the mainClass.set("seedu.duke.Duke") does not take effect. Hence, this additional JAR file cannot be run. For this product, there is no need to generate a second JAR file to begin with. Let's remove this dependency from the build.gradle to prevent the shadowJar task from generating the extra JAR file.

yockcheng

Overall, the code followed most of the coding conventions. I noted that you decided to write nested classes inside Task currently. Maybe you could consider abstracting them out instead if the classes start to get longer.

yockcheng · 2024-09-05T07:34:08Z

src/main/java/Crack.java

@@ -0,0 +1,196 @@
+import java.util.Scanner;
+import java.io.File;


Should the imports be done in lexicographical order?

yockcheng · 2024-09-05T07:42:04Z

src/main/java/Crack.java

+                    } else {
+                        System.out.println(divider + " Error: Task number out of range.\n" + divider);
+                    }
+                } catch (Exception e) {


Perhaps we can be more specific with the Exception being caught here?

yockcheng · 2024-09-05T07:42:34Z

src/main/java/Crack.java

+            while (fileScanner.hasNextLine()) {
+                String line = fileScanner.nextLine();
+                String[] parts = line.split(" \\| ");
+                switch (parts[0]) {


Should the indentation of the "cases" be in line with "switch"?

yockcheng · 2024-09-05T07:44:00Z

src/main/java/Task.java

+    public String toString() {
+        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("MMM dd yyyy");
+        return super.toString() + " (from: " + from.format(formatter) + " to: " + to.format(formatter) + ")";
+    }


I like the naming of the variables and methods.

yockcheng · 2024-09-05T07:44:23Z

src/main/java/Task.java

+        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("MMM dd yyyy");
+        return super.toString() + " (from: " + from.format(formatter) + " to: " + to.format(formatter) + ")";
+    }
+}


Perhaps consider adding some javadocs in your code?

chiangqinkang

Apart from some project structure issues, LGTM

chiangqinkang · 2024-09-05T17:30:25Z

src/main/java/Task.java

+    }
+}
+
+class Event extends Task {


I think putting this in another file would make the code neater.

Previously there was no GUI, only CMD-based user interaction. GUI is more user friendly and we chose JavaFX as our GUI based on its ease of use.

Integrated Java's assert statements across multiple classes to enforce important assumptions Included assertions to verify various task assertions were not null

Before this, there were 2 style errors raised by stylecheck. Caused gradle build to display fail message This commit fixes the style issues in Parser.java accordingly.

…ndards Applied the Single Level of Abstraction Principle (SLAP): - Extracted command handling logic from the run() method into dedicated methods such as handleMarkCommand(), handleTodoCommand(), handleDeadlineCommand(), etc. - This refactoring reduces the length of the run() method, making it more concise and easier to read. - Enhances readability by ensuring the run() method operates at a single level of abstraction. Updated Method Header Comments to comply with coding standard.

Merge branch A-Assertions

Merge branch A-CodeQuality

Added Snooze Command (B-Snooze): Implemented the ability to snooze or postpone tasks by updating their dates. Users can now snooze deadlines or events to postpone them with the snooze command. Refactored Crack Class: Removed the unused run() method since the application is now GUI-based. Refactored the getResponse() method to follow the SLAP method.

README was outdated and so updated it to include how to run and credits.

Previously, there was no user guide and new users could be lost on how Crack works. - Updated Crack with a new user guide. - Listed the features of Crack in the user guide.

damithc and others added 19 commits July 11, 2024 16:52

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

Change name and greeting message

b41d2c2

add bot echoing and exit functionality

fe3f1b4

remove bye message from greeting

4248d94

add ability to store user text

0539e3d

add mark as done feature

7da5153

remove class files

1cf5287

add todo, events, deadlines

1e0eb5a

correct test script

f868768

add more error handling cases

490cd5d

add delete function and update tests

c209de6

add tasktype enum

52914b1

Implement saving

54a0bf5

modify gitignore

f95a3f8

Merge Level 7

7cf4601

Add datetimes

e80bdce

Merge Level 8

bb8a90d

yockcheng reviewed Sep 5, 2024

View reviewed changes

chiangqinkang reviewed Sep 5, 2024

View reviewed changes

src/main/java/Task.java Outdated

}

}

class Event extends Task {

Copy link

chiangqinkang Sep 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think putting this in another file would make the code neater.

bryancheny added 9 commits September 6, 2024 08:25

Refactor with Parser, Storage, TaskList and Ui class

548cd6a

Refactor into package

5fa11fd

Merge branch 'add-gradle-support'

bf860bb

Merge gradle branch

e158ccd

Add Parser and TaskList tests

bccd063

Add Java docs

ee99b35

Tweak slightly to conform to coding standard

de5dfe9

Add find task functionality

daa7242

Add Checkstyle

74c696b

bryancheny and others added 11 commits September 16, 2024 15:51

Add GUI with JavaFX

95e54bb

Previously there was no GUI, only CMD-based user interaction. GUI is more user friendly and we chose JavaFX as our GUI based on its ease of use.

Add assertions to document important assumptions throughout the codebase

6914638

Integrated Java's assert statements across multiple classes to enforce important assumptions Included assertions to verify various task assertions were not null

Fix style issues

acae5c9

Before this, there were 2 style errors raised by stylecheck. Caused gradle build to display fail message This commit fixes the style issues in Parser.java accordingly.

Merge pull request #2 from bryancheny/A-Assertions

3429ed1

Merge branch A-Assertions

Merge pull request #3 from bryancheny/A-CodeQuality

53556f4

Merge branch A-CodeQuality

Modify README

22a7dc5

README was outdated and so updated it to include how to run and credits.

Merge tag 'B-Snooze'

1d0d947

Merge branch 'refs/heads/B-Snooze'

dc8edf1

Update README and add userguide

e6bd7f2

Previously, there was no user guide and new users could be lost on how Crack works. - Updated Crack with a new user guide. - Listed the features of Crack in the user guide.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[bryancheny] iP #624

[bryancheny] iP #624

bryancheny commented Sep 2, 2024 •

edited

Loading

yockcheng left a comment

yockcheng Sep 5, 2024

yockcheng Sep 5, 2024

yockcheng Sep 5, 2024

yockcheng Sep 5, 2024

yockcheng Sep 5, 2024

chiangqinkang left a comment

chiangqinkang Sep 5, 2024

		@@ -0,0 +1,196 @@
		import java.util.Scanner;
		import java.io.File;

[bryancheny] iP #624

Are you sure you want to change the base?

[bryancheny] iP #624

Conversation

bryancheny commented Sep 2, 2024 • edited Loading

Crack Chatbot Project

Features

How to Use

Development Tasks

yockcheng left a comment

Choose a reason for hiding this comment

yockcheng Sep 5, 2024

Choose a reason for hiding this comment

yockcheng Sep 5, 2024

Choose a reason for hiding this comment

yockcheng Sep 5, 2024

Choose a reason for hiding this comment

yockcheng Sep 5, 2024

Choose a reason for hiding this comment

yockcheng Sep 5, 2024

Choose a reason for hiding this comment

chiangqinkang left a comment

Choose a reason for hiding this comment

chiangqinkang Sep 5, 2024

Choose a reason for hiding this comment

bryancheny commented Sep 2, 2024 •

edited

Loading