[Shyun Yin] iP by Shyunyin · Pull Request #66 · nus-cs2113-AY2122S2/ip

Shyunyin · 2022-02-02T03:41:34Z

No description provided.

…through extract method

GlendonNotGlen

Overall a great job with the tidy code, could use some renaming for some of the methods to make it clearer. Do consider shifting some of your methods in Eliz.java to the classes instead!

GlendonNotGlen · 2022-02-03T02:38:08Z

+public class Eliz {
+    public static void printTasks(Task[] tasks) {
+        for (int i = 0; i < tasks.length; i++) {
+            int numToPrint = i + 1;


Can consider changing numToPrint to something else, like taskIndex

GlendonNotGlen · 2022-02-03T02:39:43Z

+        }
+    }
+
+    public static void markATask(String line, Task[] tasks) {


Consider using markOneTask instead?

GlendonNotGlen · 2022-02-03T02:41:38Z

+                + tasks[taskNumInt - 1].description);
+    }
+
+    public static Task createTask(String line) {


Can change this to a method in your Task.java class instead? so that your main.java will not be as convoluted

GlendonNotGlen · 2022-02-03T02:44:50Z

+        System.out.println("What can I do for you?");
+    }
+
+    public static void markOrUnmark(String line, Task[] tasks, int taskCounter) {


Consider using toggleMarkStatus or toggle as ur method name instead?

yanjie1017

Great work in overall. May need to make some modifications to achieve Single Level of Abstraction so that your code is more readable.

yanjie1017 · 2022-02-03T03:50:09Z

@@ -0,0 +1,18 @@
+public class Deadline extends Task{
+    private String taskType;


Can make it as a constant (static variable).

yanjie1017 · 2022-02-03T03:53:18Z

+
+    public static Task createEvent(String taskType, String line) {
+        String newDescription = line;
+        if (line.contains("/")) {


Can consider abstracting these lines out as a new method.

yanjie1017 · 2022-02-03T03:53:24Z

+
+    public static Task createDeadline(String taskType, String line) {
+        String newDescription = line;
+        if (line.contains("/")) {


Can consider abstracting these lines out as a new method.

yanjie1017 · 2022-02-03T03:55:05Z

+            unmarkATask(line, Arrays.copyOf(tasks, taskCounter));
+        } else {
+            System.out.println("Nice! I've marked this task as done:");
+            markATask(line, Arrays.copyOf(tasks, taskCounter));


Can consider creating a TaskList class to store the tasks and the relevant methods so that you don't have to keep passing the tasks around.

yanjie1017 · 2022-02-03T03:55:57Z

+                /** add line to todo, deadline, or event by creating the respective object */
+                Task t = createTask(line);
+                tasks[taskCounter] = t;
+                taskCounter++;


Can abstract these lines out as addTask method.

yanjie1017 · 2022-02-03T03:58:23Z

+            t = createEvent(taskType, splitTwoSections[1]);
+            break;
+        default:
+            return null;


May cause errors when you have other functions trying to access it.

Debug logic in getInput() method Add a help function that displays the commands for users to input

# Conflicts: # README.md # src/main/java/Eliz/Eliz.java

stephlewyh · 2022-02-22T02:41:30Z

+        if ((breakTaskNames.length < 2)){
+            String firstWord = breakTaskNames[0];
+            switch (firstWord) {
+            case "list" : printTasks(tasks);


You could begin statements for each case in a new line. See coding standard switch case layout.

stephlewyh · 2022-02-22T02:42:34Z

+//        if (line.substring(line.length() - 1) == " ") { //in the case that the last character is a space
+//            breakTaskNames[0] = line;
+//            breakTaskNames[1] = null;
+//        } else {
+//            breakTaskNames = line.split(" ", 2);
+//        }


You could delete unused code blocks and lines across your files to increase overall code quality.

stephlewyh · 2022-02-22T02:45:23Z

+                    Task t = createTask(line);
+                    tasks.add(t);
+                    System.out.println("Got it. I've added this task ");
+                    System.out.println(t);
+                    System.out.println("Now you have " + tasks.size() + " tasks in the list.");
+                    /*every time an object is added or edited, append to file*/
+                    try {
+                        writeToFile(filePath, tasks.get(tasks.size()-1).getTaskType() + "|"
+                                + tasks.get(tasks.size()-1).getStatusIcon() + "|"
+                                + tasks.get(tasks.size()-1).getDescription() + System.lineSeparator());
+                    } catch (IOException e) {
+                        System.out.println("Something went wrong: " + e.getMessage());
+                    }


These lines could be refactored further to ensure SLAP.

stephlewyh · 2022-02-22T02:46:31Z

+                    System.out.println("Now you have " + tasks.size() + " tasks in the list.");
+                    /*every time an object is added or edited, append to file*/
+                    try {
+                        writeToFile(filePath, tasks.get(tasks.size()-1).getTaskType() + "|"


This line of code has too many parameters that decrease the code readability. How about passing in a Task object as a parameter and letting the method unpack its values?

stephlewyh · 2022-02-22T02:47:29Z

+                }
+            }
+        }
+//        if (breakTaskNames[0].equalsIgnoreCase("todo") || breakTaskNames[0].equalsIgnoreCase("deadline")


Omit unused code blocks to increase code quality.

stephlewyh · 2022-02-22T02:49:48Z

+        File f = new File(filePath); //helps to create a file for the give file path
+        Scanner s = new Scanner(f); //create scanner using file as a source


You could inserted comments on separate line with same indentation relative to the code. This will not break the logical structure of the code. See commenting conventions.

stephlewyh · 2022-02-22T02:52:16Z

+        Scanner in = new Scanner(System.in);
+        botIntroduction(); //calls the introduction of the bot
+        line = in.nextLine();
+        String filePath = "./task_list.txt";


You could define this file path as a constant if it is not being further modified anywhere.

stephlewyh · 2022-02-22T02:53:24Z

+        System.out.println("unmark [TASK_LIST_NUMBER]");
+    }
+
+    public static void delete(String line, ArrayList<Task> tasks) {


It would help to add javadoc comments here to explain what is deleted.

Include find function to find tasks with same name

Include javadocs to all classes and most methods

Shyunyin added 11 commits January 26, 2022 02:05

Add greeting to duke

96ca32c

Add personalised Eliz.java

b92341c

Edit Eliz.java and remove errors

d4201fc

Edit Eliz.java to greet echo and exit

09e68ca

Include Add and List function to Eliz.java

87f6b23

Add mark and unmark task in Eliz.java and create Task class

7d83f00

Update code to match coding standards

c56979d

Add todo, deadline, event to Eliz.java

43fe325

Edit runtest.bat and input.txt and change EXPECTED.TXT

3868a80

Refactor introduction and marking and unmarking of task in Eliz.java …

cbad830

…through extract method

Edit createDeadline and createEvent in Eliz.java

b31f223

GlendonNotGlen reviewed Feb 3, 2022

View reviewed changes

yanjie1017 reviewed Feb 3, 2022

View reviewed changes

Shyunyin added 17 commits February 9, 2022 21:02

Create ElizException to handle exceptions

72d5c77

Edit Eliz.java to catch exceptions of invalid input

5c6f969

Change README to Eliz

7af71e5

Edit README tag

4b57ff2

Merge branch 'master' into branch-Level-5

394c06f

Create Eliz package containing all classes and main

9b74232

Edit README

302f8fc

Merge branch 'master' into branch-A-Packages

67c1feb

Change Array to ArrayList of tasks

5e88643

Merge branch 'branch-Level-5'

07657dc

Merge branch 'branch-A-Packages'

86e6ad6

Remove bugs that exceptions created through changing logic in Eliz.java

12af8ed

Add delete function to Eliz.java

a14abb2

Include file to tasks list conversion

c4b6697

Include writing to file functions and corresponding exceptions

8de1b1e

Edit README to include bugs section to be worked on

d237c77

Merge branch 'branch-Level-6'

fdd8076

Shyunyin added 4 commits February 16, 2022 21:39

Debug Eliz.main

a5d08e5

Debug logic in getInput() method Add a help function that displays the commands for users to input

Edit code logic to include writetofile method

49d2a75

Merge branch 'branch-Level-7'

a3db3a6

# Conflicts: # README.md # src/main/java/Eliz/Eliz.java

Create JAR file

6708d2a

stephlewyh reviewed Feb 22, 2022

View reviewed changes

Shyunyin and others added 18 commits March 1, 2022 15:22

Include classes for Parser, Storage, TaskList, Ui

a825715

Include find function to find tasks with same name

6d1243f

Merge pull request #1 from Shyunyin/branch-level-9

005255d

Include find function to find tasks with same name

edit storage file

062f268

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

19e1454

Include javadocs to all classes and most methods

0366b60

Merge pull request #2 from Shyunyin/branch-A-JavaDoc

616986e

Include javadocs to all classes and most methods

Set theme jekyll-theme-architect

04455cc

Update user guide in docs\README.md

83c97e4

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

17d7d0b

Fix syntax error

45f4707

Update README

fdb5358

Update README first page

bc600e7

Include hyperlink for FAQ in README

516ed46

Create JAR2

b52c6f2

Edit README

6e569ba

Exception check

d8cb3e3

Update README.md

fd4d9fb

		@@ -0,0 +1,18 @@
		public class Deadline extends Task{
		private String taskType;

		File f = new File(filePath); //helps to create a file for the give file path
		Scanner s = new Scanner(f); //create scanner using file as a source

Uh oh!

Conversation

Shyunyin commented Feb 2, 2022

Uh oh!

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

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

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