Latest revision as of 15:15, 26 November 2020

This wiki page describes the changes made under E2075, to ensure calibration submissions are copied along with calibration assignments for CSC/ECE 517, Fall 2020.

About Expertiza

Expertiza is an open source project based on Ruby on Rails framework, created and maintained by the joint efforts of students and faculty at North Carolina State University.

It allows the instructors to create new assignments and customize new or existing assignments. Expertiza also allows an instructor to create a list of topics the students can sign up for. Students can form teams on the web application to work on various projects and assignments together. Additionally, students can peer review each other's submissions allowing them to improve upon their work. Expertiza supports submission across various document types, including the URLs and wiki pages.

Introduction

The Expertiza project allows "calibration assignments" to be performed where students are asked to review work that has also been reviewed by a member of the course staff. Calibration is the term used for rectifying, or checking or determining something. In the context of this project, a 'Calibrated review' is one which is performed by a student, so that (s)he can verify their work by comparing it with the instructor's response for the same assignment. If the student’s review “resembles” the staff-member’s review, then the student is presumed to be a competent reviewer. Since calibration reviews are meant as reference for better performance of peer reviews (which are performed later), they are not graded.

Problem Statement

Project Purpose

Calibration submissions should be copied along with calibration assignments.

Issue in current implementation

On creating a copy of a previous assignment, say for example Design Exercise, Fall '20 for the Fall '21 semester - the calibration assignments associated with it are not copied over. The instructor is required to impersonate extra participants, and submit work on behalf of each of the extra participants. This is obviously extra trouble, and it would be a lot more convenient if an instructor didn’t have to resubmit the same calibration submissions over and over, every semester.

The following steps were taken to test the aforementioned issues:

Step 1: On copying the Design exercise assignment

Step 2: The original file contains the following calibration reviews

Step 3: However, the copy doesn't contain any of the calibrated reviews

Implementation

MVC

The project is implemented in Ruby on Rails that uses MVC architecture. We have three separate modules namely User Interface, Database Model and Control Flow (Model, View and Controller).

Principle

We tend to reuse the already existing functionalities and data to our design. The calibration reviews that are present in the previous exercise will be copied into the newly created exercise which would prevent the instructor from performing additional tasks of performing reviews repeatedly. This would also prevent code duplication and additional memory usage.

Design

The following must be added to the current implementation:

Participants with 'View' and 'Edit' actions in the calibration tab are copied over to the new version, as they are considered calibration submissions
All hyperlinks and files associated with the above mentioned participants are copied over as well
Participants with the 'Begin' action are not copied over
A check is put in place to make sure that these steps are taken only for copying assignments with calibration reviews. This is signified by a calibration tab in the tool bar, on the edit page.

Difference between Previous Implementation and Identified Solution

Previous Implementation

Identified Implementation

Files Involved

app/models/assignment_form.rb
app/views/assignments/edit/_calibration.html.erb
db/schema.rb

Changes in code

All changes mentioned below have been made in app/models/assignment_form.rb

Test Plan

Manual Testing Plan

To check if the UI is working as expected [No broken links]
The submissions [Files and Hyperlinks] are copied when an assignment for calibration is copied.

Directions for Manual Testing

The following steps must be performed to test the project UI:

Step 1: Log in as an Instructor, with Username - instructor6, Password - password

Step 2: Find an assignment with calibration submissions present, which is represented by a calibration tab on the editing page.
In this case, the assignment chosen is called "Design exercise"

Step 3: Copy the assignment, by selecting the icon shown below

Step 4: On inspection of the copied assignment, it is observed that the calibration assignments have been copied over.

Step 5: In the similar way, if the calibration tab has any files attached by the reviewers, then the files would get copied along with the participant details. Below is an assignment in which one participant has submitted a file named review1.txt in calibration.

Step 6: As the assignment has a file in calibration tab, even the copy of the assignment will have the same file with same content copied over to the calibration tab. Below is the copied assignment's calibration tab containing review1.txt created by the participant in original design exercise

Video illustrating changes

E2075 Video Link

RSpec Testing Plan

Below are the rspec testcases used to test the application.

Useful Links

Team Information

Nischal Badarinath Kashyap
Mounika Bachu
Akshay Podila
Dhanraj Raghunathan

@@ Line 16: / Line 16: @@
 = Problem Statement =
-== Goal ==
+== Project Purpose ==
 Calibration submissions should be copied along with calibration assignments.
@@ Line 35: / Line 35: @@
 = Implementation =
-== Proposed Design ==
+==MVC==
+The project is implemented in Ruby on Rails that uses MVC architecture. We have three separate modules namely User Interface, Database Model and Control Flow (Model, View and Controller).
+==Principle==
+We tend to reuse the already existing functionalities and data to our design. The calibration reviews that are present in the previous exercise will be copied into the newly created exercise which would prevent the instructor from performing additional tasks of performing reviews repeatedly. This would also prevent code duplication and additional memory usage.
+== Design ==
 The following must be added to the current implementation:
-* The same extra participants in the assignment, which are used as calibration assignments are copied over to the newly copied directory
+* Participants with 'View' and 'Edit' actions in the calibration tab are copied over to the new version, as they are considered calibration submissions
-* The URLs and/or files that were submitted to the previous assignment must be copied over as well
+* All hyperlinks and files associated with the above mentioned participants are copied over as well
-* Test cases to check if the above-mentioned steps work as required
+* Participants with the 'Begin' action are not copied over
+* A check is put in place to make sure that these steps are taken only for copying assignments with calibration reviews. This is signified by a calibration tab in the tool bar, on the <i>edit</i> page.
+==Difference between Previous Implementation and Identified Solution ==
+===Previous Implementation===
+[[File:um20201.png]]
+===Identified Implementation===
+[[File:um20221.png]]
-[More on the design pattern if any, ER/ UML diagrams to be updated as the project progresses]
 == Files Involved ==
-* '''submission_records_controller.rb'''
+* '''app/models/assignment_form.rb'''
-* '''index.html.erb''' in expertiza/app/views/submission_records
+* '''app/views/assignments/edit/_calibration.html.erb'''
+* ''' db/schema.rb'''
+== Changes in code ==
+All changes mentioned below have been made in <b>app/models/assignment_form.rb</b>
+[[File:Code_2075.jpeg |1000px|Image: 1000 pixels]]<br><br><br>
+[[File:Code1_2075.jpeg |1000px|Image: 1000 pixels]]<br><br><br>
+[[File:Code2_2075.jpeg |1000px|Image: 1000 pixels]]<br><br><br>
+[[File:Code3_2075.jpeg |1000px|Image: 1000 pixels]]<br><br><br>
+[[File:Code4_2075.jpeg |1000px|Image: 1000 pixels]]<br><br><br>
+[[File:Code5_2075.jpeg |1000px|Image: 1000 pixels]]<br><br><br>
+[[File:Code6_2075.jpeg |1000px|Image: 1000 pixels]]
+[[File:Code7_2075.jpeg |1000px|Image: 1000 pixels]]<br><br><br>
 = Test Plan =
 == Manual Testing Plan ==
-Manual test to check if:
+* To check if the UI is working as expected [No broken links]
-* The UI is working as expected [No broken links]
 * The submissions [Files and Hyperlinks] are copied when an assignment for calibration is copied.
 === Directions for Manual Testing ===
-* Go to the testing server [VCL Instance] and log in with the credentials - username: 'instructor6'; password: 'password'
+The following steps must be performed to test the project UI:<br><br>
-* Go to an existing assignment that you want to setup calibration for
+'''Step 1:''' Log in as an Instructor, with Username - instructor6, Password - password<br><br>
-** Select the '''copy''' button
+[[File:logging_in_2075.png |1000px|Image: 1000 pixels]] <br><br><br>
-** Toggle onto the calibration tab of the original directory and check the files present inside it
-** Now, select the copied directory
+'''Step 2:''' Find an assignment with calibration submissions present, which is represented by a calibration tab on the editing page. <br>In this case, the assignment chosen is called "Design exercise"<br><br>
-** On the calibrations tab, check whether the copied submissions [Files and URLs] are present.
+[[File:editing_2075.png |1000px|Image: 1000 pixels]] <br><br><br><br>
+[[File:with_calib.png |1000px|Image: 1000 pixels]] <br><br><br>
+'''Step 3:''' Copy the assignment, by selecting the icon shown below<br><br>
+[[File:copying_2075.png |1000px|Image: 1000 pixels]] <br><br><br>
+'''Step 4:''' On inspection of the copied assignment, it is observed that the calibration assignments have been copied over.<br><br>
+[[File:copied_2075.png |1000px|Image: 1000 pixels]] <br><br><br>
+'''Step 5:''' In the similar way, if the calibration tab has any files attached by the reviewers, then the files would get copied along with the participant details. Below is an assignment in which one participant has submitted a file named review1.txt in calibration.
+[[File:orgde.png]]
+'''Step 6:''' As the assignment has a file in calibration tab, even the copy of the assignment will have the same file with same content copied over to the calibration tab. Below is the copied assignment's calibration tab containing review1.txt created by the participant in original design exercise
+[[File:copde.png]]
+== Video illustrating changes ==
+[https://www.youtube.com/watch?v=cyhy2mVXcPM&feature=youtu.be '''E2075 Video Link''']
 == RSpec Testing Plan ==
-RSpec test to check:
+Below are the rspec testcases used to test the application.
-* Validation of the models
-* Sanity and basic functionality of controllers
+[[File:spec1.png]]
-** This involves essentially checking if the copied calibration's corresponding model has entries for the submissions
+[[File:spec4.png]]
-=== Directions for RSpec Testing ===
+[[File:spec3.png]]
-* Run the following commands:
-** For controllers: rspec spec/controllers/
-** For models: rspec spec/models/
 = Useful Links =
+*[http://152.46.18.202:8080/ Server running changes implemented under E2075]
+*[https://github.com/mounikaprakash/expertiza GitHub repo with changes made under E2075]
 *[https://github.com/expertiza/expertiza Expertiza on GitHub]
 *[http://expertiza.ncsu.edu/ The live Expertiza website]
@@ Line 85: / Line 137: @@
 = Team Information =
-* Nischal Kashyap
+* Nischal Badarinath Kashyap
 * Mounika Bachu
 * Akshay Podila
 * Dhanraj Raghunathan

CSC/ECE 517 Fall 2020 - E2075. calibration submissions should be copied along with calibration assignments: Difference between revisions