[Zeng Yu Ting] iP #227

Jillzyt · 2020-08-23T10:16:16Z

Transform Duke into the Best2103/TBot (Week 4)

Description:

More features are added to Duke. Duke has been transformed into a management platform for tasks. No additional dependencies are required for this change.

Best2103/TBot helps users to keep track of tasks such as todos, deadlines, events. The users can add, delete new tasks and complete tasks. They can also list their tasks to view the existing tasks.

Features added

Add Tasks (Deadline, Todo, Events type)
Add customized messages
Delete Tasks
List all Tasks
Complete Tasks

Fixes # (issue)

None.

Summary of changes

[ ✅ ] New feature (non-breaking change which adds functionality)
[ ✅ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ✅ ] This change requires a documentation update

How Has This Been Tested?

Currently, there is only one test which is Storage Test. Set up Junit and you will be able to run the StorageTest file.

[ ✅ ] Test A test.java.StorageTest

Checklist:

[ ✅ ] My code follows the style guidelines of this project
[ ✅ ] I have performed a self-review of my own code
[ ✅ ] I have commented my code, particularly in hard-to-understand areas
[ ✅ ] I have made corresponding changes to the documentation
[ ✅ ] My changes generate no new warnings
[ ✅ ] I have added tests that prove my fix is effective or that my feature works
[ ✅ ] Any dependent changes have been merged and published in downstream modules

Inline JavaFX tutorials

Address issues #5 and #6

Remove references to DukeStub

Change indentation in FXML samples to match AB-3

The OpenJFX plugin expects applications to be modular and bundled with jlink, resulting in fat jars that are not cross-platform. Let's manually include the required dependencies so that shadow can package them properly.

JavaFX tutorial: Support cross-platform JARs

@OverRide

Remove extra '@OverRide' at the start of the code example.

Remove unnecessary override annotation

Let's remove generic tutorials from this repo as they are not specific to this project tempalte

Level-1

Level-1 + Documentation

Level-2

Added Java Documentations with Level 3

Added more java documentations.

Added Documentations

Level-4 Todo and Deadline

Added documentations

Add A-TextUiTesting

Add A-TextUiTesting test cases

Level-5

Level-6

petrickjerico

Hi, Jillzyt! After reviewing your PR, I found that your code has no significant JDoc issues and is generally readable! Provided some possible optimizations that could further improve the code's readability – kindly give them some considerations. Otherwise, your Duke looks neat!

petrickjerico · 2020-09-02T16:59:54Z

src/main/java/duke/data/exception/DukeException.java

+ *
+ */
+public class DukeException extends Exception {
+    private String errorMesage;


Perhaps errorMessage can also be final?

Rationale: At any point, the code would throw new DukeException(errorMessage). Making the attribute(s) final is not only safe, but also recommended by JDoc as a good practice.

Noted. :) Thank you.

src/main/java/duke/data/Duke.java

src/main/java/duke/storage/DukeDecoder.java

petrickjerico · 2020-09-02T17:59:29Z

src/main/java/duke/data/task/TaskList.java

+        List<Task> filteredList = internalList
+                .stream()
+                .filter(task -> task.description.contains(searchString)).collect(Collectors.toList());


I like the usage of Streams here to filter relevant tasks!

Noticed that the method means to return UnmodifiableList. Would like to raise the use of Collectors.toUnmodifiableList() as a possible minor optimization.

Reference: https://stackoverflow.com/a/53013505

src/main/java/duke/commands/CommandResult.java

blackonyyx · 2020-09-05T17:16:05Z

src/main/java/duke/commands/FindCommand.java

+    // Message to add
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Find the tasks that contains the words. \n"
+            + "Parameters: find WORD\n" + "Example: " + COMMAND_WORD + " 1";
+


Your code is quite clean in general, but do note that javadocs for all public classes and methods is required.

blackonyyx · 2020-09-05T17:20:04Z

src/main/java/duke/data/exception/IllegalValueException.java

+/**
+ * Signals that some given data does not fulfill some constraints.
+ */
+public class IllegalValueException extends DukeException {


Perhaps for classes like these that extend off dukeException, we could add additional information about the error itself as compared to having the very generic dukeException error.
This could make the addition of a IllegalValueException have some additional value add.

blackonyyx · 2020-09-05T17:21:12Z

src/main/java/duke/data/task/Deadline.java

+     * Gets the string to be printed for the deadline.
+     */
+    public String toString() {
+        DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("MMM dd yyyy HH:mm");


This datetimeformatter could be made into a static method to reduce magic variables

blackonyyx · 2020-09-05T17:24:30Z

src/main/java/duke/storage/DukeDecoder.java

+
+
+/**
+ * DukeDencoder decodes all the {@code Task} in the {@code toSave} into a list of decodable


Nice use of pointers to other parts of the code! I did not know this existed. Thanks for showing this

blackonyyx

Generally, the code was well documented and well done. Good emphasis on the use of some functionalities of jdocs which I will certainly use in my own code as well. Good job!

Fix test files

Add assertions

Branch A-Assertions

Edit comments and variable names

Merge branch-A-CodeQuality into master

Add update tasks function

Update the user interface

Add credit

Add Ui image

Add a user guide

Update README.md

Rename README.md to INDEX.md

Rename index.md to README.md

Update README.md

Remove documentation files

Update images file path

Edit customized messages

j-lum and others added 30 commits August 14, 2019 15:30

Merge pull request #3 from j-lum/inline-javafx-tutorials

10c48a8

Inline JavaFX tutorials

Update Gradle tutorial to reflect new checkstyle config

f8d56b7

Fix typo referring to HelloWorld

b9c3d43

Add images to JavaFX tutorial 3

f1f2c85

Merge pull request #7 from j-lum/tutorial-fix

4d42e2c

Address issues #5 and #6

Remove references to DukeStub

f806913

Merge pull request #8 from j-lum/tutorial-fix

ce97316

Remove references to DukeStub

Change indentation in FXML samples to match AB-3

6046c12

Merge pull request #14 from j-lum/fxml-indent

c5c8937

Change indentation in FXML samples to match AB-3

JavaFX tutorial: Support cross-platform JARs

2d5dd15

The OpenJFX plugin expects applications to be modular and bundled with jlink, resulting in fat jars that are not cross-platform. Let's manually include the required dependencies so that shadow can package them properly.

Merge pull request nus-cs2103-AY2021S1#35 from j-lum/xplatformjfx

5e162da

JavaFX tutorial: Support cross-platform JARs

Remove unnecessary override annotation

0b8eb2f

Remove extra '@OverRide' at the start of the code example.

Merge pull request nus-cs2103-AY2021S1#41 from jiachen247/patch-2

0f72dde

Remove unnecessary override annotation

Remove generic tutorials

53d0463

Let's remove generic tutorials from this repo as they are not specific to this project tempalte

Add text-ui-test files

e749f6d

README.md: Fix typo of => or

db2a11b

Add Gradle support

3b19ba1

Level-1

eab7c33

Level-1

Level-1

6bcbdf0

Level-1 + Documentation

Level-2

2ffed75

Level-2

Level-3

e25b922

Level-3

91f6f56

Added Java Documentations with Level 3

Level-3

cedbfe6

Added more java documentations.

Level-3

b149537

Added Documentations

Level-4

7feb096

Level-4 Todo and Deadline

Level-4

65f9b20

Added documentations

A-TextUiTesting

3b5ed6a

Add A-TextUiTesting

A-TextUiTesting

1a5a225

Add A-TextUiTesting test cases

Level-5

37aa4b1

Level-5

Level-6

9cc75d5

Level-6

petrickjerico reviewed Sep 2, 2020

View reviewed changes

blackonyyx reviewed Sep 5, 2020

View reviewed changes

Jillzyt added 24 commits September 7, 2020 11:31

Fix test files

ce5caeb

Fix test files

Add assertions

852ba78

Add assertions

Merge pull request #9 from Jillzyt/branch-A-Assertions

6ed7ad5

Branch A-Assertions

Edit comments and variable names

0de32de

Edit comments and variable names

Merge pull request #10 from Jillzyt/branch-A-CodeQuality

8d20bfb

Merge branch-A-CodeQuality into master

Add update tasks function

9fa54de

Add update tasks function

Merge pull request #11 from Jillzyt/C-Update

6f2e802

Add update tasks function

Update the user interface

c452946

Update the user interface

Merge pull request #12 from Jillzyt/A-BetterGui

477dcf7

Update the user interface

Add credit

a023ca0

Add credit

Add Ui image

8e8842c

Add Ui image

Add a user guide

459276e

Add a user guide

Merge pull request #13 from Jillzyt/A-UserGuide

63f59c3

Add a user guide

Set theme jekyll-theme-slate

a14b30e

Update README.md

abc9afe

Update README.md

Update README.md

f157cdf

Update README.md

Rename README.md to INDEX.md

268b997

Rename README.md to INDEX.md

Rename index.md to README.md

9e0b3d5

Rename index.md to README.md

Update README.md

2011b19

Update README.md

Update README.md

d752500

Remove documentation files

945889c

Remove documentation files

Update images file path

83c3bdb

Update images file path

Edit customized messages

65836ac

Edit customized messages

Merge pull request #14 from Jillzyt/Final-Release

309d5c1

Edit customized messages

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Zeng Yu Ting] iP #227

[Zeng Yu Ting] iP #227

Jillzyt commented Aug 23, 2020 •

edited

petrickjerico left a comment

petrickjerico Sep 2, 2020 •

edited

Jillzyt Sep 7, 2020

petrickjerico Sep 2, 2020

blackonyyx Sep 5, 2020

blackonyyx Sep 5, 2020

blackonyyx Sep 5, 2020

blackonyyx Sep 5, 2020

blackonyyx left a comment



		/**
		* DukeDencoder decodes all the {@code Task} in the {@code toSave} into a list of decodable

[Zeng Yu Ting] iP #227

Are you sure you want to change the base?

[Zeng Yu Ting] iP #227

Conversation

Jillzyt commented Aug 23, 2020 • edited

Transform Duke into the Best2103/TBot (Week 4)

Description:

Features added

Fixes # (issue)

Summary of changes

How Has This Been Tested?

Checklist:

petrickjerico left a comment

Choose a reason for hiding this comment

petrickjerico Sep 2, 2020 • edited

Choose a reason for hiding this comment

Jillzyt Sep 7, 2020

Choose a reason for hiding this comment

petrickjerico Sep 2, 2020

Choose a reason for hiding this comment

blackonyyx Sep 5, 2020

Choose a reason for hiding this comment

blackonyyx Sep 5, 2020

Choose a reason for hiding this comment

blackonyyx Sep 5, 2020

Choose a reason for hiding this comment

blackonyyx Sep 5, 2020

Choose a reason for hiding this comment

blackonyyx left a comment

Choose a reason for hiding this comment

Jillzyt commented Aug 23, 2020 •

edited

petrickjerico Sep 2, 2020 •

edited