Sharing iP code quality feedback [for @bbryant824]

[nus-se-script]

@bbryant824 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/kobe/command/AddCommand.java lines 40-103:

    public void execute(TaskList tasks, Ui ui, Storage storage) throws IOException {
        // Ensure that the input has at least two parts: command and description
        assert fullCommand != null && !fullCommand.trim().isEmpty() : "fullCommand should not be null or empty";

        String[] words = fullCommand.split(" ", 2);
        String taskType = words[0];

        // Assert that a description exists for the task
        assert words.length > 1 : "The command must have a description part";

        if (taskType.equals("todo")) {
            String description = words[1];
            Todo todo = new Todo(description);

            // Assert that the task was added successfully
            int initialSize = tasks.size();
            tasks.addTask(todo);
            assert tasks.size() == initialSize + 1 : "Task was not added correctly";

            ui.setResponse("Got it. I've added this task:\n  " + todo + "\nNow you have " + tasks.size() + " tasks in the list.");

        } else if (taskType.equals("deadline")) {
            String[] parts = words[1].split(" /by ");

            // Assert that the deadline description and time part exist
            assert parts.length == 2 : "Deadline command must have a description and /by clause";

            String description = parts[0];
            LocalDateTime by = LocalDateTime.parse(parts[1], DateTimeFormatter.ofPattern("yyyy-MM-dd HHmm"));
            Deadline deadline = new Deadline(description, by);

            int initialSize = tasks.size();
            tasks.addTask(deadline);
            assert tasks.size() == initialSize + 1 : "Deadline task was not added correctly";

            ui.setResponse("Got it. I've added this task:\n  " + deadline + "\nNow you have " + tasks.size() + " tasks in the list.");

        } else if (taskType.equals("event")) {
            String[] parts = words[1].split(" /from ");

            // Assert that the event description and time part exist
            assert parts.length == 2 : "Event command must have a description and /from clause";

            String description = parts[0];
            String[] dateTimeParts = parts[1].split(" /to ");

            // Assert that the from and to dates exist
            assert dateTimeParts.length == 2 : "Event command must have /from and /to clauses";

            LocalDateTime from = LocalDateTime.parse(dateTimeParts[0], DateTimeFormatter.ofPattern("yyyy-MM-dd HHmm"));
            LocalDateTime to = LocalDateTime.parse(dateTimeParts[1], DateTimeFormatter.ofPattern("yyyy-MM-dd HHmm"));
            Event event = new Event(description, from, to);

            int initialSize = tasks.size();
            tasks.addTask(event);
            assert tasks.size() == initialSize + 1 : "Event task was not added correctly";

            ui.setResponse("Got it. I've added this task:\n  " + event + "\nNow you have " + tasks.size() + " tasks in the list.");
        }

        // Ensure that tasks are saved correctly
        storage.save(tasks.getTasks());
        assert tasks.size() > 0 : "Tasks should not be empty after saving";
    }

Example from src/main/java/kobe/util/Storage.java lines 40-91:

    public List<Task> load() throws IOException {
        List<Task> tasks = new ArrayList<>();
        File file = new File(filePath);

        if (!file.exists()) {
            new File(file.getParent()).mkdirs(); // Create the directory if it doesn't exist
            file.createNewFile(); // Create the file if it doesn't exist
        } else {
            BufferedReader reader = new BufferedReader(new FileReader(filePath));
            String line;
            while ((line = reader.readLine()) != null) {
                String[] parts = line.split(" \\| ");
                String taskType = parts[0];
                boolean isDone = parts[1].equals("1");
                String name = parts[2];
                Task task;
                switch (taskType) {
                    case "T":
                        task = new Todo(name);
                        break;
                    case "D":
                        LocalDateTime by = LocalDateTime.parse(parts[3], FORMATTER);
                        task = new Deadline(name, by);
                        break;
                    case "E":
                        LocalDateTime from = LocalDateTime.parse(parts[3], FORMATTER);
                        LocalDateTime to = LocalDateTime.parse(parts[4], FORMATTER);
                        task = new Event(name, from, to);
                        break;
                    default:
                        throw new IOException("Invalid task type in file: " + taskType);
                }

                if (isDone) task.markAsDone();

                // Load the tags (if present)
                if (parts.length > 3) {
                    String[] tags = parts[parts.length - 1].split(",");
                    for (String tag : tags) {
                        if (!tag.isEmpty()) {
                            task.addTag(tag);
                        }
                    }
                }

                tasks.add(task);
            }
            reader.close();
        }

        return tasks;
    }

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 414e01c:

Improved the overall user experience in the chatbot UI:

- Added the ability to close the application gracefully with a short delay after the 'bye' command.
- Centralized dialog management in addDialog() to handle both user and chatbot messages consistently.
- Applied responsive scrolling behavior to ensure the latest messages are always visible.
- Refactored the welcome message display for consistency and modularity.
- Ensured smoother transitions between commands and improved the UI layout for better user interaction.

This refactor improves the UI interaction flow and simplifies application exit behavior.

• body not wrapped at 72 characters: e.g., - Added the ability to close the application gracefully with a short delay after the 'bye' command.

possible problems in commit e3da37d:

refactor: Utilize Java Streams

- Refactored TaskList to use Java Streams for generating task list output.

• body not wrapped at 72 characters: e.g., - Refactored TaskList to use Java Streams for generating task list output.

possible problems in commit 020cccb:

refactor: Improve UI structure and add assertions in Main class

- Refactored `Main` class to improve code readability by modularizing layout and UI setup.
- Extracted magic numbers into constants for window dimensions and layout spacing.
- Added assertions to ensure user input is non-null and not empty before processing.
- Introduced helper method `addDialog()` to avoid code duplication when adding dialogs.
- Improved layout structure and event handler setup.

These changes enhance code quality, readability, and ensure key assumptions hold during execution.

• body not wrapped at 72 characters: e.g., - Refactored Main class to improve code readability by modularizing layout and UI setup.

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.