[Vanessa] iP by vanessaxuuan · Pull Request #314 · nus-cs2103-AY2122S2/ip

vanessaxuuan · 2022-02-01T09:16:13Z

GARY

"Get busy living or get busy dying." - Stephen King source

Gary 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) {
        new Gary("./filepath).run();
    }
}

jaysmyname

Overall good coding standard practices!
Just remember to import classes explicitly instead of using *

jaysmyname · 2022-02-03T07:41:38Z

src/main/java/Gary.java

@@ -0,0 +1,98 @@
+import java.sql.Array;
+import java.util.*;


Shouldn't imported classes be listed explicitly?

jaysmyname · 2022-02-03T07:43:37Z

src/main/java/Gary.java

+        System.out.println("Bye, hope you stay productive!\n");
+    }
+
+    public static void printList(int type, ArrayList<Task> item) {


Perhaps the variable name should be in plural form for ArrayList?

jaysmyname · 2022-02-03T07:44:51Z

src/main/java/Task.java

@@ -0,0 +1,25 @@
+import java.util.*;


Shouldn't imported classes be listed explicitly?

jaysmyname · 2022-02-03T07:47:42Z

src/main/java/Gary.java

+            } else if (nxt.equals("mark")) {
+                System.out.println("which tasks have you completed? e.g. 2 3");
+                String nums = sc.nextLine();
+                String[] first = nums.split(" ");
+                int i = 0;
+                for (String str : first) {
+                    items.get(Integer.parseInt(first[i]) - 1).toMark();
+                    i++;
+                }
+                Gary.printList(2, items);


I like that you enabled multi-step commands!

jetrz

Generally well written code! Minor nitpicks on documentation, but otherwise code implements OOP concepts effectively, and is clean and readable!

jetrz · 2022-02-03T09:51:40Z

src/main/java/Deadlines.java

@@ -0,0 +1,13 @@
+public class Deadlines extends Task {
+    String date;


It would be good to have an access modifier for these fields. Same comment for Event.

jetrz · 2022-02-03T09:55:30Z

src/main/java/Gary.java

+            if (nxt.equals("list")) {
+                Gary.printList(1, items);
+            } else if (nxt.equals("mark")) {
+                System.out.println("which tasks have you completed? e.g. 2 3");
+                String nums = sc.nextLine();
+                String[] first = nums.split(" ");
+                int i = 0;
+                for (String str : first) {
+                    items.get(Integer.parseInt(first[i]) - 1).toMark();
+                    i++;
+                }
+                Gary.printList(2, items);
+
+            } else if (nxt.equals("unmark")) {
+                System.out.println("made some mistakes?");
+                String nums = sc.nextLine();
+                String[] first = nums.split(" ");
+                int k = 0;
+                for (String str : first) {
+                    items.get(Integer.parseInt(first[k]) - 1).toUnmark();
+                    k++;
+                }
+            } else if (nxt.equals("delete")) {
+                System.out.println("Please key in what you would like to remove in descending order!");
+                try {
+                    String nums = sc.nextLine();
+                    String[] first = nums.split(" ");
+                    int k = 0;
+                    for (String str : first) {
+                        items.remove(Integer.parseInt(first[k]) - 1);
+                        k++;
+                    }
+                    Gary.printList(2, items);
+                } catch (IndexOutOfBoundsException e) {
+                    System.out.println("Ah please enter a valid number or sequence e.g. 5 3 1");
+                }
+
+            } else {
+                String[] type = nxt.split(" ");
+                String theTask = type[0];
+                try {
+                    if (!theTask.equals("todo") && !theTask.equals("event") && !theTask.equals("deadline")) {
+                        throw new GaryException(nxt); // invalid input
+                    }
+                } catch (GaryException e) {
+                    e.GaryError();
+                }
+
+                try {
+                    switch (theTask) {
+                        case "todo":
+                            items.add(new ToDo(nxt.substring(5)));
+                            break;
+                        case "event":
+                            String[] e = nxt.split("/", 5);
+                            items.add(new Event(e[0].substring(6), e[1]));
+                            break;
+                        case "deadline":
+                            String[] d = nxt.split("/", 5);
+                            items.add(new Deadlines(d[0].substring(9), d[1]));
+                            break;
+                    }
+                } catch (StringIndexOutOfBoundsException e) {
+                    System.out.println("Ah please enter a valid description e.g. task_type name / date");
+                }
+            }
+            nxt = sc.nextLine(); // continue getting inputs
+        }
+        System.out.println("Bye, hope you stay productive!\n");


Parser is clean and easy to understand!

jetrz · 2022-02-03T09:58:09Z

src/main/java/Task.java

+    public String toString() {
+        String done = this.isDone ? "X" : " ";
+        return "[" + done + "] " + this.task;
+    }


toString is abstracted well for Task and its children classes!

jetrz · 2022-02-03T10:00:49Z

src/main/java/GaryException.java

+public class GaryException extends Exception {
+    // represent exceptions specific to Gary
+    // int err;
+    String msg;
+
+    public GaryException(String msg) {
+       // this.err = err;
+       this.msg = msg;
+    }
+
+    public void GaryError() {
+        System.out.printf("Sorry, what is %s ?\n", this.msg);
+    }
+}


Would be useful to add javadocs documentation for custom exceptions!

* branch-Level-8: add dates and times # Conflicts: # src/main/java/Gary.java

Use GFMD in the PR description

* 'master' of https://github.com/vanessaxuuan/ip: Update IP description

* commit 'd8398594b7bc43da5eb865321c5a50cec4b3923d': Add Gradle support

Special cases such as, * empty user input * operating on an empty to-do list should be handled specially to prevent errors Let's add assertions to functions that handle Gary's response

Group classes into packages base on their functionalities for easier management. Let's move related classes into packages such as, * gary.task * gary.ui * gary.gui * gary.exception

Standardise code naming, layout, statements and comments Add relative file path that works on both Unix and Windows

Branch a code quality

* 'master' of https://github.com/vanessaxuuan/ip: Improve code quality Rename packages

Add assert features to document important assumptions

* 'master' of https://github.com/vanessaxuuan/ip: Add assert features to document important assumptions

Let's, * Change display images * Add welcome message

* branch-better-GUI: Finalize GUI

fit-for-purpose

* 'master' of https://github.com/vanessaxuuan/ip: Update README.md Update README.md Update README.md Update README.md Update README.md Update User Guide Update README.md Add User Guide Add a representative screenshot of Gary

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

Add Gradle support

d839859

level1-gary

253e8b0

level2-gary

3427794

level3-gary

e6d31a7

Level4-gary

9dbe82d

Level5-gary

be1a567

Level6-Gary

3ec0b1a

add memory feature in branch-Level-7

0f521e8

jaysmyname reviewed Feb 3, 2022

View reviewed changes

jetrz reviewed Feb 3, 2022

View reviewed changes

vanessaxuuan and others added 20 commits February 7, 2022 17:56

add dates and times

8f52035

Merge branch 'branch-Level-8'

8e8980b

* branch-Level-8: add dates and times # Conflicts: # src/main/java/Gary.java

use more OOP by extracting classes

2c96f56

divide classes into packages

733ba9a

add JUnit tests

4aa2a9e

add JavaDoc comments

54cd499

Add JavaDoc comments to test classes

57426c5

Add JavaDoc comments

95693f5

Follow the Coding Standard

76d36c7

Add a method to find a task by searching for a keyword

8d822c0

rebase

a30df56

Update IP description

2fa50d7

Use GFMD in the PR description

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

d48749e

* 'master' of https://github.com/vanessaxuuan/ip: Update IP description

Merge commit 'd8398594b7bc43da5eb865321c5a50cec4b3923d'

9095cf4

* commit 'd8398594b7bc43da5eb865321c5a50cec4b3923d': Add Gradle support

Set up gradle

06be999

Add GUI to Gary

35b7840

Add GUI to Gary

8315ecb

Add FXML files

3aea752

Integrate FXML into GUI for Gary

714e529

Add assert features to document important assumptions

0bccd26

Special cases such as, * empty user input * operating on an empty to-do list should be handled specially to prevent errors Let's add assertions to functions that handle Gary's response

vanessaxuuan and others added 23 commits February 21, 2022 02:01

Rename packages

3199aad

Group classes into packages base on their functionalities for easier management. Let's move related classes into packages such as, * gary.task * gary.ui * gary.gui * gary.exception

Improve code quality

71183f3

Standardise code naming, layout, statements and comments Add relative file path that works on both Unix and Windows

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

3d78dc3

Branch a code quality

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

b76a2d5

* 'master' of https://github.com/vanessaxuuan/ip: Improve code quality Rename packages

Resolve merge conflicts with master branch

6389773

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

f260392

Add assert features to document important assumptions

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

5bd4d38

* 'master' of https://github.com/vanessaxuuan/ip: Add assert features to document important assumptions

Update JavaDocs

bbdb6ff

Finalize GUI

fd09a66

Let's, * Change display images * Add welcome message

Merge branch 'branch-better-GUI'

9587526

* branch-better-GUI: Finalize GUI

Add a representative screenshot of Gary

99e35f2

Add User Guide

ccee2a0

fit-for-purpose

Update README.md

b7b8d31

Update User Guide

fea6ca1

Update README.md

7d58559

Update README.md

196330e

Update README.md

6637131

Update README.md

02f6bbd

Update README.md

fa0b705

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

de0f6b7

* 'master' of https://github.com/vanessaxuuan/ip: Update README.md Update README.md Update README.md Update README.md Update README.md Update User Guide Update README.md Add User Guide Add a representative screenshot of Gary

Create Jar file

4e6a065

update jar file

e07b092

update README.md

4d9ff92

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Vanessa] iP#314

[Vanessa] iP#314
vanessaxuuan wants to merge 51 commits intonus-cs2103-AY2122S2:masterfrom
vanessaxuuan:master

vanessaxuuan commented Feb 1, 2022 •

edited

Loading

Uh oh!

jaysmyname left a comment

Uh oh!

jaysmyname Feb 3, 2022

Uh oh!

jaysmyname Feb 3, 2022

Uh oh!

jaysmyname Feb 3, 2022

Uh oh!

jaysmyname Feb 3, 2022

Uh oh!

jetrz left a comment

Uh oh!

jetrz Feb 3, 2022

Uh oh!

jetrz Feb 3, 2022

Uh oh!

jetrz Feb 3, 2022

Uh oh!

jetrz Feb 3, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -0,0 +1,13 @@
		public class Deadlines extends Task {
		String date;

Conversation

vanessaxuuan commented Feb 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

GARY

Uh oh!

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

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

3 participants

vanessaxuuan commented Feb 1, 2022 •

edited

Loading