lava-iris / ip

Hi there 👋

ip's Issues

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

@Lava-Iris 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

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

No easy-to-detect issues 👍

Aspect: Recent Git Commit Message (Subject Only)

possible problems in commit 7de9519:

changed the output meesage for reset command

• 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.

Close Scanner Object

Remember to close your scanner object!

Originally posted by @Merrickneo in nus-cs2103-AY2223S2#215 (comment)

add bot name to window

handle bye use case

close the window or stop taking inputs when the user types bye

GUI: show full message

Right now, the message is cut short due to space considerations. make it so that the full message is visible

Abstract out DateTimeParser

Just a suggestion but you could perhaps create another class like DatetimeParser to help with parsing of the datetime string!

Originally posted by @Merrickneo in nus-cs2103-AY2223S2#215 (comment)

Sharing iP code quality feedback [for @Lava-Iris]

@Lava-Iris 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

Example from src/main/java/iris/MainWindow.java lines 34-34:

        //dialogContainer.getChildren().add(Parser.DialogBox.getIrisDialog(this.iris.startingMessage(), irisImage));

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

Example from src/main/java/iris/Parser.java lines 41-133:

    public static Command parse(String input) throws IrisException {
        String[] arr;
        String name;
        String from;
        String to;
        String by;
        CommandWord command;
        try {
            command = CommandWord.valueOf(input.split(" ")[0]);
        } catch (IllegalArgumentException e) {
            throw new NoTaskException();
        }
        switch (command) {
        case help:
            return new HelpCommand();
        case bye:
            return new ExitCommand();
        case list:
            return new ListCommand();
        case mark:
            return new MarkTaskCommand(Integer.parseInt(input.split(" ")[1]) - 1);
        case unmark:
            return new UnmarkTaskCommand(Integer.parseInt(input.split(" ")[1]) - 1);
        case delete:
            return new DeleteTaskCommand(Integer.parseInt(input.split(" ")[1]) - 1);
        case reset:
            return new ResetCommand();
        case filter:
            try {
                String s = input.substring(7);
                String[] a = s.split("/to");
                if (a.length == 1) {
                    return new FilterCommand(s.trim());
                } else {
                    return new FilterCommand(a[0].trim(), a[1].trim());
                }
            } catch (IndexOutOfBoundsException e) {
                throw new MissingFieldException("Date for filter");
            }
        case find:
            try {
                return new FindCommand(input.substring(5).trim());
            } catch (IndexOutOfBoundsException e) {
                throw new MissingFieldException("keyword for find");
            }
        case todo:
            try {
                name = input.substring(5).trim();
            } catch (IndexOutOfBoundsException e) {
                throw new MissingFieldException("Description of Todo task");
            }
            checkNotEmpty(name, "Description of Todo task");
            return new AddTaskCommand(new Todo(name));
        case deadline:
            try {
                arr = input.split("/by");
                name = arr[0].substring(9).trim();
            } catch (IndexOutOfBoundsException e) {
                throw new MissingFieldException("Description of deadline");
            }
            checkNotEmpty(name, "Description of deadline");
            try {
                by = arr[1].substring(1).trim();
            } catch (IndexOutOfBoundsException e) {
                throw new MissingFieldException("Deadline date");
            }
            checkNotEmpty(by, "Deadline date");
            return new AddTaskCommand(new Deadline(name, by));
        case event:
            try {
                arr = input.split("/");
                name = arr[0].substring(6).trim();
            } catch (IndexOutOfBoundsException e) {
                throw new MissingFieldException("Description of event");
            }
            checkNotEmpty(name, "Description of event");
            try {
                from = arr[1].substring(5).trim();
            } catch (IndexOutOfBoundsException e) {
                throw new MissingFieldException("Start date of event");
            }
            checkNotEmpty(from, "Start date of event");
            try {
                to = arr[2].substring(3).trim();
            } catch (IndexOutOfBoundsException e) {
                throw new MissingFieldException("End date of event");
            }
            checkNotEmpty(to, "End date of event");
            return new AddTaskCommand(new Event(name, from, to));
        default:
            throw new NoTaskException();
        }
    }

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 (Subject Only)

possible problems in commit 823242b:

resolved merge conflicts

• Not in imperative mood (?)

possible problems in commit bc8e4e4:

resolved merge conflicts

• 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 👍

ℹ️ 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.

add greeting to GUI version

send a greeting message when user opens GUI window

Prettier GUI

Make the GUI prettier by:

• adding colors to text
• adding colors to background
• adding bubble around dialogue
• making image border round