Skip to content

Sharing iP code quality feedback [for @GabrielWLM] #3

Description

@nus-se-bot

We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, to help you improve the code further.

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.java lines 29-139:

    public static void main(String[] args) throws IOException {

        Scanner scanner = new Scanner(System.in);

        String logo = " _           _        \n"
                + "| |    _   _| | _____ \n"
                + "| |   | | | | |/ / _ \\\n"
                + "| |___| |_| |   <  __/\n"
                + "|____/ \\__,_|_|\\_\\___|\n";
        System.out.println("Hello from\n" + logo);

        ArrayList<String> list = new ArrayList<String>();
        int amount = 0;
        
        String lineBreak = "\t____________________________________________________________";
        System.out.println(lineBreak
                + "\n\t Hello! I'm Luke, your slightly useful personal assistant!\n"
                + "\t What can I do for you, my liege?\n"
                + "\t Type 'list' to show previous inputs\n"
                + "\t Type 'todo TASK' to indicate that TASK has to be done\n"
                + "\t Type 'deadline TASK /by DATE/TIME' to indicate that TASK has to be done by DATE/TIME\n"
                + "\t Type 'event TASK /at DATE/TIME PERIOD' to indicate that TASK occurs at DATE/TIME PERIOD\n"
                + "\t Type 'done #' to indicate that task # has been done\n"
                + "\t Type 'bye' to end\n"
                + lineBreak);

        String response = scanner.nextLine();

        while (!response.equals("bye")) {
            if (response.equals("list")) {
                System.out.println(lineBreak);
                System.out.println("\t Here are the tasks in your list:");
                for (int i = 0; i < amount; i++) {
                    System.out.println("\t " + (i + 1) + "." + list.get(i));
                }
                System.out.println(lineBreak);
            } else if (response.matches("done ([0-9]|[1-9][0-9])")) {
                int taskNo = Integer.parseInt(response.replaceAll("\\D", "")) - 1;
                System.out.println(lineBreak);
                System.out.println("\t Nice! I've marked this task as done:");
                list.set(taskNo, list.get(taskNo).substring(0,4) + "X" + list.get(taskNo).substring(5));
                System.out.println("\t " + list.get(taskNo));
                System.out.println(lineBreak);
                save(list);
            } else if (response.matches("delete ([0-9]|[1-9][0-9])")) {
                int taskNo = Integer.parseInt(response.replaceAll("\\D", "")) - 1;
                System.out.println(lineBreak);
                System.out.println("\t Noted. I've removed this task:");
                System.out.println("\t " + list.get(taskNo));
                System.out.println("\t Now you have " + (amount - 1) + " tasks in the list.");
                System.out.println(lineBreak);
                list.set(taskNo, "deleted");
                save(list);
            } else if (response.matches("todo .+")) {
                System.out.println(lineBreak);
                System.out.println("\t Got it. I've added this task:");
                System.out.println("\t   [T][ ] " + response.substring(5));
                System.out.println("\t Now you have " + (amount + 1) + " tasks in the list.");
                System.out.println(lineBreak);
                list.add(amount, "[T][ ] " + response.substring(5));
                amount++;
                save(list);
            } else if (response.matches("deadline .+")) {
                System.out.println(lineBreak);
                System.out.println("\t Got it. I've added this task:");
                int pos = response.indexOf('/');
                list.add(amount, "[D][ ] "
                        + response.substring(9, pos - 1)
                        + " (by: " + response.substring(response.indexOf('/') + 4) + ")");
                System.out.println("\t   " + list.get(amount));
                System.out.println("\t Now you have " + (amount + 1) + " tasks in the list.");
                System.out.println(lineBreak);
                amount++;
                save(list);
            } else if (response.matches("event .+")) {
                System.out.println(lineBreak);
                System.out.println("\t Got it. I've added this task:");
                int pos = response.indexOf('/');
                list.add(amount, "[E][ ] "
                        + response.substring(6, pos - 1)
                        + " (at: " + response.substring(response.indexOf('/') + 4) + ")");
                System.out.println("\t   " + list.get(amount));
                System.out.println("\t Now you have " + (amount + 1) + " tasks in the list.");
                System.out.println(lineBreak);
                amount++;
                save(list);
            } else if (response.equals("todo")) {
                System.out.println(lineBreak);
                System.out.println("☹ OOPS!!! The description of a todo cannot be empty.");
                System.out.println(lineBreak);
            } else if (response.equals("deadline")) {
                System.out.println(lineBreak);
                System.out.println("☹ OOPS!!! The description of a deadline cannot be empty.");
                System.out.println(lineBreak);
            } else if (response.equals("event")) {
                System.out.println(lineBreak);
                System.out.println("☹ OOPS!!! The description of an event cannot be empty.");
                System.out.println(lineBreak);
            } else {
                System.out.println(lineBreak);
                System.out.println("☹ OOPS!!! I'm sorry, but I don't know what that means :-(");
                System.out.println(lineBreak);
            }
            response = scanner.nextLine();
        }
        System.out.println(lineBreak);
        System.out.println("\t Bye! Talk again sometime!");
        System.out.println(lineBreak);

        scanner.close();
    }

Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods. You may ignore this suggestion if you think a longer method is justified in a particular case.

Aspect: Header Comments

No easy-to-detect issues 👍

Aspect: Recent Git Commit Message (Subject Only)

No easy-to-detect issues 👍

ℹ️ The bot account @cs2103-bot 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions