Add Sort feature #53

kkangs0226 · 2020-10-14T06:03:51Z

List of projects displayed cannot be sorted in a specified order.

Adding sort feature will make application more user friendly as it
can display projects in orders required by users.

Let's

add SortCommand and SortCommandParser
add other relevant Comparators for sorting
make necessary changes to existing files
add tests for SortCommand, SortCommandParser and Comparators

Closes #47, closes #48

List of projects displayed cannot be sorted in a specified order. Adding sort feature will make application more user friendly as it can display projects in orders required by users. Let's * add SortCommand and SortCommandParser * add other relevant Comparators for sorting * make necessary changes to existing files * add tests for SortCommand, SortCommandParser and Comparators

codecov-io · 2020-10-14T06:05:21Z

Codecov Report

Merging #53 into master will increase coverage by 2.24%.
The diff coverage is 97.26%.

@@             Coverage Diff              @@
##             master      #53      +/-   ##
============================================
+ Coverage     72.52%   74.76%   +2.24%     
- Complexity      593      669      +76     
============================================
  Files            99      105       +6     
  Lines          1838     2021     +183     
  Branches        198      222      +24     
============================================
+ Hits           1333     1511     +178     
- Misses          433      435       +2     
- Partials         72       75       +3

Impacted Files	Coverage Δ	Complexity Δ
src/main/java/seedu/momentum/model/Model.java	`100.00% <ø> (ø)`	`1.00 <0.00> (ø)`
...eedu/momentum/model/project/UniqueProjectList.java	`91.13% <89.47%> (-1.55%)`	`33.00 <13.00> (+13.00)`	⬇️
...in/java/seedu/momentum/model/project/Deadline.java	`89.36% <93.75%> (+2.26%)`	`23.00 <9.00> (+9.00)`
...rc/main/java/seedu/momentum/commons/core/Date.java	`88.00% <100.00%> (+3.00%)`	`12.00 <3.00> (+3.00)`
...ain/java/seedu/momentum/commons/core/DateTime.java	`84.84% <100.00%> (+4.07%)`	`16.00 <3.00> (+3.00)`
...rc/main/java/seedu/momentum/commons/core/Time.java	`75.00% <100.00%> (+6.57%)`	`9.00 <3.00> (+3.00)`
...ava/seedu/momentum/logic/commands/SortCommand.java	`100.00% <100.00%> (ø)`	`15.00 <15.00> (?)`
...in/java/seedu/momentum/logic/parser/CliSyntax.java	`88.88% <100.00%> (+3.17%)`	`1.00 <0.00> (ø)`
...seedu/momentum/logic/parser/ProjectBookParser.java	`100.00% <100.00%> (ø)`	`15.00 <0.00> (+1.00)`
...seedu/momentum/logic/parser/SortCommandParser.java	`100.00% <100.00%> (ø)`	`14.00 <14.00> (?)`
... and 14 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5bede92...27371b3. Read the comment docs.

…into feature-issue-47

User Guide does not have a section for sort command. Updating user guide to include sort instructions would improve user guide. Let's update user guide to include sort instructions.

…nto feature-issue-47

Accidentally removed a character from User Guide. Let's fix the change.

pr4aveen

Have a few comments that might need to be addressed before merging. Should be ok to merge once those changes have been made :)

src/main/java/seedu/momentum/logic/commands/SortCommand.java

src/main/java/seedu/momentum/model/ModelManager.java

src/main/java/seedu/momentum/model/project/comparators/CreatedDateCompare.java

src/main/java/seedu/momentum/model/project/comparators/DeadlineCompare.java

src/test/java/seedu/momentum/logic/commands/SortCommandTest.java

src/main/java/seedu/momentum/logic/parser/SortCommandParser.java

src/test/java/seedu/momentum/logic/parser/ProjectBookParserTest.java

pr4aveen · 2020-10-14T08:30:05Z

src/main/java/seedu/momentum/logic/parser/SortCommandParser.java

+     * and returns a SortCommand object for execution.
+     * @throws ParseException if the user does not conform to the expected format.
+     */
+    public SortCommand parse(String args) throws ParseException {


Just checking, what's the expected behaviour when there is a preamble?

For example, sort hello type/alpha order/dsc

It should disregard the preamble.
I have added a test for this!

I have changed the SortCommandParser to fail when there is a non-empty preamble for consistency as AddCommandParser and FindCommandParser does the same. I have added a test accordingly!

src/test/java/seedu/momentum/logic/commands/AddCommandIntegrationTest.java

khoodehui

Just some things to take note, not too much of an issue though. Otherwise LGTM!

src/main/java/seedu/momentum/logic/commands/SortCommand.java

src/main/java/seedu/momentum/logic/parser/SortCommandParser.java

src/main/java/seedu/momentum/model/project/comparators/CreatedDateCompare.java

src/test/java/seedu/momentum/logic/parser/SortCommandParserTest.java

claracheong4

I think some minor changes has to be made.

src/main/java/seedu/momentum/model/Model.java

src/main/java/seedu/momentum/model/project/UniqueProjectList.java

resolve comments Name, Deadline, Date, DateTime, Time classes can inherit from Comparable interface to make them comparable. Some long methods can be abstracted further and more static variables can be declared to make code more readable. Let's * implement compareTo methods in these classes * update code to make it more readable

…into feature-issue-47

Wrong import order causes checkstyle error. Let's update import order.

Test for parsing empty arguments fails on Windows. Let's update SortCommandParserTest.

compareTo methods have not been tested. Add tests to increase test code coverage. Let's add tests for compareTo methods.

kkangs0226 added the priority.Medium Nice to have label Oct 14, 2020

kkangs0226 added this to the v1.2 milestone Oct 14, 2020

kkangs0226 added this to In progress in v1.2 (by 16/10/2020) via automation Oct 14, 2020

kkangs0226 self-assigned this Oct 14, 2020

kkangs0226 and others added 5 commits October 14, 2020 14:07

Merge branch 'master' into feature-issue-47

abdd93d

Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T10-1/tp …

fee7fe6

…into feature-issue-47

Update User Guide

d633164

User Guide does not have a section for sort command. Updating user guide to include sort instructions would improve user guide. Let's update user guide to include sort instructions.

Merge branch 'feature-issue-47' of https://github.com/kkangs0226/tp i…

4758357

…nto feature-issue-47

Fix accidental change in User Guide

65c26f9

Accidentally removed a character from User Guide. Let's fix the change.

pr4aveen approved these changes Oct 14, 2020

View reviewed changes

khoodehui approved these changes Oct 14, 2020

View reviewed changes

v1.2 (by 16/10/2020) automation moved this from In progress to Reviewer approved Oct 14, 2020

claracheong4 reviewed Oct 14, 2020

View reviewed changes

kkangs0226 added 6 commits October 14, 2020 23:44

Merge branch 'master' of https://github.com/AY2021S1-CS2103T-T10-1/tp …

922b7f4

…into feature-issue-47

Update import order for ProjectBookParserTest

3bcbfb9

Wrong import order causes checkstyle error. Let's update import order.

Update SortCommandParserTest

f141cbc

Test for parsing empty arguments fails on Windows. Let's update SortCommandParserTest.

Second update to SortCommandParserTest

1ad2501

Test for parsing empty arguments fails on Windows. Let's update SortCommandParserTest.

Add tests for compareTo methods for model classes

27371b3

compareTo methods have not been tested. Add tests to increase test code coverage. Let's add tests for compareTo methods.

kkangs0226 merged commit edb3a2e into AY2021S1-CS2103T-T10-1:master Oct 14, 2020

v1.2 (by 16/10/2020) automation moved this from Reviewer approved to Done Oct 14, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Sort feature #53

Add Sort feature #53

kkangs0226 commented Oct 14, 2020

codecov-io commented Oct 14, 2020 •

edited

pr4aveen left a comment

pr4aveen Oct 14, 2020

kkangs0226 Oct 14, 2020

kkangs0226 Oct 14, 2020

khoodehui left a comment

claracheong4 left a comment

Add Sort feature #53

Add Sort feature #53

Conversation

kkangs0226 commented Oct 14, 2020

codecov-io commented Oct 14, 2020 • edited

Codecov Report

pr4aveen left a comment

Choose a reason for hiding this comment

pr4aveen Oct 14, 2020

Choose a reason for hiding this comment

kkangs0226 Oct 14, 2020

Choose a reason for hiding this comment

kkangs0226 Oct 14, 2020

Choose a reason for hiding this comment

khoodehui left a comment

Choose a reason for hiding this comment

claracheong4 left a comment

Choose a reason for hiding this comment

codecov-io commented Oct 14, 2020 •

edited