[seandias] iP #627

seandias · 2024-09-02T03:29:04Z

iP Project: Code Refactoring and Javadoc Update

This pull request includes significant improvements to the code structure and documentation. Below are the details of the changes made:

Key Changes Implemented

📝 Added missing Javadoc comments across multiple classes.
🔧 Resolved Checkstyle issues related to:
- Import ordering
- Indentation
- Line length.
🛠️ Improved the structure and readability of core classes:
- Parser.java
- ToStore.java
- Task-related classes like Deadline, Task, and ToDo.

Detailed Steps Performed

Refactored the Parser.java class to fix operator wrapping and indentation issues.
Added Javadoc comments for all methods and classes, including CommandType, Event, Task, Deadline, and ToDo.
Merged changes from the Git-Standard branch into master.
Passed all unit tests after making the changes.
Fixed all remaining Checkstyle violations.

Code Example: `Parser.java`

Here is an updated snippet from the Parser.java class, showing improved indentation and operator wrapping:

// Example of refactored code from Parser.java
public static Task parseAddCommand(String input, CommandType type) {
    switch (type) {
    case TODO:
        String description = input.substring(5).trim();
        if (description.isEmpty()) {
            throw new IllegalArgumentException("OOPS!!! The description of a todo cannot be empty.");
        }
        return new ToDo(description);
    case DEADLINE:
        String[] deadlineParts = input.substring(9).split(" /by ");
        if (deadlineParts.length < 2 or deadlineParts[0].trim().isEmpty() || deadlineParts[1].trim().isEmpty()) {
            throw new IllegalArgumentException("OOPS!!! The description or deadline cannot be empty.");
        }
        return new Deadline(deadlineParts[0].trim(), deadlineParts[1].trim());
    // ... remaining cases
    default:
        throw new IllegalArgumentException("OOPS!!! I'm sorry, but I don't know what that means :-(");
    }
}

Task List

Refactor Parser.java for better readability.
Add Javadoc comments to all methods.
Resolve all Checkstyle violations.
Merge the latest changes from the documentation branch.

"Code is like humor. When you have to explain it, it’s bad." — Cory House

For more information, check out the Java Coding Standards.

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.

Update Level

More-OOP

GRADLE

# Conflicts: # src/main/java/skd/CommandType.java # src/main/java/skd/Parser.java # src/main/java/skd/SKD.java # src/main/java/skd/ToStore.java # src/main/java/skd/Ui.java # src/main/java/task/Deadline.java # src/main/java/task/Event.java # src/main/java/task/Task.java # src/main/java/task/TaskType.java # src/main/java/task/ToDo.java

# Conflicts: # src/main/java/skd/SKD.java # src/main/java/skd/command/CommandType.java # src/main/java/skd/command/Parser.java # src/main/java/task/Deadline.java # src/main/java/task/Event.java # src/main/java/task/Task.java # src/main/java/task/TaskType.java # src/main/java/task/ToDo.java

L-rrrr

It is very good overall! There is no violation in naming convention!

L-rrrr · 2024-09-05T03:33:18Z

src/main/java/skd/SkD.java

+import skd.command.Parser;
+import skd.storage.ToStore;
+import skd.ui.Ui;
+import task.Task;


I like how you organise the imports by separating different kinds of them

L-rrrr · 2024-09-05T03:33:51Z

src/main/java/skd/SkD.java

+    public void run() {
+        ui.showWelcome();
+        Scanner scanner = new Scanner(System.in);
+        boolean isRunning = true;


I like how you name the boolean variable

L-rrrr · 2024-09-05T03:34:13Z

src/main/java/skd/command/CommandType.java

+/**
+ * Represents the different types of commands that the parser can interpret from user input.
+ */
+public enum CommandType {


I like how you used enum here

L-rrrr · 2024-09-05T03:35:22Z

src/main/java/skd/command/Parser.java

+                    || eventParts[1].trim().isEmpty()
+                    || eventParts[2].trim().isEmpty()) {


I like how you make an extremely long line shorter by dividing them into 3 parts

L-rrrr · 2024-09-05T03:37:54Z

src/main/java/task/Task.java

+     *
+     * @param taskCount The current number of tasks in the list.
+     */
+    public void printTaskRemovedMessage(int taskCount) {


I like how you name the method to explain what it does

FYL2003 · 2024-09-05T14:28:27Z

src/main/java/skd/command/Parser.java

+package skd.command;
+
+import java.util.List;
+


The separation between different groups of import looks good to me.

FYL2003 · 2024-09-05T14:31:57Z

src/main/java/task/Deadline.java

+ */
+public class Deadline extends Task {
+    private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm");
+    private static final DateTimeFormatter OUTPUT_FORMATTER = DateTimeFormatter.ofPattern("MMM dd yyyy, HH:mm");


I like how those final fields are represented.

FYL2003 · 2024-09-05T14:33:13Z

src/main/java/task/ToDo.java

+/**
+ * Represents a To-Do task, which is a basic task with only a description and no time constraints.
+ */
+public class ToDo extends Task {


I like your explanation about this class

FYL2003 · 2024-09-05T14:34:48Z

src/main/java/skd/SkD.java

+ * of the user's task list between sessions.
+ */
+public class SkD {
+    private ToStore storage;


I like how you name this variable

FYL2003 · 2024-09-05T14:36:28Z

src/main/java/task/Task.java

+ */
+public abstract class Task {
+    protected String description;
+    protected boolean isDone;


I like how you name the boolean variable

FYL2003

I think there is no violation of coding standard

This reverts commit 1329973.

-It needs to have a JavaDoc comment to pass. -I added a JavaDoc comment for it. -Now with the comment it passes checkstyle conditions.

This reverts commit fc139ed.

This reverts commit 58ce543.

Allows for code to be tested and easier identification of error location. Assertions added in to check storage. Nne of the main checkpoints.

A- UserGuide

* 'master' of https://github.com/seandias/ip: A- UserGuide

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

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

Level 0

8bd2a3b

Level 1

640fd1d

Level 2

945ac05

Level 3+4+5

54c07ac

Level6

2ab0521

Use Enum

a380541

Level-7

1ebf834

Merge branch 'Level7'

68bfe01

Update Level

Level-8

c697c7f

Divide-into-packages

fca5d00

More-OOP

ec24a2d

Merge tag 'More-OOP'

bcbdfac

More-OOP

Merge branch 'add-gradle-support'

766b294

GRADLE

Implement Gradle and make test cases work

0e0e293

Level-9

1cea48e

More-OOP

43883b7

Look for errors

2fd652f

A-MoreOOP

122eb49

A-MoreOOP

7e01ea7

CodeStyle change

15ea043

Git Standard

88c1ff7

L-rrrr approved these changes Sep 5, 2024

View reviewed changes

FYL2003 reviewed Sep 5, 2024

View reviewed changes

seandias and others added 30 commits September 11, 2024 13:21

Add Gui to Chatbot

1329973

Revert "Add Gui to Chatbot"

fc139ed

This reverts commit 1329973.

-Initialise in MainWindow is does not pass checkstlye.

10699ff

-It needs to have a JavaDoc comment to pass. -I added a JavaDoc comment for it. -Now with the comment it passes checkstyle conditions.

Added Javadoc

58ce543

-Initialise in MainWindow is does not pass checkstlye.

7819d8f

-It needs to have a JavaDoc comment to pass. -I added a JavaDoc comment for it. -Now with the comment it passes checkstyle conditions.

Revert "Revert "Add Gui to Chatbot""

bce2a8b

This reverts commit fc139ed.

Revert "Added Javadoc"

8f0b398

This reverts commit 58ce543.

Merge tag 'A-CodeQuality'

a4ab078

No testing in between to make sure the code works correctly.

95e8012

Allows for code to be tested and easier identification of error location. Assertions added in to check storage. Nne of the main checkpoints.

Snooze function

b3e675b

Merge branch 'BCD-Extension'

f73cb7c

A- UserGuide

7d3d234

Merge pull request #2 from seandias/patch-1

a7eb4a5

A- UserGuide

Merge branch 'master' of https://github.com/seandias/ip

f2749f5

* 'master' of https://github.com/seandias/ip: A- UserGuide

Current commit

be08ef7

Current commit

efb162c

Add README.md

46eb74e

Format Fix

06eb13b

Added Ui

e5d001d

Update picture

bc1a8a9

Update picture

e27cf77

Update README.md

28ff7fb

Update README.md

0dbf968

Update Ui.java

023ddd4

Update ToStore.java

1a0eb3b

Update Main.java

14f214e

Update DialogBox.java

92457bf

Update SkD.java

6e89408

Update Parser.java

cb66105

Update README.md

7ada754

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[seandias] iP #627

[seandias] iP #627

seandias commented Sep 2, 2024 •

edited

Loading

L-rrrr left a comment

L-rrrr Sep 5, 2024

L-rrrr Sep 5, 2024

L-rrrr Sep 5, 2024

L-rrrr Sep 5, 2024

L-rrrr Sep 5, 2024

FYL2003 Sep 5, 2024

FYL2003 Sep 5, 2024

FYL2003 Sep 5, 2024

FYL2003 Sep 5, 2024

FYL2003 Sep 5, 2024

FYL2003 left a comment

		\|\| eventParts[1].trim().isEmpty()
		\|\| eventParts[2].trim().isEmpty()) {

[seandias] iP #627

Are you sure you want to change the base?

[seandias] iP #627

Conversation

seandias commented Sep 2, 2024 • edited Loading

iP Project: Code Refactoring and Javadoc Update

Key Changes Implemented

Detailed Steps Performed

Code Example: Parser.java

Task List

L-rrrr 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

Choose a reason for hiding this comment

FYL2003 left a comment

Choose a reason for hiding this comment

seandias commented Sep 2, 2024 •

edited

Loading

Code Example: `Parser.java`