[Ng Hong Liang] iP by jinnhl · Pull Request #277 · nus-cs2103-AY2122S2/ip

jinnhl · 2022-01-27T16:48:31Z

Jeff the task manager

“My name is Jeff.” – Channing Tatum

Jeff allows you to have all your to-dos in one easy to access location. It's,

text-based 📝
easy to use 👌
~~fast~~ SUPER FAST to use 🔥

How do I get Jeff? It's as easy as,

download it from here.
double-click it.
add your task.

And voilà, Jeff would do everything for you!

Features:

Managing tasks
Managing deadlines
Reminders
Working GUI (coming soon)

…ction and it's exception handling

DannyDakota

few suggestions to naming conventions and coding standards for switch cases. Otherwise, solid work handsome!

DannyDakota · 2022-02-01T17:26:07Z

src/main/java/TimeParse.java

+        this.helper();
+    }
+
+    private LocalTime helper() {


maybe can use getTime here 😄

DannyDakota · 2022-02-01T17:27:10Z

src/main/java/DateParse.java

+        this.helper();
+    }
+
+    private LocalDate helper() {


maybe can use getDate here? 😄

DannyDakota · 2022-02-01T17:30:33Z

src/main/java/DukeException.java

+     * @param curr Holds the capacity for the stored list, used to check if request is out of bounds
+     * @throws DukeException
+     */
+    public void checker(String[] arr, int curr) throws DukeException {


maybe can use a more descriptive name for the method 😄
e.g
commandChecker
stringChecker
inputTester

DannyDakota · 2022-02-01T17:35:21Z

src/main/java/ReadFile.java

+        while (s.hasNext()) {
+            String[] inputLine = s.nextLine().split("\\| ", 4);
+            Task curr;
+            switch(inputLine[0]) {


switch cases shouldn't be indented according to the coding standard 😄
otherwise v nice use of switch to differentiate the various commands

pyk595

Overall, most of your code adheres to the coding standard, good job! Just a few minor nitpicks here and there

pyk595 · 2022-02-02T06:44:57Z

src/main/java/Deadline.java

+    protected TimeParse time;
+
+    /**
+     * Constructor for Deadline class


Might be better to put a line after the JavaDoc descriptor and the params?

pyk595 · 2022-02-02T06:46:06Z

src/main/java/Duke.java

@@ -1,10 +1,104 @@
+import java.io.FileNotFoundException;


Can consider putting your Duke.java in a package?

pyk595 · 2022-02-02T06:46:50Z

src/main/java/Duke.java

+            // If user inputs bye, terminate the program
+            if (input.equals("bye")) {
+                end = true;
+            }


Good use of in-line comments, they adhere to the coding standard's requirement as well

Agreed! I like how you use in-line comments to help in code readability and understanding the code :)

pyk595 · 2022-02-02T06:47:36Z

src/main/java/ReadFile.java

+ */
+public class ReadFile {
+
+    public static final String ADDRESS = "data/duke.txt";


Good use of full caps for constants!

pyk595 · 2022-02-02T06:48:50Z

src/main/java/WriteFile.java

+        fw.close();
+    }
+//
+//    public static void main(String[] args) {


Can consider removing these few lines of code if they are not used?

pyk595 · 2022-02-02T06:49:30Z

src/main/java/Task.java

@@ -0,0 +1,31 @@
+public abstract class Task {
+    protected String description;
+    protected boolean isDone;


Good boolean variable naming!

pyk595 · 2022-02-02T06:50:20Z

src/main/java/ReadFile.java

+                case "T " :
+                    curr = new Todo(inputLine[2]);
+                    break;
+                case "D " :


Same thing as mentioned by @DannyDakota, indentation should be removed

pyk595 · 2022-02-02T06:51:56Z

src/main/java/WriteFile.java

+
+    public static final String ADDRESS = "data/duke.txt";
+
+    public WriteFile(ArrayList<Task> store) throws IOException {


Store might not be the best name for a task list, maybe naming it taskList might be a better choice?

Tiffanylin21

Overall, I found some minor issues in naming. Otherwise, I really like the in-line comments in the code :)

Tiffanylin21 · 2022-02-03T14:39:10Z

src/main/java/DateParse.java

+import java.time.LocalDate;
+import java.time.format.DateTimeParseException;
+import java.util.ArrayList;
+import java.time.format.DateTimeFormatter;


Perhaps consider separating similar ones into blocks?

Tiffanylin21 · 2022-02-03T14:40:46Z

src/main/java/Deadline.java

+        this.dateInfo = this.date.toString() + " " + this.time.toString();
+    }
+
+    public String whatType() {


Perhaps consider naming the method with verbs such as 'getType()'?

Tiffanylin21 · 2022-02-03T14:43:11Z

src/main/java/Duke.java

-        System.out.println("Hello from\n" + logo);
+        Scanner scanner = new Scanner(System.in);
+        String input = "";
+        Boolean end = false;


Perhaps use a name that sounds more like a boolean? What about something like 'isEnd' or 'isExited'?

Tiffanylin21 · 2022-02-03T14:44:06Z

src/main/java/Duke.java

+        Scanner scanner = new Scanner(System.in);
+        String input = "";
+        Boolean end = false;
+        ArrayList<Task> store = new ArrayList(100);


Perhaps consider using a plural noun as the name of the ArrayList?

Tiffanylin21 · 2022-02-03T14:44:45Z

src/main/java/Duke.java

+        // While loop ends when user inputs bye
+        while(!end) {
+            input = scanner.nextLine();
+            String[] splitInput = input.split(" ", 2);


Perhaps consider using a plural noun as a variable name here?

Tiffanylin21 · 2022-02-03T14:47:31Z

src/main/java/Duke.java

+            // If user inputs bye, terminate the program
+            if (input.equals("bye")) {
+                end = true;
+            }


Agreed! I like how you use in-line comments to help in code readability and understanding the code :)

Event and Deadline tasks does not check for assumptions that string parsed as date and time are of correct size. Event and Deadline tasks would cause Jeff to crash if certain assumptions are not met. Let's add assertions on those very variables have been added, hence throwing an assertion failure instead of adding an invalid entry into the list. Assertions impact on performance is considered low compared to its benefits.

Parser class have repeated conditional statements to check if the user gave valid inputs. To improve readability and code quality. Let's refractor said conditional statements by extract them into methods. Easiest way to reuse code that have are duplicates of each other. Allows easy navigation as they are on the same class file.

Add Assertions

Improve Code Quality

jinnhl added 13 commits January 20, 2022 22:43

Level 1. Greet,Echo,Exit

d669ce5

Level2. Add,List

254eda2

Level 3. Mark as Done

7723b25

Level 4. ToDos,Events,Deadlines

959058b

A-TextUiTesting done

c80dda2

Polished the comments in Todo, Deadline and Event

301de33

Level 5. Handle Erros

efc711e

Converted the storage type from Array to Arraylist + added delete fun…

78ac805

…ction and it's exception handling

Updated some testcases

c61e079

Added read and write feature

8239eb6

Added better formatting for date and time

dc1b29d

Merge branch 'branch-Level-7'

3fa0f96

Merge branch 'branch-Level-8'

237e571

DannyDakota reviewed Feb 1, 2022

View reviewed changes

pyk595 reviewed Feb 2, 2022

View reviewed changes

Tiffanylin21 reviewed Feb 3, 2022

View reviewed changes

jinnhl added 14 commits February 7, 2022 07:12

Add classes for A-MoreOOP

e866177

Organize into Packages

6f2f008

Add JUnit tests

5d00070

Add JavaDoc comments

4dd3896

Merge branch 'branch-A-JavaDoc'

9d7baf3

Tweak the code to comply with a coding standard

afb83cb

Merge branch 'branch-A-CodingStandard'

3e3cd51

Add more information to JavaDoc in command package

a519396

Add find feature

2b1a9ea

Merge branch 'branch-Level-9'

36c4d6d

Use Gradle

63fee40

Merge branch 'A-gradle'

6792f7f

Add GUI

19ea522

Merge branch 'branch-Level-10'

230e6e4

jinnhl and others added 10 commits February 18, 2022 02:35

Merge pull request #2 from jinnhl/branch-A-Assertions

d606b75

Add Assertions

Merge branch 'master' into branch-A-CodeQuality

33769db

Merge pull request #3 from jinnhl/branch-A-CodeQuality

115306b

Improve Code Quality

Add notes feature

2c63595

Merge branch 'branch-D-Notes'

87d3f89

Improve GUI

884d070

Add a User Guide

e81148b

Release v0.2

09de543


		public static final String ADDRESS = "data/duke.txt";

		public WriteFile(ArrayList<Task> store) throws IOException {

Conversation

jinnhl commented Jan 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Jeff the task manager

Uh oh!

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

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

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jinnhl commented Jan 27, 2022 •

edited

Loading