[ChinTaiAnn] ip by chintaiann · Pull Request #76 · nus-cs2113-AY2122S2/ip

chintaiann · 2022-02-02T18:15:03Z

No description provided.

Commit Level 0.Greet

suenalaba

You can try refactoring your code, to make it for readable. Avoid too many commands within a block.

suenalaba · 2022-02-04T02:57:04Z

+        System.out.println(("What can i do for you?"));
+        System.out.println("---------------------");
+        Task[] taskList = new Task[100];
+        Boolean run = true; 


Naming error. Boolean not does not sound boolean

suenalaba · 2022-02-04T02:57:55Z

+            else if (anyString.matches("mark \\d+")){
+                String[] arrOfStr = anyString.split(" ", 0);
+                String indexValue = arrOfStr[1]; 
+                int indexValue2 = Integer.parseInt(indexValue) - 1;
+                taskList[indexValue2].markTask(); 
+
+            }
+
+            else if (anyString.startsWith("todo")) {
+                String desc = anyString.substring(5);
+                taskList[arrayIndex] = new Task(desc);
+                arrayIndex++; 
+            }
+
+            else if (anyString.startsWith("deadline")){
+                int index = anyString.indexOf("/"); 
+                String desc = anyString.substring(9,index);
+                index++;
+                String by = anyString.substring(index);
+                taskList[arrayIndex] = new Deadline(desc,by); 
+                arrayIndex++;


Can refactor code to make it more readable.

suenalaba · 2022-02-04T03:01:16Z

+
+    @Override
+    public String toString() {
+        return "[E]" + (super.isDone ? "[X]" + super.description : "[ ]"+ super.description) + "(" + timing + ")" ; // mark done task with X


Not readable code. Can try refactoring.

suenalaba · 2022-02-04T03:02:08Z

+        int arrayIndex = 0; 
+        while (run) { 
+            Scanner sc = new Scanner(System.in);
+            String anyString = sc.nextLine();


Inappropriate naming. Should name sc to something more appropriate

suenalaba · 2022-02-04T03:04:11Z

+    public String toString() {
+        return "[T]" + (isDone ? "[X]"+ this.description : "[ ]"+ this.description); // mark done task with X
+    }
+


Should comment above similar to an indentation.

thernturnaround

Code looks mostly fine, but adding javadocs would make the code more readable and remove superfluous comments.

thernturnaround · 2022-02-04T02:55:10Z

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


Extra space on indentation

thernturnaround · 2022-02-04T03:01:15Z

+    }
+
+    public String toString() {
+        return "[T]" + (isDone ? "[X]"+ this.description : "[ ]"+ this.description); // mark done task with X


Could add new lines to improve readability, and comment could be incorporated as part of javadocs

Suggested change

return "[T]" + (isDone ? "[X]"+ this.description : "[ ]"+ this.description); // mark done task with X

/*

* @return (what it returns)

*/

return "[T]"

+ ( (isDone ? "[X]"+ this.description) : "[ ]"+ this.description);

thernturnaround · 2022-02-04T03:02:01Z

+                arrayIndex++; 
+            }
+
+            else if (anyString.startsWith("deadline")){


Whitespace consistency

Suggested change

else if (anyString.startsWith("deadline")){

else if (anyString.startsWith("deadline")) {

thernturnaround · 2022-02-04T03:02:19Z

+                arrayIndex++;
+            }
+
+            else if (anyString.startsWith("event")){


Whitespace consistency

Suggested change

else if (anyString.startsWith("event")){

else if (anyString.startsWith("event")) {

thernturnaround · 2022-02-04T03:02:35Z

+                System.out.println("Bye! Hope to see you again.");
+                run = false; 
+            }
+            else if (anyString.matches("mark \\d+")){


Whitespace consistency

Suggested change

else if (anyString.matches("mark \\d+")){

else if (anyString.matches("mark \\d+")) {

thernturnaround · 2022-02-04T03:04:06Z

+
+    @Override
+    public String toString() {
+        return "[E]" + (super.isDone ? "[X]" + super.description : "[ ]"+ super.description) + "(" + timing + ")" ; // mark done task with X


Could add new lines to improve readability, and comment could be incorporated as part of javadocs

Suggested change

return "[E]" + (super.isDone ? "[X]" + super.description : "[ ]"+ super.description) + "(" + timing + ")" ; // mark done task with X

/*

* @return (what it returns)

*/

return "[E]"

+ (super.isDone ? "[X]" + super.description : "[ ]"+ super.description)

+ "(" + timing + ")" ;

thernturnaround · 2022-02-04T03:05:36Z

+    @Override
+    public String toString() {
+        // return "[D]" + super.toString() + "(" + by + ")";
+        return "[D]" + (super.isDone ? "[X]" + super.description : "[ ]"+ super.description) + "(" + by + ")" ; // mark done task with X


Could add new lines to improve readability, and comment could be incorporated as part of javadocs.
Could also clean up line 13

Suggested change

return "[D]" + (super.isDone ? "[X]" + super.description : "[ ]"+ super.description) + "(" + by + ")" ; // mark done task with X

/*

* @return (what it returns)

*/

return "[D]"

+ (super.isDone ? "[X]" + super.description : "[ ]"+ super.description)

+ "(" + by + ")" ;

implemented ArrayList and added delete function for tasks

implement fileWriter

Level-6

Level-7

xseh

Take note of the coding standards, naming convention and improve readability by refactoring and avoiding magic literals.

xseh · 2022-02-16T08:25:35Z

+public class Duke {
+    public static void main(String[] args) throws IndexOutOfBoundsException{
+        System.out.println("---------------------");
+        System.out.println(("Hello! I'm Duke"));
+        System.out.println(("What can i do for you?"));
+        System.out.println("---------------------");
+
+        ArrayList<Task> taskList = new ArrayList<Task>(); 
+        //file organization 
+        try {
+            File myTasks = new File("tasks.txt"); 
+            if (myTasks.createNewFile()){
+                System.out.println("File is created!");
+               }else{
+                System.out.println("File exists, reading it to taskList!");
+                Scanner s = new Scanner(myTasks); // create a Scanner using the File as the source
+                while (s.hasNext()){
+                    String nextString = s.nextLine();
+                    String[] splitString = nextString.split("\\|");
+                    String typeTask = splitString[0].replaceAll(" ","");
+                    String marked = splitString[1].replaceAll(" ","");
+                    String desc = splitString[2];
+                    System.out.println(typeTask);
+                    System.out.println(marked);
+                    System.out.println(desc);
+                    String todo = "T"; 
+                    String deadline = "D";   
+                    String event = "E";      
+                    String toMark = "1";          
+                    if (typeTask.equals(todo)) { 
+                        taskList.add(new Todo(desc));
+                        if (marked.equals(toMark)) { 
+                            taskList.get(taskList.size()-1).markTask();
+                        }
+                    }
+
+                    else if (typeTask.equals(deadline)) { 
+                        String deadlineDate = splitString[3];
+                        taskList.add(new Deadline(desc,deadlineDate));
+                        if (marked.equals(toMark)) { 
+                            taskList.get(taskList.size()-1).markTask();
+                        }
+                    }
+
+                    else if (typeTask.equals(event)) { 
+                        String eventDate = splitString[3];
+                        taskList.add(new Event(desc,eventDate)); 
+                        if (marked.equals(toMark)) { 
+                            taskList.get(taskList.size()-1).markTask();
+                        }
+                    }
+                }
+                s.close();
+               }        
+
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+
+        String filePath = "tasks.txt";
+        boolean continueProgram = true; 
+
+        //using Arraylist instead. 
+        boolean continueProgram = true; 
+
+        DukeException dukeEx = new DukeException();
+        while (continueProgram) { 
+            Scanner sc = new Scanner(System.in);
+            String inputString = sc.nextLine();
+            if (inputString.equals("bye")) { 
+                System.out.println("Bye! Hope to see you again.");
+                continueProgram = false; 
+            }
+
+
+            //deleting task
+            else if (inputString.matches("delete \\d+")){
+                try {
+                    String[] arrOfStr = inputString.split(" ", 0);
+                    String indexValue = arrOfStr[1]; 
+                    int indexValue2 = Integer.parseInt(indexValue) - 1;
+                    if (indexValue2 > taskList.size()-1 || indexValue2 < 0){
+                        throw new IndexOutOfBoundsException();
+                    }
+
+                    Task removedTask = taskList.get(indexValue2);
+                    taskList.remove(indexValue2);
+                    System.out.println("Noted. I've removed this task:");
+                    System.out.println(removedTask.toString());
+                    System.out.println("Now you have " + taskList.size() + " tasks in the list.");
+
+                    updateFile(filePath,taskList);
+
+
+                }
+
+                catch (IndexOutOfBoundsException e){
+                    dukeEx.wrongIndex();
+                }
+            }
+
+            //marking a task by index 
+            else if (inputString.matches("mark \\d+")){
+
+                try {
+                    String[] arrOfStr = inputString.split(" ", 0);
+                    String indexValue = arrOfStr[1]; 
+                    int indexValue2 = Integer.parseInt(indexValue) - 1;
+                    //index given is out of array size
+                    if (indexValue2 > taskList.size()-1 || indexValue2 < 0){
+                        throw new IndexOutOfBoundsException();
+                    }
+
+
+                    taskList.get(indexValue2).markTask();
+                    updateFile(filePath,taskList);
+                }
+
+                catch (IndexOutOfBoundsException e){
+                    dukeEx.wrongIndex();
+                }
+            }
+
+            //unmarking a task by index 
+            else if (inputString.matches("unmark \\d+")){
+
+                try {
+                    String[] arrOfStr = inputString.split(" ", 0);
+                    String indexValue = arrOfStr[1]; 
+                    int indexValue2 = Integer.parseInt(indexValue) - 1;
+                    if (indexValue2 > taskList.size()-1 || indexValue2 < 0){
+                        throw new IndexOutOfBoundsException();
+                    }
+                    taskList.get(indexValue2).unmarkTask();
+                    updateFile(filePath,taskList);
+
+                }
+
+                catch (IndexOutOfBoundsException e){
+                    dukeEx.wrongIndex();
+                }
+            }
+
+            else if (inputString.startsWith("todo")) {
+
+                try { 
+                    String desc = inputString.substring(5); 
+                    if (desc.isEmpty() || desc.isBlank()) {
+                        throw new IndexOutOfBoundsException();
+                    }
+                    System.out.println("Got it. I've added this task:");
+
+
+                    taskList.add(new Todo(desc));
+                    System.out.println(taskList.get(taskList.size()-1).toString());
+                    System.out.println("Now you have " + taskList.size() + " tasks in the list.");
+                    String textToAdd = "T" + "|" + " 0 " + "|" + desc;
+                    try {
+                        appendData(filePath,textToAdd);
+                    }
+                    catch (IOException e) {
+                        System.out.println("Failed to write event data to text file.");
+                    }
+
+                }
+
+                catch (IndexOutOfBoundsException e){
+                    dukeEx.missingDescription("todo");
+                }
+            }
+
+            else if (inputString.startsWith("deadline")){
+
+                try {
+
+                    int index = inputString.indexOf("/"); 
+                    String desc = inputString.substring(9,index);
+                    if (desc.isEmpty() || desc.isBlank()) {
+                        throw new IndexOutOfBoundsException();
+                    }
+                    index++;
+                    String by = inputString.substring(index);
+                    if (by.isEmpty() || by.isBlank()) {
+                        throw new IndexOutOfBoundsException();
+                    }
+                    // taskList[arrayIndex] = new Deadline(desc,by); 
+                    taskList.add(new Deadline(desc,by));
+                    System.out.println("Got it. I've added this task:");
+
+                    System.out.println(taskList.get(taskList.size()-1).toString());
+                    System.out.println("Now you have " + taskList.size() + " tasks in the list.");
+                    String textToAdd = "D" + "|" + " 0 " + "|" + desc + "|" + by;
+                    try {
+                        appendData(filePath,textToAdd);
+                    }
+                    catch (IOException e) {
+                        System.out.println("Failed to write deadline data to text file.");
+                    }
+
+                }
+
+                catch (IndexOutOfBoundsException e){
+                    dukeEx.missingDescription("deadline");
+                }
+
+            }
+
+            else if (inputString.startsWith("event")){
+
+                try {
+
+                    int index = inputString.indexOf("/"); 
+                    String desc = inputString.substring(6,index);
+                    if (desc.isEmpty() || desc.isBlank()) {
+                        throw new IndexOutOfBoundsException();
+                    }
+                    index++;
+                    String by = inputString.substring(index);
+                    if (by.isEmpty() || by.isBlank()) {
+                        throw new IndexOutOfBoundsException();
+                    }
+                    // taskList[arrayIndex] = new Event(desc,by);
+                    taskList.add(new Event(desc,by));
+                    System.out.println("Got it. I've added this task:");
+                    System.out.println(taskList.get(taskList.size()-1).toString()); 
+                    System.out.println("Now you have " + taskList.size() + " tasks in the list.");
+
+                    String textToAdd = "E" + "|" + " 0 " + "|" + desc + "|" + by;
+                    try {
+                        appendData(filePath,textToAdd);
+                    }
+                    catch (IOException e) {
+                        System.out.println("Failed to write event data to text file.");
+                    }
+                }
+
+                catch (IndexOutOfBoundsException e){
+                    dukeEx.missingDescription("event");
+                }
+
+
+
+
+            }
+
+            else if (inputString.equals("list")){
+                System.out.println("Here are the tasks in your list : ");
+                for (int i = 0; i<taskList.size(); i++) {
+                    System.out.println(i+1 + "." + taskList.get(i).toString());
+                }
+            }
+
+            else { 
+                System.out.println("☹ OOPS!!! I'm sorry, but I don't know what that means :-(");
+                continue;
+            }
+
+
+
+
+        }
+
+
+
+    }


Avoid long methods (> 30 LOCs) to improve code readability.

Avoid deep nesting (> 3 levels of indentation) in the code to improve readability.

Use more SLAP

xseh · 2022-02-16T08:27:16Z

+        System.out.println("---------------------");
+        System.out.println(("Hello! I'm Duke"));
+        System.out.println(("What can i do for you?"));
+        System.out.println("---------------------");


Avoid magic literals for improved readability. For example, the string "---------------------" can be stored in the variable MESSAGE_BORDER.

xseh · 2022-02-16T08:29:18Z

+            File myTasks = new File("tasks.txt"); 
+            if (myTasks.createNewFile()){
+                System.out.println("File is created!");
+               }else{


According to the Java coding standard, there should be blank spaces between }else{.

xseh · 2022-02-16T08:30:18Z

+                        }
+                    }
+
+                    else if (typeTask.equals(deadline)) { 


According to the Java coding standard, if-else statement should be in the form:

if (condition) { statements; } else if (condition) { statements; } else { statements; }

xseh · 2022-02-16T08:36:43Z

+                    }
+
+                    else if (typeTask.equals(deadline)) { 
+                        String deadlineDate = splitString[3];


Avoid magic indexes for better readability. For example, splitString[3] can be changed to splitString[DATE_INDEX].

xseh · 2022-02-16T08:53:08Z

+                    }
+
+
+                    taskList.get(indexValue2).markTask();


Consider using a more descriptive name to improve code readability.

xseh · 2022-02-16T08:55:20Z

+                    if (by.isEmpty() || by.isBlank()) {
+                        throw new IndexOutOfBoundsException();
+                    }
+                    // taskList[arrayIndex] = new Deadline(desc,by); 


Consider removing dead code

xseh · 2022-02-16T08:56:08Z

+                        throw new IndexOutOfBoundsException();
+                    }
+                    // taskList[arrayIndex] = new Deadline(desc,by); 
+                    taskList.add(new Deadline(desc,by));


According to the Java coding standards, there should be a white space between the variables desc,by

xseh · 2022-02-16T08:58:19Z

+
+            else if (inputString.equals("list")){
+                System.out.println("Here are the tasks in your list : ");
+                for (int i = 0; i<taskList.size(); i++) {


According to the Java coding standards, the loop structure should resemble this (take note of the white spaces)

for (i = 0; i < 100; i++) { sum += value[i]; }

xseh · 2022-02-16T09:03:49Z

+                        throw new IndexOutOfBoundsException();
+                    }
+                    taskList.get(indexValue2).unmarkTask();
+                    updateFile(filePath,taskList);


According to the Java coding standards,

plural form should be used on names representing a collection of objects

implement OOP + find function

Final changes before release

chintaiann added 5 commits January 17, 2022 17:57

Increment Level-0

17e0d53

Commit Level 0.Greet

Level 1-0

b0542f6

Level 2-9

1c76407

Level 3

2b2ca66

Level 4

521d944

suenalaba reviewed Feb 4, 2022

View reviewed changes

thernturnaround suggested changes Feb 4, 2022

View reviewed changes

chintaiann and others added 7 commits February 5, 2022 14:54

branch-Level-5

c87209c

Level 5

527ea2d

Level-6

69c93f0

implemented ArrayList and added delete function for tasks

Level-7

16d6919

implement fileWriter

Merge pull request #1 from chintaiann/branch-Level-6

6664a33

Level-6

Merge branch 'master' into branch-Level-7

a5ccf68

Merge pull request #2 from chintaiann/branch-Level-7

a85fa64

Level-7

xseh reviewed Feb 16, 2022

View reviewed changes

chintaiann and others added 4 commits February 24, 2022 21:22

Level-9

63f534d

implement OOP + find function

Update README.md

cb89418

v0.2

43b0166

Final changes before release

Merge branch 'master' of https://github.com/chintaiann/ip

249ce0d

	else if (anyString.startsWith("deadline")){
	else if (anyString.startsWith("deadline")) {

	else if (anyString.startsWith("event")){
	else if (anyString.startsWith("event")) {

	else if (anyString.matches("mark \\d+")){
	else if (anyString.matches("mark \\d+")) {

Uh oh!

Conversation

chintaiann commented Feb 2, 2022

Uh oh!

suenalaba 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!

suenalaba Feb 4, 2022 • 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!

thernturnaround 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!

xseh 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!

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

suenalaba Feb 4, 2022 •

edited

Loading