[Nicholascyx] ip #625

Nicholascyx · 2024-09-02T01:41:43Z

Kafka

"The path to the future begins right here." - Kafka

Kafka aids you in following the path you are destined to be. It's,

text-based
easy to learn
~~FUN~~ SUPER FUN to use

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:

Managing tasks
Managing deadlines (coming soon)
Reminders (coming soon)

Here's the main method:

public class KafkaLauncher {
    public static void main(String[] args) {
        Application.launch(Main.class, args);
    }
}

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.

hm-yang1

Looks good.
Requested some cosmetic changes.

hm-yang1 · 2024-09-03T05:40:58Z

src/main/java/Kafka.java

+                } else {
+                    if (userInput[0].equalsIgnoreCase("todo")) {
+                        if (userInput.length < 2) {
+                            throw new KafkaException("It seems you've left the details blank. Even the simplest tasks need some direction, don't you think?");


Exception message is quite long and used repeatedly. Maybe store the message as a String variable? Or write a function to throw a new exception?

hm-yang1 · 2024-09-03T05:48:38Z

src/main/java/Event.java

@@ -0,0 +1,16 @@
+public class Event extends Task {
+
+    protected String from;


I don't see the protected access modifier often. Quite curious about the reason

hm-yang1 · 2024-09-03T06:52:51Z

src/main/java/Kafka.java

+                   __  __            __     _
+                  |  |/  /  ____   _/  /_  | |      ____
+                  |     /  / _  | |_    _| | |/ /  / _  |
+                  |     \\ | |_| |   |  |   |   <  | |_| |
+                  |__|\\__\\ \\____|   |__|   |_|\\ \\  \\____|
+                """;


Nice. I wouldn't be able to create that and adds character to the bot

hm-yang1 · 2024-09-03T07:06:00Z

src/main/java/Kafka.java

+        System.out.println("  Now you have " + this.tasks.size() + " task(s) in the list.");
+    }
+
+    public void createList() {


The function name is a little misleading as it does not create a new list. Perhaps getList or printList might be better?

hm-yang1 · 2024-09-03T07:15:36Z

src/main/java/Kafka.java

+                    int taskNumber = Integer.parseInt(userInput[1]);
+                    kafka.delete(taskNumber);
+                } else {
+                    if (userInput[0].equalsIgnoreCase("todo")) {


Nested if statements are not as easy to read. Is it possible to just add more elif to handle the add task cases instead of nesting them in the else block?

Able to write the list of tasks into Kafka.txt

Easier format to read files

It can now read from the Kafka.txt and update the list.

Exceptions to handle incorrect date format had been added as well.

Some tasklist functions are also added, will continue in the next commit. Created files for Parser and Storage as well

Included some Parser and TaskList functions as well

Finished up all the functions and sync them together correctly

TaskList test is still not done yet, will complete it afterwards

blackpanther9229 · 2024-09-06T14:00:53Z

src/main/java/kafka/Storage.java

+        return tasks;
+    }
+
+    public void printFileContents(ArrayList<Task> tasks) {


You definitely need JavaDoc comment for this method

blackpanther9229 · 2024-09-06T14:01:33Z

src/main/java/kafka/Storage.java

+        }
+    }
+
+    public void getNewFile(String filePath) {


This method should have JavaDoc comment

blackpanther9229 · 2024-09-06T14:03:52Z

src/main/java/kafka/Parser.java

+
+public class Parser {
+
+    public static void parseCommand(String userInput, TaskList taskList, Storage storage, Ui ui) throws KafkaException, IOException, DateTimeParseException {


you need JavaDoc comment for this

blackpanther9229 · 2024-09-06T14:05:12Z

src/main/java/kafka/Parser.java

+            case "mark":
+                int taskNumberMark = Integer.parseInt(arguments);
+                Task taskToMark = taskList.tasks.get(taskNumberMark - 1);
+                taskList.mark(taskToMark);
+                storage.writeToFile(taskList.tasks);
+                ui.mark(taskToMark);
+                break;
+            case "unmark":
+                int taskNumberUnmark = Integer.parseInt(arguments);
+                Task taskToUnmark = taskList.tasks.get(taskNumberUnmark - 1);
+                taskList.unmark(taskToUnmark);
+                storage.writeToFile(taskList.tasks);
+                ui.unmark(taskToUnmark);
+                break;
+            case "delete":
+                if (taskList.tasks.isEmpty()) {
+                    return;
+                }
+                int taskNumberDelete = Integer.parseInt(arguments);
+                Task taskToDelete = taskList.tasks.get(taskNumberDelete - 1);
+                taskList.delete(taskNumberDelete);
+                storage.writeToFile(taskList.tasks);
+                ui.delete(taskToDelete, taskList);
+                break;
+            case "todo":
+                if (arguments.isEmpty()) {
+                    throw new KafkaException("It seems you've left the details blank. Even the simplest tasks need some direction, don't you think?");
+                }
+                Task todo = new Todo(arguments, false);
+                taskList.addTask(todo);
+                storage.writeToFile(taskList.tasks);
+                ui.addTask(todo, taskList);
+                break;
+            case "deadline":
+                if (arguments.isEmpty()) {
+                    throw new KafkaException("It seems you've left the details blank. Even the simplest tasks need some direction, don't you think?");
+                }
+                String[] deadlineParts = arguments.split("/by ");
+                if (deadlineParts.length < 2) {
+                    throw new KafkaException("It appears the details for this deadline task are off. Let's give it another go, shall we?");
+                }
+                LocalDateTime by = LocalDateTimeConverter.getLocalDateTime(deadlineParts[1]);
+                Task deadline = new Deadline(deadlineParts[0], by, false);
+                taskList.addTask(deadline);
+                storage.writeToFile(taskList.tasks);
+                ui.addTask(deadline, taskList);
+                break;
+            case "event":
+                if (arguments.isEmpty()) {
+                    throw new KafkaException("It seems you've left the details blank. Even the simplest tasks need some direction, don't you think?");
+                }
+                String[] eventParts = arguments.split("/from | /to ");
+                if (eventParts.length < 3) {
+                    throw new KafkaException("It appears the details for this event task are off. Let's give it another go, shall we?");
+                }
+                LocalDateTime from = LocalDateTimeConverter.getLocalDateTime(eventParts[1]);
+                LocalDateTime to = LocalDateTimeConverter.getLocalDateTime(eventParts[2]);
+                Task event = new Event(eventParts[0], from, to, false);
+                taskList.addTask(event);
+                storage.writeToFile(taskList.tasks);
+                ui.addTask(event, taskList);
+                break;


It is better to add some comments for clarifying

Oceankoh

Great Effort! Loved how you customized the different print statements

Oceankoh · 2024-09-06T14:13:06Z

src/main/java/kafka/TaskList.java

+        if (tasks.isEmpty()) {
+            return;
+        }
+        String listMessage = "";


Minor nitpick, but you could consider using StringBuilder for some improvement in time complexity. It is really minor though as the strings are probably not long enough to result in any real world performance benefits :)

Oceankoh · 2024-09-06T14:16:43Z

src/main/java/kafka/Parser.java

+        String command = splitInput[0].toLowerCase();
+        String arguments = splitInput.length > 1 ? splitInput[1] : "";
+
+        switch (command) {


Wow! This is a really long switch case. Could this be broken up into smaller parts? Maybe try creating a method for each case! This would improve code readability!

Oceankoh · 2024-09-06T14:17:44Z

src/test/java/seedu/kafka/StorageTest.java

+import kafka.Deadline;
+import kafka.Storage;
+import kafka.Todo;
+import kafka.Event;
+import kafka.Task;
+import org.junit.jupiter.api.Test;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.time.LocalDateTime;
+import java.util.ArrayList;
+import static org.junit.jupiter.api.Assertions.assertEquals;


Does this follow the package import coding standards?

Oceankoh · 2024-09-06T14:19:14Z

src/main/java/kafka/Kafka.java

+    }
+
+    public static void main(String[] args) {
+        new Kafka("C:/Users/Nicholas/Downloads/Kafka.txt").run();


Would this work if I run it on a non-windows PC?

Elinengu · 2024-09-07T10:58:41Z

src/test/java/seedu/kafka/StorageTest.java

+public class StorageTest {
+
+    @Test
+    public void testWriteTodoToFile() throws IOException {


I think this might not be the naming convention for testing method. Perhaps can double check it on topics?

Elinengu · 2024-09-07T11:12:51Z

src/main/java/kafka/Kafka.java

+    }
+
+    public static void main(String[] args) {
+        new Kafka("C:/Users/Nicholas/Downloads/Kafka.txt").run();


Hello, I think it might not work on other computer (even if it's windows) because the path directory won't be the same. Perhaps it's better to use a relative path instead? And maybe it's better to handle the case where a folder or a txt file has not being created yet to prevent checked exception?

Elinengu · 2024-09-07T11:27:09Z

src/main/java/kafka/Storage.java

+        try (FileWriter fw = new FileWriter(filePath)) {
+            for (Task t : tasks) {
+                if (t instanceof Todo todo) {
+                    fw.write("T | " + todo.isDone + " | "
+                            + todo.description + System.lineSeparator());
+                } else if (t instanceof Deadline deadline) {
+                    fw.write("D | " + deadline.isDone + " | "
+                            + deadline.description + " | " + deadline.by + System.lineSeparator());
+                } else if (t instanceof Event event) {
+                    fw.write("E | " + event.isDone + " | "
+                            + event.description + " | " + event.from + " | " + event.to
+                            + System.lineSeparator());
+                }
+            }


I'm not quite sure about it (since I couldn't run the file) but I think this method might cause only 1 line of task to be written in the final txt file because the writer object is not being created in append mode. Perhaps it's better to check it out?

# Conflicts: # src/main/java/kafka/Parser.java

Some functions are not yet finished

Fix some issues on the chatbot not printing the list of tasks

Parser method has over 30 lines of code which violates code quality. Let's make each switch case into a different function so that there's only one line of code under every switch case.

Some parts of the code need important assumptions that should hold. Let's add some code using assert function in java to document assumptions.

Some part of my code violates the code quality standards. Let's change them and make it more readable and understandable.

Add assertions

This reverts commit 2c9400f, reversing changes made to 16a76a5.

Merge code quality branch

Users sometimes may face the problem of wanting to change the deadline or event date, or delay an event. Let's add a snooze function for users to edit their deadline and event dates.

Made some mistakes in the assertion branch. Let's fix it by adding it again.

Ensures it can be opened across different platforms.

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

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

Added Kafka.java, Added greet and exit message

459380b

Added support for echo

5a9e282

Added support for add and list function, added indentations

b4bbf71

Added new method for list

e134e90

Used ArrayList to store tasks

c8593dd

Added [] for tasks and markAsDone() function

8b32bad

Added support for Mark As Done

eccb99a

Added Deadline, Event and Todo

2792677

Added support for different events

9377e1d

Added support for exceptions

bbf800e

Added support for delete

7a84450

Added support for text-ui-test

246d624

Add changes for text-ui-test

2527e8c

hm-yang1 reviewed Sep 3, 2024

View reviewed changes

Nicholascyx added 13 commits September 4, 2024 09:02

Add support for saving tasks

efa2a78

Able to write the list of tasks into Kafka.txt

Add a create new file function

d2e9b4e

Add improvements for KafkaTextWriter

30ccaeb

Easier format to read files

Add support for loading tasks

6d9bfa9

It can now read from the Kafka.txt and update the list.

Add datetime recogniton for deadlines

ac0f46e

Exceptions to handle incorrect date format had been added as well.

Add datetime recognition for events

a556a31

Add UI class functions

32b6215

Some tasklist functions are also added, will continue in the next commit. Created files for Parser and Storage as well

Add Storage class functions

4c7c84d

Included some Parser and TaskList functions as well

Add Parser class and TaskList class functions

58d631d

Finished up all the functions and sync them together correctly

Add all the classes into a package

b28d0cb

Merge branch 'add-gradle-support' of https://github.com/Nicholascyx/ip

c2a4109

Add gradle into project

00907a3

Add JUnit tests

67cb1a1

TaskList test is still not done yet, will complete it afterwards

Nicholascyx added 4 commits September 6, 2024 14:48

Improve JUnit test for TaskListTest

31ee68b

Add Jar file

fd6d300

Add JavaDoc comments

58a71df

Add Coding Standard changes

0b4ccdb

blackpanther9229 reviewed Sep 6, 2024

View reviewed changes

Oceankoh reviewed Sep 6, 2024

View reviewed changes

Elinengu reviewed Sep 7, 2024

View reviewed changes

Nicholascyx and others added 23 commits September 12, 2024 13:00

Add find function for the tasks

440f471

Merge branch 'branch-A-JavaDoc'

294c546

Merge branch 'branch-Level-9'

d5b379b

# Conflicts: # src/main/java/kafka/Parser.java

Add JavaDoc comments for find functions and resolve conflicts

e090307

Add support for GUI

d8bddd1

Some functions are not yet finished

Add more support for GUI

7e36021

Fix some issues on the chatbot not printing the list of tasks

Add some code quality changes

b080878

Parser method has over 30 lines of code which violates code quality. Let's make each switch case into a different function so that there's only one line of code under every switch case.

Add some additional changes for parser command

b35dcac

Add assertions

edd7146

Some parts of the code need important assumptions that should hold. Let's add some code using assert function in java to document assumptions.

Change more codequality relevant stuff

0303a46

Some part of my code violates the code quality standards. Let's change them and make it more readable and understandable.

Add small adjustments to throw IOException

16a76a5

Merge pull request #2 from Nicholascyx/branch-A-Assertions

80768a8

Add assertions

Merge branch 'master' into branch-A-CodeQuality

2c9400f

Revert "Merge branch 'master' into branch-A-CodeQuality"

ba37625

This reverts commit 2c9400f, reversing changes made to 16a76a5.

Merge pull request #3 from Nicholascyx/branch-A-CodeQuality

015627c

Merge code quality branch

Add more JavaDocs

283b4e4

Add snooze function

94e7c8f

Users sometimes may face the problem of wanting to change the deadline or event date, or delay an event. Let's add a snooze function for users to edit their deadline and event dates.

Add support for assertions

0c71886

Made some mistakes in the assertion branch. Let's fix it by adding it again.

Merge branch 'branch-B-Snooze'

1898269

Update the filepath

42d6385

Ensures it can be opened across different platforms.

Create jar file

c9ce769

Add Readme

13e20f2

Update README.md

d7e2b2f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Nicholascyx] ip #625

[Nicholascyx] ip #625

Nicholascyx commented Sep 2, 2024 •

edited

Loading

hm-yang1 left a comment

hm-yang1 Sep 3, 2024

hm-yang1 Sep 3, 2024

hm-yang1 Sep 3, 2024

hm-yang1 Sep 3, 2024

hm-yang1 Sep 3, 2024

blackpanther9229 Sep 6, 2024

blackpanther9229 Sep 6, 2024

blackpanther9229 Sep 6, 2024

blackpanther9229 Sep 6, 2024

Oceankoh left a comment

Oceankoh Sep 6, 2024

Oceankoh Sep 6, 2024

Oceankoh Sep 6, 2024

Oceankoh Sep 6, 2024

Elinengu Sep 7, 2024

Elinengu Sep 7, 2024

Elinengu Sep 7, 2024

		@@ -0,0 +1,16 @@
		public class Event extends Task {

		protected String from;


		public class Parser {

		public static void parseCommand(String userInput, TaskList taskList, Storage storage, Ui ui) throws KafkaException, IOException, DateTimeParseException {

[Nicholascyx] ip #625

Are you sure you want to change the base?

[Nicholascyx] ip #625

Conversation

Nicholascyx commented Sep 2, 2024 • edited Loading

Kafka

hm-yang1 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Oceankoh 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

Nicholascyx commented Sep 2, 2024 •

edited

Loading