[Yeo Zong Yao] IP by yeozongyao · Pull Request #171 · nus-cs2113-AY2324S2/ip

yeozongyao · 2024-02-06T10:40:18Z

Contains all the changes and pushes done for all the IP levels to date

Let's tweak the docs/README.md (which is used as the user guide) to fit Duke better. Specifically, 1. mention product name in the title 2. mention adding a product screenshot and a product intro 3. tweak the flow to describe feature-by-feature

Introduce Greetings

More personalised.

Personalised message.

hongyijie06

Keep up the good work!

hongyijie06 · 2024-02-09T07:39:18Z

+        }
+        scanner.close();
    }
 }


Code is easy to read and appropriate indentations throughout the code. Good job!

hongyijie06 · 2024-02-09T07:50:00Z

            }
-            System.out.println(line + input + "\n" + line);
+            else if (input.equals("list")) {
+                int task_counter = 1;


Would be good if the variable name is in camelCase, as per coding standards

hongyijie06 · 2024-02-09T07:53:59Z

+                System.out.println(markingTask.getStatusIcon() + " " + markingTask.description + nl + line);
+            } else if (input.startsWith("unmark ")) {
+                int taskIndex = Integer.parseInt(input.substring(7)) - 1;
+                Task markingTask = taskList.get(taskIndex);


Variable names throughout code follows coding standards. Good job!

hongyijie06 · 2024-02-09T07:56:28Z

+public class Sinep {
+    public static void main(String[] args) {
+        Scanner scanner = new Scanner(System.in);
+        String greeting = "Hello! I'm Sinep, your personal chatbot!\n"


Indentation for wrapped lines is correct (8 spaces) 👍

hongyijie06 · 2024-02-09T08:06:10Z

+        System.out.println(line + nl + "Added to task list: " + nl + descriptionToPrint);
+        System.out.println("Now you have " + taskList.size() + " tasks in the list." + nl + line);
+    }
+


Variable names are appropriate and code is neat and easy to read :)

hongyijie06 · 2024-02-09T08:08:25Z

+
+    @Override
+    public String toString() {
+            return "[E]" + getStatusIcon() + " " + description + " (from: " + startDateTime + " to: " + endDateTime + ")";


The indentation of the return statement may have been a little too much :0
Just 4 spaces would be good

# Conflicts: # src/main/java/Yeos.java

Jai2501

Hi Zong Yao!

Good job on the work done so far!

I have reviewed your code and have left some comments. Please go through them and get back to me for any clarifications.

Thanks!

Jai2501 · 2024-02-25T22:22:41Z

Nice job on incorporating Gradle!

Jai2501 · 2024-02-25T22:24:15Z

+package ExceptionHandling;
+
+
+public class InvalidCommandException extends Exception{
+
+}


Empty Class. Please add at least a constructor with valid instantiations/assignments, so if this error is thrown, the description shown is correct. This has been observed in multiple files.

Else please add a comment explaining when would this error be thrown and why is it empty and nothing initialised.

Jai2501 · 2024-02-25T22:24:40Z

+public class InvalidTaskIndexException extends Exception{
+}


Advisable to have a uniform spacing strategy, to enhance code readability.

Suggested change

public class InvalidTaskIndexException extends Exception{

}

public class InvalidTaskIndexException extends Exception {

}

Jai2501 · 2024-02-25T22:25:57Z

+
+
+


You may remove these extra lines. In IntelliJ, the code formatter can be updated to do this for you, every time you hit CTRL/CMD + S.

Jai2501 · 2024-02-25T22:27:00Z

+    public String toString() {
+        return "[D]" + getStatusIcon() + " " + description + " (by: " + dateTime + ")";
+    }


It is usually a practise to use this.method() or this.variable when that method or variable belongs to the Class.

This change can be made at other places as well :)

Suggested change

public String toString() {

return "[D]" + getStatusIcon() + " " + description + " (by: " + dateTime + ")";

}

public String toString() {

return "[D]" + this.getStatusIcon() + " " + this.description + " (by: " + this.dateTime + ")";

}

Jai2501 · 2024-02-25T22:35:08Z

+    public static void main(String[] args) throws IOException {
+        loadTaskFile(taskList);
+        Scanner scanner = new Scanner(System.in);
+        printGreeting();
+        while (true) {
+            String input = scanner.nextLine();
+            String command = input.split(" ", 2)[0]; // Get the first word of the input as the command
+
+            switch (command) {
+                case "bye":
+                    printBye();
+                    scanner.close();
+                    return;
+                case "list":
+                    printList();
+                    break;
+                case "mark":
+                    try {
+                        markList(input);
+                    } catch (InvalidTaskIndexException e){
+                        System.out.println("The task you are trying to edit does not exist!" + nl + line);
+                    }
+                    break;
+                case "unmark":
+                    try {
+                        unmarkList(input);
+                    } catch (InvalidTaskIndexException e){
+                        System.out.println("The task you are trying to edit does not exist!" + nl + line);
+                    }
+                    break;
+                case "todo":
+                    try {
+                        addTodo(input);
+                    } catch (InvalidCommandMessageException e) {
+                        System.out.println("The todo command message is invalid" + nl + line);
+                    }
+                    break;
+                case "deadline":
+                    try {
+                        addDeadline(input);
+                    } catch (InvalidCommandMessageException e) {
+                        System.out.println("The deadline command is invalid" + nl +line);
+                    }
+                    break;
+                case "event":
+                    try {
+                        addEvent(input);
+                    } catch (InvalidCommandMessageException e) {
+                        System.out.println("The event command is invalid" + nl + line);
+                    }
+                    break;
+                case "delete":
+                    try {
+                        deleteTask(input);
+                    } catch (InvalidTaskIndexException | InvalidCommandMessageException e) {
+                        System.out.println("The delete command is invalid" + nl + line);
+                    }
+                    break;
+                default:
+                    try {
+                        throw new InvalidCommandException();
+                    } catch (InvalidCommandException e) {
+                        System.out.println("Please enter a valid command: todo, deadline or event");
+                    }
+            }
+            saveTasks(taskList);
+        }
+    }


This code block can be abstracted to improve the code readability. Usually, methods should not be longer than 30 Lines of Code.

There is deep nesting present in this block. You may need to work on abstraction for this as well.

Reference:
https://nus-cs2113-ay2324s2.github.io/website/se-book-adapted/chapters/codeQuality.html#avoid-long-methods
https://nus-cs2113-ay2324s2.github.io/website/se-book-adapted/chapters/codeQuality.html#avoid-deep-nesting

Jai2501 · 2024-02-25T22:36:23Z

+        try {
+            Scanner scanner = new Scanner(taskFile);
+            int counter = 0;
+            while (scanner.hasNext()) {
+                String nextLine = scanner.nextLine();
+                if (nextLine.startsWith("[T]")) {
+                    String description = nextLine.substring(6).trim();
+                    taskList.add(new Todo(description));
+                    if (nextLine.charAt(4) == 'X') {
+                        Task markingTask = taskList.get(counter);
+                        markingTask.markAsDone();
+                    }
+                } else if (nextLine.startsWith("[D]")) {
+                    String command = getDeadlineCommand(nextLine);
+                    System.out.println(command);
+                    taskList.add(new Deadline(command));
+                    if (nextLine.charAt(4) == 'X') {
+                        Task markingTask = taskList.get(counter);
+                        markingTask.markAsDone();
+                    }
+                } else {
+                    String command = getEventCommand(nextLine);
+                    taskList.add(new Event(command));
+                    if (nextLine.charAt(4) == 'X') {
+                        Task markingTask = taskList.get(counter);
+                        markingTask.markAsDone();
+                    }
+                }
+                counter++;
+            }
+        } catch (FileNotFoundException e) {
+            File parentDir = taskFile.getParentFile();
+            if (!parentDir.exists() && parentDir.mkdirs()) {
+                throw new IOException("File not found.");
+            }
+        }


Similarly here, this is a deeply nested code. Please work on the abstraction.

Jai2501 · 2024-02-25T22:41:38Z

+    private static String getEventCommand(String nextLine) {
+        int startDescription = nextLine.indexOf("[E]") + 6;
+        int endDescription = nextLine.indexOf(" (from:");
+        String description = nextLine.substring(startDescription, endDescription).trim();
+        String fromKeyword = "(from: ";
+        String toKeyword = " to:";
+        int start = nextLine.indexOf(fromKeyword) + fromKeyword.length();
+        int end = nextLine.indexOf(toKeyword);
+        String fromTime = nextLine.substring(start, end).trim();
+        String startKeyword = "to: ";
+        int start1 = nextLine.indexOf(startKeyword) + startKeyword.length();
+        int end1 = nextLine.lastIndexOf(')');
+        String toTime = nextLine.substring(start1, end1).trim();
+        String command;
+        command = "event " + description + " /from " + fromTime + " /to " + toTime;
+        return command;
+    }


It is advisable to have logically linked code to be put together, and other part separated by a line break. Please make these changes everywhere you see fit.

Example: (Add line breaks as you deem right)

Suggested change

private static String getEventCommand(String nextLine) {

int startDescription = nextLine.indexOf("[E]") + 6;

int endDescription = nextLine.indexOf(" (from:");

String description = nextLine.substring(startDescription, endDescription).trim();

String fromKeyword = "(from: ";

String toKeyword = " to:";

int start = nextLine.indexOf(fromKeyword) + fromKeyword.length();

int end = nextLine.indexOf(toKeyword);

String fromTime = nextLine.substring(start, end).trim();

String startKeyword = "to: ";

int start1 = nextLine.indexOf(startKeyword) + startKeyword.length();

int end1 = nextLine.lastIndexOf(')');

String toTime = nextLine.substring(start1, end1).trim();

String command;

command = "event " + description + " /from " + fromTime + " /to " + toTime;

return command;

}

private static String getEventCommand(String nextLine) {

int startDescription = nextLine.indexOf("[E]") + 6;

int endDescription = nextLine.indexOf(" (from:");

String description = nextLine.substring(startDescription, endDescription).trim();

String fromKeyword = "(from: ";

String toKeyword = " to:";

int start = nextLine.indexOf(fromKeyword) + fromKeyword.length();

int end = nextLine.indexOf(toKeyword);

String fromTime = nextLine.substring(start, end).trim();

String startKeyword = "to: ";

int start1 = nextLine.indexOf(startKeyword) + startKeyword.length();

int end1 = nextLine.lastIndexOf(')');

String toTime = nextLine.substring(start1, end1).trim();

String command;

command = "event " + description + " /from " + fromTime + " /to " + toTime;

return command;

}

Reference: https://nus-cs2113-ay2324s2.github.io/website/se-book-adapted/chapters/codeQuality.html#structure-code-logically

Jai2501 · 2024-02-25T22:46:57Z

+    protected static void saveTasks(ArrayList<Task> taskList) {
+        if (taskList.isEmpty()) {
+            try {
+                writeToFile("", false);
+            } catch (IOException e) {
+                System.out.println("Error saving your file. IO issues.");
+            }
+        } else {
+            try {
+                writeToFile(taskList.get(0).toString(), false);
+            } catch (IOException e) {
+                System.out.println("Error saving your file. IO issues.");
+            }
+            int i = 1;
+            while (i < taskList.size()) {
+                try {
+                    writeToFile(taskList.get(i).toString(), true);
+                    i += 1;
+                } catch (IOException e) {
+                    System.out.println("Error saving your file. IO issues.");
+                }
+            }
+        }
+    }


The current implementation of saveTasks handles the task list and file writing in a repetitive and somewhat inefficient manner. Consider abstracting the file writing logic into a separate method to reduce repetition and improve readability. Additionally, the exception handling could be streamlined to avoid duplicating the catch block.

Jai2501 · 2024-02-25T22:50:36Z

+        System.out.println(line + nl + "Added to task list:" + nl + descriptionToPrint);
+        System.out.println("Now you have " + taskList.size() + " tasks in the list." + nl + line);
+    }
+


In general, I believe the Sinep class has a lot of methods, that are not necessarily related to it, and these may be abstracted to another Class such as TaskManager or TaskList.

Level-8 - Local Date Time

Level-9: Find

A-JavaDoc: Java Documentation

Level-8

A-JavaDoc

damithc and others added 19 commits January 7, 2024 18:33

docs/README.md: Tweak document template

55f9f9f

Let's tweak the docs/README.md (which is used as the user guide) to fit Duke better. Specifically, 1. mention product name in the title 2. mention adding a product screenshot and a product intro 3. tweak the flow to describe feature-by-feature

Add Gradle support

f837ddb

Bump gradle and lib version

a6f7324

Change 'Duke' Placeholder to 'Yeos'

440bad9

Introduce Greetings

Add horizontal lines.

6d6071d

More personalised.

Add horizontal lines.

5897041

Personalised message.

Level-1

cc01601

Level-1

d9d386e

Level-2

fb20b40

Level-2

2da20d1

Merge remote-tracking branch 'origin/master'

3425e67

Level-3

d61aaa3

Merge remote-tracking branch 'origin/master'

ae17d19

Changed the code based on Java coding standards

1fef908

Merge remote-tracking branch 'origin/master'

0106932

Level-4

cce81fa

Merge remote-tracking branch 'origin/master'

655ce9f

A-CodeQuality

2c4ebac

Merge remote-tracking branch 'origin/master'

9684c65

yeozongyao changed the title ~~Commits for Level-0 to A-CodingStandard~~ Commits for Level-0 to Week 4 Feb 9, 2024

hongyijie06 reviewed Feb 9, 2024

View reviewed changes

yeozongyao changed the title ~~Commits for Level-0 to Week 4~~ [Yeo Zong Yao] IP Feb 9, 2024

hongyijie06 reviewed Feb 9, 2024

View reviewed changes

yeozongyao added 5 commits February 16, 2024 00:22

Merge commit 'cc016013d33c0b83df57a9e4bc02cb9ebbbe6667' into HEAD

ab88f22

# Conflicts: # src/main/java/Yeos.java

Merge branch 'add-gradle-support' of ssh://github.com/yeozongyao/ip

80cd39e

Merge commit 'ab88f22df977049924ac4b606a718969b7fb9deb'

b787f04

added exceptions handling

991de29

Creating packages

b49dc3f

yeozongyao added 5 commits February 22, 2024 21:02

branch-A-Packages

330611e

branch-A-Packages

d6d8dc9

Level 6 and Level 7

f7ddf53

A-Collections

a059b5c

created Jar file

3f08658

Jai2501 reviewed Feb 25, 2024

View reviewed changes

yeozongyao and others added 19 commits February 29, 2024 19:17

A-More OOP: Ui, Storage, Parser, TaskList

d2c9526

Level-8 - Local Date Time

777309e

Level-9: Find

f193e7f

A-JavaDoc: Java Documentation

b7bb72d

Merge pull request #2 from yeozongyao/branch-Level-8

8cd1308

Level-8 - Local Date Time

Merge pull request #4 from yeozongyao/branch-Level-9

0b9ad82

Level-9: Find

Merge pull request #3 from yeozongyao/A-JavaDoc

62786b8

A-JavaDoc: Java Documentation

README update

e16d759

Bug fixes

812207f

Bug fixes based on Jai's comments

b57825a

bug fixes

36eed93

bug fixes

8dfb28f

Level-8

f64b365

Merge pull request #5 from yeozongyao/branch-Level-8

9e141c0

Level-8

A-JavaDoc

e43250c

Merge branch 'master' into A-JavaDoc

6255b88

Merge pull request #6 from yeozongyao/A-JavaDoc

72ac68e

A-JavaDoc

A-JavaDoc

cb64cbc

Merge pull request #7 from yeozongyao/A-JavaDoc

6ee0f70

A-JavaDoc

Uh oh!

Conversation

yeozongyao commented Feb 6, 2024

Uh oh!

hongyijie06 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hongyijie06 Feb 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jai2501 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hongyijie06 Feb 9, 2024 •

edited

Loading