[Mengzhe] iP #466

charliemoweng · 2021-08-26T09:00:49Z

DukeAzure

“Focus on being productive instead of busy.” - Tim Ferriss, American podcaster, author and entrepreneur

Here at DukeAzure, we help you be productive so you don't have to be busy taking down your tasks everywhere, ever.

Some selling points include:

easy to use
small-sized
~~fast~~ VERY fast
Permanently FREE

Get yours from here today!

Some simple steps to follow:

Follow the link above to the webpage.
Download it!
Run it in your Com 💻 !
Start adding your tasks and manage them as you wish.

Some features (many more are on the way)

For those avid coders out there

Here is a snippet of the code. Feel free to give suggestions!
The main method of Duke:

public static void main(String[] args) {
       new Duke(FILE_PATH).run();
}

Task: added toString() method. Added Todo, Deadline and Event classes.

* branch-Level-8: Change the date time of Deadline and Event from string to LocalDateTime # Conflicts: # src/main/java/Duke.java Resolve the conflict

jackgugz

Overall, I see consistent good coding standards being especially for the for loops and conditional statements! The spacing and indentation made it super easy to read. However, I do observe some common places for improvements:

ordering of the imports
comments indentation and lack of javadoc comments
naming of variables.

Nonetheless still good job! Looking forward to the more updated version as I think it may be a few versions behind the schedule.

jackgugz · 2021-08-30T05:50:19Z

src/main/java/Deadline.java

+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.temporal.ChronoUnit;
+


We need to add some JavaDoc comments for all public classes and methods. Noticed the lack of javadoc in some other places too.

Yes indeed. I will add that in soon. Thank you for pointing it out.

jackgugz · 2021-08-30T05:55:16Z

src/main/java/Duke.java

+import java.util.Locale;
+import java.util.Scanner;
+import java.util.ArrayList;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.FileNotFoundException;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;


Should an empty line be added between imports from different packages? Also shall we order imports from same package by their alphabetical order?

Yes, you are right. I will reorder them to make them look nicer.

jackgugz · 2021-08-30T05:57:03Z

src/main/java/Duke.java

 public class Duke {
+
+    private static void appendToFile(String filePath, String textToAppend) throws IOException {
+        FileWriter fw = new FileWriter(filePath, true); // create a FileWriter in append mode


Should comments be indented relative to their position in the code?

Suggested change

FileWriter fw = new FileWriter(filePath, true); // create a FileWriter in append mode

// create a FileWriter in append mode

FileWriter fw = new FileWriter(filePath, true);

you are right.

jackgugz · 2021-08-30T05:58:10Z

src/main/java/Duke.java

+//    private static void printFileContents(File file) throws FileNotFoundException {
+//        //File f = new File(filePath); // create a File for the given file path
+//        Scanner s = new Scanner(file); // create a Scanner using the File as the source
+//        while (s.hasNext()) {
+//            System.out.println(s.nextLine());
+//        }
+//    }
+


Shall we avoid such commented out codes?

jackgugz · 2021-08-30T05:59:52Z

src/main/java/Duke.java

+                } else {
+                    // System.out.println("Data folder is already present.");
+                }


Is it possible that we take out the else clause then?

yes thank you for pointing it out. i have removed it since.

jackgugz · 2021-08-30T06:03:45Z

src/main/java/Duke.java

+            // mark a task as Done
+            Pattern pattern = Pattern.compile("done\\s\\d+");
+            Matcher matcher = pattern.matcher(input);
+            boolean matchFound = matcher.find();


Suggested change

boolean matchFound = matcher.find();

boolean ifMatchFound = matcher.find();

so that it sounds more like a boolean

jackgugz · 2021-08-30T06:05:13Z

src/main/java/Duke.java

+            // delete a task
+            Pattern patternDelete = Pattern.compile("delete\\s\\d+");
+            Matcher matcherDelete = patternDelete.matcher(input);
+            boolean matchFoundDelete = matcherDelete.find();


Same to the boolean name here as well.

jackgugz · 2021-08-30T06:06:33Z

src/main/java/Duke.java

+                // Case Event
+                if (group[0].equals(taskEve) && input.contains(" /at ")) {
+                    String[] eveGroup = input.split(" /at ");
+                    String eveToAdd = eveGroup[0].substring(6); // name of the task is after "event" and space


Suggested change

String eveToAdd = eveGroup[0].substring(6); // name of the task is after "event" and space

// name of the task is after "event" and space

String eveToAdd = eveGroup[0].substring(6);

jackgugz · 2021-08-30T06:07:13Z

src/main/java/Event.java

+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.temporal.ChronoUnit;


The ordering of the imports can be better!

yes i will improve upon it.

jackgugz · 2021-08-30T06:08:30Z

src/main/java/Task.java

+     }
+
+    public String getStatusIcon() {
+        return (isDone ? "X" : " "); // mark done task with X


Suggested change

return (isDone ? "X" : " "); // mark done task with X

// mark done task with X

return (isDone ? "X" : " ");

1waykiat

Remember to complete the tasks from last week!
Mostly just need to extract away the Storage and Parser class so that the parsing and loading and storing of data can be abstracted away.

1waykiat · 2021-09-01T14:47:58Z

src/main/java/Duke.java

+        // if data.txt does not exist, create file
+        if (!dataFile.exists()) {
+            try {
+                File dataDirectory = new File("./data/data.txt");
+                if (dataDirectory.createNewFile()) {
+                    System.out.println("Data file has been created.");
+                } else {
+                    // System.out.println("Data folder is already present.");
+                }
+            } catch (IOException e) {
+                System.out.println("An error occurred.");
+                e.printStackTrace();
+            }
+        }


Could be extracted out to the Storage class to handle instead

1waykiat · 2021-09-01T14:49:25Z

src/main/java/Duke.java

+            Pattern pattern = Pattern.compile("done\\s\\d+");
+            Matcher matcher = pattern.matcher(input);
+            boolean matchFound = matcher.find();
+            if (matchFound) {


Perhaps let Parser class handle the match finding instead, and extract the code there.

…card to specific, create JAR file

…-Gradle * commit 'd8398594b7bc43da5eb865321c5a50cec4b3923d': Add Gradle support

Assertions are a crucial part of Java error handling since. It helps detects errors at runtime and terminates the application. Assertions are missing in this project. Add assert features in TaskList.java because it has many if blocks that are suitable for using assert.

Good code quality denotes that methods are not too long, not beyond one screen. Some methods in Storage.java and TaskList.java are too long. It is hard to read and locate specific functionalities. Extract the logic and create helper methods within its class.

Add assert feature

* master: Add assert feature

Improve code quality

We assume that users would not want to input the same task twice. This prevents possible confusion. TaskList allows the creation of duplicates. Add in methods to check for duplicating Todo, Deadline, and Event. Only add one if it is not a duplicate. This enhances user experience.

Find code to make Label of DialogBox have infinite height to accommodate longer responses on GitHub and CS2103 Forum. Acknowledge it.

It shows warning of incompatible version numbers when the application is executed. Remove the version number from fxml files.

Data file under the default path of ./data/data.txt may or may not exist. There is no need to create it if it already exists. The Storage class always creates the data file. If the file already exists, it will enter the catch block and print out error message when there is no error at all. Add in a check before creating the file. Only create it when it is not yet existent.

Should be the finalised version of README

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

Add Gradle support

d839859

test hi

c4c29ba

Level-1

50c6115

Level-2: Add, List

d83fc7a

Level 3: mark as done. Added in Task class.

29333d4

Duke: updated method used in 'set task as Done' to using regex.

772dfc7

Task: added toString() method. Added Todo, Deadline and Event classes.

Level 4. ToDos, Events, Deadlines

bc75567

testing

d5cfbf9

Level 5: minimal, yet to implement custom Exception class

2aec474

Level 6: added the function to delete a task

f4478cb

test push

dadb450

test push done

33a8fe0

Add the function to save data to local

3166c57

Change the date time of Deadline and Event from string to LocalDateTime

640878d

Merge branch 'branch-Level-8'

a99f3e1

* branch-Level-8: Change the date time of Deadline and Event from string to LocalDateTime # Conflicts: # src/main/java/Duke.java Resolve the conflict

Add in the function to read from data.txt

df6ee59

Remove commented out helper function (no longer used)

3f8e12a

jackgugz reviewed Aug 30, 2021

View reviewed changes

1waykiat reviewed Sep 1, 2021

View reviewed changes

charliemoweng added 11 commits September 4, 2021 18:09

Implement more OOP: create classes Ui, Storage, Parser and TaskList.

6fc6c75

Organise classes into packages

d01204b

Change file path of data.txt

7c66cc3

Add JUnit tests for Parser.java, Task.java and Todo.java

c98087e

Move Duke.java out of duke package, change import statement from wild…

d7ac7d6

…card to specific, create JAR file

put Duke.java into package Duke, change path of data.txt

cba8677

write javadoc for all classes

dd6943d

check code style

5c37676

add find method

61467d9

add find method and others

17958d8

Merge commit 'd8398594b7bc43da5eb865321c5a50cec4b3923d' into branch-A…

177b29f

…-Gradle * commit 'd8398594b7bc43da5eb865321c5a50cec4b3923d': Add Gradle support

charliemoweng and others added 25 commits September 17, 2021 23:52

add in checkstyle rules and check style

94a04e5

change from CLI to GUI

c07757f

use Gradle to run the application

508d9f9

Improve code quality

b5616c2

Good code quality denotes that methods are not too long, not beyond one screen. Some methods in Storage.java and TaskList.java are too long. It is hard to read and locate specific functionalities. Extract the logic and create helper methods within its class.

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

847bb04

Add assert feature

Merge branch 'master' into branch-A-CodeQuality

edcab20

* master: Add assert feature

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

7b557e4

Improve code quality

Adjust GUI features

15f310f

Add acknowledgement for code reused

bb4327c

Find code to make Label of DialogBox have infinite height to accommodate longer responses on GitHub and CS2103 Forum. Acknowledge it.

Change comment to correct format

ae2490f

Add in representative screenshot

d22b9ad

Modify switch statement to comply with style

bea2220

Remove JavaFX FXML API version number

27ad461

It shows warning of incompatible version numbers when the application is executed. Remove the version number from fxml files.

Update README.md

7840d5f

Update README.md

7dfb2af

Should be the finalised version of README

Add in welcome message on start up

4ae5d63

Format a few responses to change to a new line

6ae5b39

Remove javafx version number

d139aa5

Declare constant Strings and switch order to pass style check

260f09b

Update README.md

2dff7a9

Set theme jekyll-theme-minimal

d52d8f1

Update README.md

c3d55f9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Mengzhe] iP #466

[Mengzhe] iP #466

charliemoweng commented Aug 26, 2021 •

edited

Loading

jackgugz left a comment

jackgugz Aug 30, 2021

charliemoweng Sep 5, 2021

jackgugz Aug 30, 2021

charliemoweng Sep 5, 2021

jackgugz Aug 30, 2021

charliemoweng Sep 5, 2021

jackgugz Aug 30, 2021

jackgugz Aug 30, 2021

charliemoweng Sep 5, 2021

jackgugz Aug 30, 2021

jackgugz Aug 30, 2021

jackgugz Aug 30, 2021

jackgugz Aug 30, 2021

charliemoweng Sep 5, 2021

jackgugz Aug 30, 2021

1waykiat left a comment

1waykiat Sep 1, 2021

1waykiat Sep 1, 2021

	FileWriter fw = new FileWriter(filePath, true); // create a FileWriter in append mode
	// create a FileWriter in append mode
	FileWriter fw = new FileWriter(filePath, true);

	boolean matchFound = matcher.find();
	boolean ifMatchFound = matcher.find();

	String eveToAdd = eveGroup[0].substring(6); // name of the task is after "event" and space
	// name of the task is after "event" and space
	String eveToAdd = eveGroup[0].substring(6);

	return (isDone ? "X" : " "); // mark done task with X
	// mark done task with X
	return (isDone ? "X" : " ");

[Mengzhe] iP #466

Are you sure you want to change the base?

[Mengzhe] iP #466

Conversation

charliemoweng commented Aug 26, 2021 • edited Loading

DukeAzure

Some selling points include:

Some simple steps to follow:

Some features (many more are on the way)

For those avid coders out there

jackgugz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1waykiat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charliemoweng commented Aug 26, 2021 •

edited

Loading