[yu-sutong] iP #644

yu-sutong · 2024-09-04T13:28:10Z

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

text-based
easy to learn
SUPER FAST 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)

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.

kevin-pek

LGTM, just have some nitpicks with regards to the coding standards. Have highlighted them for your consideration. Thanks!

kevin-pek · 2024-09-06T14:07:57Z

src/main/java/mysutong/Parser.java

+            switch (command) {
+                case "bye":
+                    ui.showGoodbye();
+                    System.exit(0);
+                    break;
+
+                case "list":
+                    ui.showTaskList(tasks);
+                    break;
+
+                case "mark":
+                    int markIndex = Integer.parseInt(inputs[1]) - 1;
+                    tasks.getTask(markIndex).markAsDone();
+                    ui.showLine();
+                    ui.showMessage("Nice! I've marked this task as done:");
+                    ui.showMessage(tasks.getTask(markIndex).toString());
+                    ui.showLine();
+                    storage.save(tasks);
+                    break;
+
+                case "unmark":
+                    int unmarkIndex = Integer.parseInt(inputs[1]) - 1;
+                    tasks.getTask(unmarkIndex).unmark();
+                    ui.showLine();
+                    ui.showMessage("OK, I've marked this task as not done yet:");
+                    ui.showMessage(tasks.getTask(unmarkIndex).toString());
+                    ui.showLine();
+                    storage.save(tasks);
+                    break;
+
+                case "todo":
+                    tasks.addTask(new Todo(inputs[1]));
+                    ui.showLine();
+                    ui.showMessage("Got it. I've added this task:");
+                    ui.showMessage(tasks.getTask(tasks.getTasks().size() - 1).toString());
+                    ui.showLine();
+                    storage.save(tasks);
+                    break;
+
+                case "deadline":
+                    String[] deadlineDetails = inputs[1].split("/by");
+                    tasks.addTask(new Deadline(deadlineDetails[0].trim(), LocalDateTime.parse(deadlineDetails[1].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm"))));
+                    ui.showLine();
+                    ui.showMessage("Got it. I've added this task:");
+                    ui.showMessage(tasks.getTask(tasks.getTasks().size() - 1).toString());
+                    ui.showLine();
+                    storage.save(tasks);
+                    break;
+
+                case "event":
+                    String[] eventDetails = inputs[1].split("/from|/to");
+                    tasks.addTask(new Event(eventDetails[0].trim(), LocalDateTime.parse(eventDetails[1].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm")), LocalDateTime.parse(eventDetails[2].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm"))));
+                    ui.showLine();
+                    ui.showMessage("Got it. I've added this task:");
+                    ui.showMessage(tasks.getTask(tasks.getTasks().size() - 1).toString());
+                    ui.showLine();
+                    storage.save(tasks);
+                    break;
+
+                case "delete":
+                    int deleteIndex = Integer.parseInt(inputs[1]) - 1;
+                    Task removedTask = tasks.getTask(deleteIndex);
+                    tasks.removeTask(deleteIndex);
+                    ui.showLine();
+                    ui.showMessage("Noted. I've removed this task:");
+                    ui.showMessage(removedTask.toString());
+                    ui.showLine();
+                    storage.save(tasks);
+                    break;
+
+                default:
+                    throw new UnknownCommandException("I'm sorry, but I don't know what that means.");
+            }


Suggested change

switch (command) {

case "bye":

ui.showGoodbye();

System.exit(0);

break;

case "list":

ui.showTaskList(tasks);

break;

case "mark":

int markIndex = Integer.parseInt(inputs[1]) - 1;

tasks.getTask(markIndex).markAsDone();

ui.showLine();

ui.showMessage("Nice! I've marked this task as done:");

ui.showMessage(tasks.getTask(markIndex).toString());

ui.showLine();

storage.save(tasks);

break;

case "unmark":

int unmarkIndex = Integer.parseInt(inputs[1]) - 1;

tasks.getTask(unmarkIndex).unmark();

ui.showLine();

ui.showMessage("OK, I've marked this task as not done yet:");

ui.showMessage(tasks.getTask(unmarkIndex).toString());

ui.showLine();

storage.save(tasks);

break;

case "todo":

tasks.addTask(new Todo(inputs[1]));

ui.showLine();

ui.showMessage("Got it. I've added this task:");

ui.showMessage(tasks.getTask(tasks.getTasks().size() - 1).toString());

ui.showLine();

storage.save(tasks);

break;

case "deadline":

String[] deadlineDetails = inputs[1].split("/by");

tasks.addTask(new Deadline(deadlineDetails[0].trim(), LocalDateTime.parse(deadlineDetails[1].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm"))));

ui.showLine();

ui.showMessage("Got it. I've added this task:");

ui.showMessage(tasks.getTask(tasks.getTasks().size() - 1).toString());

ui.showLine();

storage.save(tasks);

break;

case "event":

String[] eventDetails = inputs[1].split("/from|/to");

tasks.addTask(new Event(eventDetails[0].trim(), LocalDateTime.parse(eventDetails[1].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm")), LocalDateTime.parse(eventDetails[2].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm"))));

ui.showLine();

ui.showMessage("Got it. I've added this task:");

ui.showMessage(tasks.getTask(tasks.getTasks().size() - 1).toString());

ui.showLine();

storage.save(tasks);

break;

case "delete":

int deleteIndex = Integer.parseInt(inputs[1]) - 1;

Task removedTask = tasks.getTask(deleteIndex);

tasks.removeTask(deleteIndex);

ui.showLine();

ui.showMessage("Noted. I've removed this task:");

ui.showMessage(removedTask.toString());

ui.showLine();

storage.save(tasks);

break;

default:

throw new UnknownCommandException("I'm sorry, but I don't know what that means.");

}

switch (command) {

case "bye":

ui.showGoodbye();

System.exit(0);

break;

case "list":

ui.showTaskList(tasks);

break;

case "mark":

int markIndex = Integer.parseInt(inputs[1]) - 1;

tasks.getTask(markIndex).markAsDone();

ui.showLine();

ui.showMessage("Nice! I've marked this task as done:");

ui.showMessage(tasks.getTask(markIndex).toString());

ui.showLine();

storage.save(tasks);

break;

case "unmark":

int unmarkIndex = Integer.parseInt(inputs[1]) - 1;

tasks.getTask(unmarkIndex).unmark();

ui.showLine();

ui.showMessage("OK, I've marked this task as not done yet:");

ui.showMessage(tasks.getTask(unmarkIndex).toString());

ui.showLine();

storage.save(tasks);

break;

case "todo":

tasks.addTask(new Todo(inputs[1]));

ui.showLine();

ui.showMessage("Got it. I've added this task:");

ui.showMessage(tasks.getTask(tasks.getTasks().size() - 1).toString());

ui.showLine();

storage.save(tasks);

break;

case "deadline":

String[] deadlineDetails = inputs[1].split("/by");

tasks.addTask(new Deadline(deadlineDetails[0].trim(), LocalDateTime.parse(deadlineDetails[1].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm"))));

ui.showLine();

ui.showMessage("Got it. I've added this task:");

ui.showMessage(tasks.getTask(tasks.getTasks().size() - 1).toString());

ui.showLine();

storage.save(tasks);

break;

case "event":

String[] eventDetails = inputs[1].split("/from|/to");

tasks.addTask(new Event(eventDetails[0].trim(), LocalDateTime.parse(eventDetails[1].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm")), LocalDateTime.parse(eventDetails[2].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm"))));

ui.showLine();

ui.showMessage("Got it. I've added this task:");

ui.showMessage(tasks.getTask(tasks.getTasks().size() - 1).toString());

ui.showLine();

storage.save(tasks);

break;

case "delete":

int deleteIndex = Integer.parseInt(inputs[1]) - 1;

Task removedTask = tasks.getTask(deleteIndex);

tasks.removeTask(deleteIndex);

ui.showLine();

ui.showMessage("Noted. I've removed this task:");

ui.showMessage(removedTask.toString());

ui.showLine();

storage.save(tasks);

break;

default:

throw new UnknownCommandException("I'm sorry, but I don't know what that means.");

}

The coding standard mentions that switch statements should not have indentation for case clauses. Default formatting for your IDE may have conflicted with this.

kevin-pek · 2024-09-06T14:08:30Z

src/main/java/mysutong/Storage.java

+            switch (taskType) {
+                case "T":
+                    task = new Todo(description);
+                    break;
+                case "D":
+                    LocalDateTime deadlineDate = LocalDateTime.parse(parts[3], DateTimeFormatter.ofPattern("d/M/yyyy HHmm"));
+                    task = new Deadline(description, deadlineDate);
+                    break;
+                case "E":
+                    LocalDateTime eventStart = LocalDateTime.parse(parts[3], DateTimeFormatter.ofPattern("d/M/yyyy HHmm"));
+                    LocalDateTime eventEnd = LocalDateTime.parse(parts[4], DateTimeFormatter.ofPattern("d/M/yyyy HHmm"));
+                    task = new Event(description, eventStart, eventEnd);
+                    break;
+                default:
+                    throw new IllegalStateException("Unknown task type: " + taskType);
+            }


Same issue with switch formatting.

kevin-pek · 2024-09-06T14:09:14Z

src/main/java/mysutong/Storage.java

+import mysutong.Deadline;
+import mysutong.Event;
+
+import java.io.*;


Imports should be made explicit according to the coding standard.

Suggested change

import java.io.*;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.BufferedWriter;

import java.io.IOException;

kevin-pek · 2024-09-06T14:15:32Z

src/main/java/mysutong/Parser.java

+
+                case "event":
+                    String[] eventDetails = inputs[1].split("/from|/to");
+                    tasks.addTask(new Event(eventDetails[0].trim(), LocalDateTime.parse(eventDetails[1].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm")), LocalDateTime.parse(eventDetails[2].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm"))));


This line is past the 120 character line limit for the coding standards. It would be good to consider doing line wrapping. Alternatively you might want to separate the logic into multiple lines instead.

Suggested change

tasks.addTask(new Event(eventDetails[0].trim(), LocalDateTime.parse(eventDetails[1].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm")), LocalDateTime.parse(eventDetails[2].trim(), DateTimeFormatter.ofPattern("d/M/yyyy HHmm"))));

tasks.addTask(new Event(eventDetails[0].trim(),

LocalDateTime.parse(eventDetails[1].trim(),

DateTimeFormatter.ofPattern("d/M/yyyy HHmm")),

LocalDateTime.parse(eventDetails[2].trim(),

DateTimeFormatter.ofPattern("d/M/yyyy HHmm"))));

# Conflicts: # src/main/java/mysutong/Storage.java

# Conflicts: # src/main/java/mysutong/Parser.java # src/main/java/mysutong/Ui.java

The executeCommand method in Parser handles user commands by splitting the input string into two parts: the command itself and any additional arguments. Currently, the split operation does not validate that the input string contains at least one element, which could potentially lead to unexpected behaviour or bugs if empty input is passed. To mitigate this, let's add an assert statement to ensure that the inputs array has at least one element. This ensures that the code always receives a valid command to process. In situations where assertions are enabled, this will help catch empty or invalid commands during development and testing. While this doesn't address user input validation directly (since assert can be disabled in production), it adds an extra layer of safety during development. This change also avoids unnecessary array access errors and improves the stability of the command handling logic.

This commit refactors the code to conform to the Checkstyle configuration, ensuring consistency and compliance with coding standards. Changes made: - Replaced wildcard imports (e.g., import static org.junit.jupiter.api.Assertions.*) with explicit imports for better clarity and to avoid unnecessary imports. - Corrected import order to follow the standard conventions, ensuring that java.* imports are grouped together and listed alphabetically. - Fixed spacing issues, such as ensuring a single space between comments and code, and after operators (e.g., =, +). - Improved overall code readability and conformance to Checkstyle rules by addressing minor formatting inconsistencies. These changes are intended to improve the maintainability of the codebase by ensuring that it follows consistent styling rules as enforced by Checkstyle. By doing this, we minimize the chances of formatting-related errors and enhance code readability across the project. All changes are purely stylistic and do not alter the functionality of the code.

Add assertion to ensure valid command input

Refactor code style to adhere to Checkstyle guidelines

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

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

add MySutong.java

2444f9f

edited MySutong.java for Level-1

63c5161

Added Level-2 requirements to MySutong.java

f6f0834

Added Level-3 requirements to MySutong.java

22d5127

Added Level-4 requirements to MySutong.java

03c23f1

Added A-TextUiTesting requirements

5cc42a8

Added Level-5 requirements for MySutong.java

48d1228

Added Level-6 requirements to MySutong.java

9f681ef

Add Level 7 save feature

6227710

Merge branch 'branch-Level-7'

d671ee6

Add Level 8 features

e5faf70

Merge branch 'branch-Level-8'

e9c381b

Add A-MoreOOP increments

42a5567

Merge branch 'branch-A-MoreOOP'

75357a1

Add A-Packages increments

6904425

Merge branch 'branch-A-Packages'

64bc665

Merge branch 'add-gradle-support'

088c231

Add A-JUnit increments

00682ea

Merge branch 'branch-A-JUnit'

7291aae

kevin-pek reviewed Sep 6, 2024

View reviewed changes

yu-sutong added 7 commits September 7, 2024 01:59

Add A-Jar increments

099842b

Merge branch 'branch-A-Jar'

452885a

Make the code follow OOP

c7e40e7

Add A-JavaDoc increments

dbe8c9d

Add A-CodingStandard increment

f5ff5e5

Add Level-9 increments

96b7f19

Merge branch 'branch-A-JavaDoc'

0c93397

yu-sutong added 16 commits September 14, 2024 22:23

Merge branch 'branch-A-CodingStandard'

b8588bb

# Conflicts: # src/main/java/mysutong/Storage.java

Merge branch 'branch-Level-9'

cb865f8

# Conflicts: # src/main/java/mysutong/Parser.java # src/main/java/mysutong/Ui.java

Add JavaDoc for TaskList methods

93a4976

Make it more OOP

6fb2994

Add Level 10 increments

04e7aec

Make it more OOP

91fda45

Add JavaDoc to classes

f9f94b1

Add A-CheckStyle requirement

b9dd928

Merge pull request #2 from yu-sutong/branch-A-Assertions

ac4ead8

Add assertion to ensure valid command input

Merge pull request #3 from yu-sutong/branch-A-CodeQuality

4f463f0

Refactor code style to adhere to Checkstyle guidelines

Implement C-Priority

337907c

Fix some logical issues in TaskList

4bb5af2

Add A-UserGuide requirements

0ba740e

Edit README.md

4936b86

yu-sutong changed the title ~~Yu Sutong iP~~ [yu-sutong] iP Sep 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[yu-sutong] iP #644

[yu-sutong] iP #644

yu-sutong commented Sep 4, 2024 •

edited

Loading

kevin-pek left a comment

kevin-pek Sep 6, 2024

kevin-pek Sep 6, 2024

kevin-pek Sep 6, 2024

kevin-pek Sep 6, 2024

-import java.io.*;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.BufferedWriter;
+import java.io.IOException;

[yu-sutong] iP #644

Are you sure you want to change the base?

[yu-sutong] iP #644

Conversation

yu-sutong commented Sep 4, 2024 • edited Loading

kevin-pek left a comment

Choose a reason for hiding this comment

kevin-pek Sep 6, 2024

Choose a reason for hiding this comment

kevin-pek Sep 6, 2024

Choose a reason for hiding this comment

kevin-pek Sep 6, 2024

Choose a reason for hiding this comment

kevin-pek Sep 6, 2024

Choose a reason for hiding this comment

yu-sutong commented Sep 4, 2024 •

edited

Loading