Sharing iP code quality feedback [for @samriddh2145]

[soc-se-script]

@samriddh2145 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 iP 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/Bing.java lines 14-173:

    public static void main(String[] args) {
        String message = "______________________________\n"
                + "Hi! My name is Bing\n"
                + "How can I help you?\n"
                + "______________________________\n";
        System.out.println(message);

        Scanner scanner = new Scanner(System.in);
        String input;
        ArrayList<Task> tasks = new ArrayList<Task>();
        loadTasks(tasks);

        while (true) {
            input = scanner.nextLine().trim();
            if (input.equals("Bye") || input.equals("bye")) {
                System.out.println("______________________________\n"
                        + "Bye. Have a good day.\n"
                        + "______________________________\n");
                break;
            } else if (input.equals("list")) {
                System.out.println("______________________________\n"
                        + "All tasks in your list :\n");
                for (int i=0 ; i<tasks.size() ; i++) {
                    System.out.println((i + 1) + ". " + tasks.get(i).toString());
                }
                System.out.println("______________________________\n");
            } else if (input.startsWith("mark")) {
                try {
                    int x = Integer.parseInt(input.substring(5).trim());
                    if (x > 0 && x<=tasks.size()) {
                        tasks.get(x - 1).setStatus(TaskStatus.DONE);
                        System.out.println("______________________________\n");
                        System.out.println("This task is marked as done :");
                        System.out.println(tasks.get(x-1).toString());
                        System.out.println("______________________________\n");
                        saveTasks(tasks);
                    } else {
                        System.out.println("Invalid Input.\n");
                    }
                } catch (NumberFormatException e) {
                    System.out.println("______________________________\n");
                    System.out.println("Invalid Format");
                    System.out.println("______________________________\n");
                }

            } else if (input.startsWith("unmark")) {
                try {
                    int x = Integer.parseInt(input.substring(7));
                    if (x>0 && x<=tasks.size()) {
                        tasks.get(x-1).setStatus(TaskStatus.UNDONE);
                        System.out.println("______________________________\n");
                        System.out.println("This task is marked as undone :");
                        System.out.println(tasks.get(x-1).toString());
                        System.out.println("______________________________\n");
                        saveTasks(tasks);
                    } else {
                        System.out.println("Invalid Input.\n");
                    }
                } catch (NumberFormatException e) {
                    System.out.println("______________________________\n");
                    System.out.println("Invalid Format");
                    System.out.println("______________________________\n");
                }

            } else if (input.startsWith("todo")) {
                String temp = input.substring(4).trim();
                if (temp.isEmpty()) {
                    System.out.println("Invalid Input.\n");
                } else {
                    Task temp2 = new ToDo(temp);
                    tasks.add(temp2);
                    System.out.println("______________________________\n"
                            + "Added the task:\n"
                            + temp.toString() + "\n"
                            + "Total tasks - " + tasks.size() + "\n"
                            + "______________________________\n");
                    saveTasks(tasks);
                }
            } else if (input.startsWith("deadline ")) {
                try {
                    String[] segments = input.substring(9).split(" /by ");
                    if (segments.length < 2 || segments[0].trim().isEmpty() || segments[1].trim().isEmpty()) {
                        System.out.println("Invalid Input.\n");
                    } else {
                        LocalDateTime deadline = parseDate(segments[1].trim());
                        if (deadline == null) {
                            System.out.println("Invalid date format. Please enter date as d/M/yyyy HHmm");
                            return;
                        }
                        Task temp = new Deadline(segments[0].trim(), deadline);
                        tasks.add(temp);
                        System.out.println("______________________________\n"
                                + "Added the task:\n"
                                + temp.toString() + "\n"
                                + "Total tasks - " + tasks.size() + "\n"
                                + "______________________________\n");
                        saveTasks(tasks);
                    }
                } catch (ArrayIndexOutOfBoundsException e) {
                    System.out.println("______________________________\n");
                    System.out.println("Invalid Format");
                    System.out.println("______________________________\n");
                }

            } else if (input.startsWith("event ")) {
                try {
                    String[] segments = input.substring(6).split(" /from ");
                    if (segments.length < 2) {
                        System.out.println("Invalid Input.\n");
                    } else {
                        String[] segments2 = segments[1].split(" /to ");
                        if (segments2.length < 2) {
                            System.out.println("Invalid Input.\n");
                            return;
                        }
                        LocalDateTime from = parseDate(segments2[0].trim());
                        LocalDateTime to = parseDate(segments2[1].trim());
                        if (from == null || to == null) {
                            System.out.println("Invalid date format. Please enter date as d/M/yyyy HHmm");
                            return;
                        }
                        Task temp = new Event(segments[0].trim(), from, to);
                        tasks.add(temp);
                        System.out.println("______________________________\n"
                                + "Added the task:\n"
                                + temp.toString() + "\n"
                                + "Total tasks - " + tasks.size() + "\n"
                                + "______________________________\n");
                        saveTasks(tasks);
                    }
                } catch (ArrayIndexOutOfBoundsException e) {
                    System.out.println("______________________________\n");
                    System.out.println("Invalid Format");
                    System.out.println("______________________________\n");
                }

            } else if (input.startsWith("delete")) {
                try {
                    int x = Integer.parseInt(input.substring(7).trim());
                    if (x>0 && x<=tasks.size()) {
                        Task removedTask = tasks.remove(x - 1);
                        System.out.println("______________________________\n");
                        System.out.println("Task removed :");
                        System.out.println(removedTask.toString());
                        System.out.println("Total tasks - " + tasks.size() + "\n");
                        System.out.println("______________________________\n");
                        saveTasks(tasks);
                    } else {
                        System.out.println("Invalid Input.\n");
                    }
                } catch (NumberFormatException e) {
                    System.out.println("______________________________\n");
                    System.out.println("Invalid Format");
                    System.out.println("______________________________\n");
                }
            } else {
                System.out.println("Invalid Input.\n");
            }
        }
    }

Example from src/main/java/Bing.java lines 175-237:

    private static void loadTasks(ArrayList<Task> tasks) {
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("d/M/yyyy HHmm");

        try {
            File file = new File(FILE_PATH);
            if (!file.exists()) {
                return;
            }
            Scanner fileScanner = new Scanner(file);
            while (fileScanner.hasNextLine()) {
                String line = fileScanner.nextLine();
                String[] parts = line.split(" \\| ");
                if (parts.length < 3) {
                    continue;
                }
                String taskType = parts[0];
                boolean isDone = parts[1].equals("1");
                String info = parts[2];
                Task task;
                if (taskType.equals("T")) {
                    task = new ToDo(info);

                } else if (taskType.equals("D")) {
                    if (parts.length < 4) {
                        continue;
                    }
                    String deadlineStr = parts[3];
                    LocalDateTime deadline;
                    try {
                        deadline = LocalDateTime.parse(deadlineStr, formatter);
                    } catch (DateTimeParseException e) {
                        System.out.println("Error parsing deadline date: " + deadlineStr);
                        continue;
                    }
                    task = new Deadline(info, deadline);
                } else if (taskType.equals("E")) {
                    if (parts.length < 5) {
                        continue;
                    }
                    String fromStr = parts[3];
                    String toStr = parts[4];
                    LocalDateTime from, to;
                    try {
                        from = LocalDateTime.parse(fromStr, formatter);
                        to = LocalDateTime.parse(toStr, formatter);
                    } catch (DateTimeParseException e) {
                        System.out.println("Error parsing event date: " + fromStr + " to " + toStr);
                        continue;
                    }
                    task = new Event(info, from, to);

                } else {
                    continue;
                }

                task.setStatus(isDone ? TaskStatus.DONE : TaskStatus.UNDONE);
                tasks.add(task);
            }
            fileScanner.close();
        } catch (IOException e) {
            System.out.println("Error loading tasks from file: " + e.getMessage());
        }
    }

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

possible problems in commit b645e1d:

Implemented saving and loading file functionality

• Not in imperative mood (?)

possible problems in commit 1cecdae:

Enums

• Perhaps too short (?)

possible problems in commit cf46cc2:

Level6

• Perhaps too short (?)

Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).

Aspect: Binary files in repo

No easy-to-detect 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.