CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

Introduction

Purpose and Problem

The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an extra feature):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

Design

Proposed Solution

Problem 1:

• Check will be done to verify whether the course staff is a participant.
• In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
• If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" will be present.
• The already present "Assign Grade" link will only appear after the due date of the assignment has passed.
• Clicking on the "Perform Review" or "Edit Review" links will take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
• A flag will be placed on the responses done by the course staff.

Problem 2:

• A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
• Add helper class identity_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
• Change will be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

Problem 3:

• Add the Criterion review type by expanding the current conditional statements targeting Checkbox to include Criterion in show_calibration_results_for_student.html.erb.

Relevant Files

• views/assignments/list_submissions.html.erb
• views/reports/calibration_report.html.erb
• views/response/show_calibration_results_for_student.html.erb
• views/response/response.html.erb
• views/grades/view_team.html.erb
• views/grades/view_my_scores.html.erb
• controllers/response_controller.rb
• app/helpers/identity_helper.rb

Flow Chart

This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

Database Design

This diagram represents the relationship between different models involved with our proposed solution. We do not anticipate any changes to the database schema.

Testing Plan

Testing from the UI

• Add an instructor as a participant in the assignment.

1. After logging in as the instructor, go to Manage > Assignments.
2. Find the test assignment and click the icon to add participants.
3. Add the instructor as a participant on the assignment.

• Instructor should be able to add a review on an assignment.

1. After logging in as the instructor, go to Manage > Assignments.
2. Find the test assignment and click on the View Submissions icon.
3. Verify a list of submissions appears.
4. If the last due date for the assignment has not passed, the “Perform review” link should be visible.
5. Click on the “Perform review” link.
6. Verify submitted work for team is visible.
7. Complete review and click save.

• When an author view their reviews, reviews done by instructors should present a star.

1. After logging in as the student, go to Assignments.
2. Click on the test assignment
3. Click "Your scores"
4. If a review was done by an instructor, verify the star is present.

Automated Testing with RSpec

We plan on adding comprehensive RSpec tests for all controller and model classes that we change as well automated UI tests for features we added.

Team Information

Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya