[Adrian Ong] iP by AdrianOngJJ · Pull Request #302 · nus-cs2103-AY2122S2/ip

AdrianOngJJ · 2022-01-29T21:19:25Z

LeDuke

FAST, LITE, ~~POWERFUL~~ MEGA STONKS
LeDuke will help you with:

Remembering tasks
Keeping track of which tasks are completed

What? Did I hear that you want LeDuke? Follow these easy steps 👀:

Find code here
Run the JAR file
...
PROFIT!!

Progress:

Mabaging tasks
Managing deadlines
Reminders

You can also use look for the main in my code:

public static void main(String[] args) {
        new Duke("/tasks.txt").run();
    }

joshuayapwj98

Overall, an elegant and tidy set of code! Can distinguish the flow of the programme and it would be easy to take over as a public repo if ever you are going to publish this project 😄

Just some tiny pointers about the indentation and also whitespace! Otherwise, good job 👍🏼

joshuayapwj98 · 2022-02-03T06:00:21Z

+        for(int i = 0; i < masterList.size(); i++) {
+            Task curr = masterList.get(i);
+            bw.write((i + 1) + "." + curr.toString());
+            bw.newLine();
+        }
+        bw.flush();


A very intuitive set of code!

I was wondering if there's also a need for whitespace after the "for" word?

Nonetheless, neat work :)

joshuayapwj98 · 2022-02-03T06:05:44Z

+    public DukeException(String message) {
+        super(message);
+    }


Awesome that this class is kept simple!

However, maybe there should be some comments to document on what kind of exceptions you are expecting? 😄

joshuayapwj98 · 2022-02-03T06:08:50Z

+        System.out.println("Hello! I'm Duke\nWhat can I do for you?");
+        String input; // to store raw input command
+        String[] inputArr; // to store split input command
+        boolean ifBye = false;


Intuitive boolean to check if the program should exit or not!

However, maybe:

Suggested change

boolean ifBye = false;

boolean shouldAbort = false;

Add into main PC

ovidharshini

LGTM after sorting out a few nits. Overall, the code adhered well to Java coding conventions. Spacing of comments and code appears to be irregular at times, so do keep a look out for them. You can also consider adding file types of ".class" to gitignore so as to not push them to remote.

Good job!

ovidharshini · 2022-02-06T10:18:27Z

+ * Deadlines tasks that need to be done before a specific date/time
+ * e.g., submit report by 11/10/2019 5pm
+ */
+


Consider, perhaps, deleting this line break between the comments and the function for consistency

ovidharshini · 2022-02-06T10:22:36Z

+    private static final ArrayList<Task> masterList = new ArrayList<>();
+    /**
+     * Prints line break.
+     * @return void


Consider adding a line break between the description of a function and its associated Javadoc tags for consistency. I noticed the same issue across other functions as well.

ovidharshini · 2022-02-06T10:25:28Z

+    private static final ArrayList<Task> masterList = new ArrayList<>();
+    /**
+     * Prints line break.
+     * @return void


Should the @return tag here be deleted? It is not required here as per Oracle guidelines since the return type is void. Do refer to Javadoc guidelines for a more thorough reference for the conventions with respect to Javadoc comments.

ovidharshini · 2022-02-06T10:28:35Z

+     * @throws java.io.IOException If an I/O error occurs. Only takes in string.
+     */
+    private static final void printList(BufferedWriter bw) throws Exception {


Nice job on catching this! Do consider throwing an explicit IOException if you mention it as such in the documentation for the code though

ovidharshini · 2022-02-06T10:30:23Z

+     * @throws java.io.IOException If an I/O error occurs. Only takes in string.
+     */
+    private static final void printList(BufferedWriter bw) throws Exception {
+        for(int i = 0; i < masterList.size(); i++) {


You might want to include a whitespace after the 'for' keyword here?

ovidharshini · 2022-02-06T10:34:08Z

+    }
+
+    private static final String getDateTime(String[] inputArr) {
+        return inputArr[1].split("/")[1].split(" ", 2)[1]; // split input from slash


Perhaps include the comment as a same-level indent above the line as opposed to an inline one? I noticed this in other places as well.

Since this function consists of a single line at the moment, you might want to add Javadoc-style documentation instead.

ovidharshini · 2022-02-06T10:38:59Z

+        BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
+        BufferedWriter bw = new BufferedWriter(new OutputStreamWriter(System.out));
        String logo = " ____        _        \n"
                + "|  _ \\ _   _| | _____ \n"
                + "| | | | | | | |/ / _ \\\n"
                + "| |_| | |_| |   <  __/\n"
                + "|____/ \\__,_|_|\\_\\___|\n";
        System.out.println("Hello from\n" + logo);
+        printLineBreak();
+        System.out.println("Hello! I'm Duke\nWhat can I do for you?");
+        String input; // to store raw input command
+        String[] inputArr; // to store split input command
+        boolean ifBye = false;
+        do {
+            printLineBreak();
+            System.out.println();
+            input = br.readLine();
+            inputArr = input.split(" ", 2); // split first word from body
+            printLineBreak();
+            switch (inputArr[0]) {


Do consider separating the code into logical blocks with line breaks for ease of viewing. For instance, here, the do-while loop can be separated from the rest of the preceding lines, and the initialization of variables (e.g. BufferedReader) can be separated in a similar fashion as well.

ovidharshini · 2022-02-06T10:41:15Z

+            case "bye":
+                ifBye = true;
+                System.out.println("Bye. Hope to see you again soon!");
+                break;
+
+            case "list":


Good job on following the guidelines with respect to the indentation levels of switch and case! There should be no need for line breaks between individual case statements, so maybe remove these as a final step?

…into Gradle

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

Add Gradle support

d839859

Add BufferedReader and BufferedWriter

a632fc9

Add Level-1

dcc799e

Adjust spacing of output

3c42ef7

Add list function

9d19fad

Add ability to mark oand unmark

abde661

Add Task class

fa48c36

Add Deadlines.java and Events.java

af97092

Add Events.java and complete Level 4

e881447

Complete Level 4

a78a820

Add Delete function

bd3878a

joshuayapwj98 reviewed Feb 3, 2022

View reviewed changes

AdrianOngJJ added 4 commits February 3, 2022 18:14

Test file creating

24dd4bf

Update text-ui-test/runtest.bat syntax

4488007

Merge branch 'branch-Level-7' of https://github.com/AdrianOngJJ/ip

b23d3e5

Add into main PC

Improve directory saving. Cannot create duke.txt

b6fe97a

ovidharshini reviewed Feb 6, 2022

View reviewed changes

AdrianOngJJ added 13 commits February 17, 2022 21:54

Improve saving duke.txt. Unable to create duke.txt file

cb3b03c

Remove merge conflicts

51c90f5

Solve merge issue for runtest.bat

c927b39

Implement correct saving

7e02ee6

Add DateTime function

40d8e48

Resolve merge conflict

1ccf369

Merge branch-Level-7 with branch-Level-8

b56678c

Add skeleton classes for MoreOOP

42d4ed2

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

c5e310e

Update Parser.java

8f75ea8

Update MoreOOP

ce96454

Complete MoreOOP

5d04bbf

Place all class in duke package

bb998d2

AdrianOngJJ added 17 commits March 17, 2022 23:19

Create JAR files

98f5a26

Add javadocs

1ece1cd

Update Duke to reflect coding standards

9ef56c0

Merge branch 'add-gradle-support' of https://github.com/AdrianOngJJ/ip …

c10b3cb

…into Gradle

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

7368650

Add default GUI

07c59e8

Add GUI

5777f61

Improve Duke response

7a7865f

Functioning JAR file

5d7f39c

Fix Deadline parser

9f12d19

Update UG

f50bbd8

Add find command

2f2fd99

Update UG with missing command delete and find

6ffaf57

Add bye command into UG

aad47e2

Update bye command in UG

b89ebdd

Undo bye command changes in UG

89ecb35

Add a maybe

83355a4

Conversation

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

Uh oh!

LeDuke

Uh oh!

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

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AdrianOngJJ commented Jan 29, 2022 •

edited

Loading