[CS2113-T18-1] Movie Reviews #47
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Manifest-Version: 1.0 | ||
| Main-Class: seedu.duke.Duke | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,4 +43,5 @@ checkstyle { | |
|
|
||
| run{ | ||
| standardInput = System.in | ||
| enableAssertions = true | ||
| } | ||
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| # About us | ||
|
|
||
| | Display | Name | Github Profile | Portfolio | | ||
| |-----------------------------------|:-------------------:|:----------------------------------------:|:--------------------------------:| | ||
| |  | Nazrul Syahmi | [Github](https://github.com/naz019) | [Portfolio](team/naz019.md) | | ||
| |  | Matthew Phua | [Github](https://github.com/matthewphua) | [Portfolio](team/matthewphua.md) | | ||
| |  | Ong Shao Yong | [Github](https://github.com/redders7) | [Portfolio](team/redders7.md) | | ||
| |  | Indraneel Paranjape | [Github](https://github.com/indraneelrp) | [Portfolio](team/indraneelrp.md) | | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,235 @@ | ||
| # Developer Guide | ||
|
|
||
| ## Design & Implementation | ||
|
|
||
| ### Ui | ||
| The `Ui` class handles user input and basic output messages. It can | ||
| * Read user input | ||
| * Output various messages to the user | ||
| When instantiated, the Ui class holds a protected attribute called isExit, which is a flag for whether the conditions for | ||
| termination of the program have been met. In other words, this tracks whether the command entered by the user is the | ||
| termination command. The functions in the Ui class help greet the user, get continuous input, and print output to the user. | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. Note that this is non-standard UML notation. You can use the info here to change settings for PlantUML: nus-cs2113-AY2122S1/forum#114
|
||
|
|
||
| ### Storage Class | ||
| The `Storage` class handles the storing and retrieval of users' information. The storage class is instantiated with a | ||
| filepath and folderpath string, which represents where the stored.txt file will be created in the /data folder. | ||
| The Storage class is instantiated in the Duke constructor. The main program of Duke calls the function from the storage class | ||
| whose purpose is to check whether a file exists at the specified path and make the file if there is none. The main function | ||
| also calls the loadMedia function from the Storage class, which retrieves the past stored data so that it can be mainpulated | ||
| by the user.The saved information is then loaded in to the reviewList object which the user maniuplates. | ||
| After every command entered by the user, the storage txt file is updated via the function updateFile. Keeping the file updated after every user command ensures minimal data loss in the case of a non-graceful exit of the program. Moreover, the function loadMedia performs some basic checks to ensure that the format of the lineInput being read in is valid. This minimises | ||
| ungraceful termination in case of tampering of the text file. | ||
|
|
||
|  | ||
|
|
||
| ### Media Classes | ||
|  | ||
|
|
||
| ### Commands | ||
| The command component enables users to make changes to their review list. The command word is taken from the first word | ||
| of the user input, and is processed through the `Parser` class. The class diagram shows how the Commands parent class is | ||
| implemented, as well as its extended classes. | ||
|  | ||
|
There was a problem hiding this comment.
Might this italicised |
||
|
|
||
| #### Add | ||
| The `add` command enables users to create new movie or TV Show reviews and add them to their review list. The following | ||
| is how the `add` command works: | ||
| 1. The `Parser` class takes in the user input, and parses this by using its `processUserInput` function. | ||
| 2. If the parsed command word is recognised to be the `add` command, the `executeAdd` function is called. | ||
| 3. Using the parsed command, `Parser` then determines whether the review to be added is a movie or Tv show. Otherwise, a | ||
| DukeException error is thrown. | ||
| 4. A new variable of type Media parent class, `toAdd`, is then created. The `AddCommand` function is then called to add | ||
| the Movie or Tv Show `toAdd` into the review list, `reviewList`. | ||
|  | ||
|
There was a problem hiding this comment. Consider adding
|
||
|
|
||
|
There was a problem hiding this comment. Consider breaking up the diagram. If showing the sequence of
There was a problem hiding this comment. There may be missing/extra lifelines here.
|
||
| #### Find | ||
| The find command enables users to search for existing reviews that contains a given keyword. This is done through the | ||
| following steps: | ||
| 1. The `Parser` class takes in the user input, and parses this by using its `processUserInput` function. | ||
| 2. If the parsed command word is recognised to be the `add` command, the `executeFind` function is called and extracts | ||
| the keyword to search for from the user input. | ||
| 3. `Parser` then creates an `executor` object by creating a new `FindCommand`. `Parser` then calls the `execute` | ||
| function from `executor` which loops through all reviews in the list and displays those containing the given keyword | ||
| using the `toString()` function found in both the `Movie` and `TvShow` subclasses. | ||
|  | ||
|
|
||
| #### List | ||
| The list command outputs all inputted reviews per category: | ||
|
|
||
| 1. The list command sequence begins with a `Parser` object. | ||
| 2. The `Parser` object calls on `executeList` which is responsible for creating a `ListCommand` Object. It then calls on its `execute` method to execute the proper actions. | ||
| 3. In this `execute` function, it loops through all the stored reviews and separates each review based on category and formats using the proper `toString` method. | ||
| 4. Finally, an output string is returned and the `Parser` class calls on the `UI` object to print the output to the user. | ||
|
|
||
|  | ||
|
|
||
| #### Sort | ||
| The sort command sorts reviews based on a given input. | ||
|
|
||
| 1. The sort command sequence begins with a `Parser` object. | ||
| 2. The `Parser` object calls on `executeSort` which is responsible for creating a `SortCommand` Object. Then it calls on `SortCommands`'s `execute` method to execute the proper actions. | ||
| 3. The `execute` method sorts the review list by the given field. When sorting by rating or date, the sorting is done in | ||
| reverse order while whereas when sorting by title or genre, the sorting is done in default order. | ||
| 4. The `execute` function returns the sorted outputted string. | ||
| 5. Finally, the `Parser` class calls on the `UI` object to print out the output to the user. | ||
|
|
||
|  | ||
|
|
||
| #### Remove | ||
| When the user wants to delete a specific review from the review list, they will use the following command: "delete | ||
| [mediaType] [index]" which triggers the executeDelete() method in Parser. For example, "delete movie 2" will delete the | ||
| review at index 2 of movie section of the review list. | ||
|
|
||
| 1. To check that the command given by the user is valid, the program checks for the condition that the user input | ||
| array contains exactly three String objects, failing which a DukeException will be thrown. | ||
|
|
||
| 2. The program then checks if a valid media type is given i.e. "movie" or "tv", failing which a DukeException will | ||
| also be thrown. | ||
|
|
||
| 3. If the previous conditions are successfully met, a RemoveCommand object is created and its execute() method is | ||
| called. This method loops through the review list, first checking whether the review is of the given media type, then | ||
| whether the review is at the given index. | ||
|
|
||
| 4. If both conditions are met, the review is successfully removed from the review list. | ||
|
|
||
| 5. A string confirming the successful removal of the review is generated and printed for the user. | ||
|
|
||
|  | ||
|
|
||
| #### Clearing the review list | ||
|
|
||
| When the user wants to remove every review from the review list, they will use the following command: "clear", which | ||
| triggers the executeClear() method in Parser. | ||
|
|
||
| 1. A ClearCommand object is created and its execute() method is called. | ||
|
|
||
| 2. The ArrayList method clear() is called on the review list, removing every Media object from the review list. | ||
|
|
||
| 3. A string confirming the successful clearing of the review list is generated and printed for the user. | ||
|
|
||
|  | ||
|
|
||
| ### Marking favourite reviews or listing all favourites | ||
|
|
||
| The "favourite" command covers two user scenarios: | ||
| 1) The user wants to mark or unmark a specific review as favourite. | ||
| 2) The user wants to list all favourites. | ||
|
|
||
| **Scenario 1**: | ||
| To mark or unmark a review, the user will use the following command: "favourite [type] [index]", which triggers the | ||
| executeFavourite() method in Parser. For example, "favourite 3" mark the review at index 3 if it has not been marked as | ||
| favourite, or unmark it if it has already been marked as favourite. | ||
|
|
||
| Step 1: A FavouriteCommand object is created and its execute() method is called. | ||
|
|
||
| Step 2: The program checks that a valid media type is given in the user input i.e. "movie" or "tv" failing which a | ||
| DukeException will be thrown. | ||
|
|
||
| Step 3: The program then loops through the review list to check whether the review is of the given media type and at | ||
| the given index. | ||
|
|
||
| Step 4: If the review at the given index has not been marked as favourite, the setFavourite(true) method of the Media | ||
| class is called to mark the review as favourite. Conversely, if the review at the given index has already been marked | ||
| as favourite, the setFavourite(false) method of the Media class is called to unmark the review as favourite. | ||
|
|
||
| Step 5: A string confirming the successful marking or unmarking of the review as favourite is generated and printed for | ||
| the user. | ||
|
|
||
| **Scenario 2**: | ||
| To list all favourites in the review list, the user will use the following command: "favourite list", which triggers | ||
| the executeFavourite() command in Parser. | ||
|
|
||
| Step 1: A FavouriteCommand object is created and its execute() method is called. | ||
|
|
||
| Step 2: The program checks that the user input contains the "list" keyword. | ||
|
|
||
| Step 3: The program loops through the review list and checks whether the review has been marked as favourite. If the | ||
| review has been marked as favourite, the toString() method of the Media class is called on that review so that the | ||
| stringified version of that review can be added to a String object, which will be returned to the Parser. | ||
|
|
||
| Step 4: The String object which was returned to the Parser and contains the list of reviews marked as favourite is | ||
| printed for the user. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Product scope | ||
| ### Target user profile | ||
|
|
||
| myReviews targets individuals who are avid movie or TV show watchers and are proficient in using the command line. | ||
|
|
||
| ### Value proposition | ||
|
|
||
| For movie and TV show enthusiasts, using common movie review websites like RottenTomatoes involves navigating past a | ||
| lot of irrelevant pages to arrive at a review page. Users who want to submit personal reviews may also have to spend up | ||
| to a minute navigating these websites first. Furthermore, there is often no convenient way for users to view and compare | ||
| their personal reviews for any form of analysis. Hence, myReviews aims to provide a fast and bloat-free all-in-one | ||
| avenue where users can quickly store their personal reviews and view them at a glance. | ||
|
|
||
| ## User Stories | ||
|
|
||
| |Version| As a ... | I want to ... | So that I can ... | | ||
| |--------|---------|---------------------------------------------------------|----------------------------------------------------------| | ||
| |v1.0|user| add movies to a list | keep track of which movies I have watched. | | ||
| |v1.0|user| add ratings out of 10 to a movie | remember how much I enjoyed the movie. | | ||
| |v1.0|user| remove movies from my list | delete erroneous entries. | | ||
| |v1.0|user| list the movies I have added | view what movies I have watched | | ||
| |v1.0|user| enter the date I watched the movie | recall when I watched the movie. | | ||
| |v2.0|user| arrange my review list by worst or best ratings | see the shows that I like or hate the most. | | ||
| |v2.0|user| star/favorite a movie | mark shows that I would like to watch again. | | ||
| |v2.0|user| star/favorite a tv show | mark tv shows that I may want to watch again. | | ||
| |v2.0|user| see a display of my favourited items | I can quickly refer to the shows I have marked. | | ||
| |v2.0|user| be able to save my information after I exit the program | offload it from my mind. | | ||
| |v2.0|user| be able to retrieve my last saved list | I do not have to remember it myself. | | ||
| |v2.0|user| list the movies I have watched | view what movies I have watched | | ||
| |v2.0|user| list the tv shows I have watched | view what tv shows I have watched | | ||
| |v2.0|user| search movies using a keyword | to find a specific movie I have watched | | ||
| |v2.0|user| search tv show using a keyword | to find a specific tv show I have watched | | ||
| |v2.0|user| clear movies that I have watched | to clear my watch history | | ||
| |v2.0|user| clear tv shows that I have watched | to clear my watch history | | ||
| |v2.0|user| automatically save reviews | load my previously added reviews upon restarting program | | ||
|
|
||
|
|
||
|
|
||
| ## Non-Functional Requirements | ||
|
|
||
| 1. Performance: The program should respond within 2 seconds of user input. | ||
| 2. Quality: With guidance by the user guide, a new user should be able to navigate the program. | ||
| 3. Technical: The program should work with all environments that load the program with Java 11. | ||
| 4. Project Scope: The program is only required to handle reviews for movies and tv shows. | ||
|
|
||
| ## Glossary | ||
|
|
||
| * *review* - The user's appraisal of a movie or TV show, reflected in a rating. | ||
|
|
||
| ## Instructions for manual testing | ||
|
|
||
| Set Up: | ||
| 1. Ensure that you have Java 11 or above installed. | ||
| 2. Download the latest version of `myReviews` from [here](https://github.com/AY2223S1-CS2113-T18-1b/tp/releases). | ||
| 3. Copy the jar file into the folder you want to store your reviews. | ||
| 4. Open terminal application and change directory to the above folder. | ||
| 5. Run the jar file by entering java -jar myReviews.jar into the terminal. | ||
|
|
||
| Testing: | ||
| 1. myReviews will display a greeting message. Enter a command and press Enter to execute it. | ||
| 2. Add a Movie or TvShow: | ||
|
|
||
| `add /movie <title> /rating <rating> /date <dateWatched> /genre <genre>` | ||
|
|
||
| `add /tv <title> /rating <rating> /date <dateWatched> /genre <genre> /site <location>` | ||
| 3. Input additional commands for testing | ||
| (refer to user guide for command parameters): | ||
| 1. `list` | ||
| 2. `sort` | ||
| 3. `favourite` | ||
| 4. `favourite list` | ||
| 5. `find` | ||
| 6. `delete` | ||
| 7. `clear` | ||
|
|
||
|
|
||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| @startuml | ||
| !include style.puml | ||
|
|
||
| class "{abstract} \nCommands" { | ||
| String execute() | ||
| } | ||
| hide "{abstract} \nCommands" fields | ||
|
|
||
| class AddCommand { | ||
| +media: Media | ||
| +AddCommand(reviews: ReviewList, media: Media) | ||
| } | ||
|
|
||
| class ClearCommand { | ||
| +ClearCommand(reviews: ReviewList) | ||
| } | ||
| hide ClearCommand fields | ||
|
|
||
| class FavouriteCommand { | ||
| +userInput: String[] | ||
| +FavouriteCommand(reviews: ReviewList, userInput: String[]) | ||
| } | ||
|
|
||
| class FindCommand { | ||
| -outputString: String | ||
| -movieString: String | ||
| -tvShowString: String | ||
| -listDelimiter: String | ||
| #searchTerm: String | ||
| +FindCommand(reviews: ReviewList, searchTerm: String) | ||
| } | ||
|
|
||
| class ListCommand { | ||
| -outputString: String | ||
| -movieString: String | ||
| -tvShowString: String | ||
| -listDelimiter: String | ||
| +ListCommand((reviews: ReviewList) | ||
| } | ||
|
|
||
| class RemoveCommand { | ||
| +index: int | ||
| +RemoveCommand(reviews: ReviewList, index: int) | ||
| } | ||
|
|
||
| class SortCommand { | ||
| +userInput: String[] | ||
| +SortCommand(reviews: ReviewList, userInput: String[]) | ||
| } | ||
|
|
||
| class ReviewList { | ||
| +inputs: ArrayList<Media> | ||
| +void add(media: Media) | ||
| +void remove(index: int) | ||
| +String toString() | ||
| } | ||
|
|
||
| "{abstract} \nCommands" -up-> "1" ReviewList : > uses | ||
|
|
||
| skinparam groupInheritance 1 | ||
|
|
||
| "{abstract} \nCommands" <|-right- AddCommand | ||
| "{abstract} \nCommands" <|-right- ClearCommand | ||
| "{abstract} \nCommands" <|-- FavouriteCommand | ||
|
|
||
| "{abstract} \nCommands" <|-- FindCommand | ||
| "{abstract} \nCommands" <|-- ListCommand | ||
| "{abstract} \nCommands" <|-left- RemoveCommand | ||
| "{abstract} \nCommands" <|-left- SortCommand | ||
|
|
||
|
|
||
| @enduml |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Media class is shown as abstract in the UML diagram. However, it is not implemented as an abstract class. Is it supposed to be just shown as 'normal' class in the UML diagram?