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

[nus-se-bot]

@jinyang628 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

No easy-to-detect issues 👍

Aspect: Method Length

Example from src/main/java/duke/Parser.java lines 105-150:

    private Event parseEventInput(String[] userInputSegmented) throws InvalidTaskException {
        int fromIndex = 0;
        int toIndex = 0;

        while (fromIndex < userInputSegmented.length) {
            fromIndex++;
            toIndex++;
            if (fromIndex == userInputSegmented.length) {
                throw new InvalidTaskException("ERROR: Missing the /from marker");
            }
            if (userInputSegmented[fromIndex].equals("/from")) {
                fromIndex++;
                toIndex++;
                break;
            }
        }

        while (toIndex < userInputSegmented.length) {
            toIndex++;
            if (toIndex == userInputSegmented.length) {
                throw new InvalidTaskException("ERROR: Missing the /to marker");
            }
            if (userInputSegmented[toIndex].equals("/to")) {
                toIndex++;
                break;
            }
        }

        try {
            LocalDate from = LocalDate.parse(String.join(" ",
                    Arrays.copyOfRange(userInputSegmented, fromIndex, toIndex - 1))
            );
            LocalDate to = LocalDate.parse(String.join(" ",
                    Arrays.copyOfRange(userInputSegmented, toIndex, userInputSegmented.length))
            );
            return new Event(
                    String.join(" ", Arrays.copyOfRange(userInputSegmented, 1, fromIndex - 1)),
                    from, to
            );
        } catch (DateTimeParseException e) {
            throw new InvalidTaskException("ERROR: Date not in YYYY-MM-DD format");
        }



    }

Example from src/main/java/duke/Storage.java lines 30-103:

    public ArrayList<Task> load() throws NoTasksStoredException {
        ArrayList<Task> storedTasks = new ArrayList<>();
        File dataFolder = new File(this.dataFolderName);

        if (!dataFolder.exists()) {
            dataFolder.mkdirs();
        }

        File file = new File(dataFolder, this.fileName);

        if (file.exists()) {
            try {
                BufferedReader reader = new BufferedReader(new FileReader(file));
                String line;
                while ((line = reader.readLine()) != null) {
                    String[] lineSegmented = line.split("\\|");
                    String taskType = lineSegmented[0];
                    String isDone = lineSegmented[1];
                    switch (isDone) {
                    case "X":
                        switch (taskType) {
                        case "T":
                            Todo todoTask = new Todo(lineSegmented[2]);
                            todoTask.markAsDone();
                            storedTasks.add(todoTask);
                            break;
                        case "D":
                            Deadline deadlineTask = new Deadline(lineSegmented[2], lineSegmented[3]);
                            deadlineTask.markAsDone();
                            storedTasks.add(deadlineTask);
                            break;
                        case "E":
                            Event eventTask = new Event(lineSegmented[2], lineSegmented[3], lineSegmented[4]);
                            eventTask.markAsDone();
                            storedTasks.add(eventTask);
                            break;
                        default:
                            System.out.println("Unknown duke.Task Type");
                            break;
                        }
                        break;
                    case " ":
                        switch (taskType) {
                        case "T":
                            Todo todoTask = new Todo(lineSegmented[2]);
                            storedTasks.add(todoTask);
                            break;
                        case "D":
                            Deadline deadlineTask = new Deadline(lineSegmented[2], lineSegmented[3]);
                            storedTasks.add(deadlineTask);
                            break;
                        case "E":
                            Event eventTask = new Event(lineSegmented[2], lineSegmented[3], lineSegmented[4]);
                            storedTasks.add(eventTask);
                            break;
                        default:
                            System.out.println("Unknown duke.Task Type");
                            break;
                        }
                        break;
                    default:
                        System.out.println("Unknown isDone marker");
                        break;
                    }
                }
                reader.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        } else {
            throw new NoTasksStoredException("No stored tasks detected");
        }
        return storedTasks;
    }

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

No easy-to-detect issues 👍

Aspect: Recent Git Commit Message

No easy-to-detect issues 👍

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 cs2103@comp.nus.edu.sg if you want to follow up on this post.