E1867 allow reviewer to say review can be shown to class as an example

Problem Statement

The objective of this project is to:

1. Add a feature for students to make their reviews 'public', that is, allow other students to view them.
2. Add a feature for TA to select a subset of 'public' reviews, and make those reviews visible as sample reviews of the particular assignment.
3. Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
4. Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
5. Allow the student to toggle the visibility of a review he/she has submitted.

Approach & Design

1. Consent to make the review public - add a checkbox and an oncheck event handlers (JS) that sets a new field 'visibility' to public of Response object.
2. Change the schema of Responses table (add the new column) and write db migrations.
3. Create new table, model, view, controller for "similar_assignments" and validate CRUD operations that access the table.
4. Add HTML (checkbox) to uncheck the consent such that the reviews becomes private again.
5. On the "popup/team_users_popup" page (where instructor/TA can view all reviews), we give a checkbox against every review with public visibility to allow instructors/TAs to select one or more reviews as sample reviews to be available for students.
6. Once the instructor selects and submits some reviews as sample reviews, we give a popup containing a list of assignments with a checkbox against each of them and a submit button at the end to allow instructors to make sample reviews available for multiple assignments in one go. We perform validation checks also.
7. On submit of the popup, we update the similar_assignments table.
8. At the top of student_reviews/list page, we give an option for the student to preview all the available sample reviews.
9. Create the MVC setup for this new page to list all the sample reviews. Students will be able to click on one particular review and preview it.

DB Design

Currently, the Expertiza database design does not maintain any link between different assignments. An assignment of the current semester is completely independent of any other assignment of any other course having similar or exact objectives. For example, in a course C, the assignment named A1 in a semester Sx has no association to the same assignment given in an earlier semester Sy.

Since our task involves using reviews from the past as samples for the present, we should create this association as a new table. Further, reviews may not be the only intention to associate assignments with each other, as future requirements might require associating them on other criteria too. Thus, we find it appropriate to name the table as "similar_assignments".

The table structure is defined here.

This table can be visualized as a directed graph where vertices represent assignments. An edge (u,v) with a label L means u is similar to v for the intent of association, L.

Consider a row (id = x, assignment_id = Ak, is_similar_for = An, association_intent = "review"). This means, given the intent of association as "review", assignment Ak was chosen as a similar assignment for assignment An. That is, while marking some review for An as a sample, the instructor opted to have reviews of Ak as samples for An as well.

Design

Currently, the Expertiza database design does not maintain any link between different assignments. An assignment of the current semester is completely independent of any other assignment of any other course having similar or exact objectives. For example, in a course C, the assignment named A1 in a semester Sx has no association to the same assignment given in an earlier semester Sy.

Since our task involves using reviews from the past as samples for the present, we should create this association as a new table. Further, reviews may not be the only intention to associate assignments with each other, as future requirements might require associating them on other criteria too. Thus, we find it appropriate to name the table as "similar_assignments".

The table structure is defined here.

This table can visualized as a directed graph where vertices represent assignments. An edge (u,v) with a label L means u is similar to v for the intent of association, L.

Consider a row (id = x, assignment_id = Ak, is_similar_for = An, association_intent = "review"). This means, given the intent of association as "review", assignment Ak was chosen as a similar assignment for assignment An. That is, while marking some review for An as a sample, the instructor opted to have reviews of Ak as samples for An as well.

Implementation Details

Changes intended

1. For making a review as a sample for other reviews by power users
2. For Making a review public by the student

(code snippets for this section will be added during implementation)

UML - Use Case Diagram

Power Users: Instructors, TAs, Admins and Super Admins

Other details will be updated after the implementation

Test Plan

As a Power User (TA/Instructor/Admin/Super Admin)

1. Log in
2. Click on Manage->Assignments
3. Displays list of Assignments
4. Click View Report/Review for a particular assignment.
5. Displays a list of reviews submitted by students.
6. Click on any review in "team reviewed" column for a particular student.
7. Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
8. Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
9. From this list select all assignments for which the review has to be shown as a sample.
10. Click on 'Submit' after selection (this closes the popup).
11. Navigate to view reviews of that particular assignment and click on "Sample Reviews".
12. A new page is opened that lists out all the sample reviews of the assignment.

As a Student

1. Log in.
2. Click on Assignments
3. List of assignments is displayed.
4. Click on any assignment for which the review has to be submitted.
5. Assignment task page is displayed.
6. Click on "Other's work" to open the reviews summary page (at /student_review).
7. Below the heading "Reviews for ...", click on the "Show sample reviews" link.
8. This opens a page where the student can view all sample reviews for that assignment.
9. Use the browser's back button to go back to Assignment review page.
10. Chose to review any of the teams' assignments that are displayed.
11. Select a team for review and fill in the review.
12. Before submitting the review, select the check box that says "I agree to share this review anonymously as an example to the entire class".
13. After clicking on the submit button, the review submitted has been made public.

Additional Links and References

1. Link to the Git Pull Request
2. Expertiza on GitHub
3. GitHub Project Repository Fork
4. The Live Expertiza Website

Team

Amogh Agnihotri Subbanna
Chinmai Kaidabettu Srinivas
Siddu Madhure Jayanna
Suhas Naramballi Gururaja