[chashaobao] iP by chashaobao123 · Pull Request #640 · nus-cs2103-AY2425S1/ip

chashaobao123 · 2024-09-03T19:22:19Z

LittleMissHelpful

“Your mind is for having ideas, not holding them.” – David Allen

Ah Bang Mang frees your mind from remembering the things you need to do. It's:

Text-based
Easy to learn
SUPER FAST to use
Singlish Ui

All you need to do is:

Download it from here.
Double-click it.
Add your tasks.
Let it manage your tasks for you 😉.

And the best part? It’s FREE!

Features:

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

If you are a Java programmer, you can use LittleMissHelpful to practice Java too! Here's the main method:

public static void main(String[] args) {
        new LittleMissHelpful("data/LittleMissHelpful.txt").run();
    }

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.

AppleJem · 2024-09-04T02:15:25Z

src/main/java/LittleMissHelpful.java

+        loadTasks(list);
+
+        int counter = list.size();;
+        while (true) { // Continuous input


Would it be better to refactor this part into the the Parse class as suggested in the project brief week 3?

agreed! Separating all the parsing commands into a separate parse class could make the code look neater

Yes, thank you! I have abstracted out the classes now

AppleJem · 2024-09-04T02:19:16Z

src/main/java/LittleMissHelpful.java

+                        System.out.println("Ok, I see you laze. You have marked this task as not done yet: " + curTask.toString());
+                        System.out.println(lineBreak);
+                    } catch (NumberFormatException e) {
+                        System.out.println(lineBreak + "\nHai-yo, task number must be an integer lah.\n" + lineBreak);


This check looks the same as the check for the "mark" command, perhaps can refactor to reduce repetition?

AppleJem · 2024-09-04T02:20:34Z

src/main/java/LittleMissHelpful.java

+                    Task newTask = null;
+
+                    try {
+                        if (command.equalsIgnoreCase("todo")) {


The switch and case statement may come in handy here. (frankly I also never use)

AppleJem · 2024-09-04T02:21:06Z

src/main/java/LittleMissHelpful.java

+                } else {
+                    // Invalid command --> throw exception
+                    System.out.println(
+                        lineBreak + "\nAlamak! Format salah already... Please provide a valid command and description.\n" + lineBreak);


Perhaps can provide some descriptions of what are valid commands

AppleJem · 2024-09-04T02:23:09Z

src/main/java/Deadline.java

@@ -0,0 +1,18 @@
+public class Deadline extends Task {
+    protected String by;


Would it make sense to save the string as Java Datetime instead?

kimberlytmq · 2024-09-05T05:59:39Z

src/main/java/LittleMissHelpful.java

+public class LittleMissHelpful {
+    private static final String FILE_PATH = "./data/LittleMissHelpfullist.txt";
+    public static void main(String[] args) {
+        /**


Maybe you can add this comment in the header instead? (i.e. before the public class in Line 10) It may help others to understand your code purpose better!

kimberlytmq · 2024-09-05T06:02:44Z

src/main/java/LittleMissHelpful.java

+        loadTasks(list);
+
+        int counter = list.size();;
+        while (true) { // Continuous input


agreed! Separating all the parsing commands into a separate parse class could make the code look neater

kimberlytmq · 2024-09-05T06:03:16Z

src/main/java/LittleMissHelpful.java

+
+                if (inputList.length < 2) {
+                    // Check if the user command is "bye" -> exit
+                    if (command.equalsIgnoreCase("bye")) {


Maybe you could separate the UI related code to a UI class?

kimberlytmq · 2024-09-05T06:04:24Z

src/main/java/Task.java

@@ -0,0 +1,112 @@
+public class Task {


Could you consider adding header comments to the classes? Saw this problem in some other classes too.

kimberlytmq · 2024-09-05T06:06:13Z

src/main/java/Task.java

+    protected String description;
+    protected boolean isDone;
+
+    public Task (String description) {


An idea is that you could make this into an abstract class and have the different methods for the different classes in their respective class files! It's just an alternative way to do it that you can consider.

frymash

In general, I think your code is really well-organised and well-abstracted. This is the first time I've seen someone create a Java file for each command. I also like the vibes your bot's responses give. Good job! LGTM.

frymash · 2024-09-05T13:31:45Z

src/main/java/LittleMissHelpful/TaskList.java

@@ -0,0 +1,59 @@
+package main.LittleMissHelpful;
+import java.util.ArrayList;


Small suggestion involving code consistency but I noticed some files have a line of space between the package statement and the import statement while other files don't. The course's coding standard doesn't really prescribe a set way to go about this, but perhaps you could consider either using one or the other.

Thank you for your feedback! I'll be sure to edit this

frymash · 2024-09-05T13:34:37Z

src/main/java/LittleMissHelpful/Ui.java

+import main.LittleMissHelpful.Task.Task;
+
+public class Ui {
+    private static final String LINE_BREAK = "---------------------------------";


Good practice to make the divider a constant so that you don't have to repeat yourself whenever you use it.

frymash · 2024-09-05T15:01:59Z

src/main/java/LittleMissHelpful/Task/Task.java

+        if (parts.length < 3) {
+            throw new InvalidTaskFormatException("Invalid task format: " + taskString);
+        }
+
+        String taskType = parts[0];
+        boolean isDone = parts[1].equals("1");
+        String description = parts[2];
+
+        // Check task type and create corresponding Task
+        if (taskType.equals("T")) {
+            return new Todo(description, isDone);
+
+        } else if (taskType.equals("D")) {
+            if (parts.length != 4) {
+                throw new InvalidTaskFormatException("Invalid Deadline format: " + taskString);
+            }
+            LocalDateTime by = LocalDateTime.parse(parts[3]);
+            return new Deadline(description, isDone, by);
+
+        } else if (taskType.equals("E")) {
+            if (parts.length != 5) {
+                throw new InvalidTaskFormatException("Invalid Event format: " + taskString);
+            }
+
+            LocalDateTime from = LocalDateTime.parse(parts[3]);
+            LocalDateTime to = LocalDateTime.parse(parts[4]);
+            return new Event(description, isDone, from, to);


Could possibly refactor the if-else statement into a switch-case statement (not 100% necessary but a suggestion).

frymash · 2024-09-05T15:17:53Z

src/main/java/LittleMissHelpful/Task/Task.java

+        if (this instanceof Todo) {
+            taskType = "T";
+            description = this.description;
+            return taskType + spacer + isDone + spacer + description;
+
+        } else if (this instanceof Deadline d) {
+            taskType = "D";
+            description = d.description;
+            by = d.by;
+            return taskType + spacer + isDone + spacer + description + spacer + by;
+
+        } else if (this instanceof Event e) {
+            taskType = "E";
+            description = e.description;
+            from = e.from;
+            to = e.to;
+            return taskType + spacer + isDone + spacer + description + spacer + from + spacer + to;
+        } else {
+            throw new InvalidTaskFormatException("Cannot write task: " + this.toString());


Was wondering if the switch-case syntax would be more idiomatic here too

JoanneHing

Overall LGTM! The naming for class , method and variables is well done and convey their purposes clear!

Would be nice if header comments could be added to class and the public method as part of JavaDoc!

Well done!

JoanneHing · 2024-09-06T07:21:04Z

src/main/java/LittleMissHelpful/Command/AddDeadlineCommand.java

+import LittleMissHelpful.Ui;
+import LittleMissHelpful.Exception.InvalidCommandException;
+import LittleMissHelpful.Task.Deadline;
+


The header comment for the class might be missed out, will be good if it could be added in

JoanneHing · 2024-09-06T07:21:43Z

src/main/java/LittleMissHelpful/Command/AddEventCommand.java

The header comment for the class and the public methods is also missed out here, would be nice to add in!

JoanneHing · 2024-09-06T07:22:24Z

src/main/java/LittleMissHelpful/Command/AddEventCommand.java

+        if (dateTimeString.equalsIgnoreCase("today")) {
+            // Use current date and set time to 00:00 (start of the day)
+            return LocalDateTime.now().withHour(00).withMinute(00);
+        }


line breaks could be added here to seperate the section and make the code more readabel : )

JoanneHing · 2024-09-06T07:22:49Z

src/main/java/LittleMissHelpful/Command/Command.java

missing header comment for the class too

JoanneHing · 2024-09-06T07:22:58Z

src/main/java/LittleMissHelpful/Command/DeleteTaskCommand.java

same as above

JoanneHing · 2024-09-06T07:25:15Z

src/main/java/LittleMissHelpful/Parser.java

+        switch (command) {
+            case "mark":
+                return new MarkTaskCommand(Integer.parseInt(item));
+
+            case "unmark":
+                return new UnmarkTaskCommand(Integer.parseInt(item));
+
+            case "delete":
+                return new DeleteTaskCommand(Integer.parseInt(item));
+
+            case "find":
+                return new FindCommand(item);
+
+            case "todo":
+                return new AddTodoCommand(item);
+
+            case "deadline":
+                String[] deadlineParts = item.split("/by", 2);
+                if (deadlineParts.length < 2) {
+                    throw new InvalidCommandException("Invalid deadline format. Use 'deadline description /by date'.");
+                }
+                String deadlineDesc = deadlineParts[0].trim();
+                String deadlineBy = deadlineParts[1].trim();
+                return new AddDeadlineCommand(deadlineDesc, deadlineBy);
+
+            case "event":
+                String[] eventParts = item.split("/from | /to", 3);
+                if (eventParts.length < 3) {
+                    throw new InvalidCommandException("Invalid event format. Use 'event description /from start /to end'.");
+                }
+                String eventDesc = eventParts[0].trim();
+                String eventFrom = eventParts[1].trim();
+                String eventTo = eventParts[2].trim();
+                return new AddEventCommand(eventDesc, eventFrom, eventTo);
+
+            default:
+                throw new InvalidCommandException("Invalid command. Please provide a valid command.");
+        }
+    }


the case should not be indented, would be nice if it is fixed!

JoanneHing · 2024-09-06T07:25:57Z

src/main/java/LittleMissHelpful/Command/AddEventCommand.java

+import LittleMissHelpful.Ui;
+import LittleMissHelpful.Exception.InvalidCommandException;
+import LittleMissHelpful.Task.Event;
+


The commands naming is named well! Easy to understand what the class is handling!

JoanneHing · 2024-09-06T07:26:47Z

src/main/java/LittleMissHelpful/Exception/InvalidCommandException.java

The exceptions class name is named well to let developer understand what exception it is handling too! Well done!

JoanneHing · 2024-09-06T07:27:44Z

src/main/java/LittleMissHelpful/Parser.java

+            }
+        }
+
+        String item = inputList[1];


Maybe item could be named to taskIndex for better understanding?

JoanneHing · 2024-09-06T07:28:17Z

src/main/java/LittleMissHelpful/Task/Event.java

+    // public Event(String description, LocalDate from, LocalDate to) {
+    //     /**
+    //      * Instatiate event without needing to input time
+    //      * Defaults from time to start of the day and end time to end of the day
+    //      */
+    //     super(description);
+    //     this.from = from.atStartOfDay(); // Set default time to start of day
+    //     this.to = to.atStartOfDay().plusDays(1).minusSeconds(1); // Set end of day time
+    // }
+
+    // public Event(String description, boolean isDone, LocalDate from, LocalDate to) {
+    //     /**
+    //      * Instatiate event without needing to input time && isDone
+    //      * Defaults from time to start of the day and end time to end of the day
+    //      */
+    //     super(description, isDone);
+    //     this.from = from.atStartOfDay(); // Set default time to start of day
+    //     this.to = to.atStartOfDay().plusDays(1).minusSeconds(1); // Set end of day time
+    // }


can consider removing unused code to improve code quality

Assertions were added to LittleMissHelpful file to enhance clarity and debugging Let's, * add assertions to LittleMissHelpful * enable assertions in the configurations

Packages were not in full lowercase Let's * rename all packages to follow convention.

Add assertions

Branch a code quality

add date and time for deadline and event

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

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

ip_wk2_level-0

60e495d

ip wk2 level-1

fddb9e9

ip wk2 level-2

48f9b91

wk2 ip level-3

064c6c3

wk2 level-4

97639d6

wk2 ip level-5

4f01857

wk2 ip level-6

1df1350

add automated-text-ui-testing

55989ae

add Level-7 changes

957bf55

AppleJem reviewed Sep 4, 2024

View reviewed changes

chashaobao123 added 2 commits September 4, 2024 11:51

update reading and writing of saved tasks

dfae243

add date and time for deadline and event

0dea61f

kimberlytmq reviewed Sep 5, 2024

View reviewed changes

chashaobao123 added 2 commits September 5, 2024 16:48

abstract more classes

cd8b26e

abstract out classes

421974d

frymash reviewed Sep 5, 2024

View reviewed changes

chashaobao123 added 8 commits September 6, 2024 01:09

Merge remote-tracking branch 'origin/add-gradle-support'

08746c5

correct packages

ba6a7ef

correctly add packages

91afd9e

add JUnit: TaskListTest and UiTest

3da8d0b

add headers

fb664fa

add search function

991b22f

resolve merge conflicts

6df0184

merge branches

c7862f4

JoanneHing reviewed Sep 6, 2024

View reviewed changes

chashaobao123 added 2 commits September 7, 2024 00:58

add gui

1ee7602

add gui

5f50efb

chashaobao123 and others added 19 commits September 15, 2024 00:03

Add assertions

e73a476

Assertions were added to LittleMissHelpful file to enhance clarity and debugging Let's, * add assertions to LittleMissHelpful * enable assertions in the configurations

Update packages to follow convention

b01a403

Packages were not in full lowercase Let's * rename all packages to follow convention.

Update packages

5656a9d

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

620f3de

Add assertions

Resolve import errors

20e7261

Merge with master

e543672

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

668af35

Branch a code quality

Add assertions

c088340

Merge branch 'master' of github.com:chashaobao123/ip

78d3987

Merge Level-8 to master

1c02284

Merge pull request #4 from chashaobao123/branch-Level-8

ac340f4

add date and time for deadline and event

Resolved merge conflicts from pull-request

55d7ca0

Add proper headings

cd35b95

Edit error messages to fit personality

b6f266c

Add JUnit tests

a0b1e69

Update README

6bf7a93

Update README

6f02cc0

Add Ui.png to docs folder

e4dc31b

Update README

dabdb0b

		@@ -0,0 +1,18 @@
		public class Deadline extends Task {
		protected String by;

		@@ -0,0 +1,59 @@
		package main.LittleMissHelpful;
		import java.util.ArrayList;

Conversation

chashaobao123 commented Sep 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

LittleMissHelpful

Features:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frymash left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoanneHing left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

chashaobao123 commented Sep 3, 2024 •

edited

Loading