[Aakansha Narain] iP by aakanshanarain · Pull Request #491 · nus-cs2103-AY2122S1/ip

aakanshanarain · 2021-08-28T14:24:27Z

Duke: Your personal task manager

Welcome to Duke! Duke provides an interface to keep track of your tasks to make sure you never fall back on work! Here's some stuff you can do with Duke:

Store todo, event and deadline tasks
Add date and time to your event and deadline tasks
Tag your tasks to group tasks together

To use Duke, all you have to do is:

Download the program from here
Double click it
Add your tasks
Let it do the rest for you!

An example from our previous users:

Finish CSXXXX Assignment (by: Sep 20 2021, 11:59pm)
Meet friends (at: Sep 21 2021, 3:00pm)
Buy groceries
Attend book club meeting (at: Sep 25, 5:00pm) #bookClub
Write book report #bookClub

Take a look at some reviews from current users:

Duke has helped me manage my tasks so much more efficiently! It really is a second brain!

Ever since I started using Duke, I've never missed a deadline! It really helps me through the stressful university semester!

For more users experienced in programming, play around with the software to make it more customisable! Here's the main method to get you started:

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

Get started with Duke now! 🤩

yuifuku1118

LGTM!!
Overall, your code is nice and well organized.
Just added some comment and possible improvements to make.

yuifuku1118 · 2021-08-30T15:17:34Z

+        int charIndex = input.indexOf("/" );
+        int atIndex = charIndex + 4;


I like how you named your variables here! (Easy to understand)

yuifuku1118 · 2021-08-30T15:18:52Z

+
+    public void add (Task task) {
+        todoList.add(task);
+    }


I like how you named your variables with verbs, easy to understand at one glance.

yuifuku1118 · 2021-08-30T15:22:19Z

+public class Event extends Task {
+
+    private String at;
+


You could remove the extra empty line

yuifuku1118 · 2021-08-30T15:23:36Z

+public abstract class InputHandler {
+    protected Ui ui;
+    protected TaskList taskList;


You could add a line between? (To keep your coding style consistent, same thing with couple of other files)

vigneshsankariyer1234567890

Hey Aakansha!

Overall, really liked the organisation of your project. It really adheres to the principles of OO! I'll be leaving some comments on some parts of your project. Once again, well done!

vigneshsankariyer1234567890 · 2021-08-31T03:20:34Z

@@ -1,10 +1,64 @@
+//Solution below slightly adapted from https://github.com/Wincenttjoi/CS2103T-duke-chatbot/blob/master/src/main/java/duke/Duke.java
+
+import duke.*;


Should you be including the individual packages here rather than a wildcard?

vigneshsankariyer1234567890 · 2021-08-31T03:21:08Z

+
+    private Ui ui;
+    private TaskList taskList;
+    private boolean exit;


You could change this to a more boolean sounding name!

vigneshsankariyer1234567890 · 2021-08-31T03:24:12Z

+    }
+
+    public enum InputCommands {
+        bye, list, done, delete, todo, deadline, event


Since these are going to be unchanged, you could possibly rename to be capitalised? For example, BYE, LIST, DONE etc. However, i like the naming of the enum InputCommands here!

vigneshsankariyer1234567890 · 2021-08-31T03:28:37Z

+
+import duke.*;
+
 public class Duke {


You could also add some comments here! I think this would allow you to communicate your code effectively!

vigneshsankariyer1234567890 · 2021-08-31T03:29:22Z

+        bye, list, done, delete, todo, deadline, event
+    }
+
+    public void start () {


I think you do not need to add a space after the method name here! just start() would do

vigneshsankariyer1234567890 · 2021-08-31T03:38:42Z

+
+    @Override
+    public String handle(String input) throws EmptyDescriptionException {
+        if (input.length() == 6) {


I'm not too sure whether i understand the reasoning behind using length() here. Could you comment on this?

vigneshsankariyer1234567890 · 2021-08-31T03:39:45Z

+    @Override
+    public String handle (String input) throws EmptyDescriptionException {
+        if (input.length() == 4) {
+            throw new EmptyDescriptionException("error");


I think it's great to have different Exceptions here! really improves the OO-ness of the project.

vigneshsankariyer1234567890 · 2021-08-31T03:40:56Z

+            throw new EmptyDescriptionException("error");
+        }
+
+        char taskIndex = input.charAt(5);


I think you could rename the variable here, to something like indexOfTask?

vigneshsankariyer1234567890 · 2021-08-31T03:42:18Z

+import java.util.ArrayList;
+
+public class TaskList {
+    private static ArrayList<Task> todoList;


You could rename this to tasks to keep it consistent with the coding standards provided by prof!

this could also be instance level (non-static) rather than class level! I think it would be easier to keep track of the collection this way.

vigneshsankariyer1234567890 · 2021-08-31T03:45:16Z

+        return todoList;
+    }
+
+    public void add (Task task) {


again, as with other lines of code, you could remove the space between the method name and parameter parentheses

This merge includes changes to the coding standard

…A-Gradle This merges the gradle-support to implement Scenario 2 while adding Gradle to the iP

This reverts commit c228d14. Reverting commit to be made in another branch

… comments The Storage class had code at varying levels of abstraction. It had code that was responsible for parsing the stored tasks, as well as loading them into the UI at the same time. Let's move the code responsible for parsing into the Parser class to eliminate that level of abstraction from the Storage class, keeping it solely responsible for storing and loading tasks to and from the storage file. The Parser class already deals with all the relevant parsing needed to read user inputs and other text formats, so this maintains abstraction well. It also makes the code more readable as there is no convoluted parsing to read while looking at the code to load tasks to the UI.

Add assertions to some fragments of code

Modifications to the code quality

Tagging can be useful to keep track of similar tasks in the task list. Let's add a tag command word and accordingly add methods to the Parser and UI classes, as well as make changes to the toString methods to make the UI messages more readable for the user in the case they add a tag to the tasks. In keeping with the functions of the classes, the Parser parses the tag command and then the CommandHandler ensures the actual handling of the command. The UI class then returns the output message. This is in accordance to the levels of abstraction and classification established.

Add acknowledgements

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

Add Gradle support

d839859

Level-1

ff47a7a

Level-2

7358409

Level-3

3147541

Level-4

5869554

A-TextUiTesting

9ff98b5

Level-5

abe05eb

Level-6

afabe7d

Level-6

a82ef81

aakanshanarain changed the title ~~README.md~~ [Aakansha Narain] iP Aug 28, 2021

aakanshanarain added 2 commits August 29, 2021 23:56

Add more OOP

1a56d9d

Move classes to duke package

15af52e

yuifuku1118 reviewed Aug 30, 2021

View reviewed changes

vigneshsankariyer1234567890 reviewed Aug 31, 2021

View reviewed changes

aakanshanarain added 16 commits September 16, 2021 00:27

Add Storage class

feca504

Add JUnit Tests

e3694ff

Add JAR file

8c70f0d

Add Javadocs to public methods

edfb3f6

Tweak to comply with coding standards

257ac69

Add find command functionality

ab089f4

Merge branch 'branch-A-CodingStandard'

fc54428

This merge includes changes to the coding standard

Resolve conflicts while merging branch-Level-9

3109605

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

acf0641

…A-Gradle This merges the gradle-support to implement Scenario 2 while adding Gradle to the iP

Add Gradle support to automate some build tasks

98b0856

Add GUI to Duke

20af5bb

Add storage functionality to save tasklist

3c0c2b5

Add date and time conversion for task inputs

7192bbb

Add more OOP

c37b6a3

Add more JavaDocs and tweak coding style

4619db6

Add assertions

c228d14

aakanshanarain and others added 30 commits September 19, 2021 01:10

Revert "Add assertions"

16385f3

This reverts commit c228d14. Reverting commit to be made in another branch

Add assertions

94c3a0a

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

6df5f8c

Add assertions to some fragments of code

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

227584f

Modifications to the code quality

Rectify problems with the GUI

0f34752

Add Ui.png

8a175e0

Add User Guide

c4e7b8f

Change homepage screenshot for user guide

4c29fb3

Set theme jekyll-theme-minimal

e5d7624

Set theme jekyll-theme-minimal

896873a

Set theme jekyll-theme-cayman

7f2eaac

Set theme jekyll-theme-minimal

3c4eac7

Add acknowledgments

1a66261

Merge branch 'master' of github.com:aakanshanarain/ip

9163300

Add acknowledgements

Tweak README.md

8e9ec2f

Update README.md

6b49768

Set theme jekyll-theme-minimal

b90d9b5

Update README.md

52a8bb9

Update README.md

43f2042

Tweak README.md to fix images and replace Ui.png

9126f32

Tweak README.md to fix Homepage image

f073024

Update to help command for the GUI

e696299

Tweak Duke.java

e65284f

Clean code by removing redundant methods and add more JavaDocs

ca20ffe

Delete tasks.txt

9ca2212

Fix issues with launching on Windows and Linux

dac5432

Refactor code in CommandHandler, Parser and Ui

589e068

Update exceptions to be more comprehensive

7fceaae

		int charIndex = input.indexOf("/" );
		int atIndex = charIndex + 4;

		@@ -1,10 +1,64 @@
		//Solution below slightly adapted from https://github.com/Wincenttjoi/CS2103T-duke-chatbot/blob/master/src/main/java/duke/Duke.java

		import duke.*;

Uh oh!

Conversation

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

Uh oh!

Duke: Your personal task manager

Uh oh!

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

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

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

aakanshanarain commented Aug 28, 2021 •

edited

Loading