iP by pragyan01 · Pull Request #187 · nus-cs2113-AY2122S1/ip

pragyan01 · 2021-09-01T08:03:36Z

Added levels 0-3 and A-CodingStandard

glenn-tck

Only 1 minor coding violation found above, but I really like how neat and tidy your code is

glenn-tck · 2021-09-03T05:04:55Z

+        System.out.println("\nNow you have " + taskCount + " tasks in the list.\n" + line);
+    }
+
+    //Filters user inputs and pushes to different methods


No coding violations found here, I like the use of comments at the top to give a brief explanation of what the function does

glenn-tck · 2021-09-03T05:06:05Z

+    public static void sayList() {
+        System.out.println(line);
+        for (int i = 0; i < taskCount; i++) {
+            System.out.println((i + 1) + ". " + t[i].toString()+ "\n");


the + between t[i].toString() and "\n" needs to have a spacing in between

glenn-tck · 2021-09-03T05:07:10Z

+    public static String line = "------------------------------------------------------------------------------------------\n";
+
+    //declare task array and keep track of how many tasks stored
+    public static Task[] t = new Task[100];


No coding violations found, but maybe you can declare 100 as a constant to indicate that it is the maximum size of the list.

glenn-tck · 2021-09-03T05:08:23Z

+        int endIndex = input.lastIndexOf("/");
+        String taskName = input.substring(9, endIndex);
+        int endIndex2 = input.length();
+        String by = input.substring(endIndex + 4, endIndex2);


No coding violation found, but I feel like it would be good if you declared the 4 here, 9 above in taskName and 5 above in the previous taskName as constants to make it apparent that these are offsets

JMattChiam · 2021-09-03T05:03:48Z

+    //Adds a new todo task and prints it                                       //todo borrow book
+    public static void sayTodo(String input) {
+        int endIndex = input.length();
+        String taskName = input.substring(5, endIndex);


magic int. should use a constant instead of "5".

JMattChiam · 2021-09-03T05:06:30Z

+    }
+
+    //Adds a new deadline task and prints it
+    public static void sayDeadline(String input) {                               //deadline return book /by Sunday


This method can be split into a few different methods. "sayDeadline" seems to imply printing like in sayBye() but also performs the adding of a new deadline object

same with sayTodo() and sayEvent()

JMattChiam · 2021-09-03T05:12:53Z

+    public static void sayEvent(String input) {                                 //event project meeting /at Mon 2-4pm
+        int endIndex = input.lastIndexOf("/");
+        String taskName = input.substring(6, endIndex);
+        int endIndex2 = input.length();


Name endIndex and endIndex2 differently to explain what the variables are/do

# Conflicts: # src/main/java/duke/Duke.java

zikunz

Great work Pragyan! I can tell that you have definitely followed various coding guidelines and your Duke is so awesome! 💯

Overall, this version of code is very easy to understand and very readable. Please take some time to fix some very few potential and minor coding standard and quality-related problems and then it should be good to go. Keep up the good work :)

zikunz · 2021-09-14T09:19:02Z

@@ -0,0 +1,25 @@
+package duke;


Great to see that you organise your types (e.g., classes) into a package for easier management!

zikunz · 2021-09-14T09:21:34Z

+    //declarations
+    public static String line = "------------------------------------------------------------------------------------------\n";
+    private static int quitFlag = 0; //if 0, take user input. Otherwise, don't.


Lines 11 and 12 are quite obvious and self-explanatory, perhaps you could refrain from repeating the description in a comment.

zikunz · 2021-09-14T09:23:26Z

+import java.nio.file.StandardOpenOption;
+import java.util.Scanner;
+import java.util.ArrayList;
+import java.io.*;


Perhaps you could avoid using a wildcard in the import statement by configuring your IDE to make all imported classes to be listed explicitly.

zikunz · 2021-09-14T09:24:37Z

+
+public class Duke {
+    //declarations
+    public static String line = "------------------------------------------------------------------------------------------\n";


Perhaps you could make line final if it does not change, and change the naming accordingly (i.e., LINE).

zikunz · 2021-09-14T09:32:41Z

+
+    //Saves Task list into local file
+    public static void saveData(ArrayList<Task> t) {
+        String path = "D:\\Documents\\NUS\\Y2S1\\CS2113T\\IP\\UserData.txt";


Perhaps you could use a relative path here rather than an absolute path because your app might cause unpredictable results when used in another computer.

zikunz · 2021-09-14T09:47:26Z

+    }
+
+    //Program exits with this ending
+    public static void sayBye(String input) throws DukeException{                                                       //bye


Perhaps you could leave a space here before { for layout consistency.

zikunz · 2021-09-14T09:48:46Z

+    //Loads Task list into Duke
+    public static void loadData() throws FileNotFoundException, DukeException {
+        File f = new File("D:\\Documents\\NUS\\Y2S1\\CS2113T\\IP\\UserData.txt");
+
+        Scanner scan = new Scanner(f);
+        String taskType;
+        String s;
+        int taskNumber = 1; //tracks how many tasks read from .txt file so far
+
+        while(scan.hasNext())                                                                                           //todo hello | 1
+        {                                                                                                               //deadline hello /by Sunday | 1
+            String data = scan.nextLine();                                                                              //event project meeting /at Mon 2-4pm | 0
+            String[] arrayString = data.split(" \\| ");
+            String[] arrayString2 = arrayString[0].split(" ");
+            taskType = arrayString2[0];
+            s = Integer.toString(taskNumber);
+
+            switch (taskType) {
+            case "todo":
+                sayTodo(arrayString[0]);
+                if (arrayString[1].equals("1")) {
+                    sayDone(s);
+                }
+                break;
+            case "deadline":
+                sayDeadline(arrayString[0]);
+                if (arrayString[1].equals("1")) {
+                    sayDone(s);
+                }
+                break;
+            case "event":
+                sayEvent(arrayString[0]);
+                if (arrayString[1].equals("1")) {
+                    sayDone(s);
+                }
+                break;
+            default:
+            }
+            taskNumber++;
+        }
+        scan.close();
+    }


This method exceeds 30 LOC, perhaps you could shorten it (e.g., by extracting lines 64 to lines 84 into a method on its own).

zikunz · 2021-09-14T09:51:34Z

+                saveData(t);
+                break;
+            case "todo":
+                sayTodo(input);
+                saveData(t);
+                break;
+            case "deadline":
+                sayDeadline(input);
+                saveData(t);
+                break;
+            case "event":
+                sayEvent(input);
+                saveData(t);
+                break;
+            case "delete": //lvl 7
+                sayDelete(input);
+                saveData(t);


Looks like the "saveData(t)" is repeated mutiple times under different case statements, you could consider calling it only once to avoid repetitive code.

zikunz · 2021-09-14T09:51:54Z

+    //Main
+    public static void main(String[] args) throws DukeException, IOException {
+        start();
+        inputSort();
+    }
+}


All statements here are at the same level of abstraction, great! You have followed of Single Level of Abstraction Principle (SLAP) very well!

zikunz · 2021-09-14T11:06:14Z

+        while(scan.hasNext())                                                                                           //todo hello | 1
+        {                                                                                                               //deadline hello /by Sunday | 1
+            String data = scan.nextLine();                                                                              //event project meeting /at Mon 2-4pm | 0


Perhaps you could rewrite your while loop as per https://se-education.org/guides/conventions/java/index.html#layout so that { appear as the same line as while().

Add Level-8

# Conflicts: # src/main/java/duke/Duke.java

Branch level 9

# Conflicts: # UserData.txt

pragyan_01 added 8 commits August 26, 2021 23:23

Add Level 0

0033e6e

Echo's user input

9b01139

Add Level-2

c113fdf

add level-3

6db8c92

Code quality improved

9df50eb

Add level-4

d779c13

Improve Code Quality

d25eed0

auto testing

87826c1

glenn-tck reviewed Sep 3, 2021

View reviewed changes

JMattChiam reviewed Sep 3, 2021

View reviewed changes

pragyan_01 added 9 commits September 9, 2021 16:59

Add A-Exceptions class

2d8013a

Merge branch 'branch-Level-5'

8857a32

Add A-Packages

2aaa1e0

Merge branch 'branch-A-Packages'

9b1d3fa

Add Level-6

c30246f

Add Level-7

5531ec3

Add Level-7 (latest)

7695559

Merge branch 'branch-Level-6'

8b1d778

Merge branch 'branch-Level-7'

bef204e

# Conflicts: # src/main/java/duke/Duke.java

zikunz reviewed Sep 14, 2021

View reviewed changes

pragyan_01 and others added 10 commits September 16, 2021 23:58

Add A-Jar

d3e43c0

Add A-Jar updated

6ac8bb0

Add Level-8

27a1bf8

Add Level-9

2d29b00

Add new classes v1

6340b5b

Merge pull request #1 from pragyan01/branch-Level-8

560e56c

Add Level-8

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

9dd7b4f

# Conflicts: # src/main/java/duke/Duke.java

Merge branch 'master' into branch-Level-9

39c63ba

# Conflicts: # src/main/java/duke/Duke.java

Merge pull request #2 from pragyan01/branch-Level-9

e8b3be1

Branch level 9

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

11a1fda

pragyan_01 added 10 commits September 23, 2021 00:18

txt file

b07fb0e

level-9 latest

c3bf73e

Merge branch 'branch-Level-9'

ab62a67

# Conflicts: # UserData.txt

Level-8 latest

c8541d5

Updated Merge of Level-8 & Level-9 into Master. Final

89962ef

Add documentation

1ebb51f

All A-JavaDoc comments added

b65f74b

Merge branch 'master' into branch-A-JavaDoc

3a328f1

add final copy of java doc commends

434010a

Merge branch 'branch-A-JavaDoc'

0a61184

pragyan01 force-pushed the master branch from b2da9e4 to 0a61184 Compare September 27, 2021 16:05

pragyan_01 and others added 13 commits September 28, 2021 00:16

Add documentation-latest copy

11e68d9

Set theme jekyll-theme-cayman

7552d82

Add UG

3536322

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

1ffb222

Add UG-latest version

eac98bb

final version of ip

b66e3a0

added some small changes to UG

ad649c6

Set theme jekyll-theme-hacker

4093607

Set theme jekyll-theme-time-machine

0ff28b1

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

daabba7

add final version ip

0e89a93

Set theme jekyll-theme-hacker

cf715c5

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

3a9590d

Uh oh!

Conversation

pragyan01 commented Sep 1, 2021

Uh oh!

glenn-tck 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!

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

zikunz Sep 14, 2021 • 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!

zikunz Sep 14, 2021 • 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!

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

zikunz Sep 14, 2021 •

edited

Loading

zikunz Sep 14, 2021 •

edited

Loading