CSC/ECE 517 Spring 2018- Project E1818: Role-based reviewing

Introduction

Problem Statement

The project is to enable role-based team-mate reviews. These roles can be better named as duties, corresponding to the duty of a team member in a particular project. The instructor should be able to use a different rubric for evaluating the contribution of team mates with different roles. Borrowing from different Agile methodologies like SCRUM, each team member has a particular role. For example,architect,facilitator and implementer. Although one member can contribute to other duties, a much more meaningful review can be done if the review rubric was role-specific. Currently, there is a single teammate review rubric for each assignment. This means that some review questions are not applicable for all team members. For instance, if there is a question which says “What percentage of the code was written by this member?” This may not be applicable for the team member who wrote tests or documentation.

UML Diagram

In a UML Class diagram, The relationships depicted above are as follows:

• Between the User and Duty class, there is a bidirectional association. The user table is used for both the instructor and the student.
  • Each instructor can have multiple roles that he can choose from for a particular assignment/questionnaire.
  • Each student can have 0 or 1 role for a particular project.
• For each Questionnaire instance, there are one or more Questions that can be stored, hence there is an aggregation relationship from Question to Questionnaire. This is for the grading rubric based on the role.
• The Question table and the Questionnaire table each will be using the the duty ID to sort out questions for a particular assignment.

Proposed Implementation

The project introduces changes from the instructor view and the student view. The steps for implementation are as follow:

Migration changes

• . Create Duties table: This table stores all the duties created by any instructor.

              * id - The duty ID will be used by other tables like the questionnaire table and hence will be the primary key.
              * assignment_id - An assignment has particular duties. Thus, the assignment number will be the foreign key for the Duties table. 
              * instructor_id - The Duties created by one Instructor should be visible and reusable by that instructor only. Thus, the instructor id will also be a foreign key in the Duties table.

• Create assignments_duty_mappings table: If an instructor wants to add multiple duties for an assignment, storing it in the duty table will cause the duty to be overwritten. Thus we have created a table which maps an assignment and all its duties.

              * id 
              * assignment_id 
              * duty_id

• Create assignment_duty_questionnaire_mappings table : This table is created to store the questionnaire for team-mate review rubrics and the corresponding duty id.

              * id 
              * assignment_id 
              * duty_id
              * questionnaire_id

• Add a column entry named "role_based_assignment" in the assignments table which would be of type boolean. This field would save the status of the role based review checkbox.
• Add a column entry named "allow_multiple_duties" in the assignments table which would be of type boolean. This field would save the status of the checkbox for allowing multiple students with the same role.
• Add a column entry named "Duties" to the Users table which would be of type string. This field would save the duty that a student would select if role based reviews are permitted.

Instructor view changes

• For a particular assignment, in the 'Review Strategy' tab,create a check box called "Is role based review allowed?" that allows an instructor to add a role based review for a particular assignment or not. This can be done by adding a checkbox tag in the review strategy sub page of the edit assignments page.
• If the instructor selects the checkbox for role-based reviewing, then a button should appear for adding roles called “Add Duties” along with a dropdown to select from the previously added duties by the same instructor.
• The duties appearing in the drop down would consist of duties added by the instructor for any of his courses.
• This can be achieved by including a subform tag in the same table entry as the checkbox which should have a hidden attribute.
• A java script function would be created which is invoked when the status of the checkbox changes. This function should remove the hidden attribute of the sub form tag if the checkbox is checked. This would enable the add duties field and the select duties drop down to appear only on checking the box.
• An instructor can decide the number of duties for a particular assignment, the number of team members who can undertake a particular duty and if any of the duties are optional.
• To implement this , another checkbox called "Can multiple students select the same role ? "is added in the review strategy tab of the edit assignments page. This will be visible only if the role based reviewing checkbox is selected.
• The instructor can create Team-mate review Questionnaires for the different duties he created or can use any from the existing list of questionnaires.

Student view changes

• When a student goes to “Your team”, he should be able to select a duty from a drop down menu which would display all the duties added by an instructor for that particular assignment. This should only occur if role based reviewing is permitted for that particular assignment. If not, the standard existing view will be displayed which does not give any such option.
• This can be implemented by adding a drop down box in the student_teams view file. This would be enclosed in a conditional which would only appear if role based reviewing is permitted.
• A student can only select one duty.
• If the instructor has permitted multiple students to have the same role, each student will get all the duties as an option in the dropdown box.However, if the instructor has not provided permission for multiple students to have the same role, when a particular duty is selected by a student , any other student will not see that duty in the drop down box.
• This can be implemented by making a separate copy of the list of all the duties available. If multiple roles are not permitted, once a duty is selected , it can be eliminated from the separate list maintained and that list can be displayed to the student. Thus , there will be a conditional in the student teams view file that displays the separate list in the drop down if multiple students can have the same role or else display the original list of duties.
• A team member cannot change their role after the assignment submission deadline.
• This can be implemented by taking the time and date information from the server and showing the select duties option only if the current time and date is prior to the deadline time and date. A conditional statement will be included in the student teams view file for this purpose.
• When a student selects a particular duty , it is stored in the database table of that user. Thus when a team-mate reviews that student , he will see a questionnaire corresponding to the duty of that student.This would enable reviews of the teammates to be accurate and specific to their role in a project.

Files to be modified

New files

Some of the new migration files we have created are

• db/migrate/add_duties_table.rb

In this file, a duties table is created with a name field

• db/migrate/add_reference_of_instructor_and_assignment_to_duties.rb

 In this file, we have adding foreign key reference of assignment id into duties table.

• db/migrate/add_duties_to_users.rb

 In this file, a column named duties is added to the Users table

• db/migrate/add_multiple_duties_to_assignments.rb

 In this file, we have added a column allow_multiple_duties to assignments table

• db/migrate/create_assignment_duty_questionnaire_mapping.rb

 In this file, we have created assignment_duty_questionnaire_mappings table and added columns for questionnaire_id, assignment_id and duty_id

Files that have to be modified

• app/views/assignments/edit/review_strategy.html.erb

In this file, a checkbox is added to permit role based review. A hidden checkbox is added to allow multiple students to have the same role and hidden fields for adding duties along with a dropdown box for selecting from existing duties.
A javascript function should be added which removes the hidden attributes from for the above stated entries once the checkbox is selected.

• app/views/assignments/edit/rubrics.html.erb

In this file , a conditional statement is added, which displays the dropdown for selecting duties and a dropdown for selecting a teammate review for the selected duties if role based reviewing is permitted or else display the standard view.
       

• app/views/student_teams/view.html.erb

In this file, a conditional statement is added which displays the select duties dropdown box is role based reviewing is allowed or else displays the standard view. 

• app/controllers/response_controller.rb

In this file, the new_feedback function will be edited to map the team-mate review questionnaires according to the duties created.

• app/questionnaire/new.html.erb

A new questionnaire will be created for each new duty created or the same questionnaire can be used.

• app/questionnaire/edit.html.erb

A newly created questionnaire for a particular duty can be edited.

Test Plan

• Instructor tests
  • Check the box for role based reviewing.
    • Display and select from already existing roles(duties) with option to create new roles(duties).
    • Should not be able to see roles(duties) from other instructors.
    • Select corresponding rubrics for a particular role(duty).
  • If not, proceed with the default questions for the rubric for the assignment.

• Student(team member) tests
  • Before submitting the project, all team members should select a role(duty) for themselves from the roles(duties) set by the instructor.
  • Multiple students may have the role(duty) but 1 student cannot have multiple roles(duties).

• Reviewer tests
  • For the teammate review, only the questions related to the role(duty) selected by the student should appear in the rubric.