Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:25:13Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of search attributes for a given entity along with a list of files that would altered in the process.

User
*Search fields
#username
#user_id
#fullname
#email

*Files to be modified:
#app/views/users/list.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

Assignment
*Search fields
#assignment_name
#assignee_username
#assignee_name
#due_date_before
#due_date_after
#created_before
#created_after

*Modified files
#app/models/assignment_node.rb

Questionnaire
*Search fields
#name
#text
#course
#assignment
*Modified files
#app/models/questionnaire_node.rb

Review
*Search fields
#team
#text
#min_score
#max_score
*Modified files
#app/views/review_mapping/_searchbox.html.erb
#app/controllers/review_mapping_controller.rb

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:24:42Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of search attributes for a given entity along with a list of files that would altered in the process.

User
*Search fields
#username
#user_id
#fullname
#email

*Files to be modified:
#app/views/users/list.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

Assignment
*Search fields
#assignment_name
#assignee_username
#assignee_name
#due_date_before
#due_date_after
#created_before
#created_after

*Modified files
#app/models/assignment_node.rb

Questionnaire
*Search fields
#name
#text
#course
#assignment
*Modified files
1.app/models/questionnaire_node.rb

Review
*Search fields
#team
#text
#min_score
#max_score
*Modified files
#app/views/review_mapping/_searchbox.html.erb
#app/controllers/review_mapping_controller.rb

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:21:11Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of attributes that would be searched for a given entity and the list of files that would altered in the process.

User
*Search fields
#username
#user_id
#fullname
#email

*Files to be modified:
#app/views/users/list.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:20:43Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of attributes that would be searched for a given entity and the list of files that would altered in the process.

*User
**Search fields
#username
#user_id
#fullname
#email

*Files to be modified:
#app/views/users/list.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:20:11Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of attributes that would be searched for a given entity and the list of files that would altered in the process.

*User
**Search fields
#username
#user_id
#fullname
#email

**Files to be modified:
#app/views/users/list.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:19:07Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of attributes that would be searched for a given entity and the list of files that would altered in the process.

*User
**Search fields
***username
***user_id
***fullname
***email

*Files to be modified:
**app/views/users/list.html.erb
**app/controllers/users_controller.rb
**app/models/user.rb

Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:18:52Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of attributes that would be searched for a given entity and the list of files that would altered in the process.

*User
**Search fields
***username
***user_id
***fullname
***email

*Files to be modified:
***app/views/users/list.html.erb
***app/controllers/users_controller.rb
***app/models/user.rb

Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:18:32Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of attributes that would be searched for a given entity and the list of files that would altered in the process.

*User
**Search fields
***username
***user_id
***fullname
***email

**Files to be modified:
***app/views/users/list.html.erb
***app/controllers/users_controller.rb
***app/models/user.rb

Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:11:56Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Therefore in order to develop the search functionality, changes are required in all the three layers.

View : Changes in view are changes added to UI, and it is used to pass search parameters to controller
Controller : Parses the changes from UI, essentially takes params[] hash.
Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects.

*User
**Search fields
#username
#user_id
#fullname
#email

Files to be modified:
#app/views/users/list.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:09:17Z

Smeneze:

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Therefore in order to develop the search functionality, changes are required in all the three layers.

View : Changes in view are changes added to UI, and it is used to pass search parameters to controller
Controller : Parses the changes from UI, essentially takes params[] hash.
Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects.

*User
**Search fields
username
name
email
Modified files:
app/views/users/list.html.erb
app/controllers/users_controller.rb
app/models/user.rb
Modified functions
UsersController#list : Parses the username, name and email from the params hash.
User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.
[edit]Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:05:30Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Therefore in order to perform search every entity required changes in all the three layers

View : Changes in view are changes added to UI, and it is used to pass search parameters to controller
Controller : Parses the changes from UI, essentially takes params[] hash.
Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects.
User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. React based View changes are in app/assets/javascripts/tree_display.jsx.

[edit]User
Search fields
username
name
email
Modified files:
app/views/users/list.html.erb
app/controllers/users_controller.rb
app/models/user.rb
Modified functions
UsersController#list : Parses the username, name and email from the params hash.
User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.
[edit]Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:04:47Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>

Therefore in order to perform search every entity required changes in all the three layers

View : Changes in view are changes added to UI, and it is used to pass search parameters to controller
Controller : Parses the changes from UI, essentially takes params[] hash.
Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects.
User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. React based View changes are in app/assets/javascripts/tree_display.jsx.

[edit]User
Search fields
username
name
email
Modified files:
app/views/users/list.html.erb
app/controllers/users_controller.rb
app/models/user.rb
Modified functions
UsersController#list : Parses the username, name and email from the params hash.
User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.
[edit]Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T07:04:05Z

Smeneze: /* Proposed Code Changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
localhost:port/user/search?name=<>
localhost:port/assignment/search?name=<>

Therefore in order to perform search every entity required changes in all the three layers

View : Changes in view are changes added to UI, and it is used to pass search parameters to controller
Controller : Parses the changes from UI, essentially takes params[] hash.
Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects.
User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. React based View changes are in app/assets/javascripts/tree_display.jsx.

[edit]User
Search fields
username
name
email
Modified files:
app/views/users/list.html.erb
app/controllers/users_controller.rb
app/models/user.rb
Modified functions
UsersController#list : Parses the username, name and email from the params hash.
User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.
[edit]Assignment
Search fields
name
assignee_username
assignee_name
due_date_before
due_date_after
created_before
created_after
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/assignment_node.rb
Modified functions
TreeDisplayController#initialize_fnode_update_children
TreeDisplayController#update_fnode_children
AssignmentNode.get
[edit]Questionnaire
Search fields
name
text
course
assignment
Modified files
app/assets/javascripts/tree_display.jsx
app/controllers/tree_display_controller.rb
app/models/questionnaire_node.rb
Modified functions
TreeDisplayController#get_tmp_res
QuestionnaireNode.get
[edit]Review
Search fields
team
text
min_score
max_score
Modified files
app/views/review_mapping/_searchbox.html.erb
app/controllers/review_mapping_controller.rb
app/helpers/summary_helper.rb
Modified functions
ReviewMappingController#response_report
SummaryHelper#summarize_reviews_by_reviewees

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T06:55:50Z

Smeneze: /* Proposed Code Changes */

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T06:55:34Z

Smeneze: /* Proposed Solution: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T00:21:07Z

Smeneze:

==Introduction:==

The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==

==Proposed Code Changes==

==Database Design==

==Test Plan: ==

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T03:15:33Z

Smeneze: /* Introduction */

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T03:11:23Z

Smeneze: /* Files modified */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Current Implementation==
Problem 1: No limitation on the maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to a student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Process resize.png]]
[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here checks the number of reviews assigned to a student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and no topic is selected by reviewer' do
it 'shows an error message and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
allow(assignment).to receive(:can_choose_topic_to_review?).and_return(true)
params = {
assignment_id: 1,
reviewer_id: 1
}
post :assign_reviewer_dynamically, params
expect(flash[:error]).to eq('No topic is selected. Please go back and select a topic.')
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when number of reviews are less than the assignment policy' do
it 'redirects to student review page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(ReviewResponseMap).to receive(:where).with(reviewer_id: 1, reviewed_object_id: 1 )
.and_return([])
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when number of reviews are greater than the assignment policy' do
it 'shows a flash error and redirects to student review page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(ReviewResponseMap).to receive(:where).with(reviewer_id: 1, reviewed_object_id: 1 )
.and_return([1,2,3])
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
expect(flash[:error]).to be_present
end
end

context 'when user has outstanding reviews less than assignment policy' do
it 'redirects to student review page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(ReviewResponseMap).to receive(:where).with(reviewer_id: 1, reviewed_object_id: 1 )
.and_return(:review_response_map)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
allow(assignment).to receive(:max_outstanding_reviews).and_return(0)

params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when user has outstanding reviews greater than assignment policy' do
it 'redirects to student review page and shows flash error' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(ReviewResponseMap).to receive(:where).with(reviewer_id: 1, reviewed_object_id: 1 )
.and_return(:review_response_map)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
allow(assignment).to receive(:max_outstanding_reviews).and_return(3)

params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(flash[:error]).to be_present
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end
</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T03:10:30Z

Smeneze: /* Problems in Current Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Current Implementation==
Problem 1: No limitation on the maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to a student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Process resize.png]]
[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here checks the number of reviews assigned to a student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T03:04:40Z

Smeneze: /* Current Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to a student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Process resize.png|frame|left|Main page]]
[[File:Issue.png|frame|right|Current Implementation Issue]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here checks the number of reviews assigned to a student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:59:59Z

Smeneze: /* Files modified */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Issue.png|frame|centre|Current Implementation Issue]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here checks the number of reviews assigned to a student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:59:11Z

Smeneze: /* Problems in Current Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:58:31Z

Smeneze: /* Current Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:54:24Z

Smeneze: /* Introduction */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:49:28Z

Smeneze: /* Files modified */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

=====Issue 1=====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
=====Issue 2=====
*There is no check to see if the submission is already assigned to the student.
=====Issue 3=====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:43:20Z

Smeneze: /* Files modified */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

=====Issue 1=====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
=====Issue 2=====
*There is no check to see if the submission is already assigned to the student.
=====Issue 3=====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough number of reviews for that assignment before getting new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:41:32Z

Smeneze: /* Files modified */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

=====Issue 1=====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
=====Issue 2=====
*There is no check to see if the submission is already assigned to the student.
=====Issue 3=====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough number of reviews for that assignment before getting new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
<pre>
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
</pre>
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end
</pre>
<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:40:10Z

Smeneze: /* Proposed Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

=====Issue 1=====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
=====Issue 2=====
*There is no check to see if the submission is already assigned to the student.
=====Issue 3=====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough number of reviews for that assignment before getting new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
<pre>
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
</pre>
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:39:29Z

Smeneze: /* Files modified */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

=====Issue 1=====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
=====Issue 2=====
*There is no check to see if the submission is already assigned to the student.
=====Issue 3=====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough number of reviews for that assignment before getting new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
<pre>
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
</pre>
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:36:34Z

Smeneze: /* Proposed Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

=====Issue 1=====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
=====Issue 2=====
*There is no check to see if the submission is already assigned to the student.
=====Issue 3=====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough number of reviews for that assignment before getting new review.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
<pre>
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
</pre>
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:34:09Z

Smeneze: /* Files modified */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

=====Issue 1=====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
=====Issue 2=====
*There is no check to see if the submission is already assigned to the student.
=====Issue 3=====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:10:56Z

Smeneze: /* Current Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===
The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
===Issue 2===
There is no check to see if the submission is already assigned to the student.
===Issue 3===
There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:10:27Z

Smeneze: /* Current Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===
The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
===Issue 2===
There is no check to see if the submission is already assigned to the student.
===Issue 3===
There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on maximum number of peer reviews.
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submission even if the current outstanding ones are still pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:10:04Z

Smeneze: /* Current Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===
The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
===Issue 2===
There is no check to see if the submission is already assigned to the student.
===Issue 3===
There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on maximum number of peer reviews.
There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2: No check on duplicate submissions
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3: There is no check on the number of outstanding reviews
*A user can request for submission even if the current outstanding ones are still pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:06:38Z

Smeneze: /* Current Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===
The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
===Issue 2===
There is no check to see if the submission is already assigned to the student.
===Issue 3===
There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

==Problems in Current Implementation==
===Current Implementation===
Problem 1:
* No limitation on maximum number of peer reviews.
There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

Problem 2:
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

Problem 3:
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:06:03Z

Smeneze: /* Problems in Current Implementation */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===
The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
===Issue 2===
There is no check to see if the submission is already assigned to the student.
===Issue 3===
There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

==Problems in Current Implementation==
===Current Implementation===
Problem 1:
* No limitation on maximum number of peer reviews.
There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
Problem 2:
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
Problem 3:
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:05:50Z

Smeneze: /* List of Changes */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===
The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
===Issue 2===
There is no check to see if the submission is already assigned to the student.
===Issue 3===
There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

==Problems in Current Implementation==
===Current Implementation===
Problem 1:
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
Problem 2:
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
Problem 3:
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:04:07Z

Smeneze: /* Proposed Changes */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===
The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
===Issue 2===
There is no check to see if the submission is already assigned to the student.
===Issue 3===
There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

==List of Changes==
===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:00:02Z

Smeneze: /* Introduction */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===
The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
===Issue 2===
There is no check to see if the submission is already assigned to the student.
===Issue 3===
There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if a student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

==List of Changes==
===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

::1. Student has done reviews less than assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:59:34Z

Smeneze: /* Introduction */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===
The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
===Issue 2===
There is no check to see if the submission is already assigned to the student.
===Issue 3===
There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if a student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

==List of Changes==
===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

::1. Student has done reviews less than assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:58:46Z

Smeneze: /* Issues Presented */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===

===Issue 2===

===Issue 3===
===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if a student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

==List of Changes==
===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

::1. Student has done reviews less than assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:58:29Z

Smeneze: /* Introduction */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Issue 1===

===Issue 2===

===Issue 3===
===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if a student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.
* There is no check on the number of outstanding reviews a user can have.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

::1. Student has done reviews less than assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:56:49Z

Smeneze: /* Proposed Changes */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if a student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.
* There is no check on the number of outstanding reviews a user can have.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:56:34Z

Smeneze: /* Proposed Changes */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if a student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.
* There is no check on the number of outstanding reviews a user can have.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:55:12Z

Smeneze: /* Proposed Changes */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if a student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than the maximum value allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.
* There is no check on the number of outstanding reviews a user can have.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:51:20Z

Smeneze: /* Issues Presented */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than the maximum value allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.
* There is no check on the number of outstanding reviews a user can have.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:48:32Z

Smeneze: /* Proposed Changes */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than the maximum value allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:48:17Z

Smeneze: /* Proposed Changes */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission

However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

ReviewResponseMap:
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than the maximum value allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:47:40Z

Smeneze: /* Proposed Changes */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.

ReviewResponseMap:
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than the maximum value allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T01:41:20Z

Smeneze: /* Proposed Changes */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

====Proposed Changes====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code, in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" option is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time.

However, since the code did not have a check for how many reviews already are allocated to a given student, one could easily bypass the review limit by sending the same post request again and again.

ReviewResponseMap:
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than the maximum value allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes: 
1. Login as instructor. 
2. Go to Manage->Assignments and navigate to assignment name 'test1'. 
3. Click on add participants. This will give a list of all participants. 
4. Now click on any student username in order to impersonate. 
5. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

===Automated Test Cases For Review pending check===

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]