CS2103-AY1819S1-T09-2 · J0 · Nov 12, 2018 · Nov 11, 2018 · Nov 11, 2018 · Nov 11, 2018
diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc
@@ -221,6 +221,25 @@ image::Newcard Sequence Diagram.png[width="790", align="left"]
 ** Cons: The logic for executing deck-level and card-level commands are implemented at different places. We must ensure that the implementation of each command is correct.
 
 // end::cardleveloperation[]
+// tag::deckleveloperation[]
+=== Deck-level operations
+The following deck level operations are supported in Anakin:
+
+* Anakin#newDeck()
+* Anakin#removeDeck()
+* Anakin#updateDeck()
+* Anakin#importDeck()
+* Anakin#exportDeck()
+
+The following sequence diagram describes how the editdeck command would work: +
+Step 1: +
+Step 2: +
+Step 3: +
+
+* *Alternative 1* : <Insert first option here>
+* *Alternative 2* : <Insert Alternative here>
+
+// end::deckleveloperation[]
 
 // tag::handleinvalidcommands[]
 === Handle invalid commands
@@ -529,31 +548,55 @@ We are using `java.util.logging` package for logging. The `LogsCenter` class is
 * `INFO` : Information showing the noteworthy actions by the App
 * `FINE` : Details that is not usually noteworthy but may be useful in debugging e.g. print the actual list instead of just its size
 // tag::autocompleteimplementation[]
+
 === Autocomplete Implementation
 ==== Current implementation (v1.4)
 
-Autocompletion in Anakin is handled by an Autocompleter.
+The logic behind autocompletion is handled by an `Autocompleter` class.
 
-On pressing tab, CommandBox will raise an event and check if the current text in the command box is autocompletable, that is to say, it is a prefix of one of the existing commands supported by Anakin.
+On pressing `<TAB>`, Command Box will raise an event and check if the current text in the command box is autocompletable, that is to say, it is a prefix of one of the existing commands supported by Anakin.
 If it is Autocompletable, Autocompleter will search through the list of existing commands in lexicographic order and find the first match for the current text in the command box.
 
+Here is a sequence diagram of what happens during the autocompletion.
 
 ==== Design considerations
 
 * *Alternative 1 (current choice):* Use a set of pre-decided completion text for each command and have a list of all supported command words
-** Explanation: Each command has a pre-decided autocompletion text and we do prefix-matching between the text in the command box and our existing set of command words.
-If there is a potential match, we replace the current text in the command box with the autocompletion text of the supported command which it is matched to.
+** Explanation: Each command has a pre-decided `AUTOCOMPLETE_TEXT` field and we do prefix-matching between the text in the command box and our existing set of command words.
+If there is a potential match, we replace the current text in the command box with the `AUTOCOMPLETE_TEXT` of the supported command which it is matched to.
 
-** Pros: Better modularity
-** Cons: Less customizability. This design doesn't take into account the past commands that the user has issued.
+** Pros: Provides better modularity by decreasing the depndency of autocomplete on external components  (Current Implementation)
+** Cons: Less personalisation to each user. This design doesn't take into account the past commands that the user has issued.
 
 * *Alternative 2:* Match current command against the history of previously executed commands
 
-** Pros: Better prediction of intended command
-** Cons: Worse modularity and Separation of Concerns as the autocompleter would need to interact with the history and thus the state of the model.
+** Pros: Better personalisation of each command
+** Cons: Worse modularity and separation of concerns as the autocompleter would need to interact with the history. As such, it might increase coupling between the autocomplete and history components.
+
+==== How to add autocompletion for new commands
+* Should there be a need to include new commands, you can follow the following steps to ensure your command can be autocompleted.
+
+Example Scenario: Suppose we just introduced the `undo` command and we wish to integrate it with the autocompleter.
+
+Step 1 : Add the `AUTOCOMPLETE_TEXT` field to the class. This will decide what the command autocompletes to when the user presses tab. +
+
+image::AddAutocompleteTextExample.png[width="600"]
+
+
+Step 2 : Add the class to Autocompleter java
+
+image::AddCommandToAutocompleterExample.png[width="600"]
+
+With that, you're good to go!
 
 // end::autocompleteimplementation[]
+
+
+
+
 [[Implementation-Configuration]]
+
+
 === Configuration
 
 Certain properties of the application can be controlled (e.g App name, logging level) through the configuration file (default: `config.json`).

diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc
@@ -332,20 +332,6 @@ Format: `sort`
 
 // end::sort[]
 
-// tag::showDue[]
-=== Show cards that should be reviewed on a particular date : `showDue` [coming in v1.4]
-Show cards due on a particular date
-
-* Shows the cards which require a review for a particular date based on past card performance. +
-
-Format: `showDue c/10 m/12 y/14`
-****
-* Note: User must be inside a deck to perform this command.
-* The above command will display the cards due on the 10th December, 2014. If no arguments are given for date
-* If no day, month or year is given, showDue will default to showing the cards due for today
-****
-// end::showDue[]
-
 // tag::find[]
 === Search for a deck or card : `find`
 
@@ -499,21 +485,67 @@ The `redo` command fails as there are no `undo` commands executed previously.
 // end::undoredo[]
 
 === Clearing all entries : `clear`
-Clears all entries from Anakin. +
+To clear all entries from Anakin. +
 Format: `clear`
 
 
 === Exiting Anakin : `exit`
-Exits the program. +
+To exit the program. +
 Format: `exit`
 
-// start::autocompletion[]
+// tag::autocompletion[]
 === Autocompletion : Hit `<TAB>`
 
-Provides autocompletion for existing text. If there is an available autocompletion for the text in the textbox then hitting <TAB> will replace the text in the command box with the autocompletion text of the existing command
-which is lexicographically closest to what is in the text box. If the command box is empty autocompletion will default to ``cd 1``. Unfortunately, this feature does not work with trailing or preceeding whitespace currently.
+Hit <TAB> for autocompletion so you don't have to remember verbose commands. If there is an autocompletion available, hitting <TAB> will replace the current text in the command box with the autocompletion text.
+
+Examples: +
+
+1. Suppose you're attempting to create a new card.
+
+image::newCardPreAutocomplete.png[width="500"]
+
+Image: Partially completed `newcard` command.
+
+2. Just hit <TAB> and you will instantly get the desired result
+
+image::newCardPostAutocomplete.png[width="500"]
+
+Image: After pressing <TAB> the command is automatically completed!
+
+[NOTE]
+====
+If the command box is empty autocompletion will default to ``cd 1``.
+Additionally, this feature does not work with trailing or preceding whitespace currently.
+====
 
 // end::autocompletion[]
+// tag::rank[]
+=== Rank : `rank`
+
+To sort all cards by a user's cumulative performance score on each card. +
+Format: `rank` +
+Examples: Suppose you are studying for an important exam, and you want to find out which cards you performed poorly on so you can review them.
+
+
+1. Classify cards as described in the `classify` section above and type `rank`
+
+image::rankScreenshot1.png[width="500"]
+
+Image: Appearance of cards before sorting by performance
+
+2. Type  and you will instantly get the desired result
+
+image::rankScreenshot2.png[width="500"]
+Image: Appearance of cards after sorting by performance. As can be seen, harder cards move to the top. +
+
+[NOTE]
+====
+ The indicator in the card panel only shows the most recent classification of the card while the scheduling algorithm takes into account all past reviews.
+As such, cards labelled HARD may not always be above cards ranked NORMAL.
+====
+
+
+// end::rank[]
 
 
 == FAQ
@@ -554,7 +586,7 @@ You must be inside a deck to perform this operation.
 |`classify DIFFICULTY` | Classifies the current card into one of the following categories: {‘easy’, ‘normal' , ‘hard’}
 |`sort` | Sorts the displayed list of decks by name. +
 When you are inside a deck, sorts the displayed list of cards by question.
-//|`rank` | Sort the list of cards by performance
+|`rank` | Sort the list of cards by performance
 |`find KEYWORD [MORE_KEYWORDS]...` | Finds decks with names that contain any of the given keywords. +
 When you are inside a deck, finds cards with questions that contain any of the given keywords.
 |`export INDEX` | Exports the deck at the specified INDEX. (Default location is the same folder as Anakin)

diff --git a/docs/images/AddAutoCompleteTextExample.png b/docs/images/AddAutoCompleteTextExample.png
diff --git a/docs/images/AddCommandToAutoCompleterExample.png b/docs/images/AddCommandToAutoCompleterExample.png
diff --git a/docs/images/newCardPostAutocomplete.png b/docs/images/newCardPostAutocomplete.png
diff --git a/docs/images/newCardPreAutocomplete.png b/docs/images/newCardPreAutocomplete.png
diff --git a/docs/images/rankScreenshot1.png b/docs/images/rankScreenshot1.png
diff --git a/docs/images/rankScreenshot2.png b/docs/images/rankScreenshot2.png
diff --git a/docs/team/leeyjjoel.adoc b/docs/team/leeyjjoel.adoc
@@ -2,26 +2,37 @@
 :site-section: AboutUs
 :imagesDir: ../images
 :stylesDir: ../stylesheets
+:repoURL: https://github.com/CS2103-AY1819S1-T09-2/main/tree/master
 
-This portfolio outlines the contributions of Lee Yi Jie Joel to the following project(s).
+This portfolio outlines my contributions  to the following project.
 
 == PROJECT: Anakin
 
 ---
 
-This project was completed during August 2018 to November 2018 as part of a Software Engineering module (CS2103T) in
-the National University of Singapore. The team comprises Tay Yu Jia, Joel Lee, Foo Guo Wei, David Goh and Nguyen
-Trong Truong Thanh.
+Anakin is the result of our search for a better command line application to revise for exams. From August 2018 to November 2018,
+Team T09-2 comprising of myself, Tay Yu Jia, Foo Guo Wei, David Goh and Nguyen Truong Thanh built Anakin as part of a Software Engineering module (CS2103T) conducted at
+the National University of Singapore.
 
 == Overview
 
 Anakin is a desktop-based flashcard application which makes remembering things easy. The user
-interacts with it using a CLI, and it has a GUI created with JavaFX. Its key selling points are the ability to replace
-traditional paper flashcards (thus saving the environment) and to provide an enhanced learning experience through the
-well-established spaced repetition learning method.
+interacts with it using a Command Line Interface but can fallback to the Java FX GUI if needed. Anakin uses https://www.supermemo.com/english/ol/sm2.htm[Super Memo 2]  which is the  spaced repetition algorithm used by popular language learning tools such as
+Duolingo, Wani Kani, and Memrise. +
+
+Anakin aims to revolutionise the studying experience of the technically advanced user. On top of being easy to use,
+Anakin is also environmentally friendly, having zero paper wastage unlike conventional flashcards.
+
+image::Ui.png[width="500"]
+[NOTE]
+====
+What is spaced repetition? +
+Spaced repetition is a learning technique that incorporates increasing intervals of time between subsequent review of previously learned material in order to exploit the psychological spacing effect.
+====
 
 It is written in Java, and has about 10 kLoC.
 
+
 * *Main features*:
 ** Create decks of flashcards easily
 ** Review your flashcards on the go
@@ -32,25 +43,31 @@ It is written in Java, and has about 10 kLoC.
 
 This section acts as a summary of the contributions made by Lee Yi Jie Joel to project Anakin.
 
-* *Major enhancement*: added *showDue* command as well as the scheduling algorithm behind it
-** What it does: allows the users to see cards which have been scheduled on a particular date  .
-** Justification: This feature improves the product significantly because a user will want to be able to look through
- review cards based on how he has classified them
-** Highlights: This enhancement affects existing commands and commands to be added in future. While in the review
-mode, using the *supermemo2* spaced recognition algorithm, the student is saved from the hassle of seperating his/her flashcards
-into boxes based on how well he/she remembers them. This will allow for a better studying experience and in turn better recall for tests
+* *Major enhancement*: I added autocompletion for commands
+** What it does: allows the users to sort cards by when they should be reviewed.
+** Justification: This feature improves the product significantly because a user will want to be able to finish expressing
+the command he wants to type with a simple press of <TAB>
+** Highlights: This enhancement affects existing commands and commands to be added in future. While typing in the command box, the student is saved from the hassle of typing and remembering
+long strings of command syntax. This will allow for a better user experience and in turn easier studying for tests.
+
+* *Major enhancement*: I added the scheduling algorithm at the core of the product together with the `rank` command
+** What it does: allows the users to sort cards by when they should be reviewed.
+** Justification: This feature improves the product significantly because a user will want to review cards which he or she performed poorly on
+** Highlights: This allows user to focus on what's important for review by sorting the cards in order of performance and pushing cards which require review to the top of the deck.
+
+
 
 * *Minor enhancements*:
-** Help command which allows user to seek help when he/she is lost or initially starting out
-** Added systemtests to increase robustness of the application
-** Implemented a `editdeck` command that allows user to update the details of their deck.
-** Added an exit command to allow user to leave the deck
-** Added a `select` command which is now deprecated
-** Add `undo` and `redo` functions
-** Implement autocompletion function
+** Added Help command which allows user to seek help when he/she is lost.
+** Implemented the `editdeck` command that allows users to update the name of their deck.
+** Added the `exit` command to allow the user to leave the deck
+** Added the `select` command which eventually formed the basis for other commands to be developed.
+** Add `undo` and `redo` commands
 
 
-*Code contributed:* https://nus-cs2103-ay1819s1.github.io/cs2103-dashboard/#=undefined&search=leeyjjoel[GitHub]
+*Code contributed:*
+https://github.com/CS2103-AY1819S1-T09-2/main/commits?author=leeyjjoel[Github Commits],
+https://nus-cs2103-ay1819s1.github.io/cs2103-dashboard/#=undefined&search=leeyjjoel[Reposense]
 
 * *Other contributions*:
 
@@ -59,27 +76,41 @@ into boxes based on how well he/she remembers them. This will allow for a better
 https://github.com/CS2103-AY1819S1-T09-2/main/issues?q=is%3Aissue+is%3Aclosed+author%3Aleeyjjoel[List of created issues]
 *** Update contact us page (Pull request https://github.com/CS2103-AY1819S1-T09-2/main/pull/68[#68])
 *** Added initial documentation for team README (Pull request https://github.com/CS2103-AY1819S1-T09-2/main/pull/23[#23])
-*** Integrate reposense for code contribution tracking
+*** Integrate Reposense for code contribution tracking (Pull request https://github.com/CS2103-AY1819S1-T09-2/main/pull/75/files[#75])
+*** Configure naming convention of files and packages across the project to comply with project style guide(https://github.com/CS2103-AY1819S1-T09-2/main/pull/38/files[#38]
+, https://github.com/CS2103-AY1819S1-T09-2/main/pull/106/files[#106])
+
+
 
 ** Enhancements to existing features:
-*** Created system tests (Pull request https://github.com/CS2103-AY1819S1-T09-2/main/pull/158[#158])
+*** Wrote extensive system tests which played a major role in boosting coverage from 66% to the above 90%
+**** Wrote integration tests and tests for help command(https://github.com/CS2103-AY1819S1-T09-2/main/pull/148[#148])
+**** Wrote Unit Tests for editdeck(https://github.com/CS2103-AY1819S1-T09-2/main/pull/121/files[#121])
+**** Wrote tests for EditCard, EditDeckParser, and GUI (https://github.com/CS2103-AY1819S1-T09-2/main/pull/157/files[#157])
+**** Wrote System Tests for ClearCommand, FindCommand, Logic Manager, EditDeck, NewDeck(https://github.com/CS2103-AY1819S1-T09-2/main/pull/158/files[#158],
+https://github.com/CS2103-AY1819S1-T09-2/main/pull/165/files[#165],
+ https://github.com/CS2103-AY1819S1-T09-2/main/pull/238[#238], https://github.com/CS2103-AY1819S1-T09-2/main/pull/242[#242], https://github.com/CS2103-AY1819S1-T09-2/main/pull/244[#244])
+
+
 ** Documentation:
+*** Add documentation for deck level operations(https://github.com/CS2103-AY1819S1-T09-2/main/pull/110/files[#110])
+*** Update user guide and development guide(https://github.com/CS2103-AY1819S1-T09-2/main/pull/268[#268])
 
 ** Community:
 *** PRs reviewed (with non-trivial review comments):
 https://github.com/CS2103-AY1819S1-T09-2/main/pull/189[#189]
 https://github.com/CS2103-AY1819S1-T09-2/main/pull/195[#195]
+https://github.com/CS2103-AY1819S1-T09-2/main/pull/271[#271]
 
-*** Discovered and reported bugs to peers:
-This is a work in progress
 
 == Contributions to the User Guide
 
 |===
 |_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
 |===
-
-include::../UserGuide.adoc[tag=showDue]
+include::../UserGuide.adoc[tag=autocompletion]
+include::../UserGuide.adoc[tag=rank]
+include::../UserGuide.adoc[tag=undoredo]
 
 
 == Contributions to the Developer Guide
@@ -89,6 +120,8 @@ include::../UserGuide.adoc[tag=showDue]
 |===
 
 include::../DeveloperGuide.adoc[tag=autocompleteimplementation]
-include::../DeveloperGuide.adoc[tag=decklevelcommands]
+//include::../DeveloperGuide.adoc[tag=deckleveloperation]
+
+
 
 
diff --git a/src/main/java/seedu/address/logic/parser/Autocompleter.java b/src/main/java/seedu/address/logic/parser/Autocompleter.java
@@ -1,6 +1,5 @@
 package seedu.address.logic.parser;
 
-//import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.stream.Collectors;
@@ -37,7 +36,11 @@
  */
 
 public class Autocompleter {
-    // This method of approaching the problem was inspired by @jethrokuan
+    /** This method of approaching the problem was inspired by verbal discussion with @jethrokuan
+     * (a Year Three CS student)
+     * His team's CS2103 project can be found at  https://github.com/jethrokuan/main
+     */
+
     /**
      * Checks if {@code commandBox}'s commandTextField has a potential autocompletable command word,
      * if there exists such a word, it is replaced with the relevant autocompletion command.
@@ -88,11 +91,10 @@ private static List<String> getCommandField(String field) {
     }
 
     /**
-     * Creates a list of all existing command classes and returns it to the user.
+     * Creates a list of all existing command classes and returns it to the user so that
+     * the user can retrieve properties within each command class.
      */
     private static List<Class<? extends Command>> getCommandClasses() {
-        //        File directory = new File(COMMAND_DIRECTORY);
-        //        File[] fList = directory.listFiles();
         List<Class<? extends Command>> commandClasses = new ArrayList<>();
         commandClasses.add(ChangeDeckCommand.class);
         commandClasses.add(ClassifyCommand.class);

diff --git a/src/main/java/seedu/address/model/deck/UniqueCardList.java b/src/main/java/seedu/address/model/deck/UniqueCardList.java
@@ -92,7 +92,7 @@ public void sort() {
      * Sort all cards in the list in order of performance.
      */
     public void perfsort() {
-        internalList.sort(Comparator.comparing(o -> o.getNextReview()));
+        internalList.sort(Comparator.comparing(o -> -o.getReviewScore()));
 
     }