[Cheah Yan (Xie Yan)] iP by CheahYan · Pull Request #486 · nus-cs2103-AY2122S1/ip

CheahYan · 2021-08-27T02:23:09Z

DukeLite

"Your mind is for having ideas, not holding them." -David Allen (source)

DukeLite frees your mind of having to remember things you need to do. It's,

text-based
easy to learn
~~FAST~~ SUPER FAST to use

All you need to do is,

download it from here
double-click it.
add your tasks.
let it manage your tasks for you 😉

And it is FREE!

Features:

Managing tasks
Managing deadlines (coming soon)
Reminders (coming soon)

If you Java programmer, you can use it to practice Java too. Here's the main method:

public class Main {
    public static void main(String[] args) {
        Application.launch(MainApp.class, args);
    }
}

This reverts commit 881bfc1.

darrenhoon

Overall, the use of good naming conventions and meaningful variable names shows that you placed a lot of thought into how your files can be easily understood by others. Having comment headers would greatly enhance your work.

Overall, LGTM!

darrenhoon · 2021-08-31T09:32:48Z

+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+
+public class Deadline extends Task {


Perhaps a class should have a header comment to inform users about what the class does. Same suggestion for the other .java files

darrenhoon · 2021-08-31T09:33:29Z

+
+    protected LocalDateTime date;
+
+    public Deadline(String description, String date) {


Perhaps a method could have a header comment to inform users about what the method does.

Same suggestion for the other methods both in this file and other .java files

darrenhoon · 2021-08-31T09:33:56Z

@@ -0,0 +1,15 @@
+package duke;
+
+public class DukeException extends Exception {


Great work using inheritance! LGTM!

darrenhoon · 2021-08-31T09:34:20Z

+        this.isDone = false;
+    }
+
+    public String convertToFile() {


Great use of naming conventions!

darrenhoon · 2021-08-31T09:36:14Z

+    protected static final String LOCAL_FILE = "data/duke.txt";
+
+    public static void appendToFile(String filePath, String textToAppend) throws IOException {
+        FileWriter fw = new FileWriter(filePath, true); // create a FileWriter in append mode


leaving comments to help readers enables a better understanding of your code and might even help to hasten the onboarding process. Good job!

g4ryy

Overall, your code is structured logically which makes it easy to follow. I think the main issue to fix would the naming of a few variables and methods where it can be misleading or difficult to understand. Also, it would be great to include Javadoc comments which I believe would improve your code's readability. I hope my reviews will be useful to you! 🙂

g4ryy · 2021-08-31T09:34:40Z

+    public Deadline(String description, String date) {
+        super(description);
+
+        DateTimeFormatter scanned = DateTimeFormatter.ofPattern("dd/MM/yyyy HHmm");


Perhaps a more meaningful name for this variable would be datePattern or dateFormat.

g4ryy · 2021-08-31T09:44:30Z

+        String a = sc.nextLine();
+        String[] b = a.split(" ", 2);


Perhaps it would be good if you could avoid using single letters to name variables unless they are iterator variables. I noticed this issue in other parts too.

g4ryy · 2021-08-31T09:47:54Z

+
+                } else if (details[0].equals("delete")) {
+                    int taskIndex = Integer.valueOf(details[1]);
+                    Task removed = history.get(taskIndex - 1);


Perhaps a more meaningful name would be removedTask to indicate that this is the task that had been removed.

g4ryy · 2021-08-31T09:53:47Z

+        this.isDone = false;
+    }
+
+    public String convertToFile() {


Perhaps a more suitable name is getDescription. I feel that naming it convertToFile can be misleading since this method does not handle any conversion.

g4ryy · 2021-08-31T10:19:21Z

+            sc.close();
+
+    }
+}


Perhaps you could apply more OOP by extracting out closely related code as classes, rather than letting the Main method handle everything.

houtenteo

Great work overall :)

houtenteo · 2021-09-04T03:03:54Z

+        System.out.println("Bye! Hope to see you again soon!");
+    }
+
+    public void list(TaskList tasklist) {


I believe the coding standards suggest that method names should be verbs. In this case, 'list' could be a noun. Maybe a better option would be to name the method 'listAll'.

houtenteo · 2021-09-04T03:06:22Z

+        return (isDone ? "X" : " ");
+    }
+
+    public void Done() {


Method names should be in camel case.

houtenteo · 2021-09-04T03:11:33Z

+        return this.twoPart;
+    }
+
+    public boolean isBye() {


I guess u can shorten this into one-liner by just returning 'this.command.equals("bye"')'. Helps improve readability somewhat but I guess I'm just nitpicking here.

houtenteo · 2021-09-04T03:15:33Z

+        return this.twoPart[0];
+    }
+
+    public int secondPartInInt() throws DukeException {


Method names should be verbs. So this would be better named as 'getSecondPartInInt'.

Program does not have Assertions Assertions help to indicate a possible bug in the code at runtime. Adding assertions will allow us to more easily identify mistakes that we programmers make in the code.

GUI does not display the full TaskList if there is a large number of tasks. Users will not be able to properly view the entire list of tasks easily DialogBox.fxml file changed allows us to easily view all the tasks in the list when "list" command is called.

Current code is not very readable for other programmers. This can be very hard for programmers to improve upon the code in the future. Readability of code is improved with current commit

Add assertions

Improve Code Quality to all files

Added Reminder feature to Duke.

damithc and others added 15 commits July 29, 2021 20:30

Add Gradle support

d839859

Level-1

11af5b5

Level-2

0caf30f

Level-3

b228ba5

Level-4

07274fb

Level-5

0b02f80

Level-6

c11d4f6

ui testing

6f0ba24

Level-7

24bb9e5

Level-7 update

3feae08

Level-8

881bfc1

Revert "Level-8"

b489ae1

This reverts commit 881bfc1.

Merge branch 'branch-Level-7'

588650b

Level-8

cb928b3

debugging after merge conflicts

4c03146

darrenhoon reviewed Aug 31, 2021

View reviewed changes

g4ryy reviewed Aug 31, 2021

View reviewed changes

CheahYan added 3 commits September 1, 2021 11:38

OOP

ffb8151

oop updates

eacfa44

A-MoreOOP

77cb385

houtenteo reviewed Sep 4, 2021

View reviewed changes

CheahYan added 9 commits September 7, 2021 01:26

updates

e48671c

A-JUnit

259f0dd

A-Jar

b4671e3

A-JavaDoc

c06a62d

A-CodingStandard

82a5af5

Level-9

de2dab3

Merge branch 'branch-A-JavaDoc'

93d8803

Merge branch 'branch-Level-9'

e7834d4

Merge remote-tracking branch 'origin/add-gradle-support'

d94a1ea

CheahYan and others added 30 commits September 15, 2021 02:54

WHAT IS GOING ON

5bcc063

WHAT IS GOING ON

f0ba15b

debugging

fef4323

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

7bfa996

updates

6d9bcae

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

0e0a9b8

updates

3aa26c4

Merge branch 'reset-to-gradle'

b0c8db7

updates

4f13f5f

Level-7 update

de42740

GUI

d6aa8d4

debug

dd466c1

level 10

53f0877

update

36101c6

Update DialogBox.java

ff4e22b

update

b654417

Add assertions

f6ce0f9

Program does not have Assertions Assertions help to indicate a possible bug in the code at runtime. Adding assertions will allow us to more easily identify mistakes that we programmers make in the code.

Updates to GUI

6c5ee40

GUI does not display the full TaskList if there is a large number of tasks. Users will not be able to properly view the entire list of tasks easily DialogBox.fxml file changed allows us to easily view all the tasks in the list when "list" command is called.

Improve Code Quality to all files

192813f

Current code is not very readable for other programmers. This can be very hard for programmers to improve upon the code in the future. Readability of code is improved with current commit

Merge branch 'master' into branch-A-Assertions

4a4d536

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

6cc0fc7

Add assertions

Merge branch 'master' into branch-A-CodeQuality

e89f694

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

afbc471

Improve Code Quality to all files

B-Reminders

e6b2ed4

Added Reminder feature to Duke.

Add Ui.png and updated MainWindow.fxml

0bd4ee1

Set theme jekyll-theme-cayman

76b4453

updates to code

08f7db2

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

394c1c8

A-UserGuide

3f2132e

more SLAP for Storage

24bfe32


		protected LocalDateTime date;

		public Deadline(String description, String date) {

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

		public class DukeException extends Exception {

Uh oh!

Conversation

CheahYan commented Aug 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

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

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CheahYan commented Aug 27, 2021 •

edited

Loading