[Tang Zhiying] iP by zhing22 · Pull Request #472 · nus-cs2103-AY2122S1/ip

zhing22 · 2021-08-26T11:22:36Z

TiTi Catbot

"Meow Meow Meowww~ ฅ^•ﻌ•^ฅ" – TiTi

(~~and yes whatever TiTi says shall be correct~~)

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

text-based
SUPER easy to learn
SUPER SUPER fast to use (, and most importantly)
SUPER SUPER SUPER CUTE!

All you need to do is,

download it from here.
and start chatting with TiTi! 🐾

And it is FREE!!!

Features:

Managing tasks
Managing deadlines and events
Reminders (coming soon)
Cute pictures of TiTi (coming soon)

If you are programmer Ling Ling, you can use it to practice Java 40 hours a day too. Here's the main method:

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

* branch-Level-8: Add ability to understand dates and time

Extracted following classes: Ui: deals with interactions with the user Parser: deals with making sense of user command TaskList: contains the task list

Added package duke.util and duke.task

* branch-A-CodingStandard: Slight tweak to align with coding standard # Conflicts: # src/main/java/TiTi/util/Parser.java # src/main/java/TiTi/util/TaskList.java # src/main/java/TiTi/util/Ui.java

* branch-Level-9: Add function to search task using keyword # Conflicts: # src/main/java/TiTi/util/Response.java # src/main/java/TiTi/util/TaskList.java

tanqiya · 2021-08-31T08:13:00Z

+        checkDate(by);
+    }
+
+    private void checkDate(String by) {


Perhaps this function could be named with a verb, such as dateChecker.

thanks for the review! but dateChecker is actually a noun! And by convention class and variable should be names with nouns, and methods should be named with verb! Just saying in case you might have made the same assumptions for your own code ;-;

tanqiya · 2021-08-31T08:17:01Z

+        if ((cue.equals("todo") || cue.equals("deadline")
+                || cue.equals("event") || cue.equals("find"))
+                && input.split(" ", 2).length == 1) {


This expression seems a little bit complicated. Perhaps you could set aside a boolean isDescriptionMissing to handle this checking.

tanqiya · 2021-08-31T08:20:44Z

+    private static final String STARTER_NORMAL =   "   (=^ ･ｪ･^=) < ";
+    private static final String STARTER_BUFFER =   "                ";
+    private static final String STARTER_SLEEPY =   "   (=^ ‐ｪ‐^=) < ";
+    private static final String STARTER_CONFUSED = "   (=^ ･x･^=)? < ";
+    private static final String STARTER_HAPPY =    "   (=^ ･ω･^=)❀ < ";


so cute!! 😸

tanqiya · 2021-08-31T08:24:09Z

+    public String toString() {
+        return "[T]" + super.toString();
+    }
+}


Do remember to add a new line here at the end of each file.

tanqiya · 2021-08-31T08:28:05Z

+            if (taskNumber > numberOfTasks) {
+                return new Response(Response.Cue.TASKERROR);
+            } else {
+                Task task = taskList.get(taskNumber - 1);
+                task.complete();
+                return new Response(Response.Cue.DONE, task);
+            }


Suggested change

if (taskNumber > numberOfTasks) {

return new Response(Response.Cue.TASKERROR);

} else {

Task task = taskList.get(taskNumber - 1);

task.complete();

return new Response(Response.Cue.DONE, task);

}

if (taskNumber > numberOfTasks) {

return new Response(Response.Cue.TASKERROR);

}

Task task = taskList.get(taskNumber - 1);

task.complete();

return new Response(Response.Cue.DONE, task);

Since a new Response is returned in the if-block, the else-block is not required and can be removed so the main path is un-indented.
I noticed the same issue in several other places too.

xyliew25

There are quite a few coding standards violations, but kudos to all the effort you put into your iP! It is indeed a CUTEE chatbot!! Also, do correct me if I misunderstood or commented something wrongly :)

xyliew25 · 2021-08-31T13:27:38Z

@@ -0,0 +1,36 @@
+import TiTi.util.SavedHistory;


According to the coding standard, every class should be part of some package. Perhaps package titi;

xyliew25 · 2021-08-31T13:32:26Z

@@ -0,0 +1,41 @@
+package TiTi.task;


According to the coding standard, names representing packages should be in all lower case. So in this case, perhaps package titi.task;? This applies to the other files as well.

xyliew25 · 2021-08-31T13:49:28Z

+import TiTi.task.Task;
+import TiTi.task.Event;
+import TiTi.task.Deadline;
+import TiTi.task.ToDo;
+
+import java.util.ArrayList;
+import java.util.Scanner;


Not sure if there is a fixed import order convention, but I think as long as it is consistent throughout the project, it is alright. According to this link, the above import is reversed.

xyliew25 · 2021-08-31T13:57:11Z

+ * Contain the task to be printed (if needed).
+ */
+public class Response {
+    public enum Cue {EXIT, LIST, DONE, DELETE, TASKERROR, TODO, DEADLINE,


Not sure if enum names should have underscore to separate two words, as in like constants.

xyliew25 · 2021-08-31T13:59:23Z

+     *
+     * @return size of list
+     */
+    public int size() {


According to the coding standards, names representing methods must be verbs. So perhaps getSzie?

xyliew25 · 2021-08-31T14:00:00Z

+    /**
+     * Prints the response for the user command onto the user interface.
+     */
+    public void userCommand() {


Similarly, perhaps printUserCommand?

xyliew25 · 2021-08-31T14:01:58Z

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


According to coding standards, names representing methods must be verbs and written in camelCase. So perhaps testDate()?

xyliew25 · 2021-08-31T14:04:07Z

+import TiTi.task.Deadline;
+import org.junit.jupiter.api.Test;


Regardless of the import order, I think there should be a new line separate these two imports as they are from different sources.

xyliew25 · 2021-08-31T14:10:26Z

+ * Contain String description of the task.
+ * Contain String description of the date of task.
+ * Contain LocalDate object of the date of task (if applicable).
+ * Contain boolean value of whether the task has been completed.


Should be Contains instead of Contain. These are probably overlooked but I noticed the same issue in several other places too.

xyliew25 · 2021-08-31T14:11:49Z

+    protected LocalDate date;
+
+    /**
+     * Constructor for Deadline class.


Not sure if nouns are allowed. If not, perhaps can put Constructs a Deadline instance. ?

Package the app as an executable JAR file so that it can be distributed easily.

Input description from user when adding tasks might be empty. If so, response would be taken care in UI response. Hence tasks with empty description should not be created. * Assertion test is used to stop program if attempt to initialise empty description tasks

Examines the code and refactor to improve the code quality where necessary: * break long method into smaller sub-methods * improve variable naming * improve documentation style * other slight changes

Improve code quality

* branch-A-CodeQuality: Improve code quality.

Provide a way to perform tasks on multiple items: * Multiple tasks can be deleted at once * Multiple tasks can be marked done at once

changes to: *package naming *fix header comments for TiTi.main()

* 'master' of https://github.com/zhing22/ip: Set theme jekyll-theme-merlot

Includes a quick description of TiTi Chatbot, and a list of all usages and commands

* Wrong picture namings * Problem with running program * Problems with delete and done functionalites

zhing22 added 20 commits August 18, 2021 21:00

Level-1

e9a5e0e

Level-2: : Add, List

006639a

Level-3: Mark as Done

a177143

Level-4: ToDo, Event, Deadline

49bc43d

A-TextUiTesting

9f486cd

Level-5: Handle Errors

e96a381

Level-6: Delete

80cd0f3

Add function to save history in hard disk

a64dc01

Add ability to understand dates and time

07a0e04

Merge branch 'branch-Level-8'

47575f1

* branch-Level-8: Add ability to understand dates and time

Use more OOP

a67062f

Extracted following classes: Ui: deals with interactions with the user Parser: deals with making sense of user command TaskList: contains the task list

Divide classes into packages

086592a

Added package duke.util and duke.task

Add JavaDocs

8dc970c

Slight tweak to align with coding standard

da848e8

Add function to search task using keyword

cb7b9d7

Merge branch 'branch-A-CodingStandard'

5c47d60

* branch-A-CodingStandard: Slight tweak to align with coding standard # Conflicts: # src/main/java/TiTi/util/Parser.java # src/main/java/TiTi/util/TaskList.java # src/main/java/TiTi/util/Ui.java

Merge branch 'branch-Level-9'

d29e29e

* branch-Level-9: Add function to search task using keyword # Conflicts: # src/main/java/TiTi/util/Response.java # src/main/java/TiTi/util/TaskList.java

Update README using GFMD syntax

54c338f

Slight changes to README

a93a4ac

Add JUnit Test to Deadline and TaskList class

96633b5

tanqiya reviewed Aug 31, 2021

View reviewed changes

zhing22 marked this pull request as ready for review August 31, 2021 10:49

xyliew25 reviewed Aug 31, 2021

View reviewed changes

zhing22 and others added 7 commits September 1, 2021 17:08

Add Gradle

f2443d5

Testing out GUI

bc549ab

Add initial GUI

88af864

Finalise Gui

2f7e8bb

Generate new JAR file using Gradle

c752e77

Package the app as an executable JAR file so that it can be distributed easily.

Create gradle.yml

931281a

Add assertion

eab072f

Input description from user when adding tasks might be empty. If so, response would be taken care in UI response. Hence tasks with empty description should not be created. * Assertion test is used to stop program if attempt to initialise empty description tasks

zhing22 and others added 17 commits September 11, 2021 12:49

Improve code quality.

2fb4a02

Examines the code and refactor to improve the code quality where necessary: * break long method into smaller sub-methods * improve variable naming * improve documentation style * other slight changes

Merge pull request #1 from zhing22/branch-A-CodeQuality

3667f96

Improve code quality

Merge branch 'branch-A-CodeQuality' into branch-A-Assertions

b401e10

* branch-A-CodeQuality: Improve code quality.

Add mass operations functionality.

4695d4d

Provide a way to perform tasks on multiple items: * Multiple tasks can be deleted at once * Multiple tasks can be marked done at once

Update GUI

f6fa38d

Set theme jekyll-theme-merlot

f437adb

Update code quality

b38eabf

changes to: *package naming *fix header comments for TiTi.main()

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

84c7a66

* 'master' of https://github.com/zhing22/ip: Set theme jekyll-theme-merlot

Add User Guide

952a28a

Includes a quick description of TiTi Chatbot, and a list of all usages and commands

User Guide test

1b097eb

Finalise user guide

fa0e658

Finalise user guide

f3a5534

Finalise User Guide

6d37a71

Fix code standard violations

0e8612f

Fix multiple bugs

3c0607f

* Wrong picture namings * Problem with running program * Problems with delete and done functionalites

Fix typo in User Guide

a1c1c3b

Update README.md

4d2e23e

		import TiTi.task.Deadline;
		import org.junit.jupiter.api.Test;

Uh oh!

Conversation

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

Uh oh!

TiTi Catbot

"Meow Meow Meowww~ ฅ^•ﻌ•^ฅ" – TiTi

(and yes whatever TiTi says shall be correct)

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!

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

xyliew25 Aug 31, 2021 • 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!

Choose a reason for hiding this comment

Uh oh!

xyliew25 Aug 31, 2021 • 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zhing22 commented Aug 26, 2021 •

edited

Loading

xyliew25 Aug 31, 2021 •

edited

Loading

xyliew25 Aug 31, 2021 •

edited

Loading