[Elumalai Oviya Dharshini] iP by ovidharshini · Pull Request #275 · nus-cs2103-AY2122S2/ip

ovidharshini · 2022-01-27T16:13:54Z

Handbook

Are you behind on catching up with your last few commits these days? Does having to connect to the internet to log onto your favourite cloud-based task manager bother you? Are you tired of manually formatting your tasks on a new note on your smartphone

like
this
every other day?

Or is the thought of slow...ly dragging your mouse across the screen a few dozen times to update your weekly list of things to be done putting you off updating your weekly list of things to be done?

If so, Handbook is the right app for you!

Handbook is a task manager that is free, lightweight, and easy to use.
It is a heavily text-reliant application that seeks to meet the needs of the general advanced user.

What Handbook does

Manage tasks and deadlines
Save tasks onto your computer in an easily accessible format
Reminders (coming soon)
Syncing with common note-taking applications (on the todo list!)
~~Do your work for you~~

Why Handbook

Here is what some of our users have to say about Duke

"Handbook is a fantastic application - I wish I could have used Handbook to manage my schedule when I was coding Handbook... Give it a go, you won't regret it." - App Developer

"Why this over the other 270 pull requests, you ask? Good question. Check out the other applications too. But before that, try out Handbook." - Anonymous User

Installing Handbook

So, you've decided that you want to see what the hype is all about. What now?
All you need to do is

download the jar file from here
move it to where you want the application to be accessed from
double click it
and let it manage your tasks for you 🌟

If you are a Java programmer, you can customize Handbook to your liking as well; give it your own personality. Here's a brief snippet of the Ui class:

public class Ui {
    Scanner reader = new Scanner(System.in);
    /**
     * Displays a goodbye message and closes the associated Scanner.
     */
    public void showGoodbye() {
        System.out.println("Bye, hope to see you again soon!");
        reader.close();
    }
    ...
}

tobihy

I see that you like Genshin Impact a lot 💯

Overall, I found your code easy to read and understand, except for a few places where the formatting could be improved. I noticed a few minor coding standard violations too. Other than that, LGTM. Keep up the good work! 👍

tobihy · 2022-02-03T03:10:08Z

+        boolean isFirst = true;
+        for (int i = 0; i < tasks.size(); i++) {
+            String s = isFirst ? "" : "\n";
+            f.write(s + tasks.get(i).writeToFile());


Perhaps a line break after the "." operators would enhance readability? I noticed the same issue in several other places too.

tobihy · 2022-02-03T03:20:38Z

+        String s = "";
+        for (int i = 0; i < tasks.size(); i++) {
+            if (!tasks.get(i).isEmpty()) {
+                int index = i + 1;
+                s += "  " + index + ". " + tasks.get(i) + "\n";
+            }
+            else {
+                s += "You have " + i +" tasks on your list.";
+                break;
+            }
+        }
+        if (tasks.isEmpty()) {
+            s =  "You now have 0 tasks on your list.";
+        }
+
+        return s;


Maybe try adding line breaks in between logical units present in the code?

In addition, if-else statements should have the following form:

if (condition) { statements; } else { statements; }

Thanks for highlighting this! I have now changed the code to follow the Java coding standards more closely

tobihy · 2022-02-03T03:24:00Z

+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.fail;


Minor nitpick, but import statements here should be reordered as per the Java coding standard. I noticed similar issues in other places too.

I had a look at this and the guideline mentions that "the ordering of import statements must be consistent" but is otherwise generally vague. The consensus on a few StackOverflow posts appears to be that they ought to be in order of importance, then alphabetical order, with custom packages being imported after other packages. Is there another - perhaps more definitive - source you can point me to with regards to this?

tobihy · 2022-02-03T03:26:20Z

+        assertEquals("", Parser.parse("hi"));
+        assertEquals("", Parser.parse("todo"));
+        assertEquals("", Parser.parse("todo "));
+        assertEquals("", Parser.parse("event "));
+        assertEquals("", Parser.parse("event birthday at"));
+        assertEquals("", Parser.parse("event birthday at "));
+        assertEquals("event", Parser.parse("event birthday at 1500"));
+        assertEquals("", Parser.parse("deadline cs2103t week 3 ip tasks by"));
+        assertEquals("", Parser.parse("deadline cs2103t week 3 ip tasks by "));
+        assertEquals("deadline", Parser.parse("deadline cs2103t week 3 ip tasks by 2022/01/27 2359"));


Consider splitting the test into multiple JUnit test methods?

chuashihong

The whole code looks very clear and I know what is every method doing, the structure of the project is also neat and clean! Keep up the good work!

chuashihong · 2022-02-03T04:46:26Z

+ * @author  Elumalai Oviya Dharshini
+ * @version 0.1
+ */
+public class TaskWithDateTime extends Task {


I like how you make another TaskWithDateTime class that differentiate between normal task and task with date and time!

chuashihong · 2022-02-03T04:48:34Z

+
+public class DeadlineTest {
+    @Test
+    public void testStringConversion() {


Clear method name, it is obvious what is going to tested in this method

chuashihong · 2022-02-03T04:48:40Z

+    }
+
+    @Test
+    public void testWriteToFile() {


Clear method name, it is obvious what is going to tested in this method!

chuashihong · 2022-02-03T04:51:04Z

+     * @return formatted string of Todo, its completion status and a Todo marker
+     */
+    @Override
+    public String writeToFile() {


One suggestion: Maybe you can rename writeToFile as taskToStringFormat ? Because write to file at the first sight, it is going to do the whole thing writing to file, but it is just producing String format of the task to be written to file.
But it is also good that you use writeToFile (no harm)

chuashihong · 2022-02-03T04:52:03Z

+                String[] tmp = line.split("\\|");
+                boolean isDone = tmp[1].trim().equals("D");
+
+                switch (tmp[0].trim()) {


You followed the coding standard for switch case! Great Job!

chuashihong · 2022-02-03T04:52:39Z

+    //Reused from https://stackoverflow.com/questions/27904329/warning-file-mkdir-is-ignored#answer-54341862
+    // with minor modifications
+    @SuppressWarnings("unused")
+    private static void IGNORE_RESULT(boolean result) {


I am not sure what does this means, it is not returning anything

This utility function is defined for mkdirs - which creates parent directories of a given location (if they don't exist) and returns True or False depending on whether directories were created. This suppresses the File.mkdirs() is ignored warning that results from not handling the return value of mkdirs.

I am not certain if this is the recommended way to handle it so I am leaving it as is for now.

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

Add Gradle support

d839859

added user echo

8d48ae0

Store input list

a71e87b

Represent task as class

3f61a7f

Add marking for tasks

177c694

Add todo, deadline, event tasks

0438b9b

Add files for I/O redirection testing

f2f611d

Add input sanitization

fa10811

Add delete feature for list

21a974e

Add save task feature

6fed456

Add date, time recognition

0409484

Merge branch 'branch-Level-7'

c642af9

Merge branch 'branch-Level-8'

ce8a662

Refactor to use more OOP-based code

3b49e3e

Add packages

3660e1d

Add JUnit tests

9946873

Apply Java coding standards

5aad65b

Add keyword search command

769a988

Merge branch 'branch-Level-9'

b3aa7d8

Resolve merge conflict in import packages

924705b

Resolve merge conflict

5f5dd50

Add JavaDoc comments

53505d2

Resolve merge conflict

69cbb4b

Add comments for search functionality

529f480

tobihy reviewed Feb 3, 2022

View reviewed changes

chuashihong reviewed Feb 3, 2022

View reviewed changes

ovidharshini added 4 commits February 10, 2022 17:51

Resolve coding standard violations

b295aff

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

e36ebcc

Add gradle support

ffddffd

Resolve checkstyle warnings

6b35610

ovidharshini added 30 commits February 26, 2022 20:15

Handle assertion edgecase

e2e208b

Merge branch 'branch-B-DoAfterTasks'

0060559

Decrease font size

13e7025

Fix minor spelling error

7798267

Add tick unicode symbol

22cb406

Add icon

5a1a342

Add representative screenshot

a67fb2e

Fix date storage bug

7ec9d76

Add user guide

9aabb5f

Set theme jekyll-theme-minimal

47ec326

Set theme jekyll-theme-slate

063970e

Set theme jekyll-theme-slate

197ba6b

Set theme jekyll-theme-midnight

dc40c8b

Set theme jekyll-theme-slate

61ee763

Set theme jekyll-theme-time-machine

28108d3

Set theme jekyll-theme-cayman

a4d416c

Set theme jekyll-theme-tactile

dd686dc

Set theme jekyll-theme-hacker

2af586e

Delete theme

6cd5b5f

Set markdown processor for gh pages

fc44103

Update _config.yml

cc59e17

Fix bug with GFMD rendering

00ea1fb

Change Ui.png capitalization

1c79bf6

Add Ui.png

8bdaf26

Add Mac, Linux compatibility

307ce9e

Change minor messages

7aae63c

Resolve filepath bug, GUI errors

cdf341e

Add updated Ui.png

1c9240d

Add attribution for images

af733da

Resolve bug with image display

6048095

Conversation

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

Uh oh!

Handbook

If so, Handbook is the right app for you!

What Handbook does

Why Handbook

Installing Handbook

Uh oh!

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

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ovidharshini commented Jan 27, 2022 •

edited

Loading

ovidharshini Feb 10, 2022 •

edited

Loading

ovidharshini Feb 10, 2022 •

edited

Loading