Sharing iP code quality feedback [for @GlennOngJunJie] - Round 2

[soc-se-script]

@GlennOngJunJie We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.

Aspect: Tab Usage

No easy-to-detect issues 👍

Aspect: Naming boolean variables/methods

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

No easy-to-detect issues 👍

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

Example from src/main/java/duke/MainWindow.java lines 36-36:

//        duke = new Duke("data/tasks.txt");

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

Example from src/main/java/duke/Parser.java lines 18-106:

    public String parse(String userInput, Tasklist tasklist, Ui ui, Storage storage) throws FileNotFoundException, ParseException {
        if (userInput.equals("list")) {
            return tasklist.printList();
        } else if (userInput.contains("mark") && userInput.substring(0, 4).equals("mark")) {
            if (userInput.substring(4).equals("")) {
                return "☹ OOPS!!! The task number of mark cannot be empty. Type /help for user guide.";
            }
            try {
                Integer.parseInt(userInput.substring(5));
            } catch (NumberFormatException nfe) {
                return "☹ OOPS!!! No number detected. Type /help for user guide.";
            }
            if (Integer.valueOf(userInput.substring(5)) > tasklist.taskSize() || Integer.valueOf(userInput.substring(5)) < 1 ) {
                return "☹ OOPS!!! The task number is not present in the tasklist. Type /help for user guide.";
            }
            assert userInput.substring(4).equals("") || Integer.valueOf(userInput.substring(5)) <= tasklist.taskSize();
            int position = Integer.valueOf(userInput.substring(5));
            return tasklist.updateTask("mark", position - 1);
        } else if (userInput.contains("unmark") && userInput.substring(0, 6).equals("unmark")) {
            if (userInput.substring(6).equals("")) {
                return "☹ OOPS!!! The task number of mark cannot be empty. Type /help for user guide.";
            }
            try {
                Integer.parseInt(userInput.substring(7));
            } catch (NumberFormatException nfe) {
                return "☹ OOPS!!! No number detected. Type /help for user guide.";
            }
            if (Integer.valueOf(userInput.substring(7)) > tasklist.taskSize() || Integer.valueOf(userInput.substring(7)) < 1) {
                return "☹ OOPS!!! The task number is not present in the tasklist. Type /help for user guide.";
            }
            assert userInput.substring(6).equals("") || Integer.valueOf(userInput.substring(7)) <= tasklist.taskSize();
            int position = Integer.valueOf(userInput.substring(7));
            return tasklist.updateTask("unmark", position - 1);
        } else if (userInput.contains("delete") && userInput.substring(0, 6).equals("delete")) {
            if (userInput.substring(6).equals("")) {
                return "☹ OOPS!!! The task number of mark cannot be empty. Type /help for user guide.";
            }
            try {
                Integer.parseInt(userInput.substring(7));
            } catch (NumberFormatException nfe) {
                return "☹ OOPS!!! No number detected. Type /help for user guide.";
            }
            if (Integer.valueOf(userInput.substring(7)) > tasklist.taskSize() || Integer.valueOf(userInput.substring(7)) < 1) {
                return "☹ OOPS!!! The task number is not present in the tasklist. Type /help for user guide.";
            }
            assert userInput.substring(6).equals("") || Integer.valueOf(userInput.substring(7)) <= tasklist.taskSize();
            int position = Integer.valueOf(userInput.substring(7));
            return tasklist.updateTask("delete", position - 1);
        } else if (userInput.contains("todo") && userInput.substring(0, 4).equals("todo")) {
            if (userInput.substring(4).equals("")) {
                return "☹ OOPS!!! The description of a todo cannot be empty. Type /help for user guide.";
            } else {
                assert (userInput.substring(4) != null);
                return tasklist.addingActivities("todo", userInput);
            }
        } else if (userInput.contains("deadline") && userInput.substring(0, 8).equals("deadline")) {
            if (userInput.substring(8).equals("")) {
                return "☹ OOPS!!! The description of a deadline cannot be empty. Type /help for user guide.";
            } else {
                assert (userInput.substring(8) != null);
                return tasklist.addingActivities("deadline", userInput);
            }
        } else if (userInput.contains("event") && userInput.substring(0, 5).equals("event")) {
            if (userInput.substring(5).equals("")) {
                return "☹ OOPS!!! The description of a event cannot be empty. Type /help for user guide.";
            } else {
                assert (userInput.substring(6) != null);
                return tasklist.addingActivities("event", userInput);
            }
        } else if (userInput.contains("find") && userInput.substring(0, 4).equals("find")) {
            if (userInput.substring(4).equals("")) {
                return "☹ OOPS!!! The description of find cannot be empty. Type /help for user guide.";
            } else {
                assert (userInput.substring(4) != null);
                return tasklist.findingActivities(userInput.substring(5));
            }
        } else if (userInput.equals("bye")) {
            assert (storage != null);
            storage.saveToFile(tasklist);
            storage.storageClose();
            return ui.bye();
        } else if (userInput.startsWith("/help")){
            return ui.help();
        } else if (userInput.startsWith("/example")) {
            return ui.example();
        } else {
            return "☹ OOPS!!! I'm sorry, but I don't know what that means :-( Type /help for user guide.";
        }
    }

Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods e.g., extract some code blocks into separate methods. You may ignore this suggestion if you think a longer method is justified in a particular case.

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/duke/Task.java lines 52-56:

    /**
     * Return true if a particular task is marked and false if task is unmarked.
     *
     * @return a boolean to see if a task has been completed.
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

Aspect: Recent Git Commit Message (Subject Only)

possible problems in commit a99e966:

Adding readme to /docs filed

• Not in imperative mood (?)

possible problems in commit 53ef12f:

Fixed bug where assert was on the wrong line and delete and unmark with wrong values

• Not in imperative mood (?)
• Longer than 72 characters

possible problems in commit 9ec8768:

Fixed JAR file link

• Not in imperative mood (?)

Suggestion: Follow the given conventions for Git commit messages for future commits (no need to modify past commit messages).

Aspect: Binary files in repo

No easy-to-detect issues 👍

❗ You are not required to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality issues.

ℹ️ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact [email protected] if you want to follow up on this post.