CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team34

1. Introduction

1.1 Purpose

Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allow students to compare their reviews with experts' reviews. Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. But s/he needs to create a separate assignment just for calibration purpose. Ideally, calibration should become one part of the normal assignment so that students can do the calibration reviews first, learn from experts' reviews and then do the peer reviews.

1.2 Problem Definition

Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.

This project proposes a solution to include the process of calibration in a regular assignment.

2. Overall Description

“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.

3. Requirements

1. The instructor shall be able to add calibration process to an newly created or existing assignment.

2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.

3. The added calibration of an assignment shall have it owns type of due date.

4. The added calibration of an assignment shall have the same behavior as the current working calibration process.

4. Use Cases

1. Edit/Create Assignment

Use Case Id: 1

Use Case Description: Instructor can create a new assignment

Actors: Instructor

Pre Conditions: The user is logged in as an instructor

Post Conditions: Instructor can edit created assignment

2. Enable Caliration

Use Case Id: 2

Use Case Description: The instructor can now select the option - "Calibration for training?"

Actors: Instructor

Pre Conditions: The assignment is created

Post Conditions: The deadline for calibration now appears in the due dates tab

Special cases: Calibration deadline should come before the submission deadline.

3. Add calibration due date

Use Case Id: 3

Use Case Description: Instructor can set due date for calibration under due dates tab

Actors: Instructor

4. Summit work

Use Case Id: 4

Use Case Description:

Actors: Student

Pre Conditions:

5. Expert Review

Use Case Id: 5

Use Case Description:

Actors: Instructor

Pre Conditions:

Post Conditions:

6. Calibration review

Use Case Id: 6

Use Case Description:

Actors: Student

Pre Conditions:

Post Conditions:

7. View calibration result

Use Case Id: 7

Use Case Description:

Actors: Student

Pre Conditions:

Post Conditions:

5. Test-Driven Development(TDD)

A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. Also the refactoring process is safe since it happens after the test is written. Tests can also serve as a documentation to a developer.

6. Design Plan

Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement.

7. Test Plan

1. When it is in assignments#edit page:

• To check it has a checkbox with title "Calibration for training?" in assignments#edit page

2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:

• To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab
• To check it allows instructors to change and save date & time and permissions of calibration due date

3.When current assignment is calibration stage:

• To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage
• To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page
• To check it allows students to do calibration review and the date can be saved successfully
• To check the student is able to compare the results of expert review by clicking "show calibration results" link

4. When current assignment if in review_stage:

• To check it excludes calibration reviews from outstanding review restriction and total review restriction
• To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page

8. Design Patterns

1. MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).

2. Dry Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.